WriteTimeout Property

SslStream.WriteTimeout Property

Gets or sets the amount of time a write operation blocks waiting for data.

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

public override int WriteTimeout { get; set; }
/** @property */
public int get_WriteTimeout ()

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

public override function get WriteTimeout () : int

public override function set WriteTimeout (value : int)

Not applicable.

Property Value

A Int32 that specifies the amount of time that elapses before a synchronous write operation fails.

This property returns the value returned by invoking WriteTimeout on the underlying stream. For set operations, the specified value sets the WriteTimeout value on the underlying stream.

If the underlying stream is a NetworkStream, WriteTimeout is in milliseconds and is set to Infinite by default so that write operations do not timeout.

The following code example demonstrates setting the value of this property.

static void ProcessClient (TcpClient client)
    // A client has connected. Create the 
    // SslStream using the client's network stream.
    SslStream sslStream = new SslStream(
        client.GetStream(), false);
    // Authenticate the server but don't require the client to authenticate.
            false, SslProtocols.Tls, true);
        // Display the properties and settings for the authenticated stream.

        // Set timeouts for the read and write to 5 seconds.
        sslStream.ReadTimeout = 5000;
        sslStream.WriteTimeout = 5000;
        // Read a message from the client.   
        Console.WriteLine("Waiting for client message...");
        string messageData = ReadMessage(sslStream);
        Console.WriteLine("Received: {0}", messageData);
        // Write a message to the client.
        byte[] message = Encoding.UTF8.GetBytes("Hello from the server.<EOF>");
        Console.WriteLine("Sending hello message.");
    catch (AuthenticationException e)
        Console.WriteLine("Exception: {0}", e.Message);
        if (e.InnerException != null)
            Console.WriteLine("Inner exception: {0}", e.InnerException.Message);
        Console.WriteLine ("Authentication failed - closing the connection.");
        // The client stream will be closed with the sslStream
        // because we specified this behavior when creating
        // the sslStream.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

© 2015 Microsoft