socket-create-listen.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-create-listen">
 <refnamediv>
  <refname>socket_create_listen</refname>
  <refpurpose>Opens a socket on port to accept connections </refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>socket_create_listen</methodname>
   <methodparam><type>int</type><parameter>port</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer>128</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>socket_create_listen</function> creates a new socket resource of
   type <constant>AF_INET</constant> listening on <emphasis>all</emphasis>
   local interfaces on the given port waiting for new connections.
  </para>
  <para>
   This function is meant to ease the task of creating a new socket which
   only listens to accept new connections.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       The port on which to listen on all interfaces.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>backlog</parameter></term>
     <listitem>
      <para>
       The <parameter>backlog</parameter> parameter defines the maximum length
       the queue of pending connections may grow to.
       <constant>SOMAXCONN</constant> may be passed as
       <parameter>backlog</parameter> parameter, see
       <function>socket_listen</function> for more information.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_create_listen</function> returns a new socket resource
   on success or &false; on error. The error code can be retrieved with
   <function>socket_last_error</function>. This code may be passed to
   <function>socket_strerror</function> to get a textual explanation of the
   error.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    If you want to create a socket which only listens on a certain
    interface you need to use <function>socket_create</function>,
    <function>socket_bind</function> and <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
-->