TcpClient.ReceiveTimeout Property (System.Net.Sockets)

ReceiveTimeout Property

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

Public Property ReceiveTimeout As Integer

Visual Basic (Usage)

Dim instance As TcpClient
Dim value As Integer

value = instance.ReceiveTimeout

instance.ReceiveTimeout = value

public int ReceiveTimeout { get; set; }

Visual C++

public:
property int ReceiveTimeout {
    int get ();
    void set (int value);
}

JScript

public function get ReceiveTimeout () : int
public function set ReceiveTimeout (value : int)

Property Value

Type: System..::.Int32
The time-out value of the connection in milliseconds. The default value is 0.

Remarks

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.

Examples

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

Visual Basic

' Sets the receive time out using the ReceiveTimeout public property.
tcpClient.ReceiveTimeout = 5

' Gets the receive time out using the ReceiveTimeout public property.
If tcpClient.ReceiveTimeout = 5 Then
   Console.WriteLine(("The receive time out limit was successfully set " + tcpClient.ReceiveTimeout.ToString()))
End If

// 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 ());

Visual C++

// Sets the receive time out using the ReceiveTimeout public property.
tcpClient->ReceiveTimeout = 5;

// Gets the receive time out using the ReceiveTimeout public property.
if ( tcpClient->ReceiveTimeout == 5 )
      Console::WriteLine( "The receive time out limit was successfully set {0}", tcpClient->ReceiveTimeout );

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

TcpClient Class

TcpClient Members

System.Net.Sockets Namespace

Read

SendTimeout