UdpClient.ReceiveAsync UdpClient.ReceiveAsync UdpClient.ReceiveAsync UdpClient.ReceiveAsync Method

Definition

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

public:
 System::Threading::Tasks::Task<System::Net::Sockets::UdpReceiveResult> ^ ReceiveAsync();
public System.Threading.Tasks.Task<System.Net.Sockets.UdpReceiveResult> ReceiveAsync ();
member this.ReceiveAsync : unit -> System.Threading.Tasks.Task<System.Net.Sockets.UdpReceiveResult>
Public Function ReceiveAsync () As Task(Of UdpReceiveResult)

Returns

The task object representing the asynchronous operation.

Exceptions

An error occurred when accessing the socket.

Remarks

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 for a detailed description of the error.

Warning

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.

Applies to