Socket.EndReceiveMessageFrom Method

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Source:

Socket.cs

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.

-or-

.NET 7+ only: The Socket has been closed.

ObjectDisposedException

.NET Framework, .NET Core, and .NET 5-6 only: The Socket has been closed.

Remarks

Important

This is a compatibility API. We don't recommend using the APM (Begin* and End*) methods for new development. Instead, use the Task-based equivalents.

EndReceiveFrom completes the operation started by BeginReceiveFrom. You need to pass the IAsyncResult created by the matching BeginReceiveFrom call. EndReceiveFrom will block the calling thread until the operation is completed.

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

Note

If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code.