php-doc-en/reference/sockets/functions/socket-read.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.8 -->
  <refentry id="function.socket-read">
   <refnamediv>
    <refname>socket_read</refname>
    <refpurpose>Reads a maximum of length bytes from socket</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>socket_read</methodname>
      <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
      <methodparam><type>int</type><parameter>length</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
     </methodsynopsis>
    &warn.experimental.func;
    <para>
     The function <function>socket_read</function> reads from socket
     <parameter>socket</parameter> created by the
     <function>socket_accept</function> function the maximum number of bytes set by
     <parameter>length</parameter>. Otherwise you can use \r, \n or \0 to
      end reading (depending on the <parameter>type</parameter> parameter, see
      below).
    </para>
    <para>
     Returns the data as string on success, &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>
    <note>
     <para>
      <function>socket_read</function> may return a zero length string
      indicating the end of communication (i.e. the remote end point has
      closed the connection).
     </para>
    </note>
    <para>
     Optional <parameter>type</parameter> parameter is a named constant:
     <itemizedlist>
      <listitem>
       <simpara>
        PHP_BINARY_READ - use the system <literal>read()</literal> function.
        Safe for reading binary data.  (Default in PHP
        &gt;= 4.1.0)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        PHP_NORMAL_READ - reading stops at \n or \r. (Default in PHP &lt;= 4.0.6)
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     See also
     <function>socket_accept</function>,
     <function>socket_bind</function>,
     <function>socket_connect</function>,
     <function>socket_listen</function>,
     <function>socket_last_error</function>,
     <function>socket_strerror</function> and
     <function>socket_write</function>.
    </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:"../../../../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
-->