Gets or sets information about the linger state of the associated socket.
Syntax
Value
Documentation for this section has not yet been entered.
Remarks
The TcpClient.LingerState property changes the way Socket.Close method behaves. This property when set modifies the conditions under which the connection can be reset by Winsock. Connection resets can still occur based on the IP protocol behavior.
This property controls the length of time that the TCP connection will remain open after a call to TcpClient.Close when data remains to be sent. When you call the NetworkStream.Write(Byte[], int, int) method, data is placed in the outgoing network buffer. This property can be used to ensure that this data is sent to the remote host before the TcpClient.Close method drops the connection.
To enable lingering, create a System.Net.Sockets.LingerOption instance containing the desired values, and set the TcpClient.LingerState property to this instance.
The following table describes the behavior of the TcpClient.Close method for the possible values of the LingerOption.Enabled property and the LingerOption.LingerTime property stored in the TcpClient.LingerState property.
| false (disabled), the default value |
The time-out is not applicable, (default). |
Attempts to send pending data until the default IP protocol time-out expires. |
| true (enabled) |
A nonzero time-out |
Attempts to send pending data until the specified time-out expires, and if the attempt fails, then Winsock resets the connection. |
| true (enabled) |
A zero timeout. |
Discards any pending data and Winsock resets the connection. |
The IP stack computes the default IP protocol time-out period to use based on the round trip time of the connection. In most cases, the time-out computed by the stack is more relevant than one defined by an application. This is the default behavior for a socket when the TcpClient.LingerState property is not set.
When the LingerOption.LingerTime property stored in the TcpClient.LingerState property is set greater than the default IP protocol time-out, the default IP protocol time-out will still apply and override.
Requirements
Assembly: System (in System.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0