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.132 by root, Sun May 25 01:05:27 2008 UTC vs.
Revision 1.373 by root, Thu Aug 25 03:08:48 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines