socket-shutdown.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.socket-shutdown" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_shutdown</refname>
  <refpurpose>Shuts down a socket for receiving, sending, or both</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>socket_shutdown</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>2</initializer></methodparam>
  </methodsynopsis>
  <para>
   The <function>socket_shutdown</function> function allows you to stop
   incoming, outgoing or all data (the default) from being sent through the
   <parameter>socket</parameter>
  </para>
  <note>
   <para>
    The associated buffer, or buffers, may or may not be emptied.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       A <classname>Socket</classname> instance created with <function>socket_create</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The value of <parameter>mode</parameter> can be one of the following:
       <table>
        <title>possible values for <parameter>mode</parameter></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><literal>0</literal></entry>
           <entry>
            Shutdown socket reading
           </entry>
          </row>
          <row>
           <entry><literal>1</literal></entry>
           <entry>
            Shutdown socket writing
           </entry>
          </row>
          <row>
           <entry><literal>2</literal></entry>
           <entry>
            Shutdown socket reading and writing
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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>
</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
-->