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.134 by root, Sun May 25 04:44:04 2008 UTC vs.
Revision 1.183 by root, Wed Oct 1 07:40:39 2008 UTC

1=head1 => NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, 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
64offering the functionality that is necessary, in as thin as a wrapper as 80offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 81technically possible.
66 82
83Of course, AnyEvent comes with a big (and fully optional!) toolbox
84of useful functionality, such as an asynchronous DNS resolver, 100%
85non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
86such as Windows) and lots of real-world knowledge and workarounds for
87platform bugs and differences.
88
67Of course, if you want lots of policy (this can arguably be somewhat 89Now, if you I<do want> lots of policy (this can arguably be somewhat
68useful) and you want to force your users to use the one and only event 90useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module. 91model, you should I<not> use this module.
70 92
71=head1 DESCRIPTION 93=head1 DESCRIPTION
72 94
102starts using it, all bets are off. Maybe you should tell their authors to 124starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly... 125use AnyEvent so their modules work together with others seamlessly...
104 126
105The pure-perl implementation of AnyEvent is called 127The pure-perl implementation of AnyEvent is called
106C<AnyEvent::Impl::Perl>. Like other event modules you can load it 128C<AnyEvent::Impl::Perl>. Like other event modules you can load it
107explicitly. 129explicitly and enjoy the high availability of that event loop :)
108 130
109=head1 WATCHERS 131=head1 WATCHERS
110 132
111AnyEvent has the central concept of a I<watcher>, which is an object that 133AnyEvent has the central concept of a I<watcher>, which is an object that
112stores relevant data for each kind of event you are waiting for, such as 134stores relevant data for each kind of event you are waiting for, such as
126Many watchers either are used with "recursion" (repeating timers for 148Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways. 149example), or need to refer to their watcher object in other ways.
128 150
129An any way to achieve that is this pattern: 151An any way to achieve that is this pattern:
130 152
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 153 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it 154 # you can use $w here, for example to undef it
133 undef $w; 155 undef $w;
134 }); 156 });
135 157
136Note that C<my $w; $w => combination. This is necessary because in Perl, 158Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are 159my variables are only visible after the statement in which they are
138declared. 160declared.
139 161
140=head2 I/O WATCHERS 162=head2 I/O WATCHERS
141 163
142You can create an I/O watcher by calling the C<< AnyEvent->io >> method 164You can create an I/O watcher by calling the C<< AnyEvent->io >> method
143with the following mandatory key-value pairs as arguments: 165with the following mandatory key-value pairs as arguments:
144 166
145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 167C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
146for events. C<poll> must be a string that is either C<r> or C<w>, 168(AnyEvent might or might not keep a reference to this file handle). C<poll>
147which creates a watcher waiting for "r"eadable or "w"ritable events, 169must be a string that is either C<r> or C<w>, which creates a watcher
148respectively. C<cb> is the callback to invoke each time the file handle 170waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
149becomes ready. 171callback to invoke each time the file handle becomes ready.
150 172
151Although the callback might get passed parameters, their value and 173Although the callback might get passed parameters, their value and
152presence is undefined and you cannot rely on them. Portable AnyEvent 174presence is undefined and you cannot rely on them. Portable AnyEvent
153callbacks cannot use arguments passed to I/O watcher callbacks. 175callbacks cannot use arguments passed to I/O watcher callbacks.
154 176
158 180
159Some event loops issue spurious readyness notifications, so you should 181Some event loops issue spurious readyness notifications, so you should
160always use non-blocking calls when reading/writing from/to your file 182always use non-blocking calls when reading/writing from/to your file
161handles. 183handles.
162 184
163Example:
164
165 # wait for readability of STDIN, then read a line and disable the watcher 185Example: wait for readability of STDIN, then read a line and disable the
186watcher.
187
166 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 188 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
167 chomp (my $input = <STDIN>); 189 chomp (my $input = <STDIN>);
168 warn "read: $input\n"; 190 warn "read: $input\n";
169 undef $w; 191 undef $w;
170 }); 192 });
180 202
181Although the callback might get passed parameters, their value and 203Although the callback might get passed parameters, their value and
182presence is undefined and you cannot rely on them. Portable AnyEvent 204presence is undefined and you cannot rely on them. Portable AnyEvent
183callbacks cannot use arguments passed to time watcher callbacks. 205callbacks cannot use arguments passed to time watcher callbacks.
184 206
185The timer callback will be invoked at most once: if you want a repeating 207The callback will normally be invoked once only. If you specify another
186timer you have to create a new watcher (this is a limitation by both Tk 208parameter, C<interval>, as a strictly positive number (> 0), then the
187and Glib). 209callback will be invoked regularly at that interval (in fractional
210seconds) after the first invocation. If C<interval> is specified with a
211false value, then it is treated as if it were missing.
188 212
189Example: 213The callback will be rescheduled before invoking the callback, but no
214attempt is done to avoid timer drift in most backends, so the interval is
215only approximate.
190 216
191 # fire an event after 7.7 seconds 217Example: fire an event after 7.7 seconds.
218
192 my $w = AnyEvent->timer (after => 7.7, cb => sub { 219 my $w = AnyEvent->timer (after => 7.7, cb => sub {
193 warn "timeout\n"; 220 warn "timeout\n";
194 }); 221 });
195 222
196 # to cancel the timer: 223 # to cancel the timer:
197 undef $w; 224 undef $w;
198 225
199Example 2:
200
201 # fire an event after 0.5 seconds, then roughly every second 226Example 2: fire an event after 0.5 seconds, then roughly every second.
202 my $w;
203 227
204 my $cb = sub {
205 # cancel the old timer while creating a new one
206 $w = AnyEvent->timer (after => 1, cb => $cb); 228 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
229 warn "timeout\n";
207 }; 230 };
208
209 # start the "loop" by creating the first watcher
210 $w = AnyEvent->timer (after => 0.5, cb => $cb);
211 231
212=head3 TIMING ISSUES 232=head3 TIMING ISSUES
213 233
214There are two ways to handle timers: based on real time (relative, "fire 234There are two ways to handle timers: based on real time (relative, "fire
215in 10 seconds") and based on wallclock time (absolute, "fire at 12 235in 10 seconds") and based on wallclock time (absolute, "fire at 12
227timers. 247timers.
228 248
229AnyEvent always prefers relative timers, if available, matching the 249AnyEvent always prefers relative timers, if available, matching the
230AnyEvent API. 250AnyEvent API.
231 251
252AnyEvent has two additional methods that return the "current time":
253
254=over 4
255
256=item AnyEvent->time
257
258This returns the "current wallclock time" as a fractional number of
259seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time>
260return, and the result is guaranteed to be compatible with those).
261
262It progresses independently of any event loop processing, i.e. each call
263will check the system clock, which usually gets updated frequently.
264
265=item AnyEvent->now
266
267This also returns the "current wallclock time", but unlike C<time>, above,
268this value might change only once per event loop iteration, depending on
269the event loop (most return the same time as C<time>, above). This is the
270time that AnyEvent's timers get scheduled against.
271
272I<In almost all cases (in all cases if you don't care), this is the
273function to call when you want to know the current time.>
274
275This function is also often faster then C<< AnyEvent->time >>, and
276thus the preferred method if you want some timestamp (for example,
277L<AnyEvent::Handle> uses this to update it's activity timeouts).
278
279The rest of this section is only of relevance if you try to be very exact
280with your timing, you can skip it without bad conscience.
281
282For a practical example of when these times differ, consider L<Event::Lib>
283and L<EV> and the following set-up:
284
285The event loop is running and has just invoked one of your callback at
286time=500 (assume no other callbacks delay processing). In your callback,
287you wait a second by executing C<sleep 1> (blocking the process for a
288second) and then (at time=501) you create a relative timer that fires
289after three seconds.
290
291With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will
292both return C<501>, because that is the current time, and the timer will
293be scheduled to fire at time=504 (C<501> + C<3>).
294
295With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current
296time), but C<< AnyEvent->now >> returns C<500>, as that is the time the
297last event processing phase started. With L<EV>, your timer gets scheduled
298to run at time=503 (C<500> + C<3>).
299
300In one sense, L<Event::Lib> is more exact, as it uses the current time
301regardless of any delays introduced by event processing. However, most
302callbacks do not expect large delays in processing, so this causes a
303higher drift (and a lot more system calls to get the current time).
304
305In another sense, L<EV> is more exact, as your timer will be scheduled at
306the same time, regardless of how long event processing actually took.
307
308In either case, if you care (and in most cases, you don't), then you
309can get whatever behaviour you want with any event loop, by taking the
310difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
311account.
312
313=back
314
232=head2 SIGNAL WATCHERS 315=head2 SIGNAL WATCHERS
233 316
234You can watch for signals using a signal watcher, C<signal> is the signal 317You can watch for signals using a signal watcher, C<signal> is the signal
235I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 318I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
236be invoked whenever a signal occurs. 319callback to be invoked whenever a signal occurs.
237 320
238Although the callback might get passed parameters, their value and 321Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 322presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 323callbacks cannot use arguments passed to signal watcher callbacks.
241 324
257=head2 CHILD PROCESS WATCHERS 340=head2 CHILD PROCESS WATCHERS
258 341
259You can also watch on a child process exit and catch its exit status. 342You can also watch on a child process exit and catch its exit status.
260 343
261The child process is specified by the C<pid> argument (if set to C<0>, it 344The child process is specified by the C<pid> argument (if set to C<0>, it
262watches for any child process exit). The watcher will trigger as often 345watches for any child process exit). The watcher will triggered only when
263as status change for the child are received. This works by installing a 346the child process has finished and an exit status is available, not on
264signal handler for C<SIGCHLD>. The callback will be called with the pid 347any trace events (stopped/continued).
265and exit status (as returned by waitpid), so unlike other watcher types, 348
266you I<can> rely on child watcher callback arguments. 349The callback will be called with the pid and exit status (as returned by
350waitpid), so unlike other watcher types, you I<can> rely on child watcher
351callback arguments.
352
353This watcher type works by installing a signal handler for C<SIGCHLD>,
354and since it cannot be shared, nothing else should use SIGCHLD or reap
355random child processes (waiting for specific child processes, e.g. inside
356C<system>, is just fine).
267 357
268There is a slight catch to child watchers, however: you usually start them 358There is a slight catch to child watchers, however: you usually start them
269I<after> the child process was created, and this means the process could 359I<after> the child process was created, and this means the process could
270have exited already (and no SIGCHLD will be sent anymore). 360have exited already (and no SIGCHLD will be sent anymore).
271 361
277AnyEvent program, you I<have> to create at least one watcher before you 367AnyEvent program, you I<have> to create at least one watcher before you
278C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 368C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
279 369
280Example: fork a process and wait for it 370Example: fork a process and wait for it
281 371
282 my $done = AnyEvent->condvar; 372 my $done = AnyEvent->condvar;
283 373
284 my $pid = fork or exit 5; 374 my $pid = fork or exit 5;
285 375
286 my $w = AnyEvent->child ( 376 my $w = AnyEvent->child (
287 pid => $pid, 377 pid => $pid,
288 cb => sub { 378 cb => sub {
289 my ($pid, $status) = @_; 379 my ($pid, $status) = @_;
290 warn "pid $pid exited with status $status"; 380 warn "pid $pid exited with status $status";
291 $done->send; 381 $done->send;
292 }, 382 },
293 ); 383 );
294 384
295 # do something else, then wait for process exit 385 # do something else, then wait for process exit
296 $done->recv; 386 $done->recv;
297 387
298=head2 CONDITION VARIABLES 388=head2 CONDITION VARIABLES
299 389
300If you are familiar with some event loops you will know that all of them 390If you are familiar with some event loops you will know that all of them
301require you to run some blocking "loop", "run" or similar function that 391require you to run some blocking "loop", "run" or similar function that
307The instrument to do that is called a "condition variable", so called 397The instrument to do that is called a "condition variable", so called
308because they represent a condition that must become true. 398because they represent a condition that must become true.
309 399
310Condition variables can be created by calling the C<< AnyEvent->condvar 400Condition variables can be created by calling the C<< AnyEvent->condvar
311>> method, usually without arguments. The only argument pair allowed is 401>> method, usually without arguments. The only argument pair allowed is
402
312C<cb>, which specifies a callback to be called when the condition variable 403C<cb>, which specifies a callback to be called when the condition variable
313becomes true. 404becomes true, with the condition variable as the first argument (but not
405the results).
314 406
315After creation, the condition variable is "false" until it becomes "true" 407After creation, the condition variable is "false" until it becomes "true"
316by calling the C<send> method (or calling the condition variable as if it 408by calling the C<send> method (or calling the condition variable as if it
317were a callback). 409were a callback, read about the caveats in the description for the C<<
410->send >> method).
318 411
319Condition variables are similar to callbacks, except that you can 412Condition variables are similar to callbacks, except that you can
320optionally wait for them. They can also be called merge points - points 413optionally wait for them. They can also be called merge points - points
321in time where multiple outstanding events have been processed. And yet 414in time where multiple outstanding events have been processed. And yet
322another way to call them is transactions - each condition variable can be 415another way to call them is transactions - each condition variable can be
373 466
374 my $done = AnyEvent->condvar; 467 my $done = AnyEvent->condvar;
375 my $delay = AnyEvent->timer (after => 5, cb => $done); 468 my $delay = AnyEvent->timer (after => 5, cb => $done);
376 $done->recv; 469 $done->recv;
377 470
471Example: Imagine an API that returns a condvar and doesn't support
472callbacks. This is how you make a synchronous call, for example from
473the main program:
474
475 use AnyEvent::CouchDB;
476
477 ...
478
479 my @info = $couchdb->info->recv;
480
481And this is how you would just ste a callback to be called whenever the
482results are available:
483
484 $couchdb->info->cb (sub {
485 my @info = $_[0]->recv;
486 });
487
378=head3 METHODS FOR PRODUCERS 488=head3 METHODS FOR PRODUCERS
379 489
380These methods should only be used by the producing side, i.e. the 490These methods should only be used by the producing side, i.e. the
381code/module that eventually sends the signal. Note that it is also 491code/module that eventually sends the signal. Note that it is also
382the producer side which creates the condvar in most cases, but it isn't 492the producer side which creates the condvar in most cases, but it isn't
394immediately from within send. 504immediately from within send.
395 505
396Any arguments passed to the C<send> call will be returned by all 506Any arguments passed to the C<send> call will be returned by all
397future C<< ->recv >> calls. 507future C<< ->recv >> calls.
398 508
399Condition variables are overloaded so one can call them directly (as a 509Condition variables are overloaded so one can call them directly
400code reference). Calling them directly is the same as calling C<send>. 510(as a code reference). Calling them directly is the same as calling
511C<send>. Note, however, that many C-based event loops do not handle
512overloading, so as tempting as it may be, passing a condition variable
513instead of a callback does not work. Both the pure perl and EV loops
514support overloading, however, as well as all functions that use perl to
515invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for
516example).
401 517
402=item $cv->croak ($error) 518=item $cv->croak ($error)
403 519
404Similar to send, but causes all call's to C<< ->recv >> to invoke 520Similar to send, but causes all call's to C<< ->recv >> to invoke
405C<Carp::croak> with the given error message/object/scalar. 521C<Carp::croak> with the given error message/object/scalar.
509=item $bool = $cv->ready 625=item $bool = $cv->ready
510 626
511Returns true when the condition is "true", i.e. whether C<send> or 627Returns true when the condition is "true", i.e. whether C<send> or
512C<croak> have been called. 628C<croak> have been called.
513 629
514=item $cb = $cv->cb ([new callback]) 630=item $cb = $cv->cb ($cb->($cv))
515 631
516This is a mutator function that returns the callback set and optionally 632This is a mutator function that returns the callback set and optionally
517replaces it before doing so. 633replaces it before doing so.
518 634
519The callback will be called when the condition becomes "true", i.e. when 635The callback will be called when the condition becomes "true", i.e. when
520C<send> or C<croak> are called. Calling C<recv> inside the callback 636C<send> or C<croak> are called, with the only argument being the condition
521or at any later time is guaranteed not to block. 637variable itself. Calling C<recv> inside the callback or at any later time
638is guaranteed not to block.
522 639
523=back 640=back
524 641
525=head1 GLOBAL VARIABLES AND FUNCTIONS 642=head1 GLOBAL VARIABLES AND FUNCTIONS
526 643
655=item L<AnyEvent::Util> 772=item L<AnyEvent::Util>
656 773
657Contains various utility functions that replace often-used but blocking 774Contains various utility functions that replace often-used but blocking
658functions such as C<inet_aton> by event-/callback-based versions. 775functions such as C<inet_aton> by event-/callback-based versions.
659 776
660=item L<AnyEvent::Handle>
661
662Provide read and write buffers and manages watchers for reads and writes.
663
664=item L<AnyEvent::Socket> 777=item L<AnyEvent::Socket>
665 778
666Provides various utility functions for (internet protocol) sockets, 779Provides various utility functions for (internet protocol) sockets,
667addresses and name resolution. Also functions to create non-blocking tcp 780addresses and name resolution. Also functions to create non-blocking tcp
668connections or tcp servers, with IPv6 and SRV record support and more. 781connections or tcp servers, with IPv6 and SRV record support and more.
669 782
783=item L<AnyEvent::Handle>
784
785Provide read and write buffers, manages watchers for reads and writes,
786supports raw and formatted I/O, I/O queued and fully transparent and
787non-blocking SSL/TLS.
788
670=item L<AnyEvent::DNS> 789=item L<AnyEvent::DNS>
671 790
672Provides rich asynchronous DNS resolver capabilities. 791Provides rich asynchronous DNS resolver capabilities.
673 792
793=item L<AnyEvent::HTTP>
794
795A simple-to-use HTTP library that is capable of making a lot of concurrent
796HTTP requests.
797
674=item L<AnyEvent::HTTPD> 798=item L<AnyEvent::HTTPD>
675 799
676Provides a simple web application server framework. 800Provides a simple web application server framework.
677 801
678=item L<AnyEvent::FastPing> 802=item L<AnyEvent::FastPing>
679 803
680The fastest ping in the west. 804The fastest ping in the west.
805
806=item L<AnyEvent::DBI>
807
808Executes L<DBI> requests asynchronously in a proxy process.
809
810=item L<AnyEvent::AIO>
811
812Truly asynchronous I/O, should be in the toolbox of every event
813programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
814together.
815
816=item L<AnyEvent::BDB>
817
818Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
819L<BDB> and AnyEvent together.
820
821=item L<AnyEvent::GPSD>
822
823A non-blocking interface to gpsd, a daemon delivering GPS information.
824
825=item L<AnyEvent::IGS>
826
827A non-blocking interface to the Internet Go Server protocol (used by
828L<App::IGS>).
681 829
682=item L<Net::IRC3> 830=item L<Net::IRC3>
683 831
684AnyEvent based IRC client module family. 832AnyEvent based IRC client module family.
685 833
698 846
699=item L<Coro> 847=item L<Coro>
700 848
701Has special support for AnyEvent via L<Coro::AnyEvent>. 849Has special support for AnyEvent via L<Coro::AnyEvent>.
702 850
703=item L<AnyEvent::AIO>, L<IO::AIO>
704
705Truly asynchronous I/O, should be in the toolbox of every event
706programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
707together.
708
709=item L<AnyEvent::BDB>, L<BDB>
710
711Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
712IO::AIO and AnyEvent together.
713
714=item L<IO::Lambda> 851=item L<IO::Lambda>
715 852
716The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 853The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
717 854
718=back 855=back
720=cut 857=cut
721 858
722package AnyEvent; 859package AnyEvent;
723 860
724no warnings; 861no warnings;
725use strict; 862use strict qw(vars subs);
726 863
727use Carp; 864use Carp;
728 865
729our $VERSION = '4.03'; 866our $VERSION = 4.3;
730our $MODEL; 867our $MODEL;
731 868
732our $AUTOLOAD; 869our $AUTOLOAD;
733our @ISA; 870our @ISA;
734 871
872our @REGISTRY;
873
874our $WIN32;
875
876BEGIN {
877 my $win32 = ! ! ($^O =~ /mswin32/i);
878 eval "sub WIN32(){ $win32 }";
879}
880
735our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 881our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
736 882
737our @REGISTRY; 883our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
738
739our %PROTOCOL; # (ipv4|ipv6) => (1|2)
740 884
741{ 885{
742 my $idx; 886 my $idx;
743 $PROTOCOL{$_} = ++$idx 887 $PROTOCOL{$_} = ++$idx
888 for reverse split /\s*,\s*/,
744 for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 889 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
745} 890}
746 891
747my @models = ( 892my @models = (
748 [EV:: => AnyEvent::Impl::EV::], 893 [EV:: => AnyEvent::Impl::EV::],
749 [Event:: => AnyEvent::Impl::Event::], 894 [Event:: => AnyEvent::Impl::Event::],
750 [Tk:: => AnyEvent::Impl::Tk::],
751 [Wx:: => AnyEvent::Impl::POE::],
752 [Prima:: => AnyEvent::Impl::POE::],
753 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 895 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
754 # everything below here will not be autoprobed as the pureperl backend should work everywhere 896 # everything below here will not be autoprobed
755 [Glib:: => AnyEvent::Impl::Glib::], 897 # as the pureperl backend should work everywhere
898 # and is usually faster
899 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
900 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
756 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 901 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
757 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 902 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
758 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 903 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
904 [Wx:: => AnyEvent::Impl::POE::],
905 [Prima:: => AnyEvent::Impl::POE::],
759); 906);
760 907
761our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); 908our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY);
762 909
763our @post_detect; 910our @post_detect;
764 911
765sub post_detect(&) { 912sub post_detect(&) {
766 my ($cb) = @_; 913 my ($cb) = @_;
783} 930}
784 931
785sub detect() { 932sub detect() {
786 unless ($MODEL) { 933 unless ($MODEL) {
787 no strict 'refs'; 934 no strict 'refs';
935 local $SIG{__DIE__};
788 936
789 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 937 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
790 my $model = "AnyEvent::Impl::$1"; 938 my $model = "AnyEvent::Impl::$1";
791 if (eval "require $model") { 939 if (eval "require $model") {
792 $MODEL = $model; 940 $MODEL = $model;
826 $MODEL 974 $MODEL
827 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 975 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
828 } 976 }
829 } 977 }
830 978
979 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
980
831 unshift @ISA, $MODEL; 981 unshift @ISA, $MODEL;
832 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 982
983 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
833 984
834 (shift @post_detect)->() while @post_detect; 985 (shift @post_detect)->() while @post_detect;
835 } 986 }
836 987
837 $MODEL 988 $MODEL
847 998
848 my $class = shift; 999 my $class = shift;
849 $class->$func (@_); 1000 $class->$func (@_);
850} 1001}
851 1002
1003# utility function to dup a filehandle. this is used by many backends
1004# to support binding more than one watcher per filehandle (they usually
1005# allow only one watcher per fd, so we dup it to get a different one).
1006sub _dupfh($$$$) {
1007 my ($poll, $fh, $r, $w) = @_;
1008
1009 require Fcntl;
1010
1011 # cygwin requires the fh mode to be matching, unix doesn't
1012 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1013 : $poll eq "w" ? ($w, ">")
1014 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1015
1016 open my $fh2, "$mode&" . fileno $fh
1017 or die "cannot dup() filehandle: $!";
1018
1019 # we assume CLOEXEC is already set by perl in all important cases
1020
1021 ($fh2, $rw)
1022}
1023
852package AnyEvent::Base; 1024package AnyEvent::Base;
1025
1026# default implementation for now and time
1027
1028BEGIN {
1029 if (eval "use Time::HiRes (); time (); 1") {
1030 *_time = \&Time::HiRes::time;
1031 # if (eval "use POSIX (); (POSIX::times())...
1032 } else {
1033 *_time = sub { time }; # epic fail
1034 }
1035}
1036
1037sub time { _time }
1038sub now { _time }
853 1039
854# default implementation for ->condvar 1040# default implementation for ->condvar
855 1041
856sub condvar { 1042sub condvar {
857 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1043 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
878sub AnyEvent::Base::Signal::DESTROY { 1064sub AnyEvent::Base::Signal::DESTROY {
879 my ($signal, $cb) = @{$_[0]}; 1065 my ($signal, $cb) = @{$_[0]};
880 1066
881 delete $SIG_CB{$signal}{$cb}; 1067 delete $SIG_CB{$signal}{$cb};
882 1068
883 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1069 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
884} 1070}
885 1071
886# default implementation for ->child 1072# default implementation for ->child
887 1073
888our %PID_CB; 1074our %PID_CB;
915 or Carp::croak "required option 'pid' is missing"; 1101 or Carp::croak "required option 'pid' is missing";
916 1102
917 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1103 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
918 1104
919 unless ($WNOHANG) { 1105 unless ($WNOHANG) {
920 $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; 1106 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
921 } 1107 }
922 1108
923 unless ($CHLD_W) { 1109 unless ($CHLD_W) {
924 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1110 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
925 # child could be a zombie already, so make at least one round 1111 # child could be a zombie already, so make at least one round
995} 1181}
996 1182
997# undocumented/compatibility with pre-3.4 1183# undocumented/compatibility with pre-3.4
998*broadcast = \&send; 1184*broadcast = \&send;
999*wait = \&_wait; 1185*wait = \&_wait;
1186
1187=head1 ERROR AND EXCEPTION HANDLING
1188
1189In general, AnyEvent does not do any error handling - it relies on the
1190caller to do that if required. The L<AnyEvent::Strict> module (see also
1191the C<PERL_ANYEVENT_STRICT> environment variable, below) provides strict
1192checking of all AnyEvent methods, however, which is highly useful during
1193development.
1194
1195As for exception handling (i.e. runtime errors and exceptions thrown while
1196executing a callback), this is not only highly event-loop specific, but
1197also not in any way wrapped by this module, as this is the job of the main
1198program.
1199
1200The pure perl event loop simply re-throws the exception (usually
1201within C<< condvar->recv >>), the L<Event> and L<EV> modules call C<<
1202$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1203so on.
1204
1205=head1 ENVIRONMENT VARIABLES
1206
1207The following environment variables are used by this module or its
1208submodules:
1209
1210=over 4
1211
1212=item C<PERL_ANYEVENT_VERBOSE>
1213
1214By default, AnyEvent will be completely silent except in fatal
1215conditions. You can set this environment variable to make AnyEvent more
1216talkative.
1217
1218When set to C<1> or higher, causes AnyEvent to warn about unexpected
1219conditions, such as not being able to load the event model specified by
1220C<PERL_ANYEVENT_MODEL>.
1221
1222When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1223model it chooses.
1224
1225=item C<PERL_ANYEVENT_STRICT>
1226
1227AnyEvent does not do much argument checking by default, as thorough
1228argument checking is very costly. Setting this variable to a true value
1229will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1230check the arguments passed to most method calls. If it finds any problems
1231it will croak.
1232
1233In other words, enables "strict" mode.
1234
1235Unlike C<use strict>, it is definitely recommended ot keep it off in
1236production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1237developing programs can be very useful, however.
1238
1239=item C<PERL_ANYEVENT_MODEL>
1240
1241This can be used to specify the event model to be used by AnyEvent, before
1242auto detection and -probing kicks in. It must be a string consisting
1243entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1244and the resulting module name is loaded and if the load was successful,
1245used as event model. If it fails to load AnyEvent will proceed with
1246auto detection and -probing.
1247
1248This functionality might change in future versions.
1249
1250For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1251could start your program like this:
1252
1253 PERL_ANYEVENT_MODEL=Perl perl ...
1254
1255=item C<PERL_ANYEVENT_PROTOCOLS>
1256
1257Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1258for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1259of auto probing).
1260
1261Must be set to a comma-separated list of protocols or address families,
1262current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1263used, and preference will be given to protocols mentioned earlier in the
1264list.
1265
1266This variable can effectively be used for denial-of-service attacks
1267against local programs (e.g. when setuid), although the impact is likely
1268small, as the program has to handle connection errors already-
1269
1270Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1271but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1272- only support IPv4, never try to resolve or contact IPv6
1273addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1274IPv6, but prefer IPv6 over IPv4.
1275
1276=item C<PERL_ANYEVENT_EDNS0>
1277
1278Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1279for DNS. This extension is generally useful to reduce DNS traffic, but
1280some (broken) firewalls drop such DNS packets, which is why it is off by
1281default.
1282
1283Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1284EDNS0 in its DNS requests.
1285
1286=item C<PERL_ANYEVENT_MAX_FORKS>
1287
1288The maximum number of child processes that C<AnyEvent::Util::fork_call>
1289will create in parallel.
1290
1291=back
1000 1292
1001=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1293=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1002 1294
1003This is an advanced topic that you do not normally need to use AnyEvent in 1295This is an advanced topic that you do not normally need to use AnyEvent in
1004a module. This section is only of use to event loop authors who want to 1296a module. This section is only of use to event loop authors who want to
1038 1330
1039I<rxvt-unicode> also cheats a bit by not providing blocking access to 1331I<rxvt-unicode> also cheats a bit by not providing blocking access to
1040condition variables: code blocking while waiting for a condition will 1332condition variables: code blocking while waiting for a condition will
1041C<die>. This still works with most modules/usages, and blocking calls must 1333C<die>. This still works with most modules/usages, and blocking calls must
1042not be done in an interactive application, so it makes sense. 1334not be done in an interactive application, so it makes sense.
1043
1044=head1 ENVIRONMENT VARIABLES
1045
1046The following environment variables are used by this module:
1047
1048=over 4
1049
1050=item C<PERL_ANYEVENT_VERBOSE>
1051
1052By default, AnyEvent will be completely silent except in fatal
1053conditions. You can set this environment variable to make AnyEvent more
1054talkative.
1055
1056When set to C<1> or higher, causes AnyEvent to warn about unexpected
1057conditions, such as not being able to load the event model specified by
1058C<PERL_ANYEVENT_MODEL>.
1059
1060When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1061model it chooses.
1062
1063=item C<PERL_ANYEVENT_MODEL>
1064
1065This can be used to specify the event model to be used by AnyEvent, before
1066auto detection and -probing kicks in. It must be a string consisting
1067entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1068and the resulting module name is loaded and if the load was successful,
1069used as event model. If it fails to load AnyEvent will proceed with
1070auto detection and -probing.
1071
1072This functionality might change in future versions.
1073
1074For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1075could start your program like this:
1076
1077 PERL_ANYEVENT_MODEL=Perl perl ...
1078
1079=item C<PERL_ANYEVENT_PROTOCOLS>
1080
1081Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1082for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1083of auto probing).
1084
1085Must be set to a comma-separated list of protocols or address families,
1086current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1087used, and preference will be given to protocols mentioned earlier in the
1088list.
1089
1090This variable can effectively be used for denial-of-service attacks
1091against local programs (e.g. when setuid), although the impact is likely
1092small, as the program has to handle connection errors already-
1093
1094Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1095but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1096- only support IPv4, never try to resolve or contact IPv6
1097addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1098IPv6, but prefer IPv6 over IPv4.
1099
1100=item C<PERL_ANYEVENT_EDNS0>
1101
1102Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1103for DNS. This extension is generally useful to reduce DNS traffic, but
1104some (broken) firewalls drop such DNS packets, which is why it is off by
1105default.
1106
1107Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1108EDNS0 in its DNS requests.
1109
1110=back
1111 1335
1112=head1 EXAMPLE PROGRAM 1336=head1 EXAMPLE PROGRAM
1113 1337
1114The following program uses an I/O watcher to read data from STDIN, a timer 1338The following program uses an I/O watcher to read data from STDIN, a timer
1115to display a message once per second, and a condition variable to quit the 1339to display a message once per second, and a condition variable to quit the
1552specified in the variable. 1776specified in the variable.
1553 1777
1554You can make AnyEvent completely ignore this variable by deleting it 1778You can make AnyEvent completely ignore this variable by deleting it
1555before the first watcher gets created, e.g. with a C<BEGIN> block: 1779before the first watcher gets created, e.g. with a C<BEGIN> block:
1556 1780
1557 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1781 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1558 1782
1559 use AnyEvent; 1783 use AnyEvent;
1560 1784
1561Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1785Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1562be used to probe what backend is used and gain other information (which is 1786be used to probe what backend is used and gain other information (which is
1563probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1787probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1788$ENV{PERL_ANYEGENT_STRICT}.
1789
1790
1791=head1 BUGS
1792
1793Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1794to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1795and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1796mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1797pronounced).
1564 1798
1565 1799
1566=head1 SEE ALSO 1800=head1 SEE ALSO
1567 1801
1568Utility functions: L<AnyEvent::Util>. 1802Utility functions: L<AnyEvent::Util>.
1585Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 1819Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1586 1820
1587 1821
1588=head1 AUTHOR 1822=head1 AUTHOR
1589 1823
1590 Marc Lehmann <schmorp@schmorp.de> 1824 Marc Lehmann <schmorp@schmorp.de>
1591 http://home.schmorp.de/ 1825 http://home.schmorp.de/
1592 1826
1593=cut 1827=cut
1594 1828
15951 18291
1596 1830

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines