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.231 by root, Wed Jul 8 13:46:46 2009 UTC vs.
Revision 1.354 by root, Thu Aug 11 21:26:39 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines