SslStream.WriteTimeout プロパティ

.NET Framework クラス ライブラリ リファレンス

SslStream.WriteTimeout プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

書き込み操作がブロックしてデータを待機する時間を取得または設定します。

名前空間: System.Net.Security
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Overrides Property
 WriteTimeout As Integer

Visual Basic (使用法)

Dim instance As SslStream
Dim value As Integer

value = instance.WriteTimeout

instance.WriteTimeout = value

C#

public override int WriteTimeout { get;
 set; }

C++

public:
virtual property int WriteTimeout {
    int get () override;
    void set (int value)
 override;
}

J#

/** @property */
public int get_WriteTimeout ()

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

JScript

public override function get
 WriteTimeout () : int

public override function set
 WriteTimeout (value : int)

プロパティ値
同期書き込み操作が失敗するまでの時間を指定する Int32。

解説

このプロパティは、基になるストリームの WriteTimeout を呼び出すことによって返される値を返します。設定操作では、指定した値によって基になるストリームの WriteTimeout 値が設定されます。

基になるストリームが NetworkStream の場合、WriteTimeout はミリ秒単位です。また、書き込み操作がタイムアウトしないように、既定では Infinite に設定されます。

使用例

このプロパティの値を設定するコード例を次に示します。

C#

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.
    try 
    {
        sslStream.AuthenticateAsServer(serverCertificate, 
            false, SslProtocols.Tls, true);
        // Display the properties and settings for the authenticated
 stream.
        DisplaySecurityLevel(sslStream);
        DisplaySecurityServices(sslStream);
        DisplayCertificateInformation(sslStream);
        DisplayStreamProperties(sslStream);

        // 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.");
        sslStream.Write(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.");
        sslStream.Close();
        client.Close();
        return;
    }
    finally
    {
        // The client stream will be closed with the sslStream
        // because we specified this behavior when creating
        // the sslStream.
        sslStream.Close();
        client.Close();
    }
}

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SslStream クラス
SslStream メンバ
System.Net.Security 名前空間