TcpClient.SendBufferSize プロパティ

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

TcpClient.SendBufferSize プロパティ

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

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

Visual Basic (宣言)

Public Property SendBufferSize As
 Integer

Visual Basic (使用法)

Dim instance As TcpClient
Dim value As Integer

value = instance.SendBufferSize

instance.SendBufferSize = value

C#

public int SendBufferSize { get;
 set; }

C++

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

J#

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

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

JScript

public function get SendBufferSize
 () : int

public function set SendBufferSize
 (value : int)

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

解説

SendBufferSize プロパティは、NetworkStream.Write メソッドを呼び出すたびに送信するバイト数を取得または設定します。このプロパティは、ネットワーク バッファで送信操作に割り当てられている場所を実際に操作します。

ネットワーク バッファは、少なくともアプリケーション バッファと同じくらいのサイズがなければなりません。これは、1 回の操作で必要なデータが格納および送信されるようにするためです。SendBufferSize プロパティを使用してこのサイズを設定します。アプリケーションが大量のデータを送信する場合は、Write メソッドに大量のアプリケーション バッファを渡す必要があります。

ネットワーク バッファが Write メソッドに提供されたデータ量よりも少ない場合は、Write メソッドを呼び出すたびに複数のネットワーク送信操作が実行されます。ネットワーク バッファが少なくともアプリケーション バッファと同じくらいのサイズであれば、大量のデータ スループットを実現できます。

使用例

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

Visual Basic

'Sets the send buffer size using the SendBufferSize public property.
tcpClient.SendBufferSize = 1024

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

C#

// Sets the send buffer size using the SendBufferSize public property.
tcpClient.SendBufferSize = 1024;

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

C++

//sets the send buffer size using the SendBufferSize public property.
tcpClient->SendBufferSize = 1024;

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

J#

// Sets the send buffer size using the SendBufferSize public property.
tcpClient.set_SendBufferSize(1024);

// Gets the send buffer size using the SendBufferSize public property.
if (tcpClient.get_SendBufferSize() == 1024) {
    Console.WriteLine("The send buffer was successfully set
 to "
        + ((Int32)tcpClient.get_SendBufferSize()).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 名前空間
TcpClient.ReceiveBufferSize プロパティ
Write