NetworkStream.WriteTimeout プロパティ

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

NetworkStream.WriteTimeout プロパティ

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

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

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

Visual Basic (宣言)

Public Overrides Property
 WriteTimeout As Integer

Visual Basic (使用法)

Dim instance As NetworkStream
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。既定値は Infinite で、書き込み操作がタイムアウトしないことを示します。

例外

例外の種類	条件
ArgumentOutOfRangeException	指定した値が 0 以下のため Infinite ではありません。

解説

このプロパティで指定した時間内に書き込み操作が完了しない場合、書き込み操作は IOException をスローします。

メモ
このプロパティは、Write メソッドの呼び出しで実行される同期の書き込み操作だけに適用されます。このプロパティは、BeginWrite メソッドの呼び出しで実行される非同期書き込みには適用されません。

使用例

ネットワーク ストリームの書き込みタイムアウトを 10 ミリ秒に設定するコード例を次に示します。

C#

using System;
using System.Text;
using System.Net;
using System.Net.Sockets;

namespace Examples.System.Net
{
    public class TCPListenerExample
    {
        public static void
 Main()
        {
            // Create the server side connection and 
            // start listening for clients.
            TcpListener tcpListener = new TcpListener(IPAddress.Any
,11000);
            tcpListener.Start();
            Console.WriteLine("Waiting for a connection....");

            // Accept the pending client connection.
            TcpClient tcpClient = tcpListener.AcceptTcpClient();
            Console.WriteLine("Connection accepted.");
            // Get the stream to write the message 
            // that will be sent to the client.
            NetworkStream networkStream = tcpClient.GetStream();
            string responseString = "Hello.";
            // Set the write timeout to 10 millseconds.
            networkStream.WriteTimeout = 10;
            // Convert the message to a byte array and sent it to the
 client.
            Byte[] sendBytes = Encoding.UTF8.GetBytes(responseString);
            networkStream.Write(sendBytes, 0, sendBytes.Length);
            Console.WriteLine("Message Sent.");
            // Close the connection to the client.
            tcpClient.Close();
            // Stop listening for incoming connections
            // and close the server.
            tcpListener.Stop();
        }
    }
}

C++

#using <System.dll>
using namespace System;
using namespace System::Text;
using namespace System::Net;
using namespace System::Net::Sockets;

int main()
{
    // Create the server side connection and
    // start listening for clients.
    TcpListener^ tcpListener = gcnew TcpListener(IPAddress::Any, 11000);
    tcpListener->Start();
    Console::WriteLine("Waiting for a connection....");

    // Accept the pending client connection.
    TcpClient^ tcpClient = tcpListener->AcceptTcpClient();
    Console::WriteLine("Connection accepted.");
    // Get the stream to write the message
    // that will be sent to the client.
    NetworkStream^ networkStream = tcpClient->GetStream();
    String^ responseString = "Hello.";
    // Set the write timeout to 10 millseconds.
    networkStream->WriteTimeout = 10;
    // Convert the message to a byte array and sent it to the client.
    array<Byte>^ sendBytes = Encoding::UTF8->GetBytes(responseString);
    networkStream->Write(sendBytes, 0, sendBytes->Length);
    Console::WriteLine("Message Sent.");
    // Close the connection to the client.
    tcpClient->Close();
    // Stop listening for incoming connections
    // and close the server.
    tcpListener->Stop();
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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
.NET Compact Framework
サポート対象 : 2.0

参照

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