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

<!-- $Revision$ -->

<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: yannick Status: ready -->

<!-- Reviewed: yes -->

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

<refnamediv>

<refname>socket_listen</refname>

<refpurpose>Attend une connexion sur un socket</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>

Une fois que le socket <parameter>socket</parameter> a été

créé avec la fonction <function>socket_create</function>

et liée à un nom avec la fonction

<function>socket_bind</function>, il peut être mis en attente de la

connexion entrante.

</para>

<para>

<function>socket_listen</function> ne fonctionne qu'avec des sockets de

type <constant>SOCK_STREAM</constant> et <constant>SOCK_SEQPACKET</constant>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

Une instance de <classname>Socket</classname> créée par

<function>socket_create</function> ou <function>socket_addrinfo_bind</function>.

</para>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<para>

Un nombre maximum de <parameter>backlog</parameter> connexions seront mises

en attente de traitement. Si une demande de connexion arrive et que la

queue est pleine, le client recevra une erreur indiquant

<literal>ECONNREFUSED</literal>, ou, si le protocole de support accepte

les retransmissions, la requête sera ignorée pour que les tentatives

ultérieures finissent par réussir.

</para>

<note>

<para>

Le nombre maximum passé dans le paramètre <parameter>backlog</parameter>

dépend essentiellement de la plate-forme de support. Sur Linux, il est

tronqué automatiquement à <constant>SOMAXCONN</constant>. Sous Windows,

si la constante <constant>SOMAXCONN</constant> est passée, le service

responsable des sockets choisira une valeur maximum <emphasis>raisonnable</emphasis>.

Il n'y a pas de méthode pour deviner la valeur réellement choisie.

</para>

</note>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success; Le code d'erreur généré peut être obtenu en appelant la

fonction <function>socket_last_error</function>. Ce code d'erreur

peut être passé à la fonction <function>socket_strerror</function>

pour obtenir un message d'erreur humainement lisible.

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

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->