php-doc-en/reference/ev/evwatcher.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.evwatcher" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The EvWatcher class</title>
 <titleabbrev>EvWatcher</titleabbrev>
 <partintro>
<!-- {{{ EvWatcher intro -->
  <section xml:id="evwatcher.intro">
   &reftitle.intro;
   <para>
    <classname>EvWatcher</classname>
    is a base class for all watchers(
    <classname>EvCheck</classname>
    ,
    <classname>EvChild</classname>
    etc.). Since
    <classname>EvWatcher</classname>
    &apos;s constructor is
    <modifier>abstract</modifier>
    , one can&apos;t(and don&apos;t need to) create EvWatcher objects
    directly.
   </para>
  </section>
<!-- }}} -->
  <section xml:id="evwatcher.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>EvWatcher</classname>
    </ooclass>
<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>abstract</modifier>
      <classname>EvWatcher</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="evwatcher.props.is-active">is_active</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="evwatcher.props.data">data</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="evwatcher.props.is-pending">is_pending</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <varname linkend="evwatcher.props.priority">priority</varname>
    </fieldsynopsis>
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.evwatcher')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
<!-- }}} -->
  </section>
<!-- {{{ EvWatcher properties -->
  <section xml:id="evwatcher.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="evwatcher.props.is-active">
     <term>
      <varname>is_active</varname>
     </term>
     <listitem>
      <para>
       <emphasis>Readonly</emphasis>
       . &true; if the watcher is active. &false; otherwise.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="evwatcher.props.data">
     <term>
      <varname>data</varname>
     </term>
     <listitem>
      <para>
       User custom data associated with the watcher
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="evwatcher.props.is-pending">
     <term>
      <varname>is_pending</varname>
     </term>
     <listitem>
      <para>
       <emphasis>Readonly</emphasis>
       .&true; if the watcher is pending, i.e. it has outstanding events, but
       its callback has not yet been invoked. &false; otherwise. As long, as a
       watcher is pending(but not active), one must
       <emphasis>not</emphasis>
       change its priority.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="evwatcher.props.priority">
     <term>
      <varname>priority</varname>
     </term>
     <listitem>
      <para>
       <type>int</type>
       between
       <constant>Ev::MINPRI</constant>
       and
       <constant>Ev::MAXPRI</constant>
       . Pending watchers with higher priority will be invoked before watchers
       with lower priority, but priority will not keep watchers from being
       executed(except for
       <classname>EvIdle</classname>
       watchers).
       <classname>EvIdle</classname>
       watchers provide functionality to suppress invocation when higher
       priority events are pending.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->
 </partintro>

 &reference.ev.entities.evwatcher;

</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->