<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'class.eventbase.php',
    1 => 'EventBase',
    2 => 'A 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' => 'pt_BR',
    '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">A 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">Introdução</h2>
   <p class="para">
    A classe <span class="classname"><strong class="classname">EventBase</strong></span>
    representa a estrutura base de eventos do libevent. Ele contém um conjunto de eventos
    e pode pesquisar para determinar quais eventos estão ativos.
   </p>
   <p class="para">
    Cada base de eventos tem um
    <em>método</em>,
    ou um
    <em>back-end</em>
    que usa para determinar quais eventos estão prontos. Os métodos reconhecidos
    são:
    <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>
    e
    <code class="literal">win32</code>.
   </p>
   <p class="para">
    Para configurar a base de eventos a ser usada ou evitar um back-end específico,
    a classe <span class="classname"><a href="class.eventconfig.php" class="classname">EventConfig</a></span>
    pode ser usada.
   </p>
   <div class="warning"><strong class="warning">Aviso</strong>
    <p class="para">
     <em>NÃO</em>
     destrua o
     objeto
     <span class="classname"><strong class="classname">EventBase</strong></span>
     enquanto os recursos dos objetos
     <code class="literal">Event</code>
     associados não forem liberados. Caso contrário, isso levará a resultados
     imprevisíveis!
    </p>
   </div>
  </div>

  <div class="section" id="eventbase.synopsis">
   <h2 class="title">Resumo da 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étodos */</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 predefinidas</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">
       Opção usada com o método
       <span class="methodname"><a href="eventbase.loop.php" class="methodname">EventBase::loop()</a></span>
       que significa: &quot;bloquear até que libevent tenha um evento ativo e então
       sair quando todos os eventos ativos tiverem suas funções de retorno executadas&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">
       Opção usada com o método
       <span class="methodname"><a href="eventbase.loop.php" class="methodname">EventBase::loop()</a></span>
       que significa: &quot;não bloquear: veja quais eventos estão prontos agora, execute
       as funções de retorno de maior prioridade e depois saia&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">
       Opção de configuração. Não aloque um bloqueio para a base de eventos, mesmo que
       se tenha um bloqueio configurado&quot;.
      </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">
       Opção de configuração somente do Windows. Ativa o despachante IOCP na
       inicialização.
      </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">
       Opção de configuração. Em vez de verificar o horário atual sempre que o laço de
       eventos estiver pronto para executar funções de retorno de tempo limite, verifica após cada
       função de retorno de tempo limite.
      </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">
       Se estivermos usando o
       back-end <code class="literal">epoll</code>,
       este sinalizador diz que é seguro usar o código interno da lista de
       alterações do Libevent para agrupar adições e exclusões, a fim de tentar fazer o
       menor número possível de chamadas de sistema.
      </p>
      <p class="para">
       Definir esta opção pode tornar o código executado mais rápido, mas pode desencadear um problema do Linux:
       não é seguro usar este sinalizador se houver algum descritor de arquivo clonado por
       dup() ou suas variantes. Fazer isso produzirá problemas estranhos e
       difíceis de diagnosticar.
      </p>
      <p class="para">
       Esta opção também pode ser ativada configurando a
       variável de ambiente
       <code class="literal">EVENT_EPOLL_USE_CHANGELIST</code>.
      </p>
      <p class="para">
       Esta opção não tem efeito se for usado um back-end
       diferente de <code class="literal">epoll</code>.
      </p>
     </dd>
    
   </dl>
  </div>

 </div>

 

































































<h2>Índice</h2><ul class="chunklist chunklist_reference"><li><a href="eventbase.construct.php">EventBase::__construct</a> — Constr&oacute;i objeto EventBase</li><li><a href="eventbase.dispatch.php">EventBase::dispatch</a> — Despacha eventos pendentes</li><li><a href="eventbase.exit.php">EventBase::exit</a> — Para de despachar eventos</li><li><a href="eventbase.free.php">EventBase::free</a> — Libera recursos alocados para esta base de eventos</li><li><a href="eventbase.getfeatures.php">EventBase::getFeatures</a> — Retorna a m&aacute;scara de bits dos recursos suportados</li><li><a href="eventbase.getmethod.php">EventBase::getMethod</a> — Retorna o m&eacute;todo de evento em uso</li><li><a href="eventbase.gettimeofdaycached.php">EventBase::getTimeOfDayCached</a> — Retorna o hor&aacute;rio base do evento atua</li><li><a href="eventbase.gotexit.php">EventBase::gotExit</a> — Verifica se o la&ccedil;o de eventos foi informado para sair</li><li><a href="eventbase.gotstop.php">EventBase::gotStop</a> — Verifica se o la&ccedil;o de eventos foi informado para sair</li><li><a href="eventbase.loop.php">EventBase::loop</a> — Despacha eventos pendentes</li><li><a href="eventbase.priorityinit.php">EventBase::priorityInit</a> — Define o n&uacute;mero de prioridades por base de eventos</li><li><a href="eventbase.reinit.php">EventBase::reInit</a> — Reinicializa a base de eventos (ap&oacute;s um &quot;fork&quot;)</li><li><a href="eventbase.stop.php">EventBase::stop</a> — Informa ao event_base para parar de despachar eventos</li></ul>
</div>
<?php manual_footer($setup); ?>