IWebSocketControl.OutboundBufferSizeInBytes Property

Definition

Namespace:

Windows.Networking.Sockets

The size, in bytes, of the send buffer to be used for sending data on an IWebSocket 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 = iWebSocketControl.outboundBufferSizeInBytes;
iWebSocketControl.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.

Remarks

This property sets the value of the SO_SNDBUF socket option on the TCP socket used by the IWebSocket. 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 IWebSocket 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.

This property must be set before the IWebSocket connection is made. It will not have any effect if set after the connection has been initiated.

See also

• IWebSocket
• SOL_SOCKET Socket Options