Asposecpplib
System::Net::ServicePoint Class Reference

Provides HTTP connection management. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Public Member Functions

ASPOSECPP_SHARED_API BindIPEndPoint get_BindIPEndPointDelegate ()
 Gets the delegate that is used to associate local IPEndPoint with the current instance. More...
 
ASPOSECPP_SHARED_API void set_BindIPEndPointDelegate (BindIPEndPoint value)
 Sets the delegate that is used to associate local IPEndPoint with the current instance. More...
 
ASPOSECPP_SHARED_API int32_t get_ConnectionLeaseTimeout ()
 Gets a timeout in milliseconds after which active ServicePoint will be closed. More...
 
ASPOSECPP_SHARED_API void set_ConnectionLeaseTimeout (int32_t value)
 Sets a timeout in milliseconds after which active ServicePoint will be closed. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< Uriget_Address ()
 Returns the server URI to which the current instance connects. More...
 
ASPOSECPP_SHARED_API int32_t get_MaxIdleTime ()
 Gets an amount of time in milliseconds after which an idle connection will be closed. More...
 
ASPOSECPP_SHARED_API void set_MaxIdleTime (int32_t value)
 Sets an amount of time in milliseconds after which an idle connection will be closed. More...
 
ASPOSECPP_SHARED_API bool get_UseNagleAlgorithm ()
 Gets a value that indicates if the Nagle algorithm is used by connections managed by the current instance. More...
 
ASPOSECPP_SHARED_API void set_UseNagleAlgorithm (bool value)
 Sets a value that indicates if the Nagle algorithm is used by connections managed by the current instance. More...
 
ASPOSECPP_SHARED_API int32_t get_ReceiveBufferSize ()
 Gets the size of the receive buffer. More...
 
ASPOSECPP_SHARED_API void set_ReceiveBufferSize (int32_t value)
 Sets the size of the receive buffer. More...
 
ASPOSECPP_SHARED_API bool get_Expect100Continue ()
 Gets a value that indicates if the 100-Continue behavior is used. More...
 
ASPOSECPP_SHARED_API void set_Expect100Continue (bool value)
 Sets a value that indicates if the 100-Continue behavior is used. More...
 
ASPOSECPP_SHARED_API DateTime get_IdleSince ()
 Returns a date and time of the latest connection to a host. More...
 
virtual ASPOSECPP_SHARED_API Version get_ProtocolVersion ()
 Returns the HTTP version. More...
 
ASPOSECPP_SHARED_API String get_ConnectionName ()
 Returns the connection name. More...
 
ASPOSECPP_SHARED_API int32_t get_ConnectionLimit ()
 Gets the maximum number of connections that are allowed by the current instance. More...
 
ASPOSECPP_SHARED_API void set_ConnectionLimit (int32_t value)
 Sets the maximum number of connections that are allowed by the current instance. More...
 
ASPOSECPP_SHARED_API int32_t get_CurrentConnections ()
 Returns a number of opened connections. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificateget_Certificate ()
 Returns a certificate that is used by the current instance. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificateget_ClientCertificate ()
 Returns the last client certificate. More...
 
ASPOSECPP_SHARED_API bool get_SupportsPipelining ()
 Returns a value that indicates if the current instance supports the pipeline connections. More...
 
ASPOSECPP_SHARED_API bool CloseConnectionGroup (String connectionGroupName)
 Closes and removes connections that belong to the specified connection group. More...
 
ASPOSECPP_SHARED_API void SetTcpKeepAlive (bool enabled, int32_t keepAliveTime, int32_t keepAliveInterval)
 Sets the value that indicates if the 'Keep-Alive' option is enabled. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Provides HTTP connection management. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Function Documentation

◆ CloseConnectionGroup()

ASPOSECPP_SHARED_API bool System::Net::ServicePoint::CloseConnectionGroup ( String  connectionGroupName)

Closes and removes connections that belong to the specified connection group.

Parameters
connectionGroupNameThe name of the connection group.
Returns
True when connections are closed successfully, otherwise false.

◆ get_Address()

ASPOSECPP_SHARED_API System::SharedPtr<Uri> System::Net::ServicePoint::get_Address ( )

Returns the server URI to which the current instance connects.

Returns
The server URI to which the current instance connects.

◆ get_BindIPEndPointDelegate()

ASPOSECPP_SHARED_API BindIPEndPoint System::Net::ServicePoint::get_BindIPEndPointDelegate ( )

Gets the delegate that is used to associate local IPEndPoint with the current instance.

Returns
The delegate that is used to associate local IPEndPoint with the current instance.

◆ get_Certificate()

ASPOSECPP_SHARED_API System::SharedPtr<System::Security::Cryptography::X509Certificates::X509Certificate> System::Net::ServicePoint::get_Certificate ( )

Returns a certificate that is used by the current instance.

Returns
A certificate that is used by the current instance.

◆ get_ClientCertificate()

