UdpSingleSourceMulticastClient.SendBufferSize Property

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.dll

Caution

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Gets or sets the size, in bytes, of the send buffer of the Socket used for multicast send operations on this UdpSingleSourceMulticastClient instance.

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

[System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)]
public int SendBufferSize { get; set; }

[<System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)>]
member this.SendBufferSize : int with get, set

Public Property SendBufferSize As Integer

Property Value

Int32

Returns Int32.

The size, in bytes, of the send buffer.

Attributes

ObsoleteAttribute

Exceptions

ArgumentOutOfRangeException

The buffer size specified is less than 0.

InvalidOperationException

The multicast group has not yet been joined.

ObjectDisposedException

The UdpSingleSourceMulticastClient has been disposed.

Remarks

The SendBufferSize property gets or sets the size, in bytes, of the send buffer of the underlying Socket used for multicast send operations on this UdpSingleSourceMulticastClient instance.

On Mac OS X, the SendBufferSize property controls how many bytes can be in the network stack's waiting-to-be-sent buffer before additional calls to the BeginSendToSource method start failing. Applications on Mac OS X may need to be concerned with this property if they are sending a large number of UDP packets in a short timeframe.

On Windows, calls to the BeginSendToSource method will take longer to call the callback depending on the value of the SendBufferSize property if the send buffer is full. The SendBufferSize property only controls whether the user's buffer stays locked in physical memory until the send completes.

The default size of the send buffer on Windows is 8,192.