doc-fr/reference/stream/functions/stream-set-timeout.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.20 $ -->
<!-- EN-Revision: 1.13 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->
  <refentry xml:id="function.stream-set-timeout" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>stream_set_timeout</refname>
    <refpurpose>Configure la durée d'expiration d'un flux</refpurpose> 
   </refnamediv>
   <refsect1>
    &reftitle.description;
     <methodsynopsis>
      <type>bool</type><methodname>stream_set_timeout</methodname>
      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>microseconds</parameter><initializer>0</initializer></methodparam>
     </methodsynopsis>
    <para>
     <function>stream_set_timeout</function> configure la durée d'expiration
     du flux <parameter>stream</parameter>, exprimé comme la durée de
     <parameter>seconds</parameter> secondes et 
     <parameter>microseconds</parameter> microsecondes.
    </para>
    <para>
     Lorsque le flux se termine, la clé 'timed_out' du tableau retourné par
     <function>stream_get_meta_data</function> est défini à &true;, 
     cependant, aucune erreur/alerte n'est générée.
    </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      <para>
       Le flux cible.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>seconds</parameter></term>
     <listitem>
      <para>
       Le nombre de secondes entières du délai d'expiration.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>microseconds</parameter></term>
     <listitem>
      <para>
       Le nombre de microsecondes entières du délai d'expiration.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </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.3.0</entry>
       <entry>
        Depuis PHP 4.3, cette fonction peut (potentiellement) fonctionner
        avec n'importe quel flux. Avant PHP 4.3, les flux utilisant des
        sockets sont les seuls qui soient supportés dans le coeur de
        PHP, même si les autres extensions pourraient supporter cette
        fonction.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
    <para>
     <example>
      <title>Exemple avec <function>stream_set_timeout</function></title>
       <programlisting role="php">
<![CDATA[
<?php
$fp = fsockopen("www.example.com", 80);
if (!$fp) {
     echo "Impossible d'ouvrir\n";
} else {

  fwrite($fp, "GET / HTTP/1.0\r\n\r\n");
  stream_set_timeout($fp, 2);
  $res = fread($fp, 2000);

  $info = stream_get_meta_data($fp);
  fclose($fp);

  if ($info['timed_out']) {
     echo 'Délai de connexion dépassé !';
  } else {
     echo $res;
  }

}
?>
]]>
      </programlisting>
     </example>
    </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
    <note>
     <para>
      Cette fonction ne fonctionne pas avec les opérations avancées comme
      <function>stream_socket_recvfrom</function>, utilisez plutôt
      <function>stream_select</function> avec une durée d'expiration en
      paramètre.
     </para>
    </note>
    <para>
     Cette fonction était appelée auparavant
     <function>set_socket_timeout</function>, et aussi
     <function>socket_set_timeout</function>, mais ces appellations sont
     obsolètes.
  </para>
 </refsect1>

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