Sends data asynchronously to a connected System.Net.Sockets.Socket object.
Syntax
Parameters
- e
Returns
Returns true if the I/O operation is pending. The SocketAsyncEventArgs.Completed event on the e parameter will be raised upon completion of the operation.
Returns false if the I/O operation completed synchronously. In this case, The SocketAsyncEventArgs.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.
Remarks
The Socket.SendAsync(SocketAsyncEventArgs) 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 Socket.SendAsync(SocketAsyncEventArgs) method starts an asynchronous send operation to the remote host established in the Socket.Accept, Socket.AcceptAsync(SocketAsyncEventArgs), erload:System.Net.Sockets.Socket.BeginAccept, erload:System.Net.Sockets.Socket.BeginConnect, erload:System.Net.Sockets.Socket.Connect, or Socket.ConnectAsync(SocketAsyncEventArgs) method.
The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required to successfully call this method:
SocketAsyncEventArgs.Buffer or SocketAsyncEventArgs.BufferList
SocketAsyncEventArgs.Count if SocketAsyncEventArgs.Buffer is set
SocketAsyncEventArgs.Offset if SocketAsyncEventArgs.Buffer is set
The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the Socket.SendAsync(SocketAsyncEventArgs) 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.
The Socket.SendAsync(SocketAsyncEventArgs) method will throw an exception if you do not first call Socket.Accept, Socket.AcceptAsync(SocketAsyncEventArgs), erload:System.Net.Sockets.Socket.BeginAccept erload:System.Net.Sockets.Socket.BeginConnect, erload:System.Net.Sockets.Socket.Connect, or Socket.ConnectAsync(SocketAsyncEventArgs).
Calling the Socket.SendAsync(SocketAsyncEventArgs) 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 Socket.SendAsync(SocketAsyncEventArgs) method throws a System.Net.Sockets.SocketException with the SocketAsyncEventArgs.SocketError set to the native Winsock WSAEMSGSIZE error code (10040).
Note that the successful completion of the Socket.SendAsync(SocketAsyncEventArgs) method does not indicate that the data was successfully delivered.
Requirements
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0