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.142 by root, Tue May 27 02:34:30 2008 UTC vs.
Revision 1.198 by root, Thu Mar 26 20:17:44 2009 UTC

1=head1 => NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 use AnyEvent; 9 use AnyEvent;
10 10
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... });
12 ...
13 });
14 12
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 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) = @_;
16 ... 23 ...
17 }); 24 });
18 25
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 26 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 27 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 28 $w->recv; # enters "main loop" till $condvar gets ->send
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 enormous 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
121These watchers are normal Perl objects with normal Perl lifetime. After 137These watchers are normal Perl objects with normal Perl lifetime. After
122creating a watcher it will immediately "watch" for events and invoke the 138creating a watcher it will immediately "watch" for events and invoke the
123callback when the event occurs (of course, only when the event model 139callback when the event occurs (of course, only when the event model
124is in control). 140is in control).
125 141
142Note that B<callbacks must not permanently change global variables>
143potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
144callbacks must not C<die> >>. The former is good programming practise in
145Perl and the latter stems from the fact that exception handling differs
146widely between event loops.
147
126To disable the watcher you have to destroy it (e.g. by setting the 148To disable the watcher you have to destroy it (e.g. by setting the
127variable you store it in to C<undef> or otherwise deleting all references 149variable you store it in to C<undef> or otherwise deleting all references
128to it). 150to it).
129 151
130All watchers are created by calling a method on the C<AnyEvent> class. 152All watchers are created by calling a method on the C<AnyEvent> class.
132Many watchers either are used with "recursion" (repeating timers for 154Many watchers either are used with "recursion" (repeating timers for
133example), or need to refer to their watcher object in other ways. 155example), or need to refer to their watcher object in other ways.
134 156
135An any way to achieve that is this pattern: 157An any way to achieve that is this pattern:
136 158
137 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 159 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
138 # you can use $w here, for example to undef it 160 # you can use $w here, for example to undef it
139 undef $w; 161 undef $w;
140 }); 162 });
141 163
142Note that C<my $w; $w => combination. This is necessary because in Perl, 164Note that C<my $w; $w => combination. This is necessary because in Perl,
143my variables are only visible after the statement in which they are 165my variables are only visible after the statement in which they are
144declared. 166declared.
145 167
146=head2 I/O WATCHERS 168=head2 I/O WATCHERS
147 169
148You can create an I/O watcher by calling the C<< AnyEvent->io >> method 170You can create an I/O watcher by calling the C<< AnyEvent->io >> method
149with the following mandatory key-value pairs as arguments: 171with the following mandatory key-value pairs as arguments:
150 172
151C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 173C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
152for events. C<poll> must be a string that is either C<r> or C<w>, 174(AnyEvent might or might not keep a reference to this file handle). C<poll>
153which creates a watcher waiting for "r"eadable or "w"ritable events, 175must be a string that is either C<r> or C<w>, which creates a watcher
154respectively. C<cb> is the callback to invoke each time the file handle 176waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
155becomes ready. 177callback to invoke each time the file handle becomes ready.
156 178
157Although the callback might get passed parameters, their value and 179Although the callback might get passed parameters, their value and
158presence is undefined and you cannot rely on them. Portable AnyEvent 180presence is undefined and you cannot rely on them. Portable AnyEvent
159callbacks cannot use arguments passed to I/O watcher callbacks. 181callbacks cannot use arguments passed to I/O watcher callbacks.
160 182
164 186
165Some event loops issue spurious readyness notifications, so you should 187Some event loops issue spurious readyness notifications, so you should
166always use non-blocking calls when reading/writing from/to your file 188always use non-blocking calls when reading/writing from/to your file
167handles. 189handles.
168 190
169Example:
170
171 # wait for readability of STDIN, then read a line and disable the watcher 191Example: wait for readability of STDIN, then read a line and disable the
192watcher.
193
172 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 194 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
173 chomp (my $input = <STDIN>); 195 chomp (my $input = <STDIN>);
174 warn "read: $input\n"; 196 warn "read: $input\n";
175 undef $w; 197 undef $w;
176 }); 198 });
186 208
187Although the callback might get passed parameters, their value and 209Although the callback might get passed parameters, their value and
188presence is undefined and you cannot rely on them. Portable AnyEvent 210presence is undefined and you cannot rely on them. Portable AnyEvent
189callbacks cannot use arguments passed to time watcher callbacks. 211callbacks cannot use arguments passed to time watcher callbacks.
190 212
191The timer callback will be invoked at most once: if you want a repeating 213The callback will normally be invoked once only. If you specify another
192timer you have to create a new watcher (this is a limitation by both Tk 214parameter, C<interval>, as a strictly positive number (> 0), then the
193and Glib). 215callback will be invoked regularly at that interval (in fractional
216seconds) after the first invocation. If C<interval> is specified with a
217false value, then it is treated as if it were missing.
194 218
195Example: 219The callback will be rescheduled before invoking the callback, but no
220attempt is done to avoid timer drift in most backends, so the interval is
221only approximate.
196 222
197 # fire an event after 7.7 seconds 223Example: fire an event after 7.7 seconds.
224
198 my $w = AnyEvent->timer (after => 7.7, cb => sub { 225 my $w = AnyEvent->timer (after => 7.7, cb => sub {
199 warn "timeout\n"; 226 warn "timeout\n";
200 }); 227 });
201 228
202 # to cancel the timer: 229 # to cancel the timer:
203 undef $w; 230 undef $w;
204 231
205Example 2:
206
207 # fire an event after 0.5 seconds, then roughly every second 232Example 2: fire an event after 0.5 seconds, then roughly every second.
208 my $w;
209 233
210 my $cb = sub {
211 # cancel the old timer while creating a new one
212 $w = AnyEvent->timer (after => 1, cb => $cb); 234 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
235 warn "timeout\n";
213 }; 236 };
214
215 # start the "loop" by creating the first watcher
216 $w = AnyEvent->timer (after => 0.5, cb => $cb);
217 237
218=head3 TIMING ISSUES 238=head3 TIMING ISSUES
219 239
220There are two ways to handle timers: based on real time (relative, "fire 240There are two ways to handle timers: based on real time (relative, "fire
221in 10 seconds") and based on wallclock time (absolute, "fire at 12 241in 10 seconds") and based on wallclock time (absolute, "fire at 12
233timers. 253timers.
234 254
235AnyEvent always prefers relative timers, if available, matching the 255AnyEvent always prefers relative timers, if available, matching the
236AnyEvent API. 256AnyEvent API.
237 257
258AnyEvent has two additional methods that return the "current time":
259
260=over 4
261
262=item AnyEvent->time
263
264This returns the "current wallclock time" as a fractional number of
265seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
266return, and the result is guaranteed to be compatible with those).
267
268It progresses independently of any event loop processing, i.e. each call
269will check the system clock, which usually gets updated frequently.
270
271=item AnyEvent->now
272
273This also returns the "current wallclock time", but unlike C<time>, above,
274this value might change only once per event loop iteration, depending on
275the event loop (most return the same time as C<time>, above). This is the
276time that AnyEvent's timers get scheduled against.
277
278I<In almost all cases (in all cases if you don't care), this is the
279function to call when you want to know the current time.>
280
281This function is also often faster then C<< AnyEvent->time >>, and
282thus the preferred method if you want some timestamp (for example,
283L<AnyEvent::Handle> uses this to update it's activity timeouts).
284
285The rest of this section is only of relevance if you try to be very exact
286with your timing, you can skip it without bad conscience.
287
288For a practical example of when these times differ, consider L<Event::Lib>
289and L<EV> and the following set-up:
290
291The event loop is running and has just invoked one of your callback at
292time=500 (assume no other callbacks delay processing). In your callback,
293you wait a second by executing C<sleep 1> (blocking the process for a
294second) and then (at time=501) you create a relative timer that fires
295after three seconds.
296
297With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
298both return C<501>, because that is the current time, and the timer will
299be scheduled to fire at time=504 (C<501> + C<3>).
300
301With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
302time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
303last event processing phase started. With L<EV>, your timer gets scheduled
304to run at time=503 (C<500> + C<3>).
305
306In one sense, L<Event::Lib> is more exact, as it uses the current time
307regardless of any delays introduced by event processing. However, most
308callbacks do not expect large delays in processing, so this causes a
309higher drift (and a lot more system calls to get the current time).
310
311In another sense, L<EV> is more exact, as your timer will be scheduled at
312the same time, regardless of how long event processing actually took.
313
314In either case, if you care (and in most cases, you don't), then you
315can get whatever behaviour you want with any event loop, by taking the
316difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317account.
318
319=back
320
238=head2 SIGNAL WATCHERS 321=head2 SIGNAL WATCHERS
239 322
240You can watch for signals using a signal watcher, C<signal> is the signal 323You can watch for signals using a signal watcher, C<signal> is the signal
241I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 324I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
242be invoked whenever a signal occurs. 325callback to be invoked whenever a signal occurs.
243 326
244Although the callback might get passed parameters, their value and 327Although the callback might get passed parameters, their value and
245presence is undefined and you cannot rely on them. Portable AnyEvent 328presence is undefined and you cannot rely on them. Portable AnyEvent
246callbacks cannot use arguments passed to signal watcher callbacks. 329callbacks cannot use arguments passed to signal watcher callbacks.
247 330
263=head2 CHILD PROCESS WATCHERS 346=head2 CHILD PROCESS WATCHERS
264 347
265You can also watch on a child process exit and catch its exit status. 348You can also watch on a child process exit and catch its exit status.
266 349
267The child process is specified by the C<pid> argument (if set to C<0>, it 350The child process is specified by the C<pid> argument (if set to C<0>, it
268watches for any child process exit). The watcher will trigger as often 351watches for any child process exit). The watcher will triggered only when
269as status change for the child are received. This works by installing a 352the child process has finished and an exit status is available, not on
270signal handler for C<SIGCHLD>. The callback will be called with the pid 353any trace events (stopped/continued).
271and exit status (as returned by waitpid), so unlike other watcher types, 354
272you I<can> rely on child watcher callback arguments. 355The callback will be called with the pid and exit status (as returned by
356waitpid), so unlike other watcher types, you I<can> rely on child watcher
357callback arguments.
358
359This watcher type works by installing a signal handler for C<SIGCHLD>,
360and since it cannot be shared, nothing else should use SIGCHLD or reap
361random child processes (waiting for specific child processes, e.g. inside
362C<system>, is just fine).
273 363
274There is a slight catch to child watchers, however: you usually start them 364There is a slight catch to child watchers, however: you usually start them
275I<after> the child process was created, and this means the process could 365I<after> the child process was created, and this means the process could
276have exited already (and no SIGCHLD will be sent anymore). 366have exited already (and no SIGCHLD will be sent anymore).
277 367
283AnyEvent program, you I<have> to create at least one watcher before you 373AnyEvent program, you I<have> to create at least one watcher before you
284C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 374C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
285 375
286Example: fork a process and wait for it 376Example: fork a process and wait for it
287 377
288 my $done = AnyEvent->condvar; 378 my $done = AnyEvent->condvar;
289 379
290 my $pid = fork or exit 5; 380 my $pid = fork or exit 5;
291 381
292 my $w = AnyEvent->child ( 382 my $w = AnyEvent->child (
293 pid => $pid, 383 pid => $pid,
294 cb => sub { 384 cb => sub {
295 my ($pid, $status) = @_; 385 my ($pid, $status) = @_;
296 warn "pid $pid exited with status $status"; 386 warn "pid $pid exited with status $status";
297 $done->send; 387 $done->send;
298 }, 388 },
299 ); 389 );
300 390
301 # do something else, then wait for process exit 391 # do something else, then wait for process exit
302 $done->recv; 392 $done->recv;
303 393
304=head2 CONDITION VARIABLES 394=head2 CONDITION VARIABLES
305 395
306If you are familiar with some event loops you will know that all of them 396If you are familiar with some event loops you will know that all of them
307require you to run some blocking "loop", "run" or similar function that 397require you to run some blocking "loop", "run" or similar function that
313The instrument to do that is called a "condition variable", so called 403The instrument to do that is called a "condition variable", so called
314because they represent a condition that must become true. 404because they represent a condition that must become true.
315 405
316Condition variables can be created by calling the C<< AnyEvent->condvar 406Condition variables can be created by calling the C<< AnyEvent->condvar
317>> method, usually without arguments. The only argument pair allowed is 407>> method, usually without arguments. The only argument pair allowed is
408
318C<cb>, which specifies a callback to be called when the condition variable 409C<cb>, which specifies a callback to be called when the condition variable
319becomes true. 410becomes true, with the condition variable as the first argument (but not
411the results).
320 412
321After creation, the condition variable is "false" until it becomes "true" 413After creation, the condition variable is "false" until it becomes "true"
322by calling the C<send> method (or calling the condition variable as if it 414by calling the C<send> method (or calling the condition variable as if it
323were a callback, read about the caveats in the description for the C<< 415were a callback, read about the caveats in the description for the C<<
324->send >> method). 416->send >> method).
380 472
381 my $done = AnyEvent->condvar; 473 my $done = AnyEvent->condvar;
382 my $delay = AnyEvent->timer (after => 5, cb => $done); 474 my $delay = AnyEvent->timer (after => 5, cb => $done);
383 $done->recv; 475 $done->recv;
384 476
477Example: Imagine an API that returns a condvar and doesn't support
478callbacks. This is how you make a synchronous call, for example from
479the main program:
480
481 use AnyEvent::CouchDB;
482
483 ...
484
485 my @info = $couchdb->info->recv;
486
487And this is how you would just ste a callback to be called whenever the
488results are available:
489
490 $couchdb->info->cb (sub {
491 my @info = $_[0]->recv;
492 });
493
385=head3 METHODS FOR PRODUCERS 494=head3 METHODS FOR PRODUCERS
386 495
387These methods should only be used by the producing side, i.e. the 496These methods should only be used by the producing side, i.e. the
388code/module that eventually sends the signal. Note that it is also 497code/module that eventually sends the signal. Note that it is also
389the producer side which creates the condvar in most cases, but it isn't 498the producer side which creates the condvar in most cases, but it isn't
522=item $bool = $cv->ready 631=item $bool = $cv->ready
523 632
524Returns true when the condition is "true", i.e. whether C<send> or 633Returns true when the condition is "true", i.e. whether C<send> or
525C<croak> have been called. 634C<croak> have been called.
526 635
527=item $cb = $cv->cb ([new callback]) 636=item $cb = $cv->cb ($cb->($cv))
528 637
529This is a mutator function that returns the callback set and optionally 638This is a mutator function that returns the callback set and optionally
530replaces it before doing so. 639replaces it before doing so.
531 640
532The callback will be called when the condition becomes "true", i.e. when 641The callback will be called when the condition becomes "true", i.e. when
533C<send> or C<croak> are called. Calling C<recv> inside the callback 642C<send> or C<croak> are called, with the only argument being the condition
534or at any later time is guaranteed not to block. 643variable itself. Calling C<recv> inside the callback or at any later time
644is guaranteed not to block.
535 645
536=back 646=back
537 647
538=head1 GLOBAL VARIABLES AND FUNCTIONS 648=head1 GLOBAL VARIABLES AND FUNCTIONS
539 649
668=item L<AnyEvent::Util> 778=item L<AnyEvent::Util>
669 779
670Contains various utility functions that replace often-used but blocking 780Contains various utility functions that replace often-used but blocking
671functions such as C<inet_aton> by event-/callback-based versions. 781functions such as C<inet_aton> by event-/callback-based versions.
672 782
673=item L<AnyEvent::Handle>
674
675Provide read and write buffers and manages watchers for reads and writes.
676
677=item L<AnyEvent::Socket> 783=item L<AnyEvent::Socket>
678 784
679Provides various utility functions for (internet protocol) sockets, 785Provides various utility functions for (internet protocol) sockets,
680addresses and name resolution. Also functions to create non-blocking tcp 786addresses and name resolution. Also functions to create non-blocking tcp
681connections or tcp servers, with IPv6 and SRV record support and more. 787connections or tcp servers, with IPv6 and SRV record support and more.
682 788
789=item L<AnyEvent::Handle>
790
791Provide read and write buffers, manages watchers for reads and writes,
792supports raw and formatted I/O, I/O queued and fully transparent and
793non-blocking SSL/TLS.
794
683=item L<AnyEvent::DNS> 795=item L<AnyEvent::DNS>
684 796
685Provides rich asynchronous DNS resolver capabilities. 797Provides rich asynchronous DNS resolver capabilities.
686 798
799=item L<AnyEvent::HTTP>
800
801A simple-to-use HTTP library that is capable of making a lot of concurrent
802HTTP requests.
803
687=item L<AnyEvent::HTTPD> 804=item L<AnyEvent::HTTPD>
688 805
689Provides a simple web application server framework. 806Provides a simple web application server framework.
690 807
691=item L<AnyEvent::FastPing> 808=item L<AnyEvent::FastPing>
692 809
693The fastest ping in the west. 810The fastest ping in the west.
694 811
812=item L<AnyEvent::DBI>
813
814Executes L<DBI> requests asynchronously in a proxy process.
815
816=item L<AnyEvent::AIO>
817
818Truly asynchronous I/O, should be in the toolbox of every event
819programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
820together.
821
822=item L<AnyEvent::BDB>
823
824Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
825L<BDB> and AnyEvent together.
826
827=item L<AnyEvent::GPSD>
828
829A non-blocking interface to gpsd, a daemon delivering GPS information.
830
831=item L<AnyEvent::IGS>
832
833A non-blocking interface to the Internet Go Server protocol (used by
834L<App::IGS>).
835
695=item L<Net::IRC3> 836=item L<AnyEvent::IRC>
696 837
697AnyEvent based IRC client module family. 838AnyEvent based IRC client module family (replacing the older Net::IRC3).
698 839
699=item L<Net::XMPP2> 840=item L<Net::XMPP2>
700 841
701AnyEvent based XMPP (Jabber protocol) module family. 842AnyEvent based XMPP (Jabber protocol) module family.
702 843
711 852
712=item L<Coro> 853=item L<Coro>
713 854
714Has special support for AnyEvent via L<Coro::AnyEvent>. 855Has special support for AnyEvent via L<Coro::AnyEvent>.
715 856
716=item L<AnyEvent::AIO>, L<IO::AIO>
717
718Truly asynchronous I/O, should be in the toolbox of every event
719programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
720together.
721
722=item L<AnyEvent::BDB>, L<BDB>
723
724Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
725IO::AIO and AnyEvent together.
726
727=item L<IO::Lambda> 857=item L<IO::Lambda>
728 858
729The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 859The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
730 860
731=back 861=back
733=cut 863=cut
734 864
735package AnyEvent; 865package AnyEvent;
736 866
737no warnings; 867no warnings;
738use strict; 868use strict qw(vars subs);
739 869
740use Carp; 870use Carp;
741 871
742our $VERSION = '4.05'; 872our $VERSION = 4.341;
743our $MODEL; 873our $MODEL;
744 874
745our $AUTOLOAD; 875our $AUTOLOAD;
746our @ISA; 876our @ISA;
747 877
779 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 909 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
780 [Wx:: => AnyEvent::Impl::POE::], 910 [Wx:: => AnyEvent::Impl::POE::],
781 [Prima:: => AnyEvent::Impl::POE::], 911 [Prima:: => AnyEvent::Impl::POE::],
782); 912);
783 913
784our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 914our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
785 915
786our @post_detect; 916our @post_detect;
787 917
788sub post_detect(&) { 918sub post_detect(&) {
789 my ($cb) = @_; 919 my ($cb) = @_;
850 $MODEL 980 $MODEL
851 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 981 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
852 } 982 }
853 } 983 }
854 984
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986
855 unshift @ISA, $MODEL; 987 unshift @ISA, $MODEL;
856 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 988
989 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
857 990
858 (shift @post_detect)->() while @post_detect; 991 (shift @post_detect)->() while @post_detect;
859 } 992 }
860 993
861 $MODEL 994 $MODEL
871 1004
872 my $class = shift; 1005 my $class = shift;
873 $class->$func (@_); 1006 $class->$func (@_);
874} 1007}
875 1008
1009# utility function to dup a filehandle. this is used by many backends
1010# to support binding more than one watcher per filehandle (they usually
1011# allow only one watcher per fd, so we dup it to get a different one).
1012sub _dupfh($$$$) {
1013 my ($poll, $fh, $r, $w) = @_;
1014
1015 # cygwin requires the fh mode to be matching, unix doesn't
1016 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1017 : $poll eq "w" ? ($w, ">")
1018 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1019
1020 open my $fh2, "$mode&" . fileno $fh
1021 or die "cannot dup() filehandle: $!";
1022
1023 # we assume CLOEXEC is already set by perl in all important cases
1024
1025 ($fh2, $rw)
1026}
1027
876package AnyEvent::Base; 1028package AnyEvent::Base;
1029
1030# default implementation for now and time
1031
1032BEGIN {
1033 if (eval "use Time::HiRes (); time (); 1") {
1034 *_time = \&Time::HiRes::time;
1035 # if (eval "use POSIX (); (POSIX::times())...
1036 } else {
1037 *_time = sub { time }; # epic fail
1038 }
1039}
1040
1041sub time { _time }
1042sub now { _time }
877 1043
878# default implementation for ->condvar 1044# default implementation for ->condvar
879 1045
880sub condvar { 1046sub condvar {
881 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
882} 1048}
883 1049
884# default implementation for ->signal 1050# default implementation for ->signal
885 1051
886our %SIG_CB; 1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1053
1054sub _signal_exec {
1055 sysread $SIGPIPE_R, my $dummy, 4;
1056
1057 while (%SIG_EV) {
1058 for (keys %SIG_EV) {
1059 delete $SIG_EV{$_};
1060 $_->() for values %{ $SIG_CB{$_} || {} };
1061 }
1062 }
1063}
887 1064
888sub signal { 1065sub signal {
889 my (undef, %arg) = @_; 1066 my (undef, %arg) = @_;
890 1067
1068 unless ($SIGPIPE_R) {
1069 if (AnyEvent::WIN32) {
1070 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1071 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1072 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1073 } else {
1074 pipe $SIGPIPE_R, $SIGPIPE_W;
1075 require Fcntl;
1076 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1077 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1078 }
1079
1080 $SIGPIPE_R
1081 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1082
1083 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1084 }
1085
891 my $signal = uc $arg{signal} 1086 my $signal = uc $arg{signal}
892 or Carp::croak "required option 'signal' is missing"; 1087 or Carp::croak "required option 'signal' is missing";
893 1088
894 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1089 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
895 $SIG{$signal} ||= sub { 1090 $SIG{$signal} ||= sub {
896 $_->() for values %{ $SIG_CB{$signal} || {} }; 1091 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1092 undef $SIG_EV{$signal};
897 }; 1093 };
898 1094
899 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1095 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
900} 1096}
901 1097
902sub AnyEvent::Base::Signal::DESTROY { 1098sub AnyEvent::Base::Signal::DESTROY {
903 my ($signal, $cb) = @{$_[0]}; 1099 my ($signal, $cb) = @{$_[0]};
904 1100
905 delete $SIG_CB{$signal}{$cb}; 1101 delete $SIG_CB{$signal}{$cb};
906 1102
907 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1103 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
908} 1104}
909 1105
910# default implementation for ->child 1106# default implementation for ->child
911 1107
912our %PID_CB; 1108our %PID_CB;
1020 1216
1021# undocumented/compatibility with pre-3.4 1217# undocumented/compatibility with pre-3.4
1022*broadcast = \&send; 1218*broadcast = \&send;
1023*wait = \&_wait; 1219*wait = \&_wait;
1024 1220
1221=head1 ERROR AND EXCEPTION HANDLING
1222
1223In general, AnyEvent does not do any error handling - it relies on the
1224caller to do that if required. The L<AnyEvent::Strict> module (see also
1225the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1226checking of all AnyEvent methods, however, which is highly useful during
1227development.
1228
1229As for exception handling (i.e. runtime errors and exceptions thrown while
1230executing a callback), this is not only highly event-loop specific, but
1231also not in any way wrapped by this module, as this is the job of the main
1232program.
1233
1234The pure perl event loop simply re-throws the exception (usually
1235within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1236$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1237so on.
1238
1239=head1 ENVIRONMENT VARIABLES
1240
1241The following environment variables are used by this module or its
1242submodules:
1243
1244=over 4
1245
1246=item C<PERL_ANYEVENT_VERBOSE>
1247
1248By default, AnyEvent will be completely silent except in fatal
1249conditions. You can set this environment variable to make AnyEvent more
1250talkative.
1251
1252When set to C<1> or higher, causes AnyEvent to warn about unexpected
1253conditions, such as not being able to load the event model specified by
1254C<PERL_ANYEVENT_MODEL>.
1255
1256When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1257model it chooses.
1258
1259=item C<PERL_ANYEVENT_STRICT>
1260
1261AnyEvent does not do much argument checking by default, as thorough
1262argument checking is very costly. Setting this variable to a true value
1263will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1264check the arguments passed to most method calls. If it finds any problems
1265it will croak.
1266
1267In other words, enables "strict" mode.
1268
1269Unlike C<use strict>, it is definitely recommended ot keep it off in
1270production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1271developing programs can be very useful, however.
1272
1273=item C<PERL_ANYEVENT_MODEL>
1274
1275This can be used to specify the event model to be used by AnyEvent, before
1276auto detection and -probing kicks in. It must be a string consisting
1277entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1278and the resulting module name is loaded and if the load was successful,
1279used as event model. If it fails to load AnyEvent will proceed with
1280auto detection and -probing.
1281
1282This functionality might change in future versions.
1283
1284For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1285could start your program like this:
1286
1287 PERL_ANYEVENT_MODEL=Perl perl ...
1288
1289=item C<PERL_ANYEVENT_PROTOCOLS>
1290
1291Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1292for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1293of auto probing).
1294
1295Must be set to a comma-separated list of protocols or address families,
1296current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1297used, and preference will be given to protocols mentioned earlier in the
1298list.
1299
1300This variable can effectively be used for denial-of-service attacks
1301against local programs (e.g. when setuid), although the impact is likely
1302small, as the program has to handle conenction and other failures anyways.
1303
1304Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1305but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1306- only support IPv4, never try to resolve or contact IPv6
1307addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1308IPv6, but prefer IPv6 over IPv4.
1309
1310=item C<PERL_ANYEVENT_EDNS0>
1311
1312Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1313for DNS. This extension is generally useful to reduce DNS traffic, but
1314some (broken) firewalls drop such DNS packets, which is why it is off by
1315default.
1316
1317Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1318EDNS0 in its DNS requests.
1319
1320=item C<PERL_ANYEVENT_MAX_FORKS>
1321
1322The maximum number of child processes that C<AnyEvent::Util::fork_call>
1323will create in parallel.
1324
1325=back
1326
1025=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1327=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1026 1328
1027This is an advanced topic that you do not normally need to use AnyEvent in 1329This is an advanced topic that you do not normally need to use AnyEvent in
1028a module. This section is only of use to event loop authors who want to 1330a module. This section is only of use to event loop authors who want to
1029provide AnyEvent compatibility. 1331provide AnyEvent compatibility.
1062 1364
1063I<rxvt-unicode> also cheats a bit by not providing blocking access to 1365I<rxvt-unicode> also cheats a bit by not providing blocking access to
1064condition variables: code blocking while waiting for a condition will 1366condition variables: code blocking while waiting for a condition will
1065C<die>. This still works with most modules/usages, and blocking calls must 1367C<die>. This still works with most modules/usages, and blocking calls must
1066not be done in an interactive application, so it makes sense. 1368not be done in an interactive application, so it makes sense.
1067
1068=head1 ENVIRONMENT VARIABLES
1069
1070The following environment variables are used by this module:
1071
1072=over 4
1073
1074=item C<PERL_ANYEVENT_VERBOSE>
1075
1076By default, AnyEvent will be completely silent except in fatal
1077conditions. You can set this environment variable to make AnyEvent more
1078talkative.
1079
1080When set to C<1> or higher, causes AnyEvent to warn about unexpected
1081conditions, such as not being able to load the event model specified by
1082C<PERL_ANYEVENT_MODEL>.
1083
1084When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1085model it chooses.
1086
1087=item C<PERL_ANYEVENT_MODEL>
1088
1089This can be used to specify the event model to be used by AnyEvent, before
1090auto detection and -probing kicks in. It must be a string consisting
1091entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1092and the resulting module name is loaded and if the load was successful,
1093used as event model. If it fails to load AnyEvent will proceed with
1094auto detection and -probing.
1095
1096This functionality might change in future versions.
1097
1098For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1099could start your program like this:
1100
1101 PERL_ANYEVENT_MODEL=Perl perl ...
1102
1103=item C<PERL_ANYEVENT_PROTOCOLS>
1104
1105Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1106for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1107of auto probing).
1108
1109Must be set to a comma-separated list of protocols or address families,
1110current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1111used, and preference will be given to protocols mentioned earlier in the
1112list.
1113
1114This variable can effectively be used for denial-of-service attacks
1115against local programs (e.g. when setuid), although the impact is likely
1116small, as the program has to handle connection errors already-
1117
1118Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1119but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1120- only support IPv4, never try to resolve or contact IPv6
1121addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1122IPv6, but prefer IPv6 over IPv4.
1123
1124=item C<PERL_ANYEVENT_EDNS0>
1125
1126Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1127for DNS. This extension is generally useful to reduce DNS traffic, but
1128some (broken) firewalls drop such DNS packets, which is why it is off by
1129default.
1130
1131Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1132EDNS0 in its DNS requests.
1133
1134=item C<PERL_ANYEVENT_MAX_FORKS>
1135
1136The maximum number of child processes that C<AnyEvent::Util::fork_call>
1137will create in parallel.
1138
1139=back
1140 1369
1141=head1 EXAMPLE PROGRAM 1370=head1 EXAMPLE PROGRAM
1142 1371
1143The following program uses an I/O watcher to read data from STDIN, a timer 1372The following program uses an I/O watcher to read data from STDIN, a timer
1144to display a message once per second, and a condition variable to quit the 1373to display a message once per second, and a condition variable to quit the
1338watcher. 1567watcher.
1339 1568
1340=head3 Results 1569=head3 Results
1341 1570
1342 name watchers bytes create invoke destroy comment 1571 name watchers bytes create invoke destroy comment
1343 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1572 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1344 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1573 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1345 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1574 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1346 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1575 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1347 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1576 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1348 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1577 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1349 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1578 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1350 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1579 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1351 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1580 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1352 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1581 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1353 1582
1354=head3 Discussion 1583=head3 Discussion
1355 1584
1356The benchmark does I<not> measure scalability of the event loop very 1585The benchmark does I<not> measure scalability of the event loop very
1357well. For example, a select-based event loop (such as the pure perl one) 1586well. For example, a select-based event loop (such as the pure perl one)
1559watchers, as the management overhead dominates. 1788watchers, as the management overhead dominates.
1560 1789
1561=back 1790=back
1562 1791
1563 1792
1793=head1 SIGNALS
1794
1795AnyEvent currently installs handlers for these signals:
1796
1797=over 4
1798
1799=item SIGCHLD
1800
1801A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1802emulation for event loops that do not support them natively. Also, some
1803event loops install a similar handler.
1804
1805=item SIGPIPE
1806
1807A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1808when AnyEvent gets loaded.
1809
1810The rationale for this is that AnyEvent users usually do not really depend
1811on SIGPIPE delivery (which is purely an optimisation for shell use, or
1812badly-written programs), but C<SIGPIPE> can cause spurious and rare
1813program exits as a lot of people do not expect C<SIGPIPE> when writing to
1814some random socket.
1815
1816The rationale for installing a no-op handler as opposed to ignoring it is
1817that this way, the handler will be restored to defaults on exec.
1818
1819Feel free to install your own handler, or reset it to defaults.
1820
1821=back
1822
1823=cut
1824
1825$SIG{PIPE} = sub { }
1826 unless defined $SIG{PIPE};
1827
1828
1564=head1 FORK 1829=head1 FORK
1565 1830
1566Most event libraries are not fork-safe. The ones who are usually are 1831Most event libraries are not fork-safe. The ones who are usually are
1567because they rely on inefficient but fork-safe C<select> or C<poll> 1832because they rely on inefficient but fork-safe C<select> or C<poll>
1568calls. Only L<EV> is fully fork-aware. 1833calls. Only L<EV> is fully fork-aware.
1581specified in the variable. 1846specified in the variable.
1582 1847
1583You can make AnyEvent completely ignore this variable by deleting it 1848You can make AnyEvent completely ignore this variable by deleting it
1584before the first watcher gets created, e.g. with a C<BEGIN> block: 1849before the first watcher gets created, e.g. with a C<BEGIN> block:
1585 1850
1586 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1851 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1587 1852
1588 use AnyEvent; 1853 use AnyEvent;
1589 1854
1590Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1855Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1591be used to probe what backend is used and gain other information (which is 1856be used to probe what backend is used and gain other information (which is
1592probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1857probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1858$ENV{PERL_ANYEGENT_STRICT}.
1859
1860
1861=head1 BUGS
1862
1863Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1864to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1865and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1866memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1867pronounced).
1593 1868
1594 1869
1595=head1 SEE ALSO 1870=head1 SEE ALSO
1596 1871
1597Utility functions: L<AnyEvent::Util>. 1872Utility functions: L<AnyEvent::Util>.
1614Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 1889Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1615 1890
1616 1891
1617=head1 AUTHOR 1892=head1 AUTHOR
1618 1893
1619 Marc Lehmann <schmorp@schmorp.de> 1894 Marc Lehmann <schmorp@schmorp.de>
1620 http://home.schmorp.de/ 1895 http://home.schmorp.de/
1621 1896
1622=cut 1897=cut
1623 1898
16241 18991
1625 1900

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines