Begins an asynchronous operation to accept an incoming connection attempt.
Namespace:
System.Net.Sockets
Assembly:
System (in System.dll)
Visual Basic (Declaration)
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Function BeginAcceptTcpClient ( _
callback As AsyncCallback, _
state As Object _
) As IAsyncResult
Dim instance As TcpListener
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginAcceptTcpClient(callback, _
state)
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public IAsyncResult BeginAcceptTcpClient(
AsyncCallback callback,
Object state
)
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
IAsyncResult^ BeginAcceptTcpClient(
AsyncCallback^ callback,
Object^ state
)
public function BeginAcceptTcpClient(
callback : AsyncCallback,
state : Object
) : IAsyncResult
Parameters
- callback
- Type: System..::.AsyncCallback
An AsyncCallback delegate that references the method to invoke when the operation is complete.
- state
- Type: System..::.Object
A user-defined object containing information about the accept operation. This object is passed to the callback delegate when the operation is complete.
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: |
|---|
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing. |
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.
public static ManualResetEvent tcpClientConnected =
new ManualResetEvent(false);
// Accept one client connection asynchronously.
public 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(DoAcceptTcpClientCallback),
listener);
// Wait until a connection is made and processed before
// continuing.
tcpClientConnected.WaitOne();
}
// Process the client connection.
public static void DoAcceptTcpClientCallback(IAsyncResult ar)
{
// Get the listener that handles the client request.
TcpListener listener = (TcpListener) ar.AsyncState;
// End the operation and display the received data on
// the console.
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();
}
// Thread signal.
public:
static ManualResetEvent^ TcpClientConnected;
// Accept one client connection asynchronously.
public:
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(
gcnew AsyncCallback(DoAcceptTcpClientCallback),
listener);
// Wait until a connection is made and processed before
// continuing.
TcpClientConnected->WaitOne();
}
// Process the client connection.
public:
static void DoAcceptTcpClientCallback(IAsyncResult^ result)
{
// Get the listener that handles the client request.
TcpListener^ listener = (TcpListener^) result->AsyncState;
// End the operation and display the received data on
// the console.
TcpClient^ client = listener->EndAcceptTcpClient(result);
// 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();
}
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.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference