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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines