NetworkStream::ReadTimeout Property
.NET Framework (current version)
Gets or sets the amount of time that a read operation blocks waiting for data.
Assembly: System (in System.dll)
public: property int ReadTimeout { virtual int get() override; virtual void set(int value) override; }
Property Value
Type: System::Int32A Int32 that specifies the amount of time, in milliseconds, that will elapse before a read operation fails. The default value, Infinite, specifies that the read operation does not time out.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | The value specified is less than or equal to zero and is not Infinite. |
If the read operation does not complete within the time specified by this property, the read operation throws an IOException.
The following code example sets the read time-out for a network stream to 10 milliseconds.
// Create a client that will connect to a // server listening on the contosoServer computer // at port 11000. TcpClient tcpClient = new TcpClient(); tcpClient.Connect("contosoServer", 11000); // Get the stream used to read the message sent by the server. NetworkStream networkStream = tcpClient.GetStream(); // Set a 10 millisecond timeout for reading. networkStream.ReadTimeout = 10; // Read the server message into a byte buffer. byte[] bytes = new byte[1024]; networkStream.Read(bytes, 0, 1024); //Convert the server's message into a string and display it. string data = Encoding.UTF8.GetString(bytes); Console.WriteLine("Server sent message: {0}", data); networkStream.Close(); tcpClient.Close();
.NET Framework
Available since 2.0
Available since 2.0
Show:
