yaz-wait.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.yaz-wait" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>yaz_wait</refname>
  <refpurpose>Attend l'exécution d'une requête</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>yaz_wait</methodname>
   <methodparam choice="opt"><type>array</type><parameter role="reference">options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Cette fonction exécute une activité réseau (bloquée) pour les demandes
   en attente qui ont été préparées par les fonctions <function>yaz_connect</function>
   <function>yaz_search</function>, <function>yaz_present</function>,
   <function>yaz_scan</function> et <function>yaz_itemorder</function>
  </para>
  <para>
   <function>yaz_wait</function> se termine lorsque tous les hôtes
   ont terminé leurs requêtes (éventuellement en cas d'erreur).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Un tableau associatif des options :
       <variablelist>
        <varlistentry>
         <term><literal>timeout</literal></term>
         <listitem>
          <para>
           Spécifie un délai d'attente en secondes. Si un serveur n'a pas
           répondu dans les délais, il est considéré comme mort et
           <function>yaz_wait</function> se termine. La valeur par défaut pour
           le délai est de 15 secondes.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><literal>event</literal></term>
         <listitem>
          <para>
           Un booléen.
          </para>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   En mode événement, la fonction retourne une ressource
   &return.falseforfailure;.
  </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
-->