SocketTaskExtensions.ReceiveAsync Method

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Overloads

ReceiveAsync(Socket, ArraySegment<Byte>, SocketFlags)	Receives data from a connected socket.
ReceiveAsync(Socket, IList<ArraySegment<Byte>>, SocketFlags)	Receives data from a connected socket.
ReceiveAsync(Socket, Memory<Byte>, SocketFlags, CancellationToken)	Receives data from a connected socket.

ReceiveAsync(Socket, ArraySegment<Byte>, SocketFlags)

Source:

SocketTaskExtensions.cs

Receives data from a connected socket.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<int> ^ ReceiveAsync(System::Net::Sockets::Socket ^ socket, ArraySegment<System::Byte> buffer, System::Net::Sockets::SocketFlags socketFlags);

public static System.Threading.Tasks.Task<int> ReceiveAsync (this System.Net.Sockets.Socket socket, ArraySegment<byte> buffer, System.Net.Sockets.SocketFlags socketFlags);

static member ReceiveAsync : System.Net.Sockets.Socket * ArraySegment<byte> * System.Net.Sockets.SocketFlags -> System.Threading.Tasks.Task<int>

<Extension()>
Public Function ReceiveAsync (socket As Socket, buffer As ArraySegment(Of Byte), socketFlags As SocketFlags) As Task(Of Integer)

Parameters

socket

Socket

The socket to perform the receive operation on.

buffer

ArraySegment<Byte>

An array that is the storage location for the received data.

socketFlags

SocketFlags

A bitwise combination of the SocketFlags values.

Returns

Task<Int32>

A task that represents the asynchronous receive operation. The value of the TResult parameter contains the number of bytes received.

Exceptions

ObjectDisposedException

The Socket has been closed.

SocketException

An error occurred when attempting to access the socket.

ReceiveAsync(Socket, IList<ArraySegment<Byte>>, SocketFlags)

Source:

SocketTaskExtensions.cs

Receives data from a connected socket.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<int> ^ ReceiveAsync(System::Net::Sockets::Socket ^ socket, System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ buffers, System::Net::Sockets::SocketFlags socketFlags);

public static System.Threading.Tasks.Task<int> ReceiveAsync (this System.Net.Sockets.Socket socket, System.Collections.Generic.IList<ArraySegment<byte>> buffers, System.Net.Sockets.SocketFlags socketFlags);

static member ReceiveAsync : System.Net.Sockets.Socket * System.Collections.Generic.IList<ArraySegment<byte>> * System.Net.Sockets.SocketFlags -> System.Threading.Tasks.Task<int>

<Extension()>
Public Function ReceiveAsync (socket As Socket, buffers As IList(Of ArraySegment(Of Byte)), socketFlags As SocketFlags) As Task(Of Integer)

Parameters

socket

Socket

The socket to perform the receive operation on.

buffers

IList<ArraySegment<Byte>>

An array that is the storage location for the received data.

socketFlags

SocketFlags

A bitwise combination of the SocketFlags values.

Returns

Task<Int32>

A task that represents the asynchronous receive operation. The value of the TResult parameter contains the number of bytes received.

Exceptions

ArgumentNullException

The buffers parameter was null.

ObjectDisposedException

The Socket has been closed.

SocketException

An error occurred when attempting to access the socket.

ReceiveAsync(Socket, Memory<Byte>, SocketFlags, CancellationToken)

Source:

SocketTaskExtensions.cs

Receives data from a connected socket.

public static System.Threading.Tasks.ValueTask<int> ReceiveAsync (this System.Net.Sockets.Socket socket, Memory<byte> buffer, System.Net.Sockets.SocketFlags socketFlags, System.Threading.CancellationToken cancellationToken = default);

static member ReceiveAsync : System.Net.Sockets.Socket * Memory<byte> * System.Net.Sockets.SocketFlags * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

<Extension()>
Public Function ReceiveAsync (socket As Socket, buffer As Memory(Of Byte), socketFlags As SocketFlags, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parameters

socket

Socket

The socket to perform the receive operation on.

buffer

Memory<Byte>

A region of memory that is the storage location for the received data.

socketFlags

SocketFlags

A bitwise combination of the SocketFlags values.

cancellationToken

CancellationToken

A cancellation token that can be used to signal the asynchronous operation should be canceled.

Returns

ValueTask<Int32>

A task that completes with the number of bytes received, or 0 if the end of the stream has been reached.

Exceptions

ObjectDisposedException

The Socket has been closed.

SocketException

An error occurred when attempting to access the socket.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.