System.Net.Sockets.Socket.EndAccept Method

Asynchronously accepts an incoming connection attempt and creates a new System.Net.Sockets.Socket to handle remote host communication.

Syntax

public Socket EndAccept (IAsyncResult result)

Parameters

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

Returns

A System.Net.Sockets.Socket to handle communication with the remote host.

Exceptions

TypeReason
ArgumentNullException asyncResult is null.
ArgumentException asyncResult was not returned by the current instance from a call to the Socket.BeginAccept(AsyncCallback, object) method.
InvalidOperationException Socket.EndAccept(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.EndAccept(IAsyncResult) completes a call to Socket.BeginAccept(AsyncCallback, object). Before calling Socket.BeginAccept(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 the Socket.BeginAccept(AsyncCallback, object) method returns. It must accept the asyncResult parameter returned from the Socket.BeginAccept(AsyncCallback, object) method.

Within the callback method, call the IAsyncResult.AsyncState method of the asyncResult parameter to obtain the System.Net.Sockets.Socket on which the connection attempt is being made. After obtaining the System.Net.Sockets.Socket, you can call the Socket.EndAccept(IAsyncResult) method to successfully complete the connection attempt.

The Socket.EndAccept(IAsyncResult) method blocks until a connection is pending in the incoming connection queue. The Socket.EndAccept(IAsyncResult) method accepts the incoming connection and returns a new System.Net.Sockets.Socket that can be used to send data to and receive data from the remote host.

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, which uses the Socket.EndAccept(IAsyncResult) method, 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