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.165 by root, Tue Jul 8 23:07:26 2008 UTC vs.
Revision 1.383 by root, Fri Sep 2 04:41:16 2011 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,
6FLTK and 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 # if you prefer function calls, look at the AE manpage for
13 # an alternative API.
14
15 # file handle or descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 16 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
17
18 # one-shot or repeating timers
19 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
20 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
21
22 print AnyEvent->now; # prints current event loop time
23 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
24
25 # POSIX signal
26 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
27
28 # child process exit
29 my $w = AnyEvent->child (pid => $pid, cb => sub {
30 my ($pid, $status) = @_;
12 ... 31 ...
13 }); 32 });
14 33
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 34 # called when event loop idle (if applicable)
16 ... 35 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 36
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 37 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 38 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 39 $w->recv; # enters "main loop" till $condvar gets ->send
40 # use a condvar in callback mode:
41 $w->cb (sub { $_[0]->recv });
22 42
23=head1 INTRODUCTION/TUTORIAL 43=head1 INTRODUCTION/TUTORIAL
24 44
25This manpage is mainly a reference manual. If you are interested 45This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the 46in a tutorial or some gentle introduction, have a look at the
27L<AnyEvent::Intro> manpage. 47L<AnyEvent::Intro> manpage.
28 48
49=head1 SUPPORT
50
51An FAQ document is available as L<AnyEvent::FAQ>.
52
53There also is a mailinglist for discussing all things AnyEvent, and an IRC
54channel, too.
55
56See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
57Repository>, at L<http://anyevent.schmorp.de>, for more info.
58
29=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 59=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
30 60
31Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 61Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
32nowadays. So what is different about AnyEvent? 62nowadays. So what is different about AnyEvent?
33 63
34Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 64Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
35policy> and AnyEvent is I<small and efficient>. 65policy> and AnyEvent is I<small and efficient>.
36 66
37First and foremost, I<AnyEvent is not an event model> itself, it only 67First and foremost, I<AnyEvent is not an event model> itself, it only
38interfaces to whatever event model the main program happens to use in a 68interfaces to whatever event model the main program happens to use, in a
39pragmatic way. For event models and certain classes of immortals alike, 69pragmatic way. For event models and certain classes of immortals alike,
40the statement "there can only be one" is a bitter reality: In general, 70the statement "there can only be one" is a bitter reality: In general,
41only one event loop can be active at the same time in a process. AnyEvent 71only one event loop can be active at the same time in a process. AnyEvent
42helps hiding the differences between those event loops. 72cannot change this, but it can hide the differences between those event
73loops.
43 74
44The goal of AnyEvent is to offer module authors the ability to do event 75The goal of AnyEvent is to offer module authors the ability to do event
45programming (waiting for I/O or timer events) without subscribing to a 76programming (waiting for I/O or timer events) without subscribing to a
46religion, a way of living, and most importantly: without forcing your 77religion, a way of living, and most importantly: without forcing your
47module users into the same thing by forcing them to use the same event 78module users into the same thing by forcing them to use the same event
48model you use. 79model you use.
49 80
50For modules like POE or IO::Async (which is a total misnomer as it is 81For modules like POE or IO::Async (which is a total misnomer as it is
51actually doing all I/O I<synchronously>...), using them in your module is 82actually doing all I/O I<synchronously>...), using them in your module is
52like joining a cult: After you joined, you are dependent on them and you 83like joining a cult: After you join, you are dependent on them and you
53cannot use anything else, as it is simply incompatible to everything that 84cannot use anything else, as they are simply incompatible to everything
54isn't itself. What's worse, all the potential users of your module are 85that isn't them. What's worse, all the potential users of your
55I<also> forced to use the same event loop you use. 86module are I<also> forced to use the same event loop you use.
56 87
57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 88AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
58fine. AnyEvent + Tk works fine etc. etc. but none of these work together 89fine. AnyEvent + Tk works fine etc. etc. but none of these work together
59with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 90with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
60your module uses one of those, every user of your module has to use it, 91uses one of those, every user of your module has to use it, too. But if
61too. But if your module uses AnyEvent, it works transparently with all 92your module uses AnyEvent, it works transparently with all event models it
62event models it supports (including stuff like POE and IO::Async, as long 93supports (including stuff like IO::Async, as long as those use one of the
63as those use one of the supported event loops. It is trivial to add new 94supported event loops. It is easy to add new event loops to AnyEvent, too,
64event loops to AnyEvent, too, so it is future-proof). 95so it is future-proof).
65 96
66In addition to being free of having to use I<the one and only true event 97In addition to being free of having to use I<the one and only true event
67model>, AnyEvent also is free of bloat and policy: with POE or similar 98model>, AnyEvent also is free of bloat and policy: with POE or similar
68modules, you get an enormous amount of code and strict rules you have to 99modules, you get an enormous amount of code and strict rules you have to
69follow. AnyEvent, on the other hand, is lean and up to the point, by only 100follow. AnyEvent, on the other hand, is lean and to the point, by only
70offering the functionality that is necessary, in as thin as a wrapper as 101offering the functionality that is necessary, in as thin as a wrapper as
71technically possible. 102technically possible.
72 103
73Of course, AnyEvent comes with a big (and fully optional!) toolbox 104Of course, AnyEvent comes with a big (and fully optional!) toolbox
74of useful functionality, such as an asynchronous DNS resolver, 100% 105of useful functionality, such as an asynchronous DNS resolver, 100%
80useful) and you want to force your users to use the one and only event 111useful) and you want to force your users to use the one and only event
81model, you should I<not> use this module. 112model, you should I<not> use this module.
82 113
83=head1 DESCRIPTION 114=head1 DESCRIPTION
84 115
85L<AnyEvent> provides an identical interface to multiple event loops. This 116L<AnyEvent> provides a uniform interface to various event loops. This
86allows module authors to utilise an event loop without forcing module 117allows module authors to use event loop functionality without forcing
87users to use the same event loop (as only a single event loop can coexist 118module users to use a specific event loop implementation (since more
88peacefully at any one time). 119than one event loop cannot coexist peacefully).
89 120
90The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
91module. 122module.
92 123
93During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
94to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
95following modules is already loaded: L<EV>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
96L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
97L<POE>. The first one found is used. If none are found, the module tries 128found is used. If none are detected, the module tries to load the first
98to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 129four modules in the order given; but note that if L<EV> is not
99adaptor should always succeed) in the order given. The first one that can 130available, the pure-perl L<AnyEvent::Loop> should always work, so
100be successfully loaded will be used. If, after this, still none could be 131the other two are not normally tried.
101found, AnyEvent will fall back to a pure-perl event loop, which is not
102very efficient, but should work everywhere.
103 132
104Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
105an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
106that model the default. For example: 135that model the default. For example:
107 136
109 use AnyEvent; 138 use AnyEvent;
110 139
111 # .. AnyEvent will likely default to Tk 140 # .. AnyEvent will likely default to Tk
112 141
113The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
114starts using it, all bets are off. Maybe you should tell their authors to 143starts using it, all bets are off - this case should be very rare though,
115use AnyEvent so their modules work together with others seamlessly... 144as very few modules hardcode event loops without announcing this very
145loudly.
116 146
117The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
118C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
119explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
120 150
121=head1 WATCHERS 151=head1 WATCHERS
122 152
123AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
124stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
127These watchers are normal Perl objects with normal Perl lifetime. After 157These watchers are normal Perl objects with normal Perl lifetime. After
128creating a watcher it will immediately "watch" for events and invoke the 158creating a watcher it will immediately "watch" for events and invoke the
129callback when the event occurs (of course, only when the event model 159callback when the event occurs (of course, only when the event model
130is in control). 160is in control).
131 161
162Note that B<callbacks must not permanently change global variables>
163potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
164callbacks must not C<die> >>. The former is good programming practice in
165Perl and the latter stems from the fact that exception handling differs
166widely between event loops.
167
132To disable the watcher you have to destroy it (e.g. by setting the 168To disable a watcher you have to destroy it (e.g. by setting the
133variable you store it in to C<undef> or otherwise deleting all references 169variable you store it in to C<undef> or otherwise deleting all references
134to it). 170to it).
135 171
136All watchers are created by calling a method on the C<AnyEvent> class. 172All watchers are created by calling a method on the C<AnyEvent> class.
137 173
138Many watchers either are used with "recursion" (repeating timers for 174Many watchers either are used with "recursion" (repeating timers for
139example), or need to refer to their watcher object in other ways. 175example), or need to refer to their watcher object in other ways.
140 176
141An any way to achieve that is this pattern: 177One way to achieve that is this pattern:
142 178
143 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 179 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
144 # you can use $w here, for example to undef it 180 # you can use $w here, for example to undef it
145 undef $w; 181 undef $w;
146 }); 182 });
149my variables are only visible after the statement in which they are 185my variables are only visible after the statement in which they are
150declared. 186declared.
151 187
152=head2 I/O WATCHERS 188=head2 I/O WATCHERS
153 189
190 $w = AnyEvent->io (
191 fh => <filehandle_or_fileno>,
192 poll => <"r" or "w">,
193 cb => <callback>,
194 );
195
154You can create an I/O watcher by calling the C<< AnyEvent->io >> method 196You can create an I/O watcher by calling the C<< AnyEvent->io >> method
155with the following mandatory key-value pairs as arguments: 197with the following mandatory key-value pairs as arguments:
156 198
157C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 199C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
200for events (AnyEvent might or might not keep a reference to this file
201handle). Note that only file handles pointing to things for which
202non-blocking operation makes sense are allowed. This includes sockets,
203most character devices, pipes, fifos and so on, but not for example files
204or block devices.
205
158for events. C<poll> must be a string that is either C<r> or C<w>, 206C<poll> must be a string that is either C<r> or C<w>, which creates a
159which creates a watcher waiting for "r"eadable or "w"ritable events, 207watcher waiting for "r"eadable or "w"ritable events, respectively.
208
160respectively. C<cb> is the callback to invoke each time the file handle 209C<cb> is the callback to invoke each time the file handle becomes ready.
161becomes ready.
162 210
163Although the callback might get passed parameters, their value and 211Although the callback might get passed parameters, their value and
164presence is undefined and you cannot rely on them. Portable AnyEvent 212presence is undefined and you cannot rely on them. Portable AnyEvent
165callbacks cannot use arguments passed to I/O watcher callbacks. 213callbacks cannot use arguments passed to I/O watcher callbacks.
166 214
167The I/O watcher might use the underlying file descriptor or a copy of it. 215The I/O watcher might use the underlying file descriptor or a copy of it.
168You must not close a file handle as long as any watcher is active on the 216You must not close a file handle as long as any watcher is active on the
169underlying file descriptor. 217underlying file descriptor.
170 218
171Some event loops issue spurious readyness notifications, so you should 219Some event loops issue spurious readiness notifications, so you should
172always use non-blocking calls when reading/writing from/to your file 220always use non-blocking calls when reading/writing from/to your file
173handles. 221handles.
174 222
175Example: wait for readability of STDIN, then read a line and disable the 223Example: wait for readability of STDIN, then read a line and disable the
176watcher. 224watcher.
181 undef $w; 229 undef $w;
182 }); 230 });
183 231
184=head2 TIME WATCHERS 232=head2 TIME WATCHERS
185 233
234 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
235
236 $w = AnyEvent->timer (
237 after => <fractional_seconds>,
238 interval => <fractional_seconds>,
239 cb => <callback>,
240 );
241
186You can create a time watcher by calling the C<< AnyEvent->timer >> 242You can create a time watcher by calling the C<< AnyEvent->timer >>
187method with the following mandatory arguments: 243method with the following mandatory arguments:
188 244
189C<after> specifies after how many seconds (fractional values are 245C<after> specifies after how many seconds (fractional values are
190supported) the callback should be invoked. C<cb> is the callback to invoke 246supported) the callback should be invoked. C<cb> is the callback to invoke
192 248
193Although the callback might get passed parameters, their value and 249Although the callback might get passed parameters, their value and
194presence is undefined and you cannot rely on them. Portable AnyEvent 250presence is undefined and you cannot rely on them. Portable AnyEvent
195callbacks cannot use arguments passed to time watcher callbacks. 251callbacks cannot use arguments passed to time watcher callbacks.
196 252
197The callback will normally be invoked once only. If you specify another 253The callback will normally be invoked only once. If you specify another
198parameter, C<interval>, as a strictly positive number (> 0), then the 254parameter, C<interval>, as a strictly positive number (> 0), then the
199callback will be invoked regularly at that interval (in fractional 255callback will be invoked regularly at that interval (in fractional
200seconds) after the first invocation. If C<interval> is specified with a 256seconds) after the first invocation. If C<interval> is specified with a
201false value, then it is treated as if it were missing. 257false value, then it is treated as if it were not specified at all.
202 258
203The callback will be rescheduled before invoking the callback, but no 259The callback will be rescheduled before invoking the callback, but no
204attempt is done to avoid timer drift in most backends, so the interval is 260attempt is made to avoid timer drift in most backends, so the interval is
205only approximate. 261only approximate.
206 262
207Example: fire an event after 7.7 seconds. 263Example: fire an event after 7.7 seconds.
208 264
209 my $w = AnyEvent->timer (after => 7.7, cb => sub { 265 my $w = AnyEvent->timer (after => 7.7, cb => sub {
227 283
228While most event loops expect timers to specified in a relative way, they 284While most event loops expect timers to specified in a relative way, they
229use absolute time internally. This makes a difference when your clock 285use absolute time internally. This makes a difference when your clock
230"jumps", for example, when ntp decides to set your clock backwards from 286"jumps", for example, when ntp decides to set your clock backwards from
231the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to 287the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
232fire "after" a second might actually take six years to finally fire. 288fire "after a second" might actually take six years to finally fire.
233 289
234AnyEvent cannot compensate for this. The only event loop that is conscious 290AnyEvent cannot compensate for this. The only event loop that is conscious
235about these issues is L<EV>, which offers both relative (ev_timer, based 291of these issues is L<EV>, which offers both relative (ev_timer, based
236on true relative time) and absolute (ev_periodic, based on wallclock time) 292on true relative time) and absolute (ev_periodic, based on wallclock time)
237timers. 293timers.
238 294
239AnyEvent always prefers relative timers, if available, matching the 295AnyEvent always prefers relative timers, if available, matching the
240AnyEvent API. 296AnyEvent API.
262I<In almost all cases (in all cases if you don't care), this is the 318I<In almost all cases (in all cases if you don't care), this is the
263function to call when you want to know the current time.> 319function to call when you want to know the current time.>
264 320
265This function is also often faster then C<< AnyEvent->time >>, and 321This function is also often faster then C<< AnyEvent->time >>, and
266thus the preferred method if you want some timestamp (for example, 322thus the preferred method if you want some timestamp (for example,
267L<AnyEvent::Handle> uses this to update it's activity timeouts). 323L<AnyEvent::Handle> uses this to update its activity timeouts).
268 324
269The rest of this section is only of relevance if you try to be very exact 325The rest of this section is only of relevance if you try to be very exact
270with your timing, you can skip it without bad conscience. 326with your timing; you can skip it without a bad conscience.
271 327
272For a practical example of when these times differ, consider L<Event::Lib> 328For a practical example of when these times differ, consider L<Event::Lib>
273and L<EV> and the following set-up: 329and L<EV> and the following set-up:
274 330
275The event loop is running and has just invoked one of your callback at 331The event loop is running and has just invoked one of your callbacks at
276time=500 (assume no other callbacks delay processing). In your callback, 332time=500 (assume no other callbacks delay processing). In your callback,
277you wait a second by executing C<sleep 1> (blocking the process for a 333you wait a second by executing C<sleep 1> (blocking the process for a
278second) and then (at time=501) you create a relative timer that fires 334second) and then (at time=501) you create a relative timer that fires
279after three seconds. 335after three seconds.
280 336
298In either case, if you care (and in most cases, you don't), then you 354In either case, if you care (and in most cases, you don't), then you
299can get whatever behaviour you want with any event loop, by taking the 355can get whatever behaviour you want with any event loop, by taking the
300difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
301account. 357account.
302 358
359=item AnyEvent->now_update
360
361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363above).
364
365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs.
368
369When this is the case, you can call this method, which will update the
370event loop's idea of "current time".
371
372A typical example would be a script in a web server (e.g. C<mod_perl>) -
373when mod_perl executes the script, then the event loop will have the wrong
374idea about the "current time" (being potentially far in the past, when the
375script ran the last time). In that case you should arrange a call to C<<
376AnyEvent->now_update >> each time the web server process wakes up again
377(e.g. at the start of your script, or in a handler).
378
379Note that updating the time I<might> cause some events to be handled.
380
303=back 381=back
304 382
305=head2 SIGNAL WATCHERS 383=head2 SIGNAL WATCHERS
306 384
385 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
386
307You can watch for signals using a signal watcher, C<signal> is the signal 387You can watch for signals using a signal watcher, C<signal> is the signal
308I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 388I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
309be invoked whenever a signal occurs. 389callback to be invoked whenever a signal occurs.
310 390
311Although the callback might get passed parameters, their value and 391Although the callback might get passed parameters, their value and
312presence is undefined and you cannot rely on them. Portable AnyEvent 392presence is undefined and you cannot rely on them. Portable AnyEvent
313callbacks cannot use arguments passed to signal watcher callbacks. 393callbacks cannot use arguments passed to signal watcher callbacks.
314 394
316invocation, and callback invocation will be synchronous. Synchronous means 396invocation, and callback invocation will be synchronous. Synchronous means
317that it might take a while until the signal gets handled by the process, 397that it might take a while until the signal gets handled by the process,
318but it is guaranteed not to interrupt any other callbacks. 398but it is guaranteed not to interrupt any other callbacks.
319 399
320The main advantage of using these watchers is that you can share a signal 400The main advantage of using these watchers is that you can share a signal
321between multiple watchers. 401between multiple watchers, and AnyEvent will ensure that signals will not
402interrupt your program at bad times.
322 403
323This watcher might use C<%SIG>, so programs overwriting those signals 404This watcher might use C<%SIG> (depending on the event loop used),
324directly will likely not work correctly. 405so programs overwriting those signals directly will likely not work
406correctly.
325 407
326Example: exit on SIGINT 408Example: exit on SIGINT
327 409
328 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 410 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
329 411
412=head3 Restart Behaviour
413
414While restart behaviour is up to the event loop implementation, most will
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation).
417
418=head3 Safe/Unsafe Signals
419
420Perl signals can be either "safe" (synchronous to opcode handling) or
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the
422latter might corrupt your memory.
423
424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too).
428
429=head3 Signal Races, Delays and Workarounds
430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
432callbacks to signals in a generic way, which is a pity, as you cannot
433do race-free signal handling in perl, requiring C libraries for
434this. AnyEvent will try to do its best, which means in some cases,
435signals will be delayed. The maximum time a signal might be delayed is
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
437variable can be changed only before the first signal watcher is created,
438and should be left alone otherwise. This variable determines how often
439AnyEvent polls for signals (in case a wake-up was missed). Higher values
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442
443All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with
447one-second latency). For those, you just have to suffer the delays.
448
330=head2 CHILD PROCESS WATCHERS 449=head2 CHILD PROCESS WATCHERS
331 450
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452
332You can also watch on a child process exit and catch its exit status. 453You can also watch for a child process exit and catch its exit status.
333 454
334The child process is specified by the C<pid> argument (if set to C<0>, it 455The child process is specified by the C<pid> argument (on some backends,
335watches for any child process exit). The watcher will trigger as often 456using C<0> watches for any child process exit, on others this will
336as status change for the child are received. This works by installing a 457croak). The watcher will be triggered only when the child process has
337signal handler for C<SIGCHLD>. The callback will be called with the pid 458finished and an exit status is available, not on any trace events
338and exit status (as returned by waitpid), so unlike other watcher types, 459(stopped/continued).
339you I<can> rely on child watcher callback arguments. 460
461The callback will be called with the pid and exit status (as returned by
462waitpid), so unlike other watcher types, you I<can> rely on child watcher
463callback arguments.
464
465This watcher type works by installing a signal handler for C<SIGCHLD>,
466and since it cannot be shared, nothing else should use SIGCHLD or reap
467random child processes (waiting for specific child processes, e.g. inside
468C<system>, is just fine).
340 469
341There is a slight catch to child watchers, however: you usually start them 470There is a slight catch to child watchers, however: you usually start them
342I<after> the child process was created, and this means the process could 471I<after> the child process was created, and this means the process could
343have exited already (and no SIGCHLD will be sent anymore). 472have exited already (and no SIGCHLD will be sent anymore).
344 473
345Not all event models handle this correctly (POE doesn't), but even for 474Not all event models handle this correctly (neither POE nor IO::Async do,
475see their AnyEvent::Impl manpages for details), but even for event models
346event models that I<do> handle this correctly, they usually need to be 476that I<do> handle this correctly, they usually need to be loaded before
347loaded before the process exits (i.e. before you fork in the first place). 477the process exits (i.e. before you fork in the first place). AnyEvent's
478pure perl event loop handles all cases correctly regardless of when you
479start the watcher.
348 480
349This means you cannot create a child watcher as the very first thing in an 481This means you cannot create a child watcher as the very first
350AnyEvent program, you I<have> to create at least one watcher before you 482thing in an AnyEvent program, you I<have> to create at least one
351C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 483watcher before you C<fork> the child (alternatively, you can call
484C<AnyEvent::detect>).
485
486As most event loops do not support waiting for child events, they will be
487emulated by AnyEvent in most cases, in which case the latency and race
488problems mentioned in the description of signal watchers apply.
352 489
353Example: fork a process and wait for it 490Example: fork a process and wait for it
354 491
355 my $done = AnyEvent->condvar; 492 my $done = AnyEvent->condvar;
356 493
366 ); 503 );
367 504
368 # do something else, then wait for process exit 505 # do something else, then wait for process exit
369 $done->recv; 506 $done->recv;
370 507
508=head2 IDLE WATCHERS
509
510 $w = AnyEvent->idle (cb => <callback>);
511
512This will repeatedly invoke the callback after the process becomes idle,
513until either the watcher is destroyed or new events have been detected.
514
515Idle watchers are useful when there is a need to do something, but it
516is not so important (or wise) to do it instantly. The callback will be
517invoked only when there is "nothing better to do", which is usually
518defined as "all outstanding events have been handled and no new events
519have been detected". That means that idle watchers ideally get invoked
520when the event loop has just polled for new events but none have been
521detected. Instead of blocking to wait for more events, the idle watchers
522will be invoked.
523
524Unfortunately, most event loops do not really support idle watchers (only
525EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
526will simply call the callback "from time to time".
527
528Example: read lines from STDIN, but only process them when the
529program is otherwise idle:
530
531 my @lines; # read data
532 my $idle_w;
533 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
534 push @lines, scalar <STDIN>;
535
536 # start an idle watcher, if not already done
537 $idle_w ||= AnyEvent->idle (cb => sub {
538 # handle only one line, when there are lines left
539 if (my $line = shift @lines) {
540 print "handled when idle: $line";
541 } else {
542 # otherwise disable the idle watcher again
543 undef $idle_w;
544 }
545 });
546 });
547
371=head2 CONDITION VARIABLES 548=head2 CONDITION VARIABLES
549
550 $cv = AnyEvent->condvar;
551
552 $cv->send (<list>);
553 my @res = $cv->recv;
372 554
373If you are familiar with some event loops you will know that all of them 555If you are familiar with some event loops you will know that all of them
374require you to run some blocking "loop", "run" or similar function that 556require you to run some blocking "loop", "run" or similar function that
375will actively watch for new events and call your callbacks. 557will actively watch for new events and call your callbacks.
376 558
377AnyEvent is different, it expects somebody else to run the event loop and 559AnyEvent is slightly different: it expects somebody else to run the event
378will only block when necessary (usually when told by the user). 560loop and will only block when necessary (usually when told by the user).
379 561
380The instrument to do that is called a "condition variable", so called 562The tool to do that is called a "condition variable", so called because
381because they represent a condition that must become true. 563they represent a condition that must become true.
564
565Now is probably a good time to look at the examples further below.
382 566
383Condition variables can be created by calling the C<< AnyEvent->condvar 567Condition variables can be created by calling the C<< AnyEvent->condvar
384>> method, usually without arguments. The only argument pair allowed is 568>> method, usually without arguments. The only argument pair allowed is
385C<cb>, which specifies a callback to be called when the condition variable 569C<cb>, which specifies a callback to be called when the condition variable
386becomes true. 570becomes true, with the condition variable as the first argument (but not
571the results).
387 572
388After creation, the condition variable is "false" until it becomes "true" 573After creation, the condition variable is "false" until it becomes "true"
389by calling the C<send> method (or calling the condition variable as if it 574by calling the C<send> method (or calling the condition variable as if it
390were a callback, read about the caveats in the description for the C<< 575were a callback, read about the caveats in the description for the C<<
391->send >> method). 576->send >> method).
392 577
393Condition variables are similar to callbacks, except that you can 578Since condition variables are the most complex part of the AnyEvent API, here are
394optionally wait for them. They can also be called merge points - points 579some different mental models of what they are - pick the ones you can connect to:
395in time where multiple outstanding events have been processed. And yet 580
396another way to call them is transactions - each condition variable can be 581=over 4
397used to represent a transaction, which finishes at some point and delivers 582
398a result. 583=item * Condition variables are like callbacks - you can call them (and pass them instead
584of callbacks). Unlike callbacks however, you can also wait for them to be called.
585
586=item * Condition variables are signals - one side can emit or send them,
587the other side can wait for them, or install a handler that is called when
588the signal fires.
589
590=item * Condition variables are like "Merge Points" - points in your program
591where you merge multiple independent results/control flows into one.
592
593=item * Condition variables represent a transaction - functions that start
594some kind of transaction can return them, leaving the caller the choice
595between waiting in a blocking fashion, or setting a callback.
596
597=item * Condition variables represent future values, or promises to deliver
598some result, long before the result is available.
599
600=back
399 601
400Condition variables are very useful to signal that something has finished, 602Condition variables are very useful to signal that something has finished,
401for example, if you write a module that does asynchronous http requests, 603for example, if you write a module that does asynchronous http requests,
402then a condition variable would be the ideal candidate to signal the 604then a condition variable would be the ideal candidate to signal the
403availability of results. The user can either act when the callback is 605availability of results. The user can either act when the callback is
416 618
417Condition variables are represented by hash refs in perl, and the keys 619Condition variables are represented by hash refs in perl, and the keys
418used by AnyEvent itself are all named C<_ae_XXX> to make subclassing 620used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
419easy (it is often useful to build your own transaction class on top of 621easy (it is often useful to build your own transaction class on top of
420AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 622AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
421it's C<new> method in your own C<new> method. 623its C<new> method in your own C<new> method.
422 624
423There are two "sides" to a condition variable - the "producer side" which 625There are two "sides" to a condition variable - the "producer side" which
424eventually calls C<< -> send >>, and the "consumer side", which waits 626eventually calls C<< -> send >>, and the "consumer side", which waits
425for the send to occur. 627for the send to occur.
426 628
427Example: wait for a timer. 629Example: wait for a timer.
428 630
429 # wait till the result is ready 631 # condition: "wait till the timer is fired"
430 my $result_ready = AnyEvent->condvar; 632 my $timer_fired = AnyEvent->condvar;
431 633
432 # do something such as adding a timer 634 # create the timer - we could wait for, say
433 # or socket watcher the calls $result_ready->send 635 # a handle becomign ready, or even an
434 # when the "result" is ready. 636 # AnyEvent::HTTP request to finish, but
435 # in this case, we simply use a timer: 637 # in this case, we simply use a timer:
436 my $w = AnyEvent->timer ( 638 my $w = AnyEvent->timer (
437 after => 1, 639 after => 1,
438 cb => sub { $result_ready->send }, 640 cb => sub { $timer_fired->send },
439 ); 641 );
440 642
441 # this "blocks" (while handling events) till the callback 643 # this "blocks" (while handling events) till the callback
442 # calls send 644 # calls ->send
443 $result_ready->recv; 645 $timer_fired->recv;
444 646
445Example: wait for a timer, but take advantage of the fact that 647Example: wait for a timer, but take advantage of the fact that condition
446condition variables are also code references. 648variables are also callable directly.
447 649
448 my $done = AnyEvent->condvar; 650 my $done = AnyEvent->condvar;
449 my $delay = AnyEvent->timer (after => 5, cb => $done); 651 my $delay = AnyEvent->timer (after => 5, cb => $done);
450 $done->recv; 652 $done->recv;
653
654Example: Imagine an API that returns a condvar and doesn't support
655callbacks. This is how you make a synchronous call, for example from
656the main program:
657
658 use AnyEvent::CouchDB;
659
660 ...
661
662 my @info = $couchdb->info->recv;
663
664And this is how you would just set a callback to be called whenever the
665results are available:
666
667 $couchdb->info->cb (sub {
668 my @info = $_[0]->recv;
669 });
451 670
452=head3 METHODS FOR PRODUCERS 671=head3 METHODS FOR PRODUCERS
453 672
454These methods should only be used by the producing side, i.e. the 673These methods should only be used by the producing side, i.e. the
455code/module that eventually sends the signal. Note that it is also 674code/module that eventually sends the signal. Note that it is also
468immediately from within send. 687immediately from within send.
469 688
470Any arguments passed to the C<send> call will be returned by all 689Any arguments passed to the C<send> call will be returned by all
471future C<< ->recv >> calls. 690future C<< ->recv >> calls.
472 691
473Condition variables are overloaded so one can call them directly 692Condition variables are overloaded so one can call them directly (as if
474(as a code reference). Calling them directly is the same as calling 693they were a code reference). Calling them directly is the same as calling
475C<send>. Note, however, that many C-based event loops do not handle 694C<send>.
476overloading, so as tempting as it may be, passing a condition variable
477instead of a callback does not work. Both the pure perl and EV loops
478support overloading, however, as well as all functions that use perl to
479invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
480example).
481 695
482=item $cv->croak ($error) 696=item $cv->croak ($error)
483 697
484Similar to send, but causes all call's to C<< ->recv >> to invoke 698Similar to send, but causes all calls to C<< ->recv >> to invoke
485C<Carp::croak> with the given error message/object/scalar. 699C<Carp::croak> with the given error message/object/scalar.
486 700
487This can be used to signal any errors to the condition variable 701This can be used to signal any errors to the condition variable
488user/consumer. 702user/consumer. Doing it this way instead of calling C<croak> directly
703delays the error detection, but has the overwhelming advantage that it
704diagnoses the error at the place where the result is expected, and not
705deep in some event callback with no connection to the actual code causing
706the problem.
489 707
490=item $cv->begin ([group callback]) 708=item $cv->begin ([group callback])
491 709
492=item $cv->end 710=item $cv->end
493
494These two methods are EXPERIMENTAL and MIGHT CHANGE.
495 711
496These two methods can be used to combine many transactions/events into 712These two methods can be used to combine many transactions/events into
497one. For example, a function that pings many hosts in parallel might want 713one. For example, a function that pings many hosts in parallel might want
498to use a condition variable for the whole process. 714to use a condition variable for the whole process.
499 715
500Every call to C<< ->begin >> will increment a counter, and every call to 716Every call to C<< ->begin >> will increment a counter, and every call to
501C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 717C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
502>>, the (last) callback passed to C<begin> will be executed. That callback 718>>, the (last) callback passed to C<begin> will be executed, passing the
503is I<supposed> to call C<< ->send >>, but that is not required. If no 719condvar as first argument. That callback is I<supposed> to call C<< ->send
504callback was set, C<send> will be called without any arguments. 720>>, but that is not required. If no group callback was set, C<send> will
721be called without any arguments.
505 722
506Let's clarify this with the ping example: 723You can think of C<< $cv->send >> giving you an OR condition (one call
724sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
725condition (all C<begin> calls must be C<end>'ed before the condvar sends).
726
727Let's start with a simple example: you have two I/O watchers (for example,
728STDOUT and STDERR for a program), and you want to wait for both streams to
729close before activating a condvar:
507 730
508 my $cv = AnyEvent->condvar; 731 my $cv = AnyEvent->condvar;
509 732
733 $cv->begin; # first watcher
734 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
735 defined sysread $fh1, my $buf, 4096
736 or $cv->end;
737 });
738
739 $cv->begin; # second watcher
740 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
741 defined sysread $fh2, my $buf, 4096
742 or $cv->end;
743 });
744
745 $cv->recv;
746
747This works because for every event source (EOF on file handle), there is
748one call to C<begin>, so the condvar waits for all calls to C<end> before
749sending.
750
751The ping example mentioned above is slightly more complicated, as the
752there are results to be passwd back, and the number of tasks that are
753begun can potentially be zero:
754
755 my $cv = AnyEvent->condvar;
756
510 my %result; 757 my %result;
511 $cv->begin (sub { $cv->send (\%result) }); 758 $cv->begin (sub { shift->send (\%result) });
512 759
513 for my $host (@list_of_hosts) { 760 for my $host (@list_of_hosts) {
514 $cv->begin; 761 $cv->begin;
515 ping_host_then_call_callback $host, sub { 762 ping_host_then_call_callback $host, sub {
516 $result{$host} = ...; 763 $result{$host} = ...;
531loop, which serves two important purposes: first, it sets the callback 778loop, which serves two important purposes: first, it sets the callback
532to be called once the counter reaches C<0>, and second, it ensures that 779to be called once the counter reaches C<0>, and second, it ensures that
533C<send> is called even when C<no> hosts are being pinged (the loop 780C<send> is called even when C<no> hosts are being pinged (the loop
534doesn't execute once). 781doesn't execute once).
535 782
536This is the general pattern when you "fan out" into multiple subrequests: 783This is the general pattern when you "fan out" into multiple (but
537use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 784potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
538is called at least once, and then, for each subrequest you start, call 785the callback and ensure C<end> is called at least once, and then, for each
539C<begin> and for each subrequest you finish, call C<end>. 786subrequest you start, call C<begin> and for each subrequest you finish,
787call C<end>.
540 788
541=back 789=back
542 790
543=head3 METHODS FOR CONSUMERS 791=head3 METHODS FOR CONSUMERS
544 792
548=over 4 796=over 4
549 797
550=item $cv->recv 798=item $cv->recv
551 799
552Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 800Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
553>> methods have been called on c<$cv>, while servicing other watchers 801>> methods have been called on C<$cv>, while servicing other watchers
554normally. 802normally.
555 803
556You can only wait once on a condition - additional calls are valid but 804You can only wait once on a condition - additional calls are valid but
557will return immediately. 805will return immediately.
558 806
560function will call C<croak>. 808function will call C<croak>.
561 809
562In list context, all parameters passed to C<send> will be returned, 810In list context, all parameters passed to C<send> will be returned,
563in scalar context only the first one will be returned. 811in scalar context only the first one will be returned.
564 812
813Note that doing a blocking wait in a callback is not supported by any
814event loop, that is, recursive invocation of a blocking C<< ->recv
815>> is not allowed, and the C<recv> call will C<croak> if such a
816condition is detected. This condition can be slightly loosened by using
817L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
818any thread that doesn't run the event loop itself.
819
565Not all event models support a blocking wait - some die in that case 820Not all event models support a blocking wait - some die in that case
566(programs might want to do that to stay interactive), so I<if you are 821(programs might want to do that to stay interactive), so I<if you are
567using this from a module, never require a blocking wait>, but let the 822using this from a module, never require a blocking wait>. Instead, let the
568caller decide whether the call will block or not (for example, by coupling 823caller decide whether the call will block or not (for example, by coupling
569condition variables with some kind of request results and supporting 824condition variables with some kind of request results and supporting
570callbacks so the caller knows that getting the result will not block, 825callbacks so the caller knows that getting the result will not block,
571while still supporting blocking waits if the caller so desires). 826while still supporting blocking waits if the caller so desires).
572 827
573Another reason I<never> to C<< ->recv >> in a module is that you cannot
574sensibly have two C<< ->recv >>'s in parallel, as that would require
575multiple interpreters or coroutines/threads, none of which C<AnyEvent>
576can supply.
577
578The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
579fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
580versions and also integrates coroutines into AnyEvent, making blocking
581C<< ->recv >> calls perfectly safe as long as they are done from another
582coroutine (one that doesn't run the event loop).
583
584You can ensure that C<< -recv >> never blocks by setting a callback and 828You can ensure that C<< ->recv >> never blocks by setting a callback and
585only calling C<< ->recv >> from within that callback (or at a later 829only calling C<< ->recv >> from within that callback (or at a later
586time). This will work even when the event loop does not support blocking 830time). This will work even when the event loop does not support blocking
587waits otherwise. 831waits otherwise.
588 832
589=item $bool = $cv->ready 833=item $bool = $cv->ready
590 834
591Returns true when the condition is "true", i.e. whether C<send> or 835Returns true when the condition is "true", i.e. whether C<send> or
592C<croak> have been called. 836C<croak> have been called.
593 837
594=item $cb = $cv->cb ([new callback]) 838=item $cb = $cv->cb ($cb->($cv))
595 839
596This is a mutator function that returns the callback set and optionally 840This is a mutator function that returns the callback set and optionally
597replaces it before doing so. 841replaces it before doing so.
598 842
599The callback will be called when the condition becomes "true", i.e. when 843The callback will be called when the condition becomes "true", i.e. when
600C<send> or C<croak> are called, with the only argument being the condition 844C<send> or C<croak> are called, with the only argument being the
601variable itself. Calling C<recv> inside the callback or at any later time 845condition variable itself. If the condition is already true, the
602is guaranteed not to block. 846callback is called immediately when it is set. Calling C<recv> inside
847the callback or at any later time is guaranteed not to block.
603 848
604=back 849=back
605 850
851=head1 SUPPORTED EVENT LOOPS/BACKENDS
852
853The available backend classes are (every class has its own manpage):
854
855=over 4
856
857=item Backends that are autoprobed when no other event loop can be found.
858
859EV is the preferred backend when no other event loop seems to be in
860use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself.
863
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866
867=item Backends that are transparently being picked up when they are used.
868
869These will be used if they are already loaded when the first watcher
870is created, in which case it is assumed that the application is using
871them. This means that AnyEvent will automatically pick the right backend
872when the main program loads an event module before anything starts to
873create watchers. Nothing special needs to be done by the main program.
874
875 AnyEvent::Impl::Event based on Event, very stable, few glitches.
876 AnyEvent::Impl::Glib based on Glib, slow but very stable.
877 AnyEvent::Impl::Tk based on Tk, very broken.
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884
885=item Backends with special needs.
886
887Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program
889instantiates the application before any AnyEvent watchers are created,
890everything should just work.
891
892 AnyEvent::Impl::Qt based on Qt.
893
894=item Event loops that are indirectly supported via other backends.
895
896Some event loops can be supported via other modules:
897
898There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
899
900B<WxWidgets> has no support for watching file handles. However, you can
901use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
902polls 20 times per second, which was considered to be too horrible to even
903consider for AnyEvent.
904
905B<Prima> is not supported as nobody seems to be using it, but it has a POE
906backend, so it can be supported through POE.
907
908AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
909load L<POE> when detecting them, in the hope that POE will pick them up,
910in which case everything will be automatic.
911
912=back
913
606=head1 GLOBAL VARIABLES AND FUNCTIONS 914=head1 GLOBAL VARIABLES AND FUNCTIONS
607 915
916These are not normally required to use AnyEvent, but can be useful to
917write AnyEvent extension modules.
918
608=over 4 919=over 4
609 920
610=item $AnyEvent::MODEL 921=item $AnyEvent::MODEL
611 922
612Contains C<undef> until the first watcher is being created. Then it 923Contains C<undef> until the first watcher is being created, before the
924backend has been autodetected.
925
613contains the event model that is being used, which is the name of the 926Afterwards it contains the event model that is being used, which is the
614Perl class implementing the model. This class is usually one of the 927name of the Perl class implementing the model. This class is usually one
615C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 928of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
616AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 929case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
617 930will be C<urxvt::anyevent>).
618The known classes so far are:
619
620 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
621 AnyEvent::Impl::Event based on Event, second best choice.
622 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
623 AnyEvent::Impl::Glib based on Glib, third-best choice.
624 AnyEvent::Impl::Tk based on Tk, very bad choice.
625 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
626 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
627 AnyEvent::Impl::POE based on POE, not generic enough for full support.
628
629There is no support for WxWidgets, as WxWidgets has no support for
630watching file handles. However, you can use WxWidgets through the
631POE Adaptor, as POE has a Wx backend that simply polls 20 times per
632second, which was considered to be too horrible to even consider for
633AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
634it's adaptor.
635
636AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
637autodetecting them.
638 931
639=item AnyEvent::detect 932=item AnyEvent::detect
640 933
641Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
642if necessary. You should only call this function right before you would 935if necessary. You should only call this function right before you would
643have created an AnyEvent watcher anyway, that is, as late as possible at 936have created an AnyEvent watcher anyway, that is, as late as possible at
644runtime. 937runtime, and not e.g. during initialisation of your module.
938
939The effect of calling this function is as if a watcher had been created
940(specifically, actions that happen "when the first watcher is created"
941happen when calling detetc as well).
942
943If you need to do some initialisation before AnyEvent watchers are
944created, use C<post_detect>.
645 945
646=item $guard = AnyEvent::post_detect { BLOCK } 946=item $guard = AnyEvent::post_detect { BLOCK }
647 947
648Arranges for the code block to be executed as soon as the event model is 948Arranges for the code block to be executed as soon as the event model is
649autodetected (or immediately if this has already happened). 949autodetected (or immediately if that has already happened).
950
951The block will be executed I<after> the actual backend has been detected
952(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
953created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
954other initialisations - see the sources of L<AnyEvent::Strict> or
955L<AnyEvent::AIO> to see how this is used.
956
957The most common usage is to create some global watchers, without forcing
958event module detection too early, for example, L<AnyEvent::AIO> creates
959and installs the global L<IO::AIO> watcher in a C<post_detect> block to
960avoid autodetecting the event module at load time.
650 961
651If called in scalar or list context, then it creates and returns an object 962If called in scalar or list context, then it creates and returns an object
652that automatically removes the callback again when it is destroyed. See 963that automatically removes the callback again when it is destroyed (or
964C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
653L<Coro::BDB> for a case where this is useful. 965a case where this is useful.
966
967Example: Create a watcher for the IO::AIO module and store it in
968C<$WATCHER>, but do so only do so after the event loop is initialised.
969
970 our WATCHER;
971
972 my $guard = AnyEvent::post_detect {
973 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
974 };
975
976 # the ||= is important in case post_detect immediately runs the block,
977 # as to not clobber the newly-created watcher. assigning both watcher and
978 # post_detect guard to the same variable has the advantage of users being
979 # able to just C<undef $WATCHER> if the watcher causes them grief.
980
981 $WATCHER ||= $guard;
654 982
655=item @AnyEvent::post_detect 983=item @AnyEvent::post_detect
656 984
657If there are any code references in this array (you can C<push> to it 985If there are any code references in this array (you can C<push> to it
658before or after loading AnyEvent), then they will called directly after 986before or after loading AnyEvent), then they will be called directly
659the event loop has been chosen. 987after the event loop has been chosen.
660 988
661You should check C<$AnyEvent::MODEL> before adding to this array, though: 989You should check C<$AnyEvent::MODEL> before adding to this array, though:
662if it contains a true value then the event loop has already been detected, 990if it is defined then the event loop has already been detected, and the
663and the array will be ignored. 991array will be ignored.
664 992
665Best use C<AnyEvent::post_detect { BLOCK }> instead. 993Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
994it, as it takes care of these details.
995
996This variable is mainly useful for modules that can do something useful
997when AnyEvent is used and thus want to know when it is initialised, but do
998not need to even load it by default. This array provides the means to hook
999into AnyEvent passively, without loading it.
1000
1001Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
1002together, you could put this into Coro (this is the actual code used by
1003Coro to accomplish this):
1004
1005 if (defined $AnyEvent::MODEL) {
1006 # AnyEvent already initialised, so load Coro::AnyEvent
1007 require Coro::AnyEvent;
1008 } else {
1009 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1010 # as soon as it is
1011 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1012 }
1013
1014=item AnyEvent::postpone { BLOCK }
1015
1016Arranges for the block to be executed as soon as possible, but not before
1017the call itself returns. In practise, the block will be executed just
1018before the event loop polls for new events, or shortly afterwards.
1019
1020This function never returns anything (to make the C<return postpone { ...
1021}> idiom more useful.
1022
1023To understand the usefulness of this function, consider a function that
1024asynchronously does something for you and returns some transaction
1025object or guard to let you cancel the operation. For example,
1026C<AnyEvent::Socket::tcp_connect>:
1027
1028 # start a conenction attempt unless one is active
1029 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1030 delete $self->{connect_guard};
1031 ...
1032 };
1033
1034Imagine that this function could instantly call the callback, for
1035example, because it detects an obvious error such as a negative port
1036number. Invoking the callback before the function returns causes problems
1037however: the callback will be called and will try to delete the guard
1038object. But since the function hasn't returned yet, there is nothing to
1039delete. When the function eventually returns it will assign the guard
1040object to C<< $self->{connect_guard} >>, where it will likely never be
1041deleted, so the program thinks it is still trying to connect.
1042
1043This is where C<AnyEvent::postpone> should be used. Instead of calling the
1044callback directly on error:
1045
1046 $cb->(undef), return # signal error to callback, BAD!
1047 if $some_error_condition;
1048
1049It should use C<postpone>:
1050
1051 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1052 if $some_error_condition;
1053
1054=item AnyEvent::log $level, $msg[, @args]
1055
1056Log the given C<$msg> at the given C<$level>.
1057
1058If L<AnyEvent::Log> is not loaded then this function makes a simple test
1059to see whether the message will be logged. If the test succeeds it will
1060load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1061the L<AnyEvent::Log> documentation for details.
1062
1063If the test fails it will simply return. Right now this happens when a
1064numerical loglevel is used and it is larger than the level specified via
1065C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1066
1067If you want to sprinkle loads of logging calls around your code, consider
1068creating a logger callback with the C<AnyEvent::Log::logger> function,
1069which can reduce typing, codesize and can reduce the logging overhead
1070enourmously.
666 1071
667=back 1072=back
668 1073
669=head1 WHAT TO DO IN A MODULE 1074=head1 WHAT TO DO IN A MODULE
670 1075
681because it will stall the whole program, and the whole point of using 1086because it will stall the whole program, and the whole point of using
682events is to stay interactive. 1087events is to stay interactive.
683 1088
684It is fine, however, to call C<< ->recv >> when the user of your module 1089It is fine, however, to call C<< ->recv >> when the user of your module
685requests it (i.e. if you create a http request object ad have a method 1090requests it (i.e. if you create a http request object ad have a method
686called C<results> that returns the results, it should call C<< ->recv >> 1091called C<results> that returns the results, it may call C<< ->recv >>
687freely, as the user of your module knows what she is doing. always). 1092freely, as the user of your module knows what she is doing. Always).
688 1093
689=head1 WHAT TO DO IN THE MAIN PROGRAM 1094=head1 WHAT TO DO IN THE MAIN PROGRAM
690 1095
691There will always be a single main program - the only place that should 1096There will always be a single main program - the only place that should
692dictate which event model to use. 1097dictate which event model to use.
693 1098
694If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1099If the program is not event-based, it need not do anything special, even
695do anything special (it does not need to be event-based) and let AnyEvent 1100when it depends on a module that uses an AnyEvent. If the program itself
696decide which implementation to chose if some module relies on it. 1101uses AnyEvent, but does not care which event loop is used, all it needs
1102to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1103available loop implementation.
697 1104
698If the main program relies on a specific event model - for example, in 1105If the main program relies on a specific event model - for example, in
699Gtk2 programs you have to rely on the Glib module - you should load the 1106Gtk2 programs you have to rely on the Glib module - you should load the
700event module before loading AnyEvent or any module that uses it: generally 1107event module before loading AnyEvent or any module that uses it: generally
701speaking, you should load it as early as possible. The reason is that 1108speaking, you should load it as early as possible. The reason is that
702modules might create watchers when they are loaded, and AnyEvent will 1109modules might create watchers when they are loaded, and AnyEvent will
703decide on the event model to use as soon as it creates watchers, and it 1110decide on the event model to use as soon as it creates watchers, and it
704might chose the wrong one unless you load the correct one yourself. 1111might choose the wrong one unless you load the correct one yourself.
705 1112
706You can chose to use a pure-perl implementation by loading the 1113You can chose to use a pure-perl implementation by loading the
707C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1114C<AnyEvent::Loop> module, which gives you similar behaviour
708everywhere, but letting AnyEvent chose the model is generally better. 1115everywhere, but letting AnyEvent chose the model is generally better.
709 1116
710=head2 MAINLOOP EMULATION 1117=head2 MAINLOOP EMULATION
711 1118
712Sometimes (often for short test scripts, or even standalone programs who 1119Sometimes (often for short test scripts, or even standalone programs who
725 1132
726 1133
727=head1 OTHER MODULES 1134=head1 OTHER MODULES
728 1135
729The following is a non-exhaustive list of additional modules that use 1136The following is a non-exhaustive list of additional modules that use
730AnyEvent and can therefore be mixed easily with other AnyEvent modules 1137AnyEvent as a client and can therefore be mixed easily with other
731in the same program. Some of the modules come with AnyEvent, some are 1138AnyEvent modules and other event loops in the same program. Some of the
732available via CPAN. 1139modules come as part of AnyEvent, the others are available via CPAN (see
1140L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1141a longer non-exhaustive list), and the list is heavily biased towards
1142modules of the AnyEvent author himself :)
733 1143
734=over 4 1144=over 4
735 1145
736=item L<AnyEvent::Util> 1146=item L<AnyEvent::Util>
737 1147
738Contains various utility functions that replace often-used but blocking 1148Contains various utility functions that replace often-used blocking
739functions such as C<inet_aton> by event-/callback-based versions. 1149functions such as C<inet_aton> with event/callback-based versions.
740 1150
741=item L<AnyEvent::Socket> 1151=item L<AnyEvent::Socket>
742 1152
743Provides various utility functions for (internet protocol) sockets, 1153Provides various utility functions for (internet protocol) sockets,
744addresses and name resolution. Also functions to create non-blocking tcp 1154addresses and name resolution. Also functions to create non-blocking tcp
746 1156
747=item L<AnyEvent::Handle> 1157=item L<AnyEvent::Handle>
748 1158
749Provide read and write buffers, manages watchers for reads and writes, 1159Provide read and write buffers, manages watchers for reads and writes,
750supports raw and formatted I/O, I/O queued and fully transparent and 1160supports raw and formatted I/O, I/O queued and fully transparent and
751non-blocking SSL/TLS. 1161non-blocking SSL/TLS (via L<AnyEvent::TLS>).
752 1162
753=item L<AnyEvent::DNS> 1163=item L<AnyEvent::DNS>
754 1164
755Provides rich asynchronous DNS resolver capabilities. 1165Provides rich asynchronous DNS resolver capabilities.
756 1166
1167=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1168
1169Implement event-based interfaces to the protocols of the same name (for
1170the curious, IGS is the International Go Server and FCP is the Freenet
1171Client Protocol).
1172
757=item L<AnyEvent::HTTP> 1173=item L<AnyEvent::AIO>
758 1174
759A simple-to-use HTTP library that is capable of making a lot of concurrent 1175Truly asynchronous (as opposed to non-blocking) I/O, should be in the
760HTTP requests. 1176toolbox of every event programmer. AnyEvent::AIO transparently fuses
1177L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1178file I/O, and much more.
1179
1180=item L<AnyEvent::Filesys::Notify>
1181
1182AnyEvent is good for non-blocking stuff, but it can't detect file or
1183path changes (e.g. "watch this directory for new files", "watch this
1184file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1185do just that in a portbale fashion, supporting inotify on GNU/Linux and
1186some weird, without doubt broken, stuff on OS X to monitor files. It can
1187fall back to blocking scans at regular intervals transparently on other
1188platforms, so it's about as portable as it gets.
1189
1190(I haven't used it myself, but I haven't heard anybody complaining about
1191it yet).
1192
1193=item L<AnyEvent::DBI>
1194
1195Executes L<DBI> requests asynchronously in a proxy process for you,
1196notifying you in an event-based way when the operation is finished.
761 1197
762=item L<AnyEvent::HTTPD> 1198=item L<AnyEvent::HTTPD>
763 1199
764Provides a simple web application server framework. 1200A simple embedded webserver.
765 1201
766=item L<AnyEvent::FastPing> 1202=item L<AnyEvent::FastPing>
767 1203
768The fastest ping in the west. 1204The fastest ping in the west.
769 1205
770=item L<AnyEvent::DBI>
771
772Executes L<DBI> requests asynchronously in a proxy process.
773
774=item L<AnyEvent::AIO>
775
776Truly asynchronous I/O, should be in the toolbox of every event
777programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
778together.
779
780=item L<AnyEvent::BDB>
781
782Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
783L<BDB> and AnyEvent together.
784
785=item L<AnyEvent::GPSD>
786
787A non-blocking interface to gpsd, a daemon delivering GPS information.
788
789=item L<AnyEvent::IGS>
790
791A non-blocking interface to the Internet Go Server protocol (used by
792L<App::IGS>).
793
794=item L<Net::IRC3>
795
796AnyEvent based IRC client module family.
797
798=item L<Net::XMPP2>
799
800AnyEvent based XMPP (Jabber protocol) module family.
801
802=item L<Net::FCP>
803
804AnyEvent-based implementation of the Freenet Client Protocol, birthplace
805of AnyEvent.
806
807=item L<Event::ExecFlow>
808
809High level API for event-based execution flow control.
810
811=item L<Coro> 1206=item L<Coro>
812 1207
813Has special support for AnyEvent via L<Coro::AnyEvent>. 1208Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1209to simply invert the flow control - don't call us, we will call you:
814 1210
815=item L<IO::Lambda> 1211 async {
1212 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1213 print "5 seconds later!\n";
816 1214
817The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 1215 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1216 my $line = <STDIN>; # works for ttys
1217
1218 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1219 my ($body, $hdr) = Coro::rouse_wait;
1220 };
818 1221
819=back 1222=back
820 1223
821=cut 1224=cut
822 1225
823package AnyEvent; 1226package AnyEvent;
824 1227
825no warnings; 1228# basically a tuned-down version of common::sense
826use strict; 1229sub common_sense {
1230 # from common:.sense 3.4
1231 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1232 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1233 $^H |= 0x00000600;
1234}
827 1235
1236BEGIN { AnyEvent::common_sense }
1237
828use Carp; 1238use Carp ();
829 1239
830our $VERSION = 4.2; 1240our $VERSION = '6.02';
831our $MODEL; 1241our $MODEL;
832
833our $AUTOLOAD;
834our @ISA; 1242our @ISA;
835
836our @REGISTRY; 1243our @REGISTRY;
837 1244our $VERBOSE;
838our $WIN32; 1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
839 1247
840BEGIN { 1248BEGIN {
841 my $win32 = ! ! ($^O =~ /mswin32/i); 1249 require "AnyEvent/constants.pl";
842 eval "sub WIN32(){ $win32 }";
843}
844 1250
845our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
846 1252
847our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1253 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1254 if ${^TAINT};
848 1255
849{ 1256 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1257 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1258
1259 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1260 if ${^TAINT};
1261
1262 # $ENV{PERL_ANYEVENT_xxx} now valid
1263
1264 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 3;
1265
850 my $idx; 1266 my $idx;
851 $PROTOCOL{$_} = ++$idx 1267 $PROTOCOL{$_} = ++$idx
852 for reverse split /\s*,\s*/, 1268 for reverse split /\s*,\s*/,
853 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1269 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
854} 1270}
855 1271
1272our @post_detect;
1273
1274sub post_detect(&) {
1275 my ($cb) = @_;
1276
1277 push @post_detect, $cb;
1278
1279 defined wantarray
1280 ? bless \$cb, "AnyEvent::Util::postdetect"
1281 : ()
1282}
1283
1284sub AnyEvent::Util::postdetect::DESTROY {
1285 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1286}
1287
1288our $POSTPONE_W;
1289our @POSTPONE;
1290
1291sub _postpone_exec {
1292 undef $POSTPONE_W;
1293
1294 &{ shift @POSTPONE }
1295 while @POSTPONE;
1296}
1297
1298sub postpone(&) {
1299 push @POSTPONE, shift;
1300
1301 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1302
1303 ()
1304}
1305
1306sub log($$;@) {
1307 # only load the big bloated module when we actually are about to log something
1308 if ($_[0] <= $VERBOSE) { # also catches non-numeric levels(!)
1309 require AnyEvent::Log;
1310 # AnyEvent::Log overwrites this function
1311 goto &log;
1312 }
1313
1314 0 # not logged
1315}
1316
1317if (length $ENV{PERL_ANYEVENT_LOG}) {
1318 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1319}
1320
856my @models = ( 1321our @models = (
857 [EV:: => AnyEvent::Impl::EV::], 1322 [EV:: => AnyEvent::Impl::EV:: , 1],
858 [Event:: => AnyEvent::Impl::Event::], 1323 [AnyEvent::Loop:: => AnyEvent::Impl::Perl:: , 1],
859 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
860 # everything below here will not be autoprobed 1324 # everything below here will not (normally) be autoprobed
861 # as the pureperl backend should work everywhere 1325 # as the pure perl backend should work everywhere
862 # and is usually faster 1326 # and is usually faster
1327 [Event:: => AnyEvent::Impl::Event::, 1],
1328 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1329 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1330 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
863 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1331 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
864 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
865 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
866 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1332 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
867 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1333 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
868 [Wx:: => AnyEvent::Impl::POE::], 1334 [Wx:: => AnyEvent::Impl::POE::],
869 [Prima:: => AnyEvent::Impl::POE::], 1335 [Prima:: => AnyEvent::Impl::POE::],
1336 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1337 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1338 [FLTK:: => AnyEvent::Impl::FLTK::],
870); 1339);
871 1340
872our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1341our @isa_hook;
873 1342
874our @post_detect; 1343sub _isa_set {
1344 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
875 1345
1346 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1347 for 1 .. $#pkg;
1348
1349 grep $_ && $_->[1], @isa_hook
1350 and AE::_reset ();
1351}
1352
1353# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1354sub _isa_hook($$;$) {
1355 my ($i, $pkg, $reset_ae) = @_;
1356
1357 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1358
1359 _isa_set;
1360}
1361
1362# all autoloaded methods reserve the complete glob, not just the method slot.
1363# due to bugs in perls method cache implementation.
1364our @methods = qw(io timer time now now_update signal child idle condvar);
1365
876sub post_detect(&) { 1366sub detect() {
877 my ($cb) = @_; 1367 return $MODEL if $MODEL; # some programs keep references to detect
878 1368
879 if ($MODEL) { 1369 local $!; # for good measure
880 $cb->(); 1370 local $SIG{__DIE__}; # we use eval
881 1371
882 1 1372 # free some memory
1373 *detect = sub () { $MODEL };
1374 # undef &func doesn't correctly update the method cache. grmbl.
1375 # so we delete the whole glob. grmbl.
1376 # otoh, perl doesn't let me undef an active usb, but it lets me free
1377 # a glob with an active sub. hrm. i hope it works, but perl is
1378 # usually buggy in this department. sigh.
1379 delete @{"AnyEvent::"}{@methods};
1380 undef @methods;
1381
1382 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1383 my $model = $1;
1384 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1385 if (eval "require $model") {
1386 AnyEvent::log 7 => "loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1387 $MODEL = $model;
883 } else { 1388 } else {
884 push @post_detect, $cb; 1389 AnyEvent::log 5 => "unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
885 1390 }
886 defined wantarray
887 ? bless \$cb, "AnyEvent::Util::PostDetect"
888 : ()
889 } 1391 }
890}
891 1392
892sub AnyEvent::Util::PostDetect::DESTROY { 1393 # check for already loaded models
893 @post_detect = grep $_ != ${$_[0]}, @post_detect;
894}
895
896sub detect() {
897 unless ($MODEL) { 1394 unless ($MODEL) {
898 no strict 'refs'; 1395 for (@REGISTRY, @models) {
899 local $SIG{__DIE__}; 1396 my ($package, $model) = @$_;
900 1397 if (${"$package\::VERSION"} > 0) {
901 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
902 my $model = "AnyEvent::Impl::$1";
903 if (eval "require $model") { 1398 if (eval "require $model") {
1399 AnyEvent::log 7 => "autodetected model '$model', using it.";
904 $MODEL = $model; 1400 $MODEL = $model;
905 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1401 last;
906 } else { 1402 }
907 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;
908 } 1403 }
909 } 1404 }
910 1405
911 # check for already loaded models
912 unless ($MODEL) { 1406 unless ($MODEL) {
1407 # try to autoload a model
913 for (@REGISTRY, @models) { 1408 for (@REGISTRY, @models) {
914 my ($package, $model) = @$_; 1409 my ($package, $model, $autoload) = @$_;
1410 if (
1411 $autoload
1412 and eval "require $package"
915 if (${"$package\::VERSION"} > 0) { 1413 and ${"$package\::VERSION"} > 0
916 if (eval "require $model") { 1414 and eval "require $model"
1415 ) {
1416 AnyEvent::log 7 => "autoloaded model '$model', using it.";
917 $MODEL = $model; 1417 $MODEL = $model;
918 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
919 last; 1418 last;
920 }
921 } 1419 }
922 } 1420 }
923 1421
924 unless ($MODEL) { 1422 $MODEL
925 # try to load a model 1423 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?";
1424 }
1425 }
926 1426
927 for (@REGISTRY, @models) { 1427 # free memory only needed for probing
928 my ($package, $model) = @$_; 1428 undef @models;
929 if (eval "require $package" 1429 undef @REGISTRY;
930 and ${"$package\::VERSION"} > 0 1430
931 and eval "require $model") { 1431 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
932 $MODEL = $model; 1432
933 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1; 1433 # now nuke some methods that are overridden by the backend.
1434 # SUPER usage is not allowed in these.
1435 for (qw(time signal child idle)) {
1436 undef &{"AnyEvent::Base::$_"}
1437 if defined &{"$MODEL\::$_"};
1438 }
1439
1440 _isa_set;
1441
1442 # we're officially open!
1443
1444 if ($ENV{PERL_ANYEVENT_STRICT}) {
1445 require AnyEvent::Strict;
1446 }
1447
1448 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1449 require AnyEvent::Debug;
1450 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1451 }
1452
1453 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1454 require AnyEvent::Socket;
1455 require AnyEvent::Debug;
1456
1457 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1458 $shell =~ s/\$\$/$$/g;
1459
1460 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1461 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1462 }
1463
1464 # now the anyevent environment is set up as the user told us to, so
1465 # call the actual user code - post detects
1466
1467 (shift @post_detect)->() while @post_detect;
1468 undef @post_detect;
1469
1470 *post_detect = sub(&) {
1471 shift->();
1472
1473 undef
1474 };
1475
1476 $MODEL
1477}
1478
1479for my $name (@methods) {
1480 *$name = sub {
1481 detect;
1482 # we use goto because
1483 # a) it makes the thunk more transparent
1484 # b) it allows us to delete the thunk later
1485 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1486 };
1487}
1488
1489# utility function to dup a filehandle. this is used by many backends
1490# to support binding more than one watcher per filehandle (they usually
1491# allow only one watcher per fd, so we dup it to get a different one).
1492sub _dupfh($$;$$) {
1493 my ($poll, $fh, $r, $w) = @_;
1494
1495 # cygwin requires the fh mode to be matching, unix doesn't
1496 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1497
1498 open my $fh2, $mode, $fh
1499 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1500
1501 # we assume CLOEXEC is already set by perl in all important cases
1502
1503 ($fh2, $rw)
1504}
1505
1506=head1 SIMPLIFIED AE API
1507
1508Starting with version 5.0, AnyEvent officially supports a second, much
1509simpler, API that is designed to reduce the calling, typing and memory
1510overhead by using function call syntax and a fixed number of parameters.
1511
1512See the L<AE> manpage for details.
1513
1514=cut
1515
1516package AE;
1517
1518our $VERSION = $AnyEvent::VERSION;
1519
1520sub _reset() {
1521 eval q{
1522 # fall back to the main API by default - backends and AnyEvent::Base
1523 # implementations can overwrite these.
1524
1525 sub io($$$) {
1526 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1527 }
1528
1529 sub timer($$$) {
1530 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1531 }
1532
1533 sub signal($$) {
1534 AnyEvent->signal (signal => $_[0], cb => $_[1])
1535 }
1536
1537 sub child($$) {
1538 AnyEvent->child (pid => $_[0], cb => $_[1])
1539 }
1540
1541 sub idle($) {
1542 AnyEvent->idle (cb => $_[0]);
1543 }
1544
1545 sub cv(;&) {
1546 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1547 }
1548
1549 sub now() {
1550 AnyEvent->now
1551 }
1552
1553 sub now_update() {
1554 AnyEvent->now_update
1555 }
1556
1557 sub time() {
1558 AnyEvent->time
1559 }
1560
1561 *postpone = \&AnyEvent::postpone;
1562 *log = \&AnyEvent::log;
1563 };
1564 die if $@;
1565}
1566
1567BEGIN { _reset }
1568
1569package AnyEvent::Base;
1570
1571# default implementations for many methods
1572
1573sub time {
1574 eval q{ # poor man's autoloading {}
1575 # probe for availability of Time::HiRes
1576 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1577 *time = sub { Time::HiRes::time () };
1578 *AE::time = \& Time::HiRes::time ;
1579 *now = \&time;
1580 AnyEvent::log 8 => "AnyEvent: using Time::HiRes for sub-second timing accuracy.";
1581 # if (eval "use POSIX (); (POSIX::times())...
1582 } else {
1583 *time = sub { CORE::time };
1584 *AE::time = sub (){ CORE::time };
1585 *now = \&time;
1586 AnyEvent::log 3 => "using built-in time(), WARNING, no sub-second resolution!";
1587 }
1588 };
1589 die if $@;
1590
1591 &time
1592}
1593
1594*now = \&time;
1595sub now_update { }
1596
1597sub _poll {
1598 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1599}
1600
1601# default implementation for ->condvar
1602# in fact, the default should not be overwritten
1603
1604sub condvar {
1605 eval q{ # poor man's autoloading {}
1606 *condvar = sub {
1607 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1608 };
1609
1610 *AE::cv = sub (;&) {
1611 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1612 };
1613 };
1614 die if $@;
1615
1616 &condvar
1617}
1618
1619# default implementation for ->signal
1620
1621our $HAVE_ASYNC_INTERRUPT;
1622
1623sub _have_async_interrupt() {
1624 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1625 && eval "use Async::Interrupt 1.02 (); 1")
1626 unless defined $HAVE_ASYNC_INTERRUPT;
1627
1628 $HAVE_ASYNC_INTERRUPT
1629}
1630
1631our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1632our (%SIG_ASY, %SIG_ASY_W);
1633our ($SIG_COUNT, $SIG_TW);
1634
1635# install a dummy wakeup watcher to reduce signal catching latency
1636# used by Impls
1637sub _sig_add() {
1638 unless ($SIG_COUNT++) {
1639 # try to align timer on a full-second boundary, if possible
1640 my $NOW = AE::now;
1641
1642 $SIG_TW = AE::timer
1643 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1644 $MAX_SIGNAL_LATENCY,
1645 sub { } # just for the PERL_ASYNC_CHECK
1646 ;
1647 }
1648}
1649
1650sub _sig_del {
1651 undef $SIG_TW
1652 unless --$SIG_COUNT;
1653}
1654
1655our $_sig_name_init; $_sig_name_init = sub {
1656 eval q{ # poor man's autoloading {}
1657 undef $_sig_name_init;
1658
1659 if (_have_async_interrupt) {
1660 *sig2num = \&Async::Interrupt::sig2num;
1661 *sig2name = \&Async::Interrupt::sig2name;
1662 } else {
1663 require Config;
1664
1665 my %signame2num;
1666 @signame2num{ split ' ', $Config::Config{sig_name} }
1667 = split ' ', $Config::Config{sig_num};
1668
1669 my @signum2name;
1670 @signum2name[values %signame2num] = keys %signame2num;
1671
1672 *sig2num = sub($) {
1673 $_[0] > 0 ? shift : $signame2num{+shift}
1674 };
1675 *sig2name = sub ($) {
1676 $_[0] > 0 ? $signum2name[+shift] : shift
1677 };
1678 }
1679 };
1680 die if $@;
1681};
1682
1683sub sig2num ($) { &$_sig_name_init; &sig2num }
1684sub sig2name($) { &$_sig_name_init; &sig2name }
1685
1686sub signal {
1687 eval q{ # poor man's autoloading {}
1688 # probe for availability of Async::Interrupt
1689 if (_have_async_interrupt) {
1690 AnyEvent::log 8 => "using Async::Interrupt for race-free signal handling.";
1691
1692 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1693 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1694
1695 } else {
1696 AnyEvent::log 8 => "using emulated perl signal handling with latency timer.";
1697
1698 if (AnyEvent::WIN32) {
1699 require AnyEvent::Util;
1700
1701 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1702 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1703 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1704 } else {
1705 pipe $SIGPIPE_R, $SIGPIPE_W;
1706 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1707 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1708
1709 # not strictly required, as $^F is normally 2, but let's make sure...
1710 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1711 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1712 }
1713
1714 $SIGPIPE_R
1715 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1716
1717 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1718 }
1719
1720 *signal = $HAVE_ASYNC_INTERRUPT
1721 ? sub {
1722 my (undef, %arg) = @_;
1723
1724 # async::interrupt
1725 my $signal = sig2num $arg{signal};
1726 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1727
1728 $SIG_ASY{$signal} ||= new Async::Interrupt
1729 cb => sub { undef $SIG_EV{$signal} },
1730 signal => $signal,
1731 pipe => [$SIGPIPE_R->filenos],
1732 pipe_autodrain => 0,
1733 ;
1734
1735 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1736 }
1737 : sub {
1738 my (undef, %arg) = @_;
1739
1740 # pure perl
1741 my $signal = sig2name $arg{signal};
1742 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1743
1744 $SIG{$signal} ||= sub {
934 last; 1745 local $!;
1746 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1747 undef $SIG_EV{$signal};
935 } 1748 };
1749
1750 # can't do signal processing without introducing races in pure perl,
1751 # so limit the signal latency.
1752 _sig_add;
1753
1754 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1755 }
1756 ;
1757
1758 *AnyEvent::Base::signal::DESTROY = sub {
1759 my ($signal, $cb) = @{$_[0]};
1760
1761 _sig_del;
1762
1763 delete $SIG_CB{$signal}{$cb};
1764
1765 $HAVE_ASYNC_INTERRUPT
1766 ? delete $SIG_ASY{$signal}
1767 : # delete doesn't work with older perls - they then
1768 # print weird messages, or just unconditionally exit
1769 # instead of getting the default action.
1770 undef $SIG{$signal}
1771 unless keys %{ $SIG_CB{$signal} };
1772 };
1773
1774 *_signal_exec = sub {
1775 $HAVE_ASYNC_INTERRUPT
1776 ? $SIGPIPE_R->drain
1777 : sysread $SIGPIPE_R, (my $dummy), 9;
1778
1779 while (%SIG_EV) {
1780 for (keys %SIG_EV) {
1781 delete $SIG_EV{$_};
1782 &$_ for values %{ $SIG_CB{$_} || {} };
936 } 1783 }
937
938 $MODEL
939 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
940 } 1784 }
941 } 1785 };
942
943 unshift @ISA, $MODEL;
944 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
945
946 (shift @post_detect)->() while @post_detect;
947 }
948
949 $MODEL
950}
951
952sub AUTOLOAD {
953 (my $func = $AUTOLOAD) =~ s/.*://;
954
955 $method{$func}
956 or croak "$func: not a valid method for AnyEvent objects";
957
958 detect unless $MODEL;
959
960 my $class = shift;
961 $class->$func (@_);
962}
963
964package AnyEvent::Base;
965
966# default implementation for now and time
967
968use Time::HiRes ();
969
970sub time { Time::HiRes::time }
971sub now { Time::HiRes::time }
972
973# default implementation for ->condvar
974
975sub condvar {
976 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
977}
978
979# default implementation for ->signal
980
981our %SIG_CB;
982
983sub signal {
984 my (undef, %arg) = @_;
985
986 my $signal = uc $arg{signal}
987 or Carp::croak "required option 'signal' is missing";
988
989 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
990 $SIG{$signal} ||= sub {
991 $_->() for values %{ $SIG_CB{$signal} || {} };
992 }; 1786 };
1787 die if $@;
993 1788
994 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1789 &signal
995}
996
997sub AnyEvent::Base::Signal::DESTROY {
998 my ($signal, $cb) = @{$_[0]};
999
1000 delete $SIG_CB{$signal}{$cb};
1001
1002 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1003} 1790}
1004 1791
1005# default implementation for ->child 1792# default implementation for ->child
1006 1793
1007our %PID_CB; 1794our %PID_CB;
1008our $CHLD_W; 1795our $CHLD_W;
1009our $CHLD_DELAY_W; 1796our $CHLD_DELAY_W;
1010our $PID_IDLE;
1011our $WNOHANG;
1012 1797
1013sub _child_wait { 1798# used by many Impl's
1014 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1799sub _emit_childstatus($$) {
1800 my (undef, $rpid, $rstatus) = @_;
1801
1802 $_->($rpid, $rstatus)
1015 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1803 for values %{ $PID_CB{$rpid} || {} },
1016 (values %{ $PID_CB{0} || {} }); 1804 values %{ $PID_CB{0} || {} };
1017 }
1018
1019 undef $PID_IDLE;
1020}
1021
1022sub _sigchld {
1023 # make sure we deliver these changes "synchronous" with the event loop.
1024 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1025 undef $CHLD_DELAY_W;
1026 &_child_wait;
1027 });
1028} 1805}
1029 1806
1030sub child { 1807sub child {
1808 eval q{ # poor man's autoloading {}
1809 *_sigchld = sub {
1810 my $pid;
1811
1812 AnyEvent->_emit_childstatus ($pid, $?)
1813 while ($pid = waitpid -1, WNOHANG) > 0;
1814 };
1815
1816 *child = sub {
1031 my (undef, %arg) = @_; 1817 my (undef, %arg) = @_;
1032 1818
1033 defined (my $pid = $arg{pid} + 0) 1819 my $pid = $arg{pid};
1034 or Carp::croak "required option 'pid' is missing"; 1820 my $cb = $arg{cb};
1035 1821
1036 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1822 $PID_CB{$pid}{$cb+0} = $cb;
1037 1823
1038 unless ($WNOHANG) {
1039 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1040 }
1041
1042 unless ($CHLD_W) { 1824 unless ($CHLD_W) {
1043 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1825 $CHLD_W = AE::signal CHLD => \&_sigchld;
1044 # child could be a zombie already, so make at least one round 1826 # child could be a zombie already, so make at least one round
1045 &_sigchld; 1827 &_sigchld;
1046 } 1828 }
1047 1829
1048 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1830 bless [$pid, $cb+0], "AnyEvent::Base::child"
1049} 1831 };
1050 1832
1051sub AnyEvent::Base::Child::DESTROY { 1833 *AnyEvent::Base::child::DESTROY = sub {
1052 my ($pid, $cb) = @{$_[0]}; 1834 my ($pid, $icb) = @{$_[0]};
1053 1835
1054 delete $PID_CB{$pid}{$cb}; 1836 delete $PID_CB{$pid}{$icb};
1055 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1837 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1056 1838
1057 undef $CHLD_W unless keys %PID_CB; 1839 undef $CHLD_W unless keys %PID_CB;
1840 };
1841 };
1842 die if $@;
1843
1844 &child
1845}
1846
1847# idle emulation is done by simply using a timer, regardless
1848# of whether the process is idle or not, and not letting
1849# the callback use more than 50% of the time.
1850sub idle {
1851 eval q{ # poor man's autoloading {}
1852 *idle = sub {
1853 my (undef, %arg) = @_;
1854
1855 my ($cb, $w, $rcb) = $arg{cb};
1856
1857 $rcb = sub {
1858 if ($cb) {
1859 $w = AE::time;
1860 &$cb;
1861 $w = AE::time - $w;
1862
1863 # never use more then 50% of the time for the idle watcher,
1864 # within some limits
1865 $w = 0.0001 if $w < 0.0001;
1866 $w = 5 if $w > 5;
1867
1868 $w = AE::timer $w, 0, $rcb;
1869 } else {
1870 # clean up...
1871 undef $w;
1872 undef $rcb;
1873 }
1874 };
1875
1876 $w = AE::timer 0.05, 0, $rcb;
1877
1878 bless \\$cb, "AnyEvent::Base::idle"
1879 };
1880
1881 *AnyEvent::Base::idle::DESTROY = sub {
1882 undef $${$_[0]};
1883 };
1884 };
1885 die if $@;
1886
1887 &idle
1058} 1888}
1059 1889
1060package AnyEvent::CondVar; 1890package AnyEvent::CondVar;
1061 1891
1062our @ISA = AnyEvent::CondVar::Base::; 1892our @ISA = AnyEvent::CondVar::Base::;
1063 1893
1894# only to be used for subclassing
1895sub new {
1896 my $class = shift;
1897 bless AnyEvent->condvar (@_), $class
1898}
1899
1064package AnyEvent::CondVar::Base; 1900package AnyEvent::CondVar::Base;
1065 1901
1066use overload 1902#use overload
1067 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1903# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1068 fallback => 1; 1904# fallback => 1;
1905
1906# save 300+ kilobytes by dirtily hardcoding overloading
1907${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1908*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1909*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1910${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1911
1912our $WAITING;
1069 1913
1070sub _send { 1914sub _send {
1071 # nop 1915 # nop
1916}
1917
1918sub _wait {
1919 AnyEvent->_poll until $_[0]{_ae_sent};
1072} 1920}
1073 1921
1074sub send { 1922sub send {
1075 my $cv = shift; 1923 my $cv = shift;
1076 $cv->{_ae_sent} = [@_]; 1924 $cv->{_ae_sent} = [@_];
1085 1933
1086sub ready { 1934sub ready {
1087 $_[0]{_ae_sent} 1935 $_[0]{_ae_sent}
1088} 1936}
1089 1937
1090sub _wait {
1091 AnyEvent->one_event while !$_[0]{_ae_sent};
1092}
1093
1094sub recv { 1938sub recv {
1939 unless ($_[0]{_ae_sent}) {
1940 $WAITING
1941 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1942
1943 local $WAITING = 1;
1095 $_[0]->_wait; 1944 $_[0]->_wait;
1945 }
1096 1946
1097 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1947 $_[0]{_ae_croak}
1098 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1948 and Carp::croak $_[0]{_ae_croak};
1949
1950 wantarray
1951 ? @{ $_[0]{_ae_sent} }
1952 : $_[0]{_ae_sent}[0]
1099} 1953}
1100 1954
1101sub cb { 1955sub cb {
1102 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1956 my $cv = shift;
1957
1958 @_
1959 and $cv->{_ae_cb} = shift
1960 and $cv->{_ae_sent}
1961 and (delete $cv->{_ae_cb})->($cv);
1962
1103 $_[0]{_ae_cb} 1963 $cv->{_ae_cb}
1104} 1964}
1105 1965
1106sub begin { 1966sub begin {
1107 ++$_[0]{_ae_counter}; 1967 ++$_[0]{_ae_counter};
1108 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1968 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1113 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } }; 1973 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1114} 1974}
1115 1975
1116# undocumented/compatibility with pre-3.4 1976# undocumented/compatibility with pre-3.4
1117*broadcast = \&send; 1977*broadcast = \&send;
1118*wait = \&_wait; 1978*wait = \&recv;
1979
1980=head1 ERROR AND EXCEPTION HANDLING
1981
1982In general, AnyEvent does not do any error handling - it relies on the
1983caller to do that if required. The L<AnyEvent::Strict> module (see also
1984the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1985checking of all AnyEvent methods, however, which is highly useful during
1986development.
1987
1988As for exception handling (i.e. runtime errors and exceptions thrown while
1989executing a callback), this is not only highly event-loop specific, but
1990also not in any way wrapped by this module, as this is the job of the main
1991program.
1992
1993The pure perl event loop simply re-throws the exception (usually
1994within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1995$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1996so on.
1997
1998=head1 ENVIRONMENT VARIABLES
1999
2000AnyEvent supports a number of environment variables that tune the
2001runtime behaviour. They are usually evaluated when AnyEvent is
2002loaded, initialised, or a submodule that uses them is loaded. Many of
2003them also cause AnyEvent to load additional modules - for example,
2004C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2005loaded.
2006
2007All the environment variables documented here start with
2008C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
2009namespace. Other modules are encouraged (but by no means required) to use
2010C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2011namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2012be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2013variables starting with C<AE_>, see below).
2014
2015All variables can also be set via the C<AE_> prefix, that is, instead
2016of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2017case there is a clash btween anyevent and another program that uses
2018C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2019variable to the empty string, as those variables take precedence.
2020
2021When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2022to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2023exists. If taint mode is on, then AnyEvent will remove I<all> environment
2024variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2025with C<undef> or the empty string, if the corresaponding C<AE_> variable
2026is set).
2027
2028The exact algorithm is currently:
2029
2030 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2031 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2032 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2033
2034This ensures that child processes will not see the C<AE_> variables.
2035
2036The following environment variables are currently known to AnyEvent:
2037
2038=over 4
2039
2040=item C<PERL_ANYEVENT_VERBOSE>
2041
2042By default, AnyEvent will only log messages with loglevel C<3>
2043(C<critical>) or higher (see L<AnyEvent::Log>). You can set this
2044environment variable to a numerical loglevel to make AnyEvent more (or
2045less) talkative.
2046
2047If you want to do more than just set the global logging level
2048you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2049complex specifications.
2050
2051When set to C<0> (C<off>), then no messages whatsoever will be logged with
2052the default logging settings.
2053
2054When set to C<5> or higher (C<warn>), causes AnyEvent to warn about
2055unexpected conditions, such as not being able to load the event model
2056specified by C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an
2057exception - this is the minimum recommended level.
2058
2059When set to C<7> or higher (info), cause AnyEvent to report which event model it
2060chooses.
2061
2062When set to C<8> or higher (debug), then AnyEvent will report extra information on
2063which optional modules it loads and how it implements certain features.
2064
2065=item C<PERL_ANYEVENT_LOG>
2066
2067Accepts rather complex logging specifications. For example, you could log
2068all C<debug> messages of some module to stderr, warnings and above to
2069stderr, and errors and above to syslog, with:
2070
2071 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2072
2073For the rather extensive details, see L<AnyEvent::Log>.
2074
2075This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2076so will take effect even before AnyEvent has initialised itself.
2077
2078Note that specifying this environment variable causes the L<AnyEvent::Log>
2079module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2080using the latter saves a few hundred kB of memory until the first message
2081is being logged.
2082
2083=item C<PERL_ANYEVENT_STRICT>
2084
2085AnyEvent does not do much argument checking by default, as thorough
2086argument checking is very costly. Setting this variable to a true value
2087will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
2088check the arguments passed to most method calls. If it finds any problems,
2089it will croak.
2090
2091In other words, enables "strict" mode.
2092
2093Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
2094>>, it is definitely recommended to keep it off in production. Keeping
2095C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
2096can be very useful, however.
2097
2098=item C<PERL_ANYEVENT_DEBUG_SHELL>
2099
2100If this env variable is nonempty, then its contents will be interpreted by
2101C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2102replacing every occurance of C<$$> by the process pid). The shell object
2103is saved in C<$AnyEvent::Debug::SHELL>.
2104
2105This happens when the first watcher is created.
2106
2107For example, to bind a debug shell on a unix domain socket in
2108F<< /tmp/debug<pid>.sock >>, you could use this:
2109
2110 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2111 # connect with e.g.: socat readline /tmp/debug123.sock
2112
2113Or to bind to tcp port 4545 on localhost:
2114
2115 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2116 # connect with e.g.: telnet localhost 4545
2117
2118Note that creating sockets in F</tmp> or on localhost is very unsafe on
2119multiuser systems.
2120
2121=item C<PERL_ANYEVENT_DEBUG_WRAP>
2122
2123Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2124debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2125
2126=item C<PERL_ANYEVENT_MODEL>
2127
2128This can be used to specify the event model to be used by AnyEvent, before
2129auto detection and -probing kicks in.
2130
2131It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2132or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
2133resulting module name is loaded and - if the load was successful - used as
2134event model backend. If it fails to load then AnyEvent will proceed with
2135auto detection and -probing.
2136
2137If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2138nothing gets prepended and the module name is used as-is (hint: C<::> at
2139the end of a string designates a module name and quotes it appropriately).
2140
2141For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
2142could start your program like this:
2143
2144 PERL_ANYEVENT_MODEL=Perl perl ...
2145
2146=item C<PERL_ANYEVENT_PROTOCOLS>
2147
2148Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
2149for IPv4 or IPv6. The default is unspecified (and might change, or be the result
2150of auto probing).
2151
2152Must be set to a comma-separated list of protocols or address families,
2153current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
2154used, and preference will be given to protocols mentioned earlier in the
2155list.
2156
2157This variable can effectively be used for denial-of-service attacks
2158against local programs (e.g. when setuid), although the impact is likely
2159small, as the program has to handle conenction and other failures anyways.
2160
2161Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
2162but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
2163- only support IPv4, never try to resolve or contact IPv6
2164addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
2165IPv6, but prefer IPv6 over IPv4.
2166
2167=item C<PERL_ANYEVENT_HOSTS>
2168
2169This variable, if specified, overrides the F</etc/hosts> file used by
2170L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2171from that file instead.
2172
2173=item C<PERL_ANYEVENT_EDNS0>
2174
2175Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
2176DNS. This extension is generally useful to reduce DNS traffic, especially
2177when DNSSEC is involved, but some (broken) firewalls drop such DNS
2178packets, which is why it is off by default.
2179
2180Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
2181EDNS0 in its DNS requests.
2182
2183=item C<PERL_ANYEVENT_MAX_FORKS>
2184
2185The maximum number of child processes that C<AnyEvent::Util::fork_call>
2186will create in parallel.
2187
2188=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
2189
2190The default value for the C<max_outstanding> parameter for the default DNS
2191resolver - this is the maximum number of parallel DNS requests that are
2192sent to the DNS server.
2193
2194=item C<PERL_ANYEVENT_RESOLV_CONF>
2195
2196The absolute path to a F<resolv.conf>-style file to use instead of
2197F</etc/resolv.conf> (or the OS-specific configuration) in the default
2198resolver, or the empty string to select the default configuration.
2199
2200=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
2201
2202When neither C<ca_file> nor C<ca_path> was specified during
2203L<AnyEvent::TLS> context creation, and either of these environment
2204variables are nonempty, they will be used to specify CA certificate
2205locations instead of a system-dependent default.
2206
2207=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
2208
2209When these are set to C<1>, then the respective modules are not
2210loaded. Mostly good for testing AnyEvent itself.
2211
2212=back
1119 2213
1120=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 2214=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1121 2215
1122This is an advanced topic that you do not normally need to use AnyEvent in 2216This is an advanced topic that you do not normally need to use AnyEvent in
1123a module. This section is only of use to event loop authors who want to 2217a module. This section is only of use to event loop authors who want to
1157 2251
1158I<rxvt-unicode> also cheats a bit by not providing blocking access to 2252I<rxvt-unicode> also cheats a bit by not providing blocking access to
1159condition variables: code blocking while waiting for a condition will 2253condition variables: code blocking while waiting for a condition will
1160C<die>. This still works with most modules/usages, and blocking calls must 2254C<die>. This still works with most modules/usages, and blocking calls must
1161not be done in an interactive application, so it makes sense. 2255not be done in an interactive application, so it makes sense.
1162
1163=head1 ENVIRONMENT VARIABLES
1164
1165The following environment variables are used by this module:
1166
1167=over 4
1168
1169=item C<PERL_ANYEVENT_VERBOSE>
1170
1171By default, AnyEvent will be completely silent except in fatal
1172conditions. You can set this environment variable to make AnyEvent more
1173talkative.
1174
1175When set to C<1> or higher, causes AnyEvent to warn about unexpected
1176conditions, such as not being able to load the event model specified by
1177C<PERL_ANYEVENT_MODEL>.
1178
1179When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1180model it chooses.
1181
1182=item C<PERL_ANYEVENT_MODEL>
1183
1184This can be used to specify the event model to be used by AnyEvent, before
1185auto detection and -probing kicks in. It must be a string consisting
1186entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1187and the resulting module name is loaded and if the load was successful,
1188used as event model. If it fails to load AnyEvent will proceed with
1189auto detection and -probing.
1190
1191This functionality might change in future versions.
1192
1193For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1194could start your program like this:
1195
1196 PERL_ANYEVENT_MODEL=Perl perl ...
1197
1198=item C<PERL_ANYEVENT_PROTOCOLS>
1199
1200Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1201for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1202of auto probing).
1203
1204Must be set to a comma-separated list of protocols or address families,
1205current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1206used, and preference will be given to protocols mentioned earlier in the
1207list.
1208
1209This variable can effectively be used for denial-of-service attacks
1210against local programs (e.g. when setuid), although the impact is likely
1211small, as the program has to handle connection errors already-
1212
1213Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1214but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1215- only support IPv4, never try to resolve or contact IPv6
1216addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1217IPv6, but prefer IPv6 over IPv4.
1218
1219=item C<PERL_ANYEVENT_EDNS0>
1220
1221Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1222for DNS. This extension is generally useful to reduce DNS traffic, but
1223some (broken) firewalls drop such DNS packets, which is why it is off by
1224default.
1225
1226Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1227EDNS0 in its DNS requests.
1228
1229=item C<PERL_ANYEVENT_MAX_FORKS>
1230
1231The maximum number of child processes that C<AnyEvent::Util::fork_call>
1232will create in parallel.
1233
1234=back
1235 2256
1236=head1 EXAMPLE PROGRAM 2257=head1 EXAMPLE PROGRAM
1237 2258
1238The following program uses an I/O watcher to read data from STDIN, a timer 2259The following program uses an I/O watcher to read data from STDIN, a timer
1239to display a message once per second, and a condition variable to quit the 2260to display a message once per second, and a condition variable to quit the
1252 warn "read: $input\n"; # output what has been read 2273 warn "read: $input\n"; # output what has been read
1253 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2274 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1254 }, 2275 },
1255 ); 2276 );
1256 2277
1257 my $time_watcher; # can only be used once
1258
1259 sub new_timer {
1260 $timer = AnyEvent->timer (after => 1, cb => sub { 2278 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1261 warn "timeout\n"; # print 'timeout' about every second 2279 warn "timeout\n"; # print 'timeout' at most every second
1262 &new_timer; # and restart the time
1263 }); 2280 });
1264 }
1265
1266 new_timer; # create first timer
1267 2281
1268 $cv->recv; # wait until user enters /^q/i 2282 $cv->recv; # wait until user enters /^q/i
1269 2283
1270=head1 REAL-WORLD EXAMPLE 2284=head1 REAL-WORLD EXAMPLE
1271 2285
1344 2358
1345The actual code goes further and collects all errors (C<die>s, exceptions) 2359The actual code goes further and collects all errors (C<die>s, exceptions)
1346that occurred during request processing. The C<result> method detects 2360that occurred during request processing. The C<result> method detects
1347whether an exception as thrown (it is stored inside the $txn object) 2361whether an exception as thrown (it is stored inside the $txn object)
1348and just throws the exception, which means connection errors and other 2362and just throws the exception, which means connection errors and other
1349problems get reported tot he code that tries to use the result, not in a 2363problems get reported to the code that tries to use the result, not in a
1350random callback. 2364random callback.
1351 2365
1352All of this enables the following usage styles: 2366All of this enables the following usage styles:
1353 2367
13541. Blocking: 23681. Blocking:
1402through AnyEvent. The benchmark creates a lot of timers (with a zero 2416through AnyEvent. The benchmark creates a lot of timers (with a zero
1403timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2417timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1404which it is), lets them fire exactly once and destroys them again. 2418which it is), lets them fire exactly once and destroys them again.
1405 2419
1406Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2420Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1407distribution. 2421distribution. It uses the L<AE> interface, which makes a real difference
2422for the EV and Perl backends only.
1408 2423
1409=head3 Explanation of the columns 2424=head3 Explanation of the columns
1410 2425
1411I<watcher> is the number of event watchers created/destroyed. Since 2426I<watcher> is the number of event watchers created/destroyed. Since
1412different event models feature vastly different performances, each event 2427different event models feature vastly different performances, each event
1433watcher. 2448watcher.
1434 2449
1435=head3 Results 2450=head3 Results
1436 2451
1437 name watchers bytes create invoke destroy comment 2452 name watchers bytes create invoke destroy comment
1438 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 2453 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1439 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 2454 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1440 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 2455 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1441 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 2456 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1442 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 2457 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1443 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 2458 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2459 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2460 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1444 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 2461 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1445 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 2462 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1446 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 2463 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1447 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 2464 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1448 2465
1449=head3 Discussion 2466=head3 Discussion
1450 2467
1451The benchmark does I<not> measure scalability of the event loop very 2468The benchmark does I<not> measure scalability of the event loop very
1452well. For example, a select-based event loop (such as the pure perl one) 2469well. For example, a select-based event loop (such as the pure perl one)
1464benchmark machine, handling an event takes roughly 1600 CPU cycles with 2481benchmark machine, handling an event takes roughly 1600 CPU cycles with
1465EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2482EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1466cycles with POE. 2483cycles with POE.
1467 2484
1468C<EV> is the sole leader regarding speed and memory use, which are both 2485C<EV> is the sole leader regarding speed and memory use, which are both
1469maximal/minimal, respectively. Even when going through AnyEvent, it uses 2486maximal/minimal, respectively. When using the L<AE> API there is zero
2487overhead (when going through the AnyEvent API create is about 5-6 times
2488slower, with other times being equal, so still uses far less memory than
1470far less memory than any other event loop and is still faster than Event 2489any other event loop and is still faster than Event natively).
1471natively.
1472 2490
1473The pure perl implementation is hit in a few sweet spots (both the 2491The pure perl implementation is hit in a few sweet spots (both the
1474constant timeout and the use of a single fd hit optimisations in the perl 2492constant timeout and the use of a single fd hit optimisations in the perl
1475interpreter and the backend itself). Nevertheless this shows that it 2493interpreter and the backend itself). Nevertheless this shows that it
1476adds very little overhead in itself. Like any select-based backend its 2494adds very little overhead in itself. Like any select-based backend its
1477performance becomes really bad with lots of file descriptors (and few of 2495performance becomes really bad with lots of file descriptors (and few of
1478them active), of course, but this was not subject of this benchmark. 2496them active), of course, but this was not subject of this benchmark.
1479 2497
1480The C<Event> module has a relatively high setup and callback invocation 2498The C<Event> module has a relatively high setup and callback invocation
1481cost, but overall scores in on the third place. 2499cost, but overall scores in on the third place.
2500
2501C<IO::Async> performs admirably well, about on par with C<Event>, even
2502when using its pure perl backend.
1482 2503
1483C<Glib>'s memory usage is quite a bit higher, but it features a 2504C<Glib>'s memory usage is quite a bit higher, but it features a
1484faster callback invocation and overall ends up in the same class as 2505faster callback invocation and overall ends up in the same class as
1485C<Event>. However, Glib scales extremely badly, doubling the number of 2506C<Event>. However, Glib scales extremely badly, doubling the number of
1486watchers increases the processing time by more than a factor of four, 2507watchers increases the processing time by more than a factor of four,
1521(even when used without AnyEvent), but most event loops have acceptable 2542(even when used without AnyEvent), but most event loops have acceptable
1522performance with or without AnyEvent. 2543performance with or without AnyEvent.
1523 2544
1524=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2545=item * The overhead AnyEvent adds is usually much smaller than the overhead of
1525the actual event loop, only with extremely fast event loops such as EV 2546the actual event loop, only with extremely fast event loops such as EV
1526adds AnyEvent significant overhead. 2547does AnyEvent add significant overhead.
1527 2548
1528=item * You should avoid POE like the plague if you want performance or 2549=item * You should avoid POE like the plague if you want performance or
1529reasonable memory usage. 2550reasonable memory usage.
1530 2551
1531=back 2552=back
1547In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2568In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1548(1%) are active. This mirrors the activity of large servers with many 2569(1%) are active. This mirrors the activity of large servers with many
1549connections, most of which are idle at any one point in time. 2570connections, most of which are idle at any one point in time.
1550 2571
1551Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2572Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1552distribution. 2573distribution. It uses the L<AE> interface, which makes a real difference
2574for the EV and Perl backends only.
1553 2575
1554=head3 Explanation of the columns 2576=head3 Explanation of the columns
1555 2577
1556I<sockets> is the number of sockets, and twice the number of "servers" (as 2578I<sockets> is the number of sockets, and twice the number of "servers" (as
1557each server has a read and write socket end). 2579each server has a read and write socket end).
1564it to another server. This includes deleting the old timeout and creating 2586it to another server. This includes deleting the old timeout and creating
1565a new one that moves the timeout into the future. 2587a new one that moves the timeout into the future.
1566 2588
1567=head3 Results 2589=head3 Results
1568 2590
1569 name sockets create request 2591 name sockets create request
1570 EV 20000 69.01 11.16 2592 EV 20000 62.66 7.99
1571 Perl 20000 73.32 35.87 2593 Perl 20000 68.32 32.64
1572 Event 20000 212.62 257.32 2594 IOAsync 20000 174.06 101.15 epoll
1573 Glib 20000 651.16 1896.30 2595 IOAsync 20000 174.67 610.84 poll
2596 Event 20000 202.69 242.91
2597 Glib 20000 557.01 1689.52
1574 POE 20000 349.67 12317.24 uses POE::Loop::Event 2598 POE 20000 341.54 12086.32 uses POE::Loop::Event
1575 2599
1576=head3 Discussion 2600=head3 Discussion
1577 2601
1578This benchmark I<does> measure scalability and overall performance of the 2602This benchmark I<does> measure scalability and overall performance of the
1579particular event loop. 2603particular event loop.
1581EV is again fastest. Since it is using epoll on my system, the setup time 2605EV is again fastest. Since it is using epoll on my system, the setup time
1582is relatively high, though. 2606is relatively high, though.
1583 2607
1584Perl surprisingly comes second. It is much faster than the C-based event 2608Perl surprisingly comes second. It is much faster than the C-based event
1585loops Event and Glib. 2609loops Event and Glib.
2610
2611IO::Async performs very well when using its epoll backend, and still quite
2612good compared to Glib when using its pure perl backend.
1586 2613
1587Event suffers from high setup time as well (look at its code and you will 2614Event suffers from high setup time as well (look at its code and you will
1588understand why). Callback invocation also has a high overhead compared to 2615understand why). Callback invocation also has a high overhead compared to
1589the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2616the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1590uses select or poll in basically all documented configurations. 2617uses select or poll in basically all documented configurations.
1653=item * C-based event loops perform very well with small number of 2680=item * C-based event loops perform very well with small number of
1654watchers, as the management overhead dominates. 2681watchers, as the management overhead dominates.
1655 2682
1656=back 2683=back
1657 2684
2685=head2 THE IO::Lambda BENCHMARK
2686
2687Recently I was told about the benchmark in the IO::Lambda manpage, which
2688could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
2689simply compares IO::Lambda with POE, and IO::Lambda looks better (which
2690shouldn't come as a surprise to anybody). As such, the benchmark is
2691fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
2692very optimal. But how would AnyEvent compare when used without the extra
2693baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
2694
2695The benchmark itself creates an echo-server, and then, for 500 times,
2696connects to the echo server, sends a line, waits for the reply, and then
2697creates the next connection. This is a rather bad benchmark, as it doesn't
2698test the efficiency of the framework or much non-blocking I/O, but it is a
2699benchmark nevertheless.
2700
2701 name runtime
2702 Lambda/select 0.330 sec
2703 + optimized 0.122 sec
2704 Lambda/AnyEvent 0.327 sec
2705 + optimized 0.138 sec
2706 Raw sockets/select 0.077 sec
2707 POE/select, components 0.662 sec
2708 POE/select, raw sockets 0.226 sec
2709 POE/select, optimized 0.404 sec
2710
2711 AnyEvent/select/nb 0.085 sec
2712 AnyEvent/EV/nb 0.068 sec
2713 +state machine 0.134 sec
2714
2715The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
2716benchmarks actually make blocking connects and use 100% blocking I/O,
2717defeating the purpose of an event-based solution. All of the newly
2718written AnyEvent benchmarks use 100% non-blocking connects (using
2719AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2720resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2721generally require a lot more bookkeeping and event handling than blocking
2722connects (which involve a single syscall only).
2723
2724The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2725offers similar expressive power as POE and IO::Lambda, using conventional
2726Perl syntax. This means that both the echo server and the client are 100%
2727non-blocking, further placing it at a disadvantage.
2728
2729As you can see, the AnyEvent + EV combination even beats the
2730hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2731backend easily beats IO::Lambda and POE.
2732
2733And even the 100% non-blocking version written using the high-level (and
2734slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2735higher level ("unoptimised") abstractions by a large margin, even though
2736it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2737
2738The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2739F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2740part of the IO::Lambda distribution and were used without any changes.
2741
2742
2743=head1 SIGNALS
2744
2745AnyEvent currently installs handlers for these signals:
2746
2747=over 4
2748
2749=item SIGCHLD
2750
2751A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2752emulation for event loops that do not support them natively. Also, some
2753event loops install a similar handler.
2754
2755Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2756AnyEvent will reset it to default, to avoid losing child exit statuses.
2757
2758=item SIGPIPE
2759
2760A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2761when AnyEvent gets loaded.
2762
2763The rationale for this is that AnyEvent users usually do not really depend
2764on SIGPIPE delivery (which is purely an optimisation for shell use, or
2765badly-written programs), but C<SIGPIPE> can cause spurious and rare
2766program exits as a lot of people do not expect C<SIGPIPE> when writing to
2767some random socket.
2768
2769The rationale for installing a no-op handler as opposed to ignoring it is
2770that this way, the handler will be restored to defaults on exec.
2771
2772Feel free to install your own handler, or reset it to defaults.
2773
2774=back
2775
2776=cut
2777
2778undef $SIG{CHLD}
2779 if $SIG{CHLD} eq 'IGNORE';
2780
2781$SIG{PIPE} = sub { }
2782 unless defined $SIG{PIPE};
2783
2784=head1 RECOMMENDED/OPTIONAL MODULES
2785
2786One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2787its built-in modules) are required to use it.
2788
2789That does not mean that AnyEvent won't take advantage of some additional
2790modules if they are installed.
2791
2792This section explains which additional modules will be used, and how they
2793affect AnyEvent's operation.
2794
2795=over 4
2796
2797=item L<Async::Interrupt>
2798
2799This slightly arcane module is used to implement fast signal handling: To
2800my knowledge, there is no way to do completely race-free and quick
2801signal handling in pure perl. To ensure that signals still get
2802delivered, AnyEvent will start an interval timer to wake up perl (and
2803catch the signals) with some delay (default is 10 seconds, look for
2804C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2805
2806If this module is available, then it will be used to implement signal
2807catching, which means that signals will not be delayed, and the event loop
2808will not be interrupted regularly, which is more efficient (and good for
2809battery life on laptops).
2810
2811This affects not just the pure-perl event loop, but also other event loops
2812that have no signal handling on their own (e.g. Glib, Tk, Qt).
2813
2814Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2815and either employ their own workarounds (POE) or use AnyEvent's workaround
2816(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2817does nothing for those backends.
2818
2819=item L<EV>
2820
2821This module isn't really "optional", as it is simply one of the backend
2822event loops that AnyEvent can use. However, it is simply the best event
2823loop available in terms of features, speed and stability: It supports
2824the AnyEvent API optimally, implements all the watcher types in XS, does
2825automatic timer adjustments even when no monotonic clock is available,
2826can take avdantage of advanced kernel interfaces such as C<epoll> and
2827C<kqueue>, and is the fastest backend I<by far>. You can even embed
2828L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2829
2830If you only use backends that rely on another event loop (e.g. C<Tk>),
2831then this module will do nothing for you.
2832
2833=item L<Guard>
2834
2835The guard module, when used, will be used to implement
2836C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2837lot less memory), but otherwise doesn't affect guard operation much. It is
2838purely used for performance.
2839
2840=item L<JSON> and L<JSON::XS>
2841
2842One of these modules is required when you want to read or write JSON data
2843via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2844advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2845
2846=item L<Net::SSLeay>
2847
2848Implementing TLS/SSL in Perl is certainly interesting, but not very
2849worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2850the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2851
2852=item L<Time::HiRes>
2853
2854This module is part of perl since release 5.008. It will be used when the
2855chosen event library does not come with a timing source of its own. The
2856pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2857try to use a monotonic clock for timing stability.
2858
2859=back
2860
1658 2861
1659=head1 FORK 2862=head1 FORK
1660 2863
1661Most event libraries are not fork-safe. The ones who are usually are 2864Most event libraries are not fork-safe. The ones who are usually are
1662because they rely on inefficient but fork-safe C<select> or C<poll> 2865because they rely on inefficient but fork-safe C<select> or C<poll> calls
1663calls. Only L<EV> is fully fork-aware. 2866- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2867are usually badly thought-out hacks that are incompatible with fork in
2868one way or another. Only L<EV> is fully fork-aware and ensures that you
2869continue event-processing in both parent and child (or both, if you know
2870what you are doing).
2871
2872This means that, in general, you cannot fork and do event processing in
2873the child if the event library was initialised before the fork (which
2874usually happens when the first AnyEvent watcher is created, or the library
2875is loaded).
1664 2876
1665If you have to fork, you must either do so I<before> creating your first 2877If you have to fork, you must either do so I<before> creating your first
1666watcher OR you must not use AnyEvent at all in the child. 2878watcher OR you must not use AnyEvent at all in the child OR you must do
2879something completely out of the scope of AnyEvent.
2880
2881The problem of doing event processing in the parent I<and> the child
2882is much more complicated: even for backends that I<are> fork-aware or
2883fork-safe, their behaviour is not usually what you want: fork clones all
2884watchers, that means all timers, I/O watchers etc. are active in both
2885parent and child, which is almost never what you want. USing C<exec>
2886to start worker children from some kind of manage rprocess is usually
2887preferred, because it is much easier and cleaner, at the expense of having
2888to have another binary.
1667 2889
1668 2890
1669=head1 SECURITY CONSIDERATIONS 2891=head1 SECURITY CONSIDERATIONS
1670 2892
1671AnyEvent can be forced to load any event model via 2893AnyEvent can be forced to load any event model via
1682 2904
1683 use AnyEvent; 2905 use AnyEvent;
1684 2906
1685Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2907Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1686be used to probe what backend is used and gain other information (which is 2908be used to probe what backend is used and gain other information (which is
1687probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 2909probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
2910$ENV{PERL_ANYEVENT_STRICT}.
2911
2912Note that AnyEvent will remove I<all> environment variables starting with
2913C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2914enabled.
1688 2915
1689 2916
1690=head1 BUGS 2917=head1 BUGS
1691 2918
1692Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2919Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1693to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2920to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1694and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2921and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1695mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2922memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1696pronounced). 2923pronounced).
1697 2924
1698 2925
1699=head1 SEE ALSO 2926=head1 SEE ALSO
1700 2927
1701Utility functions: L<AnyEvent::Util>. 2928Tutorial/Introduction: L<AnyEvent::Intro>.
1702 2929
1703Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 2930FAQ: L<AnyEvent::FAQ>.
1704L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2931
2932Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
2933(simply logging).
2934
2935Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2936L<AnyEvent::Debug> (interactive shell, watcher tracing).
2937
2938Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
2939L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
2940L<Qt>, L<POE>, L<FLTK>.
1705 2941
1706Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2942Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1707L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2943L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1708L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2944L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2945L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
1709L<AnyEvent::Impl::POE>. 2946L<AnyEvent::Impl::FLTK>.
1710 2947
1711Non-blocking file handles, sockets, TCP clients and 2948Non-blocking handles, pipes, stream sockets, TCP clients and
1712servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2949servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
1713 2950
1714Asynchronous DNS: L<AnyEvent::DNS>. 2951Asynchronous DNS: L<AnyEvent::DNS>.
1715 2952
1716Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2953Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
1717 2954
1718Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2955Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::IRC>,
2956L<AnyEvent::HTTP>.
1719 2957
1720 2958
1721=head1 AUTHOR 2959=head1 AUTHOR
1722 2960
1723 Marc Lehmann <schmorp@schmorp.de> 2961 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines