UdpAnySourceMulticastClient.ReceiveBufferSize 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 receive buffer of the Socket used for multicast receive operations on this UdpAnySourceMulticastClient instance.

public:
 property int ReceiveBufferSize { 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 ReceiveBufferSize { 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.ReceiveBufferSize : int with get, set

Public Property ReceiveBufferSize As Integer

Property Value

Int32

Returns Int32.

The size, in bytes, of the receive buffer.

Attributes

ObsoleteAttribute

Exceptions

ArgumentOutOfRangeException

The buffer size specified is less than 0.

InvalidOperationException

The multicast group has not yet been joined.

ObjectDisposedException

The UdpAnySourceMulticastClient has been disposed.

Remarks

The ReceiveBufferSize property gets or sets the size, in bytes, of the receive buffer of the underlying Socket used for multicast receive operations on this UdpAnySourceMulticastClient instance. Specifically, the ReceiveBufferSize property controls the size of the buffer used by the stack when a packet arrives, but the application has not yet called the BeginReceiveFromGroup method. If this buffer gets filled up and packets keep coming before the application calls the BeginReceiveFromGroup and EndReceiveFromGroup methods, old packets will get dropped. The application will never be able to receive the old packets, and will instead receive newer packets when it calls the BeginReceiveFromGroup method.

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