UdpClient.ReceiveAsync Method ()

.NET Framework (current version)
 

Returns a UDP datagram asynchronously that was sent by a remote host.

Namespace:   System.Net.Sockets
Assembly:  System (in System.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public Task<UdpReceiveResult> ReceiveAsync()

Return Value

Type: System.Threading.Tasks.Task<UdpReceiveResult>

Returns Task<TResult>.

The task object representing the asynchronous operation.

Exception Condition
ObjectDisposedException

The underlying Socket has been closed.

SocketException

An error occurred when accessing the socket. See the Remarks section for more information.

This operation will not block. The returned Task<TResult>> object will complete after the UDP packet has been received.

If you specify a default remote host in the Connect method, this method will accept datagrams from that host only. All other datagrams will be discarded.

If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code. Once you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation in MSDN for a detailed description of the error.

System_CAPS_warningWarning

If you intend to receive multicasted datagrams, do not call the Connect method prior to calling this method. The UdpClient you use to receive datagrams must be created using the multicast port number.

.NET Framework
Available since 4.5
Return to top
Show: