System.Net.Sockets.Socket.EndSendTo Method

Ends a pending asynchronous send to a specific location.

Syntax

public int EndSendTo (IAsyncResult result)

Parameters

result
A IAsyncResult object that holds the state information for the asynchronous operation.

Returns

If successful, the number of bytes sent; otherwise, an invalid System.Net.Sockets.Socket error.

Exceptions

TypeReason
ArgumentNullException asyncResult is null.
ArgumentException asyncResult was not returned by the current instance from a call to the Socket.SendTo(Byte[], int, int, SocketFlags, System.Net.EndPoint) method.
InvalidOperationException Socket.EndSendTo(IAsyncResult) was previously called for this operation.
System.Net.Sockets.SocketException
Note: For additional information on causes of the SocketException, see the System.Net.Sockets.SocketException class.
ObjectDisposedExceptionThe current instance has been disposed.

Remarks

Socket.EndSendTo(IAsyncResult) completes the asynchronous send operation started in Socket.BeginSendTo(Byte[], int, int, SocketFlags, System.Net.EndPoint, AsyncCallback, object).

Before calling Socket.BeginSendTo(Byte[], int, int, SocketFlags, System.Net.EndPoint, AsyncCallback, object), you need to create a callback method that implements the AsyncCallback delegate. This callback method executes in a separate thread and is called by the system after Socket.BeginReceive(Byte[], int, int, SocketFlags, AsyncCallback, object) returns. The callback method must accept the IAsyncResult returned by the Socket.BeginSendTo(Byte[], int, int, SocketFlags, System.Net.EndPoint, AsyncCallback, object) method as a parameter.

Within the callback method, call the IAsyncResult.AsyncState method of the IAsyncResult parameter to obtain the sending System.Net.Sockets.Socket. After obtaining the System.Net.Sockets.Socket, you can call the Socket.EndSendTo(IAsyncResult) method to successfully complete the send operation and return the number of bytes sent.

If you are using a connectionless protocol, Socket.EndSendTo(IAsyncResult) will block until the datagram is sent. If you are using a connection-oriented protocol, Socket.EndSendTo(IAsyncResult) will block until the requested number of bytes are sent. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the Socket.BeginSendTo(Byte[], int, int, SocketFlags, System.Net.EndPoint, AsyncCallback, object) method means that the underlying system has had room to buffer your data for a network send.

Note:

If you receive a System.Net.Sockets.SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

Note:

This member outputs trace information when you enable network tracing in your application. For more information, see [<topic://conUsingNetworkTracing>].

Example

For an outline of an asynchronous operation, see the Socket.BeginAccept(AsyncCallback, object) method. For the complete example, see the System.Net.Sockets.Socket class overview.

Requirements

Namespace: System.Net.Sockets
Assembly: System (in System.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0