Socket.SendAsync(SocketAsyncEventArgs) Method

Definition

Выполняет асинхронную передачу данных на подключенный объект Socket.Sends data asynchronously to a connected Socket object.

public:
 bool SendAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);
public bool SendAsync (System.Net.Sockets.SocketAsyncEventArgs e);
member this.SendAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Function SendAsync (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

Свойства Buffer или BufferList на параметре e должны ссылаться на допустимые буферы.The Buffer or BufferList properties on the e parameter must reference valid buffers. Может быть установлено одно из этих свойств, но нельзя одновременно устанавливать оба свойства.One or the other of these properties may be set, but not both at the same time.

Операция сокета уже выполнялась с использованием объекта 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.

Объект Socket уже не подключен или он был получен посредством метода Accept(), AcceptAsync(SocketAsyncEventArgs) или BeginAccept.The Socket is not yet connected or was not obtained via an Accept(), AcceptAsync(SocketAsyncEventArgs),or BeginAccept, method.

Remarks

Метод SendAsync используется для записи исходящих данных из одного или нескольких буферов на сокете, ориентированном на соединение.The SendAsync method is used to write outgoing data from one or more buffers on a connection-oriented socket. Однако этот метод можно также использовать для сокетов без подключения, которые указали удаленный узел в операции подключения.This method can also be used, however, on connectionless sockets that have specified a remote host on a connect operation.

Метод SendAsync запускает асинхронную операцию отправки на удаленный узел, установленный в Accept, AcceptAsync, BeginAccept, BeginConnect, Connectили в методе ConnectAsync.The SendAsync method starts an asynchronous send operation to the remote host established in the Accept, AcceptAsync, BeginAccept, BeginConnect, Connect, or ConnectAsync method.

Следующие свойства и события для объекта 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 значение любого объекта пользовательского состояния, требуемого перед вызовом метода SendAsync, чтобы информация была извлечена в методе обратного вызова.The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the SendAsync 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.

Метод SendAsync вызывает исключение, если не выполняется первый вызов Accept, AcceptAsync, BeginAcceptBeginConnect, Connectили ConnectAsync.The SendAsync method will throw an exception if you do not first call Accept, AcceptAsync, BeginAcceptBeginConnect, Connect, or ConnectAsync.

Вызов метода SendAsync дает возможность отправки данных в отдельном потоке выполнения.Calling the SendAsync method gives you the ability to send data within a separate execution thread.

Для сокетов, ориентированных на сообщения, не следует превысить максимальный размер сообщения в базовом поставщике службы Windows Sockets.For message-oriented sockets, do not exceed the maximum message size of the underlying Windows sockets service provider. Если данные слишком длинны для передачи атомарным образом через базового поставщика услуг, данные не передаются, а метод SendAsync создает SocketException с SocketAsyncEventArgs.SocketErrorным кодом ошибки Winsock ВСАЕМСГСИЗЕ (10040).If the data is too long to pass atomically through the underlying service provider, no data is transmitted and the SendAsync method throws a SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAEMSGSIZE error code (10040).

Обратите внимание, что успешное завершение метода SendAsync не означает, что данные были успешно доставлены.Note that the successful completion of the SendAsync method does not indicate that the data was successfully delivered.

Applies to

See also