TcpClient.SendBufferSize Property (System.Net.Sockets)

SendBufferSize Property

.NET Framework Class Library

TcpClient..::.SendBufferSize Property

Gets or sets the size of the send buffer.

Namespace: System.Net.Sockets
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

Public Property SendBufferSize As Integer

Visual Basic (Usage)

Dim instance As TcpClient
Dim value As Integer

value = instance.SendBufferSize

instance.SendBufferSize = value

public int SendBufferSize { get; set; }

Visual C++

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

JScript

public function get SendBufferSize () : int
public function set SendBufferSize (value : int)

Property Value

Type: System..::.Int32
The size of the send buffer, in bytes. The default value is 8192 bytes.

Remarks

The SendBufferSize property gets or sets the number of bytes that you are expecting to send in each call to the NetworkStream..::.Write method. This property actually manipulates the network buffer space allocated for send operation.

Your network buffer should be at least as large as your application buffer to ensure that the desired data will be stored and sent in one operation. Use the SendBufferSize property to set this size. If your application will be sending bulk data, you should pass the Write method a very large application buffer.

If the network buffer is smaller than the amount of data you provide the Write method, several network send operations will be performed for every call you make to the Write method. You can achieve greater data throughput by ensuring that your network buffer is at least as large as your application buffer.

Examples

The following code example sets and gets the send buffer size.

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

// 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 ());

Visual 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 );

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Reference

TcpClient Class

TcpClient Members

System.Net.Sockets Namespace

ReceiveBufferSize

Write