doc-fr/reference/sockets/functions/socket-read.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- EN-Revision: 1.11 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-read">
 <refnamediv>
  <refname>socket_read</refname>
  <refpurpose>Lit des données d'une socket</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <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><initializer>PHP_BINARY_READ</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>socket_read</function> lit des données dans la socket
   <parameter>socket</parameter>, qui doit être une ressource créée par
   <function>socket_accept</function> ou
   <function>socket_accept</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Une ressource de socket valide, créée par la fonction
       <function>socket_create</function> ou la fonction
       <function>socket_accept</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Elle lit un maximum de <parameter>length</parameter> octets.
       Sinon, vous pouvez utiliser <constant>&#92;r</constant>,
       <constant>&#92;n</constant> ou <constant>&#92;0</constant>
       pour terminer la lecture (suivant la valeur choisie pour
       <parameter>type</parameter>, voir ci-dessous).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       Le paramètre optionnel <parameter>type</parameter> peut prendre l'une
       des valeurs constantes suivantes :
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>PHP_BINARY_READ</constant> (Défaut) - utilise la fonction système
          <literal>recv()</literal>. Capable de lire les données binaires.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PHP_NORMAL_READ</constant> - la lecture s'arrête aux <literal>\n</literal> 
          et <literal>\r</literal>
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_read</function> retourne les données sous forme de
   chaîne en cas de succès, et &false; sinon (y compris si l'hôte distant
   a fermé la connexion). Le code
   d'erreur généré peut être obtenu en appelant la fonction
   <function>socket_last_error</function>. Ce code d'erreur
   peut être passé à la fonction <function>socket_strerror</function>
   pour obtenir un message d'erreur humainement lisible.
  </para>
  <note>
   <para>
    <function>socket_read</function> retourne une chaîne de longueur
    zéro (""), lorsqu'il n'y a plus de données à lire.
   </para>
  </note>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.1.0</entry>
       <entry>
        La valeur par défaut du paramètre <parameter>type</parameter>
        est passée de <constant>PHP_NORMAL_READ</constant> à
        <constant>PHP_BINARY_READ</constant>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </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:"../../../../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
-->