socket-read.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.socket-read" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_read</refname>
  <refpurpose>Reads a maximum of length bytes from a socket</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>socket_read</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PHP_BINARY_READ</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   The function <function>socket_read</function> reads from the <classname>Socket</classname> instance
   <parameter>socket</parameter> created by the
   <function>socket_create</function> or
   <function>socket_accept</function> functions. 
  </para>
 </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>
       or <function>socket_accept</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       The maximum number of bytes read is specified by the
       <parameter>length</parameter> parameter. Otherwise you can use
       <literal>\r</literal>, <literal>\n</literal>,
       or <literal>\0</literal> to end reading (depending on the <parameter>mode</parameter>
       parameter, see below).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Optional <parameter>mode</parameter> parameter is a named constant:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>PHP_BINARY_READ</constant> (Default) - use the system
          <literal>recv()</literal> function. Safe for reading binary data.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PHP_NORMAL_READ</constant> - reading stops at
          <literal>\n</literal> or <literal>\r</literal>.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_read</function> returns the data as a string on success,
   or &false; on error (including if the remote host has closed the
   connection). 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 representation of
   the error.
  </para>
  <note>
   <para>
    <function>socket_read</function> returns a zero length string ("")
    when there is no more data to read.
   </para>
  </note>
 </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>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_accept</function></member>
    <member><function>socket_bind</function></member>
    <member><function>socket_connect</function></member>
    <member><function>socket_listen</function></member>
    <member><function>socket_last_error</function></member>
    <member><function>socket_strerror</function></member>
    <member><function>socket_write</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
-->