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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EvWatcher" namespace="" name="EvWatcher">
<member name="is_active" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Readonly . TRUE if the watcher is active. FALSE otherwise."/>
</docblock>
</member>
<member name="data" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="User custom data associated with the watcher"/>
</docblock>
</member>
<member name="is_pending" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Readonly .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 not change its priority."/>
</docblock>
</member>
<member name="priority" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Integer between Ev::MINPRI and Ev::MAXPRI . Pending watchers with higher priority will be invoked before watchers with lower priority, but priority will not keep watchers from being executed(except for EvIdle watchers). EvIdle watchers provide functionality to suppress invocation when higher priority events are pending."/>
</docblock>
</member>
<method name="clear" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Clear watcher pending status">If the watcher is pending, this method clears its pending status and returns its revents bitset(as if its callback was invoked). If the watcher isn't pending it does nothing and returns 0 .</description>
<return type="int"/>
</docblock>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Abstract constructor of a watcher object"/>
<return type="void"/>
</docblock>
</constructor>
<method name="feed" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Feeds the given revents set into the event loop"/>
<return type="void"/>
</docblock>
<parameter name="revents" optional="false" byreference="false" type="int"/>
</method>
<method name="getLoop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the loop responsible for the watcher"/>
<return type="EvLoop"/>
</docblock>
</method>
<method name="invoke" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Invokes the watcher callback with the given received events bit mask"/>
<return type="void"/>
</docblock>
<parameter name="revents" optional="false" byreference="false" type="int"/>
</method>
<method name="keepalive" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Configures whether to keep the loop from returning">Configures whether to keep the loop from returning. With keepalive value set to FALSE the watcher won't keep Ev::run / EvLoop::run from returning even though the watcher is active.</description>
<return type="bool"/>
</docblock>
<parameter name="value" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="setCallback" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Sets new callback for the watcher"/>
<return type="void"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
</method>
<method name="start" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Starts the watcher"/>
<return type="void"/>
</docblock>
</method>
<method name="stop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Stops the watcher"/>
<return type="void"/>
</docblock>
</method>
</class>
|
