socket-create-listen.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.socket-create-listen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_create_listen</refname>
  <refpurpose>Ouvre un socket sur un port pour accepter les connexions</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>Socket</type><type>false</type></type><methodname>socket_create_listen</methodname>
   <methodparam><type>int</type><parameter>port</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer><constant>SOMAXCONN</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>socket_create_listen</function> crée une nouvelle instance
   de <classname>Socket</classname>, de type <constant>AF_INET</constant>, mis
   en attente sur <emphasis>toutes</emphasis> les interfaces locales,
   pour le port <parameter>port</parameter>.
  </para>
  <para>
   <function>socket_create_listen</function> sert à simplifier
   la création de nouveaux sockets destinés à être mis en attente, et
   accepter de nouvelles connexions.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Le port que l'on doit écouter sur toutes les interfaces.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>backlog</parameter></term>
     <listitem>
      <para>
       Le paramètre <parameter>backlog</parameter> définit la taille
       maximum de la queue de connexions en attente. 
       <constant>SOMAXCONN</constant> peut être utilisée comme
       valeur pour le paramètre <parameter>backlog</parameter>. Reportez-vous
       à <function>socket_listen</function> pour plus de détails.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_create_listen</function> retourne une nouvelle instance
   de <classname>Socket</classname> en cas de succès et &false; en cas d'erreur.
   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>
     <row>
      <entry>8.0.0</entry>
      <entry>
       En cas de succès, cette fonction retourne désormais une instance de
       <classname>Socket</classname> ; auparavant, une <type>resource</type>
       était retournée.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Si vous voulez créer un socket qui n'écoute que certaines
    interfaces, vous devez utiliser <function>socket_create</function>,
    <function>socket_bind</function> et <function>socket_listen</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_create</function></member>
    <member><function>socket_create_pair</function></member>
    <member><function>socket_bind</function></member>
    <member><function>socket_listen</function></member>
    <member><function>socket_last_error</function></member>
    <member><function>socket_strerror</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
-->