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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.137 by root, Mon May 26 03:27:52 2008 UTC vs.
Revision 1.301 by root, Tue Dec 1 18:04:21 2009 UTC

1=head1 => NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6and POE are various supported event loops/environments.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
12 # file descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14
15 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
18
19 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21
22 # POSIX signal
23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
24
25 # child process exit
26 my $w = AnyEvent->child (pid => $pid, cb => sub {
27 my ($pid, $status) = @_;
12 ... 28 ...
13 }); 29 });
14 30
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 31 # called when event loop idle (if applicable)
16 ... 32 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 33
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
37 # use a condvar in callback mode:
38 $w->cb (sub { $_[0]->recv });
39
40=head1 INTRODUCTION/TUTORIAL
41
42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage.
45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Repository>, at L<http://anyevent.schmorp.de>, for more info.
22 53
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 55
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
27 58
28Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 59Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29policy> and AnyEvent is I<small and efficient>. 60policy> and AnyEvent is I<small and efficient>.
30 61
31First and foremost, I<AnyEvent is not an event model> itself, it only 62First and foremost, I<AnyEvent is not an event model> itself, it only
32interfaces to whatever event model the main program happens to use in a 63interfaces to whatever event model the main program happens to use, in a
33pragmatic way. For event models and certain classes of immortals alike, 64pragmatic way. For event models and certain classes of immortals alike,
34the statement "there can only be one" is a bitter reality: In general, 65the statement "there can only be one" is a bitter reality: In general,
35only one event loop can be active at the same time in a process. AnyEvent 66only one event loop can be active at the same time in a process. AnyEvent
36helps hiding the differences between those event loops. 67cannot change this, but it can hide the differences between those event
68loops.
37 69
38The goal of AnyEvent is to offer module authors the ability to do event 70The goal of AnyEvent is to offer module authors the ability to do event
39programming (waiting for I/O or timer events) without subscribing to a 71programming (waiting for I/O or timer events) without subscribing to a
40religion, a way of living, and most importantly: without forcing your 72religion, a way of living, and most importantly: without forcing your
41module users into the same thing by forcing them to use the same event 73module users into the same thing by forcing them to use the same event
42model you use. 74model you use.
43 75
44For modules like POE or IO::Async (which is a total misnomer as it is 76For modules like POE or IO::Async (which is a total misnomer as it is
45actually doing all I/O I<synchronously>...), using them in your module is 77actually doing all I/O I<synchronously>...), using them in your module is
46like joining a cult: After you joined, you are dependent on them and you 78like joining a cult: After you joined, you are dependent on them and you
47cannot use anything else, as it is simply incompatible to everything that 79cannot use anything else, as they are simply incompatible to everything
48isn't itself. What's worse, all the potential users of your module are 80that isn't them. What's worse, all the potential users of your
49I<also> forced to use the same event loop you use. 81module are I<also> forced to use the same event loop you use.
50 82
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 83AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. AnyEvent + Tk works fine etc. etc. but none of these work together 84fine. AnyEvent + Tk works fine etc. etc. but none of these work together
53with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if 85with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54your module uses one of those, every user of your module has to use it, 86your module uses one of those, every user of your module has to use it,
55too. But if your module uses AnyEvent, it works transparently with all 87too. But if your module uses AnyEvent, it works transparently with all
56event models it supports (including stuff like POE and IO::Async, as long 88event models it supports (including stuff like IO::Async, as long as those
57as those use one of the supported event loops. It is trivial to add new 89use one of the supported event loops. It is trivial to add new event loops
58event loops to AnyEvent, too, so it is future-proof). 90to AnyEvent, too, so it is future-proof).
59 91
60In addition to being free of having to use I<the one and only true event 92In addition to being free of having to use I<the one and only true event
61model>, AnyEvent also is free of bloat and policy: with POE or similar 93model>, AnyEvent also is free of bloat and policy: with POE or similar
62modules, you get an enormous amount of code and strict rules you have to 94modules, you get an enormous amount of code and strict rules you have to
63follow. AnyEvent, on the other hand, is lean and up to the point, by only 95follow. AnyEvent, on the other hand, is lean and up to the point, by only
64offering the functionality that is necessary, in as thin as a wrapper as 96offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 97technically possible.
66 98
99Of course, AnyEvent comes with a big (and fully optional!) toolbox
100of useful functionality, such as an asynchronous DNS resolver, 100%
101non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
102such as Windows) and lots of real-world knowledge and workarounds for
103platform bugs and differences.
104
67Of course, if you want lots of policy (this can arguably be somewhat 105Now, if you I<do want> lots of policy (this can arguably be somewhat
68useful) and you want to force your users to use the one and only event 106useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 107model, you should I<not> use this module.
70 108
71=head1 DESCRIPTION 109=head1 DESCRIPTION
72 110
102starts using it, all bets are off. Maybe you should tell their authors to 140starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly... 141use AnyEvent so their modules work together with others seamlessly...
104 142
105The pure-perl implementation of AnyEvent is called 143The pure-perl implementation of AnyEvent is called
106C<AnyEvent::Impl::Perl>. Like other event modules you can load it 144C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107explicitly. 145explicitly and enjoy the high availability of that event loop :)
108 146
109=head1 WATCHERS 147=head1 WATCHERS
110 148
111AnyEvent has the central concept of a I<watcher>, which is an object that 149AnyEvent has the central concept of a I<watcher>, which is an object that
112stores relevant data for each kind of event you are waiting for, such as 150stores relevant data for each kind of event you are waiting for, such as
115These watchers are normal Perl objects with normal Perl lifetime. After 153These watchers are normal Perl objects with normal Perl lifetime. After
116creating a watcher it will immediately "watch" for events and invoke the 154creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model 155callback when the event occurs (of course, only when the event model
118is in control). 156is in control).
119 157
158Note that B<callbacks must not permanently change global variables>
159potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
160callbacks must not C<die> >>. The former is good programming practise in
161Perl and the latter stems from the fact that exception handling differs
162widely between event loops.
163
120To disable the watcher you have to destroy it (e.g. by setting the 164To disable the watcher you have to destroy it (e.g. by setting the
121variable you store it in to C<undef> or otherwise deleting all references 165variable you store it in to C<undef> or otherwise deleting all references
122to it). 166to it).
123 167
124All watchers are created by calling a method on the C<AnyEvent> class. 168All watchers are created by calling a method on the C<AnyEvent> class.
126Many watchers either are used with "recursion" (repeating timers for 170Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways. 171example), or need to refer to their watcher object in other ways.
128 172
129An any way to achieve that is this pattern: 173An any way to achieve that is this pattern:
130 174
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 175 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it 176 # you can use $w here, for example to undef it
133 undef $w; 177 undef $w;
134 }); 178 });
135 179
136Note that C<my $w; $w => combination. This is necessary because in Perl, 180Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
138declared. 182declared.
139 183
140=head2 I/O WATCHERS 184=head2 I/O WATCHERS
141 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
142You can create an I/O watcher by calling the C<< AnyEvent->io >> method 192You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
144 194
145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 195C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
196for events (AnyEvent might or might not keep a reference to this file
197handle). Note that only file handles pointing to things for which
198non-blocking operation makes sense are allowed. This includes sockets,
199most character devices, pipes, fifos and so on, but not for example files
200or block devices.
201
146for events. C<poll> must be a string that is either C<r> or C<w>, 202C<poll> must be a string that is either C<r> or C<w>, which creates a
147which creates a watcher waiting for "r"eadable or "w"ritable events, 203watcher waiting for "r"eadable or "w"ritable events, respectively.
204
148respectively. C<cb> is the callback to invoke each time the file handle 205C<cb> is the callback to invoke each time the file handle becomes ready.
149becomes ready.
150 206
151Although the callback might get passed parameters, their value and 207Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent 208presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks. 209callbacks cannot use arguments passed to I/O watcher callbacks.
154 210
158 214
159Some event loops issue spurious readyness notifications, so you should 215Some event loops issue spurious readyness notifications, so you should
160always use non-blocking calls when reading/writing from/to your file 216always use non-blocking calls when reading/writing from/to your file
161handles. 217handles.
162 218
163Example:
164
165 # wait for readability of STDIN, then read a line and disable the watcher 219Example: wait for readability of STDIN, then read a line and disable the
220watcher.
221
166 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 222 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167 chomp (my $input = <STDIN>); 223 chomp (my $input = <STDIN>);
168 warn "read: $input\n"; 224 warn "read: $input\n";
169 undef $w; 225 undef $w;
170 }); 226 });
171 227
172=head2 TIME WATCHERS 228=head2 TIME WATCHERS
173 229
230 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
231
232 $w = AnyEvent->timer (
233 after => <fractional_seconds>,
234 interval => <fractional_seconds>,
235 cb => <callback>,
236 );
237
174You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
175method with the following mandatory arguments: 239method with the following mandatory arguments:
176 240
177C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
178supported) the callback should be invoked. C<cb> is the callback to invoke 242supported) the callback should be invoked. C<cb> is the callback to invoke
180 244
181Although the callback might get passed parameters, their value and 245Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent 246presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks. 247callbacks cannot use arguments passed to time watcher callbacks.
184 248
185The timer callback will be invoked at most once: if you want a repeating 249The callback will normally be invoked once only. If you specify another
186timer you have to create a new watcher (this is a limitation by both Tk 250parameter, C<interval>, as a strictly positive number (> 0), then the
187and Glib). 251callback will be invoked regularly at that interval (in fractional
252seconds) after the first invocation. If C<interval> is specified with a
253false value, then it is treated as if it were missing.
188 254
189Example: 255The callback will be rescheduled before invoking the callback, but no
256attempt is done to avoid timer drift in most backends, so the interval is
257only approximate.
190 258
191 # fire an event after 7.7 seconds 259Example: fire an event after 7.7 seconds.
260
192 my $w = AnyEvent->timer (after => 7.7, cb => sub { 261 my $w = AnyEvent->timer (after => 7.7, cb => sub {
193 warn "timeout\n"; 262 warn "timeout\n";
194 }); 263 });
195 264
196 # to cancel the timer: 265 # to cancel the timer:
197 undef $w; 266 undef $w;
198 267
199Example 2:
200
201 # fire an event after 0.5 seconds, then roughly every second 268Example 2: fire an event after 0.5 seconds, then roughly every second.
202 my $w;
203 269
204 my $cb = sub {
205 # cancel the old timer while creating a new one
206 $w = AnyEvent->timer (after => 1, cb => $cb); 270 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
271 warn "timeout\n";
207 }; 272 };
208
209 # start the "loop" by creating the first watcher
210 $w = AnyEvent->timer (after => 0.5, cb => $cb);
211 273
212=head3 TIMING ISSUES 274=head3 TIMING ISSUES
213 275
214There are two ways to handle timers: based on real time (relative, "fire 276There are two ways to handle timers: based on real time (relative, "fire
215in 10 seconds") and based on wallclock time (absolute, "fire at 12 277in 10 seconds") and based on wallclock time (absolute, "fire at 12
227timers. 289timers.
228 290
229AnyEvent always prefers relative timers, if available, matching the 291AnyEvent always prefers relative timers, if available, matching the
230AnyEvent API. 292AnyEvent API.
231 293
294AnyEvent has two additional methods that return the "current time":
295
296=over 4
297
298=item AnyEvent->time
299
300This returns the "current wallclock time" as a fractional number of
301seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
302return, and the result is guaranteed to be compatible with those).
303
304It progresses independently of any event loop processing, i.e. each call
305will check the system clock, which usually gets updated frequently.
306
307=item AnyEvent->now
308
309This also returns the "current wallclock time", but unlike C<time>, above,
310this value might change only once per event loop iteration, depending on
311the event loop (most return the same time as C<time>, above). This is the
312time that AnyEvent's timers get scheduled against.
313
314I<In almost all cases (in all cases if you don't care), this is the
315function to call when you want to know the current time.>
316
317This function is also often faster then C<< AnyEvent->time >>, and
318thus the preferred method if you want some timestamp (for example,
319L<AnyEvent::Handle> uses this to update it's activity timeouts).
320
321The rest of this section is only of relevance if you try to be very exact
322with your timing, you can skip it without bad conscience.
323
324For a practical example of when these times differ, consider L<Event::Lib>
325and L<EV> and the following set-up:
326
327The event loop is running and has just invoked one of your callback at
328time=500 (assume no other callbacks delay processing). In your callback,
329you wait a second by executing C<sleep 1> (blocking the process for a
330second) and then (at time=501) you create a relative timer that fires
331after three seconds.
332
333With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
334both return C<501>, because that is the current time, and the timer will
335be scheduled to fire at time=504 (C<501> + C<3>).
336
337With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
338time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
339last event processing phase started. With L<EV>, your timer gets scheduled
340to run at time=503 (C<500> + C<3>).
341
342In one sense, L<Event::Lib> is more exact, as it uses the current time
343regardless of any delays introduced by event processing. However, most
344callbacks do not expect large delays in processing, so this causes a
345higher drift (and a lot more system calls to get the current time).
346
347In another sense, L<EV> is more exact, as your timer will be scheduled at
348the same time, regardless of how long event processing actually took.
349
350In either case, if you care (and in most cases, you don't), then you
351can get whatever behaviour you want with any event loop, by taking the
352difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
353account.
354
355=item AnyEvent->now_update
356
357Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
358the current time for each loop iteration (see the discussion of L<<
359AnyEvent->now >>, above).
360
361When a callback runs for a long time (or when the process sleeps), then
362this "current" time will differ substantially from the real time, which
363might affect timers and time-outs.
364
365When this is the case, you can call this method, which will update the
366event loop's idea of "current time".
367
368A typical example would be a script in a web server (e.g. C<mod_perl>) -
369when mod_perl executes the script, then the event loop will have the wrong
370idea about the "current time" (being potentially far in the past, when the
371script ran the last time). In that case you should arrange a call to C<<
372AnyEvent->now_update >> each time the web server process wakes up again
373(e.g. at the start of your script, or in a handler).
374
375Note that updating the time I<might> cause some events to be handled.
376
377=back
378
232=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
233 380
381 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
382
234You can watch for signals using a signal watcher, C<signal> is the signal 383You can watch for signals using a signal watcher, C<signal> is the signal
235I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 384I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236be invoked whenever a signal occurs. 385callback to be invoked whenever a signal occurs.
237 386
238Although the callback might get passed parameters, their value and 387Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 388presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 389callbacks cannot use arguments passed to signal watcher callbacks.
241 390
243invocation, and callback invocation will be synchronous. Synchronous means 392invocation, and callback invocation will be synchronous. Synchronous means
244that it might take a while until the signal gets handled by the process, 393that it might take a while until the signal gets handled by the process,
245but it is guaranteed not to interrupt any other callbacks. 394but it is guaranteed not to interrupt any other callbacks.
246 395
247The main advantage of using these watchers is that you can share a signal 396The main advantage of using these watchers is that you can share a signal
248between multiple watchers. 397between multiple watchers, and AnyEvent will ensure that signals will not
398interrupt your program at bad times.
249 399
250This watcher might use C<%SIG>, so programs overwriting those signals 400This watcher might use C<%SIG> (depending on the event loop used),
251directly will likely not work correctly. 401so programs overwriting those signals directly will likely not work
402correctly.
252 403
253Example: exit on SIGINT 404Example: exit on SIGINT
254 405
255 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
256 407
408=head3 Restart Behaviour
409
410While restart behaviour is up to the event loop implementation, most will
411not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
412pure perl implementation).
413
414=head3 Safe/Unsafe Signals
415
416Perl signals can be either "safe" (synchronous to opcode handling) or
417"unsafe" (asynchronous) - the former might get delayed indefinitely, the
418latter might corrupt your memory.
419
420AnyEvent signal handlers are, in addition, synchronous to the event loop,
421i.e. they will not interrupt your running perl program but will only be
422called as part of the normal event handling (just like timer, I/O etc.
423callbacks, too).
424
425=head3 Signal Races, Delays and Workarounds
426
427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
428callbacks to signals in a generic way, which is a pity, as you cannot
429do race-free signal handling in perl, requiring C libraries for
430this. AnyEvent will try to do it's best, which means in some cases,
431signals will be delayed. The maximum time a signal might be delayed is
432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
433variable can be changed only before the first signal watcher is created,
434and should be left alone otherwise. This variable determines how often
435AnyEvent polls for signals (in case a wake-up was missed). Higher values
436will cause fewer spurious wake-ups, which is better for power and CPU
437saving.
438
439All these problems can be avoided by installing the optional
440L<Async::Interrupt> module, which works with most event loops. It will not
441work with inherently broken event loops such as L<Event> or L<Event::Lib>
442(and not with L<POE> currently, as POE does it's own workaround with
443one-second latency). For those, you just have to suffer the delays.
444
257=head2 CHILD PROCESS WATCHERS 445=head2 CHILD PROCESS WATCHERS
258 446
447 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
448
259You can also watch on a child process exit and catch its exit status. 449You can also watch on a child process exit and catch its exit status.
260 450
261The child process is specified by the C<pid> argument (if set to C<0>, it 451The child process is specified by the C<pid> argument (one some backends,
262watches for any child process exit). The watcher will trigger as often 452using C<0> watches for any child process exit, on others this will
263as status change for the child are received. This works by installing a 453croak). The watcher will be triggered only when the child process has
264signal handler for C<SIGCHLD>. The callback will be called with the pid 454finished and an exit status is available, not on any trace events
265and exit status (as returned by waitpid), so unlike other watcher types, 455(stopped/continued).
266you I<can> rely on child watcher callback arguments. 456
457The callback will be called with the pid and exit status (as returned by
458waitpid), so unlike other watcher types, you I<can> rely on child watcher
459callback arguments.
460
461This watcher type works by installing a signal handler for C<SIGCHLD>,
462and since it cannot be shared, nothing else should use SIGCHLD or reap
463random child processes (waiting for specific child processes, e.g. inside
464C<system>, is just fine).
267 465
268There is a slight catch to child watchers, however: you usually start them 466There is a slight catch to child watchers, however: you usually start them
269I<after> the child process was created, and this means the process could 467I<after> the child process was created, and this means the process could
270have exited already (and no SIGCHLD will be sent anymore). 468have exited already (and no SIGCHLD will be sent anymore).
271 469
272Not all event models handle this correctly (POE doesn't), but even for 470Not all event models handle this correctly (neither POE nor IO::Async do,
471see their AnyEvent::Impl manpages for details), but even for event models
273event models that I<do> handle this correctly, they usually need to be 472that I<do> handle this correctly, they usually need to be loaded before
274loaded before the process exits (i.e. before you fork in the first place). 473the process exits (i.e. before you fork in the first place). AnyEvent's
474pure perl event loop handles all cases correctly regardless of when you
475start the watcher.
275 476
276This means you cannot create a child watcher as the very first thing in an 477This means you cannot create a child watcher as the very first
277AnyEvent program, you I<have> to create at least one watcher before you 478thing in an AnyEvent program, you I<have> to create at least one
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 479watcher before you C<fork> the child (alternatively, you can call
480C<AnyEvent::detect>).
481
482As most event loops do not support waiting for child events, they will be
483emulated by AnyEvent in most cases, in which the latency and race problems
484mentioned in the description of signal watchers apply.
279 485
280Example: fork a process and wait for it 486Example: fork a process and wait for it
281 487
282 my $done = AnyEvent->condvar; 488 my $done = AnyEvent->condvar;
283 489
284 my $pid = fork or exit 5; 490 my $pid = fork or exit 5;
285 491
286 my $w = AnyEvent->child ( 492 my $w = AnyEvent->child (
287 pid => $pid, 493 pid => $pid,
288 cb => sub { 494 cb => sub {
289 my ($pid, $status) = @_; 495 my ($pid, $status) = @_;
290 warn "pid $pid exited with status $status"; 496 warn "pid $pid exited with status $status";
291 $done->send; 497 $done->send;
292 }, 498 },
293 ); 499 );
294 500
295 # do something else, then wait for process exit 501 # do something else, then wait for process exit
296 $done->recv; 502 $done->recv;
503
504=head2 IDLE WATCHERS
505
506 $w = AnyEvent->idle (cb => <callback>);
507
508Sometimes there is a need to do something, but it is not so important
509to do it instantly, but only when there is nothing better to do. This
510"nothing better to do" is usually defined to be "no other events need
511attention by the event loop".
512
513Idle watchers ideally get invoked when the event loop has nothing
514better to do, just before it would block the process to wait for new
515events. Instead of blocking, the idle watcher is invoked.
516
517Most event loops unfortunately do not really support idle watchers (only
518EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
519will simply call the callback "from time to time".
520
521Example: read lines from STDIN, but only process them when the
522program is otherwise idle:
523
524 my @lines; # read data
525 my $idle_w;
526 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
527 push @lines, scalar <STDIN>;
528
529 # start an idle watcher, if not already done
530 $idle_w ||= AnyEvent->idle (cb => sub {
531 # handle only one line, when there are lines left
532 if (my $line = shift @lines) {
533 print "handled when idle: $line";
534 } else {
535 # otherwise disable the idle watcher again
536 undef $idle_w;
537 }
538 });
539 });
297 540
298=head2 CONDITION VARIABLES 541=head2 CONDITION VARIABLES
542
543 $cv = AnyEvent->condvar;
544
545 $cv->send (<list>);
546 my @res = $cv->recv;
299 547
300If you are familiar with some event loops you will know that all of them 548If you are familiar with some event loops you will know that all of them
301require you to run some blocking "loop", "run" or similar function that 549require you to run some blocking "loop", "run" or similar function that
302will actively watch for new events and call your callbacks. 550will actively watch for new events and call your callbacks.
303 551
304AnyEvent is different, it expects somebody else to run the event loop and 552AnyEvent is slightly different: it expects somebody else to run the event
305will only block when necessary (usually when told by the user). 553loop and will only block when necessary (usually when told by the user).
306 554
307The instrument to do that is called a "condition variable", so called 555The instrument to do that is called a "condition variable", so called
308because they represent a condition that must become true. 556because they represent a condition that must become true.
557
558Now is probably a good time to look at the examples further below.
309 559
310Condition variables can be created by calling the C<< AnyEvent->condvar 560Condition variables can be created by calling the C<< AnyEvent->condvar
311>> method, usually without arguments. The only argument pair allowed is 561>> method, usually without arguments. The only argument pair allowed is
312C<cb>, which specifies a callback to be called when the condition variable 562C<cb>, which specifies a callback to be called when the condition variable
313becomes true. 563becomes true, with the condition variable as the first argument (but not
564the results).
314 565
315After creation, the condition variable is "false" until it becomes "true" 566After creation, the condition variable is "false" until it becomes "true"
316by calling the C<send> method (or calling the condition variable as if it 567by calling the C<send> method (or calling the condition variable as if it
317were a callback, read about the caveats in the description for the C<< 568were a callback, read about the caveats in the description for the C<<
318->send >> method). 569->send >> method).
320Condition variables are similar to callbacks, except that you can 571Condition variables are similar to callbacks, except that you can
321optionally wait for them. They can also be called merge points - points 572optionally wait for them. They can also be called merge points - points
322in time where multiple outstanding events have been processed. And yet 573in time where multiple outstanding events have been processed. And yet
323another way to call them is transactions - each condition variable can be 574another way to call them is transactions - each condition variable can be
324used to represent a transaction, which finishes at some point and delivers 575used to represent a transaction, which finishes at some point and delivers
325a result. 576a result. And yet some people know them as "futures" - a promise to
577compute/deliver something that you can wait for.
326 578
327Condition variables are very useful to signal that something has finished, 579Condition variables are very useful to signal that something has finished,
328for example, if you write a module that does asynchronous http requests, 580for example, if you write a module that does asynchronous http requests,
329then a condition variable would be the ideal candidate to signal the 581then a condition variable would be the ideal candidate to signal the
330availability of results. The user can either act when the callback is 582availability of results. The user can either act when the callback is
364 after => 1, 616 after => 1,
365 cb => sub { $result_ready->send }, 617 cb => sub { $result_ready->send },
366 ); 618 );
367 619
368 # this "blocks" (while handling events) till the callback 620 # this "blocks" (while handling events) till the callback
369 # calls send 621 # calls ->send
370 $result_ready->recv; 622 $result_ready->recv;
371 623
372Example: wait for a timer, but take advantage of the fact that 624Example: wait for a timer, but take advantage of the fact that condition
373condition variables are also code references. 625variables are also callable directly.
374 626
375 my $done = AnyEvent->condvar; 627 my $done = AnyEvent->condvar;
376 my $delay = AnyEvent->timer (after => 5, cb => $done); 628 my $delay = AnyEvent->timer (after => 5, cb => $done);
377 $done->recv; 629 $done->recv;
630
631Example: Imagine an API that returns a condvar and doesn't support
632callbacks. This is how you make a synchronous call, for example from
633the main program:
634
635 use AnyEvent::CouchDB;
636
637 ...
638
639 my @info = $couchdb->info->recv;
640
641And this is how you would just set a callback to be called whenever the
642results are available:
643
644 $couchdb->info->cb (sub {
645 my @info = $_[0]->recv;
646 });
378 647
379=head3 METHODS FOR PRODUCERS 648=head3 METHODS FOR PRODUCERS
380 649
381These methods should only be used by the producing side, i.e. the 650These methods should only be used by the producing side, i.e. the
382code/module that eventually sends the signal. Note that it is also 651code/module that eventually sends the signal. Note that it is also
395immediately from within send. 664immediately from within send.
396 665
397Any arguments passed to the C<send> call will be returned by all 666Any arguments passed to the C<send> call will be returned by all
398future C<< ->recv >> calls. 667future C<< ->recv >> calls.
399 668
400Condition variables are overloaded so one can call them directly 669Condition variables are overloaded so one can call them directly (as if
401(as a code reference). Calling them directly is the same as calling 670they were a code reference). Calling them directly is the same as calling
402C<send>. Note, however, that many C-based event loops do not handle 671C<send>.
403overloading, so as tempting as it may be, passing a condition variable
404instead of a callback does not work. Both the pure perl and EV loops
405support overloading, however, as well as all functions that use perl to
406invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
407example).
408 672
409=item $cv->croak ($error) 673=item $cv->croak ($error)
410 674
411Similar to send, but causes all call's to C<< ->recv >> to invoke 675Similar to send, but causes all call's to C<< ->recv >> to invoke
412C<Carp::croak> with the given error message/object/scalar. 676C<Carp::croak> with the given error message/object/scalar.
413 677
414This can be used to signal any errors to the condition variable 678This can be used to signal any errors to the condition variable
415user/consumer. 679user/consumer. Doing it this way instead of calling C<croak> directly
680delays the error detetcion, but has the overwhelmign advantage that it
681diagnoses the error at the place where the result is expected, and not
682deep in some event clalback without connection to the actual code causing
683the problem.
416 684
417=item $cv->begin ([group callback]) 685=item $cv->begin ([group callback])
418 686
419=item $cv->end 687=item $cv->end
420
421These two methods are EXPERIMENTAL and MIGHT CHANGE.
422 688
423These two methods can be used to combine many transactions/events into 689These two methods can be used to combine many transactions/events into
424one. For example, a function that pings many hosts in parallel might want 690one. For example, a function that pings many hosts in parallel might want
425to use a condition variable for the whole process. 691to use a condition variable for the whole process.
426 692
427Every call to C<< ->begin >> will increment a counter, and every call to 693Every call to C<< ->begin >> will increment a counter, and every call to
428C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 694C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
429>>, the (last) callback passed to C<begin> will be executed. That callback 695>>, the (last) callback passed to C<begin> will be executed, passing the
430is I<supposed> to call C<< ->send >>, but that is not required. If no 696condvar as first argument. That callback is I<supposed> to call C<< ->send
431callback was set, C<send> will be called without any arguments. 697>>, but that is not required. If no group callback was set, C<send> will
698be called without any arguments.
432 699
433Let's clarify this with the ping example: 700You can think of C<< $cv->send >> giving you an OR condition (one call
701sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
702condition (all C<begin> calls must be C<end>'ed before the condvar sends).
703
704Let's start with a simple example: you have two I/O watchers (for example,
705STDOUT and STDERR for a program), and you want to wait for both streams to
706close before activating a condvar:
434 707
435 my $cv = AnyEvent->condvar; 708 my $cv = AnyEvent->condvar;
436 709
710 $cv->begin; # first watcher
711 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
712 defined sysread $fh1, my $buf, 4096
713 or $cv->end;
714 });
715
716 $cv->begin; # second watcher
717 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
718 defined sysread $fh2, my $buf, 4096
719 or $cv->end;
720 });
721
722 $cv->recv;
723
724This works because for every event source (EOF on file handle), there is
725one call to C<begin>, so the condvar waits for all calls to C<end> before
726sending.
727
728The ping example mentioned above is slightly more complicated, as the
729there are results to be passwd back, and the number of tasks that are
730begung can potentially be zero:
731
732 my $cv = AnyEvent->condvar;
733
437 my %result; 734 my %result;
438 $cv->begin (sub { $cv->send (\%result) }); 735 $cv->begin (sub { shift->send (\%result) });
439 736
440 for my $host (@list_of_hosts) { 737 for my $host (@list_of_hosts) {
441 $cv->begin; 738 $cv->begin;
442 ping_host_then_call_callback $host, sub { 739 ping_host_then_call_callback $host, sub {
443 $result{$host} = ...; 740 $result{$host} = ...;
458loop, which serves two important purposes: first, it sets the callback 755loop, which serves two important purposes: first, it sets the callback
459to be called once the counter reaches C<0>, and second, it ensures that 756to be called once the counter reaches C<0>, and second, it ensures that
460C<send> is called even when C<no> hosts are being pinged (the loop 757C<send> is called even when C<no> hosts are being pinged (the loop
461doesn't execute once). 758doesn't execute once).
462 759
463This is the general pattern when you "fan out" into multiple subrequests: 760This is the general pattern when you "fan out" into multiple (but
464use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 761potentially none) subrequests: use an outer C<begin>/C<end> pair to set
465is called at least once, and then, for each subrequest you start, call 762the callback and ensure C<end> is called at least once, and then, for each
466C<begin> and for each subrequest you finish, call C<end>. 763subrequest you start, call C<begin> and for each subrequest you finish,
764call C<end>.
467 765
468=back 766=back
469 767
470=head3 METHODS FOR CONSUMERS 768=head3 METHODS FOR CONSUMERS
471 769
487function will call C<croak>. 785function will call C<croak>.
488 786
489In list context, all parameters passed to C<send> will be returned, 787In list context, all parameters passed to C<send> will be returned,
490in scalar context only the first one will be returned. 788in scalar context only the first one will be returned.
491 789
790Note that doing a blocking wait in a callback is not supported by any
791event loop, that is, recursive invocation of a blocking C<< ->recv
792>> is not allowed, and the C<recv> call will C<croak> if such a
793condition is detected. This condition can be slightly loosened by using
794L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
795any thread that doesn't run the event loop itself.
796
492Not all event models support a blocking wait - some die in that case 797Not all event models support a blocking wait - some die in that case
493(programs might want to do that to stay interactive), so I<if you are 798(programs might want to do that to stay interactive), so I<if you are
494using this from a module, never require a blocking wait>, but let the 799using this from a module, never require a blocking wait>. Instead, let the
495caller decide whether the call will block or not (for example, by coupling 800caller decide whether the call will block or not (for example, by coupling
496condition variables with some kind of request results and supporting 801condition variables with some kind of request results and supporting
497callbacks so the caller knows that getting the result will not block, 802callbacks so the caller knows that getting the result will not block,
498while still supporting blocking waits if the caller so desires). 803while still supporting blocking waits if the caller so desires).
499 804
500Another reason I<never> to C<< ->recv >> in a module is that you cannot
501sensibly have two C<< ->recv >>'s in parallel, as that would require
502multiple interpreters or coroutines/threads, none of which C<AnyEvent>
503can supply.
504
505The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
506fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
507versions and also integrates coroutines into AnyEvent, making blocking
508C<< ->recv >> calls perfectly safe as long as they are done from another
509coroutine (one that doesn't run the event loop).
510
511You can ensure that C<< -recv >> never blocks by setting a callback and 805You can ensure that C<< -recv >> never blocks by setting a callback and
512only calling C<< ->recv >> from within that callback (or at a later 806only calling C<< ->recv >> from within that callback (or at a later
513time). This will work even when the event loop does not support blocking 807time). This will work even when the event loop does not support blocking
514waits otherwise. 808waits otherwise.
515 809
516=item $bool = $cv->ready 810=item $bool = $cv->ready
517 811
518Returns true when the condition is "true", i.e. whether C<send> or 812Returns true when the condition is "true", i.e. whether C<send> or
519C<croak> have been called. 813C<croak> have been called.
520 814
521=item $cb = $cv->cb ([new callback]) 815=item $cb = $cv->cb ($cb->($cv))
522 816
523This is a mutator function that returns the callback set and optionally 817This is a mutator function that returns the callback set and optionally
524replaces it before doing so. 818replaces it before doing so.
525 819
526The callback will be called when the condition becomes "true", i.e. when 820The callback will be called when the condition becomes (or already was)
527C<send> or C<croak> are called. Calling C<recv> inside the callback 821"true", i.e. when C<send> or C<croak> are called (or were called), with
822the only argument being the condition variable itself. Calling C<recv>
528or at any later time is guaranteed not to block. 823inside the callback or at any later time is guaranteed not to block.
529 824
530=back 825=back
531 826
827=head1 SUPPORTED EVENT LOOPS/BACKENDS
828
829The available backend classes are (every class has its own manpage):
830
831=over 4
832
833=item Backends that are autoprobed when no other event loop can be found.
834
835EV is the preferred backend when no other event loop seems to be in
836use. If EV is not installed, then AnyEvent will fall back to its own
837pure-perl implementation, which is available everywhere as it comes with
838AnyEvent itself.
839
840 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
841 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
842
843=item Backends that are transparently being picked up when they are used.
844
845These will be used when they are currently loaded when the first watcher
846is created, in which case it is assumed that the application is using
847them. This means that AnyEvent will automatically pick the right backend
848when the main program loads an event module before anything starts to
849create watchers. Nothing special needs to be done by the main program.
850
851 AnyEvent::Impl::Event based on Event, very stable, few glitches.
852 AnyEvent::Impl::Glib based on Glib, slow but very stable.
853 AnyEvent::Impl::Tk based on Tk, very broken.
854 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
855 AnyEvent::Impl::POE based on POE, very slow, some limitations.
856 AnyEvent::Impl::Irssi used when running within irssi.
857
858=item Backends with special needs.
859
860Qt requires the Qt::Application to be instantiated first, but will
861otherwise be picked up automatically. As long as the main program
862instantiates the application before any AnyEvent watchers are created,
863everything should just work.
864
865 AnyEvent::Impl::Qt based on Qt.
866
867Support for IO::Async can only be partial, as it is too broken and
868architecturally limited to even support the AnyEvent API. It also
869is the only event loop that needs the loop to be set explicitly, so
870it can only be used by a main program knowing about AnyEvent. See
871L<AnyEvent::Impl::Async> for the gory details.
872
873 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
874
875=item Event loops that are indirectly supported via other backends.
876
877Some event loops can be supported via other modules:
878
879There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
880
881B<WxWidgets> has no support for watching file handles. However, you can
882use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
883polls 20 times per second, which was considered to be too horrible to even
884consider for AnyEvent.
885
886B<Prima> is not supported as nobody seems to be using it, but it has a POE
887backend, so it can be supported through POE.
888
889AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
890load L<POE> when detecting them, in the hope that POE will pick them up,
891in which case everything will be automatic.
892
893=back
894
532=head1 GLOBAL VARIABLES AND FUNCTIONS 895=head1 GLOBAL VARIABLES AND FUNCTIONS
533 896
897These are not normally required to use AnyEvent, but can be useful to
898write AnyEvent extension modules.
899
534=over 4 900=over 4
535 901
536=item $AnyEvent::MODEL 902=item $AnyEvent::MODEL
537 903
538Contains C<undef> until the first watcher is being created. Then it 904Contains C<undef> until the first watcher is being created, before the
905backend has been autodetected.
906
539contains the event model that is being used, which is the name of the 907Afterwards it contains the event model that is being used, which is the
540Perl class implementing the model. This class is usually one of the 908name of the Perl class implementing the model. This class is usually one
541C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 909of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
542AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 910case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
543 911will be C<urxvt::anyevent>).
544The known classes so far are:
545
546 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
547 AnyEvent::Impl::Event based on Event, second best choice.
548 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
549 AnyEvent::Impl::Glib based on Glib, third-best choice.
550 AnyEvent::Impl::Tk based on Tk, very bad choice.
551 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
552 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
553 AnyEvent::Impl::POE based on POE, not generic enough for full support.
554
555There is no support for WxWidgets, as WxWidgets has no support for
556watching file handles. However, you can use WxWidgets through the
557POE Adaptor, as POE has a Wx backend that simply polls 20 times per
558second, which was considered to be too horrible to even consider for
559AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
560it's adaptor.
561
562AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
563autodetecting them.
564 912
565=item AnyEvent::detect 913=item AnyEvent::detect
566 914
567Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 915Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
568if necessary. You should only call this function right before you would 916if necessary. You should only call this function right before you would
569have created an AnyEvent watcher anyway, that is, as late as possible at 917have created an AnyEvent watcher anyway, that is, as late as possible at
570runtime. 918runtime, and not e.g. while initialising of your module.
919
920If you need to do some initialisation before AnyEvent watchers are
921created, use C<post_detect>.
571 922
572=item $guard = AnyEvent::post_detect { BLOCK } 923=item $guard = AnyEvent::post_detect { BLOCK }
573 924
574Arranges for the code block to be executed as soon as the event model is 925Arranges for the code block to be executed as soon as the event model is
575autodetected (or immediately if this has already happened). 926autodetected (or immediately if this has already happened).
576 927
928The block will be executed I<after> the actual backend has been detected
929(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
930created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
931other initialisations - see the sources of L<AnyEvent::Strict> or
932L<AnyEvent::AIO> to see how this is used.
933
934The most common usage is to create some global watchers, without forcing
935event module detection too early, for example, L<AnyEvent::AIO> creates
936and installs the global L<IO::AIO> watcher in a C<post_detect> block to
937avoid autodetecting the event module at load time.
938
577If called in scalar or list context, then it creates and returns an object 939If called in scalar or list context, then it creates and returns an object
578that automatically removes the callback again when it is destroyed. See 940that automatically removes the callback again when it is destroyed (or
941C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
579L<Coro::BDB> for a case where this is useful. 942a case where this is useful.
943
944Example: Create a watcher for the IO::AIO module and store it in
945C<$WATCHER>. Only do so after the event loop is initialised, though.
946
947 our WATCHER;
948
949 my $guard = AnyEvent::post_detect {
950 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
951 };
952
953 # the ||= is important in case post_detect immediately runs the block,
954 # as to not clobber the newly-created watcher. assigning both watcher and
955 # post_detect guard to the same variable has the advantage of users being
956 # able to just C<undef $WATCHER> if the watcher causes them grief.
957
958 $WATCHER ||= $guard;
580 959
581=item @AnyEvent::post_detect 960=item @AnyEvent::post_detect
582 961
583If there are any code references in this array (you can C<push> to it 962If there are any code references in this array (you can C<push> to it
584before or after loading AnyEvent), then they will called directly after 963before or after loading AnyEvent), then they will called directly after
585the event loop has been chosen. 964the event loop has been chosen.
586 965
587You should check C<$AnyEvent::MODEL> before adding to this array, though: 966You should check C<$AnyEvent::MODEL> before adding to this array, though:
588if it contains a true value then the event loop has already been detected, 967if it is defined then the event loop has already been detected, and the
589and the array will be ignored. 968array will be ignored.
590 969
591Best use C<AnyEvent::post_detect { BLOCK }> instead. 970Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
971it,as it takes care of these details.
972
973This variable is mainly useful for modules that can do something useful
974when AnyEvent is used and thus want to know when it is initialised, but do
975not need to even load it by default. This array provides the means to hook
976into AnyEvent passively, without loading it.
592 977
593=back 978=back
594 979
595=head1 WHAT TO DO IN A MODULE 980=head1 WHAT TO DO IN A MODULE
596 981
651 1036
652 1037
653=head1 OTHER MODULES 1038=head1 OTHER MODULES
654 1039
655The following is a non-exhaustive list of additional modules that use 1040The following is a non-exhaustive list of additional modules that use
656AnyEvent and can therefore be mixed easily with other AnyEvent modules 1041AnyEvent as a client and can therefore be mixed easily with other AnyEvent
657in the same program. Some of the modules come with AnyEvent, some are 1042modules and other event loops in the same program. Some of the modules
658available via CPAN. 1043come with AnyEvent, most are available via CPAN.
659 1044
660=over 4 1045=over 4
661 1046
662=item L<AnyEvent::Util> 1047=item L<AnyEvent::Util>
663 1048
664Contains various utility functions that replace often-used but blocking 1049Contains various utility functions that replace often-used but blocking
665functions such as C<inet_aton> by event-/callback-based versions. 1050functions such as C<inet_aton> by event-/callback-based versions.
666
667=item L<AnyEvent::Handle>
668
669Provide read and write buffers and manages watchers for reads and writes.
670 1051
671=item L<AnyEvent::Socket> 1052=item L<AnyEvent::Socket>
672 1053
673Provides various utility functions for (internet protocol) sockets, 1054Provides various utility functions for (internet protocol) sockets,
674addresses and name resolution. Also functions to create non-blocking tcp 1055addresses and name resolution. Also functions to create non-blocking tcp
675connections or tcp servers, with IPv6 and SRV record support and more. 1056connections or tcp servers, with IPv6 and SRV record support and more.
676 1057
1058=item L<AnyEvent::Handle>
1059
1060Provide read and write buffers, manages watchers for reads and writes,
1061supports raw and formatted I/O, I/O queued and fully transparent and
1062non-blocking SSL/TLS (via L<AnyEvent::TLS>.
1063
677=item L<AnyEvent::DNS> 1064=item L<AnyEvent::DNS>
678 1065
679Provides rich asynchronous DNS resolver capabilities. 1066Provides rich asynchronous DNS resolver capabilities.
680 1067
1068=item L<AnyEvent::HTTP>
1069
1070A simple-to-use HTTP library that is capable of making a lot of concurrent
1071HTTP requests.
1072
681=item L<AnyEvent::HTTPD> 1073=item L<AnyEvent::HTTPD>
682 1074
683Provides a simple web application server framework. 1075Provides a simple web application server framework.
684 1076
685=item L<AnyEvent::FastPing> 1077=item L<AnyEvent::FastPing>
686 1078
687The fastest ping in the west. 1079The fastest ping in the west.
688 1080
1081=item L<AnyEvent::DBI>
1082
1083Executes L<DBI> requests asynchronously in a proxy process.
1084
1085=item L<AnyEvent::AIO>
1086
1087Truly asynchronous I/O, should be in the toolbox of every event
1088programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
1089together.
1090
1091=item L<AnyEvent::BDB>
1092
1093Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
1094L<BDB> and AnyEvent together.
1095
1096=item L<AnyEvent::GPSD>
1097
1098A non-blocking interface to gpsd, a daemon delivering GPS information.
1099
689=item L<Net::IRC3> 1100=item L<AnyEvent::IRC>
690 1101
691AnyEvent based IRC client module family. 1102AnyEvent based IRC client module family (replacing the older Net::IRC3).
692 1103
693=item L<Net::XMPP2> 1104=item L<AnyEvent::XMPP>
694 1105
695AnyEvent based XMPP (Jabber protocol) module family. 1106AnyEvent based XMPP (Jabber protocol) module family (replacing the older
1107Net::XMPP2>.
1108
1109=item L<AnyEvent::IGS>
1110
1111A non-blocking interface to the Internet Go Server protocol (used by
1112L<App::IGS>).
696 1113
697=item L<Net::FCP> 1114=item L<Net::FCP>
698 1115
699AnyEvent-based implementation of the Freenet Client Protocol, birthplace 1116AnyEvent-based implementation of the Freenet Client Protocol, birthplace
700of AnyEvent. 1117of AnyEvent.
705 1122
706=item L<Coro> 1123=item L<Coro>
707 1124
708Has special support for AnyEvent via L<Coro::AnyEvent>. 1125Has special support for AnyEvent via L<Coro::AnyEvent>.
709 1126
710=item L<AnyEvent::AIO>, L<IO::AIO>
711
712Truly asynchronous I/O, should be in the toolbox of every event
713programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
714together.
715
716=item L<AnyEvent::BDB>, L<BDB>
717
718Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
719IO::AIO and AnyEvent together.
720
721=item L<IO::Lambda>
722
723The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
724
725=back 1127=back
726 1128
727=cut 1129=cut
728 1130
729package AnyEvent; 1131package AnyEvent;
730 1132
731no warnings; 1133# basically a tuned-down version of common::sense
732use strict; 1134sub common_sense {
1135 # from common:.sense 1.0
1136 ${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1137 # use strict vars subs
1138 $^H |= 0x00000600;
1139}
733 1140
1141BEGIN { AnyEvent::common_sense }
1142
734use Carp; 1143use Carp ();
735 1144
736our $VERSION = '4.03'; 1145our $VERSION = '5.21';
737our $MODEL; 1146our $MODEL;
738 1147
739our $AUTOLOAD; 1148our $AUTOLOAD;
740our @ISA; 1149our @ISA;
741 1150
742our @REGISTRY; 1151our @REGISTRY;
743 1152
1153our $VERBOSE;
1154
1155BEGIN {
1156 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1157 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
1158
1159 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1160 if ${^TAINT};
1161
744our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1162 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1163
1164}
1165
1166our $MAX_SIGNAL_LATENCY = 10;
745 1167
746our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1168our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
747 1169
748{ 1170{
749 my $idx; 1171 my $idx;
751 for reverse split /\s*,\s*/, 1173 for reverse split /\s*,\s*/,
752 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1174 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
753} 1175}
754 1176
755my @models = ( 1177my @models = (
756 [EV:: => AnyEvent::Impl::EV::], 1178 [EV:: => AnyEvent::Impl::EV:: , 1],
757 [Event:: => AnyEvent::Impl::Event::],
758 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1179 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
759 # everything below here will not be autoprobed 1180 # everything below here will not (normally) be autoprobed
760 # as the pureperl backend should work everywhere 1181 # as the pureperl backend should work everywhere
761 # and is usually faster 1182 # and is usually faster
1183 [Event:: => AnyEvent::Impl::Event::, 1],
1184 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1185 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1186 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
762 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1187 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
763 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
764 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
765 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1188 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
766 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1189 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
767 [Wx:: => AnyEvent::Impl::POE::], 1190 [Wx:: => AnyEvent::Impl::POE::],
768 [Prima:: => AnyEvent::Impl::POE::], 1191 [Prima:: => AnyEvent::Impl::POE::],
1192 # IO::Async is just too broken - we would need workarounds for its
1193 # byzantine signal and broken child handling, among others.
1194 # IO::Async is rather hard to detect, as it doesn't have any
1195 # obvious default class.
1196 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1197 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1198 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1199 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
769); 1200);
770 1201
771our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 1202our %method = map +($_ => 1),
1203 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
772 1204
773our @post_detect; 1205our @post_detect;
774 1206
775sub post_detect(&) { 1207sub post_detect(&) {
776 my ($cb) = @_; 1208 my ($cb) = @_;
777 1209
778 if ($MODEL) { 1210 if ($MODEL) {
779 $cb->(); 1211 $cb->();
780 1212
781 1 1213 undef
782 } else { 1214 } else {
783 push @post_detect, $cb; 1215 push @post_detect, $cb;
784 1216
785 defined wantarray 1217 defined wantarray
786 ? bless \$cb, "AnyEvent::Util::PostDetect" 1218 ? bless \$cb, "AnyEvent::Util::postdetect"
787 : () 1219 : ()
788 } 1220 }
789} 1221}
790 1222
791sub AnyEvent::Util::PostDetect::DESTROY { 1223sub AnyEvent::Util::postdetect::DESTROY {
792 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1224 @post_detect = grep $_ != ${$_[0]}, @post_detect;
793} 1225}
794 1226
795sub detect() { 1227sub detect() {
796 unless ($MODEL) { 1228 unless ($MODEL) {
797 no strict 'refs';
798 local $SIG{__DIE__}; 1229 local $SIG{__DIE__};
799 1230
800 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1231 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
801 my $model = "AnyEvent::Impl::$1"; 1232 my $model = "AnyEvent::Impl::$1";
802 if (eval "require $model") { 1233 if (eval "require $model") {
803 $MODEL = $model; 1234 $MODEL = $model;
804 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1235 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
805 } else { 1236 } else {
806 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1237 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
807 } 1238 }
808 } 1239 }
809 1240
810 # check for already loaded models 1241 # check for already loaded models
811 unless ($MODEL) { 1242 unless ($MODEL) {
812 for (@REGISTRY, @models) { 1243 for (@REGISTRY, @models) {
813 my ($package, $model) = @$_; 1244 my ($package, $model) = @$_;
814 if (${"$package\::VERSION"} > 0) { 1245 if (${"$package\::VERSION"} > 0) {
815 if (eval "require $model") { 1246 if (eval "require $model") {
816 $MODEL = $model; 1247 $MODEL = $model;
817 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1248 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
818 last; 1249 last;
819 } 1250 }
820 } 1251 }
821 } 1252 }
822 1253
823 unless ($MODEL) { 1254 unless ($MODEL) {
824 # try to load a model 1255 # try to autoload a model
825
826 for (@REGISTRY, @models) { 1256 for (@REGISTRY, @models) {
827 my ($package, $model) = @$_; 1257 my ($package, $model, $autoload) = @$_;
1258 if (
1259 $autoload
828 if (eval "require $package" 1260 and eval "require $package"
829 and ${"$package\::VERSION"} > 0 1261 and ${"$package\::VERSION"} > 0
830 and eval "require $model") { 1262 and eval "require $model"
1263 ) {
831 $MODEL = $model; 1264 $MODEL = $model;
832 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1265 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
833 last; 1266 last;
834 } 1267 }
835 } 1268 }
836 1269
837 $MODEL 1270 $MODEL
838 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1271 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
839 } 1272 }
840 } 1273 }
841 1274
1275 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1276
842 unshift @ISA, $MODEL; 1277 unshift @ISA, $MODEL;
843 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1278
1279 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
844 1280
845 (shift @post_detect)->() while @post_detect; 1281 (shift @post_detect)->() while @post_detect;
846 } 1282 }
847 1283
848 $MODEL 1284 $MODEL
850 1286
851sub AUTOLOAD { 1287sub AUTOLOAD {
852 (my $func = $AUTOLOAD) =~ s/.*://; 1288 (my $func = $AUTOLOAD) =~ s/.*://;
853 1289
854 $method{$func} 1290 $method{$func}
855 or croak "$func: not a valid method for AnyEvent objects"; 1291 or Carp::croak "$func: not a valid method for AnyEvent objects";
856 1292
857 detect unless $MODEL; 1293 detect unless $MODEL;
858 1294
859 my $class = shift; 1295 my $class = shift;
860 $class->$func (@_); 1296 $class->$func (@_);
861} 1297}
862 1298
1299# utility function to dup a filehandle. this is used by many backends
1300# to support binding more than one watcher per filehandle (they usually
1301# allow only one watcher per fd, so we dup it to get a different one).
1302sub _dupfh($$;$$) {
1303 my ($poll, $fh, $r, $w) = @_;
1304
1305 # cygwin requires the fh mode to be matching, unix doesn't
1306 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1307
1308 open my $fh2, $mode, $fh
1309 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1310
1311 # we assume CLOEXEC is already set by perl in all important cases
1312
1313 ($fh2, $rw)
1314}
1315
1316=head1 SIMPLIFIED AE API
1317
1318Starting with version 5.0, AnyEvent officially supports a second, much
1319simpler, API that is designed to reduce the calling, typing and memory
1320overhead.
1321
1322See the L<AE> manpage for details.
1323
1324=cut
1325
1326package AE;
1327
1328our $VERSION = $AnyEvent::VERSION;
1329
1330sub io($$$) {
1331 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1332}
1333
1334sub timer($$$) {
1335 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1336}
1337
1338sub signal($$) {
1339 AnyEvent->signal (signal => $_[0], cb => $_[1])
1340}
1341
1342sub child($$) {
1343 AnyEvent->child (pid => $_[0], cb => $_[1])
1344}
1345
1346sub idle($) {
1347 AnyEvent->idle (cb => $_[0])
1348}
1349
1350sub cv(;&) {
1351 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1352}
1353
1354sub now() {
1355 AnyEvent->now
1356}
1357
1358sub now_update() {
1359 AnyEvent->now_update
1360}
1361
1362sub time() {
1363 AnyEvent->time
1364}
1365
863package AnyEvent::Base; 1366package AnyEvent::Base;
864 1367
1368# default implementations for many methods
1369
1370sub _time() {
1371 # probe for availability of Time::HiRes
1372 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1373 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1374 *_time = \&Time::HiRes::time;
1375 # if (eval "use POSIX (); (POSIX::times())...
1376 } else {
1377 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1378 *_time = sub { time }; # epic fail
1379 }
1380
1381 &_time
1382}
1383
1384sub time { _time }
1385sub now { _time }
1386sub now_update { }
1387
865# default implementation for ->condvar 1388# default implementation for ->condvar
866 1389
867sub condvar { 1390sub condvar {
868 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1391 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
869} 1392}
870 1393
871# default implementation for ->signal 1394# default implementation for ->signal
872 1395
873our %SIG_CB; 1396our $HAVE_ASYNC_INTERRUPT;
1397
1398sub _have_async_interrupt() {
1399 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1400 && eval "use Async::Interrupt 1.02 (); 1")
1401 unless defined $HAVE_ASYNC_INTERRUPT;
1402
1403 $HAVE_ASYNC_INTERRUPT
1404}
1405
1406our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1407our (%SIG_ASY, %SIG_ASY_W);
1408our ($SIG_COUNT, $SIG_TW);
1409
1410sub _signal_exec {
1411 $HAVE_ASYNC_INTERRUPT
1412 ? $SIGPIPE_R->drain
1413 : sysread $SIGPIPE_R, (my $dummy), 9;
1414
1415 while (%SIG_EV) {
1416 for (keys %SIG_EV) {
1417 delete $SIG_EV{$_};
1418 $_->() for values %{ $SIG_CB{$_} || {} };
1419 }
1420 }
1421}
1422
1423# install a dummy wakeup watcher to reduce signal catching latency
1424sub _sig_add() {
1425 unless ($SIG_COUNT++) {
1426 # try to align timer on a full-second boundary, if possible
1427 my $NOW = AE::now;
1428
1429 $SIG_TW = AE::timer
1430 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1431 $MAX_SIGNAL_LATENCY,
1432 sub { } # just for the PERL_ASYNC_CHECK
1433 ;
1434 }
1435}
1436
1437sub _sig_del {
1438 undef $SIG_TW
1439 unless --$SIG_COUNT;
1440}
1441
1442our $_sig_name_init; $_sig_name_init = sub {
1443 eval q{ # poor man's autoloading
1444 undef $_sig_name_init;
1445
1446 if (_have_async_interrupt) {
1447 *sig2num = \&Async::Interrupt::sig2num;
1448 *sig2name = \&Async::Interrupt::sig2name;
1449 } else {
1450 require Config;
1451
1452 my %signame2num;
1453 @signame2num{ split ' ', $Config::Config{sig_name} }
1454 = split ' ', $Config::Config{sig_num};
1455
1456 my @signum2name;
1457 @signum2name[values %signame2num] = keys %signame2num;
1458
1459 *sig2num = sub($) {
1460 $_[0] > 0 ? shift : $signame2num{+shift}
1461 };
1462 *sig2name = sub ($) {
1463 $_[0] > 0 ? $signum2name[+shift] : shift
1464 };
1465 }
1466 };
1467 die if $@;
1468};
1469
1470sub sig2num ($) { &$_sig_name_init; &sig2num }
1471sub sig2name($) { &$_sig_name_init; &sig2name }
874 1472
875sub signal { 1473sub signal {
1474 eval q{ # poor man's autoloading {}
1475 # probe for availability of Async::Interrupt
1476 if (_have_async_interrupt) {
1477 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1478
1479 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1480 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1481
1482 } else {
1483 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1484
1485 require Fcntl;
1486
1487 if (AnyEvent::WIN32) {
1488 require AnyEvent::Util;
1489
1490 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1491 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1492 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1493 } else {
1494 pipe $SIGPIPE_R, $SIGPIPE_W;
1495 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1496 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1497
1498 # not strictly required, as $^F is normally 2, but let's make sure...
1499 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1500 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1501 }
1502
1503 $SIGPIPE_R
1504 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1505
1506 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1507 }
1508
1509 *signal = sub {
876 my (undef, %arg) = @_; 1510 my (undef, %arg) = @_;
877 1511
878 my $signal = uc $arg{signal} 1512 my $signal = uc $arg{signal}
879 or Carp::croak "required option 'signal' is missing"; 1513 or Carp::croak "required option 'signal' is missing";
880 1514
1515 if ($HAVE_ASYNC_INTERRUPT) {
1516 # async::interrupt
1517
1518 $signal = sig2num $signal;
881 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1519 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1520
1521 $SIG_ASY{$signal} ||= new Async::Interrupt
1522 cb => sub { undef $SIG_EV{$signal} },
1523 signal => $signal,
1524 pipe => [$SIGPIPE_R->filenos],
1525 pipe_autodrain => 0,
1526 ;
1527
1528 } else {
1529 # pure perl
1530
1531 # AE::Util has been loaded in signal
1532 $signal = sig2name $signal;
1533 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1534
882 $SIG{$signal} ||= sub { 1535 $SIG{$signal} ||= sub {
883 $_->() for values %{ $SIG_CB{$signal} || {} }; 1536 local $!;
1537 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1538 undef $SIG_EV{$signal};
1539 };
1540
1541 # can't do signal processing without introducing races in pure perl,
1542 # so limit the signal latency.
1543 _sig_add;
1544 }
1545
1546 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1547 };
1548
1549 *AnyEvent::Base::signal::DESTROY = sub {
1550 my ($signal, $cb) = @{$_[0]};
1551
1552 _sig_del;
1553
1554 delete $SIG_CB{$signal}{$cb};
1555
1556 $HAVE_ASYNC_INTERRUPT
1557 ? delete $SIG_ASY{$signal}
1558 : # delete doesn't work with older perls - they then
1559 # print weird messages, or just unconditionally exit
1560 # instead of getting the default action.
1561 undef $SIG{$signal}
1562 unless keys %{ $SIG_CB{$signal} };
1563 };
884 }; 1564 };
885 1565 die if $@;
886 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1566 &signal
887}
888
889sub AnyEvent::Base::Signal::DESTROY {
890 my ($signal, $cb) = @{$_[0]};
891
892 delete $SIG_CB{$signal}{$cb};
893
894 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
895} 1567}
896 1568
897# default implementation for ->child 1569# default implementation for ->child
898 1570
899our %PID_CB; 1571our %PID_CB;
900our $CHLD_W; 1572our $CHLD_W;
901our $CHLD_DELAY_W; 1573our $CHLD_DELAY_W;
902our $PID_IDLE;
903our $WNOHANG; 1574our $WNOHANG;
904 1575
905sub _child_wait { 1576sub _emit_childstatus($$) {
906 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1577 my (undef, $rpid, $rstatus) = @_;
1578
1579 $_->($rpid, $rstatus)
907 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1580 for values %{ $PID_CB{$rpid} || {} },
908 (values %{ $PID_CB{0} || {} }); 1581 values %{ $PID_CB{0} || {} };
909 }
910
911 undef $PID_IDLE;
912} 1582}
913 1583
914sub _sigchld { 1584sub _sigchld {
915 # make sure we deliver these changes "synchronous" with the event loop. 1585 my $pid;
916 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { 1586
917 undef $CHLD_DELAY_W; 1587 AnyEvent->_emit_childstatus ($pid, $?)
918 &_child_wait; 1588 while ($pid = waitpid -1, $WNOHANG) > 0;
919 });
920} 1589}
921 1590
922sub child { 1591sub child {
923 my (undef, %arg) = @_; 1592 my (undef, %arg) = @_;
924 1593
925 defined (my $pid = $arg{pid} + 0) 1594 defined (my $pid = $arg{pid} + 0)
926 or Carp::croak "required option 'pid' is missing"; 1595 or Carp::croak "required option 'pid' is missing";
927 1596
928 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1597 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
929 1598
930 unless ($WNOHANG) { 1599 # WNOHANG is almost cetrainly 1 everywhere
1600 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1601 ? 1
931 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1602 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
932 }
933 1603
934 unless ($CHLD_W) { 1604 unless ($CHLD_W) {
935 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1605 $CHLD_W = AE::signal CHLD => \&_sigchld;
936 # child could be a zombie already, so make at least one round 1606 # child could be a zombie already, so make at least one round
937 &_sigchld; 1607 &_sigchld;
938 } 1608 }
939 1609
940 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1610 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
941} 1611}
942 1612
943sub AnyEvent::Base::Child::DESTROY { 1613sub AnyEvent::Base::child::DESTROY {
944 my ($pid, $cb) = @{$_[0]}; 1614 my ($pid, $cb) = @{$_[0]};
945 1615
946 delete $PID_CB{$pid}{$cb}; 1616 delete $PID_CB{$pid}{$cb};
947 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1617 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
948 1618
949 undef $CHLD_W unless keys %PID_CB; 1619 undef $CHLD_W unless keys %PID_CB;
950} 1620}
951 1621
1622# idle emulation is done by simply using a timer, regardless
1623# of whether the process is idle or not, and not letting
1624# the callback use more than 50% of the time.
1625sub idle {
1626 my (undef, %arg) = @_;
1627
1628 my ($cb, $w, $rcb) = $arg{cb};
1629
1630 $rcb = sub {
1631 if ($cb) {
1632 $w = _time;
1633 &$cb;
1634 $w = _time - $w;
1635
1636 # never use more then 50% of the time for the idle watcher,
1637 # within some limits
1638 $w = 0.0001 if $w < 0.0001;
1639 $w = 5 if $w > 5;
1640
1641 $w = AE::timer $w, 0, $rcb;
1642 } else {
1643 # clean up...
1644 undef $w;
1645 undef $rcb;
1646 }
1647 };
1648
1649 $w = AE::timer 0.05, 0, $rcb;
1650
1651 bless \\$cb, "AnyEvent::Base::idle"
1652}
1653
1654sub AnyEvent::Base::idle::DESTROY {
1655 undef $${$_[0]};
1656}
1657
952package AnyEvent::CondVar; 1658package AnyEvent::CondVar;
953 1659
954our @ISA = AnyEvent::CondVar::Base::; 1660our @ISA = AnyEvent::CondVar::Base::;
955 1661
956package AnyEvent::CondVar::Base; 1662package AnyEvent::CondVar::Base;
957 1663
958use overload 1664#use overload
959 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1665# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
960 fallback => 1; 1666# fallback => 1;
1667
1668# save 300+ kilobytes by dirtily hardcoding overloading
1669${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1670*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1671*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1672${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1673
1674our $WAITING;
961 1675
962sub _send { 1676sub _send {
963 # nop 1677 # nop
964} 1678}
965 1679
978sub ready { 1692sub ready {
979 $_[0]{_ae_sent} 1693 $_[0]{_ae_sent}
980} 1694}
981 1695
982sub _wait { 1696sub _wait {
1697 $WAITING
1698 and !$_[0]{_ae_sent}
1699 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1700
1701 local $WAITING = 1;
983 AnyEvent->one_event while !$_[0]{_ae_sent}; 1702 AnyEvent->one_event while !$_[0]{_ae_sent};
984} 1703}
985 1704
986sub recv { 1705sub recv {
987 $_[0]->_wait; 1706 $_[0]->_wait;
989 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1708 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
990 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1709 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
991} 1710}
992 1711
993sub cb { 1712sub cb {
994 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1713 my $cv = shift;
1714
1715 @_
1716 and $cv->{_ae_cb} = shift
1717 and $cv->{_ae_sent}
1718 and (delete $cv->{_ae_cb})->($cv);
1719
995 $_[0]{_ae_cb} 1720 $cv->{_ae_cb}
996} 1721}
997 1722
998sub begin { 1723sub begin {
999 ++$_[0]{_ae_counter}; 1724 ++$_[0]{_ae_counter};
1000 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1725 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1006} 1731}
1007 1732
1008# undocumented/compatibility with pre-3.4 1733# undocumented/compatibility with pre-3.4
1009*broadcast = \&send; 1734*broadcast = \&send;
1010*wait = \&_wait; 1735*wait = \&_wait;
1736
1737=head1 ERROR AND EXCEPTION HANDLING
1738
1739In general, AnyEvent does not do any error handling - it relies on the
1740caller to do that if required. The L<AnyEvent::Strict> module (see also
1741the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1742checking of all AnyEvent methods, however, which is highly useful during
1743development.
1744
1745As for exception handling (i.e. runtime errors and exceptions thrown while
1746executing a callback), this is not only highly event-loop specific, but
1747also not in any way wrapped by this module, as this is the job of the main
1748program.
1749
1750The pure perl event loop simply re-throws the exception (usually
1751within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1752$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1753so on.
1754
1755=head1 ENVIRONMENT VARIABLES
1756
1757The following environment variables are used by this module or its
1758submodules.
1759
1760Note that AnyEvent will remove I<all> environment variables starting with
1761C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1762enabled.
1763
1764=over 4
1765
1766=item C<PERL_ANYEVENT_VERBOSE>
1767
1768By default, AnyEvent will be completely silent except in fatal
1769conditions. You can set this environment variable to make AnyEvent more
1770talkative.
1771
1772When set to C<1> or higher, causes AnyEvent to warn about unexpected
1773conditions, such as not being able to load the event model specified by
1774C<PERL_ANYEVENT_MODEL>.
1775
1776When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1777model it chooses.
1778
1779When set to C<8> or higher, then AnyEvent will report extra information on
1780which optional modules it loads and how it implements certain features.
1781
1782=item C<PERL_ANYEVENT_STRICT>
1783
1784AnyEvent does not do much argument checking by default, as thorough
1785argument checking is very costly. Setting this variable to a true value
1786will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1787check the arguments passed to most method calls. If it finds any problems,
1788it will croak.
1789
1790In other words, enables "strict" mode.
1791
1792Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1793>>, it is definitely recommended to keep it off in production. Keeping
1794C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1795can be very useful, however.
1796
1797=item C<PERL_ANYEVENT_MODEL>
1798
1799This can be used to specify the event model to be used by AnyEvent, before
1800auto detection and -probing kicks in. It must be a string consisting
1801entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1802and the resulting module name is loaded and if the load was successful,
1803used as event model. If it fails to load AnyEvent will proceed with
1804auto detection and -probing.
1805
1806This functionality might change in future versions.
1807
1808For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1809could start your program like this:
1810
1811 PERL_ANYEVENT_MODEL=Perl perl ...
1812
1813=item C<PERL_ANYEVENT_PROTOCOLS>
1814
1815Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1816for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1817of auto probing).
1818
1819Must be set to a comma-separated list of protocols or address families,
1820current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1821used, and preference will be given to protocols mentioned earlier in the
1822list.
1823
1824This variable can effectively be used for denial-of-service attacks
1825against local programs (e.g. when setuid), although the impact is likely
1826small, as the program has to handle conenction and other failures anyways.
1827
1828Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1829but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1830- only support IPv4, never try to resolve or contact IPv6
1831addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1832IPv6, but prefer IPv6 over IPv4.
1833
1834=item C<PERL_ANYEVENT_EDNS0>
1835
1836Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1837for DNS. This extension is generally useful to reduce DNS traffic, but
1838some (broken) firewalls drop such DNS packets, which is why it is off by
1839default.
1840
1841Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1842EDNS0 in its DNS requests.
1843
1844=item C<PERL_ANYEVENT_MAX_FORKS>
1845
1846The maximum number of child processes that C<AnyEvent::Util::fork_call>
1847will create in parallel.
1848
1849=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1850
1851The default value for the C<max_outstanding> parameter for the default DNS
1852resolver - this is the maximum number of parallel DNS requests that are
1853sent to the DNS server.
1854
1855=item C<PERL_ANYEVENT_RESOLV_CONF>
1856
1857The file to use instead of F</etc/resolv.conf> (or OS-specific
1858configuration) in the default resolver. When set to the empty string, no
1859default config will be used.
1860
1861=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1862
1863When neither C<ca_file> nor C<ca_path> was specified during
1864L<AnyEvent::TLS> context creation, and either of these environment
1865variables exist, they will be used to specify CA certificate locations
1866instead of a system-dependent default.
1867
1868=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1869
1870When these are set to C<1>, then the respective modules are not
1871loaded. Mostly good for testing AnyEvent itself.
1872
1873=back
1011 1874
1012=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1875=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1013 1876
1014This is an advanced topic that you do not normally need to use AnyEvent in 1877This is an advanced topic that you do not normally need to use AnyEvent in
1015a module. This section is only of use to event loop authors who want to 1878a module. This section is only of use to event loop authors who want to
1049 1912
1050I<rxvt-unicode> also cheats a bit by not providing blocking access to 1913I<rxvt-unicode> also cheats a bit by not providing blocking access to
1051condition variables: code blocking while waiting for a condition will 1914condition variables: code blocking while waiting for a condition will
1052C<die>. This still works with most modules/usages, and blocking calls must 1915C<die>. This still works with most modules/usages, and blocking calls must
1053not be done in an interactive application, so it makes sense. 1916not be done in an interactive application, so it makes sense.
1054
1055=head1 ENVIRONMENT VARIABLES
1056
1057The following environment variables are used by this module:
1058
1059=over 4
1060
1061=item C<PERL_ANYEVENT_VERBOSE>
1062
1063By default, AnyEvent will be completely silent except in fatal
1064conditions. You can set this environment variable to make AnyEvent more
1065talkative.
1066
1067When set to C<1> or higher, causes AnyEvent to warn about unexpected
1068conditions, such as not being able to load the event model specified by
1069C<PERL_ANYEVENT_MODEL>.
1070
1071When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1072model it chooses.
1073
1074=item C<PERL_ANYEVENT_MODEL>
1075
1076This can be used to specify the event model to be used by AnyEvent, before
1077auto detection and -probing kicks in. It must be a string consisting
1078entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1079and the resulting module name is loaded and if the load was successful,
1080used as event model. If it fails to load AnyEvent will proceed with
1081auto detection and -probing.
1082
1083This functionality might change in future versions.
1084
1085For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1086could start your program like this:
1087
1088 PERL_ANYEVENT_MODEL=Perl perl ...
1089
1090=item C<PERL_ANYEVENT_PROTOCOLS>
1091
1092Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1093for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1094of auto probing).
1095
1096Must be set to a comma-separated list of protocols or address families,
1097current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1098used, and preference will be given to protocols mentioned earlier in the
1099list.
1100
1101This variable can effectively be used for denial-of-service attacks
1102against local programs (e.g. when setuid), although the impact is likely
1103small, as the program has to handle connection errors already-
1104
1105Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1106but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1107- only support IPv4, never try to resolve or contact IPv6
1108addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1109IPv6, but prefer IPv6 over IPv4.
1110
1111=item C<PERL_ANYEVENT_EDNS0>
1112
1113Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1114for DNS. This extension is generally useful to reduce DNS traffic, but
1115some (broken) firewalls drop such DNS packets, which is why it is off by
1116default.
1117
1118Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1119EDNS0 in its DNS requests.
1120
1121=back
1122 1917
1123=head1 EXAMPLE PROGRAM 1918=head1 EXAMPLE PROGRAM
1124 1919
1125The following program uses an I/O watcher to read data from STDIN, a timer 1920The following program uses an I/O watcher to read data from STDIN, a timer
1126to display a message once per second, and a condition variable to quit the 1921to display a message once per second, and a condition variable to quit the
1139 warn "read: $input\n"; # output what has been read 1934 warn "read: $input\n"; # output what has been read
1140 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1935 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1141 }, 1936 },
1142 ); 1937 );
1143 1938
1144 my $time_watcher; # can only be used once
1145
1146 sub new_timer {
1147 $timer = AnyEvent->timer (after => 1, cb => sub { 1939 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1148 warn "timeout\n"; # print 'timeout' about every second 1940 warn "timeout\n"; # print 'timeout' at most every second
1149 &new_timer; # and restart the time
1150 }); 1941 });
1151 }
1152
1153 new_timer; # create first timer
1154 1942
1155 $cv->recv; # wait until user enters /^q/i 1943 $cv->recv; # wait until user enters /^q/i
1156 1944
1157=head1 REAL-WORLD EXAMPLE 1945=head1 REAL-WORLD EXAMPLE
1158 1946
1289through AnyEvent. The benchmark creates a lot of timers (with a zero 2077through AnyEvent. The benchmark creates a lot of timers (with a zero
1290timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2078timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1291which it is), lets them fire exactly once and destroys them again. 2079which it is), lets them fire exactly once and destroys them again.
1292 2080
1293Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2081Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1294distribution. 2082distribution. It uses the L<AE> interface, which makes a real difference
2083for the EV and Perl backends only.
1295 2084
1296=head3 Explanation of the columns 2085=head3 Explanation of the columns
1297 2086
1298I<watcher> is the number of event watchers created/destroyed. Since 2087I<watcher> is the number of event watchers created/destroyed. Since
1299different event models feature vastly different performances, each event 2088different event models feature vastly different performances, each event
1320watcher. 2109watcher.
1321 2110
1322=head3 Results 2111=head3 Results
1323 2112
1324 name watchers bytes create invoke destroy comment 2113 name watchers bytes create invoke destroy comment
1325 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 2114 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1326 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 2115 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1327 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 2116 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1328 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 2117 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1329 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 2118 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1330 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 2119 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2120 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2121 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1331 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 2122 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1332 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 2123 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1333 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 2124 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1334 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 2125 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1335 2126
1336=head3 Discussion 2127=head3 Discussion
1337 2128
1338The benchmark does I<not> measure scalability of the event loop very 2129The benchmark does I<not> measure scalability of the event loop very
1339well. For example, a select-based event loop (such as the pure perl one) 2130well. For example, a select-based event loop (such as the pure perl one)
1351benchmark machine, handling an event takes roughly 1600 CPU cycles with 2142benchmark machine, handling an event takes roughly 1600 CPU cycles with
1352EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2143EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1353cycles with POE. 2144cycles with POE.
1354 2145
1355C<EV> is the sole leader regarding speed and memory use, which are both 2146C<EV> is the sole leader regarding speed and memory use, which are both
1356maximal/minimal, respectively. Even when going through AnyEvent, it uses 2147maximal/minimal, respectively. When using the L<AE> API there is zero
2148overhead (when going through the AnyEvent API create is about 5-6 times
2149slower, with other times being equal, so still uses far less memory than
1357far less memory than any other event loop and is still faster than Event 2150any other event loop and is still faster than Event natively).
1358natively.
1359 2151
1360The pure perl implementation is hit in a few sweet spots (both the 2152The pure perl implementation is hit in a few sweet spots (both the
1361constant timeout and the use of a single fd hit optimisations in the perl 2153constant timeout and the use of a single fd hit optimisations in the perl
1362interpreter and the backend itself). Nevertheless this shows that it 2154interpreter and the backend itself). Nevertheless this shows that it
1363adds very little overhead in itself. Like any select-based backend its 2155adds very little overhead in itself. Like any select-based backend its
1364performance becomes really bad with lots of file descriptors (and few of 2156performance becomes really bad with lots of file descriptors (and few of
1365them active), of course, but this was not subject of this benchmark. 2157them active), of course, but this was not subject of this benchmark.
1366 2158
1367The C<Event> module has a relatively high setup and callback invocation 2159The C<Event> module has a relatively high setup and callback invocation
1368cost, but overall scores in on the third place. 2160cost, but overall scores in on the third place.
2161
2162C<IO::Async> performs admirably well, about on par with C<Event>, even
2163when using its pure perl backend.
1369 2164
1370C<Glib>'s memory usage is quite a bit higher, but it features a 2165C<Glib>'s memory usage is quite a bit higher, but it features a
1371faster callback invocation and overall ends up in the same class as 2166faster callback invocation and overall ends up in the same class as
1372C<Event>. However, Glib scales extremely badly, doubling the number of 2167C<Event>. However, Glib scales extremely badly, doubling the number of
1373watchers increases the processing time by more than a factor of four, 2168watchers increases the processing time by more than a factor of four,
1434In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2229In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1435(1%) are active. This mirrors the activity of large servers with many 2230(1%) are active. This mirrors the activity of large servers with many
1436connections, most of which are idle at any one point in time. 2231connections, most of which are idle at any one point in time.
1437 2232
1438Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2233Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1439distribution. 2234distribution. It uses the L<AE> interface, which makes a real difference
2235for the EV and Perl backends only.
1440 2236
1441=head3 Explanation of the columns 2237=head3 Explanation of the columns
1442 2238
1443I<sockets> is the number of sockets, and twice the number of "servers" (as 2239I<sockets> is the number of sockets, and twice the number of "servers" (as
1444each server has a read and write socket end). 2240each server has a read and write socket end).
1451it to another server. This includes deleting the old timeout and creating 2247it to another server. This includes deleting the old timeout and creating
1452a new one that moves the timeout into the future. 2248a new one that moves the timeout into the future.
1453 2249
1454=head3 Results 2250=head3 Results
1455 2251
1456 name sockets create request 2252 name sockets create request
1457 EV 20000 69.01 11.16 2253 EV 20000 62.66 7.99
1458 Perl 20000 73.32 35.87 2254 Perl 20000 68.32 32.64
1459 Event 20000 212.62 257.32 2255 IOAsync 20000 174.06 101.15 epoll
1460 Glib 20000 651.16 1896.30 2256 IOAsync 20000 174.67 610.84 poll
2257 Event 20000 202.69 242.91
2258 Glib 20000 557.01 1689.52
1461 POE 20000 349.67 12317.24 uses POE::Loop::Event 2259 POE 20000 341.54 12086.32 uses POE::Loop::Event
1462 2260
1463=head3 Discussion 2261=head3 Discussion
1464 2262
1465This benchmark I<does> measure scalability and overall performance of the 2263This benchmark I<does> measure scalability and overall performance of the
1466particular event loop. 2264particular event loop.
1468EV is again fastest. Since it is using epoll on my system, the setup time 2266EV is again fastest. Since it is using epoll on my system, the setup time
1469is relatively high, though. 2267is relatively high, though.
1470 2268
1471Perl surprisingly comes second. It is much faster than the C-based event 2269Perl surprisingly comes second. It is much faster than the C-based event
1472loops Event and Glib. 2270loops Event and Glib.
2271
2272IO::Async performs very well when using its epoll backend, and still quite
2273good compared to Glib when using its pure perl backend.
1473 2274
1474Event suffers from high setup time as well (look at its code and you will 2275Event suffers from high setup time as well (look at its code and you will
1475understand why). Callback invocation also has a high overhead compared to 2276understand why). Callback invocation also has a high overhead compared to
1476the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2277the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1477uses select or poll in basically all documented configurations. 2278uses select or poll in basically all documented configurations.
1540=item * C-based event loops perform very well with small number of 2341=item * C-based event loops perform very well with small number of
1541watchers, as the management overhead dominates. 2342watchers, as the management overhead dominates.
1542 2343
1543=back 2344=back
1544 2345
2346=head2 THE IO::Lambda BENCHMARK
2347
2348Recently I was told about the benchmark in the IO::Lambda manpage, which
2349could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2350simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2351shouldn't come as a surprise to anybody). As such, the benchmark is
2352fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2353very optimal. But how would AnyEvent compare when used without the extra
2354baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2355
2356The benchmark itself creates an echo-server, and then, for 500 times,
2357connects to the echo server, sends a line, waits for the reply, and then
2358creates the next connection. This is a rather bad benchmark, as it doesn't
2359test the efficiency of the framework or much non-blocking I/O, but it is a
2360benchmark nevertheless.
2361
2362 name runtime
2363 Lambda/select 0.330 sec
2364 + optimized 0.122 sec
2365 Lambda/AnyEvent 0.327 sec
2366 + optimized 0.138 sec
2367 Raw sockets/select 0.077 sec
2368 POE/select, components 0.662 sec
2369 POE/select, raw sockets 0.226 sec
2370 POE/select, optimized 0.404 sec
2371
2372 AnyEvent/select/nb 0.085 sec
2373 AnyEvent/EV/nb 0.068 sec
2374 +state machine 0.134 sec
2375
2376The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2377benchmarks actually make blocking connects and use 100% blocking I/O,
2378defeating the purpose of an event-based solution. All of the newly
2379written AnyEvent benchmarks use 100% non-blocking connects (using
2380AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2381resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2382generally require a lot more bookkeeping and event handling than blocking
2383connects (which involve a single syscall only).
2384
2385The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2386offers similar expressive power as POE and IO::Lambda, using conventional
2387Perl syntax. This means that both the echo server and the client are 100%
2388non-blocking, further placing it at a disadvantage.
2389
2390As you can see, the AnyEvent + EV combination even beats the
2391hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2392backend easily beats IO::Lambda and POE.
2393
2394And even the 100% non-blocking version written using the high-level (and
2395slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2396higher level ("unoptimised") abstractions by a large margin, even though
2397it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2398
2399The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2400F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2401part of the IO::Lambda distribution and were used without any changes.
2402
2403
2404=head1 SIGNALS
2405
2406AnyEvent currently installs handlers for these signals:
2407
2408=over 4
2409
2410=item SIGCHLD
2411
2412A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2413emulation for event loops that do not support them natively. Also, some
2414event loops install a similar handler.
2415
2416Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2417AnyEvent will reset it to default, to avoid losing child exit statuses.
2418
2419=item SIGPIPE
2420
2421A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2422when AnyEvent gets loaded.
2423
2424The rationale for this is that AnyEvent users usually do not really depend
2425on SIGPIPE delivery (which is purely an optimisation for shell use, or
2426badly-written programs), but C<SIGPIPE> can cause spurious and rare
2427program exits as a lot of people do not expect C<SIGPIPE> when writing to
2428some random socket.
2429
2430The rationale for installing a no-op handler as opposed to ignoring it is
2431that this way, the handler will be restored to defaults on exec.
2432
2433Feel free to install your own handler, or reset it to defaults.
2434
2435=back
2436
2437=cut
2438
2439undef $SIG{CHLD}
2440 if $SIG{CHLD} eq 'IGNORE';
2441
2442$SIG{PIPE} = sub { }
2443 unless defined $SIG{PIPE};
2444
2445=head1 RECOMMENDED/OPTIONAL MODULES
2446
2447One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2448it's built-in modules) are required to use it.
2449
2450That does not mean that AnyEvent won't take advantage of some additional
2451modules if they are installed.
2452
2453This section explains which additional modules will be used, and how they
2454affect AnyEvent's operation.
2455
2456=over 4
2457
2458=item L<Async::Interrupt>
2459
2460This slightly arcane module is used to implement fast signal handling: To
2461my knowledge, there is no way to do completely race-free and quick
2462signal handling in pure perl. To ensure that signals still get
2463delivered, AnyEvent will start an interval timer to wake up perl (and
2464catch the signals) with some delay (default is 10 seconds, look for
2465C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2466
2467If this module is available, then it will be used to implement signal
2468catching, which means that signals will not be delayed, and the event loop
2469will not be interrupted regularly, which is more efficient (and good for
2470battery life on laptops).
2471
2472This affects not just the pure-perl event loop, but also other event loops
2473that have no signal handling on their own (e.g. Glib, Tk, Qt).
2474
2475Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2476and either employ their own workarounds (POE) or use AnyEvent's workaround
2477(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2478does nothing for those backends.
2479
2480=item L<EV>
2481
2482This module isn't really "optional", as it is simply one of the backend
2483event loops that AnyEvent can use. However, it is simply the best event
2484loop available in terms of features, speed and stability: It supports
2485the AnyEvent API optimally, implements all the watcher types in XS, does
2486automatic timer adjustments even when no monotonic clock is available,
2487can take avdantage of advanced kernel interfaces such as C<epoll> and
2488C<kqueue>, and is the fastest backend I<by far>. You can even embed
2489L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2490
2491=item L<Guard>
2492
2493The guard module, when used, will be used to implement
2494C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2495lot less memory), but otherwise doesn't affect guard operation much. It is
2496purely used for performance.
2497
2498=item L<JSON> and L<JSON::XS>
2499
2500One of these modules is required when you want to read or write JSON data
2501via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2502advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2503
2504In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2505installed.
2506
2507=item L<Net::SSLeay>
2508
2509Implementing TLS/SSL in Perl is certainly interesting, but not very
2510worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2511the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2512
2513=item L<Time::HiRes>
2514
2515This module is part of perl since release 5.008. It will be used when the
2516chosen event library does not come with a timing source on it's own. The
2517pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2518try to use a monotonic clock for timing stability.
2519
2520=back
2521
1545 2522
1546=head1 FORK 2523=head1 FORK
1547 2524
1548Most event libraries are not fork-safe. The ones who are usually are 2525Most event libraries are not fork-safe. The ones who are usually are
1549because they rely on inefficient but fork-safe C<select> or C<poll> 2526because they rely on inefficient but fork-safe C<select> or C<poll>
1550calls. Only L<EV> is fully fork-aware. 2527calls. Only L<EV> is fully fork-aware.
1551 2528
2529This means that, in general, you cannot fork and do event processing
2530in the child if a watcher was created before the fork (which in turn
2531initialises the event library).
2532
1552If you have to fork, you must either do so I<before> creating your first 2533If you have to fork, you must either do so I<before> creating your first
1553watcher OR you must not use AnyEvent at all in the child. 2534watcher OR you must not use AnyEvent at all in the child OR you must do
2535something completely out of the scope of AnyEvent.
2536
2537The problem of doing event processing in the parent I<and> the child
2538is much more complicated: even for backends that I<are> fork-aware or
2539fork-safe, their behaviour is not usually what you want: fork clones all
2540watchers, that means all timers, I/O watchers etc. are active in both
2541parent and child, which is almost never what you want.
1554 2542
1555 2543
1556=head1 SECURITY CONSIDERATIONS 2544=head1 SECURITY CONSIDERATIONS
1557 2545
1558AnyEvent can be forced to load any event model via 2546AnyEvent can be forced to load any event model via
1563specified in the variable. 2551specified in the variable.
1564 2552
1565You can make AnyEvent completely ignore this variable by deleting it 2553You can make AnyEvent completely ignore this variable by deleting it
1566before the first watcher gets created, e.g. with a C<BEGIN> block: 2554before the first watcher gets created, e.g. with a C<BEGIN> block:
1567 2555
1568 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 2556 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1569 2557
1570 use AnyEvent; 2558 use AnyEvent;
1571 2559
1572Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2560Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1573be used to probe what backend is used and gain other information (which is 2561be used to probe what backend is used and gain other information (which is
1574probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 2562probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
2563$ENV{PERL_ANYEVENT_STRICT}.
2564
2565Note that AnyEvent will remove I<all> environment variables starting with
2566C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2567enabled.
2568
2569
2570=head1 BUGS
2571
2572Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
2573to work around. If you suffer from memleaks, first upgrade to Perl 5.10
2574and check wether the leaks still show up. (Perl 5.10.0 has other annoying
2575memleaks, such as leaking on C<map> and C<grep> but it is usually not as
2576pronounced).
1575 2577
1576 2578
1577=head1 SEE ALSO 2579=head1 SEE ALSO
1578 2580
1579Utility functions: L<AnyEvent::Util>. 2581Utility functions: L<AnyEvent::Util>.
1582L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2584L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1583 2585
1584Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2586Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1585L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2587L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1586L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2588L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1587L<AnyEvent::Impl::POE>. 2589L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
1588 2590
1589Non-blocking file handles, sockets, TCP clients and 2591Non-blocking file handles, sockets, TCP clients and
1590servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2592servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1591 2593
1592Asynchronous DNS: L<AnyEvent::DNS>. 2594Asynchronous DNS: L<AnyEvent::DNS>.
1593 2595
1594Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2596Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2597L<Coro::Event>,
1595 2598
1596Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2599Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2600L<AnyEvent::HTTP>.
1597 2601
1598 2602
1599=head1 AUTHOR 2603=head1 AUTHOR
1600 2604
1601 Marc Lehmann <schmorp@schmorp.de> 2605 Marc Lehmann <schmorp@schmorp.de>
1602 http://home.schmorp.de/ 2606 http://home.schmorp.de/
1603 2607
1604=cut 2608=cut
1605 2609
16061 26101
1607 2611

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines