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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines