<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
  <refentry id="function.stream-socket-recvfrom">
   <refnamediv>
    <refname>stream_socket_recvfrom</refname>
    <refpurpose>Receives data from a socket, connected or not </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>stream_socket_recvfrom</methodname>
      <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
      <methodparam><type>int</type><parameter>length</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter role="reference">address</parameter></methodparam>
     </methodsynopsis>
    <para>
     The function <function>stream_socket_recvfrom</function> accepts
     data from a remote socket up to <parameter>length</parameter> bytes.
     If <parameter>address</parameter> is provided it will be populated with
     the address of the remote socket.
    </para>
    <para>
     The value of <parameter>flags</parameter> can be any combination
     of the following:
     <table>
      <title>possible values for <parameter>flags</parameter></title>
      <tgroup cols="2">
       <tbody>
        <row>
         <entry><constant>STREAM_OOB</constant></entry>
         <entry>
          Process OOB (out-of-band) data.
         </entry>
        </row>
        <row>
         <entry><constant>STREAM_PEEK</constant></entry>
         <entry>
          Retrieve data from the socket, but do not consume the buffer.
          Subsequent calls to <function>fread</function> or 
          <function>stream_socket_recvfrom</function> will see
          the same data.
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <example>
     <title><function>stream_socket_recvfrom</function> Example</title>
     <programlisting role="php">
<![CDATA[
<?php
/* Open a server socket to port 1234 on localhost */
$server = stream_socket_server('tcp://127.0.0.1:1234');

/* Accept a connection */
$socket = stream_socket_accept($server);

/* Grab a packet (1500 is a typical MTU size) of OOB data */
echo "Received Out-Of-Band: '" . stream_socket_recvfrom($socket, 1500, STREAM_OOB) . "'\n";

/* Take a peek at the normal in-band data, but don't comsume it. */
echo "Data: '" . stream_socket_recvfrom($socket, 1500, STREAM_PEEK) . "'\n";

/* Get the exact same packet again, but remove it from the buffer this time. */
echo "Data: '" . stream_socket_recvfrom($socket, 1500) . "'\n";

/* Close it up */
fclose($socket);
fclose($server);
?>
]]>
     </programlisting>
    </example>
    <note>
     <para>
      If a message received is longer than the <parameter>length</parameter>
      parameter, excess bytes may be discarded depending on the type of socket
      the message is received from (such as UDP).
     </para>
    </note>
    <para>
     See also 
     <function>stream_socket_sendto</function>,
     <function>stream_socket_client</function>, and
     <function>stream_socket_server</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
-->