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

Comparing EV/EV.pm (file contents):
Revision 1.32 by root, Thu Nov 8 17:02:10 2007 UTC vs.
Revision 1.117 by root, Tue Jul 14 00:09:59 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines