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

Comparing EV/EV.pm (file contents):
Revision 1.51 by root, Sat Nov 24 16:12:37 2007 UTC vs.
Revision 1.126 by root, Tue Mar 16 17:11:48 2010 UTC

2 2
3EV - perl interface to libev, a high performance full-featured event loop 3EV - perl interface to libev, a high performance full-featured event loop
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use EV; 7 use EV;
8
9 # TIMERS
10
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
8 39
9 # TIMERS 40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
10 44
11 my $w = EV::timer 2, 0, sub { 45 # STAT CHANGES
12 warn "is called after 2s"; 46 my $w = EV::stat "/etc/passwd", 10, sub {
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
39
40 my $w = EV::child 666, sub {
41 my ($w, $revents) = @_; 47 my ($w, $revents) = @_;
42 my $status = $w->rstatus; 48 warn $w->path, " has changed somehow.\n";
43 }; 49 };
44 50
45 # MAINLOOP 51 # MAINLOOP
46 EV::loop; # loop until EV::unloop is called or all watchers stop 52 EV::loop; # loop until EV::unloop is called or all watchers stop
47 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 53 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
48 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 54 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
49 55
50=head1 DESCRIPTION 56=head1 DESCRIPTION
51 57
52This module provides an interface to libev 58This module provides an interface to libev
53(L<http://software.schmorp.de/pkg/libev.html>). 59(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
60below is comprehensive, one might also consult the documentation of
61libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
62F<perldoc EV::libev>) for more subtle details on watcher semantics or some
63discussion on the available backends, or how to force a specific backend
64with C<LIBEV_FLAGS>, or just about in any case because it has much more
65detailed information.
66
67This module is very fast and scalable. It is actually so fast that you
68can use it through the L<AnyEvent> module, stay portable to other event
69loops (if you don't rely on any watcher types not available through it)
70and still be faster than with any other event loop currently supported in
71Perl.
72
73=head2 MODULE EXPORTS
74
75This module does not export any symbols.
54 76
55=cut 77=cut
56 78
57package EV; 79package EV;
58 80
59use strict; 81use common::sense;
60 82
61BEGIN { 83BEGIN {
62 our $VERSION = '1.3'; 84 our $VERSION = '4.00';
63 use XSLoader; 85 use XSLoader;
64 XSLoader::load "EV", $VERSION; 86 XSLoader::load "EV", $VERSION;
65} 87}
66 88
67@EV::IO::ISA = 89@EV::IO::ISA =
68@EV::Timer::ISA = 90@EV::Timer::ISA =
69@EV::Periodic::ISA = 91@EV::Periodic::ISA =
70@EV::Signal::ISA = 92@EV::Signal::ISA =
93@EV::Child::ISA =
94@EV::Stat::ISA =
71@EV::Idle::ISA = 95@EV::Idle::ISA =
72@EV::Prepare::ISA = 96@EV::Prepare::ISA =
73@EV::Check::ISA = 97@EV::Check::ISA =
74@EV::Child::ISA = "EV::Watcher"; 98@EV::Embed::ISA =
99@EV::Fork::ISA =
100@EV::Async::ISA =
101 "EV::Watcher";
102
103@EV::Loop::Default::ISA = "EV::Loop";
104
105=head1 EVENT LOOPS
106
107EV supports multiple event loops: There is a single "default event loop"
108that can handle everything including signals and child watchers, and any
109number of "dynamic event loops" that can use different backends (with
110various limitations), but no child and signal watchers.
111
112You do not have to do anything to create the default event loop: When
113the module is loaded a suitable backend is selected on the premise of
114selecting a working backend (which for example rules out kqueue on most
115BSDs). Modules should, unless they have "special needs" always use the
116default loop as this is fastest (perl-wise), best supported by other
117modules (e.g. AnyEvent or Coro) and most portable event loop.
118
119For specific programs you can create additional event loops dynamically.
120
121If you want to take advantage of kqueue (which often works properly for
122sockets only) even though the default loop doesn't enable it, you can
123I<embed> a kqueue loop into the default loop: running the default loop
124will then also service the kqueue loop to some extent. See the example in
125the section about embed watchers for an example on how to achieve that.
126
127=over 4
128
129=item $loop = new EV::Loop [$flags]
130
131Create a new event loop as per the specified flags. Please refer to
132the C<ev_loop_new ()> function description in the libev documentation
133(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
134or locally-installed as F<EV::libev> manpage) for more info.
135
136The loop will automatically be destroyed when it is no longer referenced
137by any watcher and the loop object goes out of scope.
138
139If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
140is recommended, as only the default event loop is protected by this
141module. If you I<are> embedding this loop in the default loop, this is not
142necessary, as C<EV::embed> automatically does the right thing on fork.
143
144=item $loop->loop_fork
145
146Must be called after a fork in the child, before entering or continuing
147the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
148this function automatically, at some performance loss (refer to the libev
149documentation).
150
151=item $loop->loop_verify
152
153Calls C<ev_verify> to make internal consistency checks (for debugging
154libev) and abort the program if any data structures were found to be
155corrupted.
156
157=item $loop = EV::default_loop [$flags]
158
159Return the default loop (which is a singleton object). Since this module
160already creates the default loop with default flags, specifying flags here
161will not have any effect unless you destroy the default loop first, which
162isn't supported. So in short: don't do it, and if you break it, you get to
163keep the pieces.
164
165=back
166
75 167
76=head1 BASIC INTERFACE 168=head1 BASIC INTERFACE
77 169
78=over 4 170=over 4
79 171
80=item $EV::DIED 172=item $EV::DIED
81 173
82Must contain a reference to a function that is called when a callback 174Must contain a reference to a function that is called when a callback
83throws an exception (with $@ containing thr error). The default prints an 175throws an exception (with $@ containing the error). The default prints an
84informative message and continues. 176informative message and continues.
85 177
86If this callback throws an exception it will be silently ignored. 178If this callback throws an exception it will be silently ignored.
87 179
180=item $flags = EV::supported_backends
181
182=item $flags = EV::recommended_backends
183
184=item $flags = EV::embeddable_backends
185
186Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
187instance of EV, the set of recommended backends (supposed to be good) for
188this platform and the set of embeddable backends (see EMBED WATCHERS).
189
190=item EV::sleep $seconds
191
192Block the process for the given number of (fractional) seconds.
193
88=item $time = EV::time 194=item $time = EV::time
89 195
90Returns the current time in (fractional) seconds since the epoch. 196Returns the current time in (fractional) seconds since the epoch.
91 197
92=item $time = EV::now 198=item $time = EV::now
93 199
200=item $time = $loop->now
201
94Returns the time the last event loop iteration has been started. This 202Returns the time the last event loop iteration has been started. This
95is the time that (relative) timers are based on, and refering to it is 203is the time that (relative) timers are based on, and referring to it is
96usually faster then calling EV::time. 204usually faster then calling EV::time.
97 205
98=item $method = EV::method 206=item EV::now_update
99 207
208=item $loop->now_update
209
210Establishes the current time by querying the kernel, updating the time
211returned by C<EV::now> in the progress. This is a costly operation and
212is usually done automatically within C<EV::loop>.
213
214This function is rarely useful, but when some event callback runs for a
215very long time without entering the event loop, updating libev's idea of
216the current time is a good idea.
217
218=item EV::suspend
219
220=item $loop->suspend
221
222=item EV::resume
223
224=item $loop->resume
225
226These two functions suspend and resume a loop, for use when the loop is
227not used for a while and timeouts should not be processed.
228
229A typical use case would be an interactive program such as a game: When
230the user presses C<^Z> to suspend the game and resumes it an hour later it
231would be best to handle timeouts as if no time had actually passed while
232the program was suspended. This can be achieved by calling C<suspend>
233in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
234C<resume> directly afterwards to resume timer processing.
235
236Effectively, all C<timer> watchers will be delayed by the time spend
237between C<suspend> and C<resume>, and all C<periodic> watchers
238will be rescheduled (that is, they will lose any events that would have
239occured while suspended).
240
241After calling C<suspend> you B<must not> call I<any> function on the given
242loop other than C<resume>, and you B<must not> call C<resume>
243without a previous call to C<suspend>.
244
245Calling C<suspend>/C<resume> has the side effect of updating the event
246loop time (see C<now_update>).
247
248=item $backend = EV::backend
249
250=item $backend = $loop->backend
251
100Returns an integer describing the backend used by libev (EV::METHOD_SELECT 252Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
101or EV::METHOD_EPOLL). 253or EV::BACKEND_EPOLL).
102 254
103=item EV::loop [$flags] 255=item EV::loop [$flags]
256
257=item $loop->loop ([$flags])
104 258
105Begin checking for events and calling callbacks. It returns when a 259Begin checking for events and calling callbacks. It returns when a
106callback calls EV::unloop. 260callback calls EV::unloop.
107 261
108The $flags argument can be one of the following: 262The $flags argument can be one of the following:
111 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 265 EV::LOOP_ONESHOT block at most once (wait, but do not loop)
112 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 266 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
113 267
114=item EV::unloop [$how] 268=item EV::unloop [$how]
115 269
270=item $loop->unloop ([$how])
271
116When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 272When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
117innermost call to EV::loop return. 273innermost call to EV::loop return.
118 274
119When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 275When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
120fast as possible. 276fast as possible.
121 277
278=item $count = EV::loop_count
279
280=item $count = $loop->loop_count
281
282Return the number of times the event loop has polled for new
283events. Sometimes useful as a generation counter.
284
122=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 285=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
286
287=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
123 288
124This function rolls together an I/O and a timer watcher for a single 289This function rolls together an I/O and a timer watcher for a single
125one-shot event without the need for managing a watcher object. 290one-shot event without the need for managing a watcher object.
126 291
127If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> 292If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
133If timeout is C<undef> or negative, then there will be no 298If timeout is C<undef> or negative, then there will be no
134timeout. Otherwise a EV::timer with this value will be started. 299timeout. Otherwise a EV::timer with this value will be started.
135 300
136When an error occurs or either the timeout or I/O watcher triggers, then 301When an error occurs or either the timeout or I/O watcher triggers, then
137the callback will be called with the received event set (in general 302the callback will be called with the received event set (in general
138you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, 303you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
139C<EV::WRITE> and C<EV::TIMEOUT>). 304C<EV::WRITE> and C<EV::TIMER>).
140 305
141EV::once doesn't return anything: the watchers stay active till either 306EV::once doesn't return anything: the watchers stay active till either
142of them triggers, then they will be stopped and freed, and the callback 307of them triggers, then they will be stopped and freed, and the callback
143invoked. 308invoked.
144 309
145=back 310=item EV::feed_fd_event ($fd, $revents)
146 311
147=head2 WATCHER 312=item $loop->feed_fd_event ($fd, $revents)
313
314Feed an event on a file descriptor into EV. EV will react to this call as
315if the readyness notifications specified by C<$revents> (a combination of
316C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
317
318=item EV::feed_signal_event ($signal)
319
320Feed a signal event into EV. EV will react to this call as if the signal
321specified by C<$signal> had occured.
322
323=item EV::set_io_collect_interval $time
324
325=item $loop->set_io_collect_interval ($time)
326
327=item EV::set_timeout_collect_interval $time
328
329=item $loop->set_timeout_collect_interval ($time)
330
331These advanced functions set the minimum block interval when polling for I/O events and the minimum
332wait interval for timer events. See the libev documentation at
333L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
334(locally installed as F<EV::libev>) for a more detailed discussion.
335
336=item $count = EV::pending_count
337
338=item $count = $loop->pending_count
339
340Returns the number of currently pending watchers.
341
342=item EV::invoke_pending
343
344=item $loop->invoke_pending
345
346Invoke all currently pending watchers.
347
348=back
349
350
351=head1 WATCHER OBJECTS
148 352
149A watcher is an object that gets created to record your interest in some 353A watcher is an object that gets created to record your interest in some
150event. For instance, if you want to wait for STDIN to become readable, you 354event. For instance, if you want to wait for STDIN to become readable, you
151would create an EV::io watcher for that: 355would create an EV::io watcher for that:
152 356
153 my $watcher = EV::io *STDIN, EV::READ, sub { 357 my $watcher = EV::io *STDIN, EV::READ, sub {
154 my ($watcher, $revents) = @_; 358 my ($watcher, $revents) = @_;
155 warn "yeah, STDIN should not be readable without blocking!\n" 359 warn "yeah, STDIN should now be readable without blocking!\n"
156 }; 360 };
157 361
158All watchers can be active (waiting for events) or inactive (paused). Only 362All watchers can be active (waiting for events) or inactive (paused). Only
159active watchers will have their callbacks invoked. All callbacks will be 363active watchers will have their callbacks invoked. All callbacks will be
160called with at least two arguments: the watcher and a bitmask of received 364called with at least two arguments: the watcher and a bitmask of received
161events. 365events.
162 366
163Each watcher type has its associated bit in revents, so you can use the 367Each watcher type has its associated bit in revents, so you can use the
164same callback for multiple watchers. The event mask is named after the 368same callback for multiple watchers. The event mask is named after the
165type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 369type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
166EV::periodic sets EV::PERIODIC and so on, with the exception of IO events 370EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
167(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 371(which can set both EV::READ and EV::WRITE bits).
168uses EV::TIMEOUT).
169 372
170In the rare case where one wants to create a watcher but not start it at 373In the rare case where one wants to create a watcher but not start it at
171the same time, each constructor has a variant with a trailing C<_ns> in 374the same time, each constructor has a variant with a trailing C<_ns> in
172its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. 375its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
173 376
177 380
178Also, all methods changing some aspect of a watcher (->set, ->priority, 381Also, all methods changing some aspect of a watcher (->set, ->priority,
179->fh and so on) automatically stop and start it again if it is active, 382->fh and so on) automatically stop and start it again if it is active,
180which means pending events get lost. 383which means pending events get lost.
181 384
182=head2 WATCHER TYPES 385=head2 COMMON WATCHER METHODS
183 386
184Now lets move to the existing watcher types and asociated methods. 387This section lists methods common to all watchers.
185
186The following methods are available for all watchers. Then followes a
187description of each watcher constructor (EV::io, EV::timer, EV::periodic,
188EV::signal, EV::child, EV::idle, EV::prepare and EV::check), followed by
189any type-specific methods (if any).
190 388
191=over 4 389=over 4
192 390
193=item $w->start 391=item $w->start
194 392
198 396
199=item $w->stop 397=item $w->stop
200 398
201Stop a watcher if it is active. Also clear any pending events (events that 399Stop a watcher if it is active. Also clear any pending events (events that
202have been received but that didn't yet result in a callback invocation), 400have been received but that didn't yet result in a callback invocation),
203regardless of wether the watcher was active or not. 401regardless of whether the watcher was active or not.
204 402
205=item $bool = $w->is_active 403=item $bool = $w->is_active
206 404
207Returns true if the watcher is active, false otherwise. 405Returns true if the watcher is active, false otherwise.
208 406
238The default priority of any newly-created watcher is 0. 436The default priority of any newly-created watcher is 0.
239 437
240Note that the priority semantics have not yet been fleshed out and are 438Note that the priority semantics have not yet been fleshed out and are
241subject to almost certain change. 439subject to almost certain change.
242 440
243=item $w->trigger ($revents) 441=item $w->invoke ($revents)
244 442
245Call the callback *now* with the given event mask. 443Call the callback *now* with the given event mask.
444
445=item $w->feed_event ($revents)
446
447Feed some events on this watcher into EV. EV will react to this call as if
448the watcher had received the given C<$revents> mask.
449
450=item $revents = $w->clear_pending
451
452If the watcher is pending, this function clears its pending status and
453returns its C<$revents> bitset (as if its callback was invoked). If the
454watcher isn't pending it does nothing and returns C<0>.
246 455
247=item $previous_state = $w->keepalive ($bool) 456=item $previous_state = $w->keepalive ($bool)
248 457
249Normally, C<EV::loop> will return when there are no active watchers 458Normally, C<EV::loop> will return when there are no active watchers
250(which is a "deadlock" because no progress can be made anymore). This is 459(which is a "deadlock" because no progress can be made anymore). This is
251convinient because it allows you to start your watchers (and your jobs), 460convenient because it allows you to start your watchers (and your jobs),
252call C<EV::loop> once and when it returns you know that all your jobs are 461call C<EV::loop> once and when it returns you know that all your jobs are
253finished (or they forgot to register some watchers for their task :). 462finished (or they forgot to register some watchers for their task :).
254 463
255Sometimes, however, this gets in your way, for example when you the module 464Sometimes, however, this gets in your way, for example when the module
256that calls C<EV::loop> (usually the main program) is not the same module 465that calls C<EV::loop> (usually the main program) is not the same module
257as a long-living watcher (for example a DNS client module written by 466as a long-living watcher (for example a DNS client module written by
258somebody else even). Then you might want any outstanding requests to be 467somebody else even). Then you might want any outstanding requests to be
259handled, but you would not want to keep C<EV::loop> from returning just 468handled, but you would not want to keep C<EV::loop> from returning just
260because you happen to have this long-running UDP port watcher. 469because you happen to have this long-running UDP port watcher.
261 470
262In this case you can clear the keepalive status, which means that even 471In this case you can clear the keepalive status, which means that even
263though your watcher is active, it won't keep C<EV::loop> from returning. 472though your watcher is active, it won't keep C<EV::loop> from returning.
264 473
265The initial value for keepalive is true (enabled), and you cna change it 474The initial value for keepalive is true (enabled), and you can change it
266any time. 475any time.
267 476
268Example: Register an IO watcher for some UDP socket but do not keep the 477Example: Register an I/O watcher for some UDP socket but do not keep the
269event loop from running just because of that watcher. 478event loop from running just because of that watcher.
270 479
271 my $udp_socket = ... 480 my $udp_socket = ...
272 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 481 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
273 $udp_watcher->keepalive (0); 482 $udp_watcher->keepalive (0);
274 483
484=item $loop = $w->loop
485
486Return the loop that this watcher is attached to.
487
488=back
489
490
491=head1 WATCHER TYPES
492
493Each of the following subsections describes a single watcher type.
494
495=head3 I/O WATCHERS - is this file descriptor readable or writable?
496
497=over 4
498
275=item $w = EV::io $fileno_or_fh, $eventmask, $callback 499=item $w = EV::io $fileno_or_fh, $eventmask, $callback
276 500
277=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 501=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
278 502
503=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
504
505=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
506
279As long as the returned watcher object is alive, call the C<$callback> 507As long as the returned watcher object is alive, call the C<$callback>
280when the events specified in C<$eventmask>. 508when at least one of events specified in C<$eventmask> occurs.
281 509
282The $eventmask can be one or more of these constants ORed together: 510The $eventmask can be one or more of these constants ORed together:
283 511
284 EV::READ wait until read() wouldn't block anymore 512 EV::READ wait until read() wouldn't block anymore
285 EV::WRITE wait until write() wouldn't block anymore 513 EV::WRITE wait until write() wouldn't block anymore
301 529
302=item $old_eventmask = $w->events ($new_eventmask) 530=item $old_eventmask = $w->events ($new_eventmask)
303 531
304Returns the previously set event mask and optionally set a new one. 532Returns the previously set event mask and optionally set a new one.
305 533
534=back
535
536
537=head3 TIMER WATCHERS - relative and optionally repeating timeouts
538
539=over 4
306 540
307=item $w = EV::timer $after, $repeat, $callback 541=item $w = EV::timer $after, $repeat, $callback
308 542
309=item $w = EV::timer_ns $after, $repeat, $callback 543=item $w = EV::timer_ns $after, $repeat, $callback
310 544
311Calls the callback after C<$after> seconds. If C<$repeat> is non-zero, 545=item $w = $loop->timer ($after, $repeat, $callback)
312the timer will be restarted (with the $repeat value as $after) after the 546
313callback returns. 547=item $w = $loop->timer_ns ($after, $repeat, $callback)
548
549Calls the callback after C<$after> seconds (which may be fractional). If
550C<$repeat> is non-zero, the timer will be restarted (with the $repeat
551value as $after) after the callback returns.
314 552
315This means that the callback would be called roughly after C<$after> 553This means that the callback would be called roughly after C<$after>
316seconds, and then every C<$repeat> seconds. The timer does his best not 554seconds, and then every C<$repeat> seconds. The timer does his best not
317to drift, but it will not invoke the timer more often then once per event 555to drift, but it will not invoke the timer more often then once per event
318loop iteration, and might drift in other cases. If that isn't acceptable, 556loop iteration, and might drift in other cases. If that isn't acceptable,
324 562
325The C<timer_ns> variant doesn't start (activate) the newly created watcher. 563The C<timer_ns> variant doesn't start (activate) the newly created watcher.
326 564
327=item $w->set ($after, $repeat) 565=item $w->set ($after, $repeat)
328 566
329Reconfigures the watcher, see the constructor above for details. Can be at 567Reconfigures the watcher, see the constructor above for details. Can be called at
330any time. 568any time.
331 569
332=item $w->again 570=item $w->again
333 571
334Similar to the C<start> method, but has special semantics for repeating timers: 572Similar to the C<start> method, but has special semantics for repeating timers:
345This behaviour is useful when you have a timeout for some IO 583This behaviour is useful when you have a timeout for some IO
346operation. You create a timer object with the same value for C<$after> and 584operation. You create a timer object with the same value for C<$after> and
347C<$repeat>, and then, in the read/write watcher, run the C<again> method 585C<$repeat>, and then, in the read/write watcher, run the C<again> method
348on the timeout. 586on the timeout.
349 587
588=back
589
590
591=head3 PERIODIC WATCHERS - to cron or not to cron?
592
593=over 4
350 594
351=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback 595=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
352 596
353=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 597=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
598
599=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
600
601=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
354 602
355Similar to EV::timer, but is not based on relative timeouts but on 603Similar to EV::timer, but is not based on relative timeouts but on
356absolute times. Apart from creating "simple" timers that trigger "at" the 604absolute times. Apart from creating "simple" timers that trigger "at" the
357specified time, it can also be used for non-drifting absolute timers and 605specified time, it can also be used for non-drifting absolute timers and
358more complex, cron-like, setups that are not adversely affected by time 606more complex, cron-like, setups that are not adversely affected by time
368This time simply fires at the wallclock time C<$at> and doesn't repeat. It 616This time simply fires at the wallclock time C<$at> and doesn't repeat. It
369will not adjust when a time jump occurs, that is, if it is to be run 617will not adjust when a time jump occurs, that is, if it is to be run
370at January 1st 2011 then it will run when the system time reaches or 618at January 1st 2011 then it will run when the system time reaches or
371surpasses this time. 619surpasses this time.
372 620
373=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 621=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
374 622
375In this mode the watcher will always be scheduled to time out at the 623In this mode the watcher will always be scheduled to time out at the
376next C<$at + N * $interval> time (for some integer N) and then repeat, 624next C<$at + N * $interval> time (for some integer N) and then repeat,
377regardless of any time jumps. 625regardless of any time jumps.
378 626
396time the periodic watcher gets scheduled, the reschedule callback 644time the periodic watcher gets scheduled, the reschedule callback
397($reschedule_cb) will be called with the watcher as first, and the current 645($reschedule_cb) will be called with the watcher as first, and the current
398time as second argument. 646time as second argument.
399 647
400I<This callback MUST NOT stop or destroy this or any other periodic 648I<This callback MUST NOT stop or destroy this or any other periodic
401watcher, ever>. If you need to stop it, return 1e30 and stop it 649watcher, ever, and MUST NOT call any event loop functions or methods>. If
402afterwards. 650you need to stop it, return 1e30 and stop it afterwards. You may create
651and start a C<EV::prepare> watcher for this task.
403 652
404It must return the next time to trigger, based on the passed time value 653It must return the next time to trigger, based on the passed time value
405(that is, the lowest time value larger than to the second argument). It 654(that is, the lowest time value larger than or equal to to the second
406will usually be called just before the callback will be triggered, but 655argument). It will usually be called just before the callback will be
407might be called at other times, too. 656triggered, but might be called at other times, too.
408 657
409This can be used to create very complex timers, such as a timer that 658This can be used to create very complex timers, such as a timer that
410triggers on each midnight, local time (actually 24 hours after the last 659triggers on each midnight, local time (actually 24 hours after the last
411midnight, to keep the example simple. If you know a way to do it correctly 660midnight, to keep the example simple. If you know a way to do it correctly
412in about the same space (without requiring elaborate modules), drop me a 661in about the same space (without requiring elaborate modules), drop me a
426 675
427The C<periodic_ns> variant doesn't start (activate) the newly created watcher. 676The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
428 677
429=item $w->set ($at, $interval, $reschedule_cb) 678=item $w->set ($at, $interval, $reschedule_cb)
430 679
431Reconfigures the watcher, see the constructor above for details. Can be at 680Reconfigures the watcher, see the constructor above for details. Can be called at
432any time. 681any time.
433 682
434=item $w->again 683=item $w->again
435 684
436Simply stops and starts the watcher again. 685Simply stops and starts the watcher again.
437 686
687=item $time = $w->at
688
689Return the time that the watcher is expected to trigger next.
690
691=back
692
693
694=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
695
696=over 4
438 697
439=item $w = EV::signal $signal, $callback 698=item $w = EV::signal $signal, $callback
440 699
441=item $w = EV::signal_ns $signal, $callback 700=item $w = EV::signal_ns $signal, $callback
442 701
702=item $w = $loop->signal ($signal, $callback)
703
704=item $w = $loop->signal_ns ($signal, $callback)
705
443Call the callback when $signal is received (the signal can be specified 706Call the callback when $signal is received (the signal can be specified by
444by number or by name, just as with kill or %SIG). 707number or by name, just as with C<kill> or C<%SIG>).
708
709Only one event loop can grab a given signal - attempting to grab the same
710signal from two EV loops will crash the program immediately or cause data
711corruption.
445 712
446EV will grab the signal for the process (the kernel only allows one 713EV will grab the signal for the process (the kernel only allows one
447component to receive a signal at a time) when you start a signal watcher, 714component to receive a signal at a time) when you start a signal watcher,
448and removes it again when you stop it. Perl does the same when you 715and removes it again when you stop it. Perl does the same when you
449add/remove callbacks to %SIG, so watch out. 716add/remove callbacks to C<%SIG>, so watch out.
450 717
451You can have as many signal watchers per signal as you want. 718You can have as many signal watchers per signal as you want.
452 719
453The C<signal_ns> variant doesn't start (activate) the newly created watcher. 720The C<signal_ns> variant doesn't start (activate) the newly created watcher.
454 721
455=item $w->set ($signal) 722=item $w->set ($signal)
456 723
457Reconfigures the watcher, see the constructor above for details. Can be at 724Reconfigures the watcher, see the constructor above for details. Can be
458any time. 725called at any time.
459 726
460=item $current_signum = $w->signal 727=item $current_signum = $w->signal
461 728
462=item $old_signum = $w->signal ($new_signal) 729=item $old_signum = $w->signal ($new_signal)
463 730
464Returns the previously set signal (always as a number not name) and 731Returns the previously set signal (always as a number not name) and
465optionally set a new one. 732optionally set a new one.
466 733
734=back
467 735
736
737=head3 CHILD WATCHERS - watch out for process status changes
738
739=over 4
740
468=item $w = EV::child $pid, $callback 741=item $w = EV::child $pid, $trace, $callback
469 742
470=item $w = EV::child_ns $pid, $callback 743=item $w = EV::child_ns $pid, $trace, $callback
744
745=item $w = $loop->child ($pid, $trace, $callback)
746
747=item $w = $loop->child_ns ($pid, $trace, $callback)
471 748
472Call the callback when a status change for pid C<$pid> (or any pid 749Call the callback when a status change for pid C<$pid> (or any pid
473if C<$pid> is 0) has been received. More precisely: when the process 750if C<$pid> is 0) has been received (a status change happens when the
751process terminates or is killed, or, when trace is true, additionally when
752it is stopped or continued). More precisely: when the process receives
474receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all 753a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
475changed/zombie children and call the callback. 754changed/zombie children and call the callback.
476 755
477You can access both status and pid by using the C<rstatus> and C<rpid> 756It is valid (and fully supported) to install a child watcher after a child
478methods on the watcher object. 757has exited but before the event loop has started its next iteration (for
758example, first you C<fork>, then the new child process might exit, and
759only then do you install a child watcher in the parent for the new pid).
479 760
761You can access both exit (or tracing) status and pid by using the
762C<rstatus> and C<rpid> methods on the watcher object.
763
480You can have as many pid watchers per pid as you want. 764You can have as many pid watchers per pid as you want, they will all be
765called.
481 766
482The C<child_ns> variant doesn't start (activate) the newly created watcher. 767The C<child_ns> variant doesn't start (activate) the newly created watcher.
483 768
484=item $w->set ($pid) 769=item $w->set ($pid, $trace)
485 770
486Reconfigures the watcher, see the constructor above for details. Can be at 771Reconfigures the watcher, see the constructor above for details. Can be called at
487any time. 772any time.
488 773
489=item $current_pid = $w->pid 774=item $current_pid = $w->pid
490
491=item $old_pid = $w->pid ($new_pid)
492 775
493Returns the previously set process id and optionally set a new one. 776Returns the previously set process id and optionally set a new one.
494 777
495=item $exit_status = $w->rstatus 778=item $exit_status = $w->rstatus
496 779
500=item $pid = $w->rpid 783=item $pid = $w->rpid
501 784
502Return the pid of the awaited child (useful when you have installed a 785Return the pid of the awaited child (useful when you have installed a
503watcher for all pids). 786watcher for all pids).
504 787
788=back
789
790
791=head3 STAT WATCHERS - did the file attributes just change?
792
793=over 4
794
795=item $w = EV::stat $path, $interval, $callback
796
797=item $w = EV::stat_ns $path, $interval, $callback
798
799=item $w = $loop->stat ($path, $interval, $callback)
800
801=item $w = $loop->stat_ns ($path, $interval, $callback)
802
803Call the callback when a file status change has been detected on
804C<$path>. The C<$path> does not need to exist, changing from "path exists"
805to "path does not exist" is a status change like any other.
806
807The C<$interval> is a recommended polling interval for systems where
808OS-supported change notifications don't exist or are not supported. If
809you use C<0> then an unspecified default is used (which is highly
810recommended!), which is to be expected to be around five seconds usually.
811
812This watcher type is not meant for massive numbers of stat watchers,
813as even with OS-supported change notifications, this can be
814resource-intensive.
815
816The C<stat_ns> variant doesn't start (activate) the newly created watcher.
817
818=item ... = $w->stat
819
820This call is very similar to the perl C<stat> built-in: It stats (using
821C<lstat>) the path specified in the watcher and sets perls stat cache (as
822well as EV's idea of the current stat values) to the values found.
823
824In scalar context, a boolean is return indicating success or failure of
825the stat. In list context, the same 13-value list as with stat is returned
826(except that the blksize and blocks fields are not reliable).
827
828In the case of an error, errno is set to C<ENOENT> (regardless of the
829actual error value) and the C<nlink> value is forced to zero (if the stat
830was successful then nlink is guaranteed to be non-zero).
831
832See also the next two entries for more info.
833
834=item ... = $w->attr
835
836Just like C<< $w->stat >>, but without the initial stat'ing: this returns
837the values most recently detected by EV. See the next entry for more info.
838
839=item ... = $w->prev
840
841Just like C<< $w->stat >>, but without the initial stat'ing: this returns
842the previous set of values, before the change.
843
844That is, when the watcher callback is invoked, C<< $w->prev >> will be set
845to the values found I<before> a change was detected, while C<< $w->attr >>
846returns the values found leading to the change detection. The difference (if any)
847between C<prev> and C<attr> is what triggered the callback.
848
849If you did something to the filesystem object and do not want to trigger
850yet another change, you can call C<stat> to update EV's idea of what the
851current attributes are.
852
853=item $w->set ($path, $interval)
854
855Reconfigures the watcher, see the constructor above for details. Can be
856called at any time.
857
858=item $current_path = $w->path
859
860=item $old_path = $w->path ($new_path)
861
862Returns the previously set path and optionally set a new one.
863
864=item $current_interval = $w->interval
865
866=item $old_interval = $w->interval ($new_interval)
867
868Returns the previously set interval and optionally set a new one. Can be
869used to query the actual interval used.
870
871=back
872
873
874=head3 IDLE WATCHERS - when you've got nothing better to do...
875
876=over 4
505 877
506=item $w = EV::idle $callback 878=item $w = EV::idle $callback
507 879
508=item $w = EV::idle_ns $callback 880=item $w = EV::idle_ns $callback
509 881
510Call the callback when there are no pending io, timer/periodic, signal or 882=item $w = $loop->idle ($callback)
511child events, i.e. when the process is idle. 883
884=item $w = $loop->idle_ns ($callback)
885
886Call the callback when there are no other pending watchers of the same or
887higher priority (excluding check, prepare and other idle watchers of the
888same or lower priority, of course). They are called idle watchers because
889when the watcher is the highest priority pending event in the process, the
890process is considered to be idle at that priority.
891
892If you want a watcher that is only ever called when I<no> other events are
893outstanding you have to set the priority to C<EV::MINPRI>.
512 894
513The process will not block as long as any idle watchers are active, and 895The process will not block as long as any idle watchers are active, and
514they will be called repeatedly until stopped. 896they will be called repeatedly until stopped.
515 897
898For example, if you have idle watchers at priority C<0> and C<1>, and
899an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
900and the I/O watcher will always run when ready. Only when the idle watcher
901at priority C<1> is stopped and the I/O watcher at priority C<0> is not
902pending with the C<0>-priority idle watcher be invoked.
903
516The C<idle_ns> variant doesn't start (activate) the newly created watcher. 904The C<idle_ns> variant doesn't start (activate) the newly created watcher.
517 905
906=back
907
908
909=head3 PREPARE WATCHERS - customise your event loop!
910
911=over 4
518 912
519=item $w = EV::prepare $callback 913=item $w = EV::prepare $callback
520 914
521=item $w = EV::prepare_ns $callback 915=item $w = EV::prepare_ns $callback
916
917=item $w = $loop->prepare ($callback)
918
919=item $w = $loop->prepare_ns ($callback)
522 920
523Call the callback just before the process would block. You can still 921Call the callback just before the process would block. You can still
524create/modify any watchers at this point. 922create/modify any watchers at this point.
525 923
526See the EV::check watcher, below, for explanations and an example. 924See the EV::check watcher, below, for explanations and an example.
527 925
528The C<prepare_ns> variant doesn't start (activate) the newly created watcher. 926The C<prepare_ns> variant doesn't start (activate) the newly created watcher.
529 927
928=back
929
930
931=head3 CHECK WATCHERS - customise your event loop even more!
932
933=over 4
530 934
531=item $w = EV::check $callback 935=item $w = EV::check $callback
532 936
533=item $w = EV::check_ns $callback 937=item $w = EV::check_ns $callback
938
939=item $w = $loop->check ($callback)
940
941=item $w = $loop->check_ns ($callback)
534 942
535Call the callback just after the process wakes up again (after it has 943Call the callback just after the process wakes up again (after it has
536gathered events), but before any other callbacks have been invoked. 944gathered events), but before any other callbacks have been invoked.
537 945
538This is used to integrate other event-based software into the EV 946This is used to integrate other event-based software into the EV
548 or return; 956 or return;
549 957
550 # make the dispatcher handle any outstanding stuff 958 # make the dispatcher handle any outstanding stuff
551 ... not shown 959 ... not shown
552 960
553 # create an IO watcher for each and every socket 961 # create an I/O watcher for each and every socket
554 @snmp_watcher = ( 962 @snmp_watcher = (
555 (map { EV::io $_, EV::READ, sub { } } 963 (map { EV::io $_, EV::READ, sub { } }
556 keys %{ $dispatcher->{_descriptors} }), 964 keys %{ $dispatcher->{_descriptors} }),
557 965
558 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] 966 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
573 # make the dispatcher handle any new stuff 981 # make the dispatcher handle any new stuff
574 ... not shown 982 ... not shown
575 }; 983 };
576 984
577The callbacks of the created watchers will not be called as the watchers 985The callbacks of the created watchers will not be called as the watchers
578are destroyed before this cna happen (remember EV::check gets called 986are destroyed before this can happen (remember EV::check gets called
579first). 987first).
580 988
581The C<check_ns> variant doesn't start (activate) the newly created watcher. 989The C<check_ns> variant doesn't start (activate) the newly created watcher.
582 990
583=back 991=back
584 992
993
994=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
995
996Fork watchers are called when a C<fork ()> was detected. The invocation
997is done before the event loop blocks next and before C<check> watchers
998are being called, and only in the child after the fork.
999
1000=over 4
1001
1002=item $w = EV::fork $callback
1003
1004=item $w = EV::fork_ns $callback
1005
1006=item $w = $loop->fork ($callback)
1007
1008=item $w = $loop->fork_ns ($callback)
1009
1010Call the callback before the event loop is resumed in the child process
1011after a fork.
1012
1013The C<fork_ns> variant doesn't start (activate) the newly created watcher.
1014
1015=back
1016
1017
1018=head3 EMBED WATCHERS - when one backend isn't enough...
1019
1020This is a rather advanced watcher type that lets you embed one event loop
1021into another (currently only IO events are supported in the embedded
1022loop, other types of watchers might be handled in a delayed or incorrect
1023fashion and must not be used).
1024
1025See the libev documentation at
1026L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
1027(locally installed as F<EV::libev>) for more details.
1028
1029In short, this watcher is most useful on BSD systems without working
1030kqueue to still be able to handle a large number of sockets:
1031
1032 my $socket_loop;
1033
1034 # check wether we use SELECT or POLL _and_ KQUEUE is supported
1035 if (
1036 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
1037 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
1038 ) {
1039 # use kqueue for sockets
1040 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
1041 }
1042
1043 # use the default loop otherwise
1044 $socket_loop ||= EV::default_loop;
1045
1046=over 4
1047
1048=item $w = EV::embed $otherloop[, $callback]
1049
1050=item $w = EV::embed_ns $otherloop[, $callback]
1051
1052=item $w = $loop->embed ($otherloop[, $callback])
1053
1054=item $w = $loop->embed_ns ($otherloop[, $callback])
1055
1056Call the callback when the embedded event loop (C<$otherloop>) has any
1057I/O activity. The C<$callback> is optional: if it is missing, then the
1058embedded event loop will be managed automatically (which is recommended),
1059otherwise you have to invoke C<sweep> yourself.
1060
1061The C<embed_ns> variant doesn't start (activate) the newly created watcher.
1062
1063=back
1064
1065=head3 ASYNC WATCHERS - how to wake up another event loop
1066
1067Async watchers are provided by EV, but have little use in perl directly,
1068as perl neither supports threads running in parallel nor direct access to
1069signal handlers or other contexts where they could be of value.
1070
1071It is, however, possible to use them from the XS level.
1072
1073Please see the libev documentation for further details.
1074
1075=over 4
1076
1077=item $w = EV::async $callback
1078
1079=item $w = EV::async_ns $callback
1080
1081=item $w->send
1082
1083=item $bool = $w->async_pending
1084
1085=back
1086
1087
1088=head1 PERL SIGNALS
1089
1090While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
1091with EV is as the same as any other C library: Perl-signals will only be
1092handled when Perl runs, which means your signal handler might be invoked
1093only the next time an event callback is invoked.
1094
1095The solution is to use EV signal watchers (see C<EV::signal>), which will
1096ensure proper operations with regards to other event watchers.
1097
1098If you cannot do this for whatever reason, you can also force a watcher
1099to be called on every event loop iteration by installing a C<EV::check>
1100watcher:
1101
1102 my $async_check = EV::check sub { };
1103
1104This ensures that perl gets into control for a short time to handle any
1105pending signals, and also ensures (slightly) slower overall operation.
1106
585=head1 THREADS 1107=head1 ITHREADS
586 1108
587Threads are not supported by this module in any way. Perl pseudo-threads 1109Ithreads are not supported by this module in any way. Perl pseudo-threads
588is evil stuff and must die. As soon as Perl gains real threads I will work 1110is evil stuff and must die. Real threads as provided by Coro are fully
589on thread support for it. 1111supported (and enhanced support is available via L<Coro::EV>).
590 1112
591=head1 FORK 1113=head1 FORK
592 1114
593Most of the "improved" event delivering mechanisms of modern operating 1115Most of the "improved" event delivering mechanisms of modern operating
594systems have quite a few problems with fork(2) (to put it bluntly: it is 1116systems have quite a few problems with fork(2) (to put it bluntly: it is
610our $DIED = sub { 1132our $DIED = sub {
611 warn "EV: error in callback (ignoring): $@"; 1133 warn "EV: error in callback (ignoring): $@";
612}; 1134};
613 1135
614default_loop 1136default_loop
615 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; 1137 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
616 1138
6171; 11391;
618 1140
619=head1 SEE ALSO 1141=head1 SEE ALSO
620 1142
621 L<EV::DNS>. 1143L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
1144event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1145coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1146event-loop agnostic and portable event driven programming.
622 1147
623=head1 AUTHOR 1148=head1 AUTHOR
624 1149
625 Marc Lehmann <schmorp@schmorp.de> 1150 Marc Lehmann <schmorp@schmorp.de>
626 http://home.schmorp.de/ 1151 http://home.schmorp.de/
627 1152
628=cut 1153=cut
629 1154

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines