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.113 by root, Sat May 10 20:30:35 2008 UTC vs.
Revision 1.180 by root, Sat Sep 6 07:00:45 2008 UTC

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 ->send 28 $w->recv; # enters "main loop" till $condvar gets ->send
21 $w->send; # 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
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->send; 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
302If you are familiar with some event loops you will know that all of them 383If you are familiar with some event loops you will know that all of them
303require you to run some blocking "loop", "run" or similar function that 384require you to run some blocking "loop", "run" or similar function that
309The instrument to do that is called a "condition variable", so called 390The instrument to do that is called a "condition variable", so called
310because they represent a condition that must become true. 391because they represent a condition that must become true.
311 392
312Condition variables can be created by calling the C<< AnyEvent->condvar 393Condition variables can be created by calling the C<< AnyEvent->condvar
313>> method, usually without arguments. The only argument pair allowed is 394>> method, usually without arguments. The only argument pair allowed is
395
314C<cb>, which specifies a callback to be called when the condition variable 396C<cb>, which specifies a callback to be called when the condition variable
315becomes true. 397becomes true, with the condition variable as the first argument (but not
398the results).
316 399
317After creation, the conditon variable is "false" until it becomes "true" 400After creation, the condition variable is "false" until it becomes "true"
318by calling the C<send> method. 401by calling the C<send> method (or calling the condition variable as if it
402were a callback, read about the caveats in the description for the C<<
403->send >> method).
319 404
320Condition variables are similar to callbacks, except that you can 405Condition variables are similar to callbacks, except that you can
321optionally wait for them. They can also be called merge points - points 406optionally wait for them. They can also be called merge points - points
322in time where multiple outstandign events have been processed. And yet 407in time where multiple outstanding events have been processed. And yet
323another way to call them is transations - each condition variable can be 408another way to call them is transactions - each condition variable can be
324used to represent a transaction, which finishes at some point and delivers 409used to represent a transaction, which finishes at some point and delivers
325a result. 410a result.
326 411
327Condition variables are very useful to signal that something has finished, 412Condition variables are very useful to signal that something has finished,
328for example, if you write a module that does asynchronous http requests, 413for example, if you write a module that does asynchronous http requests,
329then a condition variable would be the ideal candidate to signal the 414then a condition variable would be the ideal candidate to signal the
330availability of results. The user can either act when the callback is 415availability of results. The user can either act when the callback is
331called or can synchronously C<< ->wait >> for the results. 416called or can synchronously C<< ->recv >> for the results.
332 417
333You can also use them to simulate traditional event loops - for example, 418You can also use them to simulate traditional event loops - for example,
334you can block your main program until an event occurs - for example, you 419you can block your main program until an event occurs - for example, you
335could C<< ->wait >> in your main program until the user clicks the Quit 420could C<< ->recv >> in your main program until the user clicks the Quit
336button of your app, which would C<< ->send >> the "quit" event. 421button of your app, which would C<< ->send >> the "quit" event.
337 422
338Note that condition variables recurse into the event loop - if you have 423Note that condition variables recurse into the event loop - if you have
339two pieces of code that call C<< ->wait >> in a round-robbin fashion, you 424two pieces of code that call C<< ->recv >> in a round-robin fashion, you
340lose. Therefore, condition variables are good to export to your caller, but 425lose. Therefore, condition variables are good to export to your caller, but
341you should avoid making a blocking wait yourself, at least in callbacks, 426you should avoid making a blocking wait yourself, at least in callbacks,
342as this asks for trouble. 427as this asks for trouble.
343 428
344Condition variables are represented by hash refs in perl, and the keys 429Condition variables are represented by hash refs in perl, and the keys
349 434
350There are two "sides" to a condition variable - the "producer side" which 435There are two "sides" to a condition variable - the "producer side" which
351eventually calls C<< -> send >>, and the "consumer side", which waits 436eventually calls C<< -> send >>, and the "consumer side", which waits
352for the send to occur. 437for the send to occur.
353 438
354Example: 439Example: wait for a timer.
355 440
356 # wait till the result is ready 441 # wait till the result is ready
357 my $result_ready = AnyEvent->condvar; 442 my $result_ready = AnyEvent->condvar;
358 443
359 # do something such as adding a timer 444 # do something such as adding a timer
365 cb => sub { $result_ready->send }, 450 cb => sub { $result_ready->send },
366 ); 451 );
367 452
368 # this "blocks" (while handling events) till the callback 453 # this "blocks" (while handling events) till the callback
369 # calls send 454 # calls send
370 $result_ready->wait; 455 $result_ready->recv;
456
457Example: wait for a timer, but take advantage of the fact that
458condition variables are also code references.
459
460 my $done = AnyEvent->condvar;
461 my $delay = AnyEvent->timer (after => 5, cb => $done);
462 $done->recv;
463
464Example: Imagine an API that returns a condvar and doesn't support
465callbacks. This is how you make a synchronous call, for example from
466the main program:
467
468 use AnyEvent::CouchDB;
469
470 ...
471
472 my @info = $couchdb->info->recv;
473
474And this is how you would just ste a callback to be called whenever the
475results are available:
476
477 $couchdb->info->cb (sub {
478 my @info = $_[0]->recv;
479 });
371 480
372=head3 METHODS FOR PRODUCERS 481=head3 METHODS FOR PRODUCERS
373 482
374These methods should only be used by the producing side, i.e. the 483These methods should only be used by the producing side, i.e. the
375code/module that eventually sends the signal. Note that it is also 484code/module that eventually sends the signal. Note that it is also
378 487
379=over 4 488=over 4
380 489
381=item $cv->send (...) 490=item $cv->send (...)
382 491
383Flag the condition as ready - a running C<< ->wait >> and all further 492Flag the condition as ready - a running C<< ->recv >> and all further
384calls to C<wait> will (eventually) return after this method has been 493calls to C<recv> will (eventually) return after this method has been
385called. If nobody is waiting the send will be remembered. 494called. If nobody is waiting the send will be remembered.
386 495
387If a callback has been set on the condition variable, it is called 496If a callback has been set on the condition variable, it is called
388immediately from within send. 497immediately from within send.
389 498
390Any arguments passed to the C<send> call will be returned by all 499Any arguments passed to the C<send> call will be returned by all
391future C<< ->wait >> calls. 500future C<< ->recv >> calls.
501
502Condition variables are overloaded so one can call them directly
503(as a code reference). Calling them directly is the same as calling
504C<send>. Note, however, that many C-based event loops do not handle
505overloading, so as tempting as it may be, passing a condition variable
506instead of a callback does not work. Both the pure perl and EV loops
507support overloading, however, as well as all functions that use perl to
508invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
509example).
392 510
393=item $cv->croak ($error) 511=item $cv->croak ($error)
394 512
395Similar to send, but causes all call's wait C<< ->wait >> to invoke 513Similar to send, but causes all call's to C<< ->recv >> to invoke
396C<Carp::croak> with the given error message/object/scalar. 514C<Carp::croak> with the given error message/object/scalar.
397 515
398This can be used to signal any errors to the condition variable 516This can be used to signal any errors to the condition variable
399user/consumer. 517user/consumer.
400 518
401=item $cv->begin ([group callback]) 519=item $cv->begin ([group callback])
402 520
403=item $cv->end 521=item $cv->end
522
523These two methods are EXPERIMENTAL and MIGHT CHANGE.
404 524
405These two methods can be used to combine many transactions/events into 525These two methods can be used to combine many transactions/events into
406one. For example, a function that pings many hosts in parallel might want 526one. For example, a function that pings many hosts in parallel might want
407to use a condition variable for the whole process. 527to use a condition variable for the whole process.
408 528
443doesn't execute once). 563doesn't execute once).
444 564
445This is the general pattern when you "fan out" into multiple subrequests: 565This is the general pattern when you "fan out" into multiple subrequests:
446use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 566use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
447is called at least once, and then, for each subrequest you start, call 567is called at least once, and then, for each subrequest you start, call
448C<begin> and for eahc subrequest you finish, call C<end>. 568C<begin> and for each subrequest you finish, call C<end>.
449 569
450=back 570=back
451 571
452=head3 METHODS FOR CONSUMERS 572=head3 METHODS FOR CONSUMERS
453 573
454These methods should only be used by the consuming side, i.e. the 574These methods should only be used by the consuming side, i.e. the
455code awaits the condition. 575code awaits the condition.
456 576
457=over 4 577=over 4
458 578
459=item $cv->wait 579=item $cv->recv
460 580
461Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak 581Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
462>> methods have been called on c<$cv>, while servicing other watchers 582>> methods have been called on c<$cv>, while servicing other watchers
463normally. 583normally.
464 584
475(programs might want to do that to stay interactive), so I<if you are 595(programs might want to do that to stay interactive), so I<if you are
476using this from a module, never require a blocking wait>, but let the 596using this from a module, never require a blocking wait>, but let the
477caller decide whether the call will block or not (for example, by coupling 597caller decide whether the call will block or not (for example, by coupling
478condition variables with some kind of request results and supporting 598condition variables with some kind of request results and supporting
479callbacks so the caller knows that getting the result will not block, 599callbacks so the caller knows that getting the result will not block,
480while still suppporting blocking waits if the caller so desires). 600while still supporting blocking waits if the caller so desires).
481 601
482Another reason I<never> to C<< ->wait >> in a module is that you cannot 602Another reason I<never> to C<< ->recv >> in a module is that you cannot
483sensibly have two C<< ->wait >>'s in parallel, as that would require 603sensibly have two C<< ->recv >>'s in parallel, as that would require
484multiple interpreters or coroutines/threads, none of which C<AnyEvent> 604multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485can supply. 605can supply.
486 606
487The L<Coro> module, however, I<can> and I<does> supply coroutines and, in 607The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
488fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe 608fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
489versions and also integrates coroutines into AnyEvent, making blocking 609versions and also integrates coroutines into AnyEvent, making blocking
490C<< ->wait >> calls perfectly safe as long as they are done from another 610C<< ->recv >> calls perfectly safe as long as they are done from another
491coroutine (one that doesn't run the event loop). 611coroutine (one that doesn't run the event loop).
492 612
493You can ensure that C<< -wait >> never blocks by setting a callback and 613You can ensure that C<< -recv >> never blocks by setting a callback and
494only calling C<< ->wait >> from within that callback (or at a later 614only calling C<< ->recv >> from within that callback (or at a later
495time). This will work even when the event loop does not support blocking 615time). This will work even when the event loop does not support blocking
496waits otherwise. 616waits otherwise.
497 617
498=item $bool = $cv->ready 618=item $bool = $cv->ready
499 619
500Returns true when the condition is "true", i.e. whether C<send> or 620Returns true when the condition is "true", i.e. whether C<send> or
501C<croak> have been called. 621C<croak> have been called.
502 622
503=item $cb = $cv->cb ([new callback]) 623=item $cb = $cv->cb ($cb->($cv))
504 624
505This is a mutator function that returns the callback set and optionally 625This is a mutator function that returns the callback set and optionally
506replaces it before doing so. 626replaces it before doing so.
507 627
508The callback will be called when the condition becomes "true", i.e. when 628The callback will be called when the condition becomes "true", i.e. when
509C<send> or C<croak> are called. Calling C<wait> inside the callback 629C<send> or C<croak> are called, with the only argument being the condition
510or at any later time is guaranteed not to block. 630variable itself. Calling C<recv> inside the callback or at any later time
631is guaranteed not to block.
511 632
512=back 633=back
513 634
514=head1 GLOBAL VARIABLES AND FUNCTIONS 635=head1 GLOBAL VARIABLES AND FUNCTIONS
515 636
582Be careful when you create watchers in the module body - AnyEvent will 703Be careful when you create watchers in the module body - AnyEvent will
583decide which event module to use as soon as the first method is called, so 704decide which event module to use as soon as the first method is called, so
584by calling AnyEvent in your module body you force the user of your module 705by calling AnyEvent in your module body you force the user of your module
585to load the event module first. 706to load the event module first.
586 707
587Never call C<< ->wait >> on a condition variable unless you I<know> that 708Never call C<< ->recv >> on a condition variable unless you I<know> that
588the C<< ->send >> method has been called on it already. This is 709the C<< ->send >> method has been called on it already. This is
589because it will stall the whole program, and the whole point of using 710because it will stall the whole program, and the whole point of using
590events is to stay interactive. 711events is to stay interactive.
591 712
592It is fine, however, to call C<< ->wait >> when the user of your module 713It is fine, however, to call C<< ->recv >> when the user of your module
593requests it (i.e. if you create a http request object ad have a method 714requests it (i.e. if you create a http request object ad have a method
594called C<results> that returns the results, it should call C<< ->wait >> 715called C<results> that returns the results, it should call C<< ->recv >>
595freely, as the user of your module knows what she is doing. always). 716freely, as the user of your module knows what she is doing. always).
596 717
597=head1 WHAT TO DO IN THE MAIN PROGRAM 718=head1 WHAT TO DO IN THE MAIN PROGRAM
598 719
599There will always be a single main program - the only place that should 720There will always be a single main program - the only place that should
601 722
602If it doesn't care, it can just "use AnyEvent" and use it itself, or not 723If it doesn't care, it can just "use AnyEvent" and use it itself, or not
603do anything special (it does not need to be event-based) and let AnyEvent 724do anything special (it does not need to be event-based) and let AnyEvent
604decide which implementation to chose if some module relies on it. 725decide which implementation to chose if some module relies on it.
605 726
606If the main program relies on a specific event model. For example, in 727If the main program relies on a specific event model - for example, in
607Gtk2 programs you have to rely on the Glib module. You should load the 728Gtk2 programs you have to rely on the Glib module - you should load the
608event module before loading AnyEvent or any module that uses it: generally 729event module before loading AnyEvent or any module that uses it: generally
609speaking, you should load it as early as possible. The reason is that 730speaking, you should load it as early as possible. The reason is that
610modules might create watchers when they are loaded, and AnyEvent will 731modules might create watchers when they are loaded, and AnyEvent will
611decide on the event model to use as soon as it creates watchers, and it 732decide on the event model to use as soon as it creates watchers, and it
612might chose the wrong one unless you load the correct one yourself. 733might chose the wrong one unless you load the correct one yourself.
613 734
614You can chose to use a rather inefficient pure-perl implementation by 735You can chose to use a pure-perl implementation by loading the
615loading the C<AnyEvent::Impl::Perl> module, which gives you similar 736C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
616behaviour everywhere, but letting AnyEvent chose is generally better. 737everywhere, but letting AnyEvent chose the model is generally better.
738
739=head2 MAINLOOP EMULATION
740
741Sometimes (often for short test scripts, or even standalone programs who
742only want to use AnyEvent), you do not want to run a specific event loop.
743
744In that case, you can use a condition variable like this:
745
746 AnyEvent->condvar->recv;
747
748This has the effect of entering the event loop and looping forever.
749
750Note that usually your program has some exit condition, in which case
751it is better to use the "traditional" approach of storing a condition
752variable somewhere, waiting for it, and sending it when the program should
753exit cleanly.
754
617 755
618=head1 OTHER MODULES 756=head1 OTHER MODULES
619 757
620The following is a non-exhaustive list of additional modules that use 758The following is a non-exhaustive list of additional modules that use
621AnyEvent and can therefore be mixed easily with other AnyEvent modules 759AnyEvent and can therefore be mixed easily with other AnyEvent modules
627=item L<AnyEvent::Util> 765=item L<AnyEvent::Util>
628 766
629Contains various utility functions that replace often-used but blocking 767Contains various utility functions that replace often-used but blocking
630functions such as C<inet_aton> by event-/callback-based versions. 768functions such as C<inet_aton> by event-/callback-based versions.
631 769
770=item L<AnyEvent::Socket>
771
772Provides various utility functions for (internet protocol) sockets,
773addresses and name resolution. Also functions to create non-blocking tcp
774connections or tcp servers, with IPv6 and SRV record support and more.
775
632=item L<AnyEvent::Handle> 776=item L<AnyEvent::Handle>
633 777
634Provide read and write buffers and manages watchers for reads and writes. 778Provide read and write buffers, manages watchers for reads and writes,
779supports raw and formatted I/O, I/O queued and fully transparent and
780non-blocking SSL/TLS.
781
782=item L<AnyEvent::DNS>
783
784Provides rich asynchronous DNS resolver capabilities.
785
786=item L<AnyEvent::HTTP>
787
788A simple-to-use HTTP library that is capable of making a lot of concurrent
789HTTP requests.
635 790
636=item L<AnyEvent::HTTPD> 791=item L<AnyEvent::HTTPD>
637 792
638Provides a simple web application server framework. 793Provides a simple web application server framework.
639 794
640=item L<AnyEvent::DNS>
641
642Provides asynchronous DNS resolver capabilities, beyond what
643L<AnyEvent::Util> offers.
644
645=item L<AnyEvent::FastPing> 795=item L<AnyEvent::FastPing>
646 796
647The fastest ping in the west. 797The fastest ping in the west.
798
799=item L<AnyEvent::DBI>
800
801Executes L<DBI> requests asynchronously in a proxy process.
802
803=item L<AnyEvent::AIO>
804
805Truly asynchronous I/O, should be in the toolbox of every event
806programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
807together.
808
809=item L<AnyEvent::BDB>
810
811Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
812L<BDB> and AnyEvent together.
813
814=item L<AnyEvent::GPSD>
815
816A non-blocking interface to gpsd, a daemon delivering GPS information.
817
818=item L<AnyEvent::IGS>
819
820A non-blocking interface to the Internet Go Server protocol (used by
821L<App::IGS>).
648 822
649=item L<Net::IRC3> 823=item L<Net::IRC3>
650 824
651AnyEvent based IRC client module family. 825AnyEvent based IRC client module family.
652 826
665 839
666=item L<Coro> 840=item L<Coro>
667 841
668Has special support for AnyEvent via L<Coro::AnyEvent>. 842Has special support for AnyEvent via L<Coro::AnyEvent>.
669 843
670=item L<AnyEvent::AIO>, L<IO::AIO>
671
672Truly asynchronous I/O, should be in the toolbox of every event
673programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
674together.
675
676=item L<AnyEvent::BDB>, L<BDB>
677
678Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
679IO::AIO and AnyEvent together.
680
681=item L<IO::Lambda> 844=item L<IO::Lambda>
682 845
683The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 846The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
684 847
685=back 848=back
687=cut 850=cut
688 851
689package AnyEvent; 852package AnyEvent;
690 853
691no warnings; 854no warnings;
692use strict; 855use strict qw(vars subs);
693 856
694use Carp; 857use Carp;
695 858
696our $VERSION = '3.4'; 859our $VERSION = 4.233;
697our $MODEL; 860our $MODEL;
698 861
699our $AUTOLOAD; 862our $AUTOLOAD;
700our @ISA; 863our @ISA;
701 864
865our @REGISTRY;
866
867our $WIN32;
868
869BEGIN {
870 my $win32 = ! ! ($^O =~ /mswin32/i);
871 eval "sub WIN32(){ $win32 }";
872}
873
702our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 874our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
703 875
704our @REGISTRY; 876our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
877
878{
879 my $idx;
880 $PROTOCOL{$_} = ++$idx
881 for reverse split /\s*,\s*/,
882 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
883}
705 884
706my @models = ( 885my @models = (
707 [EV:: => AnyEvent::Impl::EV::], 886 [EV:: => AnyEvent::Impl::EV::],
708 [Event:: => AnyEvent::Impl::Event::], 887 [Event:: => AnyEvent::Impl::Event::],
709 [Tk:: => AnyEvent::Impl::Tk::],
710 [Wx:: => AnyEvent::Impl::POE::],
711 [Prima:: => AnyEvent::Impl::POE::],
712 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 888 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
713 # everything below here will not be autoprobed as the pureperl backend should work everywhere 889 # everything below here will not be autoprobed
714 [Glib:: => AnyEvent::Impl::Glib::], 890 # as the pureperl backend should work everywhere
891 # and is usually faster
892 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
893 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
715 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 894 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
716 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 895 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
717 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 896 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
897 [Wx:: => AnyEvent::Impl::POE::],
898 [Prima:: => AnyEvent::Impl::POE::],
718); 899);
719 900
720our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 901our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
721 902
722our @post_detect; 903our @post_detect;
723 904
724sub post_detect(&) { 905sub post_detect(&) {
725 my ($cb) = @_; 906 my ($cb) = @_;
730 1 911 1
731 } else { 912 } else {
732 push @post_detect, $cb; 913 push @post_detect, $cb;
733 914
734 defined wantarray 915 defined wantarray
735 ? bless \$cb, "AnyEvent::Util::Guard" 916 ? bless \$cb, "AnyEvent::Util::PostDetect"
736 : () 917 : ()
737 } 918 }
738} 919}
739 920
740sub AnyEvent::Util::Guard::DESTROY { 921sub AnyEvent::Util::PostDetect::DESTROY {
741 @post_detect = grep $_ != ${$_[0]}, @post_detect; 922 @post_detect = grep $_ != ${$_[0]}, @post_detect;
742} 923}
743 924
744sub detect() { 925sub detect() {
745 unless ($MODEL) { 926 unless ($MODEL) {
746 no strict 'refs'; 927 no strict 'refs';
928 local $SIG{__DIE__};
747 929
748 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 930 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
749 my $model = "AnyEvent::Impl::$1"; 931 my $model = "AnyEvent::Impl::$1";
750 if (eval "require $model") { 932 if (eval "require $model") {
751 $MODEL = $model; 933 $MODEL = $model;
785 $MODEL 967 $MODEL
786 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 968 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
787 } 969 }
788 } 970 }
789 971
972 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
973
790 unshift @ISA, $MODEL; 974 unshift @ISA, $MODEL;
791 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 975
976 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
792 977
793 (shift @post_detect)->() while @post_detect; 978 (shift @post_detect)->() while @post_detect;
794 } 979 }
795 980
796 $MODEL 981 $MODEL
806 991
807 my $class = shift; 992 my $class = shift;
808 $class->$func (@_); 993 $class->$func (@_);
809} 994}
810 995
996# utility function to dup a filehandle. this is used by many backends
997# to support binding more than one watcher per filehandle (they usually
998# allow only one watcher per fd, so we dup it to get a different one).
999sub _dupfh($$$$) {
1000 my ($poll, $fh, $r, $w) = @_;
1001
1002 require Fcntl;
1003
1004 # cygwin requires the fh mode to be matching, unix doesn't
1005 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1006 : $poll eq "w" ? ($w, ">")
1007 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1008
1009 open my $fh2, "$mode&" . fileno $fh
1010 or die "cannot dup() filehandle: $!";
1011
1012 # we assume CLOEXEC is already set by perl in all important cases
1013
1014 ($fh2, $rw)
1015}
1016
811package AnyEvent::Base; 1017package AnyEvent::Base;
812 1018
1019# default implementation for now and time
1020
1021BEGIN {
1022 if (eval "use Time::HiRes (); time (); 1") {
1023 *_time = \&Time::HiRes::time;
1024 # if (eval "use POSIX (); (POSIX::times())...
1025 } else {
1026 *_time = \&CORE::time; # epic fail
1027 }
1028}
1029
1030sub time { _time }
1031sub now { _time }
1032
813# default implementation for ->condvar, ->wait, ->broadcast 1033# default implementation for ->condvar
814 1034
815sub condvar { 1035sub condvar {
816 bless \my $flag, "AnyEvent::Base::CondVar" 1036 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
817}
818
819sub AnyEvent::Base::CondVar::broadcast {
820 ${$_[0]}++;
821}
822
823sub AnyEvent::Base::CondVar::wait {
824 AnyEvent->one_event while !${$_[0]};
825} 1037}
826 1038
827# default implementation for ->signal 1039# default implementation for ->signal
828 1040
829our %SIG_CB; 1041our %SIG_CB;
845sub AnyEvent::Base::Signal::DESTROY { 1057sub AnyEvent::Base::Signal::DESTROY {
846 my ($signal, $cb) = @{$_[0]}; 1058 my ($signal, $cb) = @{$_[0]};
847 1059
848 delete $SIG_CB{$signal}{$cb}; 1060 delete $SIG_CB{$signal}{$cb};
849 1061
850 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1062 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
851} 1063}
852 1064
853# default implementation for ->child 1065# default implementation for ->child
854 1066
855our %PID_CB; 1067our %PID_CB;
882 or Carp::croak "required option 'pid' is missing"; 1094 or Carp::croak "required option 'pid' is missing";
883 1095
884 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1096 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
885 1097
886 unless ($WNOHANG) { 1098 unless ($WNOHANG) {
887 $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; 1099 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
888 } 1100 }
889 1101
890 unless ($CHLD_W) { 1102 unless ($CHLD_W) {
891 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1103 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
892 # child could be a zombie already, so make at least one round 1104 # child could be a zombie already, so make at least one round
902 delete $PID_CB{$pid}{$cb}; 1114 delete $PID_CB{$pid}{$cb};
903 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1115 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
904 1116
905 undef $CHLD_W unless keys %PID_CB; 1117 undef $CHLD_W unless keys %PID_CB;
906} 1118}
1119
1120package AnyEvent::CondVar;
1121
1122our @ISA = AnyEvent::CondVar::Base::;
1123
1124package AnyEvent::CondVar::Base;
1125
1126use overload
1127 '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1128 fallback => 1;
1129
1130sub _send {
1131 # nop
1132}
1133
1134sub send {
1135 my $cv = shift;
1136 $cv->{_ae_sent} = [@_];
1137 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1138 $cv->_send;
1139}
1140
1141sub croak {
1142 $_[0]{_ae_croak} = $_[1];
1143 $_[0]->send;
1144}
1145
1146sub ready {
1147 $_[0]{_ae_sent}
1148}
1149
1150sub _wait {
1151 AnyEvent->one_event while !$_[0]{_ae_sent};
1152}
1153
1154sub recv {
1155 $_[0]->_wait;
1156
1157 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1158 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1159}
1160
1161sub cb {
1162 $_[0]{_ae_cb} = $_[1] if @_ > 1;
1163 $_[0]{_ae_cb}
1164}
1165
1166sub begin {
1167 ++$_[0]{_ae_counter};
1168 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1169}
1170
1171sub end {
1172 return if --$_[0]{_ae_counter};
1173 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1174}
1175
1176# undocumented/compatibility with pre-3.4
1177*broadcast = \&send;
1178*wait = \&_wait;
1179
1180=head1 ERROR AND EXCEPTION HANDLING
1181
1182In general, AnyEvent does not do any error handling - it relies on the
1183caller to do that if required. The L<AnyEvent::Strict> module (see also
1184the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1185checking of all AnyEvent methods, however, which is highly useful during
1186development.
1187
1188As for exception handling (i.e. runtime errors and exceptions thrown while
1189executing a callback), this is not only highly event-loop specific, but
1190also not in any way wrapped by this module, as this is the job of the main
1191program.
1192
1193The pure perl event loop simply re-throws the exception (usually
1194within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1195$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1196so on.
1197
1198=head1 ENVIRONMENT VARIABLES
1199
1200The following environment variables are used by this module or its
1201submodules:
1202
1203=over 4
1204
1205=item C<PERL_ANYEVENT_VERBOSE>
1206
1207By default, AnyEvent will be completely silent except in fatal
1208conditions. You can set this environment variable to make AnyEvent more
1209talkative.
1210
1211When set to C<1> or higher, causes AnyEvent to warn about unexpected
1212conditions, such as not being able to load the event model specified by
1213C<PERL_ANYEVENT_MODEL>.
1214
1215When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1216model it chooses.
1217
1218=item C<PERL_ANYEVENT_STRICT>
1219
1220AnyEvent does not do much argument checking by default, as thorough
1221argument checking is very costly. Setting this variable to a true value
1222will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1223check the arguments passed to most method calls. If it finds any problems
1224it will croak.
1225
1226In other words, enables "strict" mode.
1227
1228Unlike C<use strict>, it is definitely recommended ot keep it off in
1229production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1230developing programs can be very useful, however.
1231
1232=item C<PERL_ANYEVENT_MODEL>
1233
1234This can be used to specify the event model to be used by AnyEvent, before
1235auto detection and -probing kicks in. It must be a string consisting
1236entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1237and the resulting module name is loaded and if the load was successful,
1238used as event model. If it fails to load AnyEvent will proceed with
1239auto detection and -probing.
1240
1241This functionality might change in future versions.
1242
1243For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1244could start your program like this:
1245
1246 PERL_ANYEVENT_MODEL=Perl perl ...
1247
1248=item C<PERL_ANYEVENT_PROTOCOLS>
1249
1250Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1251for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1252of auto probing).
1253
1254Must be set to a comma-separated list of protocols or address families,
1255current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1256used, and preference will be given to protocols mentioned earlier in the
1257list.
1258
1259This variable can effectively be used for denial-of-service attacks
1260against local programs (e.g. when setuid), although the impact is likely
1261small, as the program has to handle connection errors already-
1262
1263Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1264but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1265- only support IPv4, never try to resolve or contact IPv6
1266addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1267IPv6, but prefer IPv6 over IPv4.
1268
1269=item C<PERL_ANYEVENT_EDNS0>
1270
1271Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1272for DNS. This extension is generally useful to reduce DNS traffic, but
1273some (broken) firewalls drop such DNS packets, which is why it is off by
1274default.
1275
1276Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1277EDNS0 in its DNS requests.
1278
1279=item C<PERL_ANYEVENT_MAX_FORKS>
1280
1281The maximum number of child processes that C<AnyEvent::Util::fork_call>
1282will create in parallel.
1283
1284=back
907 1285
908=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1286=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
909 1287
910This is an advanced topic that you do not normally need to use AnyEvent in 1288This is an advanced topic that you do not normally need to use AnyEvent in
911a module. This section is only of use to event loop authors who want to 1289a module. This section is only of use to event loop authors who want to
945 1323
946I<rxvt-unicode> also cheats a bit by not providing blocking access to 1324I<rxvt-unicode> also cheats a bit by not providing blocking access to
947condition variables: code blocking while waiting for a condition will 1325condition variables: code blocking while waiting for a condition will
948C<die>. This still works with most modules/usages, and blocking calls must 1326C<die>. This still works with most modules/usages, and blocking calls must
949not be done in an interactive application, so it makes sense. 1327not be done in an interactive application, so it makes sense.
950
951=head1 ENVIRONMENT VARIABLES
952
953The following environment variables are used by this module:
954
955=over 4
956
957=item C<PERL_ANYEVENT_VERBOSE>
958
959By default, AnyEvent will be completely silent except in fatal
960conditions. You can set this environment variable to make AnyEvent more
961talkative.
962
963When set to C<1> or higher, causes AnyEvent to warn about unexpected
964conditions, such as not being able to load the event model specified by
965C<PERL_ANYEVENT_MODEL>.
966
967When set to C<2> or higher, cause AnyEvent to report to STDERR which event
968model it chooses.
969
970=item C<PERL_ANYEVENT_MODEL>
971
972This can be used to specify the event model to be used by AnyEvent, before
973autodetection and -probing kicks in. It must be a string consisting
974entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
975and the resulting module name is loaded and if the load was successful,
976used as event model. If it fails to load AnyEvent will proceed with
977autodetection and -probing.
978
979This functionality might change in future versions.
980
981For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
982could start your program like this:
983
984 PERL_ANYEVENT_MODEL=Perl perl ...
985
986=back
987 1328
988=head1 EXAMPLE PROGRAM 1329=head1 EXAMPLE PROGRAM
989 1330
990The following program uses an I/O watcher to read data from STDIN, a timer 1331The following program uses an I/O watcher to read data from STDIN, a timer
991to display a message once per second, and a condition variable to quit the 1332to display a message once per second, and a condition variable to quit the
1000 poll => 'r', 1341 poll => 'r',
1001 cb => sub { 1342 cb => sub {
1002 warn "io event <$_[0]>\n"; # will always output <r> 1343 warn "io event <$_[0]>\n"; # will always output <r>
1003 chomp (my $input = <STDIN>); # read a line 1344 chomp (my $input = <STDIN>); # read a line
1004 warn "read: $input\n"; # output what has been read 1345 warn "read: $input\n"; # output what has been read
1005 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i 1346 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1006 }, 1347 },
1007 ); 1348 );
1008 1349
1009 my $time_watcher; # can only be used once 1350 my $time_watcher; # can only be used once
1010 1351
1015 }); 1356 });
1016 } 1357 }
1017 1358
1018 new_timer; # create first timer 1359 new_timer; # create first timer
1019 1360
1020 $cv->wait; # wait until user enters /^q/i 1361 $cv->recv; # wait until user enters /^q/i
1021 1362
1022=head1 REAL-WORLD EXAMPLE 1363=head1 REAL-WORLD EXAMPLE
1023 1364
1024Consider the L<Net::FCP> module. It features (among others) the following 1365Consider the L<Net::FCP> module. It features (among others) the following
1025API calls, which are to freenet what HTTP GET requests are to http: 1366API calls, which are to freenet what HTTP GET requests are to http:
1075 syswrite $txn->{fh}, $txn->{request} 1416 syswrite $txn->{fh}, $txn->{request}
1076 or die "connection or write error"; 1417 or die "connection or write error";
1077 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); 1418 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1078 1419
1079Again, C<fh_ready_r> waits till all data has arrived, and then stores the 1420Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1080result and signals any possible waiters that the request ahs finished: 1421result and signals any possible waiters that the request has finished:
1081 1422
1082 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; 1423 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1083 1424
1084 if (end-of-file or data complete) { 1425 if (end-of-file or data complete) {
1085 $txn->{result} = $txn->{buf}; 1426 $txn->{result} = $txn->{buf};
1086 $txn->{finished}->broadcast; 1427 $txn->{finished}->send;
1087 $txb->{cb}->($txn) of $txn->{cb}; # also call callback 1428 $txb->{cb}->($txn) of $txn->{cb}; # also call callback
1088 } 1429 }
1089 1430
1090The C<result> method, finally, just waits for the finished signal (if the 1431The C<result> method, finally, just waits for the finished signal (if the
1091request was already finished, it doesn't wait, of course, and returns the 1432request was already finished, it doesn't wait, of course, and returns the
1092data: 1433data:
1093 1434
1094 $txn->{finished}->wait; 1435 $txn->{finished}->recv;
1095 return $txn->{result}; 1436 return $txn->{result};
1096 1437
1097The actual code goes further and collects all errors (C<die>s, exceptions) 1438The actual code goes further and collects all errors (C<die>s, exceptions)
1098that occured during request processing. The C<result> method detects 1439that occurred during request processing. The C<result> method detects
1099whether an exception as thrown (it is stored inside the $txn object) 1440whether an exception as thrown (it is stored inside the $txn object)
1100and just throws the exception, which means connection errors and other 1441and just throws the exception, which means connection errors and other
1101problems get reported tot he code that tries to use the result, not in a 1442problems get reported tot he code that tries to use the result, not in a
1102random callback. 1443random callback.
1103 1444
1134 1475
1135 my $quit = AnyEvent->condvar; 1476 my $quit = AnyEvent->condvar;
1136 1477
1137 $fcp->txn_client_get ($url)->cb (sub { 1478 $fcp->txn_client_get ($url)->cb (sub {
1138 ... 1479 ...
1139 $quit->broadcast; 1480 $quit->send;
1140 }); 1481 });
1141 1482
1142 $quit->wait; 1483 $quit->recv;
1143 1484
1144 1485
1145=head1 BENCHMARKS 1486=head1 BENCHMARKS
1146 1487
1147To give you an idea of the performance and overheads that AnyEvent adds 1488To give you an idea of the performance and overheads that AnyEvent adds
1149of various event loops I prepared some benchmarks. 1490of various event loops I prepared some benchmarks.
1150 1491
1151=head2 BENCHMARKING ANYEVENT OVERHEAD 1492=head2 BENCHMARKING ANYEVENT OVERHEAD
1152 1493
1153Here is a benchmark of various supported event models used natively and 1494Here is a benchmark of various supported event models used natively and
1154through anyevent. The benchmark creates a lot of timers (with a zero 1495through AnyEvent. The benchmark creates a lot of timers (with a zero
1155timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1496timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1156which it is), lets them fire exactly once and destroys them again. 1497which it is), lets them fire exactly once and destroys them again.
1157 1498
1158Source code for this benchmark is found as F<eg/bench> in the AnyEvent 1499Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1159distribution. 1500distribution.
1176all watchers, to avoid adding memory overhead. That means closure creation 1517all watchers, to avoid adding memory overhead. That means closure creation
1177and memory usage is not included in the figures. 1518and memory usage is not included in the figures.
1178 1519
1179I<invoke> is the time, in microseconds, used to invoke a simple 1520I<invoke> is the time, in microseconds, used to invoke a simple
1180callback. The callback simply counts down a Perl variable and after it was 1521callback. The callback simply counts down a Perl variable and after it was
1181invoked "watcher" times, it would C<< ->broadcast >> a condvar once to 1522invoked "watcher" times, it would C<< ->send >> a condvar once to
1182signal the end of this phase. 1523signal the end of this phase.
1183 1524
1184I<destroy> is the time, in microseconds, that it takes to destroy a single 1525I<destroy> is the time, in microseconds, that it takes to destroy a single
1185watcher. 1526watcher.
1186 1527
1282 1623
1283=back 1624=back
1284 1625
1285=head2 BENCHMARKING THE LARGE SERVER CASE 1626=head2 BENCHMARKING THE LARGE SERVER CASE
1286 1627
1287This benchmark atcually benchmarks the event loop itself. It works by 1628This benchmark actually benchmarks the event loop itself. It works by
1288creating a number of "servers": each server consists of a socketpair, a 1629creating a number of "servers": each server consists of a socket pair, a
1289timeout watcher that gets reset on activity (but never fires), and an I/O 1630timeout watcher that gets reset on activity (but never fires), and an I/O
1290watcher waiting for input on one side of the socket. Each time the socket 1631watcher waiting for input on one side of the socket. Each time the socket
1291watcher reads a byte it will write that byte to a random other "server". 1632watcher reads a byte it will write that byte to a random other "server".
1292 1633
1293The effect is that there will be a lot of I/O watchers, only part of which 1634The effect is that there will be a lot of I/O watchers, only part of which
1294are active at any one point (so there is a constant number of active 1635are active at any one point (so there is a constant number of active
1295fds for each loop iterstaion, but which fds these are is random). The 1636fds for each loop iteration, but which fds these are is random). The
1296timeout is reset each time something is read because that reflects how 1637timeout is reset each time something is read because that reflects how
1297most timeouts work (and puts extra pressure on the event loops). 1638most timeouts work (and puts extra pressure on the event loops).
1298 1639
1299In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 1640In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1300(1%) are active. This mirrors the activity of large servers with many 1641(1%) are active. This mirrors the activity of large servers with many
1301connections, most of which are idle at any one point in time. 1642connections, most of which are idle at any one point in time.
1302 1643
1303Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 1644Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1304distribution. 1645distribution.
1306=head3 Explanation of the columns 1647=head3 Explanation of the columns
1307 1648
1308I<sockets> is the number of sockets, and twice the number of "servers" (as 1649I<sockets> is the number of sockets, and twice the number of "servers" (as
1309each server has a read and write socket end). 1650each server has a read and write socket end).
1310 1651
1311I<create> is the time it takes to create a socketpair (which is 1652I<create> is the time it takes to create a socket pair (which is
1312nontrivial) and two watchers: an I/O watcher and a timeout watcher. 1653nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1313 1654
1314I<request>, the most important value, is the time it takes to handle a 1655I<request>, the most important value, is the time it takes to handle a
1315single "request", that is, reading the token from the pipe and forwarding 1656single "request", that is, reading the token from the pipe and forwarding
1316it to another server. This includes deleting the old timeout and creating 1657it to another server. This includes deleting the old timeout and creating
1389speed most when you have lots of watchers, not when you only have a few of 1730speed most when you have lots of watchers, not when you only have a few of
1390them). 1731them).
1391 1732
1392EV is again fastest. 1733EV is again fastest.
1393 1734
1394Perl again comes second. It is noticably faster than the C-based event 1735Perl again comes second. It is noticeably faster than the C-based event
1395loops Event and Glib, although the difference is too small to really 1736loops Event and Glib, although the difference is too small to really
1396matter. 1737matter.
1397 1738
1398POE also performs much better in this case, but is is still far behind the 1739POE also performs much better in this case, but is is still far behind the
1399others. 1740others.
1428specified in the variable. 1769specified in the variable.
1429 1770
1430You can make AnyEvent completely ignore this variable by deleting it 1771You can make AnyEvent completely ignore this variable by deleting it
1431before the first watcher gets created, e.g. with a C<BEGIN> block: 1772before the first watcher gets created, e.g. with a C<BEGIN> block:
1432 1773
1433 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1774 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1434 1775
1435 use AnyEvent; 1776 use AnyEvent;
1436 1777
1437Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1778Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1438be used to probe what backend is used and gain other information (which is 1779be used to probe what backend is used and gain other information (which is
1439probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1780probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1781$ENV{PERL_ANYEGENT_STRICT}.
1782
1783
1784=head1 BUGS
1785
1786Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1787to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1788and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1789mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1790pronounced).
1440 1791
1441 1792
1442=head1 SEE ALSO 1793=head1 SEE ALSO
1794
1795Utility functions: L<AnyEvent::Util>.
1443 1796
1444Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 1797Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1445L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 1798L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1446 1799
1447Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 1800Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1448L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 1801L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1449L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 1802L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1450L<AnyEvent::Impl::POE>. 1803L<AnyEvent::Impl::POE>.
1451 1804
1805Non-blocking file handles, sockets, TCP clients and
1806servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
1807
1808Asynchronous DNS: L<AnyEvent::DNS>.
1809
1452Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, 1810Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1453 1811
1454Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 1812Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1455 1813
1456 1814
1457=head1 AUTHOR 1815=head1 AUTHOR
1458 1816
1459 Marc Lehmann <schmorp@schmorp.de> 1817 Marc Lehmann <schmorp@schmorp.de>
1460 http://home.schmorp.de/ 1818 http://home.schmorp.de/
1461 1819
1462=cut 1820=cut
1463 1821
14641 18221
1465 1823

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines