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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines