Windows Dev Center

IWebSocketControl.OutboundBufferSizeInBytes property

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

Syntax


uint OutboundBufferSizeInBytes { get; set; }

Property value

Type: System.UInt32 [.NET] | uint32 [C++]

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.

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.winmd

See also

SOL_SOCKET Socket Options
IWebSocket
IWebSocketControl

 

 

Show:
© 2015 Microsoft