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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines