socket-listen.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.socket-listen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_listen</refname>
  <refpurpose>Прослушивает входящие соединения на сокете</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> применима только к сокетам
   типа <constant>SOCK_STREAM</constant> или <constant>SOCK_SEQPACKET</constant>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Экземпляр <classname>Socket</classname>, созданный при помощи функций <function>socket_create</function> или <function>socket_addrinfo_bind</function>.
      </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>, базовый провайдер сервиса, ответственного за
        сокет, установит этот параметр максимальным <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>
<!-- 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
-->