System::Net::ServicePointManager Class Reference

Manages the lifecycle stages (creating, maintaining, and deleting) of the ServicePoint class instances. 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...

#include "service_point_manager.h"

Inherits System::Object.

Static Public Member Functions

static ASPOSECPP_SHARED_API SecurityProtocolType get_SecurityProtocol ()
 Gets the security protocol type used by the ServicePoint-class instances that are managed by the current instance. More...
 
static ASPOSECPP_SHARED_API void set_SecurityProtocol (SecurityProtocolType value)
 Sets the security protocol type used by the ServicePoint-class instances that are managed by the current instance. More...
 
static ASPOSECPP_SHARED_API int32_t get_MaxServicePoints ()
 Gets the maximum number of the ServicePoint-class instances that can be managed by the current instance. More...
 
static ASPOSECPP_SHARED_API void set_MaxServicePoints (int32_t value)
 Sets the maximum number of the ServicePoint-class instances that can be managed by the current instance. More...
 
static ASPOSECPP_SHARED_API int32_t get_DefaultConnectionLimit ()
 Gets the maximum number of concurrent connections that are allowed by the ServicePoint-class instances. More...
 
static ASPOSECPP_SHARED_API void set_DefaultConnectionLimit (int32_t value)
 Sets the maximum number of concurrent connections that are allowed by the ServicePoint-class instances. More...
 
static ASPOSECPP_SHARED_API int32_t get_MaxServicePointIdleTime ()
 Gets the maximum idle time of the ServicePoint-class instances. More...
 
static ASPOSECPP_SHARED_API void set_MaxServicePointIdleTime (int32_t value)
 Sets the maximum idle time of the ServicePoint-class instances. More...
 
static ASPOSECPP_SHARED_API bool get_UseNagleAlgorithm ()
 Gets a value that indicates if the ServicePoint-class instances use the Nagle algorithm. More...
 
static ASPOSECPP_SHARED_API void set_UseNagleAlgorithm (bool value)
 Sets a value that indicates if the ServicePoint-class instances use the Nagle algorithm. More...
 
static ASPOSECPP_SHARED_API bool get_Expect100Continue ()
 Gets a value that indicates if the ServicePoint-class instances use the 100-Continue behavior. More...
 
static ASPOSECPP_SHARED_API void set_Expect100Continue (bool value)
 Sets a value that indicates if the ServicePoint-class instances use the 100-Continue behavior. More...
 
static ASPOSECPP_SHARED_API bool get_EnableDnsRoundRobin ()
 Gets a value that indicates if a DNS resolution rotates among the applicable IP addresses. More...
 
static ASPOSECPP_SHARED_API void set_EnableDnsRoundRobin (bool value)
 Sets a value that indicates if a DNS resolution rotates among the applicable IP addresses. More...
 
static ASPOSECPP_SHARED_API int32_t get_DnsRefreshTimeout ()
 Gets a timeout in milliseconds during which a DNS resolution is considered valid. More...
 
static ASPOSECPP_SHARED_API void set_DnsRefreshTimeout (int32_t value)
 Sets a timeout in milliseconds during which a DNS resolution is considered valid. More...
 
static ASPOSECPP_SHARED_API System::SharedPtr< ICertificatePolicy > get_CertificatePolicy ()
 Gets a certificate policy. More...
 
static ASPOSECPP_SHARED_API void set_CertificatePolicy (System::SharedPtr< ICertificatePolicy > value)
 Sets a certificate policy. More...
 
static ASPOSECPP_SHARED_API Security::RemoteCertificateValidationCallback get_ServerCertificateValidationCallback ()
 Gets the callback that is used to validate a server certificate. More...
 
static ASPOSECPP_SHARED_API void set_ServerCertificateValidationCallback (Security::RemoteCertificateValidationCallback value)
 Sets the callback that is used to validate a server certificate. More...
 
static ASPOSECPP_SHARED_API bool get_ReusePort ()
 Gets a value that indicates if the output connections sockets use the 'SO_REUSE_UNICASTPORT' option. More...
 
static ASPOSECPP_SHARED_API void set_ReusePort (bool value)
 Sets a value that indicates if the output connections sockets use the 'SO_REUSE_UNICASTPORT' option. More...
 
