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

contributors($setup);

?>
<div id="class.eventbase" class="reference">
 <h1 class="title">La classe EventBase</h1>
 
 <div class="partintro"><p class="verinfo">(PECL event &gt;= 1.2.6-beta)</p>

  <div class="section" id="eventbase.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    La classe <span class="classname"><strong class="classname">EventBase</strong></span> représente la structure
    de base d&#039;un événement libevent. Elle contient un jeu d&#039;événements
    et peut vérifier quels sont les événements actifs.
   </p>
   <p class="para">
    Chaque événement de base a une <em>méthode</em> ou un
    <em>backend</em> utilisé pour déterminer quels
    sont les événements prêts. Ces méthodes sont :
    <code class="literal">select</code>, <code class="literal">poll</code>, <code class="literal">epoll</code>,
    <code class="literal">kqueue</code>, <code class="literal">devpoll</code>, <code class="literal">evport</code>
    et <code class="literal">win32</code>.
   </p>
   <p class="para">
    Pour configurer un événement de base à utiliser, ou éviter un backend spécifique,
    la classe <span class="classname"><a href="class.eventconfig.php" class="classname">EventConfig</a></span> peut être utilisée.
   </p>
   <div class="warning"><strong class="warning">Avertissement</strong>
    <p class="para">
     Ne <em>détruisez pas</em> l&#039;objet <span class="classname"><strong class="classname">EventBase</strong></span>
     tant que les ressources associées aux objets <code class="literal">Event</code>
     ne sont pas libérées. Sinon, cela mènera à des résultats totalement indéfinis !
    </p>
   </div>
  </div>

  <div class="section" id="eventbase.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">final</span>
      <span class="modifier">class</span> <strong class="classname">EventBase</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constantes */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.eventbase.php#eventbase.constants.loop-once"><var class="varname">LOOP_ONCE</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.eventbase.php#eventbase.constants.loop-nonblock"><var class="varname">LOOP_NONBLOCK</var></a></var><span class="initializer"> = 2</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.eventbase.php#eventbase.constants.nolock"><var class="varname">NOLOCK</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.eventbase.php#eventbase.constants.startup-iocp"><var class="varname">STARTUP_IOCP</var></a></var><span class="initializer"> = 4</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.eventbase.php#eventbase.constants.no-cache-time"><var class="varname">NO_CACHE_TIME</var></a></var><span class="initializer"> = 8</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.eventbase.php#eventbase.constants.epoll-use-changelist"><var class="varname">EPOLL_USE_CHANGELIST</var></a></var><span class="initializer"> = 16</span>;</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Méthodes */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span>
   <span class="methodname"><a href="eventbase.construct.php" class="methodname">__construct</a></span>(<span class="methodparam">
    
    <span class="type"><a href="class.eventconfig.php" class="type EventConfig">EventConfig</a></span> <code class="parameter">$cfg</code>
   <span class="initializer"> = ?</span></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="eventbase.dispatch.php" class="methodname">dispatch</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="eventbase.exit.php" class="methodname">exit</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$timeout</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="eventbase.free.php" class="methodname">free</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="eventbase.getfeatures.php" class="methodname">getFeatures</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="eventbase.getmethod.php" class="methodname">getMethod</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="eventbase.gettimeofdaycached.php" class="methodname">getTimeOfDayCached</a></span>(): <span class="type"><a href="language.types.float.php" class="type float">float</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="eventbase.gotexit.php" class="methodname">gotExit</a></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="eventbase.gotstop.php" class="methodname">gotStop</a></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="eventbase.loop.php" class="methodname">loop</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</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="eventbase.priorityinit.php" class="methodname">priorityInit</a></span>(<span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$n_priorities</code>
   </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="eventbase.reinit.php" class="methodname">reInit</a></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="eventbase.stop.php" class="methodname">stop</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>

  </div>

  <div class="section" id="eventbase.constants">
   <h2 class="title">Constantes pré-définies</h2>
   <dl>
    
     <dt id="eventbase.constants.loop-once">
      <strong><code><a href="class.eventbase.php#eventbase.constants.loop-once">EventBase::LOOP_ONCE</a></code></strong>
     </dt>
     <dd>
      <p class="para">
       Drapeau utilisé avec la méthode <span class="methodname"><a href="eventbase.loop.php" class="methodname">EventBase::loop()</a></span>
       qui signifie : &quot;blocage tant que libevent a un événement actif, puis,
       sortie une fois que tous les événements actifs ont exécuté leurs
       fonctions de rappel&quot;.
      </p>
     </dd>
    
    
     <dt id="eventbase.constants.loop-nonblock">
      <strong><code><a href="class.eventbase.php#eventbase.constants.loop-nonblock">EventBase::LOOP_NONBLOCK</a></code></strong>
     </dt>
     <dd>
      <p class="para">
       Drapeau utilisé avec la méthode <span class="methodname"><a href="eventbase.loop.php" class="methodname">EventBase::loop()</a></span>
       qui signifie : &quot;ne pas bloquer : regarde quels sont les événements prêts actuellement,
       exécute leurs fonctions de rappel avec une priorité haute, puis, on sort&quot;.
      </p>
     </dd>
    
    
     <dt id="eventbase.constants.nolock">
      <strong><code><a href="class.eventbase.php#eventbase.constants.nolock">EventBase::NOLOCK</a></code></strong>
     </dt>
     <dd>
      <p class="para">
       Drapeau de configuration. Ne pas verrouiller la base de l&#039;événement, même si
       un verrouillage avait été mis en place.
      </p>
     </dd>
    
    
     <dt id="eventbase.constants.startup-iocp">
      <strong><code><a href="class.eventbase.php#eventbase.constants.startup-iocp">EventBase::STARTUP_IOCP</a></code></strong>
     </dt>
     <dd>
      <p class="para">
       Drapeau de configuration spécifique à Windows. Active le répartiteur IOCP
       au démarrage.
      </p>
     </dd>
    
    
     <dt id="eventbase.constants.no-cache-time">
      <strong><code><a href="class.eventbase.php#eventbase.constants.no-cache-time">EventBase::NO_CACHE_TIME</a></code></strong>
     </dt>
     <dd>
      <p class="para">
       Drapeau de configuration. Au lieu de vérifier le temps courant chaque fois
       que la boucle d&#039;événement est prête à exécuter la fonction de rappel,
       le temps sera vérifié à chaque fois que le délai maximal d&#039;attente pour la
       fonction de rappel sera atteint.
      </p>
     </dd>
    
    
     <dt id="eventbase.constants.epoll-use-changelist">
      <strong><code><a href="class.eventbase.php#eventbase.constants.epoll-use-changelist">EventBase::EPOLL_USE_CHANGELIST</a></code></strong>
     </dt>
     <dd>
      <p class="para">
       Si l&#039;on utilise le backend <code class="literal">epoll</code>, ce drapeau
       signifie qu&#039;il est sécurisé d&#039;utiliser le code interne de modification de liste
       interne à Libevent pour mettre en lot les ajouts et les suppressions afin
       de tenter de minimiser le plus possible le nombre d&#039;appels système.
      </p>
      <p class="para">
       Le fait de définir ce drapeau rend le code plus rapide, mais il peut
       se confronter à un bogue Linux : il n&#039;est pas sécurisé d&#039;utiliser ce drapeau
       en la présence d&#039;un fds clôné par dup() ou une de ces variantes.
       Ceci produirait un comportement étrange et très difficile à diagnostiquer.
      </p>
      <p class="para">
       Ce drapeau peut aussi être activé en définissant la variable d&#039;environnement
       <code class="literal">EVENT_EPOLL_USE_CHANGELIST</code>.
      </p>
      <p class="para">
       Ce drapeau n&#039;a aucun effet si on l&#039;utilise avec un autre backend que
       <code class="literal">epoll</code>.
      </p>
     </dd>
    
   </dl>
  </div>

 </div>

 






































































































<h2>Sommaire</h2><ul class="chunklist chunklist_reference"><li><a href="eventbase.construct.php">EventBase::__construct</a> — Construit un objet EventBase</li><li><a href="eventbase.dispatch.php">EventBase::dispatch</a> — Distribue les &eacute;v&eacute;nements en attente</li><li><a href="eventbase.exit.php">EventBase::exit</a> — Stoppe la distribution des &eacute;v&eacute;nements</li><li><a href="eventbase.free.php">EventBase::free</a> — Lib&egrave;re les ressources allou&eacute;es pour l'&eacute;v&eacute;nement de base</li><li><a href="eventbase.getfeatures.php">EventBase::getFeatures</a> — Retourne un masque des fonctionnalit&eacute;s support&eacute;es</li><li><a href="eventbase.getmethod.php">EventBase::getMethod</a> — Retourne la m&eacute;thode d'&eacute;v&eacute;nement utilis&eacute;e</li><li><a href="eventbase.gettimeofdaycached.php">EventBase::getTimeOfDayCached</a> — Retourne le temps de l'&eacute;v&eacute;nement courant</li><li><a href="eventbase.gotexit.php">EventBase::gotExit</a> — V&eacute;rifie s'il a &eacute;t&eacute; demand&eacute; &agrave; la boucle d'&eacute;v&eacute;nements de sortir</li><li><a href="eventbase.gotstop.php">EventBase::gotStop</a> — V&eacute;rifie s'il a &eacute;t&eacute; demand&eacute; &agrave; la boucle d'&eacute;v&eacute;nements de s'arr&ecirc;ter</li><li><a href="eventbase.loop.php">EventBase::loop</a> — Distribue les &eacute;v&eacute;nements en attente</li><li><a href="eventbase.priorityinit.php">EventBase::priorityInit</a> — D&eacute;finit le nombre de priorit&eacute;s par &eacute;v&eacute;nement de base</li><li><a href="eventbase.reinit.php">EventBase::reInit</a> — Re-initialise l'&eacute;v&eacute;nement de base (apr&egrave;s un fork)</li><li><a href="eventbase.stop.php">EventBase::stop</a> — Demande &agrave; event_base de stopper la distribution d'&eacute;v&eacute;nements</li></ul>
</div>
<?php manual_footer($setup); ?>