ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/README
(Generate patch)

Comparing EV/README (file contents):
Revision 1.12 by root, Tue Nov 27 07:27:10 2007 UTC vs.
Revision 1.28 by root, Tue Jul 8 18:56:48 2008 UTC

1NAME 1NAME
2 EV - perl interface to libev, a high performance full-featured event 2 EV - perl interface to libev, a high performance full-featured event
3 loop 3 loop
4 4
5SYNOPSIS 5SYNOPSIS
6 use EV; 6 use EV;
7 7
8 # TIMERS 8 # TIMERS
9 9
10 my $w = EV::timer 2, 0, sub { 10 my $w = EV::timer 2, 0, sub {
11 warn "is called after 2s"; 11 warn "is called after 2s";
12 }; 12 };
13 13
14 my $w = EV::timer 2, 2, sub { 14 my $w = EV::timer 2, 2, sub {
15 warn "is called roughly every 2s (repeat = 2)"; 15 warn "is called roughly every 2s (repeat = 2)";
16 }; 16 };
17 17
18 undef $w; # destroy event watcher again 18 undef $w; # destroy event watcher again
19 19
20 my $w = EV::periodic 0, 60, 0, sub { 20 my $w = EV::periodic 0, 60, 0, sub {
21 warn "is called every minute, on the minute, exactly"; 21 warn "is called every minute, on the minute, exactly";
22 }; 22 };
23 23
24 # IO 24 # IO
25 25
26 my $w = EV::io *STDIN, EV::READ, sub { 26 my $w = EV::io *STDIN, EV::READ, sub {
27 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask 27 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
28 warn "stdin is readable, you entered: ", <STDIN>; 28 warn "stdin is readable, you entered: ", <STDIN>;
29 }; 29 };
30 30
31 # SIGNALS 31 # SIGNALS
32 32
33 my $w = EV::signal 'QUIT', sub { 33 my $w = EV::signal 'QUIT', sub {
34 warn "sigquit received\n"; 34 warn "sigquit received\n";
35 }; 35 };
36 36
37 # CHILD/PID STATUS CHANGES 37 # CHILD/PID STATUS CHANGES
38 38
39 my $w = EV::child 666, sub { 39 my $w = EV::child 666, 0, sub {
40 my ($w, $revents) = @_; 40 my ($w, $revents) = @_;
41 my $status = $w->rstatus; 41 my $status = $w->rstatus;
42 }; 42 };
43 43
44 # STAT CHANGES
45 my $w = EV::stat "/etc/passwd", 10, sub {
46 my ($w, $revents) = @_;
47 warn $w->path, " has changed somehow.\n";
48 };
49
44 # MAINLOOP 50 # MAINLOOP
45 EV::loop; # loop until EV::unloop is called or all watchers stop 51 EV::loop; # loop until EV::unloop is called or all watchers stop
46 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 52 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
47 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 53 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
48 54
49DESCRIPTION 55DESCRIPTION
50 This module provides an interface to libev 56 This module provides an interface to libev
51 (<http://software.schmorp.de/pkg/libev.html>). While the documentation 57 (<http://software.schmorp.de/pkg/libev.html>). While the documentation
52 below is comprehensive, one might also consult the documentation of 58 below is comprehensive, one might also consult the documentation of
53 libev itself (<http://cvs.schmorp.de/libev/ev.html>) for more subtle 59 libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>)
54 details on watcher semantics or some discussion on the available 60 for more subtle details on watcher semantics or some discussion on the
55 backends, or how to force a specific backend with "LIBEV_FLAGS". 61 available backends, or how to force a specific backend with
62 "LIBEV_FLAGS", or just about in any case because it has much more
63 detailed information.
64
65 This module is very fast and scalable. It is actually so fast that you
66 can use it through the AnyEvent module, stay portable to other event
67 loops (if you don't rely on any watcher types not available through it)
68 and still be faster than with any other event loop currently supported
69 in Perl.
70
71EVENT LOOPS
72 EV supports multiple event loops: There is a single "default event loop"
73 that can handle everything including signals and child watchers, and any
74 number of "dynamic event loops" that can use different backends (with
75 various limitations), but no child and signal watchers.
76
77 You do not have to do anything to create the default event loop: When
78 the module is loaded a suitable backend is selected on the premise of
79 selecting a working backend (which for example rules out kqueue on most
80 BSDs). Modules should, unless they have "special needs" always use the
81 default loop as this is fastest (perl-wise), best supported by other
82 modules (e.g. AnyEvent or Coro) and most portable event loop.
83
84 For specific programs you can create additional event loops dynamically.
85
86 If you want to take avdantage of kqueue (which often works properly for
87 sockets only) even though the default loop doesn't enable it, you can
88 *embed* a kqueue loop into the default loop: running the default loop
89 will then also service the kqueue loop to some extent. See the example
90 in the section about embed watchers for an example on how to achieve
91 that.
92
93 $loop = new EV::loop [$flags]
94 Create a new event loop as per the specified flags. Please refer to
95 the "ev_loop_new ()" function description in the libev documentation
96 (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTI
97 ONS>) for more info.
98
99 The loop will automatically be destroyed when it is no longer
100 referenced by any watcher and the loop object goes out of scope.
101
102 Using "EV::FLAG_FORKCHECK" is recommended, as only the default event
103 loop is protected by this module.
104
105 $loop->loop_fork
106 Must be called after a fork in the child, before entering or
107 continuing the event loop. An alternative is to use
108 "EV::FLAG_FORKCHECK" which calls this function automatically, at
109 some performance loss (refer to the libev documentation).
110
111 $loop->loop_verify
112 Calls "ev_verify" to make internal consistency checks (for debugging
113 libev) and abort the program if any data structures were found to be
114 corrupted.
115
116 $loop = EV::default_loop [$flags]
117 Return the default loop (which is a singleton object). Since this
118 module already creates the default loop with default flags,
119 specifying flags here will not have any effect unless you destroy
120 the default loop first, which isn't supported. So in short: don't do
121 it, and if you break it, you get to keep the pieces.
56 122
57BASIC INTERFACE 123BASIC INTERFACE
58 $EV::DIED 124 $EV::DIED
59 Must contain a reference to a function that is called when a 125 Must contain a reference to a function that is called when a
60 callback throws an exception (with $@ containing thr error). The 126 callback throws an exception (with $@ containing the error). The
61 default prints an informative message and continues. 127 default prints an informative message and continues.
62 128
63 If this callback throws an exception it will be silently ignored. 129 If this callback throws an exception it will be silently ignored.
130
131 $flags = EV::supported_backends
132 $flags = EV::recommended_backends
133 $flags = EV::embeddable_backends
134 Returns the set (see "EV::BACKEND_*" flags) of backends supported by
135 this instance of EV, the set of recommended backends (supposed to be
136 good) for this platform and the set of embeddable backends (see
137 EMBED WATCHERS).
138
139 EV::sleep $seconds
140 Block the process for the given number of (fractional) seconds.
64 141
65 $time = EV::time 142 $time = EV::time
66 Returns the current time in (fractional) seconds since the epoch. 143 Returns the current time in (fractional) seconds since the epoch.
67 144
68 $time = EV::now 145 $time = EV::now
146 $time = $loop->now
69 Returns the time the last event loop iteration has been started. 147 Returns the time the last event loop iteration has been started.
70 This is the time that (relative) timers are based on, and refering 148 This is the time that (relative) timers are based on, and refering
71 to it is usually faster then calling EV::time. 149 to it is usually faster then calling EV::time.
72 150
73 $method = EV::method 151 $backend = EV::backend
152 $backend = $loop->backend
74 Returns an integer describing the backend used by libev 153 Returns an integer describing the backend used by libev
75 (EV::METHOD_SELECT or EV::METHOD_EPOLL). 154 (EV::METHOD_SELECT or EV::METHOD_EPOLL).
76 155
77 EV::loop [$flags] 156 EV::loop [$flags]
157 $loop->loop ([$flags])
78 Begin checking for events and calling callbacks. It returns when a 158 Begin checking for events and calling callbacks. It returns when a
79 callback calls EV::unloop. 159 callback calls EV::unloop.
80 160
81 The $flags argument can be one of the following: 161 The $flags argument can be one of the following:
82 162
83 0 as above 163 0 as above
84 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 164 EV::LOOP_ONESHOT block at most once (wait, but do not loop)
85 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 165 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
86 166
87 EV::unloop [$how] 167 EV::unloop [$how]
168 $loop->unloop ([$how])
88 When called with no arguments or an argument of EV::UNLOOP_ONE, 169 When called with no arguments or an argument of EV::UNLOOP_ONE,
89 makes the innermost call to EV::loop return. 170 makes the innermost call to EV::loop return.
90 171
91 When called with an argument of EV::UNLOOP_ALL, all calls to 172 When called with an argument of EV::UNLOOP_ALL, all calls to
92 EV::loop will return as fast as possible. 173 EV::loop will return as fast as possible.
93 174
175 $count = EV::loop_count
176 $count = $loop->loop_count
177 Return the number of times the event loop has polled for new events.
178 Sometiems useful as a generation counter.
179
94 EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 180 EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
181 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
95 This function rolls together an I/O and a timer watcher for a single 182 This function rolls together an I/O and a timer watcher for a single
96 one-shot event without the need for managing a watcher object. 183 one-shot event without the need for managing a watcher object.
97 184
98 If $fh_or_undef is a filehandle or file descriptor, then $events 185 If $fh_or_undef is a filehandle or file descriptor, then $events
99 must be a bitset containing either "EV::READ", "EV::WRITE" or 186 must be a bitset containing either "EV::READ", "EV::WRITE" or
… …
104 If timeout is "undef" or negative, then there will be no timeout. 191 If timeout is "undef" or negative, then there will be no timeout.
105 Otherwise a EV::timer with this value will be started. 192 Otherwise a EV::timer with this value will be started.
106 193
107 When an error occurs or either the timeout or I/O watcher triggers, 194 When an error occurs or either the timeout or I/O watcher triggers,
108 then the callback will be called with the received event set (in 195 then the callback will be called with the received event set (in
109 general you can expect it to be a combination of "EV:ERROR", 196 general you can expect it to be a combination of "EV::ERROR",
110 "EV::READ", "EV::WRITE" and "EV::TIMEOUT"). 197 "EV::READ", "EV::WRITE" and "EV::TIMEOUT").
111 198
112 EV::once doesn't return anything: the watchers stay active till 199 EV::once doesn't return anything: the watchers stay active till
113 either of them triggers, then they will be stopped and freed, and 200 either of them triggers, then they will be stopped and freed, and
114 the callback invoked. 201 the callback invoked.
115 202
116 WATCHER 203 EV::feed_fd_event ($fd, $revents)
204 $loop->feed_fd_event ($fd, $revents)
205 Feed an event on a file descriptor into EV. EV will react to this
206 call as if the readyness notifications specified by $revents (a
207 combination of "EV::READ" and "EV::WRITE") happened on the file
208 descriptor $fd.
209
210 EV::feed_signal_event ($signal)
211 Feed a signal event into EV. EV will react to this call as if the
212 signal specified by $signal had occured.
213
214 EV::set_io_collect_interval $time
215 $loop->set_io_collect_interval ($time)
216 EV::set_timeout_collect_interval $time
217 $loop->set_timeout_collect_interval ($time)
218 These advanced functions set the minimum block interval when polling
219 for I/O events and the minimum wait interval for timer events. See
220 the libev documentation at
221 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT
222 ROLLING_THE_EVENT_LOOP> for a more detailed discussion.
223
224WATCHER OBJECTS
117 A watcher is an object that gets created to record your interest in some 225 A watcher is an object that gets created to record your interest in some
118 event. For instance, if you want to wait for STDIN to become readable, 226 event. For instance, if you want to wait for STDIN to become readable,
119 you would create an EV::io watcher for that: 227 you would create an EV::io watcher for that:
120 228
121 my $watcher = EV::io *STDIN, EV::READ, sub { 229 my $watcher = EV::io *STDIN, EV::READ, sub {
122 my ($watcher, $revents) = @_; 230 my ($watcher, $revents) = @_;
123 warn "yeah, STDIN should not be readable without blocking!\n" 231 warn "yeah, STDIN should now be readable without blocking!\n"
124 }; 232 };
125 233
126 All watchers can be active (waiting for events) or inactive (paused). 234 All watchers can be active (waiting for events) or inactive (paused).
127 Only active watchers will have their callbacks invoked. All callbacks 235 Only active watchers will have their callbacks invoked. All callbacks
128 will be called with at least two arguments: the watcher and a bitmask of 236 will be called with at least two arguments: the watcher and a bitmask of
129 received events. 237 received events.
130 238
131 Each watcher type has its associated bit in revents, so you can use the 239 Each watcher type has its associated bit in revents, so you can use the
132 same callback for multiple watchers. The event mask is named after the 240 same callback for multiple watchers. The event mask is named after the
133 type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 241 type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
134 EV::periodic sets EV::PERIODIC and so on, with the exception of IO 242 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O
135 events (which can set both EV::READ and EV::WRITE bits), and EV::timer 243 events (which can set both EV::READ and EV::WRITE bits), and EV::timer
136 (which uses EV::TIMEOUT). 244 (which uses EV::TIMEOUT).
137 245
138 In the rare case where one wants to create a watcher but not start it at 246 In the rare case where one wants to create a watcher but not start it at
139 the same time, each constructor has a variant with a trailing "_ns" in 247 the same time, each constructor has a variant with a trailing "_ns" in
… …
145 253
146 Also, all methods changing some aspect of a watcher (->set, ->priority, 254 Also, all methods changing some aspect of a watcher (->set, ->priority,
147 ->fh and so on) automatically stop and start it again if it is active, 255 ->fh and so on) automatically stop and start it again if it is active,
148 which means pending events get lost. 256 which means pending events get lost.
149 257
150 WATCHER TYPES 258 COMMON WATCHER METHODS
151 Now lets move to the existing watcher types and asociated methods. 259 This section lists methods common to all watchers.
152
153 The following methods are available for all watchers. Then followes a
154 description of each watcher constructor (EV::io, EV::timer,
155 EV::periodic, EV::signal, EV::child, EV::idle, EV::prepare and
156 EV::check), followed by any type-specific methods (if any).
157 260
158 $w->start 261 $w->start
159 Starts a watcher if it isn't active already. Does nothing to an 262 Starts a watcher if it isn't active already. Does nothing to an
160 already active watcher. By default, all watchers start out in the 263 already active watcher. By default, all watchers start out in the
161 active state (see the description of the "_ns" variants if you need 264 active state (see the description of the "_ns" variants if you need
162 stopped watchers). 265 stopped watchers).
163 266
164 $w->stop 267 $w->stop
165 Stop a watcher if it is active. Also clear any pending events 268 Stop a watcher if it is active. Also clear any pending events
166 (events that have been received but that didn't yet result in a 269 (events that have been received but that didn't yet result in a
167 callback invocation), regardless of wether the watcher was active or 270 callback invocation), regardless of whether the watcher was active
168 not. 271 or not.
169 272
170 $bool = $w->is_active 273 $bool = $w->is_active
171 Returns true if the watcher is active, false otherwise. 274 Returns true if the watcher is active, false otherwise.
172 275
173 $current_data = $w->data 276 $current_data = $w->data
… …
196 The default priority of any newly-created watcher is 0. 299 The default priority of any newly-created watcher is 0.
197 300
198 Note that the priority semantics have not yet been fleshed out and 301 Note that the priority semantics have not yet been fleshed out and
199 are subject to almost certain change. 302 are subject to almost certain change.
200 303
201 $w->trigger ($revents) 304 $w->invoke ($revents)
202 Call the callback *now* with the given event mask. 305 Call the callback *now* with the given event mask.
306
307 $w->feed_event ($revents)
308 Feed some events on this watcher into EV. EV will react to this call
309 as if the watcher had received the given $revents mask.
310
311 $revents = $w->clear_pending
312 If the watcher is pending, this function clears its pending status
313 and returns its $revents bitset (as if its callback was invoked). If
314 the watcher isn't pending it does nothing and returns 0.
203 315
204 $previous_state = $w->keepalive ($bool) 316 $previous_state = $w->keepalive ($bool)
205 Normally, "EV::loop" will return when there are no active watchers 317 Normally, "EV::loop" will return when there are no active watchers
206 (which is a "deadlock" because no progress can be made anymore). 318 (which is a "deadlock" because no progress can be made anymore).
207 This is convinient because it allows you to start your watchers (and 319 This is convinient because it allows you to start your watchers (and
208 your jobs), call "EV::loop" once and when it returns you know that 320 your jobs), call "EV::loop" once and when it returns you know that
209 all your jobs are finished (or they forgot to register some watchers 321 all your jobs are finished (or they forgot to register some watchers
210 for their task :). 322 for their task :).
211 323
212 Sometimes, however, this gets in your way, for example when you the 324 Sometimes, however, this gets in your way, for example when the
213 module that calls "EV::loop" (usually the main program) is not the 325 module that calls "EV::loop" (usually the main program) is not the
214 same module as a long-living watcher (for example a DNS client 326 same module as a long-living watcher (for example a DNS client
215 module written by somebody else even). Then you might want any 327 module written by somebody else even). Then you might want any
216 outstanding requests to be handled, but you would not want to keep 328 outstanding requests to be handled, but you would not want to keep
217 "EV::loop" from returning just because you happen to have this 329 "EV::loop" from returning just because you happen to have this
… …
222 returning. 334 returning.
223 335
224 The initial value for keepalive is true (enabled), and you cna 336 The initial value for keepalive is true (enabled), and you cna
225 change it any time. 337 change it any time.
226 338
227 Example: Register an IO watcher for some UDP socket but do not keep 339 Example: Register an I/O watcher for some UDP socket but do not keep
228 the event loop from running just because of that watcher. 340 the event loop from running just because of that watcher.
229 341
230 my $udp_socket = ... 342 my $udp_socket = ...
231 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 343 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
232 $udp_watcher->keepalive (0); 344 $udp_watcher->keepalive (0);
233 345
346 $loop = $w->loop
347 Return the loop that this watcher is attached to.
348
349WATCHER TYPES
350 Each of the following subsections describes a single watcher type.
351
352 I/O WATCHERS - is this file descriptor readable or writable?
234 $w = EV::io $fileno_or_fh, $eventmask, $callback 353 $w = EV::io $fileno_or_fh, $eventmask, $callback
235 $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 354 $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
355 $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
356 $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
236 As long as the returned watcher object is alive, call the $callback 357 As long as the returned watcher object is alive, call the $callback
237 when the events specified in $eventmask. 358 when at least one of events specified in $eventmask occurs.
238 359
239 The $eventmask can be one or more of these constants ORed together: 360 The $eventmask can be one or more of these constants ORed together:
240 361
241 EV::READ wait until read() wouldn't block anymore 362 EV::READ wait until read() wouldn't block anymore
242 EV::WRITE wait until write() wouldn't block anymore 363 EV::WRITE wait until write() wouldn't block anymore
… …
254 375
255 $current_eventmask = $w->events 376 $current_eventmask = $w->events
256 $old_eventmask = $w->events ($new_eventmask) 377 $old_eventmask = $w->events ($new_eventmask)
257 Returns the previously set event mask and optionally set a new one. 378 Returns the previously set event mask and optionally set a new one.
258 379
380 TIMER WATCHERS - relative and optionally repeating timeouts
259 $w = EV::timer $after, $repeat, $callback 381 $w = EV::timer $after, $repeat, $callback
260 $w = EV::timer_ns $after, $repeat, $callback 382 $w = EV::timer_ns $after, $repeat, $callback
383 $w = $loop->timer ($after, $repeat, $callback)
384 $w = $loop->timer_ns ($after, $repeat, $callback)
261 Calls the callback after $after seconds (which may be fractional). 385 Calls the callback after $after seconds (which may be fractional).
262 If $repeat is non-zero, the timer will be restarted (with the 386 If $repeat is non-zero, the timer will be restarted (with the
263 $repeat value as $after) after the callback returns. 387 $repeat value as $after) after the callback returns.
264 388
265 This means that the callback would be called roughly after $after 389 This means that the callback would be called roughly after $after
… …
277 The "timer_ns" variant doesn't start (activate) the newly created 401 The "timer_ns" variant doesn't start (activate) the newly created
278 watcher. 402 watcher.
279 403
280 $w->set ($after, $repeat) 404 $w->set ($after, $repeat)
281 Reconfigures the watcher, see the constructor above for details. Can 405 Reconfigures the watcher, see the constructor above for details. Can
282 be at any time. 406 be called at any time.
283 407
284 $w->again 408 $w->again
285 Similar to the "start" method, but has special semantics for 409 Similar to the "start" method, but has special semantics for
286 repeating timers: 410 repeating timers:
287 411
… …
298 This behaviour is useful when you have a timeout for some IO 422 This behaviour is useful when you have a timeout for some IO
299 operation. You create a timer object with the same value for $after 423 operation. You create a timer object with the same value for $after
300 and $repeat, and then, in the read/write watcher, run the "again" 424 and $repeat, and then, in the read/write watcher, run the "again"
301 method on the timeout. 425 method on the timeout.
302 426
427 PERIODIC WATCHERS - to cron or not to cron?
303 $w = EV::periodic $at, $interval, $reschedule_cb, $callback 428 $w = EV::periodic $at, $interval, $reschedule_cb, $callback
304 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 429 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
430 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
431 $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
305 Similar to EV::timer, but is not based on relative timeouts but on 432 Similar to EV::timer, but is not based on relative timeouts but on
306 absolute times. Apart from creating "simple" timers that trigger 433 absolute times. Apart from creating "simple" timers that trigger
307 "at" the specified time, it can also be used for non-drifting 434 "at" the specified time, it can also be used for non-drifting
308 absolute timers and more complex, cron-like, setups that are not 435 absolute timers and more complex, cron-like, setups that are not
309 adversely affected by time jumps (i.e. when the system clock is 436 adversely affected by time jumps (i.e. when the system clock is
310 changed by explicit date -s or other means such as ntpd). It is also 437 changed by explicit date -s or other means such as ntpd). It is also
311 the most complex watcher type in EV. 438 the most complex watcher type in EV.
312 439
313 It has three distinct "modes": 440 It has three distinct "modes":
314 441
315 * absolute timer ($interval = $reschedule_cb = 0) 442 * absolute timer ($interval = $reschedule_cb = 0)
443
316 This time simply fires at the wallclock time $at and doesn't 444 This time simply fires at the wallclock time $at and doesn't
317 repeat. It will not adjust when a time jump occurs, that is, if 445 repeat. It will not adjust when a time jump occurs, that is, if
318 it is to be run at January 1st 2011 then it will run when the 446 it is to be run at January 1st 2011 then it will run when the
319 system time reaches or surpasses this time. 447 system time reaches or surpasses this time.
320 448
321 * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 449 * repeating interval timer ($interval > 0, $reschedule_cb = 0)
450
322 In this mode the watcher will always be scheduled to time out at 451 In this mode the watcher will always be scheduled to time out at
323 the next "$at + N * $interval" time (for some integer N) and 452 the next "$at + N * $interval" time (for some integer N) and
324 then repeat, regardless of any time jumps. 453 then repeat, regardless of any time jumps.
325 454
326 This can be used to create timers that do not drift with respect 455 This can be used to create timers that do not drift with respect
… …
335 Another way to think about it (for the mathematically inclined) 464 Another way to think about it (for the mathematically inclined)
336 is that EV::periodic will try to run the callback in this mode 465 is that EV::periodic will try to run the callback in this mode
337 at the next possible time where "$time = $at (mod $interval)", 466 at the next possible time where "$time = $at (mod $interval)",
338 regardless of any time jumps. 467 regardless of any time jumps.
339 468
340 * manual reschedule mode ($reschedule_cb = coderef) 469 * manual reschedule mode ($reschedule_cb = coderef)
470
341 In this mode $interval and $at are both being ignored. Instead, 471 In this mode $interval and $at are both being ignored. Instead,
342 each time the periodic watcher gets scheduled, the reschedule 472 each time the periodic watcher gets scheduled, the reschedule
343 callback ($reschedule_cb) will be called with the watcher as 473 callback ($reschedule_cb) will be called with the watcher as
344 first, and the current time as second argument. 474 first, and the current time as second argument.
345 475
346 *This callback MUST NOT stop or destroy this or any other 476 *This callback MUST NOT stop or destroy this or any other
477 periodic watcher, ever, and MUST NOT call any event loop
347 periodic watcher, ever*. If you need to stop it, return 1e30 and 478 functions or methods*. If you need to stop it, return 1e30 and
348 stop it afterwards. 479 stop it afterwards. You may create and start a "EV::prepare"
480 watcher for this task.
349 481
350 It must return the next time to trigger, based on the passed 482 It must return the next time to trigger, based on the passed
351 time value (that is, the lowest time value larger than to the 483 time value (that is, the lowest time value larger than or equal
352 second argument). It will usually be called just before the 484 to to the second argument). It will usually be called just
353 callback will be triggered, but might be called at other times, 485 before the callback will be triggered, but might be called at
354 too. 486 other times, too.
355 487
356 This can be used to create very complex timers, such as a timer 488 This can be used to create very complex timers, such as a timer
357 that triggers on each midnight, local time (actually 24 hours 489 that triggers on each midnight, local time (actually 24 hours
358 after the last midnight, to keep the example simple. If you know 490 after the last midnight, to keep the example simple. If you know
359 a way to do it correctly in about the same space (without 491 a way to do it correctly in about the same space (without
… …
372 The "periodic_ns" variant doesn't start (activate) the newly created 504 The "periodic_ns" variant doesn't start (activate) the newly created
373 watcher. 505 watcher.
374 506
375 $w->set ($at, $interval, $reschedule_cb) 507 $w->set ($at, $interval, $reschedule_cb)
376 Reconfigures the watcher, see the constructor above for details. Can 508 Reconfigures the watcher, see the constructor above for details. Can
377 be at any time. 509 be called at any time.
378 510
379 $w->again 511 $w->again
380 Simply stops and starts the watcher again. 512 Simply stops and starts the watcher again.
381 513
514 $time = $w->at
515 Return the time that the watcher is expected to trigger next.
516
517 SIGNAL WATCHERS - signal me when a signal gets signalled!
382 $w = EV::signal $signal, $callback 518 $w = EV::signal $signal, $callback
383 $w = EV::signal_ns $signal, $callback 519 $w = EV::signal_ns $signal, $callback
384 Call the callback when $signal is received (the signal can be 520 Call the callback when $signal is received (the signal can be
385 specified by number or by name, just as with kill or %SIG). 521 specified by number or by name, just as with "kill" or %SIG).
386 522
387 EV will grab the signal for the process (the kernel only allows one 523 EV will grab the signal for the process (the kernel only allows one
388 component to receive a signal at a time) when you start a signal 524 component to receive a signal at a time) when you start a signal
389 watcher, and removes it again when you stop it. Perl does the same 525 watcher, and removes it again when you stop it. Perl does the same
390 when you add/remove callbacks to %SIG, so watch out. 526 when you add/remove callbacks to %SIG, so watch out.
… …
394 The "signal_ns" variant doesn't start (activate) the newly created 530 The "signal_ns" variant doesn't start (activate) the newly created
395 watcher. 531 watcher.
396 532
397 $w->set ($signal) 533 $w->set ($signal)
398 Reconfigures the watcher, see the constructor above for details. Can 534 Reconfigures the watcher, see the constructor above for details. Can
399 be at any time. 535 be called at any time.
400 536
401 $current_signum = $w->signal 537 $current_signum = $w->signal
402 $old_signum = $w->signal ($new_signal) 538 $old_signum = $w->signal ($new_signal)
403 Returns the previously set signal (always as a number not name) and 539 Returns the previously set signal (always as a number not name) and
404 optionally set a new one. 540 optionally set a new one.
405 541
542 CHILD WATCHERS - watch out for process status changes
406 $w = EV::child $pid, $callback 543 $w = EV::child $pid, $trace, $callback
407 $w = EV::child_ns $pid, $callback 544 $w = EV::child_ns $pid, $trace, $callback
545 $w = $loop->child ($pid, $trace, $callback)
546 $w = $loop->child_ns ($pid, $trace, $callback)
408 Call the callback when a status change for pid $pid (or any pid if 547 Call the callback when a status change for pid $pid (or any pid if
409 $pid is 0) has been received. More precisely: when the process 548 $pid is 0) has been received (a status change happens when the
549 process terminates or is killed, or, when trace is true,
550 additionally when it is stopped or continued). More precisely: when
410 receives a SIGCHLD, EV will fetch the outstanding exit/wait status 551 the process receives a "SIGCHLD", EV will fetch the outstanding
411 for all changed/zombie children and call the callback. 552 exit/wait status for all changed/zombie children and call the
553 callback.
412 554
413 You can access both status and pid by using the "rstatus" and "rpid" 555 It is valid (and fully supported) to install a child watcher after a
556 child has exited but before the event loop has started its next
557 iteration (for example, first you "fork", then the new child process
558 might exit, and only then do you install a child watcher in the
559 parent for the new pid).
560
561 You can access both exit (or tracing) status and pid by using the
414 methods on the watcher object. 562 "rstatus" and "rpid" methods on the watcher object.
415 563
416 You can have as many pid watchers per pid as you want. 564 You can have as many pid watchers per pid as you want, they will all
565 be called.
417 566
418 The "child_ns" variant doesn't start (activate) the newly created 567 The "child_ns" variant doesn't start (activate) the newly created
419 watcher. 568 watcher.
420 569
421 $w->set ($pid) 570 $w->set ($pid, $trace)
422 Reconfigures the watcher, see the constructor above for details. Can 571 Reconfigures the watcher, see the constructor above for details. Can
423 be at any time. 572 be called at any time.
424 573
425 $current_pid = $w->pid 574 $current_pid = $w->pid
426 $old_pid = $w->pid ($new_pid)
427 Returns the previously set process id and optionally set a new one. 575 Returns the previously set process id and optionally set a new one.
428 576
429 $exit_status = $w->rstatus 577 $exit_status = $w->rstatus
430 Return the exit/wait status (as returned by waitpid, see the waitpid 578 Return the exit/wait status (as returned by waitpid, see the waitpid
431 entry in perlfunc). 579 entry in perlfunc).
432 580
433 $pid = $w->rpid 581 $pid = $w->rpid
434 Return the pid of the awaited child (useful when you have installed 582 Return the pid of the awaited child (useful when you have installed
435 a watcher for all pids). 583 a watcher for all pids).
436 584
585 STAT WATCHERS - did the file attributes just change?
586 $w = EV::stat $path, $interval, $callback
587 $w = EV::stat_ns $path, $interval, $callback
588 $w = $loop->stat ($path, $interval, $callback)
589 $w = $loop->stat_ns ($path, $interval, $callback)
590 Call the callback when a file status change has been detected on
591 $path. The $path does not need to exist, changing from "path exists"
592 to "path does not exist" is a status change like any other.
593
594 The $interval is a recommended polling interval for systems where
595 OS-supported change notifications don't exist or are not supported.
596 If you use 0 then an unspecified default is used (which is highly
597 recommended!), which is to be expected to be around five seconds
598 usually.
599
600 This watcher type is not meant for massive numbers of stat watchers,
601 as even with OS-supported change notifications, this can be
602 resource-intensive.
603
604 The "stat_ns" variant doesn't start (activate) the newly created
605 watcher.
606
607 ... = $w->stat
608 This call is very similar to the perl "stat" built-in: It stats
609 (using "lstat") the path specified in the watcher and sets perls
610 stat cache (as well as EV's idea of the current stat values) to the
611 values found.
612
613 In scalar context, a boolean is return indicating success or failure
614 of the stat. In list context, the same 13-value list as with stat is
615 returned (except that the blksize and blocks fields are not
616 reliable).
617
618 In the case of an error, errno is set to "ENOENT" (regardless of the
619 actual error value) and the "nlink" value is forced to zero (if the
620 stat was successful then nlink is guaranteed to be non-zero).
621
622 See also the next two entries for more info.
623
624 ... = $w->attr
625 Just like "$w->stat", but without the initial stat'ing: this returns
626 the values most recently detected by EV. See the next entry for more
627 info.
628
629 ... = $w->prev
630 Just like "$w->stat", but without the initial stat'ing: this returns
631 the previous set of values, before the change.
632
633 That is, when the watcher callback is invoked, "$w->prev" will be
634 set to the values found *before* a change was detected, while
635 "$w->attr" returns the values found leading to the change detection.
636 The difference (if any) between "prev" and "attr" is what triggered
637 the callback.
638
639 If you did something to the filesystem object and do not want to
640 trigger yet another change, you can call "stat" to update EV's idea
641 of what the current attributes are.
642
643 $w->set ($path, $interval)
644 Reconfigures the watcher, see the constructor above for details. Can
645 be called at any time.
646
647 $current_path = $w->path
648 $old_path = $w->path ($new_path)
649 Returns the previously set path and optionally set a new one.
650
651 $current_interval = $w->interval
652 $old_interval = $w->interval ($new_interval)
653 Returns the previously set interval and optionally set a new one.
654 Can be used to query the actual interval used.
655
656 IDLE WATCHERS - when you've got nothing better to do...
437 $w = EV::idle $callback 657 $w = EV::idle $callback
438 $w = EV::idle_ns $callback 658 $w = EV::idle_ns $callback
659 $w = $loop->idle ($callback)
660 $w = $loop->idle_ns ($callback)
439 Call the callback when there are no pending io, timer/periodic, 661 Call the callback when there are no other pending watchers of the
440 signal or child events, i.e. when the process is idle. 662 same or higher priority (excluding check, prepare and other idle
663 watchers of the same or lower priority, of course). They are called
664 idle watchers because when the watcher is the highest priority
665 pending event in the process, the process is considered to be idle
666 at that priority.
667
668 If you want a watcher that is only ever called when *no* other
669 events are outstanding you have to set the priority to "EV::MINPRI".
441 670
442 The process will not block as long as any idle watchers are active, 671 The process will not block as long as any idle watchers are active,
443 and they will be called repeatedly until stopped. 672 and they will be called repeatedly until stopped.
444 673
674 For example, if you have idle watchers at priority 0 and 1, and an
675 I/O watcher at priority 0, then the idle watcher at priority 1 and
676 the I/O watcher will always run when ready. Only when the idle
677 watcher at priority 1 is stopped and the I/O watcher at priority 0
678 is not pending with the 0-priority idle watcher be invoked.
679
445 The "idle_ns" variant doesn't start (activate) the newly created 680 The "idle_ns" variant doesn't start (activate) the newly created
446 watcher. 681 watcher.
447 682
683 PREPARE WATCHERS - customise your event loop!
448 $w = EV::prepare $callback 684 $w = EV::prepare $callback
449 $w = EV::prepare_ns $callback 685 $w = EV::prepare_ns $callback
686 $w = $loop->prepare ($callback)
687 $w = $loop->prepare_ns ($callback)
450 Call the callback just before the process would block. You can still 688 Call the callback just before the process would block. You can still
451 create/modify any watchers at this point. 689 create/modify any watchers at this point.
452 690
453 See the EV::check watcher, below, for explanations and an example. 691 See the EV::check watcher, below, for explanations and an example.
454 692
455 The "prepare_ns" variant doesn't start (activate) the newly created 693 The "prepare_ns" variant doesn't start (activate) the newly created
456 watcher. 694 watcher.
457 695
696 CHECK WATCHERS - customise your event loop even more!
458 $w = EV::check $callback 697 $w = EV::check $callback
459 $w = EV::check_ns $callback 698 $w = EV::check_ns $callback
699 $w = $loop->check ($callback)
700 $w = $loop->check_ns ($callback)
460 Call the callback just after the process wakes up again (after it 701 Call the callback just after the process wakes up again (after it
461 has gathered events), but before any other callbacks have been 702 has gathered events), but before any other callbacks have been
462 invoked. 703 invoked.
463 704
464 This is used to integrate other event-based software into the EV 705 This is used to integrate other event-based software into the EV
… …
475 or return; 716 or return;
476 717
477 # make the dispatcher handle any outstanding stuff 718 # make the dispatcher handle any outstanding stuff
478 ... not shown 719 ... not shown
479 720
480 # create an IO watcher for each and every socket 721 # create an I/O watcher for each and every socket
481 @snmp_watcher = ( 722 @snmp_watcher = (
482 (map { EV::io $_, EV::READ, sub { } } 723 (map { EV::io $_, EV::READ, sub { } }
483 keys %{ $dispatcher->{_descriptors} }), 724 keys %{ $dispatcher->{_descriptors} }),
484 725
485 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] 726 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
… …
505 watchers are destroyed before this cna happen (remember EV::check 746 watchers are destroyed before this cna happen (remember EV::check
506 gets called first). 747 gets called first).
507 748
508 The "check_ns" variant doesn't start (activate) the newly created 749 The "check_ns" variant doesn't start (activate) the newly created
509 watcher. 750 watcher.
751
752 FORK WATCHERS - the audacity to resume the event loop after a fork
753 Fork watchers are called when a "fork ()" was detected. The invocation
754 is done before the event loop blocks next and before "check" watchers
755 are being called, and only in the child after the fork.
756
757 $w = EV::fork $callback
758 $w = EV::fork_ns $callback
759 $w = $loop->fork ($callback)
760 $w = $loop->fork_ns ($callback)
761 Call the callback before the event loop is resumed in the child
762 process after a fork.
763
764 The "fork_ns" variant doesn't start (activate) the newly created
765 watcher.
766
767 EMBED WATCHERS - when one backend isn't enough...
768 This is a rather advanced watcher type that lets you embed one event
769 loop into another (currently only IO events are supported in the
770 embedded loop, other types of watchers might be handled in a delayed or
771 incorrect fashion and must not be used).
772
773 See the libev documentation at
774 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code
775 _when_one_backend_> for more details.
776
777 In short, this watcher is most useful on BSD systems without working
778 kqueue to still be able to handle a large number of sockets:
779
780 my $socket_loop;
781
782 # check wether we use SELECT or POLL _and_ KQUEUE is supported
783 if (
784 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
785 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
786 ) {
787 # use kqueue for sockets
788 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
789 }
790
791 # use the default loop otherwise
792 $socket_loop ||= EV::default_loop;
793
794 $w = EV::embed $otherloop, $callback
795 $w = EV::embed_ns $otherloop, $callback
796 $w = $loop->embed ($otherloop, $callback)
797 $w = $loop->embed_ns ($otherloop, $callback)
798 Call the callback when the embedded event loop ($otherloop) has any
799 I/O activity. The $callback should alwas be specified as "undef" in
800 this version of EV, which means the embedded event loop will be
801 managed automatically.
802
803 The "embed_ns" variant doesn't start (activate) the newly created
804 watcher.
805
806 ASYNC WATCHERS - how to wake up another event loop
807 Async watchers are provided by EV, but have little use in perl directly,
808 as perl neither supports threads nor direct access to signal handlers or
809 other contexts where they could be of value.
810
811 It is, however, possible to use them from the XS level.
812
813 Please see the libev documentation for further details.
814
815 $w = EV::async $callback
816 $w = EV::async_ns $callback
817 $w->send
818 $bool = $w->async_pending
819
820PERL SIGNALS
821 While Perl signal handling (%SIG) is not affected by EV, the behaviour
822 with EV is as the same as any other C library: Perl-signals will only be
823 handled when Perl runs, which means your signal handler might be invoked
824 only the next time an event callback is invoked.
825
826 The solution is to use EV signal watchers (see "EV::signal"), which will
827 ensure proper operations with regards to other event watchers.
828
829 If you cannot do this for whatever reason, you can also force a watcher
830 to be called on every event loop iteration by installing a "EV::check"
831 watcher:
832
833 my $async_check = EV::check sub { };
834
835 This ensures that perl gets into control for a short time to handle any
836 pending signals, and also ensures (slightly) slower overall operation.
510 837
511THREADS 838THREADS
512 Threads are not supported by this module in any way. Perl pseudo-threads 839 Threads are not supported by this module in any way. Perl pseudo-threads
513 is evil stuff and must die. As soon as Perl gains real threads I will 840 is evil stuff and must die. As soon as Perl gains real threads I will
514 work on thread support for it. 841 work on thread support for it.
… …
529 856
530 On win32, there is no notion of fork so all this doesn't apply, of 857 On win32, there is no notion of fork so all this doesn't apply, of
531 course. 858 course.
532 859
533SEE ALSO 860SEE ALSO
534 L<EV::DNS>. 861 EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event
862 loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines
863 with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop
864 agnostic and portable event driven programming.
535 865
536AUTHOR 866AUTHOR
537 Marc Lehmann <schmorp@schmorp.de> 867 Marc Lehmann <schmorp@schmorp.de>
538 http://home.schmorp.de/ 868 http://home.schmorp.de/
539 869

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines