mscorlib(4.0.0.0) API with additions
System.Net.ServicePoint Class Reference

Provides connection management for HTTP connections. More...

Collaboration diagram for System.Net.ServicePoint:
[legend]

Public Member Functions

bool CloseConnectionGroup (string connectionGroupName)
 Removes the specified connection group from this T:System.Net.ServicePoint object. More...
 
void SetTcpKeepAlive (bool enabled, int keepAliveTime, int keepAliveInterval)
 Enables or disables the keep-alive option on a TCP connection. More...
 

Public Attributes

DateTime IdleSince => m_IdleSince
 Gets the date and time that the T:System.Net.ServicePoint object was last connected to a host. More...
 
string ConnectionName => m_ConnectionName
 Gets the connection name. More...
 

Properties

BindIPEndPoint BindIPEndPointDelegate [get, set]
 Specifies the delegate to associate a local T:System.Net.IPEndPoint with a T:System.Net.ServicePoint. More...
 
int ConnectionLeaseTimeout [get, set]
 Gets or sets the number of milliseconds after which an active T:System.Net.ServicePoint connection is closed. More...
 
Uri Address [get]
 Gets the Uniform Resource Identifier (URI) of the server that this T:System.Net.ServicePoint object connects to. More...
 
int??? MaxIdleTime [get, set]
 Gets or sets the amount of time a connection associated with the T:System.Net.ServicePoint object can remain idle before the connection is closed. More...
 
bool UseNagleAlgorithm [get, set]
 Gets or sets a T:System.Boolean value that determines whether the Nagle algorithm is used on connections managed by this T:System.Net.ServicePoint object. More...
 
int ReceiveBufferSize [get, set]
 Gets or sets the size of the receiving buffer for the socket used by this T:System.Net.ServicePoint. More...
 
bool Expect100Continue [get, set]
 Gets or sets a T:System.Boolean value that determines whether 100-Continue behavior is used. More...
 
virtual Version ProtocolVersion [get]
 Gets the version of the HTTP protocol that the T:System.Net.ServicePoint object uses. More...
 
int??? ConnectionLimit [get, set]
 Gets or sets the maximum number of connections allowed on this T:System.Net.ServicePoint object. More...
 
int CurrentConnections [get]
 Gets the number of open connections associated with this T:System.Net.ServicePoint object. More...
 
X509Certificate Certificate [get]
 Gets the certificate received for this T:System.Net.ServicePoint object. More...
 
X509Certificate ClientCertificate [get]
 Gets the last client certificate sent to the server. More...
 
bool SupportsPipelining [get]
 Indicates whether the T:System.Net.ServicePoint object supports pipelined connections. More...
 

Detailed Description

Provides connection management for HTTP connections.

Definition at line 16 of file ServicePoint.cs.

Member Function Documentation

◆ CloseConnectionGroup()

bool System.Net.ServicePoint.CloseConnectionGroup ( string  connectionGroupName)

Removes the specified connection group from this T:System.Net.ServicePoint object.

Parameters
connectionGroupNameThe name of the connection group that contains the connections to close and remove from this service point.
Returns
A T:System.Boolean value that indicates whether the connection group was closed.

Definition at line 724 of file ServicePoint.cs.

◆ SetTcpKeepAlive()

void System.Net.ServicePoint.SetTcpKeepAlive ( bool  enabled,
int  keepAliveTime,
int  keepAliveInterval 
)

Enables or disables the keep-alive option on a TCP connection.

Parameters
enabledIf set to true, then the TCP keep-alive option on a TCP connection will be enabled using the specified keepAliveTime and keepAliveInterval values. If set to false, then the TCP keep-alive option is disabled and the remaining parameters are ignored.The default value is false.
keepAliveTimeSpecifies the timeout, in milliseconds, with no activity until the first keep-alive packet is sent. The value must be greater than 0. If a value of less than or equal to zero is passed an T:System.ArgumentOutOfRangeException is thrown.
keepAliveIntervalSpecifies the interval, in milliseconds, between when successive keep-alive packets are sent if no acknowledgement is received.The value must be greater than 0. If a value of less than or equal to zero is passed an T:System.ArgumentOutOfRangeException is thrown.
Exceptions
T:System.ArgumentOutOfRangeExceptionThe value specified for keepAliveTime or keepAliveInterval parameter is less than or equal to 0.

Definition at line 800 of file ServicePoint.cs.

Member Data Documentation

◆ ConnectionName

string System.Net.ServicePoint.ConnectionName => m_ConnectionName

Gets the connection name.

Returns
A T:System.String that represents the connection name.

Definition at line 395 of file ServicePoint.cs.

◆ IdleSince

DateTime System.Net.ServicePoint.IdleSince => m_IdleSince

Gets the date and time that the T:System.Net.ServicePoint object was last connected to a host.

Returns
A T:System.DateTime object that contains the date and time at which the T:System.Net.ServicePoint object was last connected.

Definition at line 364 of file ServicePoint.cs.

Property Documentation

◆ Address

Uri System.Net.ServicePoint.Address
get

Gets the Uniform Resource Identifier (URI) of the server that this T:System.Net.ServicePoint object connects to.

