Send Async(SocketAsyncEventArgs) Method
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
The SocketAsyncEventArgs object to use for this asynchronous socket operation.
true if the I/O operation is pending. The Completed event on the
e parameter will be raised upon completion of the operation.
false if the I/O operation completed synchronously. 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.
A socket operation was already in progress using the SocketAsyncEventArgs object specified in the
Windows XP or later is required for this method.
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.
The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:
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.
Calling the SendAsync method gives you the ability to send data within a separate execution thread.
For message-oriented sockets, do not exceed the maximum message size of the underlying Windows sockets service provider. 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).
Note that the successful completion of the SendAsync method does not indicate that the data was successfully delivered.