TcpListener.BeginAcceptTcpClient(AsyncCallback, Object) Method

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Source:

TCPListener.cs

Begins an asynchronous operation to accept an incoming connection attempt.

public:
 IAsyncResult ^ BeginAcceptTcpClient(AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginAcceptTcpClient (AsyncCallback? callback, object? state);

member this.BeginAcceptTcpClient : AsyncCallback * obj -> IAsyncResult

Public Function BeginAcceptTcpClient (callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

callback

AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state

Object

A user-defined object containing information about the accept operation. This object is passed to the callback delegate when the operation is complete.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous creation of the TcpClient.

Exceptions

SocketException

An error occurred while attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

Remarks

The asynchronous BeginAcceptTcpClient operation must be completed by calling the EndAcceptTcpClient method. Typically, the method is invoked by the callback delegate.

This method does not block until the operation completes. To block until the operation completes, use the AcceptTcpClient method.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously.

Note

If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation 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 Network Tracing in the .NET Framework.