Win32 API 日本語リファレンス
ホームNetworking.WinSock › listen

listen

関数
ソケットを接続待ち受け状態にする。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll
#include <windows.h>

INT listen(
    SOCKET s,
    INT backlog
);

パラメーター

名前方向説明
sSOCKETinバインド済みで未接続のソケットを識別するディスクリプタ。
backlogINTin

保留中の接続キューの最大長。SOMAXCONN を指定すると、ソケット s を担当する下位のサービスプロバイダーが backlog を妥当な最大値に設定します。SOMAXCONN_HINT(N)(N は数値)を指定すると、backlog の値は N となり、(200, 65535) の範囲に収まるように調整されます。SOMAXCONN_HINT を使用すると、SOMAXCONN で設定できる値よりも大きな backlog を設定できる点に注意してください。

SOMAXCONN_HINT は Microsoft TCP/IP サービスプロバイダーでのみサポートされます。実際の backlog 値を取得する標準的な手段はありません。

戻り値の型: INT

公式ドキュメント

listen 関数は、ソケットを着信接続を待ち受ける状態にします。

戻り値

エラーが発生しなかった場合、 listen はゼロを返します。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

エラーコード 意味
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムで障害が発生しました。
WSAEADDRINUSE
ソケットのローカルアドレスが既に使用されており、ソケットに SO_REUSEADDR によるアドレス再利用が許可されていません。このエラーは通常 bind 関数の実行中に発生しますが、 bind が部分的にワイルドカードのアドレス(ADDR_ANY を含む)に対して行われ、この関数の実行時に特定のアドレスを確定する必要がある場合には、この関数の段階まで遅延することがあります。
WSAEINPROGRESS
ブロッキング型の Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数を処理中です。
WSAEINVAL
ソケットが bind でバインドされていません。
WSAEISCONN
ソケットは既に接続されています。
WSAEMFILE
利用可能なソケットディスクリプタがこれ以上ありません。
WSAENOBUFS
利用可能なバッファ領域がありません。
WSAENOTSOCK
ディスクリプタがソケットではありません。
WSAEOPNOTSUPP
参照されたソケットは、 listen 操作をサポートする種類ではありません。

解説(Remarks)

接続を受け入れるには、まず socket 関数でソケットを作成し、 bind 関数でローカルアドレスにバインドします。着信接続用の backlog を listen で指定し、その後 accept 関数で接続を受け入れます。接続指向のソケット(例えば SOCK_STREAM 型のもの)が listen で使用されます。ソケット s はパッシブモードに置かれ、着信した接続要求は確認応答され、プロセスによる受け入れを待ってキューに入れられます。

backlogSOMAXCONN を指定すると、これはソケット s を担当する下位のサービスプロバイダーに対し、保留中の接続キューの長さを妥当な最大値に設定するよう指示する特別な定数となります。

Windows Sockets 2 では、この最大値は既定で大きな値(通常は数百以上)になります。

Bluetooth アプリケーションで listen 関数を呼び出す場合、受け入れるクライアント接続が少数に限られるため、backlog パラメーターにはより小さな値(通常は 2 ~ 4)を使用することが強く推奨されます。これにより、リスニングソケットのために割り当てられるシステムリソースを削減できます。この推奨事項は、少数のクライアント接続のみを想定する他のネットワークアプリケーションにも当てはまります。

listen 関数は通常、同時に複数の接続要求を受け取り得るサーバーで使用されます。接続要求が到着したときにキューが満杯の場合、クライアントは WSAECONNREFUSED を示すエラーを受け取ります。

利用可能なソケットディスクリプタがない場合でも、 listen は機能を継続しようとします。ディスクリプタが利用可能になると、その後の listen または accept の呼び出しによって、可能であればキューが backlog パラメーターに指定された現在値または直近の値まで補充され、着信接続の待ち受けが再開されます。

既にリスニング状態のソケットに対して listen 関数を呼び出した場合、backlog パラメーターの値を変更することなく成功を返します。リスニング状態のソケットに対する後続の listen 呼び出しで backlog パラメーターを 0 に設定しても、特にソケット上に接続が存在する場合、適切なリセットとはみなされません。

listen のようなブロッキング型の Winsock 呼び出しを発行する際、Winsock は呼び出しを完了する前にネットワークイベントを待機する必要がある場合があります。この状況で Winsock はアラート可能な待機を実行し、これは同一スレッドでスケジュールされた非同期プロシージャ呼び出し(APC)によって中断され得ます。同一スレッド上で進行中のブロッキング型 Winsock 呼び出しを中断した APC の内部から、さらに別のブロッキング型 Winsock 呼び出しを発行すると未定義の動作を引き起こすため、Winsock クライアントは決してこれを試みてはなりません。

サンプルコード

次の例は、listen 関数の使用方法を示しています。
#ifndef UNICODE
#define UNICODE
#endif

#define WIN32_LEAN_AND_MEAN

#include <winsock2.h>
#include <ws2tcpip.h>
#include <stdio.h>

// Need to link with Ws2_32.lib
#pragma comment(lib, "ws2_32.lib")

