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

Comparing EV/EV.pm (file contents):
Revision 1.2 by root, Fri Oct 26 17:24:17 2007 UTC vs.
Revision 1.149 by root, Wed Apr 20 13:43:39 2016 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines