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

Comparing EV/EV.pm (file contents):
Revision 1.6 by root, Sat Oct 27 07:30:10 2007 UTC vs.
Revision 1.38 by root, Mon Nov 12 21:51:14 2007 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 }
34 }; 30 };
35 $w->timeout (10); 31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
36 39
40 my $w = EV::child 666, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
44
37 # MAINLOOP 45 # MAINLOOP
38 EV::dispatch; # loop as long as watchers are active 46 EV::loop; # loop until EV::loop_done is called or all watchers stop
39 EV::loop; # the same thing 47 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
40 EV::loop EV::LOOP_ONCE; 48 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
41 EV::loop EV::LOOP_ONSHOT;
42 49
43=head1 DESCRIPTION 50=head1 DESCRIPTION
44 51
45This module provides an interface to libevent 52This module provides an interface to libev
46(L<http://monkey.org/~provos/libevent/>). You probably should acquaint 53(L<http://software.schmorp.de/pkg/libev.html>).
47yourself with its documentation and source code to be able to use this
48module fully.
49
50Please note thta this module disables the libevent EPOLL method by
51default, see BUGS, below, if you need to enable it.
52 54
53=cut 55=cut
54 56
55package EV; 57package EV;
56 58
57use strict; 59use strict;
58 60
59BEGIN { 61BEGIN {
60 our $VERSION = '0.01'; 62 our $VERSION = '0.9';
61 use XSLoader; 63 use XSLoader;
62 XSLoader::load "EV", $VERSION; 64 XSLoader::load "EV", $VERSION;
63} 65}
64 66
65=head1 FUNCTIONAL INTERFACE 67@EV::Io::ISA =
68@EV::Timer::ISA =
69@EV::Periodic::ISA =
70@EV::Signal::ISA =
71@EV::Idle::ISA =
72@EV::Prepare::ISA =
73@EV::Check::ISA =
74@EV::Child::ISA = "EV::Watcher";
75
76=head1 BASIC INTERFACE
66 77
67=over 4 78=over 4
68 79
69=item $EV::NPRI 80=item $EV::DIED
70 81
71How many priority levels are available. 82Must contain a reference to a function that is called when a callback
83throws an exception (with $@ containing thr error). The default prints an
84informative message and continues.
85
86If this callback throws an exception it will be silently ignored.
87
88=item $time = EV::time
89
90Returns the current time in (fractional) seconds since the epoch.
72 91
73=item $time = EV::now 92=item $time = EV::now
74 93
75Returns the time in (fractional) seconds since the epoch. 94Returns 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
96usually faster then calling EV::time.
76 97
77=item $version = EV::version
78
79=item $method = EV::method 98=item $method = EV::ev_method
80 99
81Return version string and event polling method used. 100Returns an integer describing the backend used by libev (EV::METHOD_SELECT
101or EV::METHOD_EPOLL).
82 102
83=item EV::loop $flags # EV::LOOP_ONCE, EV::LOOP_ONESHOT 103=item EV::loop [$flags]
84 104
85=item EV::loopexit $after 105Begin checking for events and calling callbacks. It returns when a
106callback calls EV::loop_done.
86 107
87Exit any active loop or dispatch after C<$after> seconds or immediately if 108The $flags argument can be one of the following:
88C<$after> is missing or zero.
89 109
90=item EV::dispatch 110 0 as above
111 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)
91 113
92Same as C<EV::loop 0>. 114=item EV::loop_done [$how]
93 115
94=item EV::event $callback 116When called with no arguments or an argument of 1, makes the innermost
117call to EV::loop return.
95 118
96Creates a new event watcher waiting for nothing, calling the given callback. 119When called with an agrument of 2, all calls to EV::loop will return as
120fast as possible.
97 121
122=back
123
124=head2 WATCHER
125
126A watcher is an object that gets created to record your interest in some
127event. For instance, if you want to wait for STDIN to become readable, you
128would create an EV::io watcher for that:
129
130 my $watcher = EV::io *STDIN, EV::READ, sub {
131 my ($watcher, $revents) = @_;
132 warn "yeah, STDIN should not be readable without blocking!\n"
133 };
134
135All watchers can be active (waiting for events) or inactive (paused). Only
136active watchers will have their callbacks invoked. All callbacks will be
137called with at least two arguments: the watcher and a bitmask of received
138events.
139
140Each watcher type has its associated bit in revents, so you can use the
141same callback for multiple watchers. The event mask is named after the
142type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
143EV::periodic sets EV::PERIODIC and so on, with the exception of IO events
144(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
145uses EV::TIMEOUT).
146
147In the rare case where one wants to create a watcher but not start it at
148the same time, each constructor has a variant with a trailing C<_ns> in
149its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
150
151Please note that a watcher will automatically be stopped when the watcher
152object is destroyed, so you I<need> to keep the watcher objects returned by
153the constructors.
154
155Also, all methods changing some aspect of a watcher (->set, ->priority,
156->fh and so on) automatically stop and start it again if it is active,
157which means pending events get lost.
158
159=head2 WATCHER TYPES
160
161Now lets move to the existing watcher types and asociated methods.
162
163The following methods are available for all watchers. Then followes a
164description of each watcher constructor (EV::io, EV::timer, EV::periodic,
165EV::signal, EV::child, EV::idle, EV::prepare and EV::check), followed by
166any type-specific methods (if any).
167
168=over 4
169
170=item $w->start
171
172Starts a watcher if it isn't active already. Does nothing to an already
173active watcher. By default, all watchers start out in the active state
174(see the description of the C<_ns> variants if you need stopped watchers).
175
176=item $w->stop
177
178Stop a watcher if it is active. Also clear any pending events (events that
179have been received but that didn't yet result in a callback invocation),
180regardless of wether the watcher was active or not.
181
182=item $bool = $w->is_active
183
184Returns true if the watcher is active, false otherwise.
185
186=item $current_data = $w->data
187
188=item $old_data = $w->data ($new_data)
189
190Queries a freely usable data scalar on the watcher and optionally changes
191it. This is a way to associate custom data with a watcher:
192
193 my $w = EV::timer 60, 0, sub {
194 warn $_[0]->data;
195 };
196 $w->data ("print me!");
197
198=item $current_cb = $w->cb
199
200=item $old_cb = $w->cb ($new_cb)
201
202Queries the callback on the watcher and optionally changes it. You can do
203this at any time without the watcher restarting.
204
205=item $current_priority = $w->priority
206
207=item $old_priority = $w->priority ($new_priority)
208
209Queries the priority on the watcher and optionally changes it. Pending
210watchers with higher priority will be invoked first. The valid range of
211priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default
212-2). If the priority is outside this range it will automatically be
213normalised to the nearest valid priority.
214
215The default priority of any newly-created weatcher is 0.
216
217=item $w->trigger ($revents)
218
219Call the callback *now* with the given event mask.
220
221
98=item my $w = EV::io $fileno_or_fh, $eventmask, $callback 222=item $w = EV::io $fileno_or_fh, $eventmask, $callback
99 223
100=item my $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 224=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
101 225
102As long as the returned watcher object is alive, call the C<$callback> 226As long as the returned watcher object is alive, call the C<$callback>
103when the events specified in C<$eventmask> happen. Initially, the timeout 227when the events specified in C<$eventmask>.
104is disabled.
105 228
106The C<io_ns> variant doesn't add/start the newly created watcher.
107
108Eventmask can be one or more of these constants ORed together: 229The $eventmask can be one or more of these constants ORed together:
109 230
110 EV::READ wait until read() wouldn't block anymore 231 EV::READ wait until read() wouldn't block anymore
111 EV::WRITE wait until write() wouldn't block anymore 232 EV::WRITE wait until write() wouldn't block anymore
112 EV::PERSIST stay active after an event occured
113 233
234The C<io_ns> variant doesn't start (activate) the newly created watcher.
235
236=item $w->set ($fileno_or_fh, $eventmask)
237
238Reconfigures the watcher, see the constructor above for details. Can be
239called at any time.
240
241=item $current_fh = $w->fh
242
243=item $old_fh = $w->fh ($new_fh)
244
245Returns the previously set filehandle and optionally set a new one.
246
247=item $current_eventmask = $w->events
248
249=item $old_eventmask = $w->events ($new_eventmask)
250
251Returns the previously set event mask and optionally set a new one.
252
253
114=item my $w = EV::timer $after, $repeat, $callback 254=item $w = EV::timer $after, $repeat, $callback
115 255
116=item my $w = EV::timer_ns $after, $repeat, $callback 256=item $w = EV::timer_ns $after, $repeat, $callback
117 257
118Calls the callback after C<$after> seconds. If C<$repeat> is true, the 258Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,
119timer will be restarted after the callback returns. This means that the 259the timer will be restarted (with the $repeat value as $after) after the
120callback would be called roughly every C<$after> seconds, prolonged by the 260callback returns.
121time the callback takes.
122 261
262This means that the callback would be called roughly after C<$after>
263seconds, and then every C<$repeat> seconds. "Roughly" because the time of
264callback processing is not taken into account, so the timer will slowly
265drift. If that isn't acceptable, look at EV::periodic.
266
267The timer is based on a monotonic clock, that is if somebody is sitting
268in front of the machine while the timer is running and changes the system
269clock, the timer will nevertheless run (roughly) the same time.
270
123The C<timer_ns> variant doesn't add/start the newly created watcher. 271The C<timer_ns> variant doesn't start (activate) the newly created watcher.
124 272
125=item my $w = EV::timer_abs $at, $interval, $callback 273=item $w->set ($after, $repeat)
126 274
127=item my $w = EV::timer_abs_ns $at, $interval, $callback 275Reconfigures the watcher, see the constructor above for details. Can be at
276any time.
128 277
129Similar to EV::timer, but the time is given as an absolute point in time 278=item $w->again
130(C<$at>), plus an optional C<$interval>.
131 279
132If the C<$interval> is zero, then the callback will be called at the time 280Similar to the C<start> method, but has special semantics for repeating timers:
133C<$at> if that is in the future, or as soon as possible if its in the
134past. It will not automatically repeat.
135 281
136If the C<$interval> is nonzero, then the watcher will always be scheduled 282If the timer is active and repeating, reset the timeout to occur
137to time out at the next C<$at + integer * $interval> time. 283C<$repeat> seconds after now.
138 284
139This can be used to schedule a callback to run at very regular intervals, 285If the timer is active and non-repeating, it will be stopped.
140as long as the processing time is less then the interval (otherwise
141obviously events will be skipped).
142 286
143The C<timer_abs_ns> variant doesn't add/start the newly created watcher. 287If the timer is in active and repeating, start it.
144 288
145=item my $w = EV::signal $signum, $callback 289Otherwise do nothing.
146 290
147=item my $w = EV::signal_ns $signum, $callback 291This behaviour is useful when you have a timeout for some IO
292operation. You create a timer object with the same value for C<$after> and
293C<$repeat>, and then, in the read/write watcher, run the C<again> method
294on the timeout.
148 295
149Call the callback when signal $signum is received.
150 296
151The C<signal_ns> variant doesn't add/start the newly created watcher. 297=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
298
299=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
300
301Similar to EV::timer, but is not based on relative timeouts but on
302absolute times. Apart from creating "simple" timers that trigger "at" the
303specified time, it can also be used for non-drifting absolute timers and
304more complex, cron-like, setups that are not adversely affected by time
305jumps (i.e. when the system clock is changed by explicit date -s or other
306means such as ntpd). It is also the most complex watcher type in EV.
307
308It has three distinct "modes":
309
310=over 4
311
312=item * absolute timer ($interval = $reschedule_cb = 0)
313
314This time simply fires at the wallclock time C<$at> and doesn't repeat. It
315will not adjust when a time jump occurs, that is, if it is to be run
316at January 1st 2011 then it will run when the system time reaches or
317surpasses this time.
318
319=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
320
321In this mode the watcher will always be scheduled to time out at the
322next C<$at + N * $interval> time (for some integer N) and then repeat,
323regardless of any time jumps.
324
325This can be used to create timers that do not drift with respect to system
326time:
327
328 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
329
330That doesn't mean there will always be 3600 seconds in between triggers,
331but only that the the clalback will be called when the system time shows a
332full hour (UTC).
333
334Another way to think about it (for the mathematically inclined) is that
335EV::periodic will try to run the callback in this mode at the next
336possible time where C<$time = $at (mod $interval)>, regardless of any time
337jumps.
338
339=item * manual reschedule mode ($reschedule_cb = coderef)
340
341In this mode $interval and $at are both being ignored. Instead, each
342time the periodic watcher gets scheduled, the reschedule callback
343($reschedule_cb) will be called with the watcher as first, and the current
344time as second argument.
345
346I<This callback MUST NOT stop or destroy this or any other periodic
347watcher, ever>. If you need to stop it, return 1e30 and stop it
348afterwards.
349
350It must return the next time to trigger, based on the passed time value
351(that is, the lowest time value larger than to the second argument). It
352will usually be called just before the callback will be triggered, but
353might be called at other times, too.
354
355This can be used to create very complex timers, such as a timer that
356triggers on each midnight, local time (actually 24 hours after the last
357midnight, to keep the example simple. If you know a way to do it correctly
358in about the same space (without requiring elaborate modules), drop me a
359note :):
360
361 my $daily = EV::periodic 0, 0, sub {
362 my ($w, $now) = @_;
363
364 use Time::Local ();
365 my (undef, undef, undef, $d, $m, $y) = localtime $now;
366 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
367 }, sub {
368 print "it's midnight or likely shortly after, now\n";
369 };
152 370
153=back 371=back
154 372
155=head1 THE EV::Event CLASS 373The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
156 374
157All EV functions creating an event watcher (designated by C<my $w => 375=item $w->set ($at, $interval, $reschedule_cb)
158above) support the following methods on the returned watcher object:
159 376
160=over 4 377Reconfigures the watcher, see the constructor above for details. Can be at
378any time.
161 379
162=item $w->add ($timeout) 380=item $w->again
163 381
164Stops and (re-)starts the event watcher, setting the optional timeout to 382Simply stops and starts the watcher again.
165the given value, or clearing the timeout if none is given.
166 383
167=item $w->start
168 384
169Stops and (re-)starts the event watcher without touching the timeout. 385=item $w = EV::signal $signal, $callback
170 386
171=item $w->del 387=item $w = EV::signal_ns $signal, $callback
172 388
389Call the callback when $signal is received (the signal can be specified
390by number or by name, just as with kill or %SIG).
391
392EV will grab the signal for the process (the kernel only allows one
393component to receive a signal at a time) when you start a signal watcher,
394and removes it again when you stop it. Perl does the same when you
395add/remove callbacks to %SIG, so watch out.
396
397You can have as many signal watchers per signal as you want.
398
399The C<signal_ns> variant doesn't start (activate) the newly created watcher.
400
401=item $w->set ($signal)
402
403Reconfigures the watcher, see the constructor above for details. Can be at
404any time.
405
406=item $current_signum = $w->signal
407
408=item $old_signum = $w->signal ($new_signal)
409
410Returns the previously set signal (always as a number not name) and
411optionally set a new one.
412
413
414=item $w = EV::child $pid, $callback
415
416=item $w = EV::child_ns $pid, $callback
417
418Call the callback when a status change for pid C<$pid> (or any pid
419if C<$pid> is 0) has been received. More precisely: when the process
420receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all
421changed/zombie children and call the callback.
422
423You can access both status and pid by using the C<rstatus> and C<rpid>
424methods on the watcher object.
425
426You can have as many pid watchers per pid as you want.
427
428The C<child_ns> variant doesn't start (activate) the newly created watcher.
429
173=item $w->stop 430=item $w->set ($pid)
174 431
175Stop the event watcher if it was started. 432Reconfigures the watcher, see the constructor above for details. Can be at
433any time.
176 434
177=item $current_callback = $w->cb
178
179=item $old_callback = $w->cb ($new_callback)
180
181Return the previously set callback and optionally set a new one.
182
183=item $current_fh = $w->fh 435=item $current_pid = $w->pid
184 436
185=item $old_fh = $w->fh ($new_fh) 437=item $old_pid = $w->pid ($new_pid)
186 438
187Returns the previously set filehandle and optionally set a new one.
188
189=item $current_eventmask = $w->events
190
191=item $old_eventmask = $w->events ($new_eventmask)
192
193Returns the previously set event mask and optionally set a new one. 439Returns the previously set process id and optionally set a new one.
194 440
195=item $w->timeout ($after, $repeat) 441=item $exit_status = $w->rstatus
196 442
197Resets the timeout (see C<EV::timer> for details). 443Return the exit/wait status (as returned by waitpid, see the waitpid entry
444in perlfunc).
198 445
199=item $w->timeout_abs ($at, $interval) 446=item $pid = $w->rpid
200 447
201Resets the timeout (see C<EV::timer_abs> for details). 448Return the pid of the awaited child (useful when you have installed a
449watcher for all pids).
202 450
203=item $w->priority_set ($priority)
204 451
205Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI). 452=item $w = EV::idle $callback
453
454=item $w = EV::idle_ns $callback
455
456Call the callback when there are no pending io, timer/periodic, signal or
457child events, i.e. when the process is idle.
458
459The process will not block as long as any idle watchers are active, and
460they will be called repeatedly until stopped.
461
462The C<idle_ns> variant doesn't start (activate) the newly created watcher.
463
464
465=item $w = EV::prepare $callback
466
467=item $w = EV::prepare_ns $callback
468
469Call the callback just before the process would block. You can still
470create/modify any watchers at this point.
471
472See the EV::check watcher, below, for explanations and an example.
473
474The C<prepare_ns> variant doesn't start (activate) the newly created watcher.
475
476
477=item $w = EV::check $callback
478
479=item $w = EV::check_ns $callback
480
481Call the callback just after the process wakes up again (after it has
482gathered events), but before any other callbacks have been invoked.
483
484This is used to integrate other event-based software into the EV
485mainloop: You register a prepare callback and in there, you create io and
486timer watchers as required by the other software. Here is a real-world
487example of integrating Net::SNMP (with some details left out):
488
489 our @snmp_watcher;
490
491 our $snmp_prepare = EV::prepare sub {
492 # do nothing unless active
493 $dispatcher->{_event_queue_h}
494 or return;
495
496 # make the dispatcher handle any outstanding stuff
497
498 # create an IO watcher for each and every socket
499 @snmp_watcher = (
500 (map { EV::io $_, EV::READ, sub { } }
501 keys %{ $dispatcher->{_descriptors} }),
502 );
503
504 # if there are any timeouts, also create a timer
505 push @snmp_watcher, EV::timer $event->[Net::SNMP::Dispatcher::_TIME] - EV::now, 0, sub { }
506 if $event->[Net::SNMP::Dispatcher::_ACTIVE];
507 };
508
509The callbacks are irrelevant, the only purpose of those watchers is
510to wake up the process as soon as one of those events occurs (socket
511readable, or timer timed out). The corresponding EV::check watcher will then
512clean up:
513
514 our $snmp_check = EV::check sub {
515 # destroy all watchers
516 @snmp_watcher = ();
517
518 # make the dispatcher handle any new stuff
519 };
520
521The callbacks of the created watchers will not be called as the watchers
522are destroyed before this cna happen (remember EV::check gets called
523first).
524
525The C<check_ns> variant doesn't start (activate) the newly created watcher.
206 526
207=back 527=back
208 528
209=head1 BUGS 529=head1 THREADS
210 530
211Lots. Libevent itself isn't well tested and rather buggy, and this module 531Threads are not supported by this in any way. Perl pseudo-threads is evil
212is quite new at the moment. 532stuff and must die.
213
214Please note that the epoll method is not, in general, reliable in
215programs that use fork (even if no libveent calls are being made in the
216forked process). Since this is such a common issue, this module will
217force the epoll method in EV to be off *unless* the global variable
218$EV::ENABLE_EPOLL is set to 1 *before* loading this module for the first
219time.
220 533
221=cut 534=cut
222 535
223our $NPRI = 4; 536our $DIED = sub {
224our $BASE; 537 warn "EV: error in callback (ignoring): $@";
225our $ENABLE_EPOLL; 538};
226 539
227{ 540default_loop
228 local $ENV{EVENT_NOEPOLL}; 541 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
229 $ENV{EVENT_NOEPOLL} = 1 unless $ENABLE_EPOLL;
230 $BASE = init;
231}
232
233priority_init $NPRI;
234
235push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
236 542
2371; 5431;
238 544
239=head1 SEE ALSO 545=head1 SEE ALSO
240 546
241 L<EV::DNS>, L<event(3)>, L<event.h>, L<evdns.h>.
242 L<EV::AnyEvent>. 547 L<EV::DNS>, L<EV::AnyEvent>.
243 548
244=head1 AUTHOR 549=head1 AUTHOR
245 550
246 Marc Lehmann <schmorp@schmorp.de> 551 Marc Lehmann <schmorp@schmorp.de>
247 http://home.schmorp.de/ 552 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines