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

Comparing EV/README (file contents):
Revision 1.22 by root, Mon Jan 28 12:24:05 2008 UTC vs.
Revision 1.44 by root, Mon Jul 13 19:47:53 2015 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, 0, 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 44 # STAT CHANGES
45 my $w = EV::stat "/etc/passwd", 10, sub { 45 my $w = EV::stat "/etc/passwd", 10, sub {
46 my ($w, $revents) = @_; 46 my ($w, $revents) = @_;
47 warn $w->path, " has changed somehow.\n"; 47 warn $w->path, " has changed somehow.\n";
48 }; 48 };
49 49
50 # MAINLOOP 50 # MAINLOOP
51 EV::loop; # loop until EV::unloop is called or all watchers stop 51 EV::run; # loop until EV::break is called or all watchers stop
52 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 52 EV::run EV::RUN_ONCE; # block until at least one event could be handled
53 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 53 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
54
55BEFORE YOU START USING THIS MODULE
56 If you only need timer, I/O, signal, child and idle watchers and not the
57 advanced functionality of this module, consider using AnyEvent instead,
58 specifically the simplified API described in AE.
59
60 When used with EV as backend, the AE API is as fast as the native EV
61 API, but your programs/modules will still run with many other event
62 loops.
54 63
55DESCRIPTION 64DESCRIPTION
56 This module provides an interface to libev 65 This module provides an interface to libev
57 (<http://software.schmorp.de/pkg/libev.html>). While the documentation 66 (<http://software.schmorp.de/pkg/libev.html>). While the documentation
58 below is comprehensive, one might also consult the documentation of 67 below is comprehensive, one might also consult the documentation of
59 libev itself (<http://cvs.schmorp.de/libev/ev.html>) for more subtle 68 libev itself (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
60 details on watcher semantics or some discussion on the available 69 perldoc EV::libev) for more subtle details on watcher semantics or some
61 backends, or how to force a specific backend with "LIBEV_FLAGS", or just 70 discussion on the available backends, or how to force a specific backend
62 about in any case because it has much more detailed information. 71 with "LIBEV_FLAGS", or just about in any case because it has much more
72 detailed information.
73
74 This module is very fast and scalable. It is actually so fast that you
75 can use it through the AnyEvent module, stay portable to other event
76 loops (if you don't rely on any watcher types not available through it)
77 and still be faster than with any other event loop currently supported
78 in Perl.
79
80 PORTING FROM EV 3.X to 4.X
81 EV version 4 introduces a number of incompatible changes summarised
82 here. According to the depreciation strategy used by libev, there is a
83 compatibility layer in place so programs should continue to run
84 unchanged (the XS interface lacks this layer, so programs using that one
85 need to be updated).
86
87 This compatibility layer will be switched off in some future release.
88
89 All changes relevant to Perl are renames of symbols, functions and
90 methods:
91
92 EV::loop => EV::run
93 EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
94 EV::LOOP_ONESHOT => EV::RUN_ONCE
95
96 EV::unloop => EV::break
97 EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
98 EV::UNLOOP_ONE => EV::BREAK_ONE
99 EV::UNLOOP_ALL => EV::BREAK_ALL
100
101 EV::TIMEOUT => EV::TIMER
102
103 EV::loop_count => EV::iteration
104 EV::loop_depth => EV::depth
105 EV::loop_verify => EV::verify
106
107 The loop object methods corresponding to the functions above have been
108 similarly renamed.
109
110 MODULE EXPORTS
111 This module does not export any symbols.
63 112
64EVENT LOOPS 113EVENT LOOPS
65 EV supports multiple event loops: There is a single "default event loop" 114 EV supports multiple event loops: There is a single "default event loop"
66 that can handle everything including signals and child watchers, and any 115 that can handle everything including signals and child watchers, and any
67 number of "dynamic event loops" that can use different backends (with 116 number of "dynamic event loops" that can use different backends (with
… …
74 default loop as this is fastest (perl-wise), best supported by other 123 default loop as this is fastest (perl-wise), best supported by other
75 modules (e.g. AnyEvent or Coro) and most portable event loop. 124 modules (e.g. AnyEvent or Coro) and most portable event loop.
76 125
77 For specific programs you can create additional event loops dynamically. 126 For specific programs you can create additional event loops dynamically.
78 127
128 If you want to take advantage of kqueue (which often works properly for
129 sockets only) even though the default loop doesn't enable it, you can
130 *embed* a kqueue loop into the default loop: running the default loop
131 will then also service the kqueue loop to some extent. See the example
132 in the section about embed watchers for an example on how to achieve
133 that.
134
79 $loop = new EV::loop [$flags] 135 $loop = new EV::Loop [$flags]
80 Create a new event loop as per the specified flags. Please refer to 136 Create a new event loop as per the specified flags. Please refer to
81 the "ev_loop_new ()" function description in the libev documentation 137 the "ev_loop_new ()" function description in the libev documentation
82 (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTI 138 (<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTI
83 ONS>) for more info. 139 ONS>, or locally-installed as EV::libev manpage) for more info.
84 140
85 The loop will automatically be destroyed when it is no longer 141 The loop will automatically be destroyed when it is no longer
86 referenced by any watcher and the loop object goes out of scope. 142 referenced by any watcher and the loop object goes out of scope.
87 143
88 Using "EV::FLAG_FORKCHECK" is recommended, as only the default event 144 If you are not embedding the loop, then Using "EV::FLAG_FORKCHECK"
89 loop is protected by this module. 145 is recommended, as only the default event loop is protected by this
146 module. If you *are* embedding this loop in the default loop, this
147 is not necessary, as "EV::embed" automatically does the right thing
148 on fork.
90 149
91 $loop->loop_fork 150 $loop->loop_fork
92 Must be called after a fork in the child, before entering or 151 Must be called after a fork in the child, before entering or
93 continuing the event loop. An alternative is to use 152 continuing the event loop. An alternative is to use
94 "EV::FLAG_FORKCHECK" which calls this fucntion automatically, at 153 "EV::FLAG_FORKCHECK" which calls this function automatically, at
95 some performance loss (refer to the libev documentation). 154 some performance loss (refer to the libev documentation).
96 155
156 $loop->verify
157 Calls "ev_verify" to make internal consistency checks (for debugging
158 libev) and abort the program if any data structures were found to be
159 corrupted.
160
97 $loop = EV::default_loop [$flags] 161 $loop = EV::default_loop [$flags]
98 Return the default loop (which is a singleton object). 162 Return the default loop (which is a singleton object). Since this
163 module already creates the default loop with default flags,
164 specifying flags here will not have any effect unless you destroy
165 the default loop first, which isn't supported. So in short: don't do
166 it, and if you break it, you get to keep the pieces.
99 167
100BASIC INTERFACE 168BASIC INTERFACE
101 $EV::DIED 169 $EV::DIED
102 Must contain a reference to a function that is called when a 170 Must contain a reference to a function that is called when a
103 callback throws an exception (with $@ containing the error). The 171 callback throws an exception (with $@ containing the error). The
… …
120 Returns the current time in (fractional) seconds since the epoch. 188 Returns the current time in (fractional) seconds since the epoch.
121 189
122 $time = EV::now 190 $time = EV::now
123 $time = $loop->now 191 $time = $loop->now
124 Returns the time the last event loop iteration has been started. 192 Returns the time the last event loop iteration has been started.
125 This is the time that (relative) timers are based on, and refering 193 This is the time that (relative) timers are based on, and referring
126 to it is usually faster then calling EV::time. 194 to it is usually faster then calling EV::time.
195
196 EV::now_update
197 $loop->now_update
198 Establishes the current time by querying the kernel, updating the
199 time returned by "EV::now" in the progress. This is a costly
200 operation and is usually done automatically within "EV::loop".
201
202 This function is rarely useful, but when some event callback runs
203 for a very long time without entering the event loop, updating
204 libev's idea of the current time is a good idea.
205
206 EV::suspend
207 $loop->suspend
208 EV::resume
209 $loop->resume
210 These two functions suspend and resume a loop, for use when the loop
211 is not used for a while and timeouts should not be processed.
212
213 A typical use case would be an interactive program such as a game:
214 When the user presses "^Z" to suspend the game and resumes it an
215 hour later it would be best to handle timeouts as if no time had
216 actually passed while the program was suspended. This can be
217 achieved by calling "suspend" in your "SIGTSTP" handler, sending
218 yourself a "SIGSTOP" and calling "resume" directly afterwards to
219 resume timer processing.
220
221 Effectively, all "timer" watchers will be delayed by the time spend
222 between "suspend" and "resume", and all "periodic" watchers will be
223 rescheduled (that is, they will lose any events that would have
224 occured while suspended).
225
226 After calling "suspend" you must not call *any* function on the
227 given loop other than "resume", and you must not call "resume"
228 without a previous call to "suspend".
229
230 Calling "suspend"/"resume" has the side effect of updating the event
231 loop time (see "now_update").
127 232
128 $backend = EV::backend 233 $backend = EV::backend
129 $backend = $loop->backend 234 $backend = $loop->backend
130 Returns an integer describing the backend used by libev 235 Returns an integer describing the backend used by libev
131 (EV::METHOD_SELECT or EV::METHOD_EPOLL). 236 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL).
132 237
133 EV::loop [$flags] 238 $active = EV::run [$flags]
134 $loop->loop ([$flags]) 239 $active = $loop->run ([$flags])
135 Begin checking for events and calling callbacks. It returns when a 240 Begin checking for events and calling callbacks. It returns when a
136 callback calls EV::unloop. 241 callback calls EV::break or the flasg are nonzero (in which case the
242 return value is true) or when there are no active watchers which
243 reference the loop (keepalive is true), in which case the return
244 value will be false. The returnv alue can generally be interpreted
245 as "if true, there is more work left to do".
137 246
138 The $flags argument can be one of the following: 247 The $flags argument can be one of the following:
139 248
140 0 as above 249 0 as above
141 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 250 EV::RUN_ONCE block at most once (wait, but do not loop)
142 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 251 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
143 252
144 EV::unloop [$how] 253 EV::break [$how]
145 $loop->unloop ([$how]) 254 $loop->break ([$how])
146 When called with no arguments or an argument of EV::UNLOOP_ONE, 255 When called with no arguments or an argument of EV::BREAK_ONE, makes
147 makes the innermost call to EV::loop return. 256 the innermost call to EV::loop return.
148 257
149 When called with an argument of EV::UNLOOP_ALL, all calls to 258 When called with an argument of EV::BREAK_ALL, all calls to EV::loop
150 EV::loop will return as fast as possible. 259 will return as fast as possible.
151 260
152 $count = EV::loop_count 261 When called with an argument of EV::BREAK_CANCEL, any pending break
153 $count = $loop->loop_count 262 will be cancelled.
263
264 $count = EV::iteration
265 $count = $loop->iteration
154 Return the number of times the event loop has polled for new events. 266 Return the number of times the event loop has polled for new events.
155 Sometiems useful as a generation counter. 267 Sometimes useful as a generation counter.
156 268
157 EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 269 EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
158 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 270 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
159 This function rolls together an I/O and a timer watcher for a single 271 This function rolls together an I/O and a timer watcher for a single
160 one-shot event without the need for managing a watcher object. 272 one-shot event without the need for managing a watcher object.
… …
169 Otherwise a EV::timer with this value will be started. 281 Otherwise a EV::timer with this value will be started.
170 282
171 When an error occurs or either the timeout or I/O watcher triggers, 283 When an error occurs or either the timeout or I/O watcher triggers,
172 then the callback will be called with the received event set (in 284 then the callback will be called with the received event set (in
173 general you can expect it to be a combination of "EV::ERROR", 285 general you can expect it to be a combination of "EV::ERROR",
174 "EV::READ", "EV::WRITE" and "EV::TIMEOUT"). 286 "EV::READ", "EV::WRITE" and "EV::TIMER").
175 287
176 EV::once doesn't return anything: the watchers stay active till 288 EV::once doesn't return anything: the watchers stay active till
177 either of them triggers, then they will be stopped and freed, and 289 either of them triggers, then they will be stopped and freed, and
178 the callback invoked. 290 the callback invoked.
179 291
180 EV::feed_fd_event ($fd, $revents) 292 EV::feed_fd_event $fd, $revents
181 $loop->feed_fd_event ($fd, $revents) 293 $loop->feed_fd_event ($fd, $revents)
182 Feed an event on a file descriptor into EV. EV will react to this 294 Feed an event on a file descriptor into EV. EV will react to this
183 call as if the readyness notifications specified by $revents (a 295 call as if the readyness notifications specified by $revents (a
184 combination of "EV::READ" and "EV::WRITE") happened on the file 296 combination of "EV::READ" and "EV::WRITE") happened on the file
185 descriptor $fd. 297 descriptor $fd.
186 298
187 EV::feed_signal_event ($signal) 299 EV::feed_signal_event $signal
188 Feed a signal event into EV. EV will react to this call as if the 300 Feed a signal event into the default loop. EV will react to this
189 signal specified by $signal had occured. 301 call as if the signal specified by $signal had occured.
302
303 EV::feed_signal $signal
304 Feed a signal event into EV - unlike "EV::feed_signal_event", this
305 works regardless of which loop has registered the signal, and is
306 mainly useful fro custom signal implementations.
190 307
191 EV::set_io_collect_interval $time 308 EV::set_io_collect_interval $time
192 $loop->set_io_collect_interval ($time) 309 $loop->set_io_collect_interval ($time)
193 EV::set_timeout_collect_interval $time 310 EV::set_timeout_collect_interval $time
194 $loop->set_timeout_collect_interval ($time) 311 $loop->set_timeout_collect_interval ($time)
195 These advanced functions set the minimum block interval when polling 312 These advanced functions set the minimum block interval when polling
196 for I/O events and the minimum wait interval for timer events. See 313 for I/O events and the minimum wait interval for timer events. See
197 the libev documentation at 314 the libev documentation at
198 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT 315 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT
199 ROLLING_THE_EVENT_LOOP> for a more detailed discussion. 316 ROLLING_THE_EVENT_LOOP> (locally installed as EV::libev) for a more
317 detailed discussion.
318
319 $count = EV::pending_count
320 $count = $loop->pending_count
321 Returns the number of currently pending watchers.
322
323 EV::invoke_pending
324 $loop->invoke_pending
325 Invoke all currently pending watchers.
200 326
201WATCHER OBJECTS 327WATCHER OBJECTS
202 A watcher is an object that gets created to record your interest in some 328 A watcher is an object that gets created to record your interest in some
203 event. For instance, if you want to wait for STDIN to become readable, 329 event. For instance, if you want to wait for STDIN to become readable,
204 you would create an EV::io watcher for that: 330 you would create an EV::io watcher for that:
205 331
206 my $watcher = EV::io *STDIN, EV::READ, sub { 332 my $watcher = EV::io *STDIN, EV::READ, sub {
207 my ($watcher, $revents) = @_; 333 my ($watcher, $revents) = @_;
208 warn "yeah, STDIN should now be readable without blocking!\n" 334 warn "yeah, STDIN should now be readable without blocking!\n"
209 }; 335 };
210 336
211 All watchers can be active (waiting for events) or inactive (paused). 337 All watchers can be active (waiting for events) or inactive (paused).
212 Only active watchers will have their callbacks invoked. All callbacks 338 Only active watchers will have their callbacks invoked. All callbacks
213 will be called with at least two arguments: the watcher and a bitmask of 339 will be called with at least two arguments: the watcher and a bitmask of
214 received events. 340 received events.
215 341
216 Each watcher type has its associated bit in revents, so you can use the 342 Each watcher type has its associated bit in revents, so you can use the
217 same callback for multiple watchers. The event mask is named after the 343 same callback for multiple watchers. The event mask is named after the
218 type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 344 type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
219 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O 345 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O
220 events (which can set both EV::READ and EV::WRITE bits), and EV::timer 346 events (which can set both EV::READ and EV::WRITE bits).
221 (which uses EV::TIMEOUT).
222 347
223 In the rare case where one wants to create a watcher but not start it at 348 In the rare case where one wants to create a watcher but not start it at
224 the same time, each constructor has a variant with a trailing "_ns" in 349 the same time, each constructor has a variant with a trailing "_ns" in
225 its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. 350 its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
226 351
… …
291 the watcher isn't pending it does nothing and returns 0. 416 the watcher isn't pending it does nothing and returns 0.
292 417
293 $previous_state = $w->keepalive ($bool) 418 $previous_state = $w->keepalive ($bool)
294 Normally, "EV::loop" will return when there are no active watchers 419 Normally, "EV::loop" will return when there are no active watchers
295 (which is a "deadlock" because no progress can be made anymore). 420 (which is a "deadlock" because no progress can be made anymore).
296 This is convinient because it allows you to start your watchers (and 421 This is convenient because it allows you to start your watchers (and
297 your jobs), call "EV::loop" once and when it returns you know that 422 your jobs), call "EV::loop" once and when it returns you know that
298 all your jobs are finished (or they forgot to register some watchers 423 all your jobs are finished (or they forgot to register some watchers
299 for their task :). 424 for their task :).
300 425
301 Sometimes, however, this gets in your way, for example when the 426 Sometimes, however, this gets in your way, for example when the
… …
308 433
309 In this case you can clear the keepalive status, which means that 434 In this case you can clear the keepalive status, which means that
310 even though your watcher is active, it won't keep "EV::loop" from 435 even though your watcher is active, it won't keep "EV::loop" from
311 returning. 436 returning.
312 437
313 The initial value for keepalive is true (enabled), and you cna 438 The initial value for keepalive is true (enabled), and you can
314 change it any time. 439 change it any time.
315 440
316 Example: Register an I/O watcher for some UDP socket but do not keep 441 Example: Register an I/O watcher for some UDP socket but do not keep
317 the event loop from running just because of that watcher. 442 the event loop from running just because of that watcher.
318 443
319 my $udp_socket = ... 444 my $udp_socket = ...
320 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 445 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
321 $1000udp_watcher->keepalive (0); 446 $udp_watcher->keepalive (0);
322 447
323 $loop = $w->loop 448 $loop = $w->loop
324 Return the loop that this watcher is attached to. 449 Return the loop that this watcher is attached to.
325 450
326WATCHER TYPES 451WATCHER TYPES
… …
376 the same time. 501 the same time.
377 502
378 The "timer_ns" variant doesn't start (activate) the newly created 503 The "timer_ns" variant doesn't start (activate) the newly created
379 watcher. 504 watcher.
380 505
381 $w->set ($after, $repeat) 506 $w->set ($after, $repeat = 0)
382 Reconfigures the watcher, see the constructor above for details. Can 507 Reconfigures the watcher, see the constructor above for details. Can
383 be called at any time. 508 be called at any time.
384 509
385 $w->again 510 $w->again
511 $w->again ($repeat)
386 Similar to the "start" method, but has special semantics for 512 Similar to the "start" method, but has special semantics for
387 repeating timers: 513 repeating timers:
388 514
389 If the timer is active and non-repeating, it will be stopped. 515 If the timer is active and non-repeating, it will be stopped.
390 516
… …
398 524
399 This behaviour is useful when you have a timeout for some IO 525 This behaviour is useful when you have a timeout for some IO
400 operation. You create a timer object with the same value for $after 526 operation. You create a timer object with the same value for $after
401 and $repeat, and then, in the read/write watcher, run the "again" 527 and $repeat, and then, in the read/write watcher, run the "again"
402 method on the timeout. 528 method on the timeout.
529
530 If called with a $repeat argument, then it uses this a timer repeat
531 value.
532
533 $after = $w->remaining
534 Calculates and returns the remaining time till the timer will fire.
403 535
404 PERIODIC WATCHERS - to cron or not to cron? 536 PERIODIC WATCHERS - to cron or not to cron?
405 $w = EV::periodic $at, $interval, $reschedule_cb, $callback 537 $w = EV::periodic $at, $interval, $reschedule_cb, $callback
406 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 538 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
407 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) 539 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
… …
421 This time simply fires at the wallclock time $at and doesn't 553 This time simply fires at the wallclock time $at and doesn't
422 repeat. It will not adjust when a time jump occurs, that is, if 554 repeat. It will not adjust when a time jump occurs, that is, if
423 it is to be run at January 1st 2011 then it will run when the 555 it is to be run at January 1st 2011 then it will run when the
424 system time reaches or surpasses this time. 556 system time reaches or surpasses this time.
425 557
426 * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 558 * repeating interval timer ($interval > 0, $reschedule_cb = 0)
427 559
428 In this mode the watcher will always be scheduled to time out at 560 In this mode the watcher will always be scheduled to time out at
429 the next "$at + N * $interval" time (for some integer N) and 561 the next "$at + N * $interval" time (for some integer N) and
430 then repeat, regardless of any time jumps. 562 then repeat, regardless of any time jumps.
431 563
… …
433 to system time: 565 to system time:
434 566
435 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 567 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
436 568
437 That doesn't mean there will always be 3600 seconds in between 569 That doesn't mean there will always be 3600 seconds in between
438 triggers, but only that the the clalback will be called when the 570 triggers, but only that the the callback will be called when the
439 system time shows a full hour (UTC). 571 system time shows a full hour (UTC).
440 572
441 Another way to think about it (for the mathematically inclined) 573 Another way to think about it (for the mathematically inclined)
442 is that EV::periodic will try to run the callback in this mode 574 is that EV::periodic will try to run the callback in this mode
443 at the next possible time where "$time = $at (mod $interval)", 575 at the next possible time where "$time = $at (mod $interval)",
… …
449 each time the periodic watcher gets scheduled, the reschedule 581 each time the periodic watcher gets scheduled, the reschedule
450 callback ($reschedule_cb) will be called with the watcher as 582 callback ($reschedule_cb) will be called with the watcher as
451 first, and the current time as second argument. 583 first, and the current time as second argument.
452 584
453 *This callback MUST NOT stop or destroy this or any other 585 *This callback MUST NOT stop or destroy this or any other
586 periodic watcher, ever, and MUST NOT call any event loop
454 periodic watcher, ever*. If you need to stop it, return 1e30 and 587 functions or methods*. If you need to stop it, return 1e30 and
455 stop it afterwards. 588 stop it afterwards. You may create and start a "EV::prepare"
589 watcher for this task.
456 590
457 It must return the next time to trigger, based on the passed 591 It must return the next time to trigger, based on the passed
458 time value (that is, the lowest time value larger than to the 592 time value (that is, the lowest time value larger than or equal
459 second argument). It will usually be called just before the 593 to to the second argument). It will usually be called just
460 callback will be triggered, but might be called at other times, 594 before the callback will be triggered, but might be called at
461 too. 595 other times, too.
462 596
463 This can be used to create very complex timers, such as a timer 597 This can be used to create very complex timers, such as a timer
464 that triggers on each midnight, local time (actually 24 hours 598 that triggers on each midnight, local time (actually 24 hours
465 after the last midnight, to keep the example simple. If you know 599 after the last midnight, to keep the example simple. If you know
466 a way to do it correctly in about the same space (without 600 a way to do it correctly in about the same space (without
… …
490 Return the time that the watcher is expected to trigger next. 624 Return the time that the watcher is expected to trigger next.
491 625
492 SIGNAL WATCHERS - signal me when a signal gets signalled! 626 SIGNAL WATCHERS - signal me when a signal gets signalled!
493 $w = EV::signal $signal, $callback 627 $w = EV::signal $signal, $callback
494 $w = EV::signal_ns $signal, $callback 628 $w = EV::signal_ns $signal, $callback
629 $w = $loop->signal ($signal, $callback)
630 $w = $loop->signal_ns ($signal, $callback)
495 Call the callback when $signal is received (the signal can be 631 Call the callback when $signal is received (the signal can be
496 specified by number or by name, just as with "kill" or %SIG). 632 specified by number or by name, just as with "kill" or %SIG).
633
634 Only one event loop can grab a given signal - attempting to grab the
635 same signal from two EV loops will crash the program immediately or
636 cause data corruption.
497 637
498 EV will grab the signal for the process (the kernel only allows one 638 EV will grab the signal for the process (the kernel only allows one
499 component to receive a signal at a time) when you start a signal 639 component to receive a signal at a time) when you start a signal
500 watcher, and removes it again when you stop it. Perl does the same 640 watcher, and removes it again when you stop it. Perl does the same
501 when you add/remove callbacks to %SIG, so watch out. 641 when you add/remove callbacks to %SIG, so watch out.
… …
675 $w = $loop->check_ns ($callback) 815 $w = $loop->check_ns ($callback)
676 Call the callback just after the process wakes up again (after it 816 Call the callback just after the process wakes up again (after it
677 has gathered events), but before any other callbacks have been 817 has gathered events), but before any other callbacks have been
678 invoked. 818 invoked.
679 819
680 This is used to integrate other event-based software into the EV 820 This can be used to integrate other event-based software into the EV
681 mainloop: You register a prepare callback and in there, you create 821 mainloop: You register a prepare callback and in there, you create
682 io and timer watchers as required by the other software. Here is a 822 io and timer watchers as required by the other software. Here is a
683 real-world example of integrating Net::SNMP (with some details left 823 real-world example of integrating Net::SNMP (with some details left
684 out): 824 out):
685 825
… …
716 # make the dispatcher handle any new stuff 856 # make the dispatcher handle any new stuff
717 ... not shown 857 ... not shown
718 }; 858 };
719 859
720 The callbacks of the created watchers will not be called as the 860 The callbacks of the created watchers will not be called as the
721 watchers are destroyed before this cna happen (remember EV::check 861 watchers are destroyed before this can happen (remember EV::check
722 gets called first). 862 gets called first).
723 863
724 The "check_ns" variant doesn't start (activate) the newly created 864 The "check_ns" variant doesn't start (activate) the newly created
725 watcher. 865 watcher.
866
867 EV::CHECK constant issues
868 Like all other watcher types, there is a bitmask constant for use in
869 $revents and other places. The "EV::CHECK" is special as it has the
870 same name as the "CHECK" sub called by Perl. This doesn't cause big
871 issues on newer perls (beginning with 5.8.9), but it means thatthe
872 constant must be *inlined*, i.e. runtime calls will not work. That
873 means that as long as you always "use EV" and then "EV::CHECK" you
874 are on the safe side.
726 875
727 FORK WATCHERS - the audacity to resume the event loop after a fork 876 FORK WATCHERS - the audacity to resume the event loop after a fork
728 Fork watchers are called when a "fork ()" was detected. The invocation 877 Fork watchers are called when a "fork ()" was detected. The invocation
729 is done before the event loop blocks next and before "check" watchers 878 is done before the event loop blocks next and before "check" watchers
730 are being called, and only in the child after the fork. 879 are being called, and only in the child after the fork.
… …
745 embedded loop, other types of watchers might be handled in a delayed or 894 embedded loop, other types of watchers might be handled in a delayed or
746 incorrect fashion and must not be used). 895 incorrect fashion and must not be used).
747 896
748 See the libev documentation at 897 See the libev documentation at
749 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code 898 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code
750 _when_one_backend_> for more details. 899 _when_one_backend_> (locally installed as EV::libev) for more details.
751 900
752 In short, this watcher is most useful on BSD systems without working 901 In short, this watcher is most useful on BSD systems without working
753 kqueue to still be able to handle a large number of sockets: 902 kqueue to still be able to handle a large number of sockets:
754 903
755 my $socket_loop; 904 my $socket_loop;
756 905
757 # check wether we use SELECT or POLL _and_ KQUEUE is supported 906 # check wether we use SELECT or POLL _and_ KQUEUE is supported
758 if ( 907 if (
759 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 908 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
760 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 909 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
761 ) { 910 ) {
762 # use kqueue for sockets 911 # use kqueue for sockets
763 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 912 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
764 } 913 }
765 914
766 # use the default loop otherwise 915 # use the default loop otherwise
767 $socket_loop ||= EV::default_loop; 916 $socket_loop ||= EV::default_loop;
768 917
769 $w = EV::embed $otherloop, $callback 918 $w = EV::embed $otherloop[, $callback]
770 $w = EV::embed_ns $otherloop, $callback 919 $w = EV::embed_ns $otherloop[, $callback]
771 $w = $loop->embed ($otherloop, $callback) 920 $w = $loop->embed ($otherloop[, $callback])
772 $w = $loop->embed_ns ($otherloop, $callback) 921 $w = $loop->embed_ns ($otherloop[, $callback])
773 Call the callback when the embedded event loop ($otherloop) has any 922 Call the callback when the embedded event loop ($otherloop) has any
774 I/O activity. The $callback should alwas be specified as "undef" in 923 I/O activity. The $callback is optional: if it is missing, then the
775 this version of EV, which means the embedded event loop will be 924 embedded event loop will be managed automatically (which is
776 managed automatically. 925 recommended), otherwise you have to invoke "sweep" yourself.
777 926
778 The "embed_ns" variant doesn't start (activate) the newly created 927 The "embed_ns" variant doesn't start (activate) the newly created
779 watcher. 928 watcher.
929
930 ASYNC WATCHERS - how to wake up another event loop
931 Async watchers are provided by EV, but have little use in perl directly,
932 as perl neither supports threads running in parallel nor direct access
933 to signal handlers or other contexts where they could be of value.
934
935 It is, however, possible to use them from the XS level.
936
937 Please see the libev documentation for further details.
938
939 $w = EV::async $callback
940 $w = EV::async_ns $callback
941 $w = $loop->async ($callback)
942 $w = $loop->async_ns ($callback)
943 $w->send
944 $bool = $w->async_pending
945
946 CLEANUP WATCHERS - how to clean up when the event loop goes away
947 Cleanup watchers are not supported on the Perl level, they can only be
948 used via XS currently.
780 949
781PERL SIGNALS 950PERL SIGNALS
782 While Perl signal handling (%SIG) is not affected by EV, the behaviour 951 While Perl signal handling (%SIG) is not affected by EV, the behaviour
783 with EV is as the same as any other C library: Perl-signals will only be 952 with EV is as the same as any other C library: Perl-signals will only be
784 handled when Perl runs, which means your signal handler might be invoked 953 handled when Perl runs, which means your signal handler might be invoked
… …
794 my $async_check = EV::check sub { }; 963 my $async_check = EV::check sub { };
795 964
796 This ensures that perl gets into control for a short time to handle any 965 This ensures that perl gets into control for a short time to handle any
797 pending signals, and also ensures (slightly) slower overall operation. 966 pending signals, and also ensures (slightly) slower overall operation.
798 967
799THREADS 968ITHREADS
800 Threads are not supported by this module in any way. Perl pseudo-threads 969 Ithreads are not supported by this module in any way. Perl
801 is evil stuff and must die. As soon as Perl gains real threads I will 970 pseudo-threads is evil stuff and must die. Real threads as provided by
802 work on thread support for it. 971 Coro are fully supported (and enhanced support is available via
972 Coro::EV).
803 973
804FORK 974FORK
805 Most of the "improved" event delivering mechanisms of modern operating 975 Most of the "improved" event delivering mechanisms of modern operating
806 systems have quite a few problems with fork(2) (to put it bluntly: it is 976 systems have quite a few problems with fork(2) (to put it bluntly: it is
807 not supported and usually destructive). Libev makes it possible to work 977 not supported and usually destructive). Libev makes it possible to work
… …
817 987
818 On win32, there is no notion of fork so all this doesn't apply, of 988 On win32, there is no notion of fork so all this doesn't apply, of
819 course. 989 course.
820 990
821SEE ALSO 991SEE ALSO
822 EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event 992 EV::MakeMaker - MakeMaker interface to XS API, EV::ADNS (asynchronous
823 loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines 993 DNS), Glib::EV (makes Glib/Gtk2 use EV as event loop), EV::Glib (embed
824 with EV), Net::SNMP::EV (asynchronous SNMP). 994 Glib into EV), Coro::EV (efficient thread integration), Net::SNMP::EV
995 (asynchronous SNMP), AnyEvent for event-loop agnostic and portable event
996 driven programming.
825 997
826AUTHOR 998AUTHOR
827 Marc Lehmann <schmorp@schmorp.de> 999 Marc Lehmann <schmorp@schmorp.de>
828 http://home.schmorp.de/ 1000 http://home.schmorp.de/
829 1001

Diff Legend

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