TcpListener..::.EndAcceptTcpClient Method
This page is specific to:.NET Framework Version:2.03.03.54.0
.NET Framework Class Library
TcpListener..::.EndAcceptTcpClient Method

Asynchronously accepts an incoming connection attempt and creates a new TcpClient to handle remote host communication.

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

'Usage

Dim instance As TcpListener
Dim asyncResult As IAsyncResult
Dim returnValue As TcpClient

returnValue = instance.EndAcceptTcpClient(asyncResult)

'Declaration

Public Function EndAcceptTcpClient ( _
    asyncResult As IAsyncResult _
) As TcpClient

Parameters

asyncResult
Type: System..::.IAsyncResult
An IAsyncResult returned by a call to the BeginAcceptTcpClient method.
Remarks

This method blocks until the operation is complete. To perform this operation synchronously, use the AcceptTcpClient method.

NoteNote:

You can call the RemoteEndPoint property of the underlying socket (Client) to identify the remote host's network address and port number.

NoteNote:

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 in the MSDN library at http://msdn.microsoft.com/library/ for a detailed description of the error.

NoteNote:

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

Examples

The following code example demonstrates the use of the BeginAcceptTcpClient method to create and connect a socket. The callback delegate calls the EndAcceptTcpClient method to end the asynchronous request.

' Thread signal.
Public Shared tcpClientConnected As New ManualResetEvent(False)


' Accept one client connection asynchronously.
Public Shared Sub DoBeginAcceptTcpClient(listener As TcpListener)
   ' Set the event to nonsignaled state.
   tcpClientConnected.Reset()

   ' Start to listen for connections from a client.
   Console.WriteLine("Waiting for a connection...")

   ' Accept the connection. 
   ' BeginAcceptSocket() creates the accepted socket.
   listener.BeginAcceptTcpClient(New AsyncCallback(AddressOf DoAcceptTcpClientCallback), listener)

   ' Wait until a connection is made and processed before 
   ' continuing.
   tcpClientConnected.WaitOne()
End Sub 'DoBeginAcceptTcpClient


' Process the client connection.
Public Shared Sub DoAcceptTcpClientCallback(ar As IAsyncResult)
   ' Get the listener that handles the client request.
   Dim listener As TcpListener = CType(ar.AsyncState, TcpListener)

   ' End the operation and display the received data on 
   ' the console.
   Dim client As TcpClient = listener.EndAcceptTcpClient(ar)

   ' Process the connection here. (Add the client to a
   ' server table, read data, etc.)
   Console.WriteLine("Client connected completed")

   ' Signal the calling thread to continue.
   tcpClientConnected.Set()
End Sub 'DoAcceptTcpClientCallback



// Thread signal.
static ManualResetEvent* tcpClientConnected = 
    new ManualResetEvent(false);

// Accept one client connection asynchronously.
static void DoBeginAcceptTcpClient(TcpListener* listener)
{
    // Set the event to nonsignaled state.
    tcpClientConnected->Reset();

    // Start to listen for connections from a client.
    Console::WriteLine("Waiting for a connection...");

    // Accept the connection. 
    // BeginAcceptSocket() creates the accepted socket.
    listener->BeginAcceptTcpClient(
        new AsyncCallback(0, 
                        &tcplistener::DoAcceptTcpClientCallback), 
        listener);

    // Wait until a connection is made and processed before
    // continuing.
    tcpClientConnected->WaitOne();
}

// Process the client connection.
static void DoAcceptTcpClientCallback(IAsyncResult* ar) 
{
    // Get the listener that handles the client request.
    TcpListener* listener = 
        dynamic_cast<TcpListener*> (ar->AsyncState);

    // Get the new TcpClient.
    TcpClient* client = listener->EndAcceptTcpClient(ar);

    // Process the connection here. (Add the client to a server 
    // table, read data, etc.)
    Console::WriteLine("Client connected completed");

    // Signal the calling thread to continue.
    tcpClientConnected->Set();
}
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Community Content

Incorrect remark.
Added by:Charlie.

Under the "Remarks" section there is an incorrect statement.. "This method blocks until the operation is complete. To perform this operation synchronously, use the AcceptTcpClient method."

This call is asynchronous and should be non-blocking.

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View