Socket.EndSend Method (IAsyncResult, SocketError)

Ends a pending asynchronous send.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

'Declaration
Public Function EndSend ( _
	asyncResult As IAsyncResult, _
	<OutAttribute> ByRef errorCode As SocketError _
) As Integer

Parameters

asyncResult
Type: System.IAsyncResult

An IAsyncResult that stores state information for this asynchronous operation.

errorCode
Type: System.Net.Sockets.SocketError

A SocketError object that stores the socket error.

Return Value

Type: System.Int32
If successful, the number of bytes sent to the Socket; otherwise, an invalid Socket error.

ExceptionCondition
ArgumentNullException

asyncResult is Nothing.

ArgumentException

asyncResult was not returned by a call to the BeginSend method.

InvalidOperationException

EndSend was previously called for the asynchronous send.

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

EndSend completes the asynchronous send operation started in BeginSend.

Before calling BeginSend, 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 BeginSend returns. The callback method must accept the IAsyncResult returned by the BeginSend method as a parameter.

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

If you are using a connectionless protocol, EndSend will block until the datagram is sent. If you are using a connection-oriented protocol, EndSend will block until some of the buffer was sent. If the return value from EndSend indicates that the buffer was not completely sent, call the BeginSend method again, modifying the buffer to hold the unsent data.

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 BeginSend method means that the underlying system has had room to buffer your data for a network send.

NoteNote

If you receive a 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.

NoteNote

All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes.

NoteNote

The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode.

NoteNote

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft