<?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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'class.eventbase.php',
    1 => 'EventBase',
    2 => 'Класс 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' => 'ru',
    '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">Класс 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">Введение</h2>
   <p class="para">
    Класс <span class="classname"><strong class="classname">EventBase</strong></span> представляет структуру
    событийной базы модуля libevent. Класс содержит набор событий и умеет
    опрашивать события для определения, какие из событий активны.
   </p>
   <p class="para">
    Каждой событийной базе доступны
    <em>метод</em>
    или
    <em>бэкенд</em>, через которые
    определяют готовые события. Доступные методы:
    <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>
    и <code class="literal">win32</code>.
   </p>
   <p class="para">
    Класс <span class="classname"><a href="class.eventconfig.php" class="classname">EventConfig</a></span> помогает настроить событийную базу
    или исключить отдельные бэкенды.
   </p>
   <div class="warning"><strong class="warning">Внимание</strong>
    <p class="para">
     <em>НЕ</em>
     разрушайте объект
     <span class="classname"><strong class="classname">EventBase</strong></span>,
     пока не освободились связанные с объектом <code class="literal">Event</code> ресурсы,
     иначе результаты станут непредсказуемы!
    </p>
   </div>
  </div>
  
  <div class="section" id="eventbase.synopsis">
   <h2 class="title">Обзор класса</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">/* Константы */</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">/* Методы */</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">Предопределённые константы</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">
       Флаг указывают при вызове метода
       <span class="methodname"><a href="eventbase.loop.php" class="methodname">EventBase::loop()</a></span>
       и указывает: «блокировать, пока модуль libevent не получит активное событие, а затем
       выйти после завершения callback-функции для всех
       активных событий».
      </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">
       Флаг указывают при вызове метода
       <span class="methodname"><a href="eventbase.loop.php" class="methodname">EventBase::loop()</a></span>
       и означает: «не блокировать: посмотреть, какие события уже готовы, запустить
       обратные вызовы с наивысшим приоритетом, затем выйти».
      </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">
       Флаг конфигурации. Не выделять блокировку для событийной базы,
       даже если настроили блокирование.
      </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">
       Флаг конфигурации только для ОС Windows.
       Разрешает диспетчер IOCP при старте.
      </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">
       Флаг конфигурации. Вместо проверки текущего времени каждый раз
       при готовности цикла запустить функцию обратного вызова по таймеру,
       проверять время после каждого вызова такой функции.
      </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">
       На <code class="literal">epoll</code>-бэкендах флаг сообщает,
       что можно безопасно использовать внутренний код
       списка изменений Libevent для пакетного добавления и удаления в целях
       минимизации количества системных вызовов.
      </p>
      <p class="para">
       Установка флага часто повышает производительность, но иногда
       приводит к проявлению бага Linux: небезопасно использовать этот
       флаг, если какой-либо файловый дескриптор склонировали
       функцией dup() или аналогичной. Установка флага иногда приводит к странным
       ошибкам, которые трудно диагностировать.
      </p>
      <p class="para">
       Флаг также активируют установкой переменной
       окружения <code class="literal">EVENT_EPOLL_USE_CHANGELIST</code>.
      </p>
      <p class="para">
       Флаг действует только на <code class="literal">epoll</code>-бэкендах.
      </p>
     </dd>
    
   </dl>
  </div>
  
 </div>

 




















































































<h2>Содержание</h2><ul class="chunklist chunklist_reference"><li><a href="eventbase.construct.php">EventBase::__construct</a> — Конструктор объекта EventBase</li><li><a href="eventbase.dispatch.php">EventBase::dispatch</a> — Отправляет ожидающие события</li><li><a href="eventbase.exit.php">EventBase::exit</a> — Прекращает отправку событий</li><li><a href="eventbase.free.php">EventBase::free</a> — Освобождает ресурсы, выделенные для этой базы событий</li><li><a href="eventbase.getfeatures.php">EventBase::getFeatures</a> — Возвращает битовую маску поддерживаемых функций</li><li><a href="eventbase.getmethod.php">EventBase::getMethod</a> — Возвращает используемый метод события</li><li><a href="eventbase.gettimeofdaycached.php">EventBase::getTimeOfDayCached</a> — Возвращает текущее время базовый событий</li><li><a href="eventbase.gotexit.php">EventBase::gotExit</a> — Проверяет, завершился ли цикл обработки событий</li><li><a href="eventbase.gotstop.php">EventBase::gotStop</a> — Проверяет, завершился ли цикл обработки событий</li><li><a href="eventbase.loop.php">EventBase::loop</a> — Отправляет ожидающие события</li><li><a href="eventbase.priorityinit.php">EventBase::priorityInit</a> — Устанавливает количество приоритетов на базу событий</li><li><a href="eventbase.reinit.php">EventBase::reInit</a> — Повторная инициализация базы событий (после разветвления)</li><li><a href="eventbase.stop.php">EventBase::stop</a> — Сообщает event_base прекратить отправку событий</li></ul>
</div>
<?php manual_footer($setup); ?>