<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.ev.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'class.evtimer.php',
    1 => 'EvTimer',
    2 => 'La classe EvTimer',
  ),
  'up' => 
  array (
    0 => 'book.ev.php',
    1 => 'Ev',
  ),
  'prev' => 
  array (
    0 => 'evstat.stat.php',
    1 => 'EvStat::stat',
  ),
  'next' => 
  array (
    0 => 'evtimer.again.php',
    1 => 'EvTimer::again',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/ev/evtimer.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.evtimer.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.evtimer" class="reference">
 <h1 class="title">La classe EvTimer</h1>
 
 <div class="partintro"><p class="verinfo">(PECL ev &gt;= 0.2.0)</p>

  <div class="section" id="evtimer.intro">
   <h2 class="title">Introduction</h2>
   <p class="simpara">
    Les watchers <span class="classname"><strong class="classname">EvTimer</strong></span> 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.
   </p>
   <p class="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&#039;horloge système
    à <em>Janvier de l&#039;an passé</em>, il sera de nouveau
    hors délai après une heure (approximativement). &quot;Approximativement&quot;
    car la détection des sauts dans le temps est dure, et certaines inexactitudes
    sont inévitables.
   </p>
   <p class="simpara">
    Il est garanti que la fonction de rappel sera appelée uniquement après
    l&#039;expiration du délai maximal d&#039;attente (et non exactement à ce moment précis,
    aussi, sur des systèmes avec une horloge basse résolution, il se peut qu&#039;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&#039;attente maximal sera la plus proche sera invoqué avant l&#039;autre
    ayant une priorité identique mais avec une valeur du délai d&#039;attente plus
    éloignée (mais ceci n&#039;est plus vrai lorsqu&#039;une fonction de rappel appelle
    récursivement la méthode <span class="methodname"><a href="evloop.run.php" class="methodname">EvLoop::run()</a></span>).
   </p>
   <p class="simpara">
    Le minuteur lui-même va faire tout ce qu&#039;il lui est possible pour ne pas
    dériver, mais, si un minuteur est configuré pour se lancer toutes les
    <code class="literal">10</code> secondes, alors il va normalement se lancer
    à intervalle de <code class="literal">10</code> secondes exactement.
    Cependant, si le script ne peut pas conserver le minuteur car il prend
    plus de temps que ses <code class="literal">10</code> secondes, le minuteur
    ne pourra se lancer pas plus d&#039;une fois par itération de boucle
    d&#039;événements.
   </p>
  </div>

  <div class="section" id="evtimer.synopsis">
   <h2 class="title">Synopsis de la classe</h2>


   <div class="classsynopsis">
    <span class="ooclass">
     <strong class="classname"></strong>
    </span>

    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">EvTimer</strong>
     </span>
     <span class="ooclass">
      <span class="modifier">extends</span>
       <a href="class.evwatcher.php" class="classname">EvWatcher</a>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Propriétés */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
      <var class="varname"><a href="class.evtimer.php#evtimer.props.repeat">$<var class="varname">repeat</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.evtimer.php#evtimer.props.remaining">$<var class="varname">remaining</var></a></var>;</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Propriétés héritées */</div>
    <div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.evwatcher.php#evwatcher.props.is-active">$<var class="varname">is_active</var></a></var>;</div>
<div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.evwatcher.php#evwatcher.props.data">$<var class="varname">data</var></a></var>;</div>
<div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.evwatcher.php#evwatcher.props.is-pending">$<var class="varname">is_pending</var></a></var>;</div>
<div class="fieldsynopsis"><span class="modifier">public</span>
      <var class="varname"><a href="class.evwatcher.php#evwatcher.props.priority">$<var class="varname">priority</var></a></var>;</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Méthodes */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span>
   <span class="methodname"><a href="evtimer.construct.php" class="methodname">__construct</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$after</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$repeat</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$data</code>
    <span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$priority</code>
    <span class="initializer"> = 0</span>
   </span><br>)</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evtimer.again.php" class="methodname">again</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">final</span>
   <span class="modifier">public</span>
   <span class="modifier">static</span>
   <span class="methodname"><a href="evtimer.createstopped.php" class="methodname">createStopped</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$after</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$repeat</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$data</code>
    <span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span>
   </span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$priority</code>
    <span class="initializer"> = 0</span>
   </span><br>): <span class="type"><a href="class.evtimer.php" class="type EvTimer">EvTimer</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evtimer.set.php" class="methodname">set</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$after</code>
   </span>, <span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$repeat</code>
   </span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Méthodes héritées */</div>
    <div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.clear.php" class="methodname">EvWatcher::clear</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.feed.php" class="methodname">EvWatcher::feed</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$revents</code>
   </span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.getloop.php" class="methodname">EvWatcher::getLoop</a></span>(): <span class="type"><a href="class.evloop.php" class="type EvLoop">EvLoop</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.invoke.php" class="methodname">EvWatcher::invoke</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$revents</code>
   </span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.keepalive.php" class="methodname">EvWatcher::keepalive</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$value</code>
   <span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.setcallback.php" class="methodname">EvWatcher::setCallback</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code>
   </span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.start.php" class="methodname">EvWatcher::start</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.stop.php" class="methodname">EvWatcher::stop</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

   }</div>

  </div>

  <div class="section" id="evtimer.props">
   <h2 class="title">Propriétés</h2>
   <dl>
    
     <dt id="evtimer.props.repeat">
      <var class="varname">repeat</var>
     </dt>
     <dd>
      <span class="simpara">
       Si cette propriété vaut <code class="literal">0.0</code>, alors il sera automatiquement
       stoppée une fois le délai maximal d&#039;attente atteint. S&#039;il est positif,
       alors le minuteur sera automatiquement configuré à se lancer à chaque
       seconde en suivant, tant qu&#039;il ne sera pas stoppé manuellement.
      </span>
     </dd>
    
    
     <dt id="evtimer.props.remaining">
      <var class="varname">remaining</var>
     </dt>
     <dd>
      <span class="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&#039;événements courante, sinon, il sera relatif à la
       valeur du délai d&#039;attente maximal actuellement configuré.
      </span>
      <span class="simpara">
       Aussi, après l&#039;instanciation d&#039;un <span class="classname"><strong class="classname">EvTimer</strong></span>
       avec une valeur de <code class="parameter">after</code> à
       <code class="literal">5.0</code> et une valeur de <code class="parameter">repeat</code>
       à <code class="literal">7.0</code>, <var class="varname">remaining</var> retournera
       <code class="literal">5.0</code>. Lorsque le minuteur est démarré, et qu&#039;une
       seconde se passe, <var class="varname">remaining</var> retourne
       <code class="literal">4.0</code>. lorsque le minuteur expire et qu&#039;il est
       redémarré, il retournera approximativement <code class="literal">7.0</code>
       (probablement un peu moins sachant que l&#039;invocation de la fonction de rappel
       prend un peu de temps aussi), et ainsi de suite.
      </span>
     </dd>
    
   </dl>
  </div>

 </div>

 

























<h2>Sommaire</h2><ul class="chunklist chunklist_reference"><li><a href="evtimer.again.php">EvTimer::again</a> — Re-d&eacute;marre le watcher Timer</li><li><a href="evtimer.construct.php">EvTimer::__construct</a> — Construit un objet EvTimer watcher</li><li><a href="evtimer.createstopped.php">EvTimer::createStopped</a> — Cr&eacute;e un objet EvTimer watcher stopp&eacute;</li><li><a href="evtimer.set.php">EvTimer::set</a> — Configure le watcher</li></ul>
</div>
<?php manual_footer($setup); ?>