This documentation is archived and is not being maintained.

TcpClient.ReceiveTimeout Property

Gets or sets the amount of time a TcpClient will wait to receive data once a read operation is initiated.

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

public int ReceiveTimeout { get; set; }
/** @property */
public int get_ReceiveTimeout ()

/** @property */
public void set_ReceiveTimeout (int value)

public function get ReceiveTimeout () : int

public function set ReceiveTimeout (value : int)

Property Value

The time-out value of the connection in milliseconds. The default value is 0.

The ReceiveTimeout property determines the amount of time that the Read method will block until it is able to receive data. This time is measured in milliseconds. If the time-out expires before Read successfully completes, TcpClient throws a IOException. There is no time-out by default.

Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform Note: In .NET Compact Framework applications, the ReceiveTimeout enumeration value is supported but reserved for future use. Because the ReceiveTimeout property uses this enumeration value, it will raise SocketException until the enumeration value is available in a future release of the .NET Compact Framework.

The following code example sets and gets the receive time out.

// Sets the receive time out using the ReceiveTimeout public property.
tcpClient.ReceiveTimeout = 5000;

// Gets the receive time out using the ReceiveTimeout public property.
if (tcpClient.ReceiveTimeout == 5000)
    Console.WriteLine ("The receive time out limit was successfully set " + tcpClient.ReceiveTimeout.ToString ());


// Sets the receive time out using the ReceiveTimeout public property.
tcpClient.set_ReceiveTimeout(5);

// Gets the receive time out using the ReceiveTimeout public property.
if (tcpClient.get_ReceiveTimeout() == 5) {
    Console.WriteLine("The receive time out limit was successfully set "
        + ((Int32)tcpClient.get_ReceiveTimeout()).ToString());
}

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Show: