Gets or sets the amount of time to remain connected after calling the Socket.Close method if data remains to be sent.
Assembly: System (in System.dll)
Use this value if you want to determine how long a closed Socket will attempt to transfer unsent data before timing out. You can also set this value to the desired time-out period, in seconds.
If the Enabled property is true, and you set to 0, the Socket discards any pending data to send in the outgoing network buffer. If you change this value, you must pass the altered LingerOption instance to the SetSocketOption method or set the LingerState or LingerState property.
false (disabled), the default value
The time-out is not applicable, (default).
Attempts to send pending data for a connection-oriented socket (TCP, for example) until the default IP protocol time-out expires.
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.
A zero timeout.
Discards any pending data. For connection-oriented socket (TCP, for example), 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 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 example displays the value of this property.
Console.WriteLine ("This application will timeout if Send does not return within " + Encoding.ASCII.GetString (s.GetSocketOption (SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))); // blocks until send returns int i = s.Send (msg); // blocks until read returns byte bytes = new byte; s.Receive (bytes); //Display to the screen Console.WriteLine (Encoding.ASCII.GetString (bytes)); s.Shutdown (SocketShutdown.Both); Console.WriteLine ("If data remains to be sent, this application will stay open for " + ((LingerOption)s.GetSocketOption (SocketOptionLevel.Socket, SocketOptionName.Linger)).LingerTime.ToString ()); s.Close ();
Console::Write("This application will timeout if Send does not return within "); Console::WriteLine(Encoding::ASCII->GetString(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 4))); // Blocks until send returns. int i = s->Send(msg); // Blocks until read returns. Byte bytes = new Byte; s->Receive(bytes); //Displays to the screen. Console::WriteLine(Encoding::ASCII->GetString(bytes)); s->Shutdown(SocketShutdown::Both); Console::Write("If data remains to be sent, this application will stay open for "); Console::WriteLine(__box(__try_cast<LingerOption *> (s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime)->ToString()); s->Close();
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.