static ASPOSECPP_SHARED_API bool get_CheckCertificateRevocationList ()
 Gets a value that indicates if the certificate must be checked against the certificate authority revocation list. More...
 
static ASPOSECPP_SHARED_API void set_CheckCertificateRevocationList (bool value)
 Sets a value that indicates if the certificate must be checked against the certificate authority revocation list. More...
 
static ASPOSECPP_SHARED_API System::Net::Security::EncryptionPolicy get_EncryptionPolicy ()
 Returns the encryption policy that is used by the current instance. More...
 
static 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...
 
- 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...
 

Static Public Attributes

static ASPOSECPP_SHARED_API const int32_t DefaultNonPersistentConnectionLimit
 The default number of non-persistent connections. More...
 
static ASPOSECPP_SHARED_API const int32_t DefaultPersistentConnectionLimit
 The default number of persistent connections. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 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...
 
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...
 

Detailed Description

Manages the lifecycle stages (creating, maintaining, and deleting) of the ServicePoint class instances. 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

◆ get_CertificatePolicy()

static ASPOSECPP_SHARED_API System::SharedPtr<ICertificatePolicy> System::Net::ServicePointManager::get_CertificatePolicy ( )
static

Gets a certificate policy.

Returns
A certificate policy.

◆ get_CheckCertificateRevocationList()

static ASPOSECPP_SHARED_API bool System::Net::ServicePointManager::get_CheckCertificateRevocationList ( )
static

Gets a value that indicates if the certificate must be checked against the certificate authority revocation list.

Returns
A value that indicates if the certificate must be checked against the certificate authority revocation list.

◆ get_DefaultConnectionLimit()

static ASPOSECPP_SHARED_API int32_t System::Net::ServicePointManager::get_DefaultConnectionLimit ( )
static

Gets the maximum number of concurrent connections that are allowed by the ServicePoint-class instances.

Returns
The maximum number of concurrent connections that are allowed by the ServicePoint-class instances.

◆ get_DnsRefreshTimeout()

static ASPOSECPP_SHARED_API int32_t System::Net::ServicePointManager::get_DnsRefreshTimeout ( )
static

Gets a timeout in milliseconds during which a DNS resolution is considered valid.

Returns
A timeout in milliseconds during which a DNS resolution is considered valid.

◆ get_EnableDnsRoundRobin()

static ASPOSECPP_SHARED_API bool System::Net::ServicePointManager::get_EnableDnsRoundRobin ( )
static

Gets a value that indicates if a DNS resolution rotates among the applicable IP addresses.

Returns
A value that indicates if a DNS resolution rotates among the applicable IP addresses.

◆ get_EncryptionPolicy()

static ASPOSECPP_SHARED_API System::Net::Security::EncryptionPolicy System::Net::ServicePointManager::get_EncryptionPolicy ( )
static

Returns the encryption policy that is used by the current instance.

Returns
The encryption policy that is used by the current instance.

◆ get_Expect100Continue()

static ASPOSECPP_SHARED_API bool System::Net::ServicePointManager::get_Expect100Continue ( )
static

Gets a value that indicates if the ServicePoint-class instances use the 100-Continue behavior.

Returns
A value that indicates if the ServicePoint-class instances use the 100-Continue behavior.

◆ get_MaxServicePointIdleTime()

static ASPOSECPP_SHARED_API int32_t System::Net::ServicePointManager::get_MaxServicePointIdleTime ( )
static

Gets the maximum idle time of the ServicePoint-class instances.

Returns
The maximum idle time of the ServicePoint-class instances.

◆ get_MaxServicePoints()

static ASPOSECPP_SHARED_API int32_t System::Net::ServicePointManager::get_MaxServicePoints ( )
static

Gets the maximum number of the ServicePoint-class instances that can be managed by the current instance.

Returns
The maximum number of the ServicePoint-class instances that can be managed by the current instance.

◆ get_ReusePort()

static ASPOSECPP_SHARED_API bool System::Net::ServicePointManager::get_ReusePort ( )
static

Gets a value that indicates if the output connections sockets use the 'SO_REUSE_UNICASTPORT' option.

