doc-fr/reference/stream/functions/stream-socket-recvfrom.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a1702b5d45ad950c5f7a077878378a37851a2df6 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.stream-socket-recvfrom" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_socket_recvfrom</refname>
  <refpurpose>Lit des données depuis un socket, connecté ou pas</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></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><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter role="reference">address</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
   <para>
    <function>stream_socket_recvfrom</function> accepte les données
    depuis un socket distant, jusqu'à un total de <parameter>length</parameter> 
    octets.      
   </para>
  </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Le socket distant.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Le nombre d'octets à recevoir de <parameter>socket</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       La valeur de <parameter>flags</parameter> peut être la combinaison
       des constantes suivantes : 
       <table>
        <title>Valeurs possibles pour <parameter>flags</parameter></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>STREAM_OOB</constant></entry>
           <entry>
            Traite les données en mode OOB (<literal>out-of-band</literal>).
           </entry>
          </row>
          <row>
           <entry><constant>STREAM_PEEK</constant></entry>
           <entry>
            Lit des données depuis le socket, mais n'utilise pas le buffer.
            Les prochains appels à <function>fread</function> ou
            <function>stream_socket_recvfrom</function> liront les mêmes
            données.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       Si le paramètre <parameter>address</parameter> est fourni, il 
       recevra l'adresse du socket distant.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne les données lues, sous forme de &string;, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
     <title>Exemple avec <function>stream_socket_recvfrom</function></title>
     <programlisting role="php">
<![CDATA[
<?php
/* Ouvre un socket sur le port 1234 de localhost */
$server = stream_socket_server('tcp://127.0.0.1:1234');

/* Accepte une connexion */
$socket = stream_socket_accept($server);

/* Lit un paquet (1500 est la taille classique MTU) de données OOB */
echo "Received Out-Of-Band: '" . stream_socket_recvfrom($socket, 1500, STREAM_OOB) . "'\n";

/* Lit les données normales in-band, mais ne modifie rien */
echo "Data: '" . stream_socket_recvfrom($socket, 1500, STREAM_PEEK) . "'\n";

/* Relit le même paquet, mais vide le buffer. */
echo "Data: '" . stream_socket_recvfrom($socket, 1500) . "'\n";

/* Terminaison */
fclose($socket);
fclose($server);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
    <note>
     <para>
      Si le message reçu est plus grand que <parameter>length</parameter>,
      les données supplémentaires peuvent être détruites, suivant le type
      de socket utilisé (par exemple UDP).
     </para>
    </note>
    <note>
     <para>
      L'appel de <function>stream_socket_recvfrom</function> sur les flux
      basés sur le socket, après l'appel de fonctions de flux basé sur un
      tampon (comme <function>fread</function> ou
      <function>stream_get_line</function>) lit directement les données à
      partir du socket et évite l'utilisation du tampon avec le flux.
     </para>
    </note>
   </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>stream_socket_sendto</function></member>
   <member><function>stream_socket_client</function></member>
   <member><function>stream_socket_server</function></member>
  </simplelist>
 </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
-->