Returns
An instance of the T:System.Uri class that contains the URI of the Internet server that this T:System.Net.ServicePoint object connects to.
Exceptions
T:System.NotSupportedExceptionThe T:System.Net.ServicePoint is in host mode.

Definition at line 246 of file ServicePoint.cs.

◆ BindIPEndPointDelegate

BindIPEndPoint System.Net.ServicePoint.BindIPEndPointDelegate
getset

Specifies the delegate to associate a local T:System.Net.IPEndPoint with a T:System.Net.ServicePoint.

Returns
A delegate that forces a T:System.Net.ServicePoint to use a particular local Internet Protocol (IP) address and port number. The default value is null.

Definition at line 192 of file ServicePoint.cs.

◆ Certificate

X509Certificate System.Net.ServicePoint.Certificate
get

Gets the certificate received for this T:System.Net.ServicePoint object.

Returns
An instance of the T:System.Security.Cryptography.X509Certificates.X509Certificate class that contains the security certificate received for this T:System.Net.ServicePoint object.

Definition at line 473 of file ServicePoint.cs.

◆ ClientCertificate

X509Certificate System.Net.ServicePoint.ClientCertificate
get

Gets the last client certificate sent to the server.

Returns
An T:System.Security.Cryptography.X509Certificates.X509Certificate object that contains the public values of the last client certificate sent to the server.

Definition at line 488 of file ServicePoint.cs.

◆ ConnectionLeaseTimeout

int System.Net.ServicePoint.ConnectionLeaseTimeout
getset

Gets or sets the number of milliseconds after which an active T:System.Net.ServicePoint connection is closed.

Returns
A T:System.Int32 that specifies the number of milliseconds that an active T:System.Net.ServicePoint connection remains open. The default is -1, which allows an active T:System.Net.ServicePoint connection to stay connected indefinitely. Set this property to 0 to force T:System.Net.ServicePoint connections to close after servicing a request.
Exceptions
T:System.ArgumentOutOfRangeExceptionThe value specified for a set operation is a negative number less than -1.

Definition at line 210 of file ServicePoint.cs.

◆ ConnectionLimit

int??? System.Net.ServicePoint.ConnectionLimit
getset

Gets or sets the maximum number of connections allowed on this T:System.Net.ServicePoint object.

Returns
The maximum number of connections allowed on this T:System.Net.ServicePoint object.
Exceptions
T:System.ArgumentOutOfRangeExceptionThe connection limit is equal to or less than 0.

Definition at line 401 of file ServicePoint.cs.

◆ CurrentConnections

int System.Net.ServicePoint.CurrentConnections
get

Gets the number of open connections associated with this T:System.Net.ServicePoint object.

Returns
The number of open connections associated with this T:System.Net.ServicePoint object.

Definition at line 455 of file ServicePoint.cs.

◆ Expect100Continue

bool System.Net.ServicePoint.Expect100Continue
getset

Gets or sets a T:System.Boolean value that determines whether 100-Continue behavior is used.

Returns
true to expect 100-Continue responses for POST requests; otherwise, false. The default value is true.

Definition at line 351 of file ServicePoint.cs.

◆ MaxIdleTime

int??? System.Net.ServicePoint.MaxIdleTime
getset

Gets or sets the amount of time a connection associated with the T:System.Net.ServicePoint object can remain idle before the connection is closed.

Returns
The length of time, in milliseconds, that a connection associated with the T:System.Net.ServicePoint object can remain idle before it is closed and reused for another connection.
Exceptions
T:System.ArgumentOutOfRangeExceptionP:System.Net.ServicePoint.MaxIdleTime is set to less than F:System.Threading.Timeout.Infinite or greater than F:System.Int32.MaxValue.

Definition at line 282 of file ServicePoint.cs.

◆ ProtocolVersion

virtual Version System.Net.ServicePoint.ProtocolVersion
get

Gets the version of the HTTP protocol that the T:System.Net.ServicePoint object uses.

Returns
A T:System.Version object that contains the HTTP protocol version that the T:System.Net.ServicePoint object uses.

Definition at line 369 of file ServicePoint.cs.

◆ ReceiveBufferSize

int System.Net.ServicePoint.ReceiveBufferSize
getset

Gets or sets the size of the receiving buffer for the socket used by this T:System.Net.ServicePoint.

Returns
A T:System.Int32 that contains the size, in bytes, of the receive buffer. The default is 8192.
Exceptions
T:System.ArgumentOutOfRangeExceptionThe value specified for a set operation is greater than F:System.Int32.MaxValue.

Definition at line 332 of file ServicePoint.cs.

◆ SupportsPipelining

bool System.Net.ServicePoint.SupportsPipelining
get

Indicates whether the T:System.Net.ServicePoint object supports pipelined connections.

Returns
true if the T:System.Net.ServicePoint object supports pipelined connections; otherwise, false.

Definition at line 504 of file ServicePoint.cs.

◆ UseNagleAlgorithm

bool System.Net.ServicePoint.UseNagleAlgorithm
getset

Gets or sets a T:System.Boolean value that determines whether the Nagle algorithm is used on connections managed by this T:System.Net.ServicePoint object.

Returns
true to use the Nagle algorithm; otherwise, false. The default value is true.

Definition at line 317 of file ServicePoint.cs.


The documentation for this class was generated from the following file: