UdpAnySourceMulticastClient.EndReceiveFromGroup 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.

Completes the asynchronous operation of receiving a packet from the joined multicast group and provides the information received.

public:
 int EndReceiveFromGroup(IAsyncResult ^ result, [Runtime::InteropServices::Out] System::Net::IPEndPoint ^ % source);

[System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)]
public int EndReceiveFromGroup (IAsyncResult result, out System.Net.IPEndPoint source);

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

Public Function EndReceiveFromGroup (result As IAsyncResult, ByRef source As IPEndPoint) As Integer

Parameters

result

IAsyncResult

The result of the asynchronous receive operation.

source

IPEndPoint

The source endpoint where the packet was received from.

Returns

Int32

The length, in bytes, of the message stored in the buffer parameter passed to the BeginReceiveFromGroup(Byte[], Int32, Int32, AsyncCallback, Object) method.

Attributes

ObsoleteAttribute

Exceptions

ArgumentNullException

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

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 EndReceiveFromGroup method completes an asynchronous operation to receive a packet from a multicast group.

If there is a socket failure while performing the receive operation, a SocketException is thrown. The error received is specified as a member of the SocketError enumeration.