Socket.Listenとは何？わかりやすく解説 Weblio辞書

socket_listen

(PHP 4 >= 4.0.7, PHP 5)
socket_listen — ソケット上で接続待ち(listen)する

説明

bool socket_listen ( resource socket [, int backlog] )
ソケット socket が socket_create() を用いて作成され、 socket_bind() で名前が付けられた後、 socket 上の接続要求を待つための通信ができるようになります。
最大 backlog 個の接続を処理用のキューで待ち受けることが可能です。もし待ちうけ用のキューがいっぱいになった場合、クライアントでは ECONNREFUSED の通知とともにエラーが発生します。あるいは、もし基盤となるプロトコルがリクエストの再送をサポートしている場合、再試行が成功するまでリクエストは無視されます。
注意: backlog パラメータに指定できる値の最大値はプラットフォームに大きく依存します。Linux では、最大値は SOMAXCONN に切り詰められます。win32 では、もし SOMAXCONN を渡した場合、backlog の最大値を適切な値に設定する責任はサービスの提供側が負います。このプラットフォームでは、実際の backlog の値を見つける標準的な手段が提供されていません。
socket_listen() は、ソケットが SOCK_STREAM 型または SOCK_SEQPACKET 型の場合のみ利用可能です。
成功した場合に TRUE を、失敗した場合に FALSE を返します。エラーコードは socket_last_error() で取得可能で、このコードを socket_strerror() に指定することによりエラーの内容を文字列として取得可能です。
socket_accept()、 socket_bind()、 socket_connect()、 socket_create() および socket_strerror() も参照ください。

.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)

public void Listen (
    int backlog
)

C++

public:
void Listen (
    int backlog
)

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

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