socket.xml

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

<refentry xml:id="context.socket" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" annotations="verify_info:false">
 <refnamediv>
  <refname>Socket context options</refname>
  <refpurpose>Socket context option listing</refpurpose>
 </refnamediv>
 
 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <para>
   Socket context options are available for all wrappers that work over
   sockets, like <literal>tcp</literal>, <literal>http</literal> and
   <literal>ftp</literal>.
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="options"><!-- {{{ -->
  &reftitle.options;
  <para>
   <variablelist>
    <varlistentry xml:id="context.socket.bindto">
     <term><parameter>bindto</parameter></term>
     <listitem>
      <para>
       Used to specify the IP address (either IPv4 or IPv6) and/or the
       port number that PHP will use to access the network. The syntax
       is <literal>ip:port</literal> for IPv4 addresses, and
       <literal>[ip]:port</literal> for IPv6 addresses.
       Setting the IP or the port to <literal>0</literal> will let the system
       choose the IP and/or port.
      </para>
      <note>
       <para>
        As FTP creates two socket connections during normal operation,
        the port number cannot be specified using this option.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.backlog">
     <term><parameter>backlog</parameter></term>
     <listitem>
      <para>
       Used to  limit  the  number  of  outstanding  connections  in  the
       socket's  listen  queue.
      </para>
      <note>
       <para>
        This is only applicable to <function>stream_socket_server</function>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.ipv6_v6only">
     <term><parameter>ipv6_v6only</parameter></term>
     <listitem>
      <para>
       Overrides the OS default regarding mapping IPv4 into IPv6.
      </para>
      <note>
       <para>
        This is important in particular when trying to listen on IPv4 addresses
        separately while there exists a binding on <literal>[::]</literal>.
       </para>
       <para>
        This is only applicable to <function>stream_socket_server</function>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.so_reuseport">
     <term><parameter>so_reuseport</parameter></term>
     <listitem>
      <para>
       Allows multiple bindings to a same ip:port pair, even from separate processes.
      </para>
      <note>
       <para>
        This is only applicable to <function>stream_socket_server</function>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.so_broadcast">
     <term><parameter>so_broadcast</parameter></term>
     <listitem>
      <para>
       Enables sending and receiving data to/from broadcast addresses.
      </para>
      <note>
       <para>
        This is only applicable to <function>stream_socket_server</function>.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.socket.tcp_nodelay">
     <term><parameter>tcp_nodelay</parameter></term>
     <listitem>
      <para>
       Setting this option to &true; will set <literal>SOL_TCP,NO_DELAY=1</literal>
       appropriately, thus disabling the TCP Nagle algorithm.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.1.0</entry>
       <entry>
        Added <parameter>tcp_nodelay</parameter>.
       </entry>
      </row>
      <row>
       <entry>7.0.1</entry>
       <entry>
        Added <parameter>ipv6_v6only</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="context.socket.example-bindto"><!-- {{{ -->
    <title>Basic <parameter>bindto</parameter> usage example</title>
    <programlisting role="php">
<![CDATA[
<?php
// connect to the internet using the '192.168.0.100' IP
$opts = array(
    'socket' => array(
        'bindto' => '192.168.0.100:0',
    ),
);


// connect to the internet using the '192.168.0.100' IP and port '7000'
$opts = array(
    'socket' => array(
        'bindto' => '192.168.0.100:7000',
    ),
);


// connect to the internet using the '2001:db8::1' IPv6 address
// and port '7000'
$opts = array(
    'socket' => array(
        'bindto' => '[2001:db8::1]:7000',
    ),
);


// connect to the internet using port '7000'
$opts = array(
    'socket' => array(
        'bindto' => '0:7000',
    ),
);


// create the context...
$context = stream_context_create($opts);

// ...and use it to fetch the data
echo file_get_contents('http://www.example.com', false, $context);

?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </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
-->