This documentation is archived and is not being maintained.

TcpClient.ReceiveBufferSize Property

Gets or sets the size of the receive buffer.

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

public int ReceiveBufferSize { get; set; }

Property Value

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

ExceptionCondition
SocketException

An error occurred when setting the buffer size.

-or-

In .NET Compact Framework applications, you cannot set this property. For a workaround, see the Platform Note in Remarks.

The ReceiveBufferSize property gets or sets the number of bytes that you are expecting to store in the receive buffer for each read operation. This property actually manipulates the network buffer space allocated for receiving incoming data.

Your network buffer should be at least as large as your application buffer to ensure that the desired data will be available when you call the NetworkStream.Read method. Use the ReceiveBufferSize property to set this size. If your application will be receiving bulk data, you should pass the Read method a very large application buffer.

If the network buffer is smaller than the amount of data you request in the Read method, you will not be able to retrieve the desired amount of data in one read operation. This incurs the overhead of additional calls to the Read method.

Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform Note: This property is supported only on datagram oriented sockets, specified as SOCK_DGRAM sockets in Windows CE. The default receive buffer size is 32768 and cannot be set with this property.

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

// 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 ());
   // 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(S"The receive buffer was successfully set to {0}", __box(tcpClient->ReceiveBufferSize));

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.

.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
Show: