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.219 by root, Thu Jun 25 11:16:08 2009 UTC vs.
Revision 1.331 by root, Tue Aug 31 01:00:48 2010 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. 6and 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
51There is a mailinglist for discussing all things AnyEvent, and an IRC
52channel, too.
53
54See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
55Repository>, at L<http://anyevent.schmorp.de>, for more info.
45 56
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 57=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 58
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 59Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 60nowadays. So what is different about AnyEvent?
65module users into the same thing by forcing them to use the same event 76module users into the same thing by forcing them to use the same event
66model you use. 77model you use.
67 78
68For modules like POE or IO::Async (which is a total misnomer as it is 79For 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 80actually 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 81like joining a cult: After you join, you are dependent on them and you
71cannot use anything else, as they are simply incompatible to everything 82cannot use anything else, as they are simply incompatible to everything
72that isn't them. What's worse, all the potential users of your 83that 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. 84module are I<also> forced to use the same event loop you use.
74 85
75AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 86AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
76fine. AnyEvent + Tk works fine etc. etc. but none of these work together 87fine. 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 88with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
78your module uses one of those, every user of your module has to use it, 89your module uses one of those, every user of your module has to use it,
79too. But if your module uses AnyEvent, it works transparently with all 90too. But if your module uses AnyEvent, it works transparently with all
80event models it supports (including stuff like IO::Async, as long as those 91event models it supports (including stuff like IO::Async, as long as those
81use one of the supported event loops. It is trivial to add new event loops 92use one of the supported event loops. It is easy to add new event loops
82to AnyEvent, too, so it is future-proof). 93to AnyEvent, too, so it is future-proof).
83 94
84In addition to being free of having to use I<the one and only true event 95In 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 96model>, 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 97modules, 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 98follow. 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 99offering the functionality that is necessary, in as thin as a wrapper as
89technically possible. 100technically possible.
90 101
91Of course, AnyEvent comes with a big (and fully optional!) toolbox 102Of course, AnyEvent comes with a big (and fully optional!) toolbox
92of useful functionality, such as an asynchronous DNS resolver, 100% 103of useful functionality, such as an asynchronous DNS resolver, 100%
98useful) and you want to force your users to use the one and only event 109useful) and you want to force your users to use the one and only event
99model, you should I<not> use this module. 110model, you should I<not> use this module.
100 111
101=head1 DESCRIPTION 112=head1 DESCRIPTION
102 113
103L<AnyEvent> provides an identical interface to multiple event loops. This 114L<AnyEvent> provides a uniform interface to various event loops. This
104allows module authors to utilise an event loop without forcing module 115allows module authors to use event loop functionality without forcing
105users to use the same event loop (as only a single event loop can coexist 116module users to use a specific event loop implementation (since more
106peacefully at any one time). 117than one event loop cannot coexist peacefully).
107 118
108The interface itself is vaguely similar, but not identical to the L<Event> 119The interface itself is vaguely similar, but not identical to the L<Event>
109module. 120module.
110 121
111During the first call of any watcher-creation method, the module tries 122During the first call of any watcher-creation method, the module tries
112to detect the currently loaded event loop by probing whether one of the 123to detect the currently loaded event loop by probing whether one of the
113following modules is already loaded: L<EV>, 124following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>,
114L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 125L<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 126found 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 127four 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 128available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so
118be successfully loaded will be used. If, after this, still none could be 129the 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 130
122Because AnyEvent first checks for modules that are already loaded, loading 131Because AnyEvent first checks for modules that are already loaded, loading
123an event model explicitly before first using AnyEvent will likely make 132an event model explicitly before first using AnyEvent will likely make
124that model the default. For example: 133that model the default. For example:
125 134
127 use AnyEvent; 136 use AnyEvent;
128 137
129 # .. AnyEvent will likely default to Tk 138 # .. AnyEvent will likely default to Tk
130 139
131The I<likely> means that, if any module loads another event model and 140The 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 141starts using it, all bets are off - this case should be very rare though,
133use AnyEvent so their modules work together with others seamlessly... 142as very few modules hardcode event loops without announcing this very
143loudly.
134 144
135The pure-perl implementation of AnyEvent is called 145The pure-perl implementation of AnyEvent is called
136C<AnyEvent::Impl::Perl>. Like other event modules you can load it 146C<AnyEvent::Impl::Perl>. Like other event modules you can load it
137explicitly and enjoy the high availability of that event loop :) 147explicitly and enjoy the high availability of that event loop :)
138 148
147callback when the event occurs (of course, only when the event model 157callback when the event occurs (of course, only when the event model
148is in control). 158is in control).
149 159
150Note that B<callbacks must not permanently change global variables> 160Note that B<callbacks must not permanently change global variables>
151potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< 161potentially 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 162callbacks must not C<die> >>. The former is good programming practice in
153Perl and the latter stems from the fact that exception handling differs 163Perl and the latter stems from the fact that exception handling differs
154widely between event loops. 164widely between event loops.
155 165
156To disable the watcher you have to destroy it (e.g. by setting the 166To 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 167variable you store it in to C<undef> or otherwise deleting all references
158to it). 168to it).
159 169
160All watchers are created by calling a method on the C<AnyEvent> class. 170All watchers are created by calling a method on the C<AnyEvent> class.
161 171
162Many watchers either are used with "recursion" (repeating timers for 172Many watchers either are used with "recursion" (repeating timers for
163example), or need to refer to their watcher object in other ways. 173example), or need to refer to their watcher object in other ways.
164 174
165An any way to achieve that is this pattern: 175One way to achieve that is this pattern:
166 176
167 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 177 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
168 # you can use $w here, for example to undef it 178 # you can use $w here, for example to undef it
169 undef $w; 179 undef $w;
170 }); 180 });
173my variables are only visible after the statement in which they are 183my variables are only visible after the statement in which they are
174declared. 184declared.
175 185
176=head2 I/O WATCHERS 186=head2 I/O WATCHERS
177 187
188 $w = AnyEvent->io (
189 fh => <filehandle_or_fileno>,
190 poll => <"r" or "w">,
191 cb => <callback>,
192 );
193
178You can create an I/O watcher by calling the C<< AnyEvent->io >> method 194You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179with the following mandatory key-value pairs as arguments: 195with the following mandatory key-value pairs as arguments:
180 196
181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch 197C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182for events (AnyEvent might or might not keep a reference to this file 198for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which 199handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets, 200non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files 201most character devices, pipes, fifos and so on, but not for example files
186or block devices. 202or block devices.
196 212
197The I/O watcher might use the underlying file descriptor or a copy of it. 213The 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 214You must not close a file handle as long as any watcher is active on the
199underlying file descriptor. 215underlying file descriptor.
200 216
201Some event loops issue spurious readyness notifications, so you should 217Some event loops issue spurious readiness notifications, so you should
202always use non-blocking calls when reading/writing from/to your file 218always use non-blocking calls when reading/writing from/to your file
203handles. 219handles.
204 220
205Example: wait for readability of STDIN, then read a line and disable the 221Example: wait for readability of STDIN, then read a line and disable the
206watcher. 222watcher.
211 undef $w; 227 undef $w;
212 }); 228 });
213 229
214=head2 TIME WATCHERS 230=head2 TIME WATCHERS
215 231
232 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
233
234 $w = AnyEvent->timer (
235 after => <fractional_seconds>,
236 interval => <fractional_seconds>,
237 cb => <callback>,
238 );
239
216You can create a time watcher by calling the C<< AnyEvent->timer >> 240You can create a time watcher by calling the C<< AnyEvent->timer >>
217method with the following mandatory arguments: 241method with the following mandatory arguments:
218 242
219C<after> specifies after how many seconds (fractional values are 243C<after> specifies after how many seconds (fractional values are
220supported) the callback should be invoked. C<cb> is the callback to invoke 244supported) the callback should be invoked. C<cb> is the callback to invoke
222 246
223Although the callback might get passed parameters, their value and 247Although the callback might get passed parameters, their value and
224presence is undefined and you cannot rely on them. Portable AnyEvent 248presence is undefined and you cannot rely on them. Portable AnyEvent
225callbacks cannot use arguments passed to time watcher callbacks. 249callbacks cannot use arguments passed to time watcher callbacks.
226 250
227The callback will normally be invoked once only. If you specify another 251The callback will normally be invoked only once. If you specify another
228parameter, C<interval>, as a strictly positive number (> 0), then the 252parameter, C<interval>, as a strictly positive number (> 0), then the
229callback will be invoked regularly at that interval (in fractional 253callback will be invoked regularly at that interval (in fractional
230seconds) after the first invocation. If C<interval> is specified with a 254seconds) after the first invocation. If C<interval> is specified with a
231false value, then it is treated as if it were missing. 255false value, then it is treated as if it were not specified at all.
232 256
233The callback will be rescheduled before invoking the callback, but no 257The callback will be rescheduled before invoking the callback, but no
234attempt is done to avoid timer drift in most backends, so the interval is 258attempt is made to avoid timer drift in most backends, so the interval is
235only approximate. 259only approximate.
236 260
237Example: fire an event after 7.7 seconds. 261Example: fire an event after 7.7 seconds.
238 262
239 my $w = AnyEvent->timer (after => 7.7, cb => sub { 263 my $w = AnyEvent->timer (after => 7.7, cb => sub {
257 281
258While most event loops expect timers to specified in a relative way, they 282While most event loops expect timers to specified in a relative way, they
259use absolute time internally. This makes a difference when your clock 283use absolute time internally. This makes a difference when your clock
260"jumps", for example, when ntp decides to set your clock backwards from 284"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 285the 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. 286fire "after a second" might actually take six years to finally fire.
263 287
264AnyEvent cannot compensate for this. The only event loop that is conscious 288AnyEvent cannot compensate for this. The only event loop that is conscious
265about these issues is L<EV>, which offers both relative (ev_timer, based 289of these issues is L<EV>, which offers both relative (ev_timer, based
266on true relative time) and absolute (ev_periodic, based on wallclock time) 290on true relative time) and absolute (ev_periodic, based on wallclock time)
267timers. 291timers.
268 292
269AnyEvent always prefers relative timers, if available, matching the 293AnyEvent always prefers relative timers, if available, matching the
270AnyEvent API. 294AnyEvent API.
292I<In almost all cases (in all cases if you don't care), this is the 316I<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.> 317function to call when you want to know the current time.>
294 318
295This function is also often faster then C<< AnyEvent->time >>, and 319This function is also often faster then C<< AnyEvent->time >>, and
296thus the preferred method if you want some timestamp (for example, 320thus the preferred method if you want some timestamp (for example,
297L<AnyEvent::Handle> uses this to update it's activity timeouts). 321L<AnyEvent::Handle> uses this to update its activity timeouts).
298 322
299The rest of this section is only of relevance if you try to be very exact 323The 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. 324with your timing; you can skip it without a bad conscience.
301 325
302For a practical example of when these times differ, consider L<Event::Lib> 326For a practical example of when these times differ, consider L<Event::Lib>
303and L<EV> and the following set-up: 327and L<EV> and the following set-up:
304 328
305The event loop is running and has just invoked one of your callback at 329The event loop is running and has just invoked one of your callbacks at
306time=500 (assume no other callbacks delay processing). In your callback, 330time=500 (assume no other callbacks delay processing). In your callback,
307you wait a second by executing C<sleep 1> (blocking the process for a 331you 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 332second) and then (at time=501) you create a relative timer that fires
309after three seconds. 333after three seconds.
310 334
341might affect timers and time-outs. 365might affect timers and time-outs.
342 366
343When this is the case, you can call this method, which will update the 367When this is the case, you can call this method, which will update the
344event loop's idea of "current time". 368event loop's idea of "current time".
345 369
370A typical example would be a script in a web server (e.g. C<mod_perl>) -
371when mod_perl executes the script, then the event loop will have the wrong
372idea about the "current time" (being potentially far in the past, when the
373script ran the last time). In that case you should arrange a call to C<<
374AnyEvent->now_update >> each time the web server process wakes up again
375(e.g. at the start of your script, or in a handler).
376
346Note that updating the time I<might> cause some events to be handled. 377Note that updating the time I<might> cause some events to be handled.
347 378
348=back 379=back
349 380
350=head2 SIGNAL WATCHERS 381=head2 SIGNAL WATCHERS
382
383 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
351 384
352You can watch for signals using a signal watcher, C<signal> is the signal 385You 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 386I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
354callback to be invoked whenever a signal occurs. 387callback to be invoked whenever a signal occurs.
355 388
361invocation, and callback invocation will be synchronous. Synchronous means 394invocation, and callback invocation will be synchronous. Synchronous means
362that it might take a while until the signal gets handled by the process, 395that it might take a while until the signal gets handled by the process,
363but it is guaranteed not to interrupt any other callbacks. 396but it is guaranteed not to interrupt any other callbacks.
364 397
365The main advantage of using these watchers is that you can share a signal 398The main advantage of using these watchers is that you can share a signal
366between multiple watchers. 399between multiple watchers, and AnyEvent will ensure that signals will not
400interrupt your program at bad times.
367 401
368This watcher might use C<%SIG>, so programs overwriting those signals 402This watcher might use C<%SIG> (depending on the event loop used),
369directly will likely not work correctly. 403so programs overwriting those signals directly will likely not work
404correctly.
370 405
371Example: exit on SIGINT 406Example: exit on SIGINT
372 407
373 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 408 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
374 409
410=head3 Restart Behaviour
411
412While restart behaviour is up to the event loop implementation, most will
413not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
414pure perl implementation).
415
416=head3 Safe/Unsafe Signals
417
418Perl signals can be either "safe" (synchronous to opcode handling) or
419"unsafe" (asynchronous) - the former might get delayed indefinitely, the
420latter might corrupt your memory.
421
422AnyEvent signal handlers are, in addition, synchronous to the event loop,
423i.e. they will not interrupt your running perl program but will only be
424called as part of the normal event handling (just like timer, I/O etc.
425callbacks, too).
426
427=head3 Signal Races, Delays and Workarounds
428
429Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
430callbacks to signals in a generic way, which is a pity, as you cannot
431do race-free signal handling in perl, requiring C libraries for
432this. AnyEvent will try to do its best, which means in some cases,
433signals will be delayed. The maximum time a signal might be delayed is
434specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
435variable can be changed only before the first signal watcher is created,
436and should be left alone otherwise. This variable determines how often
437AnyEvent polls for signals (in case a wake-up was missed). Higher values
438will cause fewer spurious wake-ups, which is better for power and CPU
439saving.
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, as POE does its own workaround with
445one-second latency). For those, you just have to suffer the delays.
446
375=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
376 448
449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
450
377You 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.
378 452
379The 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,
380watches for any child process exit). The watcher will triggered only when 454using C<0> watches for any child process exit, on others this will
381the child process has finished and an exit status is available, not on 455croak). The watcher will be triggered only when the child process has
382any trace events (stopped/continued). 456finished and an exit status is available, not on any trace events
457(stopped/continued).
383 458
384The 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
385waitpid), 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
386callback arguments. 461callback arguments.
387 462
403 478
404This means you cannot create a child watcher as the very first 479This means you cannot create a child watcher as the very first
405thing 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
406watcher before you C<fork> the child (alternatively, you can call 481watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>). 482C<AnyEvent::detect>).
483
484As most event loops do not support waiting for child events, they will be
485emulated by AnyEvent in most cases, in which the latency and race problems
486mentioned in the description of signal watchers apply.
408 487
409Example: fork a process and wait for it 488Example: fork a process and wait for it
410 489
411 my $done = AnyEvent->condvar; 490 my $done = AnyEvent->condvar;
412 491
424 # do something else, then wait for process exit 503 # do something else, then wait for process exit
425 $done->recv; 504 $done->recv;
426 505
427=head2 IDLE WATCHERS 506=head2 IDLE WATCHERS
428 507
429Sometimes there is a need to do something, but it is not so important 508 $w = AnyEvent->idle (cb => <callback>);
430to do it instantly, but only when there is nothing better to do. This
431"nothing better to do" is usually defined to be "no other events need
432attention by the event loop".
433 509
434Idle watchers ideally get invoked when the event loop has nothing 510This will repeatedly invoke the callback after the process becomes idle,
435better 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.
436events. Instead of blocking, the idle watcher is invoked.
437 512
438Most 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
439EV, 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
440will simply call the callback "from time to time". 524will simply call the callback "from time to time".
441 525
442Example: read lines from STDIN, but only process them when the 526Example: read lines from STDIN, but only process them when the
443program is otherwise idle: 527program is otherwise idle:
459 }); 543 });
460 }); 544 });
461 545
462=head2 CONDITION VARIABLES 546=head2 CONDITION VARIABLES
463 547
548 $cv = AnyEvent->condvar;
549
550 $cv->send (<list>);
551 my @res = $cv->recv;
552
464If 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
465require you to run some blocking "loop", "run" or similar function that 554require you to run some blocking "loop", "run" or similar function that
466will actively watch for new events and call your callbacks. 555will actively watch for new events and call your callbacks.
467 556
468AnyEvent is different, it expects somebody else to run the event loop and 557AnyEvent is slightly different: it expects somebody else to run the event
469will only block when necessary (usually when told by the user). 558loop and will only block when necessary (usually when told by the user).
470 559
471The instrument to do that is called a "condition variable", so called 560The tool to do that is called a "condition variable", so called because
472because they represent a condition that must become true. 561they represent a condition that must become true.
562
563Now is probably a good time to look at the examples further below.
473 564
474Condition variables can be created by calling the C<< AnyEvent->condvar 565Condition variables can be created by calling the C<< AnyEvent->condvar
475>> method, usually without arguments. The only argument pair allowed is 566>> method, usually without arguments. The only argument pair allowed is
476
477C<cb>, which specifies a callback to be called when the condition variable 567C<cb>, which specifies a callback to be called when the condition variable
478becomes true, with the condition variable as the first argument (but not 568becomes true, with the condition variable as the first argument (but not
479the results). 569the results).
480 570
481After creation, the condition variable is "false" until it becomes "true" 571After creation, the condition variable is "false" until it becomes "true"
482by 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
483were 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<<
484->send >> method). 574->send >> method).
485 575
486Condition variables are similar to callbacks, except that you can 576Since condition variables are the most complex part of the AnyEvent API, here are
487optionally 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:
488in time where multiple outstanding events have been processed. And yet 578
489another way to call them is transactions - each condition variable can be 579=over 4
490used to represent a transaction, which finishes at some point and delivers 580
491a 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
492 599
493Condition variables are very useful to signal that something has finished, 600Condition variables are very useful to signal that something has finished,
494for example, if you write a module that does asynchronous http requests, 601for example, if you write a module that does asynchronous http requests,
495then a condition variable would be the ideal candidate to signal the 602then a condition variable would be the ideal candidate to signal the
496availability of results. The user can either act when the callback is 603availability of results. The user can either act when the callback is
509 616
510Condition variables are represented by hash refs in perl, and the keys 617Condition variables are represented by hash refs in perl, and the keys
511used 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
512easy (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
513AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call 620AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
514it's C<new> method in your own C<new> method. 621its C<new> method in your own C<new> method.
515 622
516There are two "sides" to a condition variable - the "producer side" which 623There are two "sides" to a condition variable - the "producer side" which
517eventually calls C<< -> send >>, and the "consumer side", which waits 624eventually calls C<< -> send >>, and the "consumer side", which waits
518for the send to occur. 625for the send to occur.
519 626
520Example: wait for a timer. 627Example: wait for a timer.
521 628
522 # wait till the result is ready 629 # condition: "wait till the timer is fired"
523 my $result_ready = AnyEvent->condvar; 630 my $timer_fired = AnyEvent->condvar;
524 631
525 # do something such as adding a timer 632 # create the timer - we could wait for, say
526 # or socket watcher the calls $result_ready->send 633 # a handle becomign ready, or even an
527 # when the "result" is ready. 634 # AnyEvent::HTTP request to finish, but
528 # in this case, we simply use a timer: 635 # in this case, we simply use a timer:
529 my $w = AnyEvent->timer ( 636 my $w = AnyEvent->timer (
530 after => 1, 637 after => 1,
531 cb => sub { $result_ready->send }, 638 cb => sub { $timer_fired->send },
532 ); 639 );
533 640
534 # this "blocks" (while handling events) till the callback 641 # this "blocks" (while handling events) till the callback
535 # calls send 642 # calls ->send
536 $result_ready->recv; 643 $timer_fired->recv;
537 644
538Example: wait for a timer, but take advantage of the fact that 645Example: wait for a timer, but take advantage of the fact that condition
539condition variables are also code references. 646variables are also callable directly.
540 647
541 my $done = AnyEvent->condvar; 648 my $done = AnyEvent->condvar;
542 my $delay = AnyEvent->timer (after => 5, cb => $done); 649 my $delay = AnyEvent->timer (after => 5, cb => $done);
543 $done->recv; 650 $done->recv;
544 651
550 657
551 ... 658 ...
552 659
553 my @info = $couchdb->info->recv; 660 my @info = $couchdb->info->recv;
554 661
555And this is how you would just ste a callback to be called whenever the 662And this is how you would just set a callback to be called whenever the
556results are available: 663results are available:
557 664
558 $couchdb->info->cb (sub { 665 $couchdb->info->cb (sub {
559 my @info = $_[0]->recv; 666 my @info = $_[0]->recv;
560 }); 667 });
578immediately from within send. 685immediately from within send.
579 686
580Any arguments passed to the C<send> call will be returned by all 687Any arguments passed to the C<send> call will be returned by all
581future C<< ->recv >> calls. 688future C<< ->recv >> calls.
582 689
583Condition variables are overloaded so one can call them directly 690Condition variables are overloaded so one can call them directly (as if
584(as a code reference). Calling them directly is the same as calling 691they were a code reference). Calling them directly is the same as calling
585C<send>. Note, however, that many C-based event loops do not handle 692C<send>.
586overloading, so as tempting as it may be, passing a condition variable
587instead of a callback does not work. Both the pure perl and EV loops
588support overloading, however, as well as all functions that use perl to
589invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
590example).
591 693
592=item $cv->croak ($error) 694=item $cv->croak ($error)
593 695
594Similar to send, but causes all call's to C<< ->recv >> to invoke 696Similar to send, but causes all calls to C<< ->recv >> to invoke
595C<Carp::croak> with the given error message/object/scalar. 697C<Carp::croak> with the given error message/object/scalar.
596 698
597This can be used to signal any errors to the condition variable 699This can be used to signal any errors to the condition variable
598user/consumer. 700user/consumer. Doing it this way instead of calling C<croak> directly
701delays the error detection, but has the overwhelming advantage that it
702diagnoses the error at the place where the result is expected, and not
703deep in some event callback with no connection to the actual code causing
704the problem.
599 705
600=item $cv->begin ([group callback]) 706=item $cv->begin ([group callback])
601 707
602=item $cv->end 708=item $cv->end
603
604These two methods are EXPERIMENTAL and MIGHT CHANGE.
605 709
606These two methods can be used to combine many transactions/events into 710These two methods can be used to combine many transactions/events into
607one. 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
608to use a condition variable for the whole process. 712to use a condition variable for the whole process.
609 713
610Every 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
611C<< ->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
612>>, 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
613is 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
614callback 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.
615 720
616Let's clarify this with the ping example: 721You can think of C<< $cv->send >> giving you an OR condition (one call
722sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
723condition (all C<begin> calls must be C<end>'ed before the condvar sends).
724
725Let's start with a simple example: you have two I/O watchers (for example,
726STDOUT and STDERR for a program), and you want to wait for both streams to
727close before activating a condvar:
617 728
618 my $cv = AnyEvent->condvar; 729 my $cv = AnyEvent->condvar;
619 730
731 $cv->begin; # first watcher
732 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
733 defined sysread $fh1, my $buf, 4096
734 or $cv->end;
735 });
736
737 $cv->begin; # second watcher
738 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
739 defined sysread $fh2, my $buf, 4096
740 or $cv->end;
741 });
742
743 $cv->recv;
744
745This works because for every event source (EOF on file handle), there is
746one call to C<begin>, so the condvar waits for all calls to C<end> before
747sending.
748
749The ping example mentioned above is slightly more complicated, as the
750there are results to be passwd back, and the number of tasks that are
751begun can potentially be zero:
752
753 my $cv = AnyEvent->condvar;
754
620 my %result; 755 my %result;
621 $cv->begin (sub { $cv->send (\%result) }); 756 $cv->begin (sub { shift->send (\%result) });
622 757
623 for my $host (@list_of_hosts) { 758 for my $host (@list_of_hosts) {
624 $cv->begin; 759 $cv->begin;
625 ping_host_then_call_callback $host, sub { 760 ping_host_then_call_callback $host, sub {
626 $result{$host} = ...; 761 $result{$host} = ...;
641loop, which serves two important purposes: first, it sets the callback 776loop, which serves two important purposes: first, it sets the callback
642to be called once the counter reaches C<0>, and second, it ensures that 777to be called once the counter reaches C<0>, and second, it ensures that
643C<send> is called even when C<no> hosts are being pinged (the loop 778C<send> is called even when C<no> hosts are being pinged (the loop
644doesn't execute once). 779doesn't execute once).
645 780
646This is the general pattern when you "fan out" into multiple subrequests: 781This is the general pattern when you "fan out" into multiple (but
647use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 782potentially zero) subrequests: use an outer C<begin>/C<end> pair to set
648is called at least once, and then, for each subrequest you start, call 783the callback and ensure C<end> is called at least once, and then, for each
649C<begin> and for each subrequest you finish, call C<end>. 784subrequest you start, call C<begin> and for each subrequest you finish,
785call C<end>.
650 786
651=back 787=back
652 788
653=head3 METHODS FOR CONSUMERS 789=head3 METHODS FOR CONSUMERS
654 790
658=over 4 794=over 4
659 795
660=item $cv->recv 796=item $cv->recv
661 797
662Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 798Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
663>> methods have been called on c<$cv>, while servicing other watchers 799>> methods have been called on C<$cv>, while servicing other watchers
664normally. 800normally.
665 801
666You can only wait once on a condition - additional calls are valid but 802You can only wait once on a condition - additional calls are valid but
667will return immediately. 803will return immediately.
668 804
670function will call C<croak>. 806function will call C<croak>.
671 807
672In list context, all parameters passed to C<send> will be returned, 808In list context, all parameters passed to C<send> will be returned,
673in scalar context only the first one will be returned. 809in scalar context only the first one will be returned.
674 810
811Note that doing a blocking wait in a callback is not supported by any
812event loop, that is, recursive invocation of a blocking C<< ->recv
813>> is not allowed, and the C<recv> call will C<croak> if such a
814condition is detected. This condition can be slightly loosened by using
815L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from
816any thread that doesn't run the event loop itself.
817
675Not all event models support a blocking wait - some die in that case 818Not all event models support a blocking wait - some die in that case
676(programs might want to do that to stay interactive), so I<if you are 819(programs might want to do that to stay interactive), so I<if you are
677using this from a module, never require a blocking wait>, but let the 820using this from a module, never require a blocking wait>. Instead, let the
678caller decide whether the call will block or not (for example, by coupling 821caller decide whether the call will block or not (for example, by coupling
679condition variables with some kind of request results and supporting 822condition variables with some kind of request results and supporting
680callbacks so the caller knows that getting the result will not block, 823callbacks so the caller knows that getting the result will not block,
681while still supporting blocking waits if the caller so desires). 824while still supporting blocking waits if the caller so desires).
682 825
683Another reason I<never> to C<< ->recv >> in a module is that you cannot
684sensibly have two C<< ->recv >>'s in parallel, as that would require
685multiple interpreters or coroutines/threads, none of which C<AnyEvent>
686can supply.
687
688The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
689fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
690versions and also integrates coroutines into AnyEvent, making blocking
691C<< ->recv >> calls perfectly safe as long as they are done from another
692coroutine (one that doesn't run the event loop).
693
694You can ensure that C<< -recv >> never blocks by setting a callback and 826You can ensure that C<< ->recv >> never blocks by setting a callback and
695only calling C<< ->recv >> from within that callback (or at a later 827only calling C<< ->recv >> from within that callback (or at a later
696time). This will work even when the event loop does not support blocking 828time). This will work even when the event loop does not support blocking
697waits otherwise. 829waits otherwise.
698 830
699=item $bool = $cv->ready 831=item $bool = $cv->ready
705 837
706This is a mutator function that returns the callback set and optionally 838This is a mutator function that returns the callback set and optionally
707replaces it before doing so. 839replaces it before doing so.
708 840
709The callback will be called when the condition becomes "true", i.e. when 841The callback will be called when the condition becomes "true", i.e. when
710C<send> or C<croak> are called, with the only argument being the condition 842C<send> or C<croak> are called, with the only argument being the
711variable itself. Calling C<recv> inside the callback or at any later time 843condition variable itself. If the condition is already true, the
712is guaranteed not to block. 844callback is called immediately when it is set. Calling C<recv> inside
845the callback or at any later time is guaranteed not to block.
713 846
714=back 847=back
715 848
849=head1 SUPPORTED EVENT LOOPS/BACKENDS
850
851The available backend classes are (every class has its own manpage):
852
853=over 4
854
855=item Backends that are autoprobed when no other event loop can be found.
856
857EV is the preferred backend when no other event loop seems to be in
858use. If EV is not installed, then AnyEvent will fall back to its own
859pure-perl implementation, which is available everywhere as it comes with
860AnyEvent itself.
861
862 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
863 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
864
865=item Backends that are transparently being picked up when they are used.
866
867These will be used if they are already loaded when the first watcher
868is created, in which case it is assumed that the application is using
869them. This means that AnyEvent will automatically pick the right backend
870when the main program loads an event module before anything starts to
871create watchers. Nothing special needs to be done by the main program.
872
873 AnyEvent::Impl::Event based on Event, very stable, few glitches.
874 AnyEvent::Impl::Glib based on Glib, slow but very stable.
875 AnyEvent::Impl::Tk based on Tk, very broken.
876 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
877 AnyEvent::Impl::POE based on POE, very slow, some limitations.
878 AnyEvent::Impl::Irssi used when running within irssi.
879
880=item Backends with special needs.
881
882Qt requires the Qt::Application to be instantiated first, but will
883otherwise be picked up automatically. As long as the main program
884instantiates the application before any AnyEvent watchers are created,
885everything should just work.
886
887 AnyEvent::Impl::Qt based on Qt.
888
889Support for IO::Async can only be partial, as it is too broken and
890architecturally limited to even support the AnyEvent API. It also
891is the only event loop that needs the loop to be set explicitly, so
892it can only be used by a main program knowing about AnyEvent. See
893L<AnyEvent::Impl::IOAsync> for the gory details.
894
895 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
896
897=item Event loops that are indirectly supported via other backends.
898
899Some event loops can be supported via other modules:
900
901There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
902
903B<WxWidgets> has no support for watching file handles. However, you can
904use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
905polls 20 times per second, which was considered to be too horrible to even
906consider for AnyEvent.
907
908B<Prima> is not supported as nobody seems to be using it, but it has a POE
909backend, so it can be supported through POE.
910
911AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
912load L<POE> when detecting them, in the hope that POE will pick them up,
913in which case everything will be automatic.
914
915=back
916
716=head1 GLOBAL VARIABLES AND FUNCTIONS 917=head1 GLOBAL VARIABLES AND FUNCTIONS
717 918
919These are not normally required to use AnyEvent, but can be useful to
920write AnyEvent extension modules.
921
718=over 4 922=over 4
719 923
720=item $AnyEvent::MODEL 924=item $AnyEvent::MODEL
721 925
722Contains C<undef> until the first watcher is being created. Then it 926Contains C<undef> until the first watcher is being created, before the
927backend has been autodetected.
928
723contains the event model that is being used, which is the name of the 929Afterwards it contains the event model that is being used, which is the
724Perl class implementing the model. This class is usually one of the 930name of the Perl class implementing the model. This class is usually one
725C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 931of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the
726AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 932case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
727 933will be C<urxvt::anyevent>).
728The known classes so far are:
729
730 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
731 AnyEvent::Impl::Event based on Event, second best choice.
732 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
733 AnyEvent::Impl::Glib based on Glib, third-best choice.
734 AnyEvent::Impl::Tk based on Tk, very bad choice.
735 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
736 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
737 AnyEvent::Impl::POE based on POE, not generic enough for full support.
738
739 # warning, support for IO::Async is only partial, as it is too broken
740 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
741 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
742
743There is no support for WxWidgets, as WxWidgets has no support for
744watching file handles. However, you can use WxWidgets through the
745POE Adaptor, as POE has a Wx backend that simply polls 20 times per
746second, which was considered to be too horrible to even consider for
747AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
748it's adaptor.
749
750AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
751autodetecting them.
752 934
753=item AnyEvent::detect 935=item AnyEvent::detect
754 936
755Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 937Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
756if necessary. You should only call this function right before you would 938if necessary. You should only call this function right before you would
757have created an AnyEvent watcher anyway, that is, as late as possible at 939have created an AnyEvent watcher anyway, that is, as late as possible at
758runtime. 940runtime, and not e.g. during initialisation of your module.
941
942If you need to do some initialisation before AnyEvent watchers are
943created, use C<post_detect>.
759 944
760=item $guard = AnyEvent::post_detect { BLOCK } 945=item $guard = AnyEvent::post_detect { BLOCK }
761 946
762Arranges for the code block to be executed as soon as the event model is 947Arranges for the code block to be executed as soon as the event model is
763autodetected (or immediately if this has already happened). 948autodetected (or immediately if that has already happened).
949
950The block will be executed I<after> the actual backend has been detected
951(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
952created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
953other initialisations - see the sources of L<AnyEvent::Strict> or
954L<AnyEvent::AIO> to see how this is used.
955
956The most common usage is to create some global watchers, without forcing
957event module detection too early, for example, L<AnyEvent::AIO> creates
958and installs the global L<IO::AIO> watcher in a C<post_detect> block to
959avoid autodetecting the event module at load time.
764 960
765If called in scalar or list context, then it creates and returns an object 961If called in scalar or list context, then it creates and returns an object
766that automatically removes the callback again when it is destroyed. See 962that automatically removes the callback again when it is destroyed (or
963C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
767L<Coro::BDB> for a case where this is useful. 964a case where this is useful.
965
966Example: Create a watcher for the IO::AIO module and store it in
967C<$WATCHER>, but do so only do so after the event loop is initialised.
968
969 our WATCHER;
970
971 my $guard = AnyEvent::post_detect {
972 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
973 };
974
975 # the ||= is important in case post_detect immediately runs the block,
976 # as to not clobber the newly-created watcher. assigning both watcher and
977 # post_detect guard to the same variable has the advantage of users being
978 # able to just C<undef $WATCHER> if the watcher causes them grief.
979
980 $WATCHER ||= $guard;
768 981
769=item @AnyEvent::post_detect 982=item @AnyEvent::post_detect
770 983
771If there are any code references in this array (you can C<push> to it 984If there are any code references in this array (you can C<push> to it
772before or after loading AnyEvent), then they will called directly after 985before or after loading AnyEvent), then they will be called directly
773the event loop has been chosen. 986after the event loop has been chosen.
774 987
775You should check C<$AnyEvent::MODEL> before adding to this array, though: 988You should check C<$AnyEvent::MODEL> before adding to this array, though:
776if it contains a true value then the event loop has already been detected, 989if it is defined then the event loop has already been detected, and the
777and the array will be ignored. 990array will be ignored.
778 991
779Best use C<AnyEvent::post_detect { BLOCK }> instead. 992Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
993it, as it takes care of these details.
994
995This variable is mainly useful for modules that can do something useful
996when AnyEvent is used and thus want to know when it is initialised, but do
997not need to even load it by default. This array provides the means to hook
998into AnyEvent passively, without loading it.
999
1000Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
1001together, you could put this into Coro (this is the actual code used by
1002Coro to accomplish this):
1003
1004 if (defined $AnyEvent::MODEL) {
1005 # AnyEvent already initialised, so load Coro::AnyEvent
1006 require Coro::AnyEvent;
1007 } else {
1008 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1009 # as soon as it is
1010 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1011 }
780 1012
781=back 1013=back
782 1014
783=head1 WHAT TO DO IN A MODULE 1015=head1 WHAT TO DO IN A MODULE
784 1016
795because it will stall the whole program, and the whole point of using 1027because it will stall the whole program, and the whole point of using
796events is to stay interactive. 1028events is to stay interactive.
797 1029
798It is fine, however, to call C<< ->recv >> when the user of your module 1030It is fine, however, to call C<< ->recv >> when the user of your module
799requests it (i.e. if you create a http request object ad have a method 1031requests it (i.e. if you create a http request object ad have a method
800called C<results> that returns the results, it should call C<< ->recv >> 1032called C<results> that returns the results, it may call C<< ->recv >>
801freely, as the user of your module knows what she is doing. always). 1033freely, as the user of your module knows what she is doing. Always).
802 1034
803=head1 WHAT TO DO IN THE MAIN PROGRAM 1035=head1 WHAT TO DO IN THE MAIN PROGRAM
804 1036
805There will always be a single main program - the only place that should 1037There will always be a single main program - the only place that should
806dictate which event model to use. 1038dictate which event model to use.
807 1039
808If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1040If the program is not event-based, it need not do anything special, even
809do anything special (it does not need to be event-based) and let AnyEvent 1041when it depends on a module that uses an AnyEvent. If the program itself
810decide which implementation to chose if some module relies on it. 1042uses AnyEvent, but does not care which event loop is used, all it needs
1043to do is C<use AnyEvent>. In either case, AnyEvent will choose the best
1044available loop implementation.
811 1045
812If the main program relies on a specific event model - for example, in 1046If the main program relies on a specific event model - for example, in
813Gtk2 programs you have to rely on the Glib module - you should load the 1047Gtk2 programs you have to rely on the Glib module - you should load the
814event module before loading AnyEvent or any module that uses it: generally 1048event module before loading AnyEvent or any module that uses it: generally
815speaking, you should load it as early as possible. The reason is that 1049speaking, you should load it as early as possible. The reason is that
816modules might create watchers when they are loaded, and AnyEvent will 1050modules might create watchers when they are loaded, and AnyEvent will
817decide on the event model to use as soon as it creates watchers, and it 1051decide on the event model to use as soon as it creates watchers, and it
818might chose the wrong one unless you load the correct one yourself. 1052might choose the wrong one unless you load the correct one yourself.
819 1053
820You can chose to use a pure-perl implementation by loading the 1054You can chose to use a pure-perl implementation by loading the
821C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1055C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
822everywhere, but letting AnyEvent chose the model is generally better. 1056everywhere, but letting AnyEvent chose the model is generally better.
823 1057
839 1073
840 1074
841=head1 OTHER MODULES 1075=head1 OTHER MODULES
842 1076
843The following is a non-exhaustive list of additional modules that use 1077The following is a non-exhaustive list of additional modules that use
844AnyEvent and can therefore be mixed easily with other AnyEvent modules 1078AnyEvent as a client and can therefore be mixed easily with other AnyEvent
845in the same program. Some of the modules come with AnyEvent, some are 1079modules and other event loops in the same program. Some of the modules
846available via CPAN. 1080come as part of AnyEvent, the others are available via CPAN.
847 1081
848=over 4 1082=over 4
849 1083
850=item L<AnyEvent::Util> 1084=item L<AnyEvent::Util>
851 1085
852Contains various utility functions that replace often-used but blocking 1086Contains various utility functions that replace often-used blocking
853functions such as C<inet_aton> by event-/callback-based versions. 1087functions such as C<inet_aton> with event/callback-based versions.
854 1088
855=item L<AnyEvent::Socket> 1089=item L<AnyEvent::Socket>
856 1090
857Provides various utility functions for (internet protocol) sockets, 1091Provides various utility functions for (internet protocol) sockets,
858addresses and name resolution. Also functions to create non-blocking tcp 1092addresses and name resolution. Also functions to create non-blocking tcp
860 1094
861=item L<AnyEvent::Handle> 1095=item L<AnyEvent::Handle>
862 1096
863Provide read and write buffers, manages watchers for reads and writes, 1097Provide read and write buffers, manages watchers for reads and writes,
864supports raw and formatted I/O, I/O queued and fully transparent and 1098supports raw and formatted I/O, I/O queued and fully transparent and
865non-blocking SSL/TLS. 1099non-blocking SSL/TLS (via L<AnyEvent::TLS>).
866 1100
867=item L<AnyEvent::DNS> 1101=item L<AnyEvent::DNS>
868 1102
869Provides rich asynchronous DNS resolver capabilities. 1103Provides rich asynchronous DNS resolver capabilities.
870 1104
1105=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1106
1107Implement event-based interfaces to the protocols of the same name (for
1108the curious, IGS is the International Go Server and FCP is the Freenet
1109Client Protocol).
1110
1111=item L<AnyEvent::Handle::UDP>
1112
1113Here be danger!
1114
1115As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1116there are so many things wrong with AnyEvent::Handle::UDP, most notably
1117its use of a stream-based API with a protocol that isn't streamable, that
1118the only way to improve it is to delete it.
1119
1120It features data corruption (but typically only under load) and general
1121confusion. On top, the author is not only clueless about UDP but also
1122fact-resistant - some gems of his understanding: "connect doesn't work
1123with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1124packets", "I don't need to implement proper error checking as UDP doesn't
1125support error checking" and so on - he doesn't even understand what's
1126wrong with his module when it is explained to him.
1127
871=item L<AnyEvent::HTTP> 1128=item L<AnyEvent::DBI>
872 1129
873A simple-to-use HTTP library that is capable of making a lot of concurrent 1130Executes L<DBI> requests asynchronously in a proxy process for you,
874HTTP requests. 1131notifying you in an event-based way when the operation is finished.
1132
1133=item L<AnyEvent::AIO>
1134
1135Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1136toolbox of every event programmer. AnyEvent::AIO transparently fuses
1137L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1138file I/O, and much more.
875 1139
876=item L<AnyEvent::HTTPD> 1140=item L<AnyEvent::HTTPD>
877 1141
878Provides a simple web application server framework. 1142A simple embedded webserver.
879 1143
880=item L<AnyEvent::FastPing> 1144=item L<AnyEvent::FastPing>
881 1145
882The fastest ping in the west. 1146The fastest ping in the west.
883 1147
884=item L<AnyEvent::DBI>
885
886Executes L<DBI> requests asynchronously in a proxy process.
887
888=item L<AnyEvent::AIO>
889
890Truly asynchronous I/O, should be in the toolbox of every event
891programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
892together.
893
894=item L<AnyEvent::BDB>
895
896Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
897L<BDB> and AnyEvent together.
898
899=item L<AnyEvent::GPSD>
900
901A non-blocking interface to gpsd, a daemon delivering GPS information.
902
903=item L<AnyEvent::IGS>
904
905A non-blocking interface to the Internet Go Server protocol (used by
906L<App::IGS>).
907
908=item L<AnyEvent::IRC>
909
910AnyEvent based IRC client module family (replacing the older Net::IRC3).
911
912=item L<Net::XMPP2>
913
914AnyEvent based XMPP (Jabber protocol) module family.
915
916=item L<Net::FCP>
917
918AnyEvent-based implementation of the Freenet Client Protocol, birthplace
919of AnyEvent.
920
921=item L<Event::ExecFlow>
922
923High level API for event-based execution flow control.
924
925=item L<Coro> 1148=item L<Coro>
926 1149
927Has special support for AnyEvent via L<Coro::AnyEvent>. 1150Has special support for AnyEvent via L<Coro::AnyEvent>.
928 1151
929=item L<IO::Lambda>
930
931The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
932
933=back 1152=back
934 1153
935=cut 1154=cut
936 1155
937package AnyEvent; 1156package AnyEvent;
938 1157
939no warnings; 1158# basically a tuned-down version of common::sense
940use strict qw(vars subs); 1159sub common_sense {
1160 # from common:.sense 1.0
1161 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1162 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1163 $^H |= 0x00000600;
1164}
941 1165
1166BEGIN { AnyEvent::common_sense }
1167
942use Carp; 1168use Carp ();
943 1169
944our $VERSION = 4.412; 1170our $VERSION = '5.271';
945our $MODEL; 1171our $MODEL;
946 1172
947our $AUTOLOAD; 1173our $AUTOLOAD;
948our @ISA; 1174our @ISA;
949 1175
950our @REGISTRY; 1176our @REGISTRY;
951 1177
952our $WIN32; 1178our $VERBOSE;
953 1179
954BEGIN { 1180BEGIN {
955 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1181 require "AnyEvent/constants.pl";
1182
956 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1183 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
957 1184
958 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1185 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
959 if ${^TAINT}; 1186 if ${^TAINT};
960}
961 1187
962our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1188 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1189
1190}
1191
1192our $MAX_SIGNAL_LATENCY = 10;
963 1193
964our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1194our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
965 1195
966{ 1196{
967 my $idx; 1197 my $idx;
969 for reverse split /\s*,\s*/, 1199 for reverse split /\s*,\s*/,
970 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1200 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
971} 1201}
972 1202
973my @models = ( 1203my @models = (
974 [EV:: => AnyEvent::Impl::EV::], 1204 [EV:: => AnyEvent::Impl::EV:: , 1],
975 [Event:: => AnyEvent::Impl::Event::],
976 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1205 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
977 # everything below here will not be autoprobed 1206 # everything below here will not (normally) be autoprobed
978 # as the pureperl backend should work everywhere 1207 # as the pureperl backend should work everywhere
979 # and is usually faster 1208 # and is usually faster
1209 [Event:: => AnyEvent::Impl::Event::, 1],
1210 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1211 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1212 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
980 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1213 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
981 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
982 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
983 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1214 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
984 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1215 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
985 [Wx:: => AnyEvent::Impl::POE::], 1216 [Wx:: => AnyEvent::Impl::POE::],
986 [Prima:: => AnyEvent::Impl::POE::], 1217 [Prima:: => AnyEvent::Impl::POE::],
987 # IO::Async is just too broken - we would need workaorunds for its 1218 # IO::Async is just too broken - we would need workarounds for its
988 # byzantine signal and broken child handling, among others. 1219 # byzantine signal and broken child handling, among others.
989 # IO::Async is rather hard to detect, as it doesn't have any 1220 # IO::Async is rather hard to detect, as it doesn't have any
990 # obvious default class. 1221 # obvious default class.
991# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1222 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
992# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1223 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
993# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1224 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1225 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
994); 1226);
995 1227
996our %method = map +($_ => 1), 1228our %method = map +($_ => 1),
997 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1229 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
998 1230
999our @post_detect; 1231our @post_detect;
1000 1232
1001sub post_detect(&) { 1233sub post_detect(&) {
1002 my ($cb) = @_; 1234 my ($cb) = @_;
1003 1235
1004 if ($MODEL) {
1005 $cb->();
1006
1007 1
1008 } else {
1009 push @post_detect, $cb; 1236 push @post_detect, $cb;
1010 1237
1011 defined wantarray 1238 defined wantarray
1012 ? bless \$cb, "AnyEvent::Util::postdetect" 1239 ? bless \$cb, "AnyEvent::Util::postdetect"
1013 : () 1240 : ()
1014 }
1015} 1241}
1016 1242
1017sub AnyEvent::Util::postdetect::DESTROY { 1243sub AnyEvent::Util::postdetect::DESTROY {
1018 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1244 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1019} 1245}
1020 1246
1021sub detect() { 1247sub detect() {
1248 # free some memory
1249 *detect = sub () { $MODEL };
1250
1251 local $!; # for good measure
1252 local $SIG{__DIE__};
1253
1254 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1255 my $model = "AnyEvent::Impl::$1";
1256 if (eval "require $model") {
1257 $MODEL = $model;
1258 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1259 } else {
1260 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1261 }
1262 }
1263
1264 # check for already loaded models
1022 unless ($MODEL) { 1265 unless ($MODEL) {
1023 no strict 'refs'; 1266 for (@REGISTRY, @models) {
1024 local $SIG{__DIE__}; 1267 my ($package, $model) = @$_;
1025 1268 if (${"$package\::VERSION"} > 0) {
1026 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1027 my $model = "AnyEvent::Impl::$1";
1028 if (eval "require $model") { 1269 if (eval "require $model") {
1029 $MODEL = $model; 1270 $MODEL = $model;
1030 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1; 1271 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1031 } else { 1272 last;
1032 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose; 1273 }
1033 } 1274 }
1034 } 1275 }
1035 1276
1036 # check for already loaded models
1037 unless ($MODEL) { 1277 unless ($MODEL) {
1278 # try to autoload a model
1038 for (@REGISTRY, @models) { 1279 for (@REGISTRY, @models) {
1039 my ($package, $model) = @$_; 1280 my ($package, $model, $autoload) = @$_;
1281 if (
1282 $autoload
1283 and eval "require $package"
1040 if (${"$package\::VERSION"} > 0) { 1284 and ${"$package\::VERSION"} > 0
1041 if (eval "require $model") { 1285 and eval "require $model"
1286 ) {
1042 $MODEL = $model; 1287 $MODEL = $model;
1043 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1; 1288 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1044 last; 1289 last;
1045 }
1046 } 1290 }
1047 } 1291 }
1048 1292
1049 unless ($MODEL) {
1050 # try to load a model
1051
1052 for (@REGISTRY, @models) {
1053 my ($package, $model) = @$_;
1054 if (eval "require $package"
1055 and ${"$package\::VERSION"} > 0
1056 and eval "require $model") {
1057 $MODEL = $model;
1058 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
1059 last;
1060 }
1061 }
1062
1063 $MODEL 1293 $MODEL
1064 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1294 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1065 }
1066 } 1295 }
1067
1068 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1069
1070 unshift @ISA, $MODEL;
1071
1072 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1073
1074 (shift @post_detect)->() while @post_detect;
1075 } 1296 }
1297
1298 @models = (); # free probe data
1299
1300 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1301 unshift @ISA, $MODEL;
1302
1303 # now nuke some methods that are overriden by the backend.
1304 # SUPER is not allowed.
1305 for (qw(time signal child idle)) {
1306 undef &{"AnyEvent::Base::$_"}
1307 if defined &{"$MODEL\::$_"};
1308 }
1309
1310 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1311
1312 (shift @post_detect)->() while @post_detect;
1313
1314 *post_detect = sub(&) {
1315 shift->();
1316
1317 undef
1318 };
1076 1319
1077 $MODEL 1320 $MODEL
1078} 1321}
1079 1322
1080sub AUTOLOAD { 1323sub AUTOLOAD {
1081 (my $func = $AUTOLOAD) =~ s/.*://; 1324 (my $func = $AUTOLOAD) =~ s/.*://;
1082 1325
1083 $method{$func} 1326 $method{$func}
1084 or croak "$func: not a valid method for AnyEvent objects"; 1327 or Carp::croak "$func: not a valid AnyEvent class method";
1085 1328
1086 detect unless $MODEL; 1329 detect;
1087 1330
1088 my $class = shift; 1331 my $class = shift;
1089 $class->$func (@_); 1332 $class->$func (@_);
1090} 1333}
1091 1334
1094# allow only one watcher per fd, so we dup it to get a different one). 1337# allow only one watcher per fd, so we dup it to get a different one).
1095sub _dupfh($$;$$) { 1338sub _dupfh($$;$$) {
1096 my ($poll, $fh, $r, $w) = @_; 1339 my ($poll, $fh, $r, $w) = @_;
1097 1340
1098 # cygwin requires the fh mode to be matching, unix doesn't 1341 # cygwin requires the fh mode to be matching, unix doesn't
1099 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1342 my ($rw, $mode) = $poll eq "r" ? ($r, "<&") : ($w, ">&");
1100 : $poll eq "w" ? ($w, ">")
1101 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1102 1343
1103 open my $fh2, "$mode&" . fileno $fh 1344 open my $fh2, $mode, $fh
1104 or die "cannot dup() filehandle: $!,"; 1345 or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1105 1346
1106 # we assume CLOEXEC is already set by perl in all important cases 1347 # we assume CLOEXEC is already set by perl in all important cases
1107 1348
1108 ($fh2, $rw) 1349 ($fh2, $rw)
1109} 1350}
1110 1351
1352=head1 SIMPLIFIED AE API
1353
1354Starting with version 5.0, AnyEvent officially supports a second, much
1355simpler, API that is designed to reduce the calling, typing and memory
1356overhead by using function call syntax and a fixed number of parameters.
1357
1358See the L<AE> manpage for details.
1359
1360=cut
1361
1362package AE;
1363
1364our $VERSION = $AnyEvent::VERSION;
1365
1366# fall back to the main API by default - backends and AnyEvent::Base
1367# implementations can overwrite these.
1368
1369sub io($$$) {
1370 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1371}
1372
1373sub timer($$$) {
1374 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1375}
1376
1377sub signal($$) {
1378 AnyEvent->signal (signal => $_[0], cb => $_[1])
1379}
1380
1381sub child($$) {
1382 AnyEvent->child (pid => $_[0], cb => $_[1])
1383}
1384
1385sub idle($) {
1386 AnyEvent->idle (cb => $_[0])
1387}
1388
1389sub cv(;&) {
1390 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1391}
1392
1393sub now() {
1394 AnyEvent->now
1395}
1396
1397sub now_update() {
1398 AnyEvent->now_update
1399}
1400
1401sub time() {
1402 AnyEvent->time
1403}
1404
1111package AnyEvent::Base; 1405package AnyEvent::Base;
1112 1406
1113# default implementations for many methods 1407# default implementations for many methods
1114 1408
1115BEGIN { 1409sub time {
1410 eval q{ # poor man's autoloading {}
1411 # probe for availability of Time::HiRes
1116 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1412 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1413 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1117 *_time = \&Time::HiRes::time; 1414 *AE::time = \&Time::HiRes::time;
1118 # if (eval "use POSIX (); (POSIX::times())... 1415 # if (eval "use POSIX (); (POSIX::times())...
1119 } else { 1416 } else {
1417 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1120 *_time = sub { time }; # epic fail 1418 *AE::time = sub (){ time }; # epic fail
1419 }
1420
1421 *time = sub { AE::time }; # different prototypes
1422 };
1423 die if $@;
1424
1425 &time
1426}
1427
1428*now = \&time;
1429
1430sub now_update { }
1431
1432# default implementation for ->condvar
1433
1434sub condvar {
1435 eval q{ # poor man's autoloading {}
1436 *condvar = sub {
1437 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1438 };
1439
1440 *AE::cv = sub (;&) {
1441 bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar"
1442 };
1443 };
1444 die if $@;
1445
1446 &condvar
1447}
1448
1449# default implementation for ->signal
1450
1451our $HAVE_ASYNC_INTERRUPT;
1452
1453sub _have_async_interrupt() {
1454 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1455 && eval "use Async::Interrupt 1.02 (); 1")
1456 unless defined $HAVE_ASYNC_INTERRUPT;
1457
1458 $HAVE_ASYNC_INTERRUPT
1459}
1460
1461our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1462our (%SIG_ASY, %SIG_ASY_W);
1463our ($SIG_COUNT, $SIG_TW);
1464
1465# install a dummy wakeup watcher to reduce signal catching latency
1466# used by Impls
1467sub _sig_add() {
1468 unless ($SIG_COUNT++) {
1469 # try to align timer on a full-second boundary, if possible
1470 my $NOW = AE::now;
1471
1472 $SIG_TW = AE::timer
1473 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1474 $MAX_SIGNAL_LATENCY,
1475 sub { } # just for the PERL_ASYNC_CHECK
1476 ;
1121 } 1477 }
1122} 1478}
1123 1479
1124sub time { _time } 1480sub _sig_del {
1125sub now { _time } 1481 undef $SIG_TW
1126sub now_update { } 1482 unless --$SIG_COUNT;
1127
1128# default implementation for ->condvar
1129
1130sub condvar {
1131 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1132} 1483}
1133 1484
1134# default implementation for ->signal 1485our $_sig_name_init; $_sig_name_init = sub {
1486 eval q{ # poor man's autoloading {}
1487 undef $_sig_name_init;
1135 1488
1136our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1489 if (_have_async_interrupt) {
1490 *sig2num = \&Async::Interrupt::sig2num;
1491 *sig2name = \&Async::Interrupt::sig2name;
1492 } else {
1493 require Config;
1137 1494
1138sub _signal_exec { 1495 my %signame2num;
1139 sysread $SIGPIPE_R, my $dummy, 4; 1496 @signame2num{ split ' ', $Config::Config{sig_name} }
1497 = split ' ', $Config::Config{sig_num};
1140 1498
1141 while (%SIG_EV) { 1499 my @signum2name;
1142 for (keys %SIG_EV) { 1500 @signum2name[values %signame2num] = keys %signame2num;
1143 delete $SIG_EV{$_}; 1501
1144 $_->() for values %{ $SIG_CB{$_} || {} }; 1502 *sig2num = sub($) {
1503 $_[0] > 0 ? shift : $signame2num{+shift}
1504 };
1505 *sig2name = sub ($) {
1506 $_[0] > 0 ? $signum2name[+shift] : shift
1507 };
1145 } 1508 }
1146 } 1509 };
1147} 1510 die if $@;
1511};
1512
1513sub sig2num ($) { &$_sig_name_init; &sig2num }
1514sub sig2name($) { &$_sig_name_init; &sig2name }
1148 1515
1149sub signal { 1516sub signal {
1150 my (undef, %arg) = @_; 1517 eval q{ # poor man's autoloading {}
1518 # probe for availability of Async::Interrupt
1519 if (_have_async_interrupt) {
1520 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1151 1521
1152 unless ($SIGPIPE_R) { 1522 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1153 require Fcntl; 1523 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1154 1524
1155 if (AnyEvent::WIN32) {
1156 require AnyEvent::Util;
1157
1158 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1159 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1160 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1161 } else { 1525 } else {
1526 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1527
1528 if (AnyEvent::WIN32) {
1529 require AnyEvent::Util;
1530
1531 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1532 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1533 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1534 } else {
1162 pipe $SIGPIPE_R, $SIGPIPE_W; 1535 pipe $SIGPIPE_R, $SIGPIPE_W;
1163 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1536 fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R;
1164 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1537 fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case
1165 1538
1166 # not strictly required, as $^F is normally 2, but let's make sure... 1539 # not strictly required, as $^F is normally 2, but let's make sure...
1167 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1540 fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1168 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; 1541 fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC;
1542 }
1543
1544 $SIGPIPE_R
1545 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1546
1547 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1169 } 1548 }
1170 1549
1171 $SIGPIPE_R 1550 *signal = $HAVE_ASYNC_INTERRUPT
1172 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1551 ? sub {
1552 my (undef, %arg) = @_;
1173 1553
1174 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1554 # async::interrupt
1175 }
1176
1177 my $signal = uc $arg{signal} 1555 my $signal = sig2num $arg{signal};
1178 or Carp::croak "required option 'signal' is missing";
1179
1180 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1556 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1557
1558 $SIG_ASY{$signal} ||= new Async::Interrupt
1559 cb => sub { undef $SIG_EV{$signal} },
1560 signal => $signal,
1561 pipe => [$SIGPIPE_R->filenos],
1562 pipe_autodrain => 0,
1563 ;
1564
1565 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1566 }
1567 : sub {
1568 my (undef, %arg) = @_;
1569
1570 # pure perl
1571 my $signal = sig2name $arg{signal};
1572 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1573
1181 $SIG{$signal} ||= sub { 1574 $SIG{$signal} ||= sub {
1182 local $!; 1575 local $!;
1183 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1576 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1184 undef $SIG_EV{$signal}; 1577 undef $SIG_EV{$signal};
1578 };
1579
1580 # can't do signal processing without introducing races in pure perl,
1581 # so limit the signal latency.
1582 _sig_add;
1583
1584 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1585 }
1586 ;
1587
1588 *AnyEvent::Base::signal::DESTROY = sub {
1589 my ($signal, $cb) = @{$_[0]};
1590
1591 _sig_del;
1592
1593 delete $SIG_CB{$signal}{$cb};
1594
1595 $HAVE_ASYNC_INTERRUPT
1596 ? delete $SIG_ASY{$signal}
1597 : # delete doesn't work with older perls - they then
1598 # print weird messages, or just unconditionally exit
1599 # instead of getting the default action.
1600 undef $SIG{$signal}
1601 unless keys %{ $SIG_CB{$signal} };
1602 };
1603
1604 *_signal_exec = sub {
1605 $HAVE_ASYNC_INTERRUPT
1606 ? $SIGPIPE_R->drain
1607 : sysread $SIGPIPE_R, (my $dummy), 9;
1608
1609 while (%SIG_EV) {
1610 for (keys %SIG_EV) {
1611 delete $SIG_EV{$_};
1612 $_->() for values %{ $SIG_CB{$_} || {} };
1613 }
1614 }
1615 };
1185 }; 1616 };
1617 die if $@;
1186 1618
1187 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1619 &signal
1188}
1189
1190sub AnyEvent::Base::signal::DESTROY {
1191 my ($signal, $cb) = @{$_[0]};
1192
1193 delete $SIG_CB{$signal}{$cb};
1194
1195 # delete doesn't work with older perls - they then
1196 # print weird messages, or just unconditionally exit
1197 # instead of getting the default action.
1198 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1199} 1620}
1200 1621
1201# default implementation for ->child 1622# default implementation for ->child
1202 1623
1203our %PID_CB; 1624our %PID_CB;
1204our $CHLD_W; 1625our $CHLD_W;
1205our $CHLD_DELAY_W; 1626our $CHLD_DELAY_W;
1206our $WNOHANG; 1627our $WNOHANG;
1207 1628
1208sub _sigchld { 1629# used by many Impl's
1209 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1630sub _emit_childstatus($$) {
1631 my (undef, $rpid, $rstatus) = @_;
1632
1633 $_->($rpid, $rstatus)
1210 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1634 for values %{ $PID_CB{$rpid} || {} },
1211 (values %{ $PID_CB{0} || {} }); 1635 values %{ $PID_CB{0} || {} };
1212 }
1213} 1636}
1214 1637
1215sub child { 1638sub child {
1639 eval q{ # poor man's autoloading {}
1640 *_sigchld = sub {
1641 my $pid;
1642
1643 AnyEvent->_emit_childstatus ($pid, $?)
1644 while ($pid = waitpid -1, $WNOHANG) > 0;
1645 };
1646
1647 *child = sub {
1216 my (undef, %arg) = @_; 1648 my (undef, %arg) = @_;
1217 1649
1218 defined (my $pid = $arg{pid} + 0) 1650 defined (my $pid = $arg{pid} + 0)
1219 or Carp::croak "required option 'pid' is missing"; 1651 or Carp::croak "required option 'pid' is missing";
1220 1652
1221 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1653 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1222 1654
1655 # WNOHANG is almost cetrainly 1 everywhere
1656 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1657 ? 1
1223 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1658 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1224 1659
1225 unless ($CHLD_W) { 1660 unless ($CHLD_W) {
1226 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1661 $CHLD_W = AE::signal CHLD => \&_sigchld;
1227 # child could be a zombie already, so make at least one round 1662 # child could be a zombie already, so make at least one round
1228 &_sigchld; 1663 &_sigchld;
1229 } 1664 }
1230 1665
1231 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1666 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1232} 1667 };
1233 1668
1234sub AnyEvent::Base::child::DESTROY { 1669 *AnyEvent::Base::child::DESTROY = sub {
1235 my ($pid, $cb) = @{$_[0]}; 1670 my ($pid, $cb) = @{$_[0]};
1236 1671
1237 delete $PID_CB{$pid}{$cb}; 1672 delete $PID_CB{$pid}{$cb};
1238 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1673 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1239 1674
1240 undef $CHLD_W unless keys %PID_CB; 1675 undef $CHLD_W unless keys %PID_CB;
1676 };
1677 };
1678 die if $@;
1679
1680 &child
1241} 1681}
1242 1682
1243# idle emulation is done by simply using a timer, regardless 1683# idle emulation is done by simply using a timer, regardless
1244# of whether the process is idle or not, and not letting 1684# of whether the process is idle or not, and not letting
1245# the callback use more than 50% of the time. 1685# the callback use more than 50% of the time.
1246sub idle { 1686sub idle {
1687 eval q{ # poor man's autoloading {}
1688 *idle = sub {
1247 my (undef, %arg) = @_; 1689 my (undef, %arg) = @_;
1248 1690
1249 my ($cb, $w, $rcb) = $arg{cb}; 1691 my ($cb, $w, $rcb) = $arg{cb};
1250 1692
1251 $rcb = sub { 1693 $rcb = sub {
1252 if ($cb) { 1694 if ($cb) {
1253 $w = _time; 1695 $w = _time;
1254 &$cb; 1696 &$cb;
1255 $w = _time - $w; 1697 $w = _time - $w;
1256 1698
1257 # never use more then 50% of the time for the idle watcher, 1699 # never use more then 50% of the time for the idle watcher,
1258 # within some limits 1700 # within some limits
1259 $w = 0.0001 if $w < 0.0001; 1701 $w = 0.0001 if $w < 0.0001;
1260 $w = 5 if $w > 5; 1702 $w = 5 if $w > 5;
1261 1703
1262 $w = AnyEvent->timer (after => $w, cb => $rcb); 1704 $w = AE::timer $w, 0, $rcb;
1263 } else { 1705 } else {
1264 # clean up... 1706 # clean up...
1265 undef $w; 1707 undef $w;
1266 undef $rcb; 1708 undef $rcb;
1709 }
1710 };
1711
1712 $w = AE::timer 0.05, 0, $rcb;
1713
1714 bless \\$cb, "AnyEvent::Base::idle"
1267 } 1715 };
1716
1717 *AnyEvent::Base::idle::DESTROY = sub {
1718 undef $${$_[0]};
1719 };
1268 }; 1720 };
1721 die if $@;
1269 1722
1270 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1723 &idle
1271
1272 bless \\$cb, "AnyEvent::Base::idle"
1273}
1274
1275sub AnyEvent::Base::idle::DESTROY {
1276 undef $${$_[0]};
1277} 1724}
1278 1725
1279package AnyEvent::CondVar; 1726package AnyEvent::CondVar;
1280 1727
1281our @ISA = AnyEvent::CondVar::Base::; 1728our @ISA = AnyEvent::CondVar::Base::;
1282 1729
1283package AnyEvent::CondVar::Base; 1730package AnyEvent::CondVar::Base;
1284 1731
1285use overload 1732#use overload
1286 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1733# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1287 fallback => 1; 1734# fallback => 1;
1735
1736# save 300+ kilobytes by dirtily hardcoding overloading
1737${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1738*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1739*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1740${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1741
1742our $WAITING;
1288 1743
1289sub _send { 1744sub _send {
1290 # nop 1745 # nop
1291} 1746}
1292 1747
1305sub ready { 1760sub ready {
1306 $_[0]{_ae_sent} 1761 $_[0]{_ae_sent}
1307} 1762}
1308 1763
1309sub _wait { 1764sub _wait {
1765 $WAITING
1766 and !$_[0]{_ae_sent}
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected";
1768
1769 local $WAITING = 1;
1310 AnyEvent->one_event while !$_[0]{_ae_sent}; 1770 AnyEvent->one_event while !$_[0]{_ae_sent};
1311} 1771}
1312 1772
1313sub recv { 1773sub recv {
1314 $_[0]->_wait; 1774 $_[0]->_wait;
1316 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1776 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1317 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1777 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1318} 1778}
1319 1779
1320sub cb { 1780sub cb {
1321 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1781 my $cv = shift;
1782
1783 @_
1784 and $cv->{_ae_cb} = shift
1785 and $cv->{_ae_sent}
1786 and (delete $cv->{_ae_cb})->($cv);
1787
1322 $_[0]{_ae_cb} 1788 $cv->{_ae_cb}
1323} 1789}
1324 1790
1325sub begin { 1791sub begin {
1326 ++$_[0]{_ae_counter}; 1792 ++$_[0]{_ae_counter};
1327 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1793 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1376C<PERL_ANYEVENT_MODEL>. 1842C<PERL_ANYEVENT_MODEL>.
1377 1843
1378When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1844When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1379model it chooses. 1845model it chooses.
1380 1846
1847When set to C<8> or higher, then AnyEvent will report extra information on
1848which optional modules it loads and how it implements certain features.
1849
1381=item C<PERL_ANYEVENT_STRICT> 1850=item C<PERL_ANYEVENT_STRICT>
1382 1851
1383AnyEvent does not do much argument checking by default, as thorough 1852AnyEvent does not do much argument checking by default, as thorough
1384argument checking is very costly. Setting this variable to a true value 1853argument checking is very costly. Setting this variable to a true value
1385will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1854will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1386check the arguments passed to most method calls. If it finds any problems, 1855check the arguments passed to most method calls. If it finds any problems,
1387it will croak. 1856it will croak.
1388 1857
1389In other words, enables "strict" mode. 1858In other words, enables "strict" mode.
1390 1859
1391Unlike C<use strict>, it is definitely recommended to keep it off in 1860Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1392production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1861>>, it is definitely recommended to keep it off in production. Keeping
1393developing programs can be very useful, however. 1862C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1863can be very useful, however.
1394 1864
1395=item C<PERL_ANYEVENT_MODEL> 1865=item C<PERL_ANYEVENT_MODEL>
1396 1866
1397This can be used to specify the event model to be used by AnyEvent, before 1867This can be used to specify the event model to be used by AnyEvent, before
1398auto detection and -probing kicks in. It must be a string consisting 1868auto detection and -probing kicks in. It must be a string consisting
1441 1911
1442=item C<PERL_ANYEVENT_MAX_FORKS> 1912=item C<PERL_ANYEVENT_MAX_FORKS>
1443 1913
1444The maximum number of child processes that C<AnyEvent::Util::fork_call> 1914The maximum number of child processes that C<AnyEvent::Util::fork_call>
1445will create in parallel. 1915will create in parallel.
1916
1917=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1918
1919The default value for the C<max_outstanding> parameter for the default DNS
1920resolver - this is the maximum number of parallel DNS requests that are
1921sent to the DNS server.
1922
1923=item C<PERL_ANYEVENT_RESOLV_CONF>
1924
1925The file to use instead of F</etc/resolv.conf> (or OS-specific
1926configuration) in the default resolver. When set to the empty string, no
1927default config will be used.
1928
1929=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1930
1931When neither C<ca_file> nor C<ca_path> was specified during
1932L<AnyEvent::TLS> context creation, and either of these environment
1933variables exist, they will be used to specify CA certificate locations
1934instead of a system-dependent default.
1935
1936=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1937
1938When these are set to C<1>, then the respective modules are not
1939loaded. Mostly good for testing AnyEvent itself.
1446 1940
1447=back 1941=back
1448 1942
1449=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1943=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1450 1944
1508 warn "read: $input\n"; # output what has been read 2002 warn "read: $input\n"; # output what has been read
1509 $cv->send if $input =~ /^q/i; # quit program if /^q/i 2003 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1510 }, 2004 },
1511 ); 2005 );
1512 2006
1513 my $time_watcher; # can only be used once
1514
1515 sub new_timer {
1516 $timer = AnyEvent->timer (after => 1, cb => sub { 2007 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1517 warn "timeout\n"; # print 'timeout' about every second 2008 warn "timeout\n"; # print 'timeout' at most every second
1518 &new_timer; # and restart the time
1519 }); 2009 });
1520 }
1521
1522 new_timer; # create first timer
1523 2010
1524 $cv->recv; # wait until user enters /^q/i 2011 $cv->recv; # wait until user enters /^q/i
1525 2012
1526=head1 REAL-WORLD EXAMPLE 2013=head1 REAL-WORLD EXAMPLE
1527 2014
1600 2087
1601The actual code goes further and collects all errors (C<die>s, exceptions) 2088The actual code goes further and collects all errors (C<die>s, exceptions)
1602that occurred during request processing. The C<result> method detects 2089that occurred during request processing. The C<result> method detects
1603whether an exception as thrown (it is stored inside the $txn object) 2090whether an exception as thrown (it is stored inside the $txn object)
1604and just throws the exception, which means connection errors and other 2091and just throws the exception, which means connection errors and other
1605problems get reported tot he code that tries to use the result, not in a 2092problems get reported to the code that tries to use the result, not in a
1606random callback. 2093random callback.
1607 2094
1608All of this enables the following usage styles: 2095All of this enables the following usage styles:
1609 2096
16101. Blocking: 20971. Blocking:
1658through AnyEvent. The benchmark creates a lot of timers (with a zero 2145through AnyEvent. The benchmark creates a lot of timers (with a zero
1659timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2146timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1660which it is), lets them fire exactly once and destroys them again. 2147which it is), lets them fire exactly once and destroys them again.
1661 2148
1662Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2149Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1663distribution. 2150distribution. It uses the L<AE> interface, which makes a real difference
2151for the EV and Perl backends only.
1664 2152
1665=head3 Explanation of the columns 2153=head3 Explanation of the columns
1666 2154
1667I<watcher> is the number of event watchers created/destroyed. Since 2155I<watcher> is the number of event watchers created/destroyed. Since
1668different event models feature vastly different performances, each event 2156different event models feature vastly different performances, each event
1689watcher. 2177watcher.
1690 2178
1691=head3 Results 2179=head3 Results
1692 2180
1693 name watchers bytes create invoke destroy comment 2181 name watchers bytes create invoke destroy comment
1694 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2182 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1695 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2183 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1696 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2184 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1697 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2185 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1698 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2186 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1699 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2187 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2188 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2189 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1700 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2190 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1701 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2191 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1702 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2192 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1703 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2193 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1704 2194
1705=head3 Discussion 2195=head3 Discussion
1706 2196
1707The benchmark does I<not> measure scalability of the event loop very 2197The benchmark does I<not> measure scalability of the event loop very
1708well. For example, a select-based event loop (such as the pure perl one) 2198well. For example, a select-based event loop (such as the pure perl one)
1720benchmark machine, handling an event takes roughly 1600 CPU cycles with 2210benchmark machine, handling an event takes roughly 1600 CPU cycles with
1721EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2211EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
1722cycles with POE. 2212cycles with POE.
1723 2213
1724C<EV> is the sole leader regarding speed and memory use, which are both 2214C<EV> is the sole leader regarding speed and memory use, which are both
1725maximal/minimal, respectively. Even when going through AnyEvent, it uses 2215maximal/minimal, respectively. When using the L<AE> API there is zero
2216overhead (when going through the AnyEvent API create is about 5-6 times
2217slower, with other times being equal, so still uses far less memory than
1726far less memory than any other event loop and is still faster than Event 2218any other event loop and is still faster than Event natively).
1727natively.
1728 2219
1729The pure perl implementation is hit in a few sweet spots (both the 2220The pure perl implementation is hit in a few sweet spots (both the
1730constant timeout and the use of a single fd hit optimisations in the perl 2221constant timeout and the use of a single fd hit optimisations in the perl
1731interpreter and the backend itself). Nevertheless this shows that it 2222interpreter and the backend itself). Nevertheless this shows that it
1732adds very little overhead in itself. Like any select-based backend its 2223adds very little overhead in itself. Like any select-based backend its
1733performance becomes really bad with lots of file descriptors (and few of 2224performance becomes really bad with lots of file descriptors (and few of
1734them active), of course, but this was not subject of this benchmark. 2225them active), of course, but this was not subject of this benchmark.
1735 2226
1736The C<Event> module has a relatively high setup and callback invocation 2227The C<Event> module has a relatively high setup and callback invocation
1737cost, but overall scores in on the third place. 2228cost, but overall scores in on the third place.
2229
2230C<IO::Async> performs admirably well, about on par with C<Event>, even
2231when using its pure perl backend.
1738 2232
1739C<Glib>'s memory usage is quite a bit higher, but it features a 2233C<Glib>'s memory usage is quite a bit higher, but it features a
1740faster callback invocation and overall ends up in the same class as 2234faster callback invocation and overall ends up in the same class as
1741C<Event>. However, Glib scales extremely badly, doubling the number of 2235C<Event>. However, Glib scales extremely badly, doubling the number of
1742watchers increases the processing time by more than a factor of four, 2236watchers increases the processing time by more than a factor of four,
1803In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2297In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1804(1%) are active. This mirrors the activity of large servers with many 2298(1%) are active. This mirrors the activity of large servers with many
1805connections, most of which are idle at any one point in time. 2299connections, most of which are idle at any one point in time.
1806 2300
1807Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2301Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1808distribution. 2302distribution. It uses the L<AE> interface, which makes a real difference
2303for the EV and Perl backends only.
1809 2304
1810=head3 Explanation of the columns 2305=head3 Explanation of the columns
1811 2306
1812I<sockets> is the number of sockets, and twice the number of "servers" (as 2307I<sockets> is the number of sockets, and twice the number of "servers" (as
1813each server has a read and write socket end). 2308each server has a read and write socket end).
1820it to another server. This includes deleting the old timeout and creating 2315it to another server. This includes deleting the old timeout and creating
1821a new one that moves the timeout into the future. 2316a new one that moves the timeout into the future.
1822 2317
1823=head3 Results 2318=head3 Results
1824 2319
1825 name sockets create request 2320 name sockets create request
1826 EV 20000 69.01 11.16 2321 EV 20000 62.66 7.99
1827 Perl 20000 73.32 35.87 2322 Perl 20000 68.32 32.64
1828 Event 20000 212.62 257.32 2323 IOAsync 20000 174.06 101.15 epoll
1829 Glib 20000 651.16 1896.30 2324 IOAsync 20000 174.67 610.84 poll
2325 Event 20000 202.69 242.91
2326 Glib 20000 557.01 1689.52
1830 POE 20000 349.67 12317.24 uses POE::Loop::Event 2327 POE 20000 341.54 12086.32 uses POE::Loop::Event
1831 2328
1832=head3 Discussion 2329=head3 Discussion
1833 2330
1834This benchmark I<does> measure scalability and overall performance of the 2331This benchmark I<does> measure scalability and overall performance of the
1835particular event loop. 2332particular event loop.
1837EV is again fastest. Since it is using epoll on my system, the setup time 2334EV is again fastest. Since it is using epoll on my system, the setup time
1838is relatively high, though. 2335is relatively high, though.
1839 2336
1840Perl surprisingly comes second. It is much faster than the C-based event 2337Perl surprisingly comes second. It is much faster than the C-based event
1841loops Event and Glib. 2338loops Event and Glib.
2339
2340IO::Async performs very well when using its epoll backend, and still quite
2341good compared to Glib when using its pure perl backend.
1842 2342
1843Event suffers from high setup time as well (look at its code and you will 2343Event suffers from high setup time as well (look at its code and you will
1844understand why). Callback invocation also has a high overhead compared to 2344understand why). Callback invocation also has a high overhead compared to
1845the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 2345the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1846uses select or poll in basically all documented configurations. 2346uses select or poll in basically all documented configurations.
1958As you can see, the AnyEvent + EV combination even beats the 2458As you can see, the AnyEvent + EV combination even beats the
1959hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2459hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
1960backend easily beats IO::Lambda and POE. 2460backend easily beats IO::Lambda and POE.
1961 2461
1962And even the 100% non-blocking version written using the high-level (and 2462And even the 100% non-blocking version written using the high-level (and
1963slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2463slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
1964large margin, even though it does all of DNS, tcp-connect and socket I/O 2464higher level ("unoptimised") abstractions by a large margin, even though
1965in a non-blocking way. 2465it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
1966 2466
1967The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2467The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
1968F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2468F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
1969part of the IO::lambda distribution and were used without any changes. 2469part of the IO::Lambda distribution and were used without any changes.
1970 2470
1971 2471
1972=head1 SIGNALS 2472=head1 SIGNALS
1973 2473
1974AnyEvent currently installs handlers for these signals: 2474AnyEvent currently installs handlers for these signals:
1979 2479
1980A handler for C<SIGCHLD> is installed by AnyEvent's child watcher 2480A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1981emulation for event loops that do not support them natively. Also, some 2481emulation for event loops that do not support them natively. Also, some
1982event loops install a similar handler. 2482event loops install a similar handler.
1983 2483
1984If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will 2484Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
1985reset it to default, to avoid losing child exit statuses. 2485AnyEvent will reset it to default, to avoid losing child exit statuses.
1986 2486
1987=item SIGPIPE 2487=item SIGPIPE
1988 2488
1989A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> 2489A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1990when AnyEvent gets loaded. 2490when AnyEvent gets loaded.
2008 if $SIG{CHLD} eq 'IGNORE'; 2508 if $SIG{CHLD} eq 'IGNORE';
2009 2509
2010$SIG{PIPE} = sub { } 2510$SIG{PIPE} = sub { }
2011 unless defined $SIG{PIPE}; 2511 unless defined $SIG{PIPE};
2012 2512
2513=head1 RECOMMENDED/OPTIONAL MODULES
2514
2515One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
2516its built-in modules) are required to use it.
2517
2518That does not mean that AnyEvent won't take advantage of some additional
2519modules if they are installed.
2520
2521This section explains which additional modules will be used, and how they
2522affect AnyEvent's operation.
2523
2524=over 4
2525
2526=item L<Async::Interrupt>
2527
2528This slightly arcane module is used to implement fast signal handling: To
2529my knowledge, there is no way to do completely race-free and quick
2530signal handling in pure perl. To ensure that signals still get
2531delivered, AnyEvent will start an interval timer to wake up perl (and
2532catch the signals) with some delay (default is 10 seconds, look for
2533C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2534
2535If this module is available, then it will be used to implement signal
2536catching, which means that signals will not be delayed, and the event loop
2537will not be interrupted regularly, which is more efficient (and good for
2538battery life on laptops).
2539
2540This affects not just the pure-perl event loop, but also other event loops
2541that have no signal handling on their own (e.g. Glib, Tk, Qt).
2542
2543Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2544and either employ their own workarounds (POE) or use AnyEvent's workaround
2545(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2546does nothing for those backends.
2547
2548=item L<EV>
2549
2550This module isn't really "optional", as it is simply one of the backend
2551event loops that AnyEvent can use. However, it is simply the best event
2552loop available in terms of features, speed and stability: It supports
2553the AnyEvent API optimally, implements all the watcher types in XS, does
2554automatic timer adjustments even when no monotonic clock is available,
2555can take avdantage of advanced kernel interfaces such as C<epoll> and
2556C<kqueue>, and is the fastest backend I<by far>. You can even embed
2557L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>).
2558
2559If you only use backends that rely on another event loop (e.g. C<Tk>),
2560then this module will do nothing for you.
2561
2562=item L<Guard>
2563
2564The guard module, when used, will be used to implement
2565C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a
2566lot less memory), but otherwise doesn't affect guard operation much. It is
2567purely used for performance.
2568
2569=item L<JSON> and L<JSON::XS>
2570
2571One of these modules is required when you want to read or write JSON data
2572via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take
2573advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2574
2575=item L<Net::SSLeay>
2576
2577Implementing TLS/SSL in Perl is certainly interesting, but not very
2578worthwhile: If this module is installed, then L<AnyEvent::Handle> (with
2579the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL.
2580
2581=item L<Time::HiRes>
2582
2583This module is part of perl since release 5.008. It will be used when the
2584chosen event library does not come with a timing source of its own. The
2585pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to
2586try to use a monotonic clock for timing stability.
2587
2588=back
2589
2590
2013=head1 FORK 2591=head1 FORK
2014 2592
2015Most event libraries are not fork-safe. The ones who are usually are 2593Most event libraries are not fork-safe. The ones who are usually are
2016because they rely on inefficient but fork-safe C<select> or C<poll> 2594because they rely on inefficient but fork-safe C<select> or C<poll> calls
2017calls. Only L<EV> is fully fork-aware. 2595- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2596are usually badly thought-out hacks that are incompatible with fork in
2597one way or another. Only L<EV> is fully fork-aware and ensures that you
2598continue event-processing in both parent and child (or both, if you know
2599what you are doing).
2600
2601This means that, in general, you cannot fork and do event processing in
2602the child if the event library was initialised before the fork (which
2603usually happens when the first AnyEvent watcher is created, or the library
2604is loaded).
2018 2605
2019If you have to fork, you must either do so I<before> creating your first 2606If you have to fork, you must either do so I<before> creating your first
2020watcher OR you must not use AnyEvent at all in the child. 2607watcher OR you must not use AnyEvent at all in the child OR you must do
2608something completely out of the scope of AnyEvent.
2609
2610The problem of doing event processing in the parent I<and> the child
2611is much more complicated: even for backends that I<are> fork-aware or
2612fork-safe, their behaviour is not usually what you want: fork clones all
2613watchers, that means all timers, I/O watchers etc. are active in both
2614parent and child, which is almost never what you want. USing C<exec>
2615to start worker children from some kind of manage rprocess is usually
2616preferred, because it is much easier and cleaner, at the expense of having
2617to have another binary.
2021 2618
2022 2619
2023=head1 SECURITY CONSIDERATIONS 2620=head1 SECURITY CONSIDERATIONS
2024 2621
2025AnyEvent can be forced to load any event model via 2622AnyEvent can be forced to load any event model via
2063L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2660L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2064 2661
2065Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2662Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2066L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2663L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2067L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2664L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2068L<AnyEvent::Impl::POE>. 2665L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2069 2666
2070Non-blocking file handles, sockets, TCP clients and 2667Non-blocking file handles, sockets, TCP clients and
2071servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. 2668servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2072 2669
2073Asynchronous DNS: L<AnyEvent::DNS>. 2670Asynchronous DNS: L<AnyEvent::DNS>.
2074 2671
2075Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 2672Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
2673L<Coro::Event>,
2076 2674
2077Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2675Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
2676L<AnyEvent::HTTP>.
2078 2677
2079 2678
2080=head1 AUTHOR 2679=head1 AUTHOR
2081 2680
2082 Marc Lehmann <schmorp@schmorp.de> 2681 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines