TcpListener.BeginAcceptTcpClient メソッド

.NET Framework クラス ライブラリ リファレンス

TcpListener.BeginAcceptTcpClient メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

受信接続の試行を受け入れる非同期操作を開始します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As TcpListener
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginAcceptTcpClient(callback, state)

C#

public IAsyncResult BeginAcceptTcpClient (
    AsyncCallback callback,
    Object state
)

C++

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

J#

public IAsyncResult BeginAcceptTcpClient (
    AsyncCallback callback, 
    Object state
)

JScript

public function BeginAcceptTcpClient (
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

パラメータ

callback

操作の完了時に呼び出すメソッドを参照する AsyncCallback デリゲート。

state

受け入れ操作に関する情報を格納するユーザー定義のオブジェクト。このオブジェクトは、操作の完了時に callback デリゲートに渡されます。

戻り値
TcpClient の非同期の作成を参照する IAsyncResult。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

非同期の BeginAcceptTcpClient 操作は、EndAcceptTcpClient メソッドを呼び出して終了させる必要があります。通常、このメソッドは callback デリゲートによって呼び出されます。

このメソッドは、操作が完了するまでブロックしません。操作が完了するまでブロックするには、AcceptTcpClient メソッドを使用します。

非同期プログラミング モデルの使用法の詳細については、「同期メソッドの非同期呼び出し」を参照してください。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して特定のエラー コードを取得してください。エラーの詳細については、MSDN ライブラリ (http://msdn.microsoft.com/library/ja) で Windows Socket Version 2 API のエラー コードのドキュメントを参照してください。

メモ
このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

BeginAcceptTcpClient メソッドを使用して、ソケットの作成と接続を行うコード例を次に示します。コールバック デリゲートは EndAcceptTcpClient メソッドを呼び出して非同期要求を終了します。

Visual Basic

' 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
 

C#

// 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();

}

C++

    // 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 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
TcpListener クラス
TcpListener メンバ
System.Net.Sockets 名前空間