Socket.EndReceiveMessageFrom(IAsyncResult, SocketFlags, EndPoint, IPPacketInformation) Method

Definition

Namespace:
System.Net.Sockets
Assembly:
System.Net.Sockets.dll
Assembly:
System.dll
Assembly:
netstandard.dll

Ends a pending asynchronous read from a specific endpoint. This method also reveals more information about the packet than EndReceiveFrom(IAsyncResult, EndPoint).

public:
 int EndReceiveMessageFrom(IAsyncResult ^ asyncResult, System::Net::Sockets::SocketFlags % socketFlags, System::Net::EndPoint ^ % endPoint, [Runtime::InteropServices::Out] System::Net::Sockets::IPPacketInformation % ipPacketInformation);
public int EndReceiveMessageFrom (IAsyncResult asyncResult, ref System.Net.Sockets.SocketFlags socketFlags, ref System.Net.EndPoint endPoint, out System.Net.Sockets.IPPacketInformation ipPacketInformation);
member this.EndReceiveMessageFrom : IAsyncResult * SocketFlags * EndPoint * IPPacketInformation -> int
Public Function EndReceiveMessageFrom (asyncResult As IAsyncResult, ByRef socketFlags As SocketFlags, ByRef endPoint As EndPoint, ByRef ipPacketInformation As IPPacketInformation) As Integer

Parameters

asyncResult
IAsyncResult

An IAsyncResult that stores state information and any user defined data for this asynchronous operation.

socketFlags
SocketFlags

A bitwise combination of the SocketFlags values for the received packet.

endPoint
EndPoint

The source EndPoint.

ipPacketInformation
IPPacketInformation

The IPAddress and interface of the received packet.

Returns

Int32

If successful, the number of bytes received. If unsuccessful, returns 0.

Exceptions

ArgumentNullException

asyncResult is null

-or-

endPoint is null.

ArgumentException

asyncResult was not returned by a call to the BeginReceiveMessageFrom(Byte[], Int32, Int32, SocketFlags, EndPoint, AsyncCallback, Object) method.

InvalidOperationException

EndReceiveMessageFrom(IAsyncResult, SocketFlags, EndPoint, IPPacketInformation) was previously called for the asynchronous read.

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

Remarks

If the operation has not completed, this method blocks until it does.

To perform this operation synchronously, use the ReceiveMessageFrom method.

Examine ipPacketInformation if you need to know if the datagram was sent using a unicast, multicast, or broadcast address.

Applies to