StreamWebSocketControl.OutboundBufferSizeInBytes Property

Reference

Definition

Namespace:: Windows.Networking.Sockets

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

The size, in bytes, of the send buffer to be used for sending data on a StreamWebSocket object.

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

uint32_t OutboundBufferSizeInBytes();

void OutboundBufferSizeInBytes(uint32_t value);

public uint OutboundBufferSizeInBytes { get; set; }

var uInt32 = streamWebSocketControl.outboundBufferSizeInBytes;
streamWebSocketControl.outboundBufferSizeInBytes = uInt32;

Public Property OutboundBufferSizeInBytes As UInteger

Property Value

UInt32

unsigned int

uint32_t

The size, in bytes, of the send buffer to be used for sending data.

Implements

OutboundBufferSizeInBytes

Remarks

The OutboundBufferSizeInBytes property sets the value of the SO_SNDBUF socket option on the TCP socket used by the StreamWebSocket. The default value is the local computer's default send buffer size. This value varies based on the system memory size. For more detailed information, see SOL_SOCKET Socket Options in the Windows Sockets documentation.

For most apps, this property should not be set since this disables TCP send auto-tuning by the system on this StreamWebSocket object. With TCP send auto-tuning disabled, network throughput is often worse especially on a connections with high latency. So this property should only be used in very specific situations.

The OutboundBufferSizeInBytes property must be set before the StreamWebSocket is connected. Setting this property after the MessageWebSocket is connected has no effect.

Applies to