UdpSingleSourceMulticastClient.EndReceiveFromSource Method

Definition

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 EndReceiveFromSource(IAsyncResult ^ result, [Runtime::InteropServices::Out] int % sourcePort);
[System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)]
public int EndReceiveFromSource (IAsyncResult result, out int sourcePort);
[<System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)>]
member this.EndReceiveFromSource : IAsyncResult * int -> int
Public Function EndReceiveFromSource (result As IAsyncResult, ByRef sourcePort As Integer) As Integer

Parameters

result
IAsyncResult

The result of the asynchronous receive operation.

sourcePort
Int32

The source endpoint where the packet was received from.

Returns

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

Attributes

Exceptions

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

The multicast group has not yet been joined.

An error occurred when attempting to access the socket.

Remarks

The EndReceiveFromSource method completes an asynchronous operation to receive a packet from a single source in 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.

Applies to