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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines