TcpClient.ReceiveBufferSize プロパティ

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

TcpClient.ReceiveBufferSize プロパティ

受信バッファのサイズを取得または設定します。

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

Visual Basic (宣言)

Public Property ReceiveBufferSize As
 Integer

Visual Basic (使用法)

Dim instance As TcpClient
Dim value As Integer

value = instance.ReceiveBufferSize

instance.ReceiveBufferSize = value

C#

public int ReceiveBufferSize { get;
 set; }

C++

public:
property int ReceiveBufferSize {
    int get ();
    void set (int value);
}

J#

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

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

JScript

public function get ReceiveBufferSize
 () : int

public function set ReceiveBufferSize
 (value : int)

プロパティ値
受信バッファ サイズ (バイト単位)。既定値は 8192 バイトです。

例外

例外の種類	条件
SocketException	バッファ サイズの設定中にエラーが発生しました。 または .NET Compact Framework アプリケーションでは、このプロパティは設定できません。代替手段については、「解説」の「プラットフォームメモ」を参照してください。

解説

ReceiveBufferSize プロパティはユーザーがそれぞれの読み取り操作について受信バッファに格納するバイト数を取得または設定します。このプロパティは、ネットワーク バッファで受信データに割り当てられている場所を実際に操作します。

ネットワーク バッファは、少なくともアプリケーション バッファと同じくらいのサイズがなければなりません。これは、NetworkStream.Read メソッドを呼び出すときに必要なデータを使用できるようにするためです。ReceiveBufferSize プロパティを使用してこのサイズを設定します。アプリケーションが大量のデータを受信する場合は、Read メソッドに大量のアプリケーション バッファを渡す必要があります。

ネットワーク バッファが Read メソッドに必要なデータ量よりも少ない場合は、必要な量のデータを 1 回の読み取り操作で取得することはできません。このため、Read メソッドをさらに呼び出すというオーバーヘッドが生じることになります。

Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows CE プラットフォームメモ : このプロパティは、Windows CE の SOCK_DGRAM ソケットとして指定された、データグラム指向のソケットでだけサポートされています。既定の受信バッファ サイズは 32768 で、このプロパティでは設定できません。

使用例

受信バッファ サイズを設定および取得するコード例を次に示します。

Visual Basic

' Sets the receive buffer size using the ReceiveBufferSize public property.
tcpClient.ReceiveBufferSize = 1024

' Gets the receive buffer size using the ReceiveBufferSize public property.
If tcpClient.ReceiveBufferSize = 1024 Then
   Console.WriteLine(("The receive buffer was successfully set
 to " + tcpClient.ReceiveBufferSize.ToString()))
End If

C#

// Sets the receive buffer size using the ReceiveBufferSize public property.
tcpClient.ReceiveBufferSize = 1024;

// Gets the receive buffer size using the ReceiveBufferSize public property.
if (tcpClient.ReceiveBufferSize == 1024)
    Console.WriteLine ("The receive buffer was successfully set
 to " + tcpClient.ReceiveBufferSize.ToString ());

C++

// sets the receive buffer size using the ReceiveBufferSize public property.
tcpClient->ReceiveBufferSize = 1024;

// gets the receive buffer size using the ReceiveBufferSize public property.
if ( tcpClient->ReceiveBufferSize == 1024 )
      Console::WriteLine( "The receive buffer was successfully set
 to {0}", tcpClient->ReceiveBufferSize );

J#

// Sets the receive buffer size using the ReceiveBufferSize public
// property.
tcpClient.set_ReceiveBufferSize(1024);

// Gets the receive buffer size using the ReceiveBufferSize public
// property.
if (tcpClient.get_ReceiveBufferSize() == 1024) {
    Console.WriteLine("The receive buffer was successfully set
 to "
        + ((Int32)tcpClient.get_ReceiveBufferSize()).ToString());
}

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

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