<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'class.evwatcher.php',
    1 => 'EvWatcher',
    2 => 'The EvWatcher class',
  ),
  'up' => 
  array (
    0 => 'book.ev.php',
    1 => 'Ev',
  ),
  'prev' => 
  array (
    0 => 'evtimer.set.php',
    1 => 'EvTimer::set',
  ),
  'next' => 
  array (
    0 => 'evwatcher.clear.php',
    1 => 'EvWatcher::clear',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ev/evwatcher.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.evwatcher.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.evwatcher" class="reference">
 <h1 class="title">The EvWatcher class</h1>
 
 <div class="partintro"><p class="verinfo">(PECL ev &gt;= 0.2.0)</p>

  <div class="section" id="evwatcher.intro">
   <h2 class="title">はじめに</h2>
   <p class="simpara">
    <span class="classname"><strong class="classname">EvWatcher</strong></span>
    is a base class for all watchers(
    <span class="classname"><a href="class.evcheck.php" class="classname">EvCheck</a></span>,
    <span class="classname"><a href="class.evchild.php" class="classname">EvChild</a></span>
    etc.). Since
    <span class="classname"><strong class="classname">EvWatcher</strong></span>
    &#039;s constructor is
    <span class="modifier">abstract</span>,
    one can&#039;t(and don&#039;t need to) create EvWatcher objects
    directly.
   </p>
  </div>

  <div class="section" id="evwatcher.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">abstract</span>
      <span class="modifier">class</span> <strong class="classname">EvWatcher</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* プロパティ */</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">/* メソッド */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">abstract</span>
   <span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.construct.php" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span>
   <span class="methodname"><a href="evwatcher.clear.php" class="methodname">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">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">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">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">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">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">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">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="evwatcher.props">
   <h2 class="title">プロパティ</h2>
   <dl>
    
     <dt id="evwatcher.props.is-active">
      <var class="varname">is_active</var>
     </dt>
     <dd>
      <span class="simpara">
       <em>Readonly</em>.
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if the watcher is active. <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> otherwise.
      </span>
     </dd>
    
    
     <dt id="evwatcher.props.data">
      <var class="varname">data</var>
     </dt>
     <dd>
      <span class="simpara">
       User custom data associated with the watcher
      </span>
     </dd>
    
    
     <dt id="evwatcher.props.is-pending">
      <var class="varname">is_pending</var>
     </dt>
     <dd>
      <span class="simpara">
       <em>Readonly</em>
       .<strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if the watcher is pending, i.e. it has outstanding events, but
       its callback has not yet been invoked. <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> otherwise. As long, as a
       watcher is pending(but not active), one must
       <em>not</em>
       change its priority.
      </span>
     </dd>
    
    
     <dt id="evwatcher.props.priority">
      <var class="varname">priority</var>
     </dt>
     <dd>
      <span class="simpara">
       <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
       between
       <strong><code><a href="class.ev.php#ev.constants.minpri">Ev::MINPRI</a></code></strong>
       and
       <strong><code><a href="class.ev.php#ev.constants.maxpri">Ev::MAXPRI</a></code></strong>.
       Pending watchers with higher priority will be invoked before watchers
       with lower priority, but priority will not keep watchers from being
       executed(except for
       <span class="classname"><a href="class.evidle.php" class="classname">EvIdle</a></span>
       watchers).
       <span class="classname"><a href="class.evidle.php" class="classname">EvIdle</a></span>
       watchers provide functionality to suppress invocation when higher
       priority events are pending.
      </span>
     </dd>
    
   </dl>
  </div>

 </div>

 













































<h2>目次</h2><ul class="chunklist chunklist_reference"><li><a href="evwatcher.clear.php">EvWatcher::clear</a> — Clear watcher pending status</li><li><a href="evwatcher.construct.php">EvWatcher::__construct</a> — Abstract constructor of a watcher object</li><li><a href="evwatcher.feed.php">EvWatcher::feed</a> — Feeds the given revents set into the event loop</li><li><a href="evwatcher.getloop.php">EvWatcher::getLoop</a> — Returns the loop responsible for the watcher</li><li><a href="evwatcher.invoke.php">EvWatcher::invoke</a> — Invokes the watcher callback with the given received events bit
  mask</li><li><a href="evwatcher.keepalive.php">EvWatcher::keepalive</a> — Configures whether to keep the loop from returning</li><li><a href="evwatcher.setcallback.php">EvWatcher::setCallback</a> — Sets new callback for the watcher</li><li><a href="evwatcher.start.php">EvWatcher::start</a> — Starts the watcher</li><li><a href="evwatcher.stop.php">EvWatcher::stop</a> — Stops the watcher</li></ul>
</div>
<?php manual_footer($setup); ?>