Socket.EndReceiveMessageFrom Method

Definition

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, ref System.Net.Sockets.SocketFlags socketFlags, ref System.Net.EndPoint endPoint, out System.Net.Sockets.IPPacketInformation ipPacketInformation);

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

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

Exceptions

asyncResult is null

-or-

endPoint is null.

An error occurred when attempting to access the socket.

-or-

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

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

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1