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.199 by root, Fri Mar 27 10:49:50 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> is the Perl I<file handle> (I<not> file descriptor) to watch
174for events (AnyEvent might or might not keep a reference to this file
175handle). Note that only file handles pointing to things for which
176non-blocking operation makes sense are allowed. This includes sockets,
177most character devices, pipes, fifos and so on, but not for example files
178or block devices.
179
152for events. C<poll> must be a string that is either C<r> or C<w>, 180C<poll> must be a string that is either C<r> or C<w>, which creates a
153which creates a watcher waiting for "r"eadable or "w"ritable events, 181watcher waiting for "r"eadable or "w"ritable events, respectively.
182
154respectively. C<cb> is the callback to invoke each time the file handle 183C<cb> is the callback to invoke each time the file handle becomes ready.
155becomes ready.
156 184
157Although the callback might get passed parameters, their value and 185Although the callback might get passed parameters, their value and
158presence is undefined and you cannot rely on them. Portable AnyEvent 186presence is undefined and you cannot rely on them. Portable AnyEvent
159callbacks cannot use arguments passed to I/O watcher callbacks. 187callbacks cannot use arguments passed to I/O watcher callbacks.
160 188
164 192
165Some event loops issue spurious readyness notifications, so you should 193Some event loops issue spurious readyness notifications, so you should
166always use non-blocking calls when reading/writing from/to your file 194always use non-blocking calls when reading/writing from/to your file
167handles. 195handles.
168 196
169Example:
170
171 # wait for readability of STDIN, then read a line and disable the watcher 197Example: wait for readability of STDIN, then read a line and disable the
198watcher.
199
172 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 200 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
173 chomp (my $input = <STDIN>); 201 chomp (my $input = <STDIN>);
174 warn "read: $input\n"; 202 warn "read: $input\n";
175 undef $w; 203 undef $w;
176 }); 204 });
186 214
187Although the callback might get passed parameters, their value and 215Although the callback might get passed parameters, their value and
188presence is undefined and you cannot rely on them. Portable AnyEvent 216presence is undefined and you cannot rely on them. Portable AnyEvent
189callbacks cannot use arguments passed to time watcher callbacks. 217callbacks cannot use arguments passed to time watcher callbacks.
190 218
191The timer callback will be invoked at most once: if you want a repeating 219The 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 220parameter, C<interval>, as a strictly positive number (> 0), then the
193and Glib). 221callback will be invoked regularly at that interval (in fractional
222seconds) after the first invocation. If C<interval> is specified with a
223false value, then it is treated as if it were missing.
194 224
195Example: 225The callback will be rescheduled before invoking the callback, but no
226attempt is done to avoid timer drift in most backends, so the interval is
227only approximate.
196 228
197 # fire an event after 7.7 seconds 229Example: fire an event after 7.7 seconds.
230
198 my $w = AnyEvent->timer (after => 7.7, cb => sub { 231 my $w = AnyEvent->timer (after => 7.7, cb => sub {
199 warn "timeout\n"; 232 warn "timeout\n";
200 }); 233 });
201 234
202 # to cancel the timer: 235 # to cancel the timer:
203 undef $w; 236 undef $w;
204 237
205Example 2:
206
207 # fire an event after 0.5 seconds, then roughly every second 238Example 2: fire an event after 0.5 seconds, then roughly every second.
208 my $w;
209 239
210 my $cb = sub {
211 # cancel the old timer while creating a new one
212 $w = AnyEvent->timer (after => 1, cb => $cb); 240 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
241 warn "timeout\n";
213 }; 242 };
214
215 # start the "loop" by creating the first watcher
216 $w = AnyEvent->timer (after => 0.5, cb => $cb);
217 243
218=head3 TIMING ISSUES 244=head3 TIMING ISSUES
219 245
220There are two ways to handle timers: based on real time (relative, "fire 246There are two ways to handle timers: based on real time (relative, "fire
221in 10 seconds") and based on wallclock time (absolute, "fire at 12 247in 10 seconds") and based on wallclock time (absolute, "fire at 12
243 269
244This returns the "current wallclock time" as a fractional number of 270This 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> 271seconds 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). 272return, and the result is guaranteed to be compatible with those).
247 273
248It progresses independently of any event loop processing. 274It progresses independently of any event loop processing, i.e. each call
249 275will 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 276
253=item AnyEvent->now 277=item AnyEvent->now
254 278
255This also returns the "current wallclock time", but unlike C<time>, above, 279This also returns the "current wallclock time", but unlike C<time>, above,
256this value might change only once per event loop iteration, depending on 280this 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 281the event loop (most return the same time as C<time>, above). This is the
258time that AnyEvent timers get scheduled against. 282time that AnyEvent's timers get scheduled against.
283
284I<In almost all cases (in all cases if you don't care), this is the
285function to call when you want to know the current time.>
286
287This function is also often faster then C<< AnyEvent->time >>, and
288thus the preferred method if you want some timestamp (for example,
289L<AnyEvent::Handle> uses this to update it's activity timeouts).
290
291The rest of this section is only of relevance if you try to be very exact
292with your timing, you can skip it without bad conscience.
259 293
260For a practical example of when these times differ, consider L<Event::Lib> 294For a practical example of when these times differ, consider L<Event::Lib>
261and L<EV> and the following set-up: 295and L<EV> and the following set-up:
262 296
263The event loop is running and has just invoked one of your callback at 297The event loop is running and has just invoked one of your callback at
268 302
269With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will 303With 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 304both return C<501>, because that is the current time, and the timer will
271be scheduled to fire at time=504 (C<501> + C<3>). 305be scheduled to fire at time=504 (C<501> + C<3>).
272 306
273With L<EV>m C<< AnyEvent->time >> returns C<501> (as that is the current 307With 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 308time), 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 309last event processing phase started. With L<EV>, your timer gets scheduled
276to run at time=503 (C<500> + C<3>). 310to run at time=503 (C<500> + C<3>).
277 311
278In one sense, L<Event::Lib> is more exact, as it uses the current time 312In one sense, L<Event::Lib> is more exact, as it uses the current time
279regardless of any delays introduced by event processing. However, most 313regardless of any delays introduced by event processing. However, most
280callbacks do not expect large delays in processing, so this causes a 314callbacks do not expect large delays in processing, so this causes a
281higher drift (and a lot more syscalls to get the current time). 315higher drift (and a lot more system calls to get the current time).
282 316
283In another sense, L<EV> is more exact, as your timer will be scheduled at 317In 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. 318the same time, regardless of how long event processing actually took.
285 319
286In either case, if you care (and in most cases, you don't), then you 320In either case, if you care (and in most cases, you don't), then you
291=back 325=back
292 326
293=head2 SIGNAL WATCHERS 327=head2 SIGNAL WATCHERS
294 328
295You can watch for signals using a signal watcher, C<signal> is the signal 329You 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 330I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
297be invoked whenever a signal occurs. 331callback to be invoked whenever a signal occurs.
298 332
299Although the callback might get passed parameters, their value and 333Although the callback might get passed parameters, their value and
300presence is undefined and you cannot rely on them. Portable AnyEvent 334presence is undefined and you cannot rely on them. Portable AnyEvent
301callbacks cannot use arguments passed to signal watcher callbacks. 335callbacks cannot use arguments passed to signal watcher callbacks.
302 336
318=head2 CHILD PROCESS WATCHERS 352=head2 CHILD PROCESS WATCHERS
319 353
320You can also watch on a child process exit and catch its exit status. 354You can also watch on a child process exit and catch its exit status.
321 355
322The child process is specified by the C<pid> argument (if set to C<0>, it 356The 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 357watches for any child process exit). The watcher will triggered only when
324as status change for the child are received. This works by installing a 358the 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 359any trace events (stopped/continued).
326and exit status (as returned by waitpid), so unlike other watcher types, 360
327you I<can> rely on child watcher callback arguments. 361The callback will be called with the pid and exit status (as returned by
362waitpid), so unlike other watcher types, you I<can> rely on child watcher
363callback arguments.
364
365This watcher type works by installing a signal handler for C<SIGCHLD>,
366and since it cannot be shared, nothing else should use SIGCHLD or reap
367random child processes (waiting for specific child processes, e.g. inside
368C<system>, is just fine).
328 369
329There is a slight catch to child watchers, however: you usually start them 370There 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 371I<after> the child process was created, and this means the process could
331have exited already (and no SIGCHLD will be sent anymore). 372have exited already (and no SIGCHLD will be sent anymore).
332 373
338AnyEvent program, you I<have> to create at least one watcher before you 379AnyEvent program, you I<have> to create at least one watcher before you
339C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 380C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
340 381
341Example: fork a process and wait for it 382Example: fork a process and wait for it
342 383
343 my $done = AnyEvent->condvar; 384 my $done = AnyEvent->condvar;
344 385
345 my $pid = fork or exit 5; 386 my $pid = fork or exit 5;
346 387
347 my $w = AnyEvent->child ( 388 my $w = AnyEvent->child (
348 pid => $pid, 389 pid => $pid,
349 cb => sub { 390 cb => sub {
350 my ($pid, $status) = @_; 391 my ($pid, $status) = @_;
351 warn "pid $pid exited with status $status"; 392 warn "pid $pid exited with status $status";
352 $done->send; 393 $done->send;
353 }, 394 },
354 ); 395 );
355 396
356 # do something else, then wait for process exit 397 # do something else, then wait for process exit
357 $done->recv; 398 $done->recv;
358 399
359=head2 CONDITION VARIABLES 400=head2 CONDITION VARIABLES
360 401
361If you are familiar with some event loops you will know that all of them 402If 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 403require you to run some blocking "loop", "run" or similar function that
368The instrument to do that is called a "condition variable", so called 409The instrument to do that is called a "condition variable", so called
369because they represent a condition that must become true. 410because they represent a condition that must become true.
370 411
371Condition variables can be created by calling the C<< AnyEvent->condvar 412Condition variables can be created by calling the C<< AnyEvent->condvar
372>> method, usually without arguments. The only argument pair allowed is 413>> method, usually without arguments. The only argument pair allowed is
414
373C<cb>, which specifies a callback to be called when the condition variable 415C<cb>, which specifies a callback to be called when the condition variable
374becomes true. 416becomes true, with the condition variable as the first argument (but not
417the results).
375 418
376After creation, the condition variable is "false" until it becomes "true" 419After creation, the condition variable is "false" until it becomes "true"
377by calling the C<send> method (or calling the condition variable as if it 420by 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<< 421were a callback, read about the caveats in the description for the C<<
379->send >> method). 422->send >> method).
435 478
436 my $done = AnyEvent->condvar; 479 my $done = AnyEvent->condvar;
437 my $delay = AnyEvent->timer (after => 5, cb => $done); 480 my $delay = AnyEvent->timer (after => 5, cb => $done);
438 $done->recv; 481 $done->recv;
439 482
483Example: Imagine an API that returns a condvar and doesn't support
484callbacks. This is how you make a synchronous call, for example from
485the main program:
486
487 use AnyEvent::CouchDB;
488
489 ...
490
491 my @info = $couchdb->info->recv;
492
493And this is how you would just ste a callback to be called whenever the
494results are available:
495
496 $couchdb->info->cb (sub {
497 my @info = $_[0]->recv;
498 });
499
440=head3 METHODS FOR PRODUCERS 500=head3 METHODS FOR PRODUCERS
441 501
442These methods should only be used by the producing side, i.e. the 502These methods should only be used by the producing side, i.e. the
443code/module that eventually sends the signal. Note that it is also 503code/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 504the producer side which creates the condvar in most cases, but it isn't
577=item $bool = $cv->ready 637=item $bool = $cv->ready
578 638
579Returns true when the condition is "true", i.e. whether C<send> or 639Returns true when the condition is "true", i.e. whether C<send> or
580C<croak> have been called. 640C<croak> have been called.
581 641
582=item $cb = $cv->cb ([new callback]) 642=item $cb = $cv->cb ($cb->($cv))
583 643
584This is a mutator function that returns the callback set and optionally 644This is a mutator function that returns the callback set and optionally
585replaces it before doing so. 645replaces it before doing so.
586 646
587The callback will be called when the condition becomes "true", i.e. when 647The 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 648C<send> or C<croak> are called, with the only argument being the condition
589or at any later time is guaranteed not to block. 649variable itself. Calling C<recv> inside the callback or at any later time
650is guaranteed not to block.
590 651
591=back 652=back
592 653
593=head1 GLOBAL VARIABLES AND FUNCTIONS 654=head1 GLOBAL VARIABLES AND FUNCTIONS
594 655
723=item L<AnyEvent::Util> 784=item L<AnyEvent::Util>
724 785
725Contains various utility functions that replace often-used but blocking 786Contains various utility functions that replace often-used but blocking
726functions such as C<inet_aton> by event-/callback-based versions. 787functions such as C<inet_aton> by event-/callback-based versions.
727 788
728=item L<AnyEvent::Handle>
729
730Provide read and write buffers and manages watchers for reads and writes.
731
732=item L<AnyEvent::Socket> 789=item L<AnyEvent::Socket>
733 790
734Provides various utility functions for (internet protocol) sockets, 791Provides various utility functions for (internet protocol) sockets,
735addresses and name resolution. Also functions to create non-blocking tcp 792addresses and name resolution. Also functions to create non-blocking tcp
736connections or tcp servers, with IPv6 and SRV record support and more. 793connections or tcp servers, with IPv6 and SRV record support and more.
737 794
795=item L<AnyEvent::Handle>
796
797Provide read and write buffers, manages watchers for reads and writes,
798supports raw and formatted I/O, I/O queued and fully transparent and
799non-blocking SSL/TLS.
800
738=item L<AnyEvent::DNS> 801=item L<AnyEvent::DNS>
739 802
740Provides rich asynchronous DNS resolver capabilities. 803Provides rich asynchronous DNS resolver capabilities.
741 804
805=item L<AnyEvent::HTTP>
806
807A simple-to-use HTTP library that is capable of making a lot of concurrent
808HTTP requests.
809
742=item L<AnyEvent::HTTPD> 810=item L<AnyEvent::HTTPD>
743 811
744Provides a simple web application server framework. 812Provides a simple web application server framework.
745 813
746=item L<AnyEvent::FastPing> 814=item L<AnyEvent::FastPing>
747 815
748The fastest ping in the west. 816The fastest ping in the west.
749 817
818=item L<AnyEvent::DBI>
819
820Executes L<DBI> requests asynchronously in a proxy process.
821
822=item L<AnyEvent::AIO>
823
824Truly asynchronous I/O, should be in the toolbox of every event
825programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
826together.
827
828=item L<AnyEvent::BDB>
829
830Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
831L<BDB> and AnyEvent together.
832
833=item L<AnyEvent::GPSD>
834
835A non-blocking interface to gpsd, a daemon delivering GPS information.
836
837=item L<AnyEvent::IGS>
838
839A non-blocking interface to the Internet Go Server protocol (used by
840L<App::IGS>).
841
750=item L<Net::IRC3> 842=item L<AnyEvent::IRC>
751 843
752AnyEvent based IRC client module family. 844AnyEvent based IRC client module family (replacing the older Net::IRC3).
753 845
754=item L<Net::XMPP2> 846=item L<Net::XMPP2>
755 847
756AnyEvent based XMPP (Jabber protocol) module family. 848AnyEvent based XMPP (Jabber protocol) module family.
757 849
766 858
767=item L<Coro> 859=item L<Coro>
768 860
769Has special support for AnyEvent via L<Coro::AnyEvent>. 861Has special support for AnyEvent via L<Coro::AnyEvent>.
770 862
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> 863=item L<IO::Lambda>
783 864
784The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 865The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
785 866
786=back 867=back
788=cut 869=cut
789 870
790package AnyEvent; 871package AnyEvent;
791 872
792no warnings; 873no warnings;
793use strict; 874use strict qw(vars subs);
794 875
795use Carp; 876use Carp;
796 877
797our $VERSION = '4.05'; 878our $VERSION = 4.35;
798our $MODEL; 879our $MODEL;
799 880
800our $AUTOLOAD; 881our $AUTOLOAD;
801our @ISA; 882our @ISA;
802 883
905 $MODEL 986 $MODEL
906 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 987 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
907 } 988 }
908 } 989 }
909 990
991 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
992
910 unshift @ISA, $MODEL; 993 unshift @ISA, $MODEL;
911 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 994
995 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
912 996
913 (shift @post_detect)->() while @post_detect; 997 (shift @post_detect)->() while @post_detect;
914 } 998 }
915 999
916 $MODEL 1000 $MODEL
926 1010
927 my $class = shift; 1011 my $class = shift;
928 $class->$func (@_); 1012 $class->$func (@_);
929} 1013}
930 1014
1015# utility function to dup a filehandle. this is used by many backends
1016# to support binding more than one watcher per filehandle (they usually
1017# allow only one watcher per fd, so we dup it to get a different one).
1018sub _dupfh($$$$) {
1019 my ($poll, $fh, $r, $w) = @_;
1020
1021 # cygwin requires the fh mode to be matching, unix doesn't
1022 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1023 : $poll eq "w" ? ($w, ">")
1024 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1025
1026 open my $fh2, "$mode&" . fileno $fh
1027 or die "cannot dup() filehandle: $!";
1028
1029 # we assume CLOEXEC is already set by perl in all important cases
1030
1031 ($fh2, $rw)
1032}
1033
931package AnyEvent::Base; 1034package AnyEvent::Base;
932 1035
933# default implementation for now and time 1036# default implementation for now and time
934 1037
935use Time::HiRes (); 1038BEGIN {
1039 if (eval "use Time::HiRes (); time (); 1") {
1040 *_time = \&Time::HiRes::time;
1041 # if (eval "use POSIX (); (POSIX::times())...
1042 } else {
1043 *_time = sub { time }; # epic fail
1044 }
1045}
936 1046
937sub time { Time::HiRes::time } 1047sub time { _time }
938sub now { Time::HiRes::time } 1048sub now { _time }
939 1049
940# default implementation for ->condvar 1050# default implementation for ->condvar
941 1051
942sub condvar { 1052sub condvar {
943 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1053 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
944} 1054}
945 1055
946# default implementation for ->signal 1056# default implementation for ->signal
947 1057
948our %SIG_CB; 1058our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1059
1060sub _signal_exec {
1061 sysread $SIGPIPE_R, my $dummy, 4;
1062
1063 while (%SIG_EV) {
1064 for (keys %SIG_EV) {
1065 delete $SIG_EV{$_};
1066 $_->() for values %{ $SIG_CB{$_} || {} };
1067 }
1068 }
1069}
949 1070
950sub signal { 1071sub signal {
951 my (undef, %arg) = @_; 1072 my (undef, %arg) = @_;
952 1073
1074 unless ($SIGPIPE_R) {
1075 if (AnyEvent::WIN32) {
1076 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1077 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1078 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1079 } else {
1080 pipe $SIGPIPE_R, $SIGPIPE_W;
1081 require Fcntl;
1082 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1083 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1084 }
1085
1086 $SIGPIPE_R
1087 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1088
1089 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1090 }
1091
953 my $signal = uc $arg{signal} 1092 my $signal = uc $arg{signal}
954 or Carp::croak "required option 'signal' is missing"; 1093 or Carp::croak "required option 'signal' is missing";
955 1094
956 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1095 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
957 $SIG{$signal} ||= sub { 1096 $SIG{$signal} ||= sub {
958 $_->() for values %{ $SIG_CB{$signal} || {} }; 1097 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1098 undef $SIG_EV{$signal};
959 }; 1099 };
960 1100
961 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1101 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
962} 1102}
963 1103
964sub AnyEvent::Base::Signal::DESTROY { 1104sub AnyEvent::Base::Signal::DESTROY {
965 my ($signal, $cb) = @{$_[0]}; 1105 my ($signal, $cb) = @{$_[0]};
966 1106
967 delete $SIG_CB{$signal}{$cb}; 1107 delete $SIG_CB{$signal}{$cb};
968 1108
969 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1109 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
970} 1110}
971 1111
972# default implementation for ->child 1112# default implementation for ->child
973 1113
974our %PID_CB; 1114our %PID_CB;
1082 1222
1083# undocumented/compatibility with pre-3.4 1223# undocumented/compatibility with pre-3.4
1084*broadcast = \&send; 1224*broadcast = \&send;
1085*wait = \&_wait; 1225*wait = \&_wait;
1086 1226
1227=head1 ERROR AND EXCEPTION HANDLING
1228
1229In general, AnyEvent does not do any error handling - it relies on the
1230caller to do that if required. The L<AnyEvent::Strict> module (see also
1231the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1232checking of all AnyEvent methods, however, which is highly useful during
1233development.
1234
1235As for exception handling (i.e. runtime errors and exceptions thrown while
1236executing a callback), this is not only highly event-loop specific, but
1237also not in any way wrapped by this module, as this is the job of the main
1238program.
1239
1240The pure perl event loop simply re-throws the exception (usually
1241within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1242$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1243so on.
1244
1245=head1 ENVIRONMENT VARIABLES
1246
1247The following environment variables are used by this module or its
1248submodules:
1249
1250=over 4
1251
1252=item C<PERL_ANYEVENT_VERBOSE>
1253
1254By default, AnyEvent will be completely silent except in fatal
1255conditions. You can set this environment variable to make AnyEvent more
1256talkative.
1257
1258When set to C<1> or higher, causes AnyEvent to warn about unexpected
1259conditions, such as not being able to load the event model specified by
1260C<PERL_ANYEVENT_MODEL>.
1261
1262When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1263model it chooses.
1264
1265=item C<PERL_ANYEVENT_STRICT>
1266
1267AnyEvent does not do much argument checking by default, as thorough
1268argument checking is very costly. Setting this variable to a true value
1269will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1270check the arguments passed to most method calls. If it finds any problems
1271it will croak.
1272
1273In other words, enables "strict" mode.
1274
1275Unlike C<use strict>, it is definitely recommended ot keep it off in
1276production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1277developing programs can be very useful, however.
1278
1279=item C<PERL_ANYEVENT_MODEL>
1280
1281This can be used to specify the event model to be used by AnyEvent, before
1282auto detection and -probing kicks in. It must be a string consisting
1283entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1284and the resulting module name is loaded and if the load was successful,
1285used as event model. If it fails to load AnyEvent will proceed with
1286auto detection and -probing.
1287
1288This functionality might change in future versions.
1289
1290For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1291could start your program like this:
1292
1293 PERL_ANYEVENT_MODEL=Perl perl ...
1294
1295=item C<PERL_ANYEVENT_PROTOCOLS>
1296
1297Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1298for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1299of auto probing).
1300
1301Must be set to a comma-separated list of protocols or address families,
1302current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1303used, and preference will be given to protocols mentioned earlier in the
1304list.
1305
1306This variable can effectively be used for denial-of-service attacks
1307against local programs (e.g. when setuid), although the impact is likely
1308small, as the program has to handle conenction and other failures anyways.
1309
1310Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1311but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1312- only support IPv4, never try to resolve or contact IPv6
1313addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1314IPv6, but prefer IPv6 over IPv4.
1315
1316=item C<PERL_ANYEVENT_EDNS0>
1317
1318Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1319for DNS. This extension is generally useful to reduce DNS traffic, but
1320some (broken) firewalls drop such DNS packets, which is why it is off by
1321default.
1322
1323Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1324EDNS0 in its DNS requests.
1325
1326=item C<PERL_ANYEVENT_MAX_FORKS>
1327
1328The maximum number of child processes that C<AnyEvent::Util::fork_call>
1329will create in parallel.
1330
1331=back
1332
1087=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1333=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1088 1334
1089This is an advanced topic that you do not normally need to use AnyEvent in 1335This 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 1336a module. This section is only of use to event loop authors who want to
1091provide AnyEvent compatibility. 1337provide AnyEvent compatibility.
1124 1370
1125I<rxvt-unicode> also cheats a bit by not providing blocking access to 1371I<rxvt-unicode> also cheats a bit by not providing blocking access to
1126condition variables: code blocking while waiting for a condition will 1372condition variables: code blocking while waiting for a condition will
1127C<die>. This still works with most modules/usages, and blocking calls must 1373C<die>. This still works with most modules/usages, and blocking calls must
1128not be done in an interactive application, so it makes sense. 1374not 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 1375
1203=head1 EXAMPLE PROGRAM 1376=head1 EXAMPLE PROGRAM
1204 1377
1205The following program uses an I/O watcher to read data from STDIN, a timer 1378The 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 1379to display a message once per second, and a condition variable to quit the
1400watcher. 1573watcher.
1401 1574
1402=head3 Results 1575=head3 Results
1403 1576
1404 name watchers bytes create invoke destroy comment 1577 name watchers bytes create invoke destroy comment
1405 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1578 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 1579 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 1580 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 1581 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 1582 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 1583 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 1584 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 1585 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 1586 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 1587 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1415 1588
1416=head3 Discussion 1589=head3 Discussion
1417 1590
1418The benchmark does I<not> measure scalability of the event loop very 1591The 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) 1592well. For example, a select-based event loop (such as the pure perl one)
1621watchers, as the management overhead dominates. 1794watchers, as the management overhead dominates.
1622 1795
1623=back 1796=back
1624 1797
1625 1798
1799=head1 SIGNALS
1800
1801AnyEvent currently installs handlers for these signals:
1802
1803=over 4
1804
1805=item SIGCHLD
1806
1807A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1808emulation for event loops that do not support them natively. Also, some
1809event loops install a similar handler.
1810
1811=item SIGPIPE
1812
1813A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1814when AnyEvent gets loaded.
1815
1816The rationale for this is that AnyEvent users usually do not really depend
1817on SIGPIPE delivery (which is purely an optimisation for shell use, or
1818badly-written programs), but C<SIGPIPE> can cause spurious and rare
1819program exits as a lot of people do not expect C<SIGPIPE> when writing to
1820some random socket.
1821
1822The rationale for installing a no-op handler as opposed to ignoring it is
1823that this way, the handler will be restored to defaults on exec.
1824
1825Feel free to install your own handler, or reset it to defaults.
1826
1827=back
1828
1829=cut
1830
1831$SIG{PIPE} = sub { }
1832 unless defined $SIG{PIPE};
1833
1834
1626=head1 FORK 1835=head1 FORK
1627 1836
1628Most event libraries are not fork-safe. The ones who are usually are 1837Most 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> 1838because they rely on inefficient but fork-safe C<select> or C<poll>
1630calls. Only L<EV> is fully fork-aware. 1839calls. Only L<EV> is fully fork-aware.
1643specified in the variable. 1852specified in the variable.
1644 1853
1645You can make AnyEvent completely ignore this variable by deleting it 1854You can make AnyEvent completely ignore this variable by deleting it
1646before the first watcher gets created, e.g. with a C<BEGIN> block: 1855before the first watcher gets created, e.g. with a C<BEGIN> block:
1647 1856
1648 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1857 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1649 1858
1650 use AnyEvent; 1859 use AnyEvent;
1651 1860
1652Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1861Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1653be used to probe what backend is used and gain other information (which is 1862be used to probe what backend is used and gain other information (which is
1654probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1863probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1864$ENV{PERL_ANYEGENT_STRICT}.
1865
1866
1867=head1 BUGS
1868
1869Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1870to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1871and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1872memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1873pronounced).
1655 1874
1656 1875
1657=head1 SEE ALSO 1876=head1 SEE ALSO
1658 1877
1659Utility functions: L<AnyEvent::Util>. 1878Utility functions: L<AnyEvent::Util>.
1676Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 1895Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1677 1896
1678 1897
1679=head1 AUTHOR 1898=head1 AUTHOR
1680 1899
1681 Marc Lehmann <schmorp@schmorp.de> 1900 Marc Lehmann <schmorp@schmorp.de>
1682 http://home.schmorp.de/ 1901 http://home.schmorp.de/
1683 1902
1684=cut 1903=cut
1685 1904
16861 19051
1687 1906

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines