archived-doc-fr/reference/ev/evtimer.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b4fbf4434abeca44c58575ff3967e5640f7877d5 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.evtimer" role="class">
 <title>La classe EvTimer</title>
 <titleabbrev>EvTimer</titleabbrev>
 <partintro>
<!-- {{{ EvTimer intro -->
  <section xml:id="evtimer.intro">
   &reftitle.intro;
   <simpara>
    Les watchers <classname>EvTimer</classname> sont des watchers relativement
    simples qui génèrent un événement après une durée fournie, et, optionnellement,
    se répètent dans un intervalle régulier.
   </simpara>
   <simpara>
    Les minuteurs sont basés sur un temps réel, aussi, si un minuteur enregistre
    un événement qui se termine après une heure et ré-initialise l'horloge système
    à <emphasis>Janvier de l'an passé</emphasis>, il sera de nouveau
    hors délai après une heure (approximativement). "Approximativement"
    car la détection des sauts dans le temps est dure, et certaines inexactitudes
    sont inévitables.
   </simpara>
   <simpara>
    Il est garanti que la fonction de rappel sera appelée uniquement après
    l'expiration du délai maximal d'attente (et non exactement à ce moment précis,
    aussi, sur des systèmes avec une horloge basse résolution, il se peut qu'un
    petit délai soit introduit). Si plusieurs minuteurs deviennent
    prêts pendant la même itération de boucle, alors celui dont la valeur
    du délai d'attente maximal sera la plus proche sera invoqué avant l'autre
    ayant une priorité identique mais avec une valeur du délai d'attente plus
    éloignée (mais ceci n'est plus vrai lorsqu'une fonction de rappel appelle
    récursivement la méthode <methodname>EvLoop::run</methodname>).
   </simpara>
   <simpara>
    Le minuteur lui-même va faire tout ce qu'il lui est possible pour ne pas
    dériver, mais, si un minuteur est configuré pour se lancer toutes les
    <literal>10</literal> secondes, alors il va normalement se lancer
    à intervalle de <literal>10</literal> secondes exactement.
    Cependant, si le script ne peut pas conserver le minuteur car il prend
    plus de temps que ses <literal>10</literal> secondes, le minuteur
    ne pourra se lancer pas plus d'une fois par itération de boucle
    d'événements.
   </simpara>
  </section>
<!-- }}} -->
  <section xml:id="evtimer.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>EvTimer</classname>
    </ooclass>
<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>EvTimer</classname>
     </ooclass>
     <ooclass>
      <modifier>extends</modifier>
      <classname>EvWatcher</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="evtimer.props.repeat">repeat</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="evtimer.props.remaining">remaining</varname>
    </fieldsynopsis>
    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('evwatcher.synopsis')/descendant::db:fieldsynopsis)"/>
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evtimer')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evtimer')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"/>
   </classsynopsis>
<!-- }}} -->
  </section>
<!-- {{{ EvTimer properties -->
  <section xml:id="evtimer.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="evtimer.props.repeat">
     <term>
      <varname>repeat</varname>
     </term>
     <listitem>
      <simpara>
       Si cette propriété vaut <literal>0.0</literal>, alors il sera automatiquement
       stoppée une fois le délai maximal d'attente atteint. S'il est positif,
       alors le minuteur sera automatiquement configuré à se lancer à chaque
       seconde en suivant, tant qu'il ne sera pas stoppé manuellement.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="evtimer.props.remaining">
     <term>
      <varname>remaining</varname>
     </term>
     <listitem>
      <simpara>
       Retourne le temps restant avant que le minuteur ne se lance.
       Si le minuteur est actif, alors ce temps sera relatif au temps de
       la boucle d'événements courante, sinon, il sera relatif à la
       valeur du délai d'attente maximal actuellement configuré.
      </simpara>
      <simpara>
       Aussi, après l'instanciation d'un <classname>EvTimer</classname>
       avec une valeur de <parameter>after</parameter> à
       <literal>5.0</literal> et une valeur de <parameter>repeat</parameter>
       à <literal>7.0</literal>, <varname>remaining</varname> retournera
       <literal>5.0</literal>. Lorsque le minuteur est démarré, et qu'une
       seconde se passe, <varname>remaining</varname> retourne
       <literal>4.0</literal>. lorsque le minuteur expire et qu'il est
       redémarré, il retournera approximativement <literal>7.0</literal>
       (probablement un peu moins sachant que l'invocation de la fonction de rappel
       prend un peu de temps aussi), et ainsi de suite.
      </simpara>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->
 </partintro>

 &reference.ev.entities.evtimer;

</reference>
<!-- 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
-->