Socket.ReceiveFromAsync(SocketAsyncEventArgs) Method

Definition

Начинает выполнение асинхронного приема данных с указанного сетевого устройства.Begins to asynchronously receive data from a specified network device.

public:
 bool ReceiveFromAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);
public bool ReceiveFromAsync (System.Net.Sockets.SocketAsyncEventArgs e);
member this.ReceiveFromAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Function ReceiveFromAsync (e As SocketAsyncEventArgs) As Boolean

Parameters

e
SocketAsyncEventArgs

Объект SocketAsyncEventArgs для использования в данной асинхронной операции сокета.The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Returns

Boolean

true, если операция ввода-вывода находится в состоянии ожидания.true if the I/O operation is pending. По завершении операции создается событие Completed в параметре e.The Completed event on the e parameter will be raised upon completion of the operation.

false, если операция ввода-вывода завершена синхронно.false if the I/O operation completed synchronously. В данном случае событие Completed на параметре e не будет создано и объект e, передаваемый как параметр, можно изучить сразу после получения результатов вызова метода для извлечения результатов операции.In this case, The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

Exceptions

Объект RemoteEndPoint не может иметь значение "null".The RemoteEndPoint cannot be null.

Операция сокета уже выполнялась с использованием объекта SocketAsyncEventArgs, указанного в параметре e.A socket operation was already in progress using the SocketAsyncEventArgs object specified in the e parameter.

Этот метод доступен только в Windows XP и более поздних версиях.Windows XP or later is required for this method.

Socket был закрыт.The Socket has been closed.

Произошла ошибка при попытке доступа к сокету.An error occurred when attempting to access the socket.

Remarks

Метод ReceiveFromAsync используется в основном для получения данных в сокете без подключения.The ReceiveFromAsync method is used primarily to receive data on a connectionless socket. Локальный адрес сокета должен быть известен.The socket's local address must be known.

Вызывающий объект должен присвоить свойству SocketAsyncEventArgs.RemoteEndPoint IPEndPoint удаленного узла, от которого должны быть получены данные.The caller must set the SocketAsyncEventArgs.RemoteEndPoint property to the IPEndPoint of the remote host from which the data is to be received.

Свойство SocketAsyncEventArgs.SocketFlags в параметре e предоставляет поставщику службы оконных сокетов дополнительные сведения о запросе на чтение.The SocketAsyncEventArgs.SocketFlags property on the e parameter provides the Window Sockets service provider with additional information about the read request. Дополнительные сведения об использовании этого параметра см. в разделе System.Net.Sockets.SocketFlags.For more information about how to use this parameter, see System.Net.Sockets.SocketFlags.

Следующие свойства и события для объекта System.Net.Sockets.SocketAsyncEventArgs необходимы для успешного вызова этого метода:The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:

Вызывающий объект может задать для свойства SocketAsyncEventArgs.UserToken значение любого объекта пользовательского состояния, требуемого перед вызовом метода ReceiveFromAsync, чтобы информация была извлечена в методе обратного вызова.The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the ReceiveFromAsync method, so that the information will be retrievable in the callback method. Если для обратного вызова требуется больше сведений, чем для одного объекта, можно создать небольшой класс для хранения других требуемых сведений о состоянии в качестве членов.If the callback needs more information than a single object, a small class can be created to hold the other required state information as members.

Для сокетов, ориентированных на сообщения, входящее сообщение помещается в буфер вплоть до общего размера буфера.For message-oriented sockets, an incoming message is placed into the buffer up to the total size of the buffer. Свойства SocketAsyncEventArgs.Count и SocketAsyncEventArgs.Offset определяют место размещения данных в буфере и объем данных.The SocketAsyncEventArgs.Count and SocketAsyncEventArgs.Offset properties determine where in the buffer the data is placed and the amount of data.

Для сокетов типа Byte входящие данные помещаются в буфер до тех пор, пока буфер не будет заполнен, соединение будет закрыто или исчерпаны внутренние буферизованные данные.For byte stream-style sockets, incoming data is placed into the buffer until the buffer is filled, the connection is closed, or the internally buffered data is exhausted. Свойства SocketAsyncEventArgs.Count и SocketAsyncEventArgs.Offset определяют место размещения данных в буфере и объем данных.The SocketAsyncEventArgs.Count and SocketAsyncEventArgs.Offset properties determine where in the buffer the data is placed and the amount of data.

Applies to

See also