int wmain()
{

    //----------------------
    // Initialize Winsock
    WSADATA wsaData;
    int iResult = 0;

    SOCKET ListenSocket = INVALID_SOCKET;
    sockaddr_in service;

    iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
    if (iResult != NO_ERROR) {
        wprintf(L"WSAStartup() failed with error: %d\n", iResult);
        return 1;
    }
    //----------------------
    // Create a SOCKET for listening for incoming connection requests.
    ListenSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (ListenSocket == INVALID_SOCKET) {
        wprintf(L"socket function failed with error: %ld\n", WSAGetLastError());
        WSACleanup();
        return 1;
    }
    //----------------------
    // The sockaddr_in structure specifies the address family,
    // IP address, and port for the socket that is being bound.
    service.sin_family = AF_INET;
    service.sin_addr.s_addr = inet_addr("127.0.0.1");
    service.sin_port = htons(27015);

    iResult = bind(ListenSocket, (SOCKADDR *) & service, sizeof (service));
    if (iResult == SOCKET_ERROR) {
        wprintf(L"bind function failed with error %d\n", WSAGetLastError());
        iResult = closesocket(ListenSocket);
        if (iResult == SOCKET_ERROR)
            wprintf(L"closesocket function failed with error %d\n", WSAGetLastError());
        WSACleanup();
        return 1;
    }
    //----------------------
    // Listen for incoming connection requests 
    // on the created socket
    if (listen(ListenSocket, SOMAXCONN) == SOCKET_ERROR)
        wprintf(L"listen function failed with error: %d\n", WSAGetLastError());

    wprintf(L"Listening on socket...\n");

    iResult = closesocket(ListenSocket);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"closesocket function failed with error %d\n", WSAGetLastError());
        WSACleanup();
        return 1;
    }

    WSACleanup();
    return 0;
}

サンプルコード

listen 関数を使用する別の例については、Getting Started With Winsock を参照してください。

IrDA ソケットに関する注意

互換性

backlog パラメーターは、下位のサービスプロバイダーによって決定される妥当な値に(暗黙的に)制限されます。不正な値は最も近い有効な値に置き換えられます。実際の backlog 値を調べる標準的な手段はありません。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされます。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll
#include <windows.h>

INT listen(
    SOCKET s,
    INT backlog
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int listen(
    UIntPtr s,   // SOCKET
    int backlog   // INT
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function listen(
    s As UIntPtr,   ' SOCKET
    backlog As Integer   ' INT
) As Integer
End Function
' s : SOCKET
' backlog : INT
Declare PtrSafe Function listen Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal backlog As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

listen = ctypes.windll.ws2_32.listen
listen.restype = ctypes.c_int
listen.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_int,  # backlog : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
listen = Fiddle::Function.new(
  lib['listen'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_INT,  # backlog : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn listen(
        s: usize,  // SOCKET
        backlog: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int listen(UIntPtr s, int backlog);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_listen' -Namespace Win32 -PassThru
# $api::listen(s, backlog)
#uselib "WS2_32.dll"
#func global listen "listen" sptr, sptr
; listen s, backlog   ; 戻り値は stat
; s : SOCKET -> "sptr"
; backlog : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WS2_32.dll"
#cfunc global listen "listen" sptr, int
; res = listen(s, backlog)
; s : SOCKET -> "sptr"
; backlog : INT -> "int"
; INT listen(SOCKET s, INT backlog)
#uselib "WS2_32.dll"
#cfunc global listen "listen" intptr, int
; res = listen(s, backlog)
; s : SOCKET -> "intptr"
; backlog : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	proclisten = ws2_32.NewProc("listen")
)

// s (SOCKET), backlog (INT)
r1, _, err := proclisten.Call(
	uintptr(s),
	uintptr(backlog),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function listen(
  s: NativeUInt;   // SOCKET
  backlog: Integer   // INT
): Integer; stdcall;
  external 'WS2_32.dll' name 'listen';
result := DllCall("WS2_32\listen"
    , "UPtr", s   ; SOCKET
    , "Int", backlog   ; INT
    , "Int")   ; return: INT
●listen(s, backlog) = DLL("WS2_32.dll", "int listen(int, int)")
# 呼び出し: listen(s, backlog)
# s : SOCKET -> "int"
# backlog : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn listen(
    s: usize, // SOCKET
    backlog: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc listen(
    s: uint,  # SOCKET
    backlog: int32  # INT
): int32 {.importc: "listen", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int listen(
    size_t s,   // SOCKET
    int backlog   // INT
);
ccall((:listen, "WS2_32.dll"), stdcall, Int32,
      (Csize_t, Int32),
      s, backlog)
# s : SOCKET -> Csize_t
# backlog : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t listen(
    uintptr_t s,
    int32_t backlog);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.listen(s, backlog)
-- s : SOCKET
-- backlog : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const listen = lib.func('__stdcall', 'listen', 'int32_t', ['uintptr_t', 'int32_t']);
// listen(s, backlog)
// s : SOCKET -> 'uintptr_t'
// backlog : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  listen: { parameters: ["usize", "i32"], result: "i32" },
});
// lib.symbols.listen(s, backlog)
// s : SOCKET -> "usize"
// backlog : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t listen(
    size_t s,
    int32_t backlog);
C, "WS2_32.dll");
// $ffi->listen(s, backlog);
// s : SOCKET
// backlog : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
    int listen(
        long s,   // SOCKET
        int backlog   // INT
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun listen = listen(
    s : LibC::SizeT,   # SOCKET
    backlog : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef listenNative = Int32 Function(UintPtr, Int32);
typedef listenDart = int Function(int, int);
final listen = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<listenNative, listenDart>('listen');
// s : SOCKET -> UintPtr
// backlog : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function listen(
  s: NativeUInt;   // SOCKET
  backlog: Integer   // INT
): Integer; stdcall;
  external 'WS2_32.dll' name 'listen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "listen"
  c_listen :: CUIntPtr -> Int32 -> IO Int32
-- s : SOCKET -> CUIntPtr
-- backlog : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let listen =
  foreign "listen"
    (size_t @-> int32_t @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* backlog : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("listen" listen :convention :stdcall) :int32
  (s :uint64)   ; SOCKET
  (backlog :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $listen = Win32::API::More->new('WS2_32',
    'int listen(WPARAM s, int backlog)');
# my $ret = $listen->Call($s, $backlog);
# s : SOCKET -> WPARAM
# backlog : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目