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.167 by root, Tue Jul 8 23:44:51 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
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 15 my $w = AnyEvent->timer (after => $seconds, cb => sub {
16 ... 16 ...
17 }); 17 });
18 18
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 19 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's
20 $w->wait; # enters "main loop" till $condvar gets ->broadcast 21 $w->recv; # enters "main loop" till $condvar gets ->send
21 $w->broadcast; # wake up current and all future wait's 22
23=head1 INTRODUCTION/TUTORIAL
24
25This manpage is mainly a reference manual. If you are interested
26in a tutorial or some gentle introduction, have a look at the
27L<AnyEvent::Intro> manpage.
22 28
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 29=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 30
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 31Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 32nowadays. So what is different about AnyEvent?
48isn't itself. What's worse, all the potential users of your module are 54isn't itself. What's worse, all the potential users of your module are
49I<also> forced to use the same event loop you use. 55I<also> forced to use the same event loop you use.
50 56
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 57AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. AnyEvent + Tk works fine etc. etc. but none of these work together 58fine. 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 59with 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, 60your 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 61too. But if your module uses AnyEvent, it works transparently with all
56event models it supports (including stuff like POE and IO::Async, as long 62event models it supports (including stuff like POE and IO::Async, as long
57as those use one of the supported event loops. It is trivial to add new 63as those use one of the supported event loops. It is trivial to add new
58event loops to AnyEvent, too, so it is future-proof). 64event loops to AnyEvent, too, so it is future-proof).
59 65
60In addition to being free of having to use I<the one and only true event 66In 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 67model>, 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 68modules, 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 69follow. 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 70offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 71technically possible.
66 72
73Of course, AnyEvent comes with a big (and fully optional!) toolbox
74of useful functionality, such as an asynchronous DNS resolver, 100%
75non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
76such as Windows) and lots of real-world knowledge and workarounds for
77platform bugs and differences.
78
67Of course, if you want lots of policy (this can arguably be somewhat 79Now, 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 80useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 81model, you should I<not> use this module.
70 82
71=head1 DESCRIPTION 83=head1 DESCRIPTION
72 84
78The interface itself is vaguely similar, but not identical to the L<Event> 90The interface itself is vaguely similar, but not identical to the L<Event>
79module. 91module.
80 92
81During the first call of any watcher-creation method, the module tries 93During the first call of any watcher-creation method, the module tries
82to detect the currently loaded event loop by probing whether one of the 94to 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>, 95following modules is already loaded: L<EV>,
84L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, 96L<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 97L<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 98to 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 99adaptor 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 100be 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 114starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly... 115use AnyEvent so their modules work together with others seamlessly...
104 116
105The pure-perl implementation of AnyEvent is called 117The pure-perl implementation of AnyEvent is called
106C<AnyEvent::Impl::Perl>. Like other event modules you can load it 118C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107explicitly. 119explicitly and enjoy the high availability of that event loop :)
108 120
109=head1 WATCHERS 121=head1 WATCHERS
110 122
111AnyEvent has the central concept of a I<watcher>, which is an object that 123AnyEvent 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 124stores relevant data for each kind of event you are waiting for, such as
113the callback to call, the filehandle to watch, etc. 125the callback to call, the file handle to watch, etc.
114 126
115These watchers are normal Perl objects with normal Perl lifetime. After 127These watchers are normal Perl objects with normal Perl lifetime. After
116creating a watcher it will immediately "watch" for events and invoke the 128creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model 129callback when the event occurs (of course, only when the event model
118is in control). 130is in control).
126Many watchers either are used with "recursion" (repeating timers for 138Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways. 139example), or need to refer to their watcher object in other ways.
128 140
129An any way to achieve that is this pattern: 141An any way to achieve that is this pattern:
130 142
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 143 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it 144 # you can use $w here, for example to undef it
133 undef $w; 145 undef $w;
134 }); 146 });
135 147
136Note that C<my $w; $w => combination. This is necessary because in Perl, 148Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are 149my variables are only visible after the statement in which they are
138declared. 150declared.
139 151
140=head2 I/O WATCHERS 152=head2 I/O WATCHERS
141 153
142You can create an I/O watcher by calling the C<< AnyEvent->io >> method 154You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143with the following mandatory key-value pairs as arguments: 155with the following mandatory key-value pairs as arguments:
144 156
145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 157C<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>, 158(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, 159must 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 160waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
149becomes ready. 161callback to invoke each time the file handle becomes ready.
150 162
151Although the callback might get passed parameters, their value and 163Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent 164presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks. 165callbacks cannot use arguments passed to I/O watcher callbacks.
154 166
158 170
159Some event loops issue spurious readyness notifications, so you should 171Some event loops issue spurious readyness notifications, so you should
160always use non-blocking calls when reading/writing from/to your file 172always use non-blocking calls when reading/writing from/to your file
161handles. 173handles.
162 174
163Example:
164
165 # wait for readability of STDIN, then read a line and disable the watcher 175Example: wait for readability of STDIN, then read a line and disable the
176watcher.
177
166 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 178 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167 chomp (my $input = <STDIN>); 179 chomp (my $input = <STDIN>);
168 warn "read: $input\n"; 180 warn "read: $input\n";
169 undef $w; 181 undef $w;
170 }); 182 });
180 192
181Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks. 195callbacks cannot use arguments passed to time watcher callbacks.
184 196
185The timer callback will be invoked at most once: if you want a repeating 197The 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 198parameter, C<interval>, as a strictly positive number (> 0), then the
187and Glib). 199callback will be invoked regularly at that interval (in fractional
200seconds) after the first invocation. If C<interval> is specified with a
201false value, then it is treated as if it were missing.
188 202
189Example: 203The callback will be rescheduled before invoking the callback, but no
204attempt is done to avoid timer drift in most backends, so the interval is
205only approximate.
190 206
191 # fire an event after 7.7 seconds 207Example: fire an event after 7.7 seconds.
208
192 my $w = AnyEvent->timer (after => 7.7, cb => sub { 209 my $w = AnyEvent->timer (after => 7.7, cb => sub {
193 warn "timeout\n"; 210 warn "timeout\n";
194 }); 211 });
195 212
196 # to cancel the timer: 213 # to cancel the timer:
197 undef $w; 214 undef $w;
198 215
199Example 2:
200
201 # fire an event after 0.5 seconds, then roughly every second 216Example 2: fire an event after 0.5 seconds, then roughly every second.
202 my $w;
203 217
204 my $cb = sub {
205 # cancel the old timer while creating a new one
206 $w = AnyEvent->timer (after => 1, cb => $cb); 218 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
219 warn "timeout\n";
207 }; 220 };
208
209 # start the "loop" by creating the first watcher
210 $w = AnyEvent->timer (after => 0.5, cb => $cb);
211 221
212=head3 TIMING ISSUES 222=head3 TIMING ISSUES
213 223
214There are two ways to handle timers: based on real time (relative, "fire 224There are two ways to handle timers: based on real time (relative, "fire
215in 10 seconds") and based on wallclock time (absolute, "fire at 12 225in 10 seconds") and based on wallclock time (absolute, "fire at 12
227timers. 237timers.
228 238
229AnyEvent always prefers relative timers, if available, matching the 239AnyEvent always prefers relative timers, if available, matching the
230AnyEvent API. 240AnyEvent API.
231 241
242AnyEvent has two additional methods that return the "current time":
243
244=over 4
245
246=item AnyEvent->time
247
248This returns the "current wallclock time" as a fractional number of
249seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
250return, and the result is guaranteed to be compatible with those).
251
252It progresses independently of any event loop processing, i.e. each call
253will check the system clock, which usually gets updated frequently.
254
255=item AnyEvent->now
256
257This also returns the "current wallclock time", but unlike C<time>, above,
258this value might change only once per event loop iteration, depending on
259the event loop (most return the same time as C<time>, above). This is the
260time that AnyEvent's timers get scheduled against.
261
262I<In almost all cases (in all cases if you don't care), this is the
263function to call when you want to know the current time.>
264
265This function is also often faster then C<< AnyEvent->time >>, and
266thus the preferred method if you want some timestamp (for example,
267L<AnyEvent::Handle> uses this to update it's activity timeouts).
268
269The rest of this section is only of relevance if you try to be very exact
270with your timing, you can skip it without bad conscience.
271
272For a practical example of when these times differ, consider L<Event::Lib>
273and L<EV> and the following set-up:
274
275The event loop is running and has just invoked one of your callback at
276time=500 (assume no other callbacks delay processing). In your callback,
277you wait a second by executing C<sleep 1> (blocking the process for a
278second) and then (at time=501) you create a relative timer that fires
279after three seconds.
280
281With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
282both return C<501>, because that is the current time, and the timer will
283be scheduled to fire at time=504 (C<501> + C<3>).
284
285With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
286time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
287last event processing phase started. With L<EV>, your timer gets scheduled
288to run at time=503 (C<500> + C<3>).
289
290In one sense, L<Event::Lib> is more exact, as it uses the current time
291regardless of any delays introduced by event processing. However, most
292callbacks do not expect large delays in processing, so this causes a
293higher drift (and a lot more system calls to get the current time).
294
295In another sense, L<EV> is more exact, as your timer will be scheduled at
296the same time, regardless of how long event processing actually took.
297
298In either case, if you care (and in most cases, you don't), then you
299can get whatever behaviour you want with any event loop, by taking the
300difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
301account.
302
303=back
304
232=head2 SIGNAL WATCHERS 305=head2 SIGNAL WATCHERS
233 306
234You can watch for signals using a signal watcher, C<signal> is the signal 307You 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 308I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236be invoked whenever a signal occurs. 309callback to be invoked whenever a signal occurs.
237 310
238Although the callback might get passed parameters, their value and 311Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 312presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 313callbacks cannot use arguments passed to signal watcher callbacks.
241 314
242Multiple signal occurances can be clumped together into one callback 315Multiple signal occurrences can be clumped together into one callback
243invocation, and callback invocation will be synchronous. synchronous means 316invocation, and callback invocation will be synchronous. Synchronous means
244that it might take a while until the signal gets handled by the process, 317that it might take a while until the signal gets handled by the process,
245but it is guarenteed not to interrupt any other callbacks. 318but it is guaranteed not to interrupt any other callbacks.
246 319
247The main advantage of using these watchers is that you can share a signal 320The main advantage of using these watchers is that you can share a signal
248between multiple watchers. 321between multiple watchers.
249 322
250This watcher might use C<%SIG>, so programs overwriting those signals 323This watcher might use C<%SIG>, so programs overwriting those signals
277AnyEvent program, you I<have> to create at least one watcher before you 350AnyEvent program, you I<have> to create at least one watcher before you
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 351C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279 352
280Example: fork a process and wait for it 353Example: fork a process and wait for it
281 354
282 my $done = AnyEvent->condvar; 355 my $done = AnyEvent->condvar;
283 356
284 AnyEvent::detect; # force event module to be initialised
285
286 my $pid = fork or exit 5; 357 my $pid = fork or exit 5;
287 358
288 my $w = AnyEvent->child ( 359 my $w = AnyEvent->child (
289 pid => $pid, 360 pid => $pid,
290 cb => sub { 361 cb => sub {
291 my ($pid, $status) = @_; 362 my ($pid, $status) = @_;
292 warn "pid $pid exited with status $status"; 363 warn "pid $pid exited with status $status";
293 $done->broadcast; 364 $done->send;
294 }, 365 },
295 ); 366 );
296 367
297 # do something else, then wait for process exit 368 # do something else, then wait for process exit
298 $done->wait; 369 $done->recv;
299 370
300=head2 CONDITION VARIABLES 371=head2 CONDITION VARIABLES
301 372
373If you are familiar with some event loops you will know that all of them
374require you to run some blocking "loop", "run" or similar function that
375will actively watch for new events and call your callbacks.
376
377AnyEvent is different, it expects somebody else to run the event loop and
378will only block when necessary (usually when told by the user).
379
380The instrument to do that is called a "condition variable", so called
381because they represent a condition that must become true.
382
302Condition variables can be created by calling the C<< AnyEvent->condvar >> 383Condition variables can be created by calling the C<< AnyEvent->condvar
303method without any arguments. 384>> method, usually without arguments. The only argument pair allowed is
385C<cb>, which specifies a callback to be called when the condition variable
386becomes true.
304 387
305A condition variable waits for a condition - precisely that the C<< 388After creation, the condition variable is "false" until it becomes "true"
306->broadcast >> method has been called. 389by calling the C<send> method (or calling the condition variable as if it
390were a callback, read about the caveats in the description for the C<<
391->send >> method).
307 392
308They are very useful to signal that a condition has been fulfilled, for 393Condition variables are similar to callbacks, except that you can
394optionally wait for them. They can also be called merge points - points
395in time where multiple outstanding events have been processed. And yet
396another way to call them is transactions - each condition variable can be
397used to represent a transaction, which finishes at some point and delivers
398a result.
399
400Condition variables are very useful to signal that something has finished,
309example, if you write a module that does asynchronous http requests, 401for example, if you write a module that does asynchronous http requests,
310then a condition variable would be the ideal candidate to signal the 402then a condition variable would be the ideal candidate to signal the
311availability of results. 403availability of results. The user can either act when the callback is
404called or can synchronously C<< ->recv >> for the results.
312 405
313You can also use condition variables to block your main program until 406You can also use them to simulate traditional event loops - for example,
314an event occurs - for example, you could C<< ->wait >> in your main 407you 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<< 408could C<< ->recv >> in your main program until the user clicks the Quit
316->broadcast >> the "quit" event. 409button of your app, which would C<< ->send >> the "quit" event.
317 410
318Note that condition variables recurse into the event loop - if you have 411Note 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 412two 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 413lose. Therefore, condition variables are good to export to your caller, but
321you should avoid making a blocking wait yourself, at least in callbacks, 414you should avoid making a blocking wait yourself, at least in callbacks,
322as this asks for trouble. 415as this asks for trouble.
323 416
324This object has two methods: 417Condition variables are represented by hash refs in perl, and the keys
418used by AnyEvent itself are all named C<_ae_XXX> to make subclassing
419easy (it is often useful to build your own transaction class on top of
420AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call
421it's C<new> method in your own C<new> method.
422
423There are two "sides" to a condition variable - the "producer side" which
424eventually calls C<< -> send >>, and the "consumer side", which waits
425for the send to occur.
426
427Example: wait for a timer.
428
429 # wait till the result is ready
430 my $result_ready = AnyEvent->condvar;
431
432 # do something such as adding a timer
433 # or socket watcher the calls $result_ready->send
434 # when the "result" is ready.
435 # in this case, we simply use a timer:
436 my $w = AnyEvent->timer (
437 after => 1,
438 cb => sub { $result_ready->send },
439 );
440
441 # this "blocks" (while handling events) till the callback
442 # calls send
443 $result_ready->recv;
444
445Example: wait for a timer, but take advantage of the fact that
446condition variables are also code references.
447
448 my $done = AnyEvent->condvar;
449 my $delay = AnyEvent->timer (after => 5, cb => $done);
450 $done->recv;
451
452=head3 METHODS FOR PRODUCERS
453
454These methods should only be used by the producing side, i.e. the
455code/module that eventually sends the signal. Note that it is also
456the producer side which creates the condvar in most cases, but it isn't
457uncommon for the consumer to create it as well.
325 458
326=over 4 459=over 4
327 460
461=item $cv->send (...)
462
463Flag the condition as ready - a running C<< ->recv >> and all further
464calls to C<recv> will (eventually) return after this method has been
465called. If nobody is waiting the send will be remembered.
466
467If a callback has been set on the condition variable, it is called
468immediately from within send.
469
470Any arguments passed to the C<send> call will be returned by all
471future C<< ->recv >> calls.
472
473Condition variables are overloaded so one can call them directly
474(as a code reference). Calling them directly is the same as calling
475C<send>. Note, however, that many C-based event loops do not handle
476overloading, so as tempting as it may be, passing a condition variable
477instead of a callback does not work. Both the pure perl and EV loops
478support overloading, however, as well as all functions that use perl to
479invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
480example).
481
482=item $cv->croak ($error)
483
484Similar to send, but causes all call's to C<< ->recv >> to invoke
485C<Carp::croak> with the given error message/object/scalar.
486
487This can be used to signal any errors to the condition variable
488user/consumer.
489
490=item $cv->begin ([group callback])
491
328=item $cv->wait 492=item $cv->end
329 493
330Wait (blocking if necessary) until the C<< ->broadcast >> method has been 494These two methods are EXPERIMENTAL and MIGHT CHANGE.
495
496These two methods can be used to combine many transactions/events into
497one. For example, a function that pings many hosts in parallel might want
498to use a condition variable for the whole process.
499
500Every call to C<< ->begin >> will increment a counter, and every call to
501C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
502>>, the (last) callback passed to C<begin> will be executed. That callback
503is I<supposed> to call C<< ->send >>, but that is not required. If no
504callback was set, C<send> will be called without any arguments.
505
506Let's clarify this with the ping example:
507
508 my $cv = AnyEvent->condvar;
509
510 my %result;
511 $cv->begin (sub { $cv->send (\%result) });
512
513 for my $host (@list_of_hosts) {
514 $cv->begin;
515 ping_host_then_call_callback $host, sub {
516 $result{$host} = ...;
517 $cv->end;
518 };
519 }
520
521 $cv->end;
522
523This code fragment supposedly pings a number of hosts and calls
524C<send> after results for all then have have been gathered - in any
525order. To achieve this, the code issues a call to C<begin> when it starts
526each ping request and calls C<end> when it has received some result for
527it. Since C<begin> and C<end> only maintain a counter, the order in which
528results arrive is not relevant.
529
530There is an additional bracketing call to C<begin> and C<end> outside the
531loop, which serves two important purposes: first, it sets the callback
532to be called once the counter reaches C<0>, and second, it ensures that
533C<send> is called even when C<no> hosts are being pinged (the loop
534doesn't execute once).
535
536This is the general pattern when you "fan out" into multiple subrequests:
537use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
538is called at least once, and then, for each subrequest you start, call
539C<begin> and for each subrequest you finish, call C<end>.
540
541=back
542
543=head3 METHODS FOR CONSUMERS
544
545These methods should only be used by the consuming side, i.e. the
546code awaits the condition.
547
548=over 4
549
550=item $cv->recv
551
552Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak
331called on c<$cv>, while servicing other watchers normally. 553>> methods have been called on c<$cv>, while servicing other watchers
554normally.
332 555
333You can only wait once on a condition - additional calls will return 556You can only wait once on a condition - additional calls are valid but
334immediately. 557will return immediately.
558
559If an error condition has been set by calling C<< ->croak >>, then this
560function will call C<croak>.
561
562In list context, all parameters passed to C<send> will be returned,
563in scalar context only the first one will be returned.
335 564
336Not all event models support a blocking wait - some die in that case 565Not 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 566(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 567using 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 568caller decide whether the call will block or not (for example, by coupling
340condition variables with some kind of request results and supporting 569condition variables with some kind of request results and supporting
341callbacks so the caller knows that getting the result will not block, 570callbacks so the caller knows that getting the result will not block,
342while still suppporting blocking waits if the caller so desires). 571while still supporting blocking waits if the caller so desires).
343 572
344Another reason I<never> to C<< ->wait >> in a module is that you cannot 573Another 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 574sensibly have two C<< ->recv >>'s in parallel, as that would require
346multiple interpreters or coroutines/threads, none of which C<AnyEvent> 575multiple interpreters or coroutines/threads, none of which C<AnyEvent>
347can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and 576can supply.
348L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
349from different coroutines, however).
350 577
351=item $cv->broadcast 578The L<Coro> module, however, I<can> and I<does> supply coroutines and, in
579fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe
580versions and also integrates coroutines into AnyEvent, making blocking
581C<< ->recv >> calls perfectly safe as long as they are done from another
582coroutine (one that doesn't run the event loop).
352 583
353Flag the condition as ready - a running C<< ->wait >> and all further 584You can ensure that C<< -recv >> never blocks by setting a callback and
354calls to C<wait> will (eventually) return after this method has been 585only calling C<< ->recv >> from within that callback (or at a later
355called. If nobody is waiting the broadcast will be remembered.. 586time). This will work even when the event loop does not support blocking
587waits otherwise.
588
589=item $bool = $cv->ready
590
591Returns true when the condition is "true", i.e. whether C<send> or
592C<croak> have been called.
593
594=item $cb = $cv->cb ([new callback])
595
596This is a mutator function that returns the callback set and optionally
597replaces it before doing so.
598
599The callback will be called when the condition becomes "true", i.e. when
600C<send> or C<croak> are called, with the only argument being the condition
601variable itself. Calling C<recv> inside the callback or at any later time
602is guaranteed not to block.
356 603
357=back 604=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 605
377=head1 GLOBAL VARIABLES AND FUNCTIONS 606=head1 GLOBAL VARIABLES AND FUNCTIONS
378 607
379=over 4 608=over 4
380 609
386C<AnyEvent::Impl:xxx> modules, but can be any other class in the case 615C<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>). 616AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
388 617
389The known classes so far are: 618The known classes so far are:
390 619
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). 620 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
394 AnyEvent::Impl::Event based on Event, second best choice. 621 AnyEvent::Impl::Event based on Event, second best choice.
395 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 622 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
396 AnyEvent::Impl::Glib based on Glib, third-best choice. 623 AnyEvent::Impl::Glib based on Glib, third-best choice.
397 AnyEvent::Impl::Tk based on Tk, very bad choice. 624 AnyEvent::Impl::Tk based on Tk, very bad choice.
414Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 641Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
415if necessary. You should only call this function right before you would 642if necessary. You should only call this function right before you would
416have created an AnyEvent watcher anyway, that is, as late as possible at 643have created an AnyEvent watcher anyway, that is, as late as possible at
417runtime. 644runtime.
418 645
646=item $guard = AnyEvent::post_detect { BLOCK }
647
648Arranges for the code block to be executed as soon as the event model is
649autodetected (or immediately if this has already happened).
650
651If called in scalar or list context, then it creates and returns an object
652that automatically removes the callback again when it is destroyed. See
653L<Coro::BDB> for a case where this is useful.
654
655=item @AnyEvent::post_detect
656
657If there are any code references in this array (you can C<push> to it
658before or after loading AnyEvent), then they will called directly after
659the event loop has been chosen.
660
661You should check C<$AnyEvent::MODEL> before adding to this array, though:
662if it contains a true value then the event loop has already been detected,
663and the array will be ignored.
664
665Best use C<AnyEvent::post_detect { BLOCK }> instead.
666
419=back 667=back
420 668
421=head1 WHAT TO DO IN A MODULE 669=head1 WHAT TO DO IN A MODULE
422 670
423As a module author, you should C<use AnyEvent> and call AnyEvent methods 671As a module author, you should C<use AnyEvent> and call AnyEvent methods
426Be careful when you create watchers in the module body - AnyEvent will 674Be 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 675decide 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 676by calling AnyEvent in your module body you force the user of your module
429to load the event module first. 677to load the event module first.
430 678
431Never call C<< ->wait >> on a condition variable unless you I<know> that 679Never call C<< ->recv >> on a condition variable unless you I<know> that
432the C<< ->broadcast >> method has been called on it already. This is 680the C<< ->send >> method has been called on it already. This is
433because it will stall the whole program, and the whole point of using 681because it will stall the whole program, and the whole point of using
434events is to stay interactive. 682events is to stay interactive.
435 683
436It is fine, however, to call C<< ->wait >> when the user of your module 684It 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 685requests 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 >> 686called C<results> that returns the results, it should call C<< ->recv >>
439freely, as the user of your module knows what she is doing. always). 687freely, as the user of your module knows what she is doing. always).
440 688
441=head1 WHAT TO DO IN THE MAIN PROGRAM 689=head1 WHAT TO DO IN THE MAIN PROGRAM
442 690
443There will always be a single main program - the only place that should 691There will always be a single main program - the only place that should
445 693
446If it doesn't care, it can just "use AnyEvent" and use it itself, or not 694If 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 695do anything special (it does not need to be event-based) and let AnyEvent
448decide which implementation to chose if some module relies on it. 696decide which implementation to chose if some module relies on it.
449 697
450If the main program relies on a specific event model. For example, in 698If 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 699Gtk2 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 700event module before loading AnyEvent or any module that uses it: generally
453speaking, you should load it as early as possible. The reason is that 701speaking, you should load it as early as possible. The reason is that
454modules might create watchers when they are loaded, and AnyEvent will 702modules 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 703decide 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. 704might chose the wrong one unless you load the correct one yourself.
457 705
458You can chose to use a rather inefficient pure-perl implementation by 706You can chose to use a pure-perl implementation by loading the
459loading the C<AnyEvent::Impl::Perl> module, which gives you similar 707C<AnyEvent::Impl::Perl> module, which gives you similar behaviour
460behaviour everywhere, but letting AnyEvent chose is generally better. 708everywhere, but letting AnyEvent chose the model is generally better.
709
710=head2 MAINLOOP EMULATION
711
712Sometimes (often for short test scripts, or even standalone programs who
713only want to use AnyEvent), you do not want to run a specific event loop.
714
715In that case, you can use a condition variable like this:
716
717 AnyEvent->condvar->recv;
718
719This has the effect of entering the event loop and looping forever.
720
721Note that usually your program has some exit condition, in which case
722it is better to use the "traditional" approach of storing a condition
723variable somewhere, waiting for it, and sending it when the program should
724exit cleanly.
725
461 726
462=head1 OTHER MODULES 727=head1 OTHER MODULES
463 728
464The following is a non-exhaustive list of additional modules that use 729The following is a non-exhaustive list of additional modules that use
465AnyEvent and can therefore be mixed easily with other AnyEvent modules 730AnyEvent and can therefore be mixed easily with other AnyEvent modules
471=item L<AnyEvent::Util> 736=item L<AnyEvent::Util>
472 737
473Contains various utility functions that replace often-used but blocking 738Contains various utility functions that replace often-used but blocking
474functions such as C<inet_aton> by event-/callback-based versions. 739functions such as C<inet_aton> by event-/callback-based versions.
475 740
741=item L<AnyEvent::Socket>
742
743Provides various utility functions for (internet protocol) sockets,
744addresses and name resolution. Also functions to create non-blocking tcp
745connections or tcp servers, with IPv6 and SRV record support and more.
746
476=item L<AnyEvent::Handle> 747=item L<AnyEvent::Handle>
477 748
478Provide read and write buffers and manages watchers for reads and writes. 749Provide read and write buffers, manages watchers for reads and writes,
750supports raw and formatted I/O, I/O queued and fully transparent and
751non-blocking SSL/TLS.
479 752
480=item L<AnyEvent::Socket> 753=item L<AnyEvent::DNS>
481 754
482Provides a means to do non-blocking connects, accepts etc. 755Provides rich asynchronous DNS resolver capabilities.
756
757=item L<AnyEvent::HTTP>
758
759A simple-to-use HTTP library that is capable of making a lot of concurrent
760HTTP requests.
483 761
484=item L<AnyEvent::HTTPD> 762=item L<AnyEvent::HTTPD>
485 763
486Provides a simple web application server framework. 764Provides a simple web application server framework.
487 765
488=item L<AnyEvent::DNS>
489
490Provides asynchronous DNS resolver capabilities, beyond what
491L<AnyEvent::Util> offers.
492
493=item L<AnyEvent::FastPing> 766=item L<AnyEvent::FastPing>
494 767
495The fastest ping in the west. 768The fastest ping in the west.
769
770=item L<AnyEvent::DBI>
771
772Executes L<DBI> requests asynchronously in a proxy process.
773
774=item L<AnyEvent::AIO>
775
776Truly asynchronous I/O, should be in the toolbox of every event
777programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
778together.
779
780=item L<AnyEvent::BDB>
781
782Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
783L<BDB> and AnyEvent together.
784
785=item L<AnyEvent::GPSD>
786
787A non-blocking interface to gpsd, a daemon delivering GPS information.
788
789=item L<AnyEvent::IGS>
790
791A non-blocking interface to the Internet Go Server protocol (used by
792L<App::IGS>).
496 793
497=item L<Net::IRC3> 794=item L<Net::IRC3>
498 795
499AnyEvent based IRC client module family. 796AnyEvent based IRC client module family.
500 797
511 808
512High level API for event-based execution flow control. 809High level API for event-based execution flow control.
513 810
514=item L<Coro> 811=item L<Coro>
515 812
516Has special support for AnyEvent. 813Has special support for AnyEvent via L<Coro::AnyEvent>.
517 814
518=item L<IO::Lambda> 815=item L<IO::Lambda>
519 816
520The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 817The 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 818
532=back 819=back
533 820
534=cut 821=cut
535 822
538no warnings; 825no warnings;
539use strict; 826use strict;
540 827
541use Carp; 828use Carp;
542 829
543our $VERSION = '3.3'; 830our $VERSION = 4.2;
544our $MODEL; 831our $MODEL;
545 832
546our $AUTOLOAD; 833our $AUTOLOAD;
547our @ISA; 834our @ISA;
548 835
836our @REGISTRY;
837
838our $WIN32;
839
840BEGIN {
841 my $win32 = ! ! ($^O =~ /mswin32/i);
842 eval "sub WIN32(){ $win32 }";
843}
844
549our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 845our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
550 846
551our @REGISTRY; 847our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
848
849{
850 my $idx;
851 $PROTOCOL{$_} = ++$idx
852 for reverse split /\s*,\s*/,
853 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
854}
552 855
553my @models = ( 856my @models = (
554 [Coro::EV:: => AnyEvent::Impl::CoroEV::],
555 [Coro::Event:: => AnyEvent::Impl::CoroEvent::],
556 [EV:: => AnyEvent::Impl::EV::], 857 [EV:: => AnyEvent::Impl::EV::],
557 [Event:: => AnyEvent::Impl::Event::], 858 [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::], 859 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
562 # everything below here will not be autoprobed as the pureperl backend should work everywhere 860 # everything below here will not be autoprobed
563 [Glib:: => AnyEvent::Impl::Glib::], 861 # as the pureperl backend should work everywhere
862 # and is usually faster
863 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
864 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
564 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 865 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
565 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 866 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
566 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 867 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
868 [Wx:: => AnyEvent::Impl::POE::],
869 [Prima:: => AnyEvent::Impl::POE::],
567); 870);
568 871
569our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); 872our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
873
874our @post_detect;
875
876sub post_detect(&) {
877 my ($cb) = @_;
878
879 if ($MODEL) {
880 $cb->();
881
882 1
883 } else {
884 push @post_detect, $cb;
885
886 defined wantarray
887 ? bless \$cb, "AnyEvent::Util::PostDetect"
888 : ()
889 }
890}
891
892sub AnyEvent::Util::PostDetect::DESTROY {
893 @post_detect = grep $_ != ${$_[0]}, @post_detect;
894}
570 895
571sub detect() { 896sub detect() {
572 unless ($MODEL) { 897 unless ($MODEL) {
573 no strict 'refs'; 898 no strict 'refs';
899 local $SIG{__DIE__};
574 900
575 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 901 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
576 my $model = "AnyEvent::Impl::$1"; 902 my $model = "AnyEvent::Impl::$1";
577 if (eval "require $model") { 903 if (eval "require $model") {
578 $MODEL = $model; 904 $MODEL = $model;
608 last; 934 last;
609 } 935 }
610 } 936 }
611 937
612 $MODEL 938 $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."; 939 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
614 } 940 }
615 } 941 }
616 942
617 unshift @ISA, $MODEL;
618 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 943 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
944
945 if ($ENV{PERL_ANYEVENT_STRICT}) {
946 unshift @AnyEvent::Base::Strict::ISA, $MODEL;
947 unshift @ISA, AnyEvent::Base::Strict::
948 } else {
949 unshift @ISA, $MODEL;
950 }
951
952 (shift @post_detect)->() while @post_detect;
619 } 953 }
620 954
621 $MODEL 955 $MODEL
622} 956}
623 957
633 $class->$func (@_); 967 $class->$func (@_);
634} 968}
635 969
636package AnyEvent::Base; 970package AnyEvent::Base;
637 971
972# default implementation for now and time
973
974use Time::HiRes ();
975
976sub time { Time::HiRes::time }
977sub now { Time::HiRes::time }
978
638# default implementation for ->condvar, ->wait, ->broadcast 979# default implementation for ->condvar
639 980
640sub condvar { 981sub condvar {
641 bless \my $flag, "AnyEvent::Base::CondVar" 982 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} 983}
651 984
652# default implementation for ->signal 985# default implementation for ->signal
653 986
654our %SIG_CB; 987our %SIG_CB;
670sub AnyEvent::Base::Signal::DESTROY { 1003sub AnyEvent::Base::Signal::DESTROY {
671 my ($signal, $cb) = @{$_[0]}; 1004 my ($signal, $cb) = @{$_[0]};
672 1005
673 delete $SIG_CB{$signal}{$cb}; 1006 delete $SIG_CB{$signal}{$cb};
674 1007
675 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1008 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
676} 1009}
677 1010
678# default implementation for ->child 1011# default implementation for ->child
679 1012
680our %PID_CB; 1013our %PID_CB;
707 or Carp::croak "required option 'pid' is missing"; 1040 or Carp::croak "required option 'pid' is missing";
708 1041
709 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1042 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
710 1043
711 unless ($WNOHANG) { 1044 unless ($WNOHANG) {
712 $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; 1045 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
713 } 1046 }
714 1047
715 unless ($CHLD_W) { 1048 unless ($CHLD_W) {
716 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1049 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
717 # child could be a zombie already, so make at least one round 1050 # child could be a zombie already, so make at least one round
726 1059
727 delete $PID_CB{$pid}{$cb}; 1060 delete $PID_CB{$pid}{$cb};
728 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1061 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
729 1062
730 undef $CHLD_W unless keys %PID_CB; 1063 undef $CHLD_W unless keys %PID_CB;
1064}
1065
1066package AnyEvent::CondVar;
1067
1068our @ISA = AnyEvent::CondVar::Base::;
1069
1070package AnyEvent::CondVar::Base;
1071
1072use overload
1073 '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1074 fallback => 1;
1075
1076sub _send {
1077 # nop
1078}
1079
1080sub send {
1081 my $cv = shift;
1082 $cv->{_ae_sent} = [@_];
1083 (delete $cv->{_ae_cb})->($cv) if $cv->{_ae_cb};
1084 $cv->_send;
1085}
1086
1087sub croak {
1088 $_[0]{_ae_croak} = $_[1];
1089 $_[0]->send;
1090}
1091
1092sub ready {
1093 $_[0]{_ae_sent}
1094}
1095
1096sub _wait {
1097 AnyEvent->one_event while !$_[0]{_ae_sent};
1098}
1099
1100sub recv {
1101 $_[0]->_wait;
1102
1103 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1104 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1105}
1106
1107sub cb {
1108 $_[0]{_ae_cb} = $_[1] if @_ > 1;
1109 $_[0]{_ae_cb}
1110}
1111
1112sub begin {
1113 ++$_[0]{_ae_counter};
1114 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1115}
1116
1117sub end {
1118 return if --$_[0]{_ae_counter};
1119 &{ $_[0]{_ae_end_cb} || sub { $_[0]->send } };
1120}
1121
1122# undocumented/compatibility with pre-3.4
1123*broadcast = \&send;
1124*wait = \&_wait;
1125
1126package AnyEvent::Base::Strict;
1127
1128use Carp qw(croak);
1129
1130# supply checks for argument validity for many functions
1131
1132sub io {
1133 my $class = shift;
1134 my %arg = @_;
1135
1136 ref $arg{cb}
1137 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
1138 delete $arg{cb};
1139
1140 fileno $arg{fh}
1141 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
1142 delete $arg{fh};
1143
1144 $arg{poll} =~ /^[rw]$/
1145 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
1146 delete $arg{poll};
1147
1148 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
1149 if keys %arg;
1150
1151 $class->SUPER::io (@_)
1152}
1153
1154sub timer {
1155 my $class = shift;
1156 my %arg = @_;
1157
1158 ref $arg{cb}
1159 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
1160 delete $arg{cb};
1161
1162 exists $arg{after}
1163 or croak "AnyEvent->timer called without mandatory 'after' parameter";
1164 delete $arg{after};
1165
1166 $arg{interval} > 0 || !$arg{interval}
1167 or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'";
1168 delete $arg{interval};
1169
1170 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
1171 if keys %arg;
1172
1173 $class->SUPER::timer (@_)
1174}
1175
1176sub signal {
1177 my $class = shift;
1178 my %arg = @_;
1179
1180 ref $arg{cb}
1181 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1182 delete $arg{cb};
1183
1184 eval "require POSIX; defined &POSIX::SIG$arg{signal}"
1185 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
1186 delete $arg{signal};
1187
1188 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1189 if keys %arg;
1190
1191 $class->SUPER::signal (@_)
1192}
1193
1194sub child {
1195 my $class = shift;
1196 my %arg = @_;
1197
1198 ref $arg{cb}
1199 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
1200 delete $arg{cb};
1201
1202 $arg{pid} =~ /^-?\d+$/
1203 or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'";
1204 delete $arg{pid};
1205
1206 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
1207 if keys %arg;
1208
1209 $class->SUPER::child (@_)
1210}
1211
1212sub condvar {
1213 my $class = shift;
1214 my %arg = @_;
1215
1216 !exists $arg{cb} or ref $arg{cb}
1217 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
1218 delete $arg{cb};
1219
1220 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
1221 if keys %arg;
1222
1223 $class->SUPER::condvar (@_)
1224}
1225
1226sub time {
1227 my $class = shift;
1228
1229 @_
1230 and croak "AnyEvent->time wrongly called with paramaters";
1231
1232 $class->SUPER::time (@_)
1233}
1234
1235sub now {
1236 my $class = shift;
1237
1238 @_
1239 and croak "AnyEvent->now wrongly called with paramaters";
1240
1241 $class->SUPER::now (@_)
731} 1242}
732 1243
733=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1244=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
734 1245
735This is an advanced topic that you do not normally need to use AnyEvent in 1246This is an advanced topic that you do not normally need to use AnyEvent in
790C<PERL_ANYEVENT_MODEL>. 1301C<PERL_ANYEVENT_MODEL>.
791 1302
792When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1303When set to C<2> or higher, cause AnyEvent to report to STDERR which event
793model it chooses. 1304model it chooses.
794 1305
1306=item C<PERL_ANYEVENT_STRICT>
1307
1308AnyEvent does not do much argument checking by default, as thorough
1309argument checking is very costly. Setting this variable to a true value
1310will cause AnyEvent to thoroughly check the arguments passed to most
1311method calls and croaks if it finds any problems. In other words, enables
1312"strict" mode. Unlike C<use strict> it is definitely recommended ot keep
1313it off in production.
1314
795=item C<PERL_ANYEVENT_MODEL> 1315=item C<PERL_ANYEVENT_MODEL>
796 1316
797This can be used to specify the event model to be used by AnyEvent, before 1317This 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 1318auto detection and -probing kicks in. It must be a string consisting
799entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1319entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
800and the resulting module name is loaded and if the load was successful, 1320and 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 1321used as event model. If it fails to load AnyEvent will proceed with
802autodetection and -probing. 1322auto detection and -probing.
803 1323
804This functionality might change in future versions. 1324This functionality might change in future versions.
805 1325
806For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1326For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
807could start your program like this: 1327could start your program like this:
808 1328
809 PERL_ANYEVENT_MODEL=Perl perl ... 1329 PERL_ANYEVENT_MODEL=Perl perl ...
1330
1331=item C<PERL_ANYEVENT_PROTOCOLS>
1332
1333Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1334for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1335of auto probing).
1336
1337Must be set to a comma-separated list of protocols or address families,
1338current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1339used, and preference will be given to protocols mentioned earlier in the
1340list.
1341
1342This variable can effectively be used for denial-of-service attacks
1343against local programs (e.g. when setuid), although the impact is likely
1344small, as the program has to handle connection errors already-
1345
1346Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1347but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1348- only support IPv4, never try to resolve or contact IPv6
1349addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1350IPv6, but prefer IPv6 over IPv4.
1351
1352=item C<PERL_ANYEVENT_EDNS0>
1353
1354Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1355for DNS. This extension is generally useful to reduce DNS traffic, but
1356some (broken) firewalls drop such DNS packets, which is why it is off by
1357default.
1358
1359Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1360EDNS0 in its DNS requests.
1361
1362=item C<PERL_ANYEVENT_MAX_FORKS>
1363
1364The maximum number of child processes that C<AnyEvent::Util::fork_call>
1365will create in parallel.
810 1366
811=back 1367=back
812 1368
813=head1 EXAMPLE PROGRAM 1369=head1 EXAMPLE PROGRAM
814 1370
825 poll => 'r', 1381 poll => 'r',
826 cb => sub { 1382 cb => sub {
827 warn "io event <$_[0]>\n"; # will always output <r> 1383 warn "io event <$_[0]>\n"; # will always output <r>
828 chomp (my $input = <STDIN>); # read a line 1384 chomp (my $input = <STDIN>); # read a line
829 warn "read: $input\n"; # output what has been read 1385 warn "read: $input\n"; # output what has been read
830 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i 1386 $cv->send if $input =~ /^q/i; # quit program if /^q/i
831 }, 1387 },
832 ); 1388 );
833 1389
834 my $time_watcher; # can only be used once 1390 my $time_watcher; # can only be used once
835 1391
840 }); 1396 });
841 } 1397 }
842 1398
843 new_timer; # create first timer 1399 new_timer; # create first timer
844 1400
845 $cv->wait; # wait until user enters /^q/i 1401 $cv->recv; # wait until user enters /^q/i
846 1402
847=head1 REAL-WORLD EXAMPLE 1403=head1 REAL-WORLD EXAMPLE
848 1404
849Consider the L<Net::FCP> module. It features (among others) the following 1405Consider the L<Net::FCP> module. It features (among others) the following
850API calls, which are to freenet what HTTP GET requests are to http: 1406API calls, which are to freenet what HTTP GET requests are to http:
900 syswrite $txn->{fh}, $txn->{request} 1456 syswrite $txn->{fh}, $txn->{request}
901 or die "connection or write error"; 1457 or die "connection or write error";
902 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); 1458 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
903 1459
904Again, C<fh_ready_r> waits till all data has arrived, and then stores the 1460Again, 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: 1461result and signals any possible waiters that the request has finished:
906 1462
907 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; 1463 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
908 1464
909 if (end-of-file or data complete) { 1465 if (end-of-file or data complete) {
910 $txn->{result} = $txn->{buf}; 1466 $txn->{result} = $txn->{buf};
911 $txn->{finished}->broadcast; 1467 $txn->{finished}->send;
912 $txb->{cb}->($txn) of $txn->{cb}; # also call callback 1468 $txb->{cb}->($txn) of $txn->{cb}; # also call callback
913 } 1469 }
914 1470
915The C<result> method, finally, just waits for the finished signal (if the 1471The 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 1472request was already finished, it doesn't wait, of course, and returns the
917data: 1473data:
918 1474
919 $txn->{finished}->wait; 1475 $txn->{finished}->recv;
920 return $txn->{result}; 1476 return $txn->{result};
921 1477
922The actual code goes further and collects all errors (C<die>s, exceptions) 1478The actual code goes further and collects all errors (C<die>s, exceptions)
923that occured during request processing. The C<result> method detects 1479that occurred during request processing. The C<result> method detects
924whether an exception as thrown (it is stored inside the $txn object) 1480whether an exception as thrown (it is stored inside the $txn object)
925and just throws the exception, which means connection errors and other 1481and 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 1482problems get reported tot he code that tries to use the result, not in a
927random callback. 1483random callback.
928 1484
959 1515
960 my $quit = AnyEvent->condvar; 1516 my $quit = AnyEvent->condvar;
961 1517
962 $fcp->txn_client_get ($url)->cb (sub { 1518 $fcp->txn_client_get ($url)->cb (sub {
963 ... 1519 ...
964 $quit->broadcast; 1520 $quit->send;
965 }); 1521 });
966 1522
967 $quit->wait; 1523 $quit->recv;
968 1524
969 1525
970=head1 BENCHMARKS 1526=head1 BENCHMARKS
971 1527
972To give you an idea of the performance and overheads that AnyEvent adds 1528To give you an idea of the performance and overheads that AnyEvent adds
974of various event loops I prepared some benchmarks. 1530of various event loops I prepared some benchmarks.
975 1531
976=head2 BENCHMARKING ANYEVENT OVERHEAD 1532=head2 BENCHMARKING ANYEVENT OVERHEAD
977 1533
978Here is a benchmark of various supported event models used natively and 1534Here is a benchmark of various supported event models used natively and
979through anyevent. The benchmark creates a lot of timers (with a zero 1535through AnyEvent. The benchmark creates a lot of timers (with a zero
980timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1536timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
981which it is), lets them fire exactly once and destroys them again. 1537which it is), lets them fire exactly once and destroys them again.
982 1538
983Source code for this benchmark is found as F<eg/bench> in the AnyEvent 1539Source code for this benchmark is found as F<eg/bench> in the AnyEvent
984distribution. 1540distribution.
1001all watchers, to avoid adding memory overhead. That means closure creation 1557all watchers, to avoid adding memory overhead. That means closure creation
1002and memory usage is not included in the figures. 1558and memory usage is not included in the figures.
1003 1559
1004I<invoke> is the time, in microseconds, used to invoke a simple 1560I<invoke> is the time, in microseconds, used to invoke a simple
1005callback. The callback simply counts down a Perl variable and after it was 1561callback. The callback simply counts down a Perl variable and after it was
1006invoked "watcher" times, it would C<< ->broadcast >> a condvar once to 1562invoked "watcher" times, it would C<< ->send >> a condvar once to
1007signal the end of this phase. 1563signal the end of this phase.
1008 1564
1009I<destroy> is the time, in microseconds, that it takes to destroy a single 1565I<destroy> is the time, in microseconds, that it takes to destroy a single
1010watcher. 1566watcher.
1011 1567
1107 1663
1108=back 1664=back
1109 1665
1110=head2 BENCHMARKING THE LARGE SERVER CASE 1666=head2 BENCHMARKING THE LARGE SERVER CASE
1111 1667
1112This benchmark atcually benchmarks the event loop itself. It works by 1668This benchmark actually benchmarks the event loop itself. It works by
1113creating a number of "servers": each server consists of a socketpair, a 1669creating 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 1670timeout 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 1671watcher 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". 1672watcher reads a byte it will write that byte to a random other "server".
1117 1673
1118The effect is that there will be a lot of I/O watchers, only part of which 1674The 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 1675are 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 1676fds for each loop iteration, but which fds these are is random). The
1121timeout is reset each time something is read because that reflects how 1677timeout is reset each time something is read because that reflects how
1122most timeouts work (and puts extra pressure on the event loops). 1678most timeouts work (and puts extra pressure on the event loops).
1123 1679
1124In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 1680In 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 1681(1%) are active. This mirrors the activity of large servers with many
1126connections, most of which are idle at any one point in time. 1682connections, most of which are idle at any one point in time.
1127 1683
1128Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 1684Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1129distribution. 1685distribution.
1131=head3 Explanation of the columns 1687=head3 Explanation of the columns
1132 1688
1133I<sockets> is the number of sockets, and twice the number of "servers" (as 1689I<sockets> is the number of sockets, and twice the number of "servers" (as
1134each server has a read and write socket end). 1690each server has a read and write socket end).
1135 1691
1136I<create> is the time it takes to create a socketpair (which is 1692I<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. 1693nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1138 1694
1139I<request>, the most important value, is the time it takes to handle a 1695I<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 1696single "request", that is, reading the token from the pipe and forwarding
1141it to another server. This includes deleting the old timeout and creating 1697it 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 1770speed most when you have lots of watchers, not when you only have a few of
1215them). 1771them).
1216 1772
1217EV is again fastest. 1773EV is again fastest.
1218 1774
1219Perl again comes second. It is noticably faster than the C-based event 1775Perl again comes second. It is noticeably faster than the C-based event
1220loops Event and Glib, although the difference is too small to really 1776loops Event and Glib, although the difference is too small to really
1221matter. 1777matter.
1222 1778
1223POE also performs much better in this case, but is is still far behind the 1779POE also performs much better in this case, but is is still far behind the
1224others. 1780others.
1253specified in the variable. 1809specified in the variable.
1254 1810
1255You can make AnyEvent completely ignore this variable by deleting it 1811You can make AnyEvent completely ignore this variable by deleting it
1256before the first watcher gets created, e.g. with a C<BEGIN> block: 1812before the first watcher gets created, e.g. with a C<BEGIN> block:
1257 1813
1258 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1814 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1259 1815
1260 use AnyEvent; 1816 use AnyEvent;
1817
1818Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1819be used to probe what backend is used and gain other information (which is
1820probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1821$ENV{PERL_ANYEGENT_STRICT}.
1822
1823
1824=head1 BUGS
1825
1826Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1827to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1828and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1829mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1830pronounced).
1261 1831
1262 1832
1263=head1 SEE ALSO 1833=head1 SEE ALSO
1264 1834
1265Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, 1835Utility functions: L<AnyEvent::Util>.
1266L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, 1836
1837Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>,
1267L<Event::Lib>, L<Qt>, L<POE>. 1838L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
1268 1839
1269Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, 1840Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
1270L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, 1841L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
1271L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, 1842L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
1272L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. 1843L<AnyEvent::Impl::POE>.
1273 1844
1845Non-blocking file handles, sockets, TCP clients and
1846servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.
1847
1848Asynchronous DNS: L<AnyEvent::DNS>.
1849
1850Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,
1851
1274Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 1852Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1275 1853
1276 1854
1277=head1 AUTHOR 1855=head1 AUTHOR
1278 1856
1279 Marc Lehmann <schmorp@schmorp.de> 1857 Marc Lehmann <schmorp@schmorp.de>
1280 http://home.schmorp.de/ 1858 http://home.schmorp.de/
1281 1859
1282=cut 1860=cut
1283 1861
12841 18621
1285 1863

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines