php-doc-en/reference/sockets/functions/socket-set-option.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.27 -->
  <refentry id="function.socket-set-option">
   <refnamediv>
    <refname>socket_set_option</refname>
    <refpurpose>Sets socket options for the socket</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>socket_set_option</methodname>
      <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
      <methodparam><type>int</type><parameter>level</parameter></methodparam>
      <methodparam><type>int</type><parameter>optname</parameter></methodparam>
      <methodparam><type>mixed</type><parameter>optval</parameter></methodparam>
     </methodsynopsis>
    <para>
     The <function>socket_set_option</function> function sets the option specified by the <parameter>optname</parameter>
     parameter, at the protocol level specified by the <parameter>level</parameter> parameter, to the
     value pointed to by the <parameter>optval</parameter> parameter for the socket
     specified by the <parameter>socket</parameter> parameter. <function>socket_set_option</function>
     will return &false; on failure.
    </para>
    <para>
     The <parameter>level</parameter> parameter specifies the protocol level at
     which the option resides. For example, to retrieve options at the socket level,
     a <parameter>level</parameter> parameter of SOL_SOCKET would be used. Other
     levels, such as TCP, can be used by specifying the protocol number of that level.
     Protocol numbers can be found by using the <function>getprotobyname</function> function.
    </para>
    <para>
     The available socket options are the same as those for the <function>socket_get_option</function> function.
    </para>
    <note>
     <para>
      This function used to be called <function>socket_setopt</function> prior
      to PHP 4.3.0.
     </para>
    </note>
   </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:"../../../../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
-->