Socket.Listen メソッド

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

Socket.Listen メソッド

Socket を待機状態にします。

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

Visual Basic (宣言)

Public Sub Listen ( _
    backlog As Integer _
)

Visual Basic (使用法)

Dim instance As Socket
Dim backlog As Integer

instance.Listen(backlog)

C#

public void Listen (
    int backlog
)

C++

public:
void Listen (
    int backlog
)

J#

public void Listen (
    int backlog
)

JScript

public function Listen (
    backlog : int
)

パラメータ

backlog

保留中の接続のキューの最大長。

例外

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

解説

Listen により、コネクション指向の Socket が受信接続の試行を待機するようになります。受信キューに置かれる受信接続数は、backlog パラメータが指定します。指定できる最大接続数を判断するには、MaxConnections 値を取得します。Listen はブロックしません。

SocketException が発生した場合は、ErrorCode プロパティを使用して具体的なエラー コードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラー コードのマニュアルからエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。キューからの接続を受け入れるには、Accept または BeginAccept を使用します。

メモ
Listen の前に Bind メソッドを呼び出す必要があります。呼び出さないと、Listen は SocketException をスローします。

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

メモ
backlog パラメータに指定できる値は、オペレーティング システムによって異なります。より大きな値を指定してもかまいませんが、backlog はオペレーティング システムに基づいて制限されます。

使用例

Socket を使用して受信接続を待機するコード例を次に示します。

Visual Basic

   ' create the socket
   Dim listenSocket As New
 Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp)
   
   ' bind the listening socket to the port
   Dim hostIP As IPAddress = Dns.Resolve(IPAddress.Any.ToString()).AddressList(0)
   Dim ep As New IPEndPoint(hostIP,
 port)
   listenSocket.Bind(ep)
   
   ' start listening
   listenSocket.Listen(backlog)
End Sub 'CreateAndListen

C#

    // create the socket
    Socket listenSocket = new Socket(AddressFamily.InterNetwork,
 
                                     SocketType.Stream,
                                     ProtocolType.Tcp);

    // bind the listening socket to the port
IPAddress hostIP = (Dns.Resolve(IPAddress.Any.ToString())).AddressList[0];
    IPEndPoint ep = new IPEndPoint(hostIP, port);
    listenSocket.Bind(ep); 

    // start listening
    listenSocket.Listen(backlog);

C++

// create the socket
Socket^ listenSocket = gcnew Socket( AddressFamily::InterNetwork,
   SocketType::Stream,
   ProtocolType::Tcp );

// bind the listening socket to the port
IPAddress^ hostIP = ( Dns::Resolve( IPAddress::Any->ToString() ) )->AddressList[
 0 ];
IPEndPoint^ ep = gcnew IPEndPoint( hostIP,port );
listenSocket->Bind( ep );

// start listening
listenSocket->Listen( backlog );

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
MaxConnections
Accept
Bind