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.104 by root, Wed Apr 30 11:40:22 2008 UTC vs.
Revision 1.173 by root, Mon Jul 21 03:47:22 2008 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, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 use AnyEvent; 9 use AnyEvent;
10 10
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... });
12
13 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
15
16 print AnyEvent->now; # prints current event loop time
17 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18
19 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20
21 my $w = AnyEvent->child (pid => $pid, cb => sub {
22 my ($pid, $status) = @_;
12 ... 23 ...
13 }); 24 });
14 25
15 my $w = AnyEvent->timer (after => $seconds, cb => sub {
16 ...
17 });
18
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 26 my $w = AnyEvent->condvar; # stores whether a condition was flagged
27 $w->send; # wake up current and all future recv's
20 $w->wait; # enters "main loop" till $condvar gets ->broadcast 28 $w->recv; # enters "main loop" till $condvar gets ->send
21 $w->broadcast; # wake up current and all future wait's 29 # use a condvar in callback mode:
30 $w->cb (sub { $_[0]->recv });
31
32=head1 INTRODUCTION/TUTORIAL
33
34This manpage is mainly a reference manual. If you are interested
35in a tutorial or some gentle introduction, have a look at the
36L<AnyEvent::Intro> manpage.
22 37
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 38=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 39
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 40Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 41nowadays. So what is different about AnyEvent?
27 42
28Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 43Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29policy> and AnyEvent is I<small and efficient>. 44policy> and AnyEvent is I<small and efficient>.
30 45
31First and foremost, I<AnyEvent is not an event model> itself, it only 46First 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 47interfaces to whatever event model the main program happens to use, in a
33pragmatic way. For event models and certain classes of immortals alike, 48pragmatic way. For event models and certain classes of immortals alike,
34the statement "there can only be one" is a bitter reality: In general, 49the 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 50only one event loop can be active at the same time in a process. AnyEvent
36helps hiding the differences between those event loops. 51cannot change this, but it can hide the differences between those event
52loops.
37 53
38The goal of AnyEvent is to offer module authors the ability to do event 54The 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 55programming (waiting for I/O or timer events) without subscribing to a
40religion, a way of living, and most importantly: without forcing your 56religion, a way of living, and most importantly: without forcing your
41module users into the same thing by forcing them to use the same event 57module users into the same thing by forcing them to use the same event
42model you use. 58model you use.
43 59
44For modules like POE or IO::Async (which is a total misnomer as it is 60For 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 61actually 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 62like 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 63cannot use anything else, as they are simply incompatible to everything
48isn't itself. What's worse, all the potential users of your module are 64that isn't them. What's worse, all the potential users of your
49I<also> forced to use the same event loop you use. 65module are I<also> forced to use the same event loop you use.
50 66
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 67AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. AnyEvent + Tk works fine etc. etc. but none of these work together 68fine. 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 69with 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, 70your 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 71too. But if your module uses AnyEvent, it works transparently with all
56event models it supports (including stuff like POE and IO::Async, as long 72event 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 73use one of the supported event loops. It is trivial to add new event loops
58event loops to AnyEvent, too, so it is future-proof). 74to AnyEvent, too, so it is future-proof).
59 75
60In addition to being free of having to use I<the one and only true event 76In 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 77model>, AnyEvent also is free of bloat and policy: with POE or similar
62modules, you get an enourmous amount of code and strict rules you have to 78modules, 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 79follow. 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 80offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 81technically possible.
66 82
83Of course, AnyEvent comes with a big (and fully optional!) toolbox
84of useful functionality, such as an asynchronous DNS resolver, 100%
85non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
86such as Windows) and lots of real-world knowledge and workarounds for
87platform bugs and differences.
88
67Of course, if you want lots of policy (this can arguably be somewhat 89Now, 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 90useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 91model, you should I<not> use this module.
70 92
71=head1 DESCRIPTION 93=head1 DESCRIPTION
72 94
78The interface itself is vaguely similar, but not identical to the L<Event> 100The interface itself is vaguely similar, but not identical to the L<Event>
79module. 101module.
80 102
81During the first call of any watcher-creation method, the module tries 103During the first call of any watcher-creation method, the module tries
82to detect the currently loaded event loop by probing whether one of the 104to detect the currently loaded event loop by probing whether one of the
83following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, 105following modules is already loaded: L<EV>,
84L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 106L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
85L<POE>. The first one found is used. If none are found, the module tries 107L<POE>. The first one found is used. If none are found, the module tries
86to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl 108to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
87adaptor should always succeed) in the order given. The first one that can 109adaptor should always succeed) in the order given. The first one that can
88be successfully loaded will be used. If, after this, still none could be 110be successfully loaded will be used. If, after this, still none could be
102starts using it, all bets are off. Maybe you should tell their authors to 124starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly... 125use AnyEvent so their modules work together with others seamlessly...
104 126
105The pure-perl implementation of AnyEvent is called 127The pure-perl implementation of AnyEvent is called
106C<AnyEvent::Impl::Perl>. Like other event modules you can load it 128C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107explicitly. 129explicitly and enjoy the high availability of that event loop :)
108 130
109=head1 WATCHERS 131=head1 WATCHERS
110 132
111AnyEvent has the central concept of a I<watcher>, which is an object that 133AnyEvent 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 134stores relevant data for each kind of event you are waiting for, such as
113the callback to call, the filehandle to watch, etc. 135the callback to call, the file handle to watch, etc.
114 136
115These watchers are normal Perl objects with normal Perl lifetime. After 137These watchers are normal Perl objects with normal Perl lifetime. After
116creating a watcher it will immediately "watch" for events and invoke the 138creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model 139callback when the event occurs (of course, only when the event model
118is in control). 140is in control).
126Many watchers either are used with "recursion" (repeating timers for 148Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways. 149example), or need to refer to their watcher object in other ways.
128 150
129An any way to achieve that is this pattern: 151An any way to achieve that is this pattern:
130 152
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 153 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it 154 # you can use $w here, for example to undef it
133 undef $w; 155 undef $w;
134 }); 156 });
135 157
136Note that C<my $w; $w => combination. This is necessary because in Perl, 158Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are 159my variables are only visible after the statement in which they are
138declared. 160declared.
139 161
140=head2 I/O WATCHERS 162=head2 I/O WATCHERS
141 163
142You can create an I/O watcher by calling the C<< AnyEvent->io >> method 164You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143with the following mandatory key-value pairs as arguments: 165with the following mandatory key-value pairs as arguments:
144 166
145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 167C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
146for events. C<poll> must be a string that is either C<r> or C<w>, 168(AnyEvent might or might not keep a reference to this file handle). C<poll>
147which creates a watcher waiting for "r"eadable or "w"ritable events, 169must be a string that is either C<r> or C<w>, which creates a watcher
148respectively. C<cb> is the callback to invoke each time the file handle 170waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
149becomes ready. 171callback to invoke each time the file handle becomes ready.
150 172
151Although the callback might get passed parameters, their value and 173Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent 174presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks. 175callbacks cannot use arguments passed to I/O watcher callbacks.
154 176
158 180
159Some event loops issue spurious readyness notifications, so you should 181Some event loops issue spurious readyness notifications, so you should
160always use non-blocking calls when reading/writing from/to your file 182always use non-blocking calls when reading/writing from/to your file
161handles. 183handles.
162 184
163Example:
164
165 # wait for readability of STDIN, then read a line and disable the watcher 185Example: wait for readability of STDIN, then read a line and disable the
186watcher.
187
166 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 188 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167 chomp (my $input = <STDIN>); 189 chomp (my $input = <STDIN>);
168 warn "read: $input\n"; 190 warn "read: $input\n";
169 undef $w; 191 undef $w;
170 }); 192 });
180 202
181Although the callback might get passed parameters, their value and 203Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent 204presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks. 205callbacks cannot use arguments passed to time watcher callbacks.
184 206
185The timer callback will be invoked at most once: if you want a repeating 207The 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 208parameter, C<interval>, as a strictly positive number (> 0), then the
187and Glib). 209callback will be invoked regularly at that interval (in fractional
210seconds) after the first invocation. If C<interval> is specified with a
211false value, then it is treated as if it were missing.
188 212
189Example: 213The callback will be rescheduled before invoking the callback, but no
214attempt is done to avoid timer drift in most backends, so the interval is
215only approximate.
190 216
191 # fire an event after 7.7 seconds 217Example: fire an event after 7.7 seconds.
218
192 my $w = AnyEvent->timer (after => 7.7, cb => sub { 219 my $w = AnyEvent->timer (after => 7.7, cb => sub {
193 warn "timeout\n"; 220 warn "timeout\n";
194 }); 221 });
195 222
196 # to cancel the timer: 223 # to cancel the timer:
197 undef $w; 224 undef $w;
198 225
199Example 2:
200
201 # fire an event after 0.5 seconds, then roughly every second 226Example 2: fire an event after 0.5 seconds, then roughly every second.
202 my $w;
203 227
204 my $cb = sub {
205 # cancel the old timer while creating a new one
206 $w = AnyEvent->timer (after => 1, cb => $cb); 228 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
229 warn "timeout\n";
207 }; 230 };
208
209 # start the "loop" by creating the first watcher
210 $w = AnyEvent->timer (after => 0.5, cb => $cb);
211 231
212=head3 TIMING ISSUES 232=head3 TIMING ISSUES
213 233
214There are two ways to handle timers: based on real time (relative, "fire 234There are two ways to handle timers: based on real time (relative, "fire
215in 10 seconds") and based on wallclock time (absolute, "fire at 12 235in 10 seconds") and based on wallclock time (absolute, "fire at 12
227timers. 247timers.
228 248
229AnyEvent always prefers relative timers, if available, matching the 249AnyEvent always prefers relative timers, if available, matching the
230AnyEvent API. 250AnyEvent API.
231 251
252AnyEvent has two additional methods that return the "current time":
253
254=over 4
255
256=item AnyEvent->time
257
258This returns the "current wallclock time" as a fractional number of
259seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
260return, and the result is guaranteed to be compatible with those).
261
262It progresses independently of any event loop processing, i.e. each call
263will check the system clock, which usually gets updated frequently.
264
265=item AnyEvent->now
266
267This also returns the "current wallclock time", but unlike C<time>, above,
268this value might change only once per event loop iteration, depending on
269the event loop (most return the same time as C<time>, above). This is the
270time that AnyEvent's timers get scheduled against.
271
272I<In almost all cases (in all cases if you don't care), this is the
273function to call when you want to know the current time.>
274
275This function is also often faster then C<< AnyEvent->time >>, and
276thus the preferred method if you want some timestamp (for example,
277L<AnyEvent::Handle> uses this to update it's activity timeouts).
278
279The rest of this section is only of relevance if you try to be very exact
280with your timing, you can skip it without bad conscience.
281
282For a practical example of when these times differ, consider L<Event::Lib>
283and L<EV> and the following set-up:
284
285The event loop is running and has just invoked one of your callback at
286time=500 (assume no other callbacks delay processing). In your callback,
287you wait a second by executing C<sleep 1> (blocking the process for a
288second) and then (at time=501) you create a relative timer that fires
289after three seconds.
290
291With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
292both return C<501>, because that is the current time, and the timer will
293be scheduled to fire at time=504 (C<501> + C<3>).
294
295With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
296time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
297last event processing phase started. With L<EV>, your timer gets scheduled
298to run at time=503 (C<500> + C<3>).
299
300In one sense, L<Event::Lib> is more exact, as it uses the current time
301regardless of any delays introduced by event processing. However, most
302callbacks do not expect large delays in processing, so this causes a
303higher drift (and a lot more system calls to get the current time).
304
305In another sense, L<EV> is more exact, as your timer will be scheduled at
306the same time, regardless of how long event processing actually took.
307
308In either case, if you care (and in most cases, you don't), then you
309can get whatever behaviour you want with any event loop, by taking the
310difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
311account.
312
313=back
314
232=head2 SIGNAL WATCHERS 315=head2 SIGNAL WATCHERS
233 316
234You can watch for signals using a signal watcher, C<signal> is the signal 317You 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 318I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236be invoked whenever a signal occurs. 319callback to be invoked whenever a signal occurs.
237 320
238Although the callback might get passed parameters, their value and 321Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 322presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 323callbacks cannot use arguments passed to signal watcher callbacks.
241 324
242Multiple signal occurances can be clumped together into one callback 325Multiple signal occurrences can be clumped together into one callback
243invocation, and callback invocation will be synchronous. synchronous means 326invocation, and callback invocation will be synchronous. Synchronous means
244that it might take a while until the signal gets handled by the process, 327that it might take a while until the signal gets handled by the process,
245but it is guarenteed not to interrupt any other callbacks. 328but it is guaranteed not to interrupt any other callbacks.
246 329
247The main advantage of using these watchers is that you can share a signal 330The main advantage of using these watchers is that you can share a signal
248between multiple watchers. 331between multiple watchers.
249 332
250This watcher might use C<%SIG>, so programs overwriting those signals 333This watcher might use C<%SIG>, so programs overwriting those signals
277AnyEvent program, you I<have> to create at least one watcher before you 360AnyEvent program, you I<have> to create at least one watcher before you
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 361C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279 362
280Example: fork a process and wait for it 363Example: fork a process and wait for it
281 364
282 my $done = AnyEvent->condvar; 365 my $done = AnyEvent->condvar;
283 366
284 AnyEvent::detect; # force event module to be initialised
285
286 my $pid = fork or exit 5; 367 my $pid = fork or exit 5;
287 368
288 my $w = AnyEvent->child ( 369 my $w = AnyEvent->child (
289 pid => $pid, 370 pid => $pid,
290 cb => sub { 371 cb => sub {
291 my ($pid, $status) = @_; 372 my ($pid, $status) = @_;
292 warn "pid $pid exited with status $status"; 373 warn "pid $pid exited with status $status";
293 $done->broadcast; 374 $done->send;
294 }, 375 },
295 ); 376 );
296 377
297 # do something else, then wait for process exit 378 # do something else, then wait for process exit
298 $done->wait; 379 $done->recv;
299 380
300=head2 CONDITION VARIABLES 381=head2 CONDITION VARIABLES
301 382
383If you are familiar with some event loops you will know that all of them
384require you to run some blocking "loop", "run" or similar function that
385will actively watch for new events and call your callbacks.
386
387AnyEvent is different, it expects somebody else to run the event loop and
388will only block when necessary (usually when told by the user).
389
390The instrument to do that is called a "condition variable", so called
391because they represent a condition that must become true.
392
302Condition variables can be created by calling the C<< AnyEvent->condvar >> 393Condition variables can be created by calling the C<< AnyEvent->condvar
303method without any arguments.
304 394
305A condition variable waits for a condition - precisely that the C<< 395>> method, usually without arguments. The only argument pair allowed is
306->broadcast >> method has been called.
307 396
308They are very useful to signal that a condition has been fulfilled, for 397C<cb>, which specifies a callback to be called when the condition variable
398becomes true, with the condition variable as the first argument (but not
399the results).
400
401After creation, the condition variable is "false" until it becomes "true"
402by calling the C<send> method (or calling the condition variable as if it
403were a callback, read about the caveats in the description for the C<<
404->send >> method).
405
406Condition variables are similar to callbacks, except that you can
407optionally wait for them. They can also be called merge points - points
408in time where multiple outstanding events have been processed. And yet
409another way to call them is transactions - each condition variable can be
410used to represent a transaction, which finishes at some point and delivers
411a result.
412
413Condition variables are very useful to signal that something has finished,
309example, if you write a module that does asynchronous http requests, 414for example, if you write a module that does asynchronous http requests,
310then a condition variable would be the ideal candidate to signal the 415then a condition variable would be the ideal candidate to signal the
311availability of results. 416availability of results. The user can either act when the callback is
417called or can synchronously C<< ->recv >> for the results.
312 418
313You can also use condition variables to block your main program until 419You can also use them to simulate traditional event loops - for example,
314an event occurs - for example, you could C<< ->wait >> in your main 420you can block your main program until an event occurs - for example, you
315program until the user clicks the Quit button in your app, which would C<< 421could C<< ->recv >> in your main program until the user clicks the Quit
316->broadcast >> the "quit" event. 422button of your app, which would C<< ->send >> the "quit" event.
317 423
318Note that condition variables recurse into the event loop - if you have 424Note that condition variables recurse into the event loop - if you have
319two pirces of code that call C<< ->wait >> in a round-robbin fashion, you 425two pieces of code that call C<< ->recv >> in a round-robin fashion, you
320lose. Therefore, condition variables are good to export to your caller, but 426lose. Therefore, condition variables are good to export to your caller, but
321you should avoid making a blocking wait yourself, at least in callbacks, 427you should avoid making a blocking wait yourself, at least in callbacks,
322as this asks for trouble. 428as this asks for trouble.
323 429
324This object has two methods: 430Condition variables are represented by hash refs in perl, and the keys
431used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
432easy (it is often useful to build your own transaction class on top of
433AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
434it's C<new> method in your own C<new> method.
435
436There are two "sides" to a condition variable - the "producer side" which
437eventually calls C<< -> send >>, and the "consumer side", which waits
438for the send to occur.
439
440Example: wait for a timer.
441
442 # wait till the result is ready
443 my $result_ready = AnyEvent->condvar;
444
445 # do something such as adding a timer
446 # or socket watcher the calls $result_ready->send
447 # when the "result" is ready.
448 # in this case, we simply use a timer:
449 my $w = AnyEvent->timer (
450 after => 1,
451 cb => sub { $result_ready->send },
452 );
453
454 # this "blocks" (while handling events) till the callback
455 # calls send
456 $result_ready->recv;
457
458Example: wait for a timer, but take advantage of the fact that
459condition variables are also code references.
460
461 my $done = AnyEvent->condvar;
462 my $delay = AnyEvent->timer (after => 5, cb => $done);
463 $done->recv;
464
465Example: Imagine an API that returns a condvar and doesn't support
466callbacks. This is how you make a synchronous call, for example from
467the main program:
468
469 use AnyEvent::CouchDB;
470
471 ...
472
473 my @info = $couchdb->info->recv;
474
475And this is how you would just ste a callback to be called whenever the
476results are available:
477
478 $couchdb->info->cb (sub {
479 my @info = $_[0]->recv;
480 });
481
482=head3 METHODS FOR PRODUCERS
483
484These methods should only be used by the producing side, i.e. the
485code/module that eventually sends the signal. Note that it is also
486the producer side which creates the condvar in most cases, but it isn't
487uncommon for the consumer to create it as well.
325 488
326=over 4 489=over 4
327 490
491=item $cv->send (...)
492
493Flag the condition as ready - a running C<< ->recv >> and all further
494calls to C<recv> will (eventually) return after this method has been
495called. If nobody is waiting the send will be remembered.
496
497If a callback has been set on the condition variable, it is called
498immediately from within send.
499
500Any arguments passed to the C<send> call will be returned by all
501future C<< ->recv >> calls.
502
503Condition variables are overloaded so one can call them directly
504(as a code reference). Calling them directly is the same as calling
505C<send>. Note, however, that many C-based event loops do not handle
506overloading, so as tempting as it may be, passing a condition variable
507instead of a callback does not work. Both the pure perl and EV loops
508support overloading, however, as well as all functions that use perl to
509invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
510example).
511
512=item $cv->croak ($error)
513
514Similar to send, but causes all call's to C<< ->recv >> to invoke
515C<Carp::croak> with the given error message/object/scalar.
516
517This can be used to signal any errors to the condition variable
518user/consumer.
519
520=item $cv->begin ([group callback])
521
328=item $cv->wait 522=item $cv->end
329 523
330Wait (blocking if necessary) until the C<< ->broadcast >> method has been 524These two methods are EXPERIMENTAL and MIGHT CHANGE.
525
526These two methods can be used to combine many transactions/events into
527one. For example, a function that pings many hosts in parallel might want
528to use a condition variable for the whole process.
529
530Every call to C<< ->begin >> will increment a counter, and every call to
531C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
532>>, the (last) callback passed to C<begin> will be executed. That callback
533is I<supposed> to call C<< ->send >>, but that is not required. If no
534callback was set, C<send> will be called without any arguments.
535
536Let's clarify this with the ping example:
537
538 my $cv = AnyEvent->condvar;
539
540 my %result;
541 $cv->begin (sub { $cv->send (\%result) });
542
543 for my $host (@list_of_hosts) {
544 $cv->begin;
545 ping_host_then_call_callback $host, sub {
546 $result{$host} = ...;
547 $cv->end;
548 };
549 }
550
551 $cv->end;
552
553This code fragment supposedly pings a number of hosts and calls
554C<send> after results for all then have have been gathered - in any
555order. To achieve this, the code issues a call to C<begin> when it starts
556each ping request and calls C<end> when it has received some result for
557it. Since C<begin> and C<end> only maintain a counter, the order in which
558results arrive is not relevant.
559
560There is an additional bracketing call to C<begin> and C<end> outside the
561loop, which serves two important purposes: first, it sets the callback
562to be called once the counter reaches C<0>, and second, it ensures that
563C<send> is called even when C<no> hosts are being pinged (the loop
564doesn't execute once).
565
566This is the general pattern when you "fan out" into multiple subrequests:
567use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
568is called at least once, and then, for each subrequest you start, call
569C<begin> and for each subrequest you finish, call C<end>.
570
571=back
572
573=head3 METHODS FOR CONSUMERS
574
575These methods should only be used by the consuming side, i.e. the
576code awaits the condition.
577
578=over 4
579
580=item $cv->recv
581
582Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
331called on c<$cv>, while servicing other watchers normally. 583>> methods have been called on c<$cv>, while servicing other watchers
584normally.
332 585
333You can only wait once on a condition - additional calls will return 586You can only wait once on a condition - additional calls are valid but
334immediately. 587will return immediately.
588
589If an error condition has been set by calling C<< ->croak >>, then this
590function will call C<croak>.
591
592In list context, all parameters passed to C<send> will be returned,
593in scalar context only the first one will be returned.
335 594
336Not all event models support a blocking wait - some die in that case 595Not all event models support a blocking wait - some die in that case
337(programs might want to do that to stay interactive), so I<if you are 596(programs might want to do that to stay interactive), so I<if you are
338using this from a module, never require a blocking wait>, but let the 597using this from a module, never require a blocking wait>, but let the
339caller decide whether the call will block or not (for example, by coupling 598caller decide whether the call will block or not (for example, by coupling
340condition variables with some kind of request results and supporting 599condition variables with some kind of request results and supporting
341callbacks so the caller knows that getting the result will not block, 600callbacks so the caller knows that getting the result will not block,
342while still suppporting blocking waits if the caller so desires). 601while still supporting blocking waits if the caller so desires).
343 602
344Another reason I<never> to C<< ->wait >> in a module is that you cannot 603Another reason I<never> to C<< ->recv >> in a module is that you cannot
345sensibly have two C<< ->wait >>'s in parallel, as that would require 604sensibly have two C<< ->recv >>'s in parallel, as that would require
346multiple interpreters or coroutines/threads, none of which C<AnyEvent> 605multiple interpreters or coroutines/threads, none of which C<AnyEvent>
347can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and 606can supply.
348L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
349from different coroutines, however).
350 607
351=item $cv->broadcast 608The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
609fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
610versions and also integrates coroutines into AnyEvent, making blocking
611C<< ->recv >> calls perfectly safe as long as they are done from another
612coroutine (one that doesn't run the event loop).
352 613
353Flag the condition as ready - a running C<< ->wait >> and all further 614You can ensure that C<< -recv >> never blocks by setting a callback and
354calls to C<wait> will (eventually) return after this method has been 615only calling C<< ->recv >> from within that callback (or at a later
355called. If nobody is waiting the broadcast will be remembered.. 616time). This will work even when the event loop does not support blocking
617waits otherwise.
618
619=item $bool = $cv->ready
620
621Returns true when the condition is "true", i.e. whether C<send> or
622C<croak> have been called.
623
624=item $cb = $cv->cb ($cb->($cv))
625
626This is a mutator function that returns the callback set and optionally
627replaces it before doing so.
628
629The callback will be called when the condition becomes "true", i.e. when
630C<send> or C<croak> are called, with the only argument being the condition
631variable itself. Calling C<recv> inside the callback or at any later time
632is guaranteed not to block.
356 633
357=back 634=back
358
359Example:
360
361 # wait till the result is ready
362 my $result_ready = AnyEvent->condvar;
363
364 # do something such as adding a timer
365 # or socket watcher the calls $result_ready->broadcast
366 # when the "result" is ready.
367 # in this case, we simply use a timer:
368 my $w = AnyEvent->timer (
369 after => 1,
370 cb => sub { $result_ready->broadcast },
371 );
372
373 # this "blocks" (while handling events) till the watcher
374 # calls broadcast
375 $result_ready->wait;
376 635
377=head1 GLOBAL VARIABLES AND FUNCTIONS 636=head1 GLOBAL VARIABLES AND FUNCTIONS
378 637
379=over 4 638=over 4
380 639
386C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 645C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
387AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 646AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
388 647
389The known classes so far are: 648The known classes so far are:
390 649
391 AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
392 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
393 AnyEvent::Impl::EV based on EV (an interface to libev, best choice). 650 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
394 AnyEvent::Impl::Event based on Event, second best choice. 651 AnyEvent::Impl::Event based on Event, second best choice.
395 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 652 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
396 AnyEvent::Impl::Glib based on Glib, third-best choice. 653 AnyEvent::Impl::Glib based on Glib, third-best choice.
397 AnyEvent::Impl::Tk based on Tk, very bad choice. 654 AnyEvent::Impl::Tk based on Tk, very bad choice.
414Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 671Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
415if necessary. You should only call this function right before you would 672if necessary. You should only call this function right before you would
416have created an AnyEvent watcher anyway, that is, as late as possible at 673have created an AnyEvent watcher anyway, that is, as late as possible at
417runtime. 674runtime.
418 675
676=item $guard = AnyEvent::post_detect { BLOCK }
677
678Arranges for the code block to be executed as soon as the event model is
679autodetected (or immediately if this has already happened).
680
681If called in scalar or list context, then it creates and returns an object
682that automatically removes the callback again when it is destroyed. See
683L<Coro::BDB> for a case where this is useful.
684
685=item @AnyEvent::post_detect
686
687If there are any code references in this array (you can C<push> to it
688before or after loading AnyEvent), then they will called directly after
689the event loop has been chosen.
690
691You should check C<$AnyEvent::MODEL> before adding to this array, though:
692if it contains a true value then the event loop has already been detected,
693and the array will be ignored.
694
695Best use C<AnyEvent::post_detect { BLOCK }> instead.
696
419=back 697=back
420 698
421=head1 WHAT TO DO IN A MODULE 699=head1 WHAT TO DO IN A MODULE
422 700
423As a module author, you should C<use AnyEvent> and call AnyEvent methods 701As a module author, you should C<use AnyEvent> and call AnyEvent methods
426Be careful when you create watchers in the module body - AnyEvent will 704Be careful when you create watchers in the module body - AnyEvent will
427decide which event module to use as soon as the first method is called, so 705decide which event module to use as soon as the first method is called, so
428by calling AnyEvent in your module body you force the user of your module 706by calling AnyEvent in your module body you force the user of your module
429to load the event module first. 707to load the event module first.
430 708
431Never call C<< ->wait >> on a condition variable unless you I<know> that 709Never call C<< ->recv >> on a condition variable unless you I<know> that
432the C<< ->broadcast >> method has been called on it already. This is 710the C<< ->send >> method has been called on it already. This is
433because it will stall the whole program, and the whole point of using 711because it will stall the whole program, and the whole point of using
434events is to stay interactive. 712events is to stay interactive.
435 713
436It is fine, however, to call C<< ->wait >> when the user of your module 714It is fine, however, to call C<< ->recv >> when the user of your module
437requests it (i.e. if you create a http request object ad have a method 715requests it (i.e. if you create a http request object ad have a method
438called C<results> that returns the results, it should call C<< ->wait >> 716called C<results> that returns the results, it should call C<< ->recv >>
439freely, as the user of your module knows what she is doing. always). 717freely, as the user of your module knows what she is doing. always).
440 718
441=head1 WHAT TO DO IN THE MAIN PROGRAM 719=head1 WHAT TO DO IN THE MAIN PROGRAM
442 720
443There will always be a single main program - the only place that should 721There will always be a single main program - the only place that should
445 723
446If it doesn't care, it can just "use AnyEvent" and use it itself, or not 724If it doesn't care, it can just "use AnyEvent" and use it itself, or not
447do anything special (it does not need to be event-based) and let AnyEvent 725do anything special (it does not need to be event-based) and let AnyEvent
448decide which implementation to chose if some module relies on it. 726decide which implementation to chose if some module relies on it.
449 727
450If the main program relies on a specific event model. For example, in 728If the main program relies on a specific event model - for example, in
451Gtk2 programs you have to rely on the Glib module. You should load the 729Gtk2 programs you have to rely on the Glib module - you should load the
452event module before loading AnyEvent or any module that uses it: generally 730event module before loading AnyEvent or any module that uses it: generally
453speaking, you should load it as early as possible. The reason is that 731speaking, you should load it as early as possible. The reason is that
454modules might create watchers when they are loaded, and AnyEvent will 732modules might create watchers when they are loaded, and AnyEvent will
455decide on the event model to use as soon as it creates watchers, and it 733decide on the event model to use as soon as it creates watchers, and it
456might chose the wrong one unless you load the correct one yourself. 734might chose the wrong one unless you load the correct one yourself.
457 735
458You can chose to use a rather inefficient pure-perl implementation by 736You can chose to use a pure-perl implementation by loading the
459loading the C<AnyEvent::Impl::Perl> module, which gives you similar 737C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
460behaviour everywhere, but letting AnyEvent chose is generally better. 738everywhere, but letting AnyEvent chose the model is generally better.
739
740=head2 MAINLOOP EMULATION
741
742Sometimes (often for short test scripts, or even standalone programs who
743only want to use AnyEvent), you do not want to run a specific event loop.
744
745In that case, you can use a condition variable like this:
746
747 AnyEvent->condvar->recv;
748
749This has the effect of entering the event loop and looping forever.
750
751Note that usually your program has some exit condition, in which case
752it is better to use the "traditional" approach of storing a condition
753variable somewhere, waiting for it, and sending it when the program should
754exit cleanly.
755
461 756
462=head1 OTHER MODULES 757=head1 OTHER MODULES
463 758
464The following is a non-exhaustive list of additional modules that use 759The following is a non-exhaustive list of additional modules that use
465AnyEvent and can therefore be mixed easily with other AnyEvent modules 760AnyEvent and can therefore be mixed easily with other AnyEvent modules
471=item L<AnyEvent::Util> 766=item L<AnyEvent::Util>
472 767
473Contains various utility functions that replace often-used but blocking 768Contains various utility functions that replace often-used but blocking
474functions such as C<inet_aton> by event-/callback-based versions. 769functions such as C<inet_aton> by event-/callback-based versions.
475 770
771=item L<AnyEvent::Socket>
772
773Provides various utility functions for (internet protocol) sockets,
774addresses and name resolution. Also functions to create non-blocking tcp
775connections or tcp servers, with IPv6 and SRV record support and more.
776
476=item L<AnyEvent::Handle> 777=item L<AnyEvent::Handle>
477 778
478Provide read and write buffers and manages watchers for reads and writes. 779Provide read and write buffers, manages watchers for reads and writes,
780supports raw and formatted I/O, I/O queued and fully transparent and
781non-blocking SSL/TLS.
479 782
480=item L<AnyEvent::Socket> 783=item L<AnyEvent::DNS>
481 784
482Provides a means to do non-blocking connects, accepts etc. 785Provides rich asynchronous DNS resolver capabilities.
786
787=item L<AnyEvent::HTTP>
788
789A simple-to-use HTTP library that is capable of making a lot of concurrent
790HTTP requests.
483 791
484=item L<AnyEvent::HTTPD> 792=item L<AnyEvent::HTTPD>
485 793
486Provides a simple web application server framework. 794Provides a simple web application server framework.
487 795
488=item L<AnyEvent::DNS>
489
490Provides asynchronous DNS resolver capabilities, beyond what
491L<AnyEvent::Util> offers.
492
493=item L<AnyEvent::FastPing> 796=item L<AnyEvent::FastPing>
494 797
495The fastest ping in the west. 798The fastest ping in the west.
799
800=item L<AnyEvent::DBI>
801
802Executes L<DBI> requests asynchronously in a proxy process.
803
804=item L<AnyEvent::AIO>
805
806Truly asynchronous I/O, should be in the toolbox of every event
807programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
808together.
809
810=item L<AnyEvent::BDB>
811
812Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
813L<BDB> and AnyEvent together.
814
815=item L<AnyEvent::GPSD>
816
817A non-blocking interface to gpsd, a daemon delivering GPS information.
818
819=item L<AnyEvent::IGS>
820
821A non-blocking interface to the Internet Go Server protocol (used by
822L<App::IGS>).
496 823
497=item L<Net::IRC3> 824=item L<Net::IRC3>
498 825
499AnyEvent based IRC client module family. 826AnyEvent based IRC client module family.
500 827
511 838
512High level API for event-based execution flow control. 839High level API for event-based execution flow control.
513 840
514=item L<Coro> 841=item L<Coro>
515 842
516Has special support for AnyEvent. 843Has special support for AnyEvent via L<Coro::AnyEvent>.
517 844
518=item L<IO::Lambda> 845=item L<IO::Lambda>
519 846
520The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 847The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
521
522=item L<IO::AIO>
523
524Truly asynchronous I/O, should be in the toolbox of every event
525programmer. Can be trivially made to use AnyEvent.
526
527=item L<BDB>
528
529Truly asynchronous Berkeley DB access. Can be trivially made to use
530AnyEvent.
531 848
532=back 849=back
533 850
534=cut 851=cut
535 852
538no warnings; 855no warnings;
539use strict; 856use strict;
540 857
541use Carp; 858use Carp;
542 859
543our $VERSION = '3.3'; 860our $VERSION = 4.22;
544our $MODEL; 861our $MODEL;
545 862
546our $AUTOLOAD; 863our $AUTOLOAD;
547our @ISA; 864our @ISA;
548 865
866our @REGISTRY;
867
868our $WIN32;
869
870BEGIN {
871 my $win32 = ! ! ($^O =~ /mswin32/i);
872 eval "sub WIN32(){ $win32 }";
873}
874
549our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 875our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
550 876
551our @REGISTRY; 877our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
878
879{
880 my $idx;
881 $PROTOCOL{$_} = ++$idx
882 for reverse split /\s*,\s*/,
883 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
884}
552 885
553my @models = ( 886my @models = (
554 [Coro::EV:: => AnyEvent::Impl::CoroEV::],
555 [Coro::Event:: => AnyEvent::Impl::CoroEvent::],
556 [EV:: => AnyEvent::Impl::EV::], 887 [EV:: => AnyEvent::Impl::EV::],
557 [Event:: => AnyEvent::Impl::Event::], 888 [Event:: => AnyEvent::Impl::Event::],
558 [Tk:: => AnyEvent::Impl::Tk::],
559 [Wx:: => AnyEvent::Impl::POE::],
560 [Prima:: => AnyEvent::Impl::POE::],
561 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 889 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
562 # everything below here will not be autoprobed as the pureperl backend should work everywhere 890 # everything below here will not be autoprobed
563 [Glib:: => AnyEvent::Impl::Glib::], 891 # as the pureperl backend should work everywhere
892 # and is usually faster
893 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
894 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
564 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 895 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
565 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 896 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
566 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 897 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
898 [Wx:: => AnyEvent::Impl::POE::],
899 [Prima:: => AnyEvent::Impl::POE::],
567); 900);
568 901
569our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); 902our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
903
904our @post_detect;
905
906sub post_detect(&) {
907 my ($cb) = @_;
908
909 if ($MODEL) {
910 $cb->();
911
912 1
913 } else {
914 push @post_detect, $cb;
915
916 defined wantarray
917 ? bless \$cb, "AnyEvent::Util::PostDetect"
918 : ()
919 }
920}
921
922sub AnyEvent::Util::PostDetect::DESTROY {
923 @post_detect = grep $_ != ${$_[0]}, @post_detect;
924}
570 925
571sub detect() { 926sub detect() {
572 unless ($MODEL) { 927 unless ($MODEL) {
573 no strict 'refs'; 928 no strict 'refs';
929 local $SIG{__DIE__};
574 930
575 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 931 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
576 my $model = "AnyEvent::Impl::$1"; 932 my $model = "AnyEvent::Impl::$1";
577 if (eval "require $model") { 933 if (eval "require $model") {
578 $MODEL = $model; 934 $MODEL = $model;
608 last; 964 last;
609 } 965 }
610 } 966 }
611 967
612 $MODEL 968 $MODEL
613 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib."; 969 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
614 } 970 }
615 } 971 }
616 972
973 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
974
617 unshift @ISA, $MODEL; 975 unshift @ISA, $MODEL;
618 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 976
977 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
978
979 (shift @post_detect)->() while @post_detect;
619 } 980 }
620 981
621 $MODEL 982 $MODEL
622} 983}
623 984
631 992
632 my $class = shift; 993 my $class = shift;
633 $class->$func (@_); 994 $class->$func (@_);
634} 995}
635 996
997# utility function to dup a filehandle. this is used by many backends
998# to support binding more than one watcher per filehandle (they usually
999# allow only one watcher per fd, so we dup it to get a different one).
1000sub _dupfh($$$$) {
1001 my ($poll, $fh, $r, $w) = @_;
1002
1003 require Fcntl;
1004
1005 # cygwin requires the fh mode to be matching, unix doesn't
1006 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1007 : $poll eq "w" ? ($w, ">")
1008 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1009
1010 open my $fh2, "$mode&" . fileno $fh
1011 or die "cannot dup() filehandle: $!";
1012
1013 # we assume CLOEXEC is already set by perl in all important cases
1014
1015 ($fh2, $rw)
1016}
1017
636package AnyEvent::Base; 1018package AnyEvent::Base;
637 1019
1020# default implementation for now and time
1021
1022use Time::HiRes ();
1023
1024sub time { Time::HiRes::time }
1025sub now { Time::HiRes::time }
1026
638# default implementation for ->condvar, ->wait, ->broadcast 1027# default implementation for ->condvar
639 1028
640sub condvar { 1029sub condvar {
641 bless \my $flag, "AnyEvent::Base::CondVar" 1030 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
642}
643
644sub AnyEvent::Base::CondVar::broadcast {
645 ${$_[0]}++;
646}
647
648sub AnyEvent::Base::CondVar::wait {
649 AnyEvent->one_event while !${$_[0]};
650} 1031}
651 1032
652# default implementation for ->signal 1033# default implementation for ->signal
653 1034
654our %SIG_CB; 1035our %SIG_CB;
670sub AnyEvent::Base::Signal::DESTROY { 1051sub AnyEvent::Base::Signal::DESTROY {
671 my ($signal, $cb) = @{$_[0]}; 1052 my ($signal, $cb) = @{$_[0]};
672 1053
673 delete $SIG_CB{$signal}{$cb}; 1054 delete $SIG_CB{$signal}{$cb};
674 1055
675 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1056 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
676} 1057}
677 1058
678# default implementation for ->child 1059# default implementation for ->child
679 1060
680our %PID_CB; 1061our %PID_CB;
707 or Carp::croak "required option 'pid' is missing"; 1088 or Carp::croak "required option 'pid' is missing";
708 1089
709 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1090 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
710 1091
711 unless ($WNOHANG) { 1092 unless ($WNOHANG) {
712 $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; 1093 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
713 } 1094 }
714 1095
715 unless ($CHLD_W) { 1096 unless ($CHLD_W) {
716 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1097 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
717 # child could be a zombie already, so make at least one round 1098 # child could be a zombie already, so make at least one round
727 delete $PID_CB{$pid}{$cb}; 1108 delete $PID_CB{$pid}{$cb};
728 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1109 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
729 1110
730 undef $CHLD_W unless keys %PID_CB; 1111 undef $CHLD_W unless keys %PID_CB;
731} 1112}
1113
1114package AnyEvent::CondVar;
1115
1116our @ISA = AnyEvent::CondVar::Base::;
1117
1118package AnyEvent::CondVar::Base;
1119
1120use overload
1121 '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1122 fallback => 1;
1123
1124sub _send {
1125 # nop
1126}
1127
1128sub send {
1129 my $cv = shift;
1130 $cv->{_ae_sent} = [@_];
1131 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1132 $cv->_send;
1133}
1134
1135sub croak {
1136 $_[0]{_ae_croak} = $_[1];
1137 $_[0]->send;
1138}
1139
1140sub ready {
1141 $_[0]{_ae_sent}
1142}
1143
1144sub _wait {
1145 AnyEvent->one_event while !$_[0]{_ae_sent};
1146}
1147
1148sub recv {
1149 $_[0]->_wait;
1150
1151 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1152 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1153}
1154
1155sub cb {
1156 $_[0]{_ae_cb} = $_[1] if @_ > 1;
1157 $_[0]{_ae_cb}
1158}
1159
1160sub begin {
1161 ++$_[0]{_ae_counter};
1162 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1163}
1164
1165sub end {
1166 return if --$_[0]{_ae_counter};
1167 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1168}
1169
1170# undocumented/compatibility with pre-3.4
1171*broadcast = \&send;
1172*wait = \&_wait;
732 1173
733=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1174=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
734 1175
735This is an advanced topic that you do not normally need to use AnyEvent in 1176This is an advanced topic that you do not normally need to use AnyEvent in
736a module. This section is only of use to event loop authors who want to 1177a module. This section is only of use to event loop authors who want to
790C<PERL_ANYEVENT_MODEL>. 1231C<PERL_ANYEVENT_MODEL>.
791 1232
792When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1233When set to C<2> or higher, cause AnyEvent to report to STDERR which event
793model it chooses. 1234model it chooses.
794 1235
1236=item C<PERL_ANYEVENT_STRICT>
1237
1238AnyEvent does not do much argument checking by default, as thorough
1239argument checking is very costly. Setting this variable to a true value
1240will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1241check the arguments passed to most method calls. If it finds any problems
1242it will croak.
1243
1244In other words, enables "strict" mode.
1245
1246Unlike C<use strict> it is definitely recommended ot keep it off in
1247production.
1248
795=item C<PERL_ANYEVENT_MODEL> 1249=item C<PERL_ANYEVENT_MODEL>
796 1250
797This can be used to specify the event model to be used by AnyEvent, before 1251This can be used to specify the event model to be used by AnyEvent, before
798autodetection and -probing kicks in. It must be a string consisting 1252auto detection and -probing kicks in. It must be a string consisting
799entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1253entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
800and the resulting module name is loaded and if the load was successful, 1254and the resulting module name is loaded and if the load was successful,
801used as event model. If it fails to load AnyEvent will proceed with 1255used as event model. If it fails to load AnyEvent will proceed with
802autodetection and -probing. 1256auto detection and -probing.
803 1257
804This functionality might change in future versions. 1258This functionality might change in future versions.
805 1259
806For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1260For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
807could start your program like this: 1261could start your program like this:
808 1262
809 PERL_ANYEVENT_MODEL=Perl perl ... 1263 PERL_ANYEVENT_MODEL=Perl perl ...
1264
1265=item C<PERL_ANYEVENT_PROTOCOLS>
1266
1267Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1268for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1269of auto probing).
1270
1271Must be set to a comma-separated list of protocols or address families,
1272current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1273used, and preference will be given to protocols mentioned earlier in the
1274list.
1275
1276This variable can effectively be used for denial-of-service attacks
1277against local programs (e.g. when setuid), although the impact is likely
1278small, as the program has to handle connection errors already-
1279
1280Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1281but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1282- only support IPv4, never try to resolve or contact IPv6
1283addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1284IPv6, but prefer IPv6 over IPv4.
1285
1286=item C<PERL_ANYEVENT_EDNS0>
1287
1288Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1289for DNS. This extension is generally useful to reduce DNS traffic, but
1290some (broken) firewalls drop such DNS packets, which is why it is off by
1291default.
1292
1293Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1294EDNS0 in its DNS requests.
1295
1296=item C<PERL_ANYEVENT_MAX_FORKS>
1297
1298The maximum number of child processes that C<AnyEvent::Util::fork_call>
1299will create in parallel.
810 1300
811=back 1301=back
812 1302
813=head1 EXAMPLE PROGRAM 1303=head1 EXAMPLE PROGRAM
814 1304
825 poll => 'r', 1315 poll => 'r',
826 cb => sub { 1316 cb => sub {
827 warn "io event <$_[0]>\n"; # will always output <r> 1317 warn "io event <$_[0]>\n"; # will always output <r>
828 chomp (my $input = <STDIN>); # read a line 1318 chomp (my $input = <STDIN>); # read a line
829 warn "read: $input\n"; # output what has been read 1319 warn "read: $input\n"; # output what has been read
830 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i 1320 $cv->send if $input =~ /^q/i; # quit program if /^q/i
831 }, 1321 },
832 ); 1322 );
833 1323
834 my $time_watcher; # can only be used once 1324 my $time_watcher; # can only be used once
835 1325
840 }); 1330 });
841 } 1331 }
842 1332
843 new_timer; # create first timer 1333 new_timer; # create first timer
844 1334
845 $cv->wait; # wait until user enters /^q/i 1335 $cv->recv; # wait until user enters /^q/i
846 1336
847=head1 REAL-WORLD EXAMPLE 1337=head1 REAL-WORLD EXAMPLE
848 1338
849Consider the L<Net::FCP> module. It features (among others) the following 1339Consider the L<Net::FCP> module. It features (among others) the following
850API calls, which are to freenet what HTTP GET requests are to http: 1340API calls, which are to freenet what HTTP GET requests are to http:
900 syswrite $txn->{fh}, $txn->{request} 1390 syswrite $txn->{fh}, $txn->{request}
901 or die "connection or write error"; 1391 or die "connection or write error";
902 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); 1392 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
903 1393
904Again, C<fh_ready_r> waits till all data has arrived, and then stores the 1394Again, C<fh_ready_r> waits till all data has arrived, and then stores the
905result and signals any possible waiters that the request ahs finished: 1395result and signals any possible waiters that the request has finished:
906 1396
907 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; 1397 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
908 1398
909 if (end-of-file or data complete) { 1399 if (end-of-file or data complete) {
910 $txn->{result} = $txn->{buf}; 1400 $txn->{result} = $txn->{buf};
911 $txn->{finished}->broadcast; 1401 $txn->{finished}->send;
912 $txb->{cb}->($txn) of $txn->{cb}; # also call callback 1402 $txb->{cb}->($txn) of $txn->{cb}; # also call callback
913 } 1403 }
914 1404
915The C<result> method, finally, just waits for the finished signal (if the 1405The C<result> method, finally, just waits for the finished signal (if the
916request was already finished, it doesn't wait, of course, and returns the 1406request was already finished, it doesn't wait, of course, and returns the
917data: 1407data:
918 1408
919 $txn->{finished}->wait; 1409 $txn->{finished}->recv;
920 return $txn->{result}; 1410 return $txn->{result};
921 1411
922The actual code goes further and collects all errors (C<die>s, exceptions) 1412The actual code goes further and collects all errors (C<die>s, exceptions)
923that occured during request processing. The C<result> method detects 1413that occurred during request processing. The C<result> method detects
924whether an exception as thrown (it is stored inside the $txn object) 1414whether an exception as thrown (it is stored inside the $txn object)
925and just throws the exception, which means connection errors and other 1415and just throws the exception, which means connection errors and other
926problems get reported tot he code that tries to use the result, not in a 1416problems get reported tot he code that tries to use the result, not in a
927random callback. 1417random callback.
928 1418
959 1449
960 my $quit = AnyEvent->condvar; 1450 my $quit = AnyEvent->condvar;
961 1451
962 $fcp->txn_client_get ($url)->cb (sub { 1452 $fcp->txn_client_get ($url)->cb (sub {
963 ... 1453 ...
964 $quit->broadcast; 1454 $quit->send;
965 }); 1455 });
966 1456
967 $quit->wait; 1457 $quit->recv;
968 1458
969 1459
970=head1 BENCHMARKS 1460=head1 BENCHMARKS
971 1461
972To give you an idea of the performance and overheads that AnyEvent adds 1462To give you an idea of the performance and overheads that AnyEvent adds
974of various event loops I prepared some benchmarks. 1464of various event loops I prepared some benchmarks.
975 1465
976=head2 BENCHMARKING ANYEVENT OVERHEAD 1466=head2 BENCHMARKING ANYEVENT OVERHEAD
977 1467
978Here is a benchmark of various supported event models used natively and 1468Here is a benchmark of various supported event models used natively and
979through anyevent. The benchmark creates a lot of timers (with a zero 1469through AnyEvent. The benchmark creates a lot of timers (with a zero
980timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1470timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
981which it is), lets them fire exactly once and destroys them again. 1471which it is), lets them fire exactly once and destroys them again.
982 1472
983Source code for this benchmark is found as F<eg/bench> in the AnyEvent 1473Source code for this benchmark is found as F<eg/bench> in the AnyEvent
984distribution. 1474distribution.
1001all watchers, to avoid adding memory overhead. That means closure creation 1491all watchers, to avoid adding memory overhead. That means closure creation
1002and memory usage is not included in the figures. 1492and memory usage is not included in the figures.
1003 1493
1004I<invoke> is the time, in microseconds, used to invoke a simple 1494I<invoke> is the time, in microseconds, used to invoke a simple
1005callback. The callback simply counts down a Perl variable and after it was 1495callback. The callback simply counts down a Perl variable and after it was
1006invoked "watcher" times, it would C<< ->broadcast >> a condvar once to 1496invoked "watcher" times, it would C<< ->send >> a condvar once to
1007signal the end of this phase. 1497signal the end of this phase.
1008 1498
1009I<destroy> is the time, in microseconds, that it takes to destroy a single 1499I<destroy> is the time, in microseconds, that it takes to destroy a single
1010watcher. 1500watcher.
1011 1501
1107 1597
1108=back 1598=back
1109 1599
1110=head2 BENCHMARKING THE LARGE SERVER CASE 1600=head2 BENCHMARKING THE LARGE SERVER CASE
1111 1601
1112This benchmark atcually benchmarks the event loop itself. It works by 1602This benchmark actually benchmarks the event loop itself. It works by
1113creating a number of "servers": each server consists of a socketpair, a 1603creating a number of "servers": each server consists of a socket pair, a
1114timeout watcher that gets reset on activity (but never fires), and an I/O 1604timeout watcher that gets reset on activity (but never fires), and an I/O
1115watcher waiting for input on one side of the socket. Each time the socket 1605watcher waiting for input on one side of the socket. Each time the socket
1116watcher reads a byte it will write that byte to a random other "server". 1606watcher reads a byte it will write that byte to a random other "server".
1117 1607
1118The effect is that there will be a lot of I/O watchers, only part of which 1608The effect is that there will be a lot of I/O watchers, only part of which
1119are active at any one point (so there is a constant number of active 1609are active at any one point (so there is a constant number of active
1120fds for each loop iterstaion, but which fds these are is random). The 1610fds for each loop iteration, but which fds these are is random). The
1121timeout is reset each time something is read because that reflects how 1611timeout is reset each time something is read because that reflects how
1122most timeouts work (and puts extra pressure on the event loops). 1612most timeouts work (and puts extra pressure on the event loops).
1123 1613
1124In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 1614In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1125(1%) are active. This mirrors the activity of large servers with many 1615(1%) are active. This mirrors the activity of large servers with many
1126connections, most of which are idle at any one point in time. 1616connections, most of which are idle at any one point in time.
1127 1617
1128Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 1618Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1129distribution. 1619distribution.
1131=head3 Explanation of the columns 1621=head3 Explanation of the columns
1132 1622
1133I<sockets> is the number of sockets, and twice the number of "servers" (as 1623I<sockets> is the number of sockets, and twice the number of "servers" (as
1134each server has a read and write socket end). 1624each server has a read and write socket end).
1135 1625
1136I<create> is the time it takes to create a socketpair (which is 1626I<create> is the time it takes to create a socket pair (which is
1137nontrivial) and two watchers: an I/O watcher and a timeout watcher. 1627nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1138 1628
1139I<request>, the most important value, is the time it takes to handle a 1629I<request>, the most important value, is the time it takes to handle a
1140single "request", that is, reading the token from the pipe and forwarding 1630single "request", that is, reading the token from the pipe and forwarding
1141it to another server. This includes deleting the old timeout and creating 1631it to another server. This includes deleting the old timeout and creating
1214speed most when you have lots of watchers, not when you only have a few of 1704speed most when you have lots of watchers, not when you only have a few of
1215them). 1705them).
1216 1706
1217EV is again fastest. 1707EV is again fastest.
1218 1708
1219Perl again comes second. It is noticably faster than the C-based event 1709Perl again comes second. It is noticeably faster than the C-based event
1220loops Event and Glib, although the difference is too small to really 1710loops Event and Glib, although the difference is too small to really
1221matter. 1711matter.
1222 1712
1223POE also performs much better in this case, but is is still far behind the 1713POE also performs much better in this case, but is is still far behind the
1224others. 1714others.
1253specified in the variable. 1743specified in the variable.
1254 1744
1255You can make AnyEvent completely ignore this variable by deleting it 1745You can make AnyEvent completely ignore this variable by deleting it
1256before the first watcher gets created, e.g. with a C<BEGIN> block: 1746before the first watcher gets created, e.g. with a C<BEGIN> block:
1257 1747
1258 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1748 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1259 1749
1260 use AnyEvent; 1750 use AnyEvent;
1751
1752Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1753be used to probe what backend is used and gain other information (which is
1754probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1755$ENV{PERL_ANYEGENT_STRICT}.
1756
1757
1758=head1 BUGS
1759
1760Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1761to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1762and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1763mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1764pronounced).
1261 1765
1262 1766
1263=head1 SEE ALSO 1767=head1 SEE ALSO
1264 1768
1265Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, 1769Utility functions: L<AnyEvent::Util>.
1266L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, 1770
1771Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1267L<Event::Lib>, L<Qt>, L<POE>. 1772L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1268 1773
1269Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, 1774Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1270L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, 1775L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1271L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, 1776L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1272L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. 1777L<AnyEvent::Impl::POE>.
1273 1778
1779Non-blocking file handles, sockets, TCP clients and
1780servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
1781
1782Asynchronous DNS: L<AnyEvent::DNS>.
1783
1784Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1785
1274Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 1786Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1275 1787
1276 1788
1277=head1 AUTHOR 1789=head1 AUTHOR
1278 1790
1279 Marc Lehmann <schmorp@schmorp.de> 1791 Marc Lehmann <schmorp@schmorp.de>
1280 http://home.schmorp.de/ 1792 http://home.schmorp.de/
1281 1793
1282=cut 1794=cut
1283 1795
12841 17961
1285 1797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines