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.143 by root, Wed May 28 23:57:38 2008 UTC vs.
Revision 1.196 by root, Thu Mar 26 07:47:42 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
243 263
244This returns the "current wallclock time" as a fractional number of 264This returns the "current wallclock time" as a fractional number of
245seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> 265seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
246return, and the result is guaranteed to be compatible with those). 266return, and the result is guaranteed to be compatible with those).
247 267
248It progresses independently of any event loop processing. 268It progresses independently of any event loop processing, i.e. each call
249 269will check the system clock, which usually gets updated frequently.
250In almost all cases (in all cases if you don't care), this is the function
251to call when you want to know the current time.
252 270
253=item AnyEvent->now 271=item AnyEvent->now
254 272
255This also returns the "current wallclock time", but unlike C<time>, above, 273This also returns the "current wallclock time", but unlike C<time>, above,
256this value might change only once per event loop iteration, depending on 274this value might change only once per event loop iteration, depending on
257the event loop (most return the same time as C<time>, above). This is the 275the event loop (most return the same time as C<time>, above). This is the
258time that AnyEvent timers get scheduled against. 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.
259 287
260For a practical example of when these times differ, consider L<Event::Lib> 288For a practical example of when these times differ, consider L<Event::Lib>
261and L<EV> and the following set-up: 289and L<EV> and the following set-up:
262 290
263The event loop is running and has just invoked one of your callback at 291The event loop is running and has just invoked one of your callback at
268 296
269With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will 297With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
270both return C<501>, because that is the current time, and the timer will 298both return C<501>, because that is the current time, and the timer will
271be scheduled to fire at time=504 (C<501> + C<3>). 299be scheduled to fire at time=504 (C<501> + C<3>).
272 300
273With L<EV>m C<< AnyEvent->time >> returns C<501> (as that is the current 301With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
274time), but C<< AnyEvent->now >> returns C<500>, as that is the time the 302time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
275last event processing phase started. With L<EV>, your timer gets scheduled 303last event processing phase started. With L<EV>, your timer gets scheduled
276to run at time=503 (C<500> + C<3>). 304to run at time=503 (C<500> + C<3>).
277 305
278In one sense, L<Event::Lib> is more exact, as it uses the current time 306In one sense, L<Event::Lib> is more exact, as it uses the current time
279regardless of any delays introduced by event processing. However, most 307regardless of any delays introduced by event processing. However, most
280callbacks do not expect large delays in processing, so this causes a 308callbacks do not expect large delays in processing, so this causes a
281higher drift (and a lot more syscalls to get the current time). 309higher drift (and a lot more system calls to get the current time).
282 310
283In another sense, L<EV> is more exact, as your timer will be scheduled at 311In another sense, L<EV> is more exact, as your timer will be scheduled at
284the same time, regardless of how long event processing actually took. 312the same time, regardless of how long event processing actually took.
285 313
286In either case, if you care (and in most cases, you don't), then you 314In either case, if you care (and in most cases, you don't), then you
291=back 319=back
292 320
293=head2 SIGNAL WATCHERS 321=head2 SIGNAL WATCHERS
294 322
295You 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
296I<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
297be invoked whenever a signal occurs. 325callback to be invoked whenever a signal occurs.
298 326
299Although the callback might get passed parameters, their value and 327Although the callback might get passed parameters, their value and
300presence is undefined and you cannot rely on them. Portable AnyEvent 328presence is undefined and you cannot rely on them. Portable AnyEvent
301callbacks cannot use arguments passed to signal watcher callbacks. 329callbacks cannot use arguments passed to signal watcher callbacks.
302 330
318=head2 CHILD PROCESS WATCHERS 346=head2 CHILD PROCESS WATCHERS
319 347
320You 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.
321 349
322The 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
323watches for any child process exit). The watcher will trigger as often 351watches for any child process exit). The watcher will triggered only when
324as 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
325signal handler for C<SIGCHLD>. The callback will be called with the pid 353any trace events (stopped/continued).
326and exit status (as returned by waitpid), so unlike other watcher types, 354
327you 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).
328 363
329There 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
330I<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
331have exited already (and no SIGCHLD will be sent anymore). 366have exited already (and no SIGCHLD will be sent anymore).
332 367
338AnyEvent 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
339C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 374C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
340 375
341Example: fork a process and wait for it 376Example: fork a process and wait for it
342 377
343 my $done = AnyEvent->condvar; 378 my $done = AnyEvent->condvar;
344 379
345 my $pid = fork or exit 5; 380 my $pid = fork or exit 5;
346 381
347 my $w = AnyEvent->child ( 382 my $w = AnyEvent->child (
348 pid => $pid, 383 pid => $pid,
349 cb => sub { 384 cb => sub {
350 my ($pid, $status) = @_; 385 my ($pid, $status) = @_;
351 warn "pid $pid exited with status $status"; 386 warn "pid $pid exited with status $status";
352 $done->send; 387 $done->send;
353 }, 388 },
354 ); 389 );
355 390
356 # do something else, then wait for process exit 391 # do something else, then wait for process exit
357 $done->recv; 392 $done->recv;
358 393
359=head2 CONDITION VARIABLES 394=head2 CONDITION VARIABLES
360 395
361If 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
362require you to run some blocking "loop", "run" or similar function that 397require you to run some blocking "loop", "run" or similar function that
368The instrument to do that is called a "condition variable", so called 403The instrument to do that is called a "condition variable", so called
369because they represent a condition that must become true. 404because they represent a condition that must become true.
370 405
371Condition variables can be created by calling the C<< AnyEvent->condvar 406Condition variables can be created by calling the C<< AnyEvent->condvar
372>> method, usually without arguments. The only argument pair allowed is 407>> method, usually without arguments. The only argument pair allowed is
408
373C<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
374becomes true. 410becomes true, with the condition variable as the first argument (but not
411the results).
375 412
376After creation, the condition variable is "false" until it becomes "true" 413After creation, the condition variable is "false" until it becomes "true"
377by 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
378were 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<<
379->send >> method). 416->send >> method).
435 472
436 my $done = AnyEvent->condvar; 473 my $done = AnyEvent->condvar;
437 my $delay = AnyEvent->timer (after => 5, cb => $done); 474 my $delay = AnyEvent->timer (after => 5, cb => $done);
438 $done->recv; 475 $done->recv;
439 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
440=head3 METHODS FOR PRODUCERS 494=head3 METHODS FOR PRODUCERS
441 495
442These 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
443code/module that eventually sends the signal. Note that it is also 497code/module that eventually sends the signal. Note that it is also
444the 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
577=item $bool = $cv->ready 631=item $bool = $cv->ready
578 632
579Returns 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
580C<croak> have been called. 634C<croak> have been called.
581 635
582=item $cb = $cv->cb ([new callback]) 636=item $cb = $cv->cb ($cb->($cv))
583 637
584This is a mutator function that returns the callback set and optionally 638This is a mutator function that returns the callback set and optionally
585replaces it before doing so. 639replaces it before doing so.
586 640
587The 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
588C<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
589or 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.
590 645
591=back 646=back
592 647
593=head1 GLOBAL VARIABLES AND FUNCTIONS 648=head1 GLOBAL VARIABLES AND FUNCTIONS
594 649
723=item L<AnyEvent::Util> 778=item L<AnyEvent::Util>
724 779
725Contains various utility functions that replace often-used but blocking 780Contains various utility functions that replace often-used but blocking
726functions such as C<inet_aton> by event-/callback-based versions. 781functions such as C<inet_aton> by event-/callback-based versions.
727 782
728=item L<AnyEvent::Handle>
729
730Provide read and write buffers and manages watchers for reads and writes.
731
732=item L<AnyEvent::Socket> 783=item L<AnyEvent::Socket>
733 784
734Provides various utility functions for (internet protocol) sockets, 785Provides various utility functions for (internet protocol) sockets,
735addresses and name resolution. Also functions to create non-blocking tcp 786addresses and name resolution. Also functions to create non-blocking tcp
736connections or tcp servers, with IPv6 and SRV record support and more. 787connections or tcp servers, with IPv6 and SRV record support and more.
737 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
738=item L<AnyEvent::DNS> 795=item L<AnyEvent::DNS>
739 796
740Provides rich asynchronous DNS resolver capabilities. 797Provides rich asynchronous DNS resolver capabilities.
741 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
742=item L<AnyEvent::HTTPD> 804=item L<AnyEvent::HTTPD>
743 805
744Provides a simple web application server framework. 806Provides a simple web application server framework.
745 807
746=item L<AnyEvent::FastPing> 808=item L<AnyEvent::FastPing>
747 809
748The fastest ping in the west. 810The fastest ping in the west.
749 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
750=item L<Net::IRC3> 836=item L<AnyEvent::IRC>
751 837
752AnyEvent based IRC client module family. 838AnyEvent based IRC client module family (replacing the older Net::IRC3).
753 839
754=item L<Net::XMPP2> 840=item L<Net::XMPP2>
755 841
756AnyEvent based XMPP (Jabber protocol) module family. 842AnyEvent based XMPP (Jabber protocol) module family.
757 843
766 852
767=item L<Coro> 853=item L<Coro>
768 854
769Has special support for AnyEvent via L<Coro::AnyEvent>. 855Has special support for AnyEvent via L<Coro::AnyEvent>.
770 856
771=item L<AnyEvent::AIO>, L<IO::AIO>
772
773Truly asynchronous I/O, should be in the toolbox of every event
774programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
775together.
776
777=item L<AnyEvent::BDB>, L<BDB>
778
779Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
780IO::AIO and AnyEvent together.
781
782=item L<IO::Lambda> 857=item L<IO::Lambda>
783 858
784The 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.
785 860
786=back 861=back
788=cut 863=cut
789 864
790package AnyEvent; 865package AnyEvent;
791 866
792no warnings; 867no warnings;
793use strict; 868use strict qw(vars subs);
794 869
795use Carp; 870use Carp;
796 871
797our $VERSION = '4.05'; 872our $VERSION = 4.341;
798our $MODEL; 873our $MODEL;
799 874
800our $AUTOLOAD; 875our $AUTOLOAD;
801our @ISA; 876our @ISA;
802 877
905 $MODEL 980 $MODEL
906 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.";
907 } 982 }
908 } 983 }
909 984
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986
910 unshift @ISA, $MODEL; 987 unshift @ISA, $MODEL;
911 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 988
989 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
912 990
913 (shift @post_detect)->() while @post_detect; 991 (shift @post_detect)->() while @post_detect;
914 } 992 }
915 993
916 $MODEL 994 $MODEL
926 1004
927 my $class = shift; 1005 my $class = shift;
928 $class->$func (@_); 1006 $class->$func (@_);
929} 1007}
930 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
931package AnyEvent::Base; 1028package AnyEvent::Base;
932 1029
933# default implementation for now and time 1030# default implementation for now and time
934 1031
935use Time::HiRes (); 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}
936 1040
937sub time { Time::HiRes::time } 1041sub time { _time }
938sub now { Time::HiRes::time } 1042sub now { _time }
939 1043
940# default implementation for ->condvar 1044# default implementation for ->condvar
941 1045
942sub condvar { 1046sub condvar {
943 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
944} 1048}
945 1049
946# default implementation for ->signal 1050# default implementation for ->signal
947 1051
948our %SIG_CB; 1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1053
1054sub _signal_exec {
1055 while (%SIG_EV) {
1056 sysread $SIGPIPE_R, my $dummy, 4;
1057 for (keys %SIG_EV) {
1058 delete $SIG_EV{$_};
1059 $_->() for values %{ $SIG_CB{$_} || {} };
1060 }
1061 }
1062}
949 1063
950sub signal { 1064sub signal {
951 my (undef, %arg) = @_; 1065 my (undef, %arg) = @_;
952 1066
1067 unless ($SIGPIPE_R) {
1068 if (AnyEvent::WIN32) {
1069 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1070 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1071 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1072 } else {
1073 pipe $SIGPIPE_R, $SIGPIPE_W;
1074 require Fcntl;
1075 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1076 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1077 }
1078
1079 $SIGPIPE_R
1080 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1081
1082 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1083 }
1084
953 my $signal = uc $arg{signal} 1085 my $signal = uc $arg{signal}
954 or Carp::croak "required option 'signal' is missing"; 1086 or Carp::croak "required option 'signal' is missing";
955 1087
956 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1088 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
957 $SIG{$signal} ||= sub { 1089 $SIG{$signal} ||= sub {
958 $_->() for values %{ $SIG_CB{$signal} || {} }; 1090 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1091 undef $SIG_EV{$signal};
959 }; 1092 };
960 1093
961 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1094 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
962} 1095}
963 1096
964sub AnyEvent::Base::Signal::DESTROY { 1097sub AnyEvent::Base::Signal::DESTROY {
965 my ($signal, $cb) = @{$_[0]}; 1098 my ($signal, $cb) = @{$_[0]};
966 1099
967 delete $SIG_CB{$signal}{$cb}; 1100 delete $SIG_CB{$signal}{$cb};
968 1101
969 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1102 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
970} 1103}
971 1104
972# default implementation for ->child 1105# default implementation for ->child
973 1106
974our %PID_CB; 1107our %PID_CB;
1082 1215
1083# undocumented/compatibility with pre-3.4 1216# undocumented/compatibility with pre-3.4
1084*broadcast = \&send; 1217*broadcast = \&send;
1085*wait = \&_wait; 1218*wait = \&_wait;
1086 1219
1220=head1 ERROR AND EXCEPTION HANDLING
1221
1222In general, AnyEvent does not do any error handling - it relies on the
1223caller to do that if required. The L<AnyEvent::Strict> module (see also
1224the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1225checking of all AnyEvent methods, however, which is highly useful during
1226development.
1227
1228As for exception handling (i.e. runtime errors and exceptions thrown while
1229executing a callback), this is not only highly event-loop specific, but
1230also not in any way wrapped by this module, as this is the job of the main
1231program.
1232
1233The pure perl event loop simply re-throws the exception (usually
1234within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1235$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1236so on.
1237
1238=head1 ENVIRONMENT VARIABLES
1239
1240The following environment variables are used by this module or its
1241submodules:
1242
1243=over 4
1244
1245=item C<PERL_ANYEVENT_VERBOSE>
1246
1247By default, AnyEvent will be completely silent except in fatal
1248conditions. You can set this environment variable to make AnyEvent more
1249talkative.
1250
1251When set to C<1> or higher, causes AnyEvent to warn about unexpected
1252conditions, such as not being able to load the event model specified by
1253C<PERL_ANYEVENT_MODEL>.
1254
1255When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1256model it chooses.
1257
1258=item C<PERL_ANYEVENT_STRICT>
1259
1260AnyEvent does not do much argument checking by default, as thorough
1261argument checking is very costly. Setting this variable to a true value
1262will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1263check the arguments passed to most method calls. If it finds any problems
1264it will croak.
1265
1266In other words, enables "strict" mode.
1267
1268Unlike C<use strict>, it is definitely recommended ot keep it off in
1269production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1270developing programs can be very useful, however.
1271
1272=item C<PERL_ANYEVENT_MODEL>
1273
1274This can be used to specify the event model to be used by AnyEvent, before
1275auto detection and -probing kicks in. It must be a string consisting
1276entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1277and the resulting module name is loaded and if the load was successful,
1278used as event model. If it fails to load AnyEvent will proceed with
1279auto detection and -probing.
1280
1281This functionality might change in future versions.
1282
1283For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1284could start your program like this:
1285
1286 PERL_ANYEVENT_MODEL=Perl perl ...
1287
1288=item C<PERL_ANYEVENT_PROTOCOLS>
1289
1290Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1291for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1292of auto probing).
1293
1294Must be set to a comma-separated list of protocols or address families,
1295current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1296used, and preference will be given to protocols mentioned earlier in the
1297list.
1298
1299This variable can effectively be used for denial-of-service attacks
1300against local programs (e.g. when setuid), although the impact is likely
1301small, as the program has to handle conenction and other failures anyways.
1302
1303Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1304but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1305- only support IPv4, never try to resolve or contact IPv6
1306addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1307IPv6, but prefer IPv6 over IPv4.
1308
1309=item C<PERL_ANYEVENT_EDNS0>
1310
1311Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1312for DNS. This extension is generally useful to reduce DNS traffic, but
1313some (broken) firewalls drop such DNS packets, which is why it is off by
1314default.
1315
1316Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1317EDNS0 in its DNS requests.
1318
1319=item C<PERL_ANYEVENT_MAX_FORKS>
1320
1321The maximum number of child processes that C<AnyEvent::Util::fork_call>
1322will create in parallel.
1323
1324=back
1325
1087=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1326=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1088 1327
1089This is an advanced topic that you do not normally need to use AnyEvent in 1328This is an advanced topic that you do not normally need to use AnyEvent in
1090a module. This section is only of use to event loop authors who want to 1329a module. This section is only of use to event loop authors who want to
1091provide AnyEvent compatibility. 1330provide AnyEvent compatibility.
1124 1363
1125I<rxvt-unicode> also cheats a bit by not providing blocking access to 1364I<rxvt-unicode> also cheats a bit by not providing blocking access to
1126condition variables: code blocking while waiting for a condition will 1365condition variables: code blocking while waiting for a condition will
1127C<die>. This still works with most modules/usages, and blocking calls must 1366C<die>. This still works with most modules/usages, and blocking calls must
1128not be done in an interactive application, so it makes sense. 1367not be done in an interactive application, so it makes sense.
1129
1130=head1 ENVIRONMENT VARIABLES
1131
1132The following environment variables are used by this module:
1133
1134=over 4
1135
1136=item C<PERL_ANYEVENT_VERBOSE>
1137
1138By default, AnyEvent will be completely silent except in fatal
1139conditions. You can set this environment variable to make AnyEvent more
1140talkative.
1141
1142When set to C<1> or higher, causes AnyEvent to warn about unexpected
1143conditions, such as not being able to load the event model specified by
1144C<PERL_ANYEVENT_MODEL>.
1145
1146When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1147model it chooses.
1148
1149=item C<PERL_ANYEVENT_MODEL>
1150
1151This can be used to specify the event model to be used by AnyEvent, before
1152auto detection and -probing kicks in. It must be a string consisting
1153entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1154and the resulting module name is loaded and if the load was successful,
1155used as event model. If it fails to load AnyEvent will proceed with
1156auto detection and -probing.
1157
1158This functionality might change in future versions.
1159
1160For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1161could start your program like this:
1162
1163 PERL_ANYEVENT_MODEL=Perl perl ...
1164
1165=item C<PERL_ANYEVENT_PROTOCOLS>
1166
1167Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1168for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1169of auto probing).
1170
1171Must be set to a comma-separated list of protocols or address families,
1172current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1173used, and preference will be given to protocols mentioned earlier in the
1174list.
1175
1176This variable can effectively be used for denial-of-service attacks
1177against local programs (e.g. when setuid), although the impact is likely
1178small, as the program has to handle connection errors already-
1179
1180Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1181but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1182- only support IPv4, never try to resolve or contact IPv6
1183addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1184IPv6, but prefer IPv6 over IPv4.
1185
1186=item C<PERL_ANYEVENT_EDNS0>
1187
1188Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1189for DNS. This extension is generally useful to reduce DNS traffic, but
1190some (broken) firewalls drop such DNS packets, which is why it is off by
1191default.
1192
1193Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1194EDNS0 in its DNS requests.
1195
1196=item C<PERL_ANYEVENT_MAX_FORKS>
1197
1198The maximum number of child processes that C<AnyEvent::Util::fork_call>
1199will create in parallel.
1200
1201=back
1202 1368
1203=head1 EXAMPLE PROGRAM 1369=head1 EXAMPLE PROGRAM
1204 1370
1205The following program uses an I/O watcher to read data from STDIN, a timer 1371The following program uses an I/O watcher to read data from STDIN, a timer
1206to display a message once per second, and a condition variable to quit the 1372to display a message once per second, and a condition variable to quit the
1400watcher. 1566watcher.
1401 1567
1402=head3 Results 1568=head3 Results
1403 1569
1404 name watchers bytes create invoke destroy comment 1570 name watchers bytes create invoke destroy comment
1405 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1571 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1406 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1572 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1407 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1573 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1408 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1574 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1409 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1575 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1410 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1576 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1411 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1577 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1412 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1578 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1413 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1579 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1414 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1580 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1415 1581
1416=head3 Discussion 1582=head3 Discussion
1417 1583
1418The benchmark does I<not> measure scalability of the event loop very 1584The benchmark does I<not> measure scalability of the event loop very
1419well. For example, a select-based event loop (such as the pure perl one) 1585well. For example, a select-based event loop (such as the pure perl one)
1621watchers, as the management overhead dominates. 1787watchers, as the management overhead dominates.
1622 1788
1623=back 1789=back
1624 1790
1625 1791
1792=head1 SIGNALS
1793
1794AnyEvent currently installs handlers for these signals:
1795
1796=over 4
1797
1798=item SIGCHLD
1799
1800A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1801emulation for event loops that do not support them natively. Also, some
1802event loops install a similar handler.
1803
1804=item SIGPIPE
1805
1806A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1807when AnyEvent gets loaded.
1808
1809The rationale for this is that AnyEvent users usually do not really depend
1810on SIGPIPE delivery (which is purely an optimisation for shell use, or
1811badly-written programs), but C<SIGPIPE> can cause spurious and rare
1812program exits as a lot of people do not expect C<SIGPIPE> when writing to
1813some random socket.
1814
1815The rationale for installing a no-op handler as opposed to ignoring it is
1816that this way, the handler will be restored to defaults on exec.
1817
1818Feel free to install your own handler, or reset it to defaults.
1819
1820=back
1821
1822=cut
1823
1824$SIG{PIPE} = sub { }
1825 unless defined $SIG{PIPE};
1826
1827
1626=head1 FORK 1828=head1 FORK
1627 1829
1628Most event libraries are not fork-safe. The ones who are usually are 1830Most event libraries are not fork-safe. The ones who are usually are
1629because they rely on inefficient but fork-safe C<select> or C<poll> 1831because they rely on inefficient but fork-safe C<select> or C<poll>
1630calls. Only L<EV> is fully fork-aware. 1832calls. Only L<EV> is fully fork-aware.
1643specified in the variable. 1845specified in the variable.
1644 1846
1645You can make AnyEvent completely ignore this variable by deleting it 1847You can make AnyEvent completely ignore this variable by deleting it
1646before the first watcher gets created, e.g. with a C<BEGIN> block: 1848before the first watcher gets created, e.g. with a C<BEGIN> block:
1647 1849
1648 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1850 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1649 1851
1650 use AnyEvent; 1852 use AnyEvent;
1651 1853
1652Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1854Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1653be used to probe what backend is used and gain other information (which is 1855be used to probe what backend is used and gain other information (which is
1654probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1856probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1857$ENV{PERL_ANYEGENT_STRICT}.
1858
1859
1860=head1 BUGS
1861
1862Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1863to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1864and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1865mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1866pronounced).
1655 1867
1656 1868
1657=head1 SEE ALSO 1869=head1 SEE ALSO
1658 1870
1659Utility functions: L<AnyEvent::Util>. 1871Utility functions: L<AnyEvent::Util>.
1676Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 1888Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1677 1889
1678 1890
1679=head1 AUTHOR 1891=head1 AUTHOR
1680 1892
1681 Marc Lehmann <schmorp@schmorp.de> 1893 Marc Lehmann <schmorp@schmorp.de>
1682 http://home.schmorp.de/ 1894 http://home.schmorp.de/
1683 1895
1684=cut 1896=cut
1685 1897
16861 18981
1687 1899

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines