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.140 by root, Mon May 26 06:18:53 2008 UTC vs.
Revision 1.223 by root, Mon Jun 29 21:00:32 2009 UTC

1=head1 => NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event loops.
6 7
7=head1 SYNOPSIS 8=head1 SYNOPSIS
8 9
9 use AnyEvent; 10 use AnyEvent;
10 11
12 # file descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 13 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
14
15 # one-shot or repeating timers
16 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
17 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
18
19 print AnyEvent->now; # prints current event loop time
20 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
21
22 # POSIX signal
23 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
24
25 # child process exit
26 my $w = AnyEvent->child (pid => $pid, cb => sub {
27 my ($pid, $status) = @_;
12 ... 28 ...
13 }); 29 });
14 30
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 31 # called when event loop idle (if applicable)
16 ... 32 my $w = AnyEvent->idle (cb => sub { ... });
17 });
18 33
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 34 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 35 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 36 $w->recv; # enters "main loop" till $condvar gets ->send
37 # use a condvar in callback mode:
38 $w->cb (sub { $_[0]->recv });
39
40=head1 INTRODUCTION/TUTORIAL
41
42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage.
22 45
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 47
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 49nowadays. So what is different about AnyEvent?
27 50
28Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 51Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29policy> and AnyEvent is I<small and efficient>. 52policy> and AnyEvent is I<small and efficient>.
30 53
31First and foremost, I<AnyEvent is not an event model> itself, it only 54First 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 55interfaces to whatever event model the main program happens to use, in a
33pragmatic way. For event models and certain classes of immortals alike, 56pragmatic way. For event models and certain classes of immortals alike,
34the statement "there can only be one" is a bitter reality: In general, 57the 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 58only one event loop can be active at the same time in a process. AnyEvent
36helps hiding the differences between those event loops. 59cannot change this, but it can hide the differences between those event
60loops.
37 61
38The goal of AnyEvent is to offer module authors the ability to do event 62The 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 63programming (waiting for I/O or timer events) without subscribing to a
40religion, a way of living, and most importantly: without forcing your 64religion, a way of living, and most importantly: without forcing your
41module users into the same thing by forcing them to use the same event 65module users into the same thing by forcing them to use the same event
42model you use. 66model you use.
43 67
44For modules like POE or IO::Async (which is a total misnomer as it is 68For 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 69actually 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 70like joining a cult: After you joined, you are dependent on them and you
47cannot use anything else, as it is simply incompatible to everything that 71cannot use anything else, as they are simply incompatible to everything
48isn't itself. What's worse, all the potential users of your module are 72that isn't them. What's worse, all the potential users of your
49I<also> forced to use the same event loop you use. 73module are I<also> forced to use the same event loop you use.
50 74
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 75AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. AnyEvent + Tk works fine etc. etc. but none of these work together 76fine. 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 77with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54your module uses one of those, every user of your module has to use it, 78your module uses one of those, every user of your module has to use it,
55too. But if your module uses AnyEvent, it works transparently with all 79too. But if your module uses AnyEvent, it works transparently with all
56event models it supports (including stuff like POE and IO::Async, as long 80event models it supports (including stuff like IO::Async, as long as those
57as those use one of the supported event loops. It is trivial to add new 81use one of the supported event loops. It is trivial to add new event loops
58event loops to AnyEvent, too, so it is future-proof). 82to AnyEvent, too, so it is future-proof).
59 83
60In addition to being free of having to use I<the one and only true event 84In 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 85model>, 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 86modules, 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 87follow. AnyEvent, on the other hand, is lean and up to the point, by only
64offering the functionality that is necessary, in as thin as a wrapper as 88offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 89technically possible.
66 90
91Of course, AnyEvent comes with a big (and fully optional!) toolbox
92of useful functionality, such as an asynchronous DNS resolver, 100%
93non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
94such as Windows) and lots of real-world knowledge and workarounds for
95platform bugs and differences.
96
67Of course, if you want lots of policy (this can arguably be somewhat 97Now, 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 98useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 99model, you should I<not> use this module.
70 100
71=head1 DESCRIPTION 101=head1 DESCRIPTION
72 102
102starts using it, all bets are off. Maybe you should tell their authors to 132starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly... 133use AnyEvent so their modules work together with others seamlessly...
104 134
105The pure-perl implementation of AnyEvent is called 135The pure-perl implementation of AnyEvent is called
106C<AnyEvent::Impl::Perl>. Like other event modules you can load it 136C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107explicitly. 137explicitly and enjoy the high availability of that event loop :)
108 138
109=head1 WATCHERS 139=head1 WATCHERS
110 140
111AnyEvent has the central concept of a I<watcher>, which is an object that 141AnyEvent 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 142stores relevant data for each kind of event you are waiting for, such as
115These watchers are normal Perl objects with normal Perl lifetime. After 145These watchers are normal Perl objects with normal Perl lifetime. After
116creating a watcher it will immediately "watch" for events and invoke the 146creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model 147callback when the event occurs (of course, only when the event model
118is in control). 148is in control).
119 149
150Note that B<callbacks must not permanently change global variables>
151potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
152callbacks must not C<die> >>. The former is good programming practise in
153Perl and the latter stems from the fact that exception handling differs
154widely between event loops.
155
120To disable the watcher you have to destroy it (e.g. by setting the 156To disable the watcher you have to destroy it (e.g. by setting the
121variable you store it in to C<undef> or otherwise deleting all references 157variable you store it in to C<undef> or otherwise deleting all references
122to it). 158to it).
123 159
124All watchers are created by calling a method on the C<AnyEvent> class. 160All watchers are created by calling a method on the C<AnyEvent> class.
126Many watchers either are used with "recursion" (repeating timers for 162Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways. 163example), or need to refer to their watcher object in other ways.
128 164
129An any way to achieve that is this pattern: 165An any way to achieve that is this pattern:
130 166
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 167 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it 168 # you can use $w here, for example to undef it
133 undef $w; 169 undef $w;
134 }); 170 });
135 171
136Note that C<my $w; $w => combination. This is necessary because in Perl, 172Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are 173my variables are only visible after the statement in which they are
138declared. 174declared.
139 175
140=head2 I/O WATCHERS 176=head2 I/O WATCHERS
141 177
142You can create an I/O watcher by calling the C<< AnyEvent->io >> method 178You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
144 180
145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
182for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files
186or block devices.
187
146for events. C<poll> must be a string that is either C<r> or C<w>, 188C<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, 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
148respectively. C<cb> is the callback to invoke each time the file handle 191C<cb> is the callback to invoke each time the file handle becomes ready.
149becomes ready.
150 192
151Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
154 196
158 200
159Some event loops issue spurious readyness notifications, so you should 201Some event loops issue spurious readyness notifications, so you should
160always use non-blocking calls when reading/writing from/to your file 202always use non-blocking calls when reading/writing from/to your file
161handles. 203handles.
162 204
163Example:
164
165 # wait for readability of STDIN, then read a line and disable the watcher 205Example: wait for readability of STDIN, then read a line and disable the
206watcher.
207
166 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 208 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167 chomp (my $input = <STDIN>); 209 chomp (my $input = <STDIN>);
168 warn "read: $input\n"; 210 warn "read: $input\n";
169 undef $w; 211 undef $w;
170 }); 212 });
180 222
181Although the callback might get passed parameters, their value and 223Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent 224presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks. 225callbacks cannot use arguments passed to time watcher callbacks.
184 226
185The timer callback will be invoked at most once: if you want a repeating 227The callback will normally be invoked once only. If you specify another
186timer you have to create a new watcher (this is a limitation by both Tk 228parameter, C<interval>, as a strictly positive number (> 0), then the
187and Glib). 229callback will be invoked regularly at that interval (in fractional
230seconds) after the first invocation. If C<interval> is specified with a
231false value, then it is treated as if it were missing.
188 232
189Example: 233The callback will be rescheduled before invoking the callback, but no
234attempt is done to avoid timer drift in most backends, so the interval is
235only approximate.
190 236
191 # fire an event after 7.7 seconds 237Example: fire an event after 7.7 seconds.
238
192 my $w = AnyEvent->timer (after => 7.7, cb => sub { 239 my $w = AnyEvent->timer (after => 7.7, cb => sub {
193 warn "timeout\n"; 240 warn "timeout\n";
194 }); 241 });
195 242
196 # to cancel the timer: 243 # to cancel the timer:
197 undef $w; 244 undef $w;
198 245
199Example 2:
200
201 # fire an event after 0.5 seconds, then roughly every second 246Example 2: fire an event after 0.5 seconds, then roughly every second.
202 my $w;
203 247
204 my $cb = sub {
205 # cancel the old timer while creating a new one
206 $w = AnyEvent->timer (after => 1, cb => $cb); 248 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
249 warn "timeout\n";
207 }; 250 };
208
209 # start the "loop" by creating the first watcher
210 $w = AnyEvent->timer (after => 0.5, cb => $cb);
211 251
212=head3 TIMING ISSUES 252=head3 TIMING ISSUES
213 253
214There are two ways to handle timers: based on real time (relative, "fire 254There are two ways to handle timers: based on real time (relative, "fire
215in 10 seconds") and based on wallclock time (absolute, "fire at 12 255in 10 seconds") and based on wallclock time (absolute, "fire at 12
227timers. 267timers.
228 268
229AnyEvent always prefers relative timers, if available, matching the 269AnyEvent always prefers relative timers, if available, matching the
230AnyEvent API. 270AnyEvent API.
231 271
272AnyEvent has two additional methods that return the "current time":
273
274=over 4
275
276=item AnyEvent->time
277
278This returns the "current wallclock time" as a fractional number of
279seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
280return, and the result is guaranteed to be compatible with those).
281
282It progresses independently of any event loop processing, i.e. each call
283will check the system clock, which usually gets updated frequently.
284
285=item AnyEvent->now
286
287This also returns the "current wallclock time", but unlike C<time>, above,
288this value might change only once per event loop iteration, depending on
289the event loop (most return the same time as C<time>, above). This is the
290time that AnyEvent's timers get scheduled against.
291
292I<In almost all cases (in all cases if you don't care), this is the
293function to call when you want to know the current time.>
294
295This function is also often faster then C<< AnyEvent->time >>, and
296thus the preferred method if you want some timestamp (for example,
297L<AnyEvent::Handle> uses this to update it's activity timeouts).
298
299The rest of this section is only of relevance if you try to be very exact
300with your timing, you can skip it without bad conscience.
301
302For a practical example of when these times differ, consider L<Event::Lib>
303and L<EV> and the following set-up:
304
305The event loop is running and has just invoked one of your callback at
306time=500 (assume no other callbacks delay processing). In your callback,
307you wait a second by executing C<sleep 1> (blocking the process for a
308second) and then (at time=501) you create a relative timer that fires
309after three seconds.
310
311With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
312both return C<501>, because that is the current time, and the timer will
313be scheduled to fire at time=504 (C<501> + C<3>).
314
315With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
316time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
317last event processing phase started. With L<EV>, your timer gets scheduled
318to run at time=503 (C<500> + C<3>).
319
320In one sense, L<Event::Lib> is more exact, as it uses the current time
321regardless of any delays introduced by event processing. However, most
322callbacks do not expect large delays in processing, so this causes a
323higher drift (and a lot more system calls to get the current time).
324
325In another sense, L<EV> is more exact, as your timer will be scheduled at
326the same time, regardless of how long event processing actually took.
327
328In either case, if you care (and in most cases, you don't), then you
329can get whatever behaviour you want with any event loop, by taking the
330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
331account.
332
333=item AnyEvent->now_update
334
335Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
336the current time for each loop iteration (see the discussion of L<<
337AnyEvent->now >>, above).
338
339When a callback runs for a long time (or when the process sleeps), then
340this "current" time will differ substantially from the real time, which
341might affect timers and time-outs.
342
343When this is the case, you can call this method, which will update the
344event loop's idea of "current time".
345
346Note that updating the time I<might> cause some events to be handled.
347
348=back
349
232=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
233 351
234You can watch for signals using a signal watcher, C<signal> is the signal 352You 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 353I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236be invoked whenever a signal occurs. 354callback to be invoked whenever a signal occurs.
237 355
238Although the callback might get passed parameters, their value and 356Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 357presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 358callbacks cannot use arguments passed to signal watcher callbacks.
241 359
257=head2 CHILD PROCESS WATCHERS 375=head2 CHILD PROCESS WATCHERS
258 376
259You can also watch on a child process exit and catch its exit status. 377You can also watch on a child process exit and catch its exit status.
260 378
261The child process is specified by the C<pid> argument (if set to C<0>, it 379The child process is specified by the C<pid> argument (if set to C<0>, it
262watches for any child process exit). The watcher will trigger as often 380watches for any child process exit). The watcher will triggered only when
263as status change for the child are received. This works by installing a 381the child process has finished and an exit status is available, not on
264signal handler for C<SIGCHLD>. The callback will be called with the pid 382any trace events (stopped/continued).
265and exit status (as returned by waitpid), so unlike other watcher types, 383
266you I<can> rely on child watcher callback arguments. 384The callback will be called with the pid and exit status (as returned by
385waitpid), so unlike other watcher types, you I<can> rely on child watcher
386callback arguments.
387
388This watcher type works by installing a signal handler for C<SIGCHLD>,
389and since it cannot be shared, nothing else should use SIGCHLD or reap
390random child processes (waiting for specific child processes, e.g. inside
391C<system>, is just fine).
267 392
268There is a slight catch to child watchers, however: you usually start them 393There 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 394I<after> the child process was created, and this means the process could
270have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
271 396
272Not all event models handle this correctly (POE doesn't), but even for 397Not all event models handle this correctly (neither POE nor IO::Async do,
398see their AnyEvent::Impl manpages for details), but even for event models
273event models that I<do> handle this correctly, they usually need to be 399that 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). 400the process exits (i.e. before you fork in the first place). AnyEvent's
401pure perl event loop handles all cases correctly regardless of when you
402start the watcher.
275 403
276This means you cannot create a child watcher as the very first thing in an 404This means you cannot create a child watcher as the very first
277AnyEvent program, you I<have> to create at least one watcher before you 405thing in an AnyEvent program, you I<have> to create at least one
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 406watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>).
279 408
280Example: fork a process and wait for it 409Example: fork a process and wait for it
281 410
282 my $done = AnyEvent->condvar; 411 my $done = AnyEvent->condvar;
283 412
284 my $pid = fork or exit 5; 413 my $pid = fork or exit 5;
285 414
286 my $w = AnyEvent->child ( 415 my $w = AnyEvent->child (
287 pid => $pid, 416 pid => $pid,
288 cb => sub { 417 cb => sub {
289 my ($pid, $status) = @_; 418 my ($pid, $status) = @_;
290 warn "pid $pid exited with status $status"; 419 warn "pid $pid exited with status $status";
291 $done->send; 420 $done->send;
292 }, 421 },
293 ); 422 );
294 423
295 # do something else, then wait for process exit 424 # do something else, then wait for process exit
296 $done->recv; 425 $done->recv;
426
427=head2 IDLE WATCHERS
428
429Sometimes there is a need to do something, but it is not so important
430to do it instantly, but only when there is nothing better to do. This
431"nothing better to do" is usually defined to be "no other events need
432attention by the event loop".
433
434Idle watchers ideally get invoked when the event loop has nothing
435better to do, just before it would block the process to wait for new
436events. Instead of blocking, the idle watcher is invoked.
437
438Most event loops unfortunately do not really support idle watchers (only
439EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
440will simply call the callback "from time to time".
441
442Example: read lines from STDIN, but only process them when the
443program is otherwise idle:
444
445 my @lines; # read data
446 my $idle_w;
447 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
448 push @lines, scalar <STDIN>;
449
450 # start an idle watcher, if not already done
451 $idle_w ||= AnyEvent->idle (cb => sub {
452 # handle only one line, when there are lines left
453 if (my $line = shift @lines) {
454 print "handled when idle: $line";
455 } else {
456 # otherwise disable the idle watcher again
457 undef $idle_w;
458 }
459 });
460 });
297 461
298=head2 CONDITION VARIABLES 462=head2 CONDITION VARIABLES
299 463
300If you are familiar with some event loops you will know that all of them 464If 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 465require you to run some blocking "loop", "run" or similar function that
307The instrument to do that is called a "condition variable", so called 471The instrument to do that is called a "condition variable", so called
308because they represent a condition that must become true. 472because they represent a condition that must become true.
309 473
310Condition variables can be created by calling the C<< AnyEvent->condvar 474Condition variables can be created by calling the C<< AnyEvent->condvar
311>> method, usually without arguments. The only argument pair allowed is 475>> method, usually without arguments. The only argument pair allowed is
476
312C<cb>, which specifies a callback to be called when the condition variable 477C<cb>, which specifies a callback to be called when the condition variable
313becomes true. 478becomes true, with the condition variable as the first argument (but not
479the results).
314 480
315After creation, the condition variable is "false" until it becomes "true" 481After creation, the condition variable is "false" until it becomes "true"
316by calling the C<send> method (or calling the condition variable as if it 482by calling the C<send> method (or calling the condition variable as if it
317were a callback, read about the caveats in the description for the C<< 483were a callback, read about the caveats in the description for the C<<
318->send >> method). 484->send >> method).
374 540
375 my $done = AnyEvent->condvar; 541 my $done = AnyEvent->condvar;
376 my $delay = AnyEvent->timer (after => 5, cb => $done); 542 my $delay = AnyEvent->timer (after => 5, cb => $done);
377 $done->recv; 543 $done->recv;
378 544
545Example: Imagine an API that returns a condvar and doesn't support
546callbacks. This is how you make a synchronous call, for example from
547the main program:
548
549 use AnyEvent::CouchDB;
550
551 ...
552
553 my @info = $couchdb->info->recv;
554
555And this is how you would just ste a callback to be called whenever the
556results are available:
557
558 $couchdb->info->cb (sub {
559 my @info = $_[0]->recv;
560 });
561
379=head3 METHODS FOR PRODUCERS 562=head3 METHODS FOR PRODUCERS
380 563
381These methods should only be used by the producing side, i.e. the 564These methods should only be used by the producing side, i.e. the
382code/module that eventually sends the signal. Note that it is also 565code/module that eventually sends the signal. Note that it is also
383the producer side which creates the condvar in most cases, but it isn't 566the producer side which creates the condvar in most cases, but it isn't
416 599
417=item $cv->begin ([group callback]) 600=item $cv->begin ([group callback])
418 601
419=item $cv->end 602=item $cv->end
420 603
421These two methods are EXPERIMENTAL and MIGHT CHANGE.
422
423These two methods can be used to combine many transactions/events into 604These two methods can be used to combine many transactions/events into
424one. For example, a function that pings many hosts in parallel might want 605one. For example, a function that pings many hosts in parallel might want
425to use a condition variable for the whole process. 606to use a condition variable for the whole process.
426 607
427Every call to C<< ->begin >> will increment a counter, and every call to 608Every call to C<< ->begin >> will increment a counter, and every call to
428C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 609C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
429>>, the (last) callback passed to C<begin> will be executed. That callback 610>>, the (last) callback passed to C<begin> will be executed. That callback
430is I<supposed> to call C<< ->send >>, but that is not required. If no 611is I<supposed> to call C<< ->send >>, but that is not required. If no
431callback was set, C<send> will be called without any arguments. 612callback was set, C<send> will be called without any arguments.
432 613
433Let's clarify this with the ping example: 614You can think of C<< $cv->send >> giving you an OR condition (one call
615sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617
618Let's start with a simple example: you have two I/O watchers (for example,
619STDOUT and STDERR for a program), and you want to wait for both streams to
620close before activating a condvar:
621
622 my $cv = AnyEvent->condvar;
623
624 $cv->begin; # first watcher
625 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
626 defined sysread $fh1, my $buf, 4096
627 or $cv->end;
628 });
629
630 $cv->begin; # second watcher
631 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
632 defined sysread $fh2, my $buf, 4096
633 or $cv->end;
634 });
635
636 $cv->recv;
637
638This works because for every event source (EOF on file handle), there is
639one call to C<begin>, so the condvar waits for all calls to C<end> before
640sending.
641
642The ping example mentioned above is slightly more complicated, as the
643there are results to be passwd back, and the number of tasks that are
644begung can potentially be zero:
434 645
435 my $cv = AnyEvent->condvar; 646 my $cv = AnyEvent->condvar;
436 647
437 my %result; 648 my %result;
438 $cv->begin (sub { $cv->send (\%result) }); 649 $cv->begin (sub { $cv->send (\%result) });
458loop, which serves two important purposes: first, it sets the callback 669loop, which serves two important purposes: first, it sets the callback
459to be called once the counter reaches C<0>, and second, it ensures that 670to be called once the counter reaches C<0>, and second, it ensures that
460C<send> is called even when C<no> hosts are being pinged (the loop 671C<send> is called even when C<no> hosts are being pinged (the loop
461doesn't execute once). 672doesn't execute once).
462 673
463This is the general pattern when you "fan out" into multiple subrequests: 674This is the general pattern when you "fan out" into multiple (but
464use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 675potentially none) subrequests: use an outer C<begin>/C<end> pair to set
465is called at least once, and then, for each subrequest you start, call 676the callback and ensure C<end> is called at least once, and then, for each
466C<begin> and for each subrequest you finish, call C<end>. 677subrequest you start, call C<begin> and for each subrequest you finish,
678call C<end>.
467 679
468=back 680=back
469 681
470=head3 METHODS FOR CONSUMERS 682=head3 METHODS FOR CONSUMERS
471 683
516=item $bool = $cv->ready 728=item $bool = $cv->ready
517 729
518Returns true when the condition is "true", i.e. whether C<send> or 730Returns true when the condition is "true", i.e. whether C<send> or
519C<croak> have been called. 731C<croak> have been called.
520 732
521=item $cb = $cv->cb ([new callback]) 733=item $cb = $cv->cb ($cb->($cv))
522 734
523This is a mutator function that returns the callback set and optionally 735This is a mutator function that returns the callback set and optionally
524replaces it before doing so. 736replaces it before doing so.
525 737
526The callback will be called when the condition becomes "true", i.e. when 738The callback will be called when the condition becomes "true", i.e. when
527C<send> or C<croak> are called. Calling C<recv> inside the callback 739C<send> or C<croak> are called, with the only argument being the condition
528or at any later time is guaranteed not to block. 740variable itself. Calling C<recv> inside the callback or at any later time
741is guaranteed not to block.
529 742
530=back 743=back
531 744
532=head1 GLOBAL VARIABLES AND FUNCTIONS 745=head1 GLOBAL VARIABLES AND FUNCTIONS
533 746
550 AnyEvent::Impl::Tk based on Tk, very bad choice. 763 AnyEvent::Impl::Tk based on Tk, very bad choice.
551 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 764 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
552 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
553 AnyEvent::Impl::POE based on POE, not generic enough for full support. 766 AnyEvent::Impl::POE based on POE, not generic enough for full support.
554 767
768 # warning, support for IO::Async is only partial, as it is too broken
769 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
555There is no support for WxWidgets, as WxWidgets has no support for 772There is no support for WxWidgets, as WxWidgets has no support for
556watching file handles. However, you can use WxWidgets through the 773watching file handles. However, you can use WxWidgets through the
557POE Adaptor, as POE has a Wx backend that simply polls 20 times per 774POE Adaptor, as POE has a Wx backend that simply polls 20 times per
558second, which was considered to be too horrible to even consider for 775second, which was considered to be too horrible to even consider for
559AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
662=item L<AnyEvent::Util> 879=item L<AnyEvent::Util>
663 880
664Contains various utility functions that replace often-used but blocking 881Contains various utility functions that replace often-used but blocking
665functions such as C<inet_aton> by event-/callback-based versions. 882functions such as C<inet_aton> by event-/callback-based versions.
666 883
667=item L<AnyEvent::Handle>
668
669Provide read and write buffers and manages watchers for reads and writes.
670
671=item L<AnyEvent::Socket> 884=item L<AnyEvent::Socket>
672 885
673Provides various utility functions for (internet protocol) sockets, 886Provides various utility functions for (internet protocol) sockets,
674addresses and name resolution. Also functions to create non-blocking tcp 887addresses and name resolution. Also functions to create non-blocking tcp
675connections or tcp servers, with IPv6 and SRV record support and more. 888connections or tcp servers, with IPv6 and SRV record support and more.
676 889
890=item L<AnyEvent::Handle>
891
892Provide read and write buffers, manages watchers for reads and writes,
893supports raw and formatted I/O, I/O queued and fully transparent and
894non-blocking SSL/TLS.
895
677=item L<AnyEvent::DNS> 896=item L<AnyEvent::DNS>
678 897
679Provides rich asynchronous DNS resolver capabilities. 898Provides rich asynchronous DNS resolver capabilities.
680 899
900=item L<AnyEvent::HTTP>
901
902A simple-to-use HTTP library that is capable of making a lot of concurrent
903HTTP requests.
904
681=item L<AnyEvent::HTTPD> 905=item L<AnyEvent::HTTPD>
682 906
683Provides a simple web application server framework. 907Provides a simple web application server framework.
684 908
685=item L<AnyEvent::FastPing> 909=item L<AnyEvent::FastPing>
686 910
687The fastest ping in the west. 911The fastest ping in the west.
688 912
913=item L<AnyEvent::DBI>
914
915Executes L<DBI> requests asynchronously in a proxy process.
916
917=item L<AnyEvent::AIO>
918
919Truly asynchronous I/O, should be in the toolbox of every event
920programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
921together.
922
923=item L<AnyEvent::BDB>
924
925Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
926L<BDB> and AnyEvent together.
927
928=item L<AnyEvent::GPSD>
929
930A non-blocking interface to gpsd, a daemon delivering GPS information.
931
932=item L<AnyEvent::IGS>
933
934A non-blocking interface to the Internet Go Server protocol (used by
935L<App::IGS>).
936
689=item L<Net::IRC3> 937=item L<AnyEvent::IRC>
690 938
691AnyEvent based IRC client module family. 939AnyEvent based IRC client module family (replacing the older Net::IRC3).
692 940
693=item L<Net::XMPP2> 941=item L<Net::XMPP2>
694 942
695AnyEvent based XMPP (Jabber protocol) module family. 943AnyEvent based XMPP (Jabber protocol) module family.
696 944
705 953
706=item L<Coro> 954=item L<Coro>
707 955
708Has special support for AnyEvent via L<Coro::AnyEvent>. 956Has special support for AnyEvent via L<Coro::AnyEvent>.
709 957
710=item L<AnyEvent::AIO>, L<IO::AIO>
711
712Truly asynchronous I/O, should be in the toolbox of every event
713programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
714together.
715
716=item L<AnyEvent::BDB>, L<BDB>
717
718Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
719IO::AIO and AnyEvent together.
720
721=item L<IO::Lambda> 958=item L<IO::Lambda>
722 959
723The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 960The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
724 961
725=back 962=back
727=cut 964=cut
728 965
729package AnyEvent; 966package AnyEvent;
730 967
731no warnings; 968no warnings;
732use strict; 969use strict qw(vars subs);
733 970
734use Carp; 971use Carp;
735 972
736our $VERSION = '4.04'; 973our $VERSION = 4.45;
737our $MODEL; 974our $MODEL;
738 975
739our $AUTOLOAD; 976our $AUTOLOAD;
740our @ISA; 977our @ISA;
741 978
742our @REGISTRY; 979our @REGISTRY;
743 980
744our $WIN32; 981our $WIN32;
745 982
746BEGIN { 983BEGIN {
747 my $win32 = ! ! ($^O =~ /mswin32/i); 984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
748 eval "sub WIN32(){ $win32 }"; 985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT};
749} 989}
750 990
751our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
752 992
753our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
771 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
772 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
773 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
774 [Wx:: => AnyEvent::Impl::POE::], 1014 [Wx:: => AnyEvent::Impl::POE::],
775 [Prima:: => AnyEvent::Impl::POE::], 1015 [Prima:: => AnyEvent::Impl::POE::],
1016 # IO::Async is just too broken - we would need workaorunds for its
1017 # byzantine signal and broken child handling, among others.
1018 # IO::Async is rather hard to detect, as it doesn't have any
1019 # obvious default class.
1020# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
776); 1023);
777 1024
778our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 1025our %method = map +($_ => 1),
1026 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
779 1027
780our @post_detect; 1028our @post_detect;
781 1029
782sub post_detect(&) { 1030sub post_detect(&) {
783 my ($cb) = @_; 1031 my ($cb) = @_;
788 1 1036 1
789 } else { 1037 } else {
790 push @post_detect, $cb; 1038 push @post_detect, $cb;
791 1039
792 defined wantarray 1040 defined wantarray
793 ? bless \$cb, "AnyEvent::Util::PostDetect" 1041 ? bless \$cb, "AnyEvent::Util::postdetect"
794 : () 1042 : ()
795 } 1043 }
796} 1044}
797 1045
798sub AnyEvent::Util::PostDetect::DESTROY { 1046sub AnyEvent::Util::postdetect::DESTROY {
799 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
800} 1048}
801 1049
802sub detect() { 1050sub detect() {
803 unless ($MODEL) { 1051 unless ($MODEL) {
840 last; 1088 last;
841 } 1089 }
842 } 1090 }
843 1091
844 $MODEL 1092 $MODEL
845 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1093 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
846 } 1094 }
847 } 1095 }
848 1096
1097 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1098
849 unshift @ISA, $MODEL; 1099 unshift @ISA, $MODEL;
850 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1100
1101 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
851 1102
852 (shift @post_detect)->() while @post_detect; 1103 (shift @post_detect)->() while @post_detect;
853 } 1104 }
854 1105
855 $MODEL 1106 $MODEL
865 1116
866 my $class = shift; 1117 my $class = shift;
867 $class->$func (@_); 1118 $class->$func (@_);
868} 1119}
869 1120
1121# utility function to dup a filehandle. this is used by many backends
1122# to support binding more than one watcher per filehandle (they usually
1123# allow only one watcher per fd, so we dup it to get a different one).
1124sub _dupfh($$;$$) {
1125 my ($poll, $fh, $r, $w) = @_;
1126
1127 # cygwin requires the fh mode to be matching, unix doesn't
1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1129 : $poll eq "w" ? ($w, ">")
1130 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1131
1132 open my $fh2, "$mode&" . fileno $fh
1133 or die "cannot dup() filehandle: $!,";
1134
1135 # we assume CLOEXEC is already set by perl in all important cases
1136
1137 ($fh2, $rw)
1138}
1139
870package AnyEvent::Base; 1140package AnyEvent::Base;
871 1141
1142# default implementations for many methods
1143
1144BEGIN {
1145 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1146 *_time = \&Time::HiRes::time;
1147 # if (eval "use POSIX (); (POSIX::times())...
1148 } else {
1149 *_time = sub { time }; # epic fail
1150 }
1151}
1152
1153sub time { _time }
1154sub now { _time }
1155sub now_update { }
1156
872# default implementation for ->condvar 1157# default implementation for ->condvar
873 1158
874sub condvar { 1159sub condvar {
875 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1160 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
876} 1161}
877 1162
878# default implementation for ->signal 1163# default implementation for ->signal
879 1164
880our %SIG_CB; 1165our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1166
1167sub _signal_exec {
1168 sysread $SIGPIPE_R, my $dummy, 4;
1169
1170 while (%SIG_EV) {
1171 for (keys %SIG_EV) {
1172 delete $SIG_EV{$_};
1173 $_->() for values %{ $SIG_CB{$_} || {} };
1174 }
1175 }
1176}
881 1177
882sub signal { 1178sub signal {
883 my (undef, %arg) = @_; 1179 my (undef, %arg) = @_;
884 1180
1181 unless ($SIGPIPE_R) {
1182 require Fcntl;
1183
1184 if (AnyEvent::WIN32) {
1185 require AnyEvent::Util;
1186
1187 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1188 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1189 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1190 } else {
1191 pipe $SIGPIPE_R, $SIGPIPE_W;
1192 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1193 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1194
1195 # not strictly required, as $^F is normally 2, but let's make sure...
1196 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1197 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1198 }
1199
1200 $SIGPIPE_R
1201 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1202
1203 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1204 }
1205
885 my $signal = uc $arg{signal} 1206 my $signal = uc $arg{signal}
886 or Carp::croak "required option 'signal' is missing"; 1207 or Carp::croak "required option 'signal' is missing";
887 1208
888 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1209 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
889 $SIG{$signal} ||= sub { 1210 $SIG{$signal} ||= sub {
890 $_->() for values %{ $SIG_CB{$signal} || {} }; 1211 local $!;
1212 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1213 undef $SIG_EV{$signal};
891 }; 1214 };
892 1215
893 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1216 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
894} 1217}
895 1218
896sub AnyEvent::Base::Signal::DESTROY { 1219sub AnyEvent::Base::signal::DESTROY {
897 my ($signal, $cb) = @{$_[0]}; 1220 my ($signal, $cb) = @{$_[0]};
898 1221
899 delete $SIG_CB{$signal}{$cb}; 1222 delete $SIG_CB{$signal}{$cb};
900 1223
1224 # delete doesn't work with older perls - they then
1225 # print weird messages, or just unconditionally exit
1226 # instead of getting the default action.
901 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1227 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
902} 1228}
903 1229
904# default implementation for ->child 1230# default implementation for ->child
905 1231
906our %PID_CB; 1232our %PID_CB;
907our $CHLD_W; 1233our $CHLD_W;
908our $CHLD_DELAY_W; 1234our $CHLD_DELAY_W;
909our $PID_IDLE;
910our $WNOHANG; 1235our $WNOHANG;
911 1236
912sub _child_wait { 1237sub _sigchld {
913 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1238 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
914 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1239 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
915 (values %{ $PID_CB{0} || {} }); 1240 (values %{ $PID_CB{0} || {} });
916 } 1241 }
917
918 undef $PID_IDLE;
919}
920
921sub _sigchld {
922 # make sure we deliver these changes "synchronous" with the event loop.
923 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
924 undef $CHLD_DELAY_W;
925 &_child_wait;
926 });
927} 1242}
928 1243
929sub child { 1244sub child {
930 my (undef, %arg) = @_; 1245 my (undef, %arg) = @_;
931 1246
932 defined (my $pid = $arg{pid} + 0) 1247 defined (my $pid = $arg{pid} + 0)
933 or Carp::croak "required option 'pid' is missing"; 1248 or Carp::croak "required option 'pid' is missing";
934 1249
935 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1250 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
936 1251
937 unless ($WNOHANG) {
938 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1252 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
939 }
940 1253
941 unless ($CHLD_W) { 1254 unless ($CHLD_W) {
942 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1255 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
943 # child could be a zombie already, so make at least one round 1256 # child could be a zombie already, so make at least one round
944 &_sigchld; 1257 &_sigchld;
945 } 1258 }
946 1259
947 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1260 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
948} 1261}
949 1262
950sub AnyEvent::Base::Child::DESTROY { 1263sub AnyEvent::Base::child::DESTROY {
951 my ($pid, $cb) = @{$_[0]}; 1264 my ($pid, $cb) = @{$_[0]};
952 1265
953 delete $PID_CB{$pid}{$cb}; 1266 delete $PID_CB{$pid}{$cb};
954 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1267 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
955 1268
956 undef $CHLD_W unless keys %PID_CB; 1269 undef $CHLD_W unless keys %PID_CB;
1270}
1271
1272# idle emulation is done by simply using a timer, regardless
1273# of whether the process is idle or not, and not letting
1274# the callback use more than 50% of the time.
1275sub idle {
1276 my (undef, %arg) = @_;
1277
1278 my ($cb, $w, $rcb) = $arg{cb};
1279
1280 $rcb = sub {
1281 if ($cb) {
1282 $w = _time;
1283 &$cb;
1284 $w = _time - $w;
1285
1286 # never use more then 50% of the time for the idle watcher,
1287 # within some limits
1288 $w = 0.0001 if $w < 0.0001;
1289 $w = 5 if $w > 5;
1290
1291 $w = AnyEvent->timer (after => $w, cb => $rcb);
1292 } else {
1293 # clean up...
1294 undef $w;
1295 undef $rcb;
1296 }
1297 };
1298
1299 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1300
1301 bless \\$cb, "AnyEvent::Base::idle"
1302}
1303
1304sub AnyEvent::Base::idle::DESTROY {
1305 undef $${$_[0]};
957} 1306}
958 1307
959package AnyEvent::CondVar; 1308package AnyEvent::CondVar;
960 1309
961our @ISA = AnyEvent::CondVar::Base::; 1310our @ISA = AnyEvent::CondVar::Base::;
1013} 1362}
1014 1363
1015# undocumented/compatibility with pre-3.4 1364# undocumented/compatibility with pre-3.4
1016*broadcast = \&send; 1365*broadcast = \&send;
1017*wait = \&_wait; 1366*wait = \&_wait;
1367
1368=head1 ERROR AND EXCEPTION HANDLING
1369
1370In general, AnyEvent does not do any error handling - it relies on the
1371caller to do that if required. The L<AnyEvent::Strict> module (see also
1372the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1373checking of all AnyEvent methods, however, which is highly useful during
1374development.
1375
1376As for exception handling (i.e. runtime errors and exceptions thrown while
1377executing a callback), this is not only highly event-loop specific, but
1378also not in any way wrapped by this module, as this is the job of the main
1379program.
1380
1381The pure perl event loop simply re-throws the exception (usually
1382within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1383$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1384so on.
1385
1386=head1 ENVIRONMENT VARIABLES
1387
1388The following environment variables are used by this module or its
1389submodules.
1390
1391Note that AnyEvent will remove I<all> environment variables starting with
1392C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1393enabled.
1394
1395=over 4
1396
1397=item C<PERL_ANYEVENT_VERBOSE>
1398
1399By default, AnyEvent will be completely silent except in fatal
1400conditions. You can set this environment variable to make AnyEvent more
1401talkative.
1402
1403When set to C<1> or higher, causes AnyEvent to warn about unexpected
1404conditions, such as not being able to load the event model specified by
1405C<PERL_ANYEVENT_MODEL>.
1406
1407When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1408model it chooses.
1409
1410=item C<PERL_ANYEVENT_STRICT>
1411
1412AnyEvent does not do much argument checking by default, as thorough
1413argument checking is very costly. Setting this variable to a true value
1414will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1415check the arguments passed to most method calls. If it finds any problems,
1416it will croak.
1417
1418In other words, enables "strict" mode.
1419
1420Unlike C<use strict>, it is definitely recommended to keep it off in
1421production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1422developing programs can be very useful, however.
1423
1424=item C<PERL_ANYEVENT_MODEL>
1425
1426This can be used to specify the event model to be used by AnyEvent, before
1427auto detection and -probing kicks in. It must be a string consisting
1428entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1429and the resulting module name is loaded and if the load was successful,
1430used as event model. If it fails to load AnyEvent will proceed with
1431auto detection and -probing.
1432
1433This functionality might change in future versions.
1434
1435For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1436could start your program like this:
1437
1438 PERL_ANYEVENT_MODEL=Perl perl ...
1439
1440=item C<PERL_ANYEVENT_PROTOCOLS>
1441
1442Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1443for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1444of auto probing).
1445
1446Must be set to a comma-separated list of protocols or address families,
1447current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1448used, and preference will be given to protocols mentioned earlier in the
1449list.
1450
1451This variable can effectively be used for denial-of-service attacks
1452against local programs (e.g. when setuid), although the impact is likely
1453small, as the program has to handle conenction and other failures anyways.
1454
1455Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1456but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1457- only support IPv4, never try to resolve or contact IPv6
1458addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1459IPv6, but prefer IPv6 over IPv4.
1460
1461=item C<PERL_ANYEVENT_EDNS0>
1462
1463Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1464for DNS. This extension is generally useful to reduce DNS traffic, but
1465some (broken) firewalls drop such DNS packets, which is why it is off by
1466default.
1467
1468Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1469EDNS0 in its DNS requests.
1470
1471=item C<PERL_ANYEVENT_MAX_FORKS>
1472
1473The maximum number of child processes that C<AnyEvent::Util::fork_call>
1474will create in parallel.
1475
1476=back
1018 1477
1019=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1478=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1020 1479
1021This is an advanced topic that you do not normally need to use AnyEvent in 1480This is an advanced topic that you do not normally need to use AnyEvent in
1022a module. This section is only of use to event loop authors who want to 1481a module. This section is only of use to event loop authors who want to
1056 1515
1057I<rxvt-unicode> also cheats a bit by not providing blocking access to 1516I<rxvt-unicode> also cheats a bit by not providing blocking access to
1058condition variables: code blocking while waiting for a condition will 1517condition variables: code blocking while waiting for a condition will
1059C<die>. This still works with most modules/usages, and blocking calls must 1518C<die>. This still works with most modules/usages, and blocking calls must
1060not be done in an interactive application, so it makes sense. 1519not be done in an interactive application, so it makes sense.
1061
1062=head1 ENVIRONMENT VARIABLES
1063
1064The following environment variables are used by this module:
1065
1066=over 4
1067
1068=item C<PERL_ANYEVENT_VERBOSE>
1069
1070By default, AnyEvent will be completely silent except in fatal
1071conditions. You can set this environment variable to make AnyEvent more
1072talkative.
1073
1074When set to C<1> or higher, causes AnyEvent to warn about unexpected
1075conditions, such as not being able to load the event model specified by
1076C<PERL_ANYEVENT_MODEL>.
1077
1078When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1079model it chooses.
1080
1081=item C<PERL_ANYEVENT_MODEL>
1082
1083This can be used to specify the event model to be used by AnyEvent, before
1084auto detection and -probing kicks in. It must be a string consisting
1085entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1086and the resulting module name is loaded and if the load was successful,
1087used as event model. If it fails to load AnyEvent will proceed with
1088auto detection and -probing.
1089
1090This functionality might change in future versions.
1091
1092For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1093could start your program like this:
1094
1095 PERL_ANYEVENT_MODEL=Perl perl ...
1096
1097=item C<PERL_ANYEVENT_PROTOCOLS>
1098
1099Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1100for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1101of auto probing).
1102
1103Must be set to a comma-separated list of protocols or address families,
1104current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1105used, and preference will be given to protocols mentioned earlier in the
1106list.
1107
1108This variable can effectively be used for denial-of-service attacks
1109against local programs (e.g. when setuid), although the impact is likely
1110small, as the program has to handle connection errors already-
1111
1112Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1113but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1114- only support IPv4, never try to resolve or contact IPv6
1115addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1116IPv6, but prefer IPv6 over IPv4.
1117
1118=item C<PERL_ANYEVENT_EDNS0>
1119
1120Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1121for DNS. This extension is generally useful to reduce DNS traffic, but
1122some (broken) firewalls drop such DNS packets, which is why it is off by
1123default.
1124
1125Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1126EDNS0 in its DNS requests.
1127
1128=back
1129 1520
1130=head1 EXAMPLE PROGRAM 1521=head1 EXAMPLE PROGRAM
1131 1522
1132The following program uses an I/O watcher to read data from STDIN, a timer 1523The following program uses an I/O watcher to read data from STDIN, a timer
1133to display a message once per second, and a condition variable to quit the 1524to display a message once per second, and a condition variable to quit the
1327watcher. 1718watcher.
1328 1719
1329=head3 Results 1720=head3 Results
1330 1721
1331 name watchers bytes create invoke destroy comment 1722 name watchers bytes create invoke destroy comment
1332 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1723 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1333 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1724 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1334 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1725 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1335 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1726 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1336 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1727 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1337 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1728 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1729 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1730 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1338 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1731 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1339 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1732 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1340 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1733 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1341 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1734 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1342 1735
1343=head3 Discussion 1736=head3 Discussion
1344 1737
1345The benchmark does I<not> measure scalability of the event loop very 1738The benchmark does I<not> measure scalability of the event loop very
1346well. For example, a select-based event loop (such as the pure perl one) 1739well. For example, a select-based event loop (such as the pure perl one)
1371performance becomes really bad with lots of file descriptors (and few of 1764performance becomes really bad with lots of file descriptors (and few of
1372them active), of course, but this was not subject of this benchmark. 1765them active), of course, but this was not subject of this benchmark.
1373 1766
1374The C<Event> module has a relatively high setup and callback invocation 1767The C<Event> module has a relatively high setup and callback invocation
1375cost, but overall scores in on the third place. 1768cost, but overall scores in on the third place.
1769
1770C<IO::Async> performs admirably well, about on par with C<Event>, even
1771when using its pure perl backend.
1376 1772
1377C<Glib>'s memory usage is quite a bit higher, but it features a 1773C<Glib>'s memory usage is quite a bit higher, but it features a
1378faster callback invocation and overall ends up in the same class as 1774faster callback invocation and overall ends up in the same class as
1379C<Event>. However, Glib scales extremely badly, doubling the number of 1775C<Event>. However, Glib scales extremely badly, doubling the number of
1380watchers increases the processing time by more than a factor of four, 1776watchers increases the processing time by more than a factor of four,
1458it to another server. This includes deleting the old timeout and creating 1854it to another server. This includes deleting the old timeout and creating
1459a new one that moves the timeout into the future. 1855a new one that moves the timeout into the future.
1460 1856
1461=head3 Results 1857=head3 Results
1462 1858
1463 name sockets create request 1859 name sockets create request
1464 EV 20000 69.01 11.16 1860 EV 20000 69.01 11.16
1465 Perl 20000 73.32 35.87 1861 Perl 20000 73.32 35.87
1862 IOAsync 20000 157.00 98.14 epoll
1863 IOAsync 20000 159.31 616.06 poll
1466 Event 20000 212.62 257.32 1864 Event 20000 212.62 257.32
1467 Glib 20000 651.16 1896.30 1865 Glib 20000 651.16 1896.30
1468 POE 20000 349.67 12317.24 uses POE::Loop::Event 1866 POE 20000 349.67 12317.24 uses POE::Loop::Event
1469 1867
1470=head3 Discussion 1868=head3 Discussion
1471 1869
1472This benchmark I<does> measure scalability and overall performance of the 1870This benchmark I<does> measure scalability and overall performance of the
1473particular event loop. 1871particular event loop.
1475EV is again fastest. Since it is using epoll on my system, the setup time 1873EV is again fastest. Since it is using epoll on my system, the setup time
1476is relatively high, though. 1874is relatively high, though.
1477 1875
1478Perl surprisingly comes second. It is much faster than the C-based event 1876Perl surprisingly comes second. It is much faster than the C-based event
1479loops Event and Glib. 1877loops Event and Glib.
1878
1879IO::Async performs very well when using its epoll backend, and still quite
1880good compared to Glib when using its pure perl backend.
1480 1881
1481Event suffers from high setup time as well (look at its code and you will 1882Event suffers from high setup time as well (look at its code and you will
1482understand why). Callback invocation also has a high overhead compared to 1883understand why). Callback invocation also has a high overhead compared to
1483the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1884the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1484uses select or poll in basically all documented configurations. 1885uses select or poll in basically all documented configurations.
1547=item * C-based event loops perform very well with small number of 1948=item * C-based event loops perform very well with small number of
1548watchers, as the management overhead dominates. 1949watchers, as the management overhead dominates.
1549 1950
1550=back 1951=back
1551 1952
1953=head2 THE IO::Lambda BENCHMARK
1954
1955Recently I was told about the benchmark in the IO::Lambda manpage, which
1956could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1957simply compares IO::Lambda with POE, and IO::Lambda looks better (which
1958shouldn't come as a surprise to anybody). As such, the benchmark is
1959fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
1960very optimal. But how would AnyEvent compare when used without the extra
1961baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
1962
1963The benchmark itself creates an echo-server, and then, for 500 times,
1964connects to the echo server, sends a line, waits for the reply, and then
1965creates the next connection. This is a rather bad benchmark, as it doesn't
1966test the efficiency of the framework or much non-blocking I/O, but it is a
1967benchmark nevertheless.
1968
1969 name runtime
1970 Lambda/select 0.330 sec
1971 + optimized 0.122 sec
1972 Lambda/AnyEvent 0.327 sec
1973 + optimized 0.138 sec
1974 Raw sockets/select 0.077 sec
1975 POE/select, components 0.662 sec
1976 POE/select, raw sockets 0.226 sec
1977 POE/select, optimized 0.404 sec
1978
1979 AnyEvent/select/nb 0.085 sec
1980 AnyEvent/EV/nb 0.068 sec
1981 +state machine 0.134 sec
1982
1983The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
1984benchmarks actually make blocking connects and use 100% blocking I/O,
1985defeating the purpose of an event-based solution. All of the newly
1986written AnyEvent benchmarks use 100% non-blocking connects (using
1987AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
1988resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
1989generally require a lot more bookkeeping and event handling than blocking
1990connects (which involve a single syscall only).
1991
1992The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
1993offers similar expressive power as POE and IO::Lambda, using conventional
1994Perl syntax. This means that both the echo server and the client are 100%
1995non-blocking, further placing it at a disadvantage.
1996
1997As you can see, the AnyEvent + EV combination even beats the
1998hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
1999backend easily beats IO::Lambda and POE.
2000
2001And even the 100% non-blocking version written using the high-level (and
2002slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2003large margin, even though it does all of DNS, tcp-connect and socket I/O
2004in a non-blocking way.
2005
2006The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2007F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2008part of the IO::lambda distribution and were used without any changes.
2009
2010
2011=head1 SIGNALS
2012
2013AnyEvent currently installs handlers for these signals:
2014
2015=over 4
2016
2017=item SIGCHLD
2018
2019A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2020emulation for event loops that do not support them natively. Also, some
2021event loops install a similar handler.
2022
2023If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2024reset it to default, to avoid losing child exit statuses.
2025
2026=item SIGPIPE
2027
2028A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2029when AnyEvent gets loaded.
2030
2031The rationale for this is that AnyEvent users usually do not really depend
2032on SIGPIPE delivery (which is purely an optimisation for shell use, or
2033badly-written programs), but C<SIGPIPE> can cause spurious and rare
2034program exits as a lot of people do not expect C<SIGPIPE> when writing to
2035some random socket.
2036
2037The rationale for installing a no-op handler as opposed to ignoring it is
2038that this way, the handler will be restored to defaults on exec.
2039
2040Feel free to install your own handler, or reset it to defaults.
2041
2042=back
2043
2044=cut
2045
2046undef $SIG{CHLD}
2047 if $SIG{CHLD} eq 'IGNORE';
2048
2049$SIG{PIPE} = sub { }
2050 unless defined $SIG{PIPE};
1552 2051
1553=head1 FORK 2052=head1 FORK
1554 2053
1555Most event libraries are not fork-safe. The ones who are usually are 2054Most event libraries are not fork-safe. The ones who are usually are
1556because they rely on inefficient but fork-safe C<select> or C<poll> 2055because they rely on inefficient but fork-safe C<select> or C<poll>
1570specified in the variable. 2069specified in the variable.
1571 2070
1572You can make AnyEvent completely ignore this variable by deleting it 2071You can make AnyEvent completely ignore this variable by deleting it
1573before the first watcher gets created, e.g. with a C<BEGIN> block: 2072before the first watcher gets created, e.g. with a C<BEGIN> block:
1574 2073
1575 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 2074 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1576 2075
1577 use AnyEvent; 2076 use AnyEvent;
1578 2077
1579Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2078Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1580be used to probe what backend is used and gain other information (which is 2079be used to probe what backend is used and gain other information (which is
1581probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 2080probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
2081$ENV{PERL_ANYEVENT_STRICT}.
2082
2083Note that AnyEvent will remove I<all> environment variables starting with
2084C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2085enabled.
2086
2087
2088=head1 BUGS
2089
2090Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
2091to work around. If you suffer from memleaks, first upgrade to Perl 5.10
2092and check wether the leaks still show up. (Perl 5.10.0 has other annoying
2093memleaks, such as leaking on C<map> and C<grep> but it is usually not as
2094pronounced).
1582 2095
1583 2096
1584=head1 SEE ALSO 2097=head1 SEE ALSO
1585 2098
1586Utility functions: L<AnyEvent::Util>. 2099Utility functions: L<AnyEvent::Util>.
1603Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 2116Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1604 2117
1605 2118
1606=head1 AUTHOR 2119=head1 AUTHOR
1607 2120
1608 Marc Lehmann <schmorp@schmorp.de> 2121 Marc Lehmann <schmorp@schmorp.de>
1609 http://home.schmorp.de/ 2122 http://home.schmorp.de/
1610 2123
1611=cut 2124=cut
1612 2125
16131 21261
1614 2127

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines