NegotiateStream.ReadTimeout Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the amount of time a read operation blocks waiting for data.
public:
virtual property int ReadTimeout { int get(); void set(int value); };public override int ReadTimeout { get; set; }member this.ReadTimeout : int with get, setPublic Overrides Property ReadTimeout As IntegerProperty Value
A Int32 that specifies the amount of time that will elapse before a read operation fails.
Examples
The following code example demonstrates displaying the value of this property.
static void DisplayStreamProperties( NegotiateStream^ stream )
{
Console::WriteLine( L"Can read: {0}", stream->CanRead );
Console::WriteLine( L"Can write: {0}", stream->CanWrite );
Console::WriteLine( L"Can seek: {0}", stream->CanSeek );
try
{
// If the underlying stream supports it, display the length.
Console::WriteLine( L"Length: {0}", stream->Length );
}
catch ( NotSupportedException^ )
{
Console::WriteLine( L"Cannot get the length of the underlying stream." );
}
if ( stream->CanTimeout )
{
Console::WriteLine( L"Read time-out: {0}", stream->ReadTimeout );
Console::WriteLine( L"Write time-out: {0}", stream->WriteTimeout );
}
}
static void DisplayStreamProperties(NegotiateStream stream)
{
Console.WriteLine("Can read: {0}", stream.CanRead);
Console.WriteLine("Can write: {0}", stream.CanWrite);
Console.WriteLine("Can seek: {0}", stream.CanSeek);
try
{
// If the underlying stream supports it, display the length.
Console.WriteLine("Length: {0}", stream.Length);
} catch (NotSupportedException)
{
Console.WriteLine("Cannot get the length of the underlying stream.");
}
if (stream.CanTimeout)
{
Console.WriteLine("Read time-out: {0}", stream.ReadTimeout);
Console.WriteLine("Write time-out: {0}", stream.WriteTimeout);
}
}
Remarks
This property returns the value returned by invoking the ReadTimeout property on the underlying stream. When you set this property, the ReadTimeout value on the underlying stream is set to the specified value.
If the underlying stream is a NetworkStream, ReadTimeout is in milliseconds and is set to Infinite by default so that read operations do not time out.
