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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EvLoop" namespace="" name="EvLoop">
<member name="data" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Custom data attached to loop"/>
</docblock>
</member>
<member name="backend" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Readonly . The backend flags indicating the event backend in use."/>
</docblock>
</member>
<member name="is_default_loop" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Readonly . TRUE if it is the default event loop."/>
</docblock>
</member>
<member name="iteration" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The current iteration count of the loop. See Ev::iteration"/>
</docblock>
</member>
<member name="pending" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The number of pending watchers. 0 indicates that there are no watchers pending."/>
</docblock>
</member>
<member name="io_interval" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Higher io_interval allows libev to spend more time collecting EvIo events, so more events can be handled per iteration, at the cost of increasing latency. Timeouts (both EvPeriodic and EvTimer ) will not be affected. Setting this to a non-zero value will introduce an additional sleep() call into most loop iterations. The sleep time ensures that libev will not poll for EvIo events more often than once per this interval, on average. Many programs can usually benefit by setting the io_interval to a value near 0.1 , which is often enough for interactive servers(not for games). It usually doesn't make much sense to set it to a lower value than 0.01 , as this approaches the timing granularity of most systems.">Higher io_interval allows libev to spend more time collecting EvIo events, so more events can be handled per iteration, at the cost of increasing latency. Timeouts (both EvPeriodic and EvTimer ) will not be affected. Setting this to a non-zero value will introduce an additional sleep() call into most loop iterations. The sleep time ensures that libev will not poll for EvIo events more often than once per this interval, on average. Many programs can usually benefit by setting the io_interval to a value near 0.1 , which is often enough for interactive servers(not for games). It usually doesn't make much sense to set it to a lower value than 0.01 , as this approaches the timing granularity of most systems.</description>
</docblock>
</member>
<member name="timeout_interval" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="Higher timeout_interval allows libev to spend more time collecting timeouts, at the expense of increased latency/jitter/inexactness(the watcher callback will be called later). EvIo watchers will not be affected. Setting this to a non-null value will not introduce any overhead in libev . See also FUNCTIONS CONTROLLING EVENT LOOPS ."/>
</docblock>
</member>
<member name="depth" static="false" visibility="public">
<default>null</default>
<docblock>
<description compact="The recursion depth. See Ev::depth ."/>
</docblock>
</member>
<method name="backend" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns an integer describing the backend used by libev"/>
<return type="int"/>
</docblock>
</method>
<method name="check" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvCheck object associated with the current event loop instance"/>
<return type="EvCheck"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="string"/>
<parameter name="data" optional="true" byreference="false" type="string"/>
<parameter name="priority" optional="true" byreference="false" type="string"/>
</method>
<method name="child" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvChild object associated with the current event loop"/>
<return type="EvChild"/>
</docblock>
<parameter name="pid" optional="false" byreference="false" type="string"/>
<parameter name="trace" optional="false" byreference="false" type="string"/>
<parameter name="callback" optional="false" byreference="false" type="string"/>
<parameter name="data" optional="true" byreference="false" type="string"/>
<parameter name="priority" optional="true" byreference="false" type="string"/>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Constructs the event loop object"/>
<return type="void"/>
</docblock>
<parameter name="flags" optional="true" byreference="false" type="int"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="io_interval" optional="true" byreference="false" type="object" class="float"/>
<parameter name="timeout_interval" optional="true" byreference="false" type="object" class="float"/>
</constructor>
<method name="defaultLoop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns or creates the default event loop"/>
<return type="EvLoop"/>
</docblock>
<parameter name="flags" optional="true" byreference="false" type="int"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="io_interval" optional="true" byreference="false" type="object" class="float"/>
<parameter name="timeout_interval" optional="true" byreference="false" type="object" class="float"/>
</method>
<method name="embed" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates an instance of EvEmbed watcher associated with the current EvLoop object"/>
<return type="EvEmbed"/>
</docblock>
<parameter name="other" optional="false" byreference="false" type="string"/>
<parameter name="callback" optional="true" byreference="false" type="string"/>
<parameter name="data" optional="true" byreference="false" type="string"/>
<parameter name="priority" optional="true" byreference="false" type="string"/>
</method>
<method name="fork" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvFork watcher object associated with the current event loop instance"/>
<return type="EvFork"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="idle" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvIdle watcher object associated with the current event loop instance"/>
<return type="EvIdle"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="invokePending" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Invoke all pending watchers while resetting their pending state"/>
<return type="void"/>
</docblock>
</method>
<method name="io" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Create EvIo watcher object associated with the current event loop instance"/>
<return type="EvIo"/>
</docblock>
<parameter name="fd" optional="false" byreference="false" type="object" class="mixed"/>
<parameter name="events" optional="false" byreference="false" type="int"/>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="loopFork" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Must be called after a fork"/>
<return type="void"/>
</docblock>
</method>
<method name="now" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns the current "event loop time""/>
<return type="float"/>
</docblock>
</method>
<method name="nowUpdate" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Establishes the current time by querying the kernel, updating the time returned by EvLoop::now in the progress"/>
<return type="void"/>
</docblock>
</method>
<method name="periodic" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvPeriodic watcher object associated with the current event loop instance"/>
<return type="EvPeriodic"/>
</docblock>
<parameter name="offset" optional="false" byreference="false" type="object" class="float"/>
<parameter name="interval" optional="false" byreference="false" type="object" class="float"/>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="prepare" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvPrepare watcher object associated with the current event loop instance"/>
<return type="EvPrepare"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="resume" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Resume previously suspended default event loop"/>
<return type="void"/>
</docblock>
</method>
<method name="run" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Begin checking for events and calling callbacks for the loop"/>
<return type="void"/>
</docblock>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="signal" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvSignal watcher object associated with the current event loop instance"/>
<return type="EvSignal"/>
</docblock>
<parameter name="signum" optional="false" byreference="false" type="int"/>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="stat" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvStat watcher object associated with the current event loop instance"/>
<return type="EvStat"/>
</docblock>
<parameter name="path" optional="false" byreference="false" type="string"/>
<parameter name="interval" optional="false" byreference="false" type="object" class="float"/>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="stop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Stops the event loop"/>
<return type="void"/>
</docblock>
<parameter name="how" optional="true" byreference="false" type="int"/>
</method>
<method name="suspend" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Suspend the loop"/>
<return type="void"/>
</docblock>
</method>
<method name="timer" abstract="false" static="false" visibility="public" final="true">
<docblock>
<description compact="Creates EvTimer watcher object associated with the current event loop instance"/>
<return type="EvTimer"/>
</docblock>
<parameter name="after" optional="false" byreference="false" type="object" class="float"/>
<parameter name="repeat" optional="false" byreference="false" type="object" class="float"/>
<parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
<parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="priority" optional="true" byreference="false" type="int"/>
</method>
<method name="verify" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Performs internal consistency checks(for debugging)"/>
<return type="void"/>
</docblock>
</method>
</class>
|
