1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 328913 $ -->
<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>
's constructor is
<modifier>abstract</modifier>
, one can't(and don'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>Integer</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
-->
|
