Export (0) Print
Expand All

TcpClient.LingerState Property

Gets or sets information about the linger state of the associated socket.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

public LingerOption LingerState { get; set; }

Property Value

Type: System.Net.Sockets.LingerOption
A LingerOption. By default, lingering is disabled.

The LingerState property changes the way 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 Close when data remains to be sent. When you call the Write 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 Close method drops the connection.

To enable lingering, create a LingerOption instance containing the desired values, and set the LingerState property to this instance.

The following table describes the behavior of the Close method for the possible values of the Enabled property and the LingerTime property stored in the LingerState property.

LingerState.Enabled

LingerState.LingerTime

Behavior

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 LingerState property is not set.

When the LingerTime property stored in the LingerState property is set greater than the default IP protocol time-out, the default IP protocol time-out will still apply and override.

The following code example sets and gets the sockets linger time.

        // sets the amount of time to linger after closing, using the LingerOption public property.
        LingerOption lingerOption = new LingerOption (true, 10);

        tcpClient.LingerState = lingerOption;

        // gets the amount of linger time set, using the LingerOption public property. 
        if (tcpClient.LingerState.LingerTime == 10)
            Console.WriteLine ("The linger state setting was successfully set to " + tcpClient.LingerState.LingerTime.ToString ());

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft