Socket.ReceiveAsync Метод

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<int> ^ ReceiveAsync(ArraySegment<System::Byte> buffer);

public System.Threading.Tasks.Task<int> ReceiveAsync (ArraySegment<byte> buffer);

member this.ReceiveAsync : ArraySegment<byte> -> System.Threading.Tasks.Task<int>

Public Function ReceiveAsync (buffer As ArraySegment(Of Byte)) As Task(Of Integer)

Параметры

Возвращаемое значение

Асинхронная задача, которая завершается с количеством полученных байтов.

Исключения

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<int> ^ ReceiveAsync(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ buffers);

public System.Threading.Tasks.Task<int> ReceiveAsync (System.Collections.Generic.IList<ArraySegment<byte>> buffers);

member this.ReceiveAsync : System.Collections.Generic.IList<ArraySegment<byte>> -> System.Threading.Tasks.Task<int>

Public Function ReceiveAsync (buffers As IList(Of ArraySegment(Of Byte))) As Task(Of Integer)

Параметры

Возвращаемое значение

Асинхронная задача, которая завершается с количеством полученных байтов.

Исключения

Комментарии

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Receive(IList<ArraySegment<Byte>>).

Исходный код:

Socket.cs

Исходный код:

Socket.cs

Исходный код:

Socket.cs

public:
 bool ReceiveAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);

public bool ReceiveAsync (System.Net.Sockets.SocketAsyncEventArgs e);

member this.ReceiveAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool

Public Function ReceiveAsync (e As SocketAsyncEventArgs) As Boolean

Параметры

Возвращаемое значение

true, если операция ввода-вывода находится в состоянии ожидания. По завершении операции создается событие Completed в параметре e.

false, если операция ввода-вывода завершена синхронно. В данном случае событие Completed на параметре e не будет создано и объект e, передаваемый как параметр, можно изучить сразу после получения результатов вызова метода для извлечения результатов операции.

Исключения

Комментарии

Метод ReceiveAsync используется в подключенных или ограниченных сокетах без подключения и используется для чтения входящих данных. Локальный адрес сокета должен быть известен.

Для ограниченных сокетов без подключения эта функция ограничивает адреса, с которых принимаются сообщения. Функция возвращает сообщения только с удаленного адреса, указанного в соединении. Сообщения с других адресов отклоняются автоматически.

Свойство SocketAsyncEventArgs.SocketFlags параметра e предоставляет поставщику службы Window Sockets дополнительные сведения о запросе на чтение. Дополнительные сведения об использовании этого параметра см. в разделе System.Net.Sockets.SocketFlags.

Для успешного System.Net.Sockets.SocketAsyncEventArgs вызова этого метода требуются следующие свойства и события объекта :

• SocketAsyncEventArgs.Buffer или SocketAsyncEventArgs.BufferList

• SocketAsyncEventArgs.Count Значение , если SocketAsyncEventArgs.Buffer задано значение

• SocketAsyncEventArgs.Offset Значение , если SocketAsyncEventArgs.Buffer задано значение

• SocketAsyncEventArgs.Completed

Вызывающий объект может задать SocketAsyncEventArgs.UserToken для свойства любой объект пользовательского состояния, необходимый перед вызовом ReceiveAsync метода , чтобы данные можно было получить в методе обратного вызова. Если для обратного вызова требуется больше сведений, чем для одного объекта, можно создать небольшой класс для хранения других необходимых сведений о состоянии в качестве членов.

Для сокетов в стиле байтового потока входящие данные помещаются в буфер до заполнения буфера, закрытия соединения или исчерпания внутренне буферированных данных.

Для сокетов, ориентированных на сообщения, входящее сообщение помещается в буфер до общего размера буфера, связанного с параметром e . Если сообщение больше буфера, буфер заполняется первой частью сообщения.

Для сокетов, ориентированных на подключение, метод может указать корректное завершение виртуальной цепи одним из двух способов, зависящих от того, ReceiveAsync является ли сокет потоком байтов или ориентирован на сообщения. Для байтовых потоков ноль считанных байтов означает корректное закрытие и то, что больше байтов никогда не будет прочитано. Для сокетов, ориентированных на сообщения, где сообщение с нулевым байтом часто допускается, SocketException для обозначения корректного закрытия используется сокет с SocketAsyncEventArgs.SocketError собственным кодом ошибки Winsock WSAEDISCON (10101). В любом случае объект SocketException с SocketAsyncEventArgs.SocketError собственным кодом ошибки Winsock WSAECONNRESET (10054) указывает на прерывание закрытия.

См. также раздел

• SocketAsyncEventArgs
• Buffer
• BufferList
• Completed
• Count
• Offset
• UserToken

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<int> ^ ReceiveAsync(ArraySegment<System::Byte> buffer, System::Net::Sockets::SocketFlags socketFlags);

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

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

Public Function ReceiveAsync (buffer As ArraySegment(Of Byte), socketFlags As SocketFlags) As Task(Of Integer)

Параметры

Возвращаемое значение

Асинхронная задача, которая завершается с количеством полученных байтов.

Исключения

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

public:
 System::Threading::Tasks::Task<int> ^ ReceiveAsync(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ buffers, System::Net::Sockets::SocketFlags socketFlags);

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

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

Public Function ReceiveAsync (buffers As IList(Of ArraySegment(Of Byte)), socketFlags As SocketFlags) As Task(Of Integer)

Параметры

Возвращаемое значение

Асинхронная задача, которая завершается с количеством полученных байтов.

Исключения

Комментарии

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Receive(IList<ArraySegment<Byte>>, SocketFlags).

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

public System.Threading.Tasks.ValueTask<int> ReceiveAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

member this.ReceiveAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Function ReceiveAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Параметры

Возвращаемое значение

Асинхронная задача, которая завершается с количеством полученных байтов.

Исключения

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

Исходный код:

Socket.Tasks.cs

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

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

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

Параметры

Возвращаемое значение

Асинхронная задача, которая завершается с количеством полученных байтов.

Исключения