ASPOSECPP_SHARED_API System::SharedPtr<System::Security::Cryptography::X509Certificates::X509Certificate> System::Net::ServicePoint::get_ClientCertificate ( )

Returns the last client certificate.

Returns
The last client certificate.

◆ get_ConnectionLeaseTimeout()

ASPOSECPP_SHARED_API int32_t System::Net::ServicePoint::get_ConnectionLeaseTimeout ( )

Gets a timeout in milliseconds after which active ServicePoint will be closed.

Returns
A timeout in milliseconds after which active ServicePoint will be closed.

◆ get_ConnectionLimit()

ASPOSECPP_SHARED_API int32_t System::Net::ServicePoint::get_ConnectionLimit ( )

Gets the maximum number of connections that are allowed by the current instance.

Returns
The maximum number of connections that are allowed by the current instance.

◆ get_ConnectionName()

ASPOSECPP_SHARED_API String System::Net::ServicePoint::get_ConnectionName ( )

Returns the connection name.

Returns
The connection name.

◆ get_CurrentConnections()

ASPOSECPP_SHARED_API int32_t System::Net::ServicePoint::get_CurrentConnections ( )

Returns a number of opened connections.

Returns
A number of opened connections.

◆ get_Expect100Continue()

ASPOSECPP_SHARED_API bool System::Net::ServicePoint::get_Expect100Continue ( )

Gets a value that indicates if the 100-Continue behavior is used.

Returns
A value that indicates if the 100-Continue behavior is used.

◆ get_IdleSince()

ASPOSECPP_SHARED_API DateTime System::Net::ServicePoint::get_IdleSince ( )

Returns a date and time of the latest connection to a host.

Returns
A date and time of the latest connection to a host.

◆ get_MaxIdleTime()

ASPOSECPP_SHARED_API int32_t System::Net::ServicePoint::get_MaxIdleTime ( )

Gets an amount of time in milliseconds after which an idle connection will be closed.

Returns
A n amount of time in milliseconds after which an idle connection will be closed.

◆ get_ProtocolVersion()

virtual ASPOSECPP_SHARED_API Version System::Net::ServicePoint::get_ProtocolVersion ( )
virtual

Returns the HTTP version.

Returns
The HTTP version.

◆ get_ReceiveBufferSize()

ASPOSECPP_SHARED_API int32_t System::Net::ServicePoint::get_ReceiveBufferSize ( )

Gets the size of the receive buffer.

Returns
The size of the receive buffer.

◆ get_SupportsPipelining()

ASPOSECPP_SHARED_API bool System::Net::ServicePoint::get_SupportsPipelining ( )

Returns a value that indicates if the current instance supports the pipeline connections.

Returns
A value that indicates if the current instance supports the pipeline connections.

◆ get_UseNagleAlgorithm()

ASPOSECPP_SHARED_API bool System::Net::ServicePoint::get_UseNagleAlgorithm ( )

Gets a value that indicates if the Nagle algorithm is used by connections managed by the current instance.

Returns
A value that indicates if the Nagle algorithm is used by connections managed by the current instance.

◆ set_BindIPEndPointDelegate()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_BindIPEndPointDelegate ( BindIPEndPoint  value)

Sets the delegate that is used to associate local IPEndPoint with the current instance.

Parameters
valueThe value to set.

◆ set_ConnectionLeaseTimeout()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_ConnectionLeaseTimeout ( int32_t  value)

Sets a timeout in milliseconds after which active ServicePoint will be closed.

Parameters
valueThe value to set.

◆ set_ConnectionLimit()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_ConnectionLimit ( int32_t  value)

Sets the maximum number of connections that are allowed by the current instance.

Parameters
valueThe value to set.

◆ set_Expect100Continue()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_Expect100Continue ( bool  value)

Sets a value that indicates if the 100-Continue behavior is used.

Parameters
valueThe value to set.

◆ set_MaxIdleTime()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_MaxIdleTime ( int32_t  value)

Sets an amount of time in milliseconds after which an idle connection will be closed.

Parameters
valueThe value to set.

◆ set_ReceiveBufferSize()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_ReceiveBufferSize ( int32_t  value)

Sets the size of the receive buffer.

Parameters
valueThe value to set.

◆ set_UseNagleAlgorithm()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::set_UseNagleAlgorithm ( bool  value)

Sets a value that indicates if the Nagle algorithm is used by connections managed by the current instance.

Parameters
valueThe value to set.

◆ SetTcpKeepAlive()

ASPOSECPP_SHARED_API void System::Net::ServicePoint::SetTcpKeepAlive ( bool  enabled,
int32_t  keepAliveTime,
int32_t  keepAliveInterval 
)

Sets the value that indicates if the 'Keep-Alive' option is enabled.

Parameters
enabledA value that indicates if the 'Keep-Alive' option is enabled.
keepAliveTimeA timeout in milliseconds after which the first 'Keep-Alive' packet will be sent.
keepAliveIntervalA timeout in milliseconds between sending 'Keep-Alive' packets.