Returns
A value that indicates if the output connections sockets use the 'SO_REUSE_UNICASTPORT' option.

◆ get_SecurityProtocol()

static ASPOSECPP_SHARED_API SecurityProtocolType System::Net::ServicePointManager::get_SecurityProtocol ( )
static

Gets the security protocol type used by the ServicePoint-class instances that are managed by the current instance.

Returns
The security protocol type used by the ServicePoint-class instances that are managed by the current instance.

◆ get_ServerCertificateValidationCallback()

static ASPOSECPP_SHARED_API Security::RemoteCertificateValidationCallback System::Net::ServicePointManager::get_ServerCertificateValidationCallback ( )
static

Gets the callback that is used to validate a server certificate.

Returns
The callback that is used to validate a server certificate.

◆ get_UseNagleAlgorithm()

static ASPOSECPP_SHARED_API bool System::Net::ServicePointManager::get_UseNagleAlgorithm ( )
static

Gets a value that indicates if the ServicePoint-class instances use the Nagle algorithm.

Returns
A value that indicates if the ServicePoint-class instances use the Nagle algorithm.

◆ set_CertificatePolicy()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_CertificatePolicy ( System::SharedPtr< ICertificatePolicy >  value)
static

Sets a certificate policy.

Parameters
valueThe value to set.

◆ set_CheckCertificateRevocationList()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_CheckCertificateRevocationList ( bool  value)
static

Sets a value that indicates if the certificate must be checked against the certificate authority revocation list.

Parameters
valueThe value to set.

◆ set_DefaultConnectionLimit()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_DefaultConnectionLimit ( int32_t  value)
static

Sets the maximum number of concurrent connections that are allowed by the ServicePoint-class instances.

Parameters
valueThe value to set.

◆ set_DnsRefreshTimeout()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_DnsRefreshTimeout ( int32_t  value)
static

Sets a timeout in milliseconds during which a DNS resolution is considered valid.

Parameters
valueThe value to set.

◆ set_EnableDnsRoundRobin()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_EnableDnsRoundRobin ( bool  value)
static

Sets a value that indicates if a DNS resolution rotates among the applicable IP addresses.

Parameters
valueThe value to set.

◆ set_Expect100Continue()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_Expect100Continue ( bool  value)
static

Sets a value that indicates if the ServicePoint-class instances use the 100-Continue behavior.

Parameters
valueThe value to set.

◆ set_MaxServicePointIdleTime()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_MaxServicePointIdleTime ( int32_t  value)
static

Sets the maximum idle time of the ServicePoint-class instances.

Parameters
valueThe value to set.

◆ set_MaxServicePoints()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_MaxServicePoints ( int32_t  value)
static

Sets the maximum number of the ServicePoint-class instances that can be managed by the current instance.

Parameters
valueThe value to set.

◆ set_ReusePort()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_ReusePort ( bool  value)
static

Sets a value that indicates if the output connections sockets use the 'SO_REUSE_UNICASTPORT' option.

Parameters
valueThe value to set.

◆ set_SecurityProtocol()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_SecurityProtocol ( SecurityProtocolType  value)
static

Sets the security protocol type used by the ServicePoint-class instances that are managed by the current instance.

Parameters
valueThe value to set.

◆ set_ServerCertificateValidationCallback()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_ServerCertificateValidationCallback ( Security::RemoteCertificateValidationCallback  value)
static

Sets the callback that is used to validate a server certificate.

Parameters
valueThe value to set.

◆ set_UseNagleAlgorithm()

static ASPOSECPP_SHARED_API void System::Net::ServicePointManager::set_UseNagleAlgorithm ( bool  value)
static

Sets a value that indicates if the ServicePoint-class instances use the Nagle algorithm.

Parameters
valueThe value to set.

◆ SetTcpKeepAlive()

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

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.

Member Data Documentation

◆ DefaultNonPersistentConnectionLimit

ASPOSECPP_SHARED_API const int32_t System::Net::ServicePointManager::DefaultNonPersistentConnectionLimit
static

The default number of non-persistent connections.

◆ DefaultPersistentConnectionLimit

ASPOSECPP_SHARED_API const int32_t System::Net::ServicePointManager::DefaultPersistentConnectionLimit
static

The default number of persistent connections.