doc-fr/reference/curl/functions/curl-multi-info-read.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b7f8c11e56ff1c57a2993e2ed7e5c5ace18637fd Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.curl-multi-info-read" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_multi_info_read</refname>
  <refpurpose>Lit les informations sur les transferts actuels</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>curl_multi_info_read</methodname>
   <methodparam><type>CurlMultiHandle</type><parameter>multi_handle</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">queued_messages</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Appelle le gestionnaire multiple s'il y a des messages ou des informations
   issus des transferts individuels. Les messages peuvent inclure des informations
   comme un code erreur du transfert, ou juste le fait que le transfert est terminé.
  </para>
  <para>
   Les appels répétés à cette fonction retournera un nouveau résultat à chaque fois,
   tant que &false; n'est pas retourné, indiquant qu'il n'y a plus rien à récupérer
   pour le moment. L'entier présent dans le paramètre <parameter>queued_messages</parameter>
   représente le nombre de messages restant une fois cette fonction appelée.
  </para>
  <warning>
   <para>
    Les données pointées par la ressource retournée, ne survivront pas
    à l'appel de la fonction <function>curl_multi_remove_handle</function>.
   </para>
  </warning>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.mh.description;
    <varlistentry>
     <term><parameter>queued_messages</parameter></term>
     <listitem>
      <para>
       Nombre de messages encore présents dans la file d'attente
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau associatif contenant le message en cas de succès,
   &false; si une erreur survient.
  </para>
  <para>
   <table>
    <title>Contenu du tableau retourné</title>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Key:</entry>
       <entry>Value:</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>msg</literal></entry>
       <entry>La constante <constant>CURLMSG_DONE</constant>. Les autres valeurs retournées
        sont actuellement non disponibles.</entry>
      </row>
      <row>
       <entry><literal>result</literal></entry>
       <entry>Une des constantes <constant>CURLE_*</constant>. Si tout s'est bien déroulé,
        la constante <constant>CURLE_OK</constant> sera retournée.</entry>
      </row>
      <row>
       <entry><literal>handle</literal></entry>
       <entry>Ressource de type curl indiquant le gestionnaire concerné.</entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &curl.changelog.multi-handle-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>curl_multi_info_read</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$urls = array(
   "http://www.cnn.com/",
   "http://www.bbc.co.uk/",
   "http://www.yahoo.com/"
);

$mh = curl_multi_init();

foreach ($urls as $i => $url) {
    $conn[$i] = curl_init($url);
    curl_setopt($conn[$i], CURLOPT_RETURNTRANSFER, 1);
    curl_multi_add_handle($mh, $conn[$i]);
}

do {
    $status = curl_multi_exec($mh, $active);
    if ($active) {
        curl_multi_select($mh);
    }
    while (false !== ($info = curl_multi_info_read($mh))) {
        var_dump($info);
    }
} while ($active && $status == CURLM_OK);

foreach ($urls as $i => $url) {
    $res[$i] = curl_multi_getcontent($conn[$i]);
    curl_close($conn[$i]);
}

var_dump(curl_multi_info_read($mh));

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(3) {
  ["msg"]=>
  int(1)
  ["result"]=>
  int(0)
  ["handle"]=>
  resource(5) of type (curl)
}
array(3) {
  ["msg"]=>
  int(1)
  ["result"]=>
  int(0)
  ["handle"]=>
  resource(7) of type (curl)
}
array(3) {
  ["msg"]=>
  int(1)
  ["result"]=>
  int(0)
  ["handle"]=>
  resource(6) of type (curl)
}
bool(false)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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