UdpAnySourceMulticastClient.BeginReceiveFromGroup Method

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.

Begins the operation of receiving a packet from the joined multicast group and invokes the specified callback when a packet has arrived on the group from any sender.

public:
 IAsyncResult ^ BeginReceiveFromGroup(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);

[System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)]
public IAsyncResult BeginReceiveFromGroup (byte[] buffer, int offset, int count, AsyncCallback callback, object state);

[<System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)>]
member this.BeginReceiveFromGroup : byte[] * int * int * AsyncCallback * obj -> IAsyncResult

Public Function BeginReceiveFromGroup (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

buffer

Byte[]

The buffer to store the received data.

offset

Int32

The offset, in bytes, from the beginning of the buffer where the data should be stored.

count

Int32

The maximum number of bytes to receive and store in the buffer.

callback

AsyncCallback

The callback method to invoke when the operation completes.

state

Object

Optional state information to pass to the callback method for this operation.

Returns

IAsyncResult

An IAsyncResult that references this operation.

Attributes

ObsoleteAttribute

Exceptions

ArgumentNullException

buffer is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

offset is less than 0

-or-

offset is greater than the length of the buffer.

-or-

count is less than 0

-or-

offset plus the count is greater than the length of the buffer.

InvalidOperationException

The multicast group has not yet been joined.

ObjectDisposedException

The UdpAnySourceMulticastClient has been disposed.

SocketException

An error occurred when attempting to access the socket.

Remarks

The BeginReceiveFromGroup method begins an operation of receiving a UDP packet from the joined multicast group from any sender. The local port and multicast group address are specified in the UdpAnySourceMulticastClient constructor. The multicast client must also have completed a join to the multicast group.

The method specified in the callback parameter is invoked when a packet has received.

It is possible to have a socket failure if a receive operation fails synchronously, although this is uncommon with UDP. If a socket failure occurs, a SocketException is thrown. The error received is specified as a member of the SocketError enumeration.