<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.socket-listen" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>socket_listen</refname>

<refpurpose>ソケット上で接続待ち(listen)する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>socket_listen</methodname>

<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

ソケット <parameter>socket</parameter> が

<function>socket_create</function> を用いて作成され、

<function>socket_bind</function> で名前が付けられた後、

<parameter>socket</parameter> 上の接続要求を待つための通信ができるようになります。

</para>

<para>

<function>socket_listen</function> は、ソケットが

<literal>SOCK_STREAM</literal> 型または

<literal>SOCK_SEQPACKET</literal> 型の場合のみ利用可能です。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>socket</parameter></term>

<listitem>

<para>

<function>socket_create</function>

または <function>socket_addrinfo_bind</function> で作成した

有効な <classname>Socket</classname> クラスのインスタンス。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>backlog</parameter></term>

<listitem>

<para>

最大 <parameter>backlog</parameter> 個の接続を処理用の

キューで待ち受けることが可能です。もし待ちうけ用のキューが

いっぱいになった場合、クライアントでは <literal>ECONNREFUSED</literal>

の通知とともにエラーが発生します。あるいは、もし基盤となるプロトコルが

リクエストの再送をサポートしている場合、再試行が成功するまで

リクエストは無視されます。

</para>

<note>

<para>

<parameter>backlog</parameter> パラメータに指定できる値の最大値は

プラットフォームに大きく依存します。Linux では、最大値は

<constant>SOMAXCONN</constant> に切り詰められます。win32 では、

もし <constant>SOMAXCONN</constant> を渡した場合、backlog の

最大値を<emphasis>適切な</emphasis>値に設定する責任はサービスの

提供側が負います。

このプラットフォームでは、実際の backlog の値を見つける標準的な

手段が提供されていません。

</para>

</note>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success; エラーコードは <function>socket_last_error</function>

で取得可能で、このコードを

<function>socket_strerror</function> に指定することにより

エラーの内容を文字列として取得可能です。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&sockets.changelog.socket-param;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>socket_accept</function></member>

<member><function>socket_bind</function></member>

<member><function>socket_connect</function></member>

<member><function>socket_create</function></member>

<member><function>socket_strerror</function></member>

<member><function>socket_addrinfo_bind</function></member>

</simplelist>

</para>

</refsect1>

</refentry>