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.38 by root, Sun Nov 25 14:08:12 2007 UTC vs.
Revision 1.84 by root, Fri Apr 25 13:48:42 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
5Event, Coro, Glib, Tk, Perl - various supported event loops 5EV, Event, Coro::EV, Coro::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
14 14
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 15 my $w = AnyEvent->timer (after => $seconds, cb => sub {
16 ... 16 ...
17 }); 17 });
18 18
19 my $w = AnyEvent->condvar; # stores wether a condition was flagged 19 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->wait; # enters "main loop" till $condvar gets ->broadcast 20 $w->wait; # enters "main loop" till $condvar gets ->broadcast
21 $w->broadcast; # wake up current and all future wait's 21 $w->broadcast; # wake up current and all future wait's
22
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent?
27
28Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29policy> and AnyEvent is I<small and efficient>.
30
31First 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
33pragmatic way. For event models and certain classes of immortals alike,
34the 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
36helps hiding the differences between those event loops.
37
38The 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
40religion, a way of living, and most importantly: without forcing your
41module users into the same thing by forcing them to use the same event
42model you use.
43
44For 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
46like 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
48isn't itself. What's worse, all the potential users of your module are
49I<also> forced to use the same event loop you use.
50
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. 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
54your 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
56event models it supports (including stuff like POE and IO::Async, as long
57as those use one of the supported event loops. It is trivial to add new
58event loops to AnyEvent, too, so it is future-proof).
59
60In 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
62modules, you get an enourmous amount of code and strict rules you have to
63follow. 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
65technically possible.
66
67Of course, if you want lots of policy (this can arguably be somewhat
68useful) and you want to force your users to use the one and only event
69model, you should I<not> use this module.
70
22 71
23=head1 DESCRIPTION 72=head1 DESCRIPTION
24 73
25L<AnyEvent> provides an identical interface to multiple event loops. This 74L<AnyEvent> provides an identical interface to multiple event loops. This
26allows module authors to utilise an event loop without forcing module 75allows module authors to utilise an event loop without forcing module
27users to use the same event loop (as only a single event loop can coexist 76users to use the same event loop (as only a single event loop can coexist
28peacefully at any one time). 77peacefully at any one time).
29 78
30The interface itself is vaguely similar but not identical to the Event 79The interface itself is vaguely similar, but not identical to the L<Event>
31module. 80module.
32 81
33On the first call of any method, the module tries to detect the currently 82During the first call of any watcher-creation method, the module tries
34loaded event loop by probing wether any of the following modules is 83to detect the currently loaded event loop by probing whether one of the
35loaded: L<Coro::Event>, L<Event>, L<Glib>, L<Tk>. The first one found is 84following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>,
36used. If none is found, the module tries to load these modules in the 85L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>,
37order given. The first one that could be successfully loaded will be 86L<POE>. The first one found is used. If none are found, the module tries
38used. If still none could be found, AnyEvent will fall back to a pure-perl 87to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl
39event loop, which is also not very efficient. 88adaptor should always succeed) in the order given. The first one that can
89be successfully loaded will be used. If, after this, still none could be
90found, AnyEvent will fall back to a pure-perl event loop, which is not
91very efficient, but should work everywhere.
40 92
41Because AnyEvent first checks for modules that are already loaded, loading 93Because AnyEvent first checks for modules that are already loaded, loading
42an Event model explicitly before first using AnyEvent will likely make 94an event model explicitly before first using AnyEvent will likely make
43that model the default. For example: 95that model the default. For example:
44 96
45 use Tk; 97 use Tk;
46 use AnyEvent; 98 use AnyEvent;
47 99
48 # .. AnyEvent will likely default to Tk 100 # .. AnyEvent will likely default to Tk
101
102The I<likely> means that, if any module loads another event model and
103starts using it, all bets are off. Maybe you should tell their authors to
104use AnyEvent so their modules work together with others seamlessly...
49 105
50The pure-perl implementation of AnyEvent is called 106The pure-perl implementation of AnyEvent is called
51C<AnyEvent::Impl::Perl>. Like other event modules you can load it 107C<AnyEvent::Impl::Perl>. Like other event modules you can load it
52explicitly. 108explicitly.
53 109
56AnyEvent has the central concept of a I<watcher>, which is an object that 112AnyEvent has the central concept of a I<watcher>, which is an object that
57stores relevant data for each kind of event you are waiting for, such as 113stores relevant data for each kind of event you are waiting for, such as
58the callback to call, the filehandle to watch, etc. 114the callback to call, the filehandle to watch, etc.
59 115
60These watchers are normal Perl objects with normal Perl lifetime. After 116These watchers are normal Perl objects with normal Perl lifetime. After
61creating a watcher it will immediately "watch" for events and invoke 117creating a watcher it will immediately "watch" for events and invoke the
118callback when the event occurs (of course, only when the event model
119is in control).
120
62the callback. To disable the watcher you have to destroy it (e.g. by 121To disable the watcher you have to destroy it (e.g. by setting the
63setting the variable that stores it to C<undef> or otherwise deleting all 122variable you store it in to C<undef> or otherwise deleting all references
64references to it). 123to it).
65 124
66All watchers are created by calling a method on the C<AnyEvent> class. 125All watchers are created by calling a method on the C<AnyEvent> class.
67 126
127Many watchers either are used with "recursion" (repeating timers for
128example), or need to refer to their watcher object in other ways.
129
130An any way to achieve that is this pattern:
131
132 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
133 # you can use $w here, for example to undef it
134 undef $w;
135 });
136
137Note that C<my $w; $w => combination. This is necessary because in Perl,
138my variables are only visible after the statement in which they are
139declared.
140
68=head2 IO WATCHERS 141=head2 I/O WATCHERS
69 142
70You can create I/O watcher by calling the C<< AnyEvent->io >> method with 143You can create an I/O watcher by calling the C<< AnyEvent->io >> method
71the following mandatory arguments: 144with the following mandatory key-value pairs as arguments:
72 145
73C<fh> the Perl I<filehandle> (not filedescriptor) to watch for 146C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for
74events. C<poll> must be a string that is either C<r> or C<w>, that creates 147events. C<poll> must be a string that is either C<r> or C<w>, which
75a watcher waiting for "r"eadable or "w"ritable events. C<cb> the callback 148creates a watcher waiting for "r"eadable or "w"ritable events,
76to invoke everytime the filehandle becomes ready. 149respectively. C<cb> is the callback to invoke each time the file handle
150becomes ready.
77 151
78Only one io watcher per C<fh> and C<poll> combination is allowed (i.e. on 152The I/O watcher might use the underlying file descriptor or a copy of it.
79a socket you can have one r + one w, not any more (limitation comes from 153You must not close a file handle as long as any watcher is active on the
80Tk - if you are sure you are not using Tk this limitation is gone). 154underlying file descriptor.
81 155
82Filehandles will be kept alive, so as long as the watcher exists, the 156Some event loops issue spurious readyness notifications, so you should
83filehandle exists, too. 157always use non-blocking calls when reading/writing from/to your file
158handles.
159
160Although the callback might get passed parameters, their value and
161presence is undefined and you cannot rely on them. Portable AnyEvent
162callbacks cannot use arguments passed to I/O watcher callbacks.
84 163
85Example: 164Example:
86 165
87 # wait for readability of STDIN, then read a line and disable the watcher 166 # wait for readability of STDIN, then read a line and disable the watcher
88 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 167 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
94=head2 TIME WATCHERS 173=head2 TIME WATCHERS
95 174
96You can create a time watcher by calling the C<< AnyEvent->timer >> 175You can create a time watcher by calling the C<< AnyEvent->timer >>
97method with the following mandatory arguments: 176method with the following mandatory arguments:
98 177
99C<after> after how many seconds (fractions are supported) should the timer 178C<after> specifies after how many seconds (fractional values are
100activate. C<cb> the callback to invoke. 179supported) should the timer activate. C<cb> the callback to invoke in that
180case.
101 181
102The timer callback will be invoked at most once: if you want a repeating 182The timer callback will be invoked at most once: if you want a repeating
103timer you have to create a new watcher (this is a limitation by both Tk 183timer you have to create a new watcher (this is a limitation by both Tk
104and Glib). 184and Glib).
185
186Although the callback might get passed parameters, their value and
187presence is undefined and you cannot rely on them. Portable AnyEvent
188callbacks cannot use arguments passed to time watcher callbacks.
105 189
106Example: 190Example:
107 191
108 # fire an event after 7.7 seconds 192 # fire an event after 7.7 seconds
109 my $w = AnyEvent->timer (after => 7.7, cb => sub { 193 my $w = AnyEvent->timer (after => 7.7, cb => sub {
111 }); 195 });
112 196
113 # to cancel the timer: 197 # to cancel the timer:
114 undef $w; 198 undef $w;
115 199
200Example 2:
201
202 # fire an event after 0.5 seconds, then roughly every second
203 my $w;
204
205 my $cb = sub {
206 # cancel the old timer while creating a new one
207 $w = AnyEvent->timer (after => 1, cb => $cb);
208 };
209
210 # start the "loop" by creating the first watcher
211 $w = AnyEvent->timer (after => 0.5, cb => $cb);
212
213=head3 TIMING ISSUES
214
215There are two ways to handle timers: based on real time (relative, "fire
216in 10 seconds") and based on wallclock time (absolute, "fire at 12
217o'clock").
218
219While most event loops expect timers to specified in a relative way, they
220use absolute time internally. This makes a difference when your clock
221"jumps", for example, when ntp decides to set your clock backwards from
222the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
223fire "after" a second might actually take six years to finally fire.
224
225AnyEvent cannot compensate for this. The only event loop that is conscious
226about these issues is L<EV>, which offers both relative (ev_timer, based
227on true relative time) and absolute (ev_periodic, based on wallclock time)
228timers.
229
230AnyEvent always prefers relative timers, if available, matching the
231AnyEvent API.
232
233=head2 SIGNAL WATCHERS
234
235You can watch for signals using a signal watcher, C<signal> is the signal
236I<name> without any C<SIG> prefix, C<cb> is the Perl callback to
237be invoked whenever a signal occurs.
238
239Multiple signal occurances can be clumped together into one callback
240invocation, and callback invocation will be synchronous. synchronous means
241that it might take a while until the signal gets handled by the process,
242but it is guarenteed not to interrupt any other callbacks.
243
244The main advantage of using these watchers is that you can share a signal
245between multiple watchers.
246
247This watcher might use C<%SIG>, so programs overwriting those signals
248directly will likely not work correctly.
249
250Example: exit on SIGINT
251
252 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
253
254=head2 CHILD PROCESS WATCHERS
255
256You can also watch on a child process exit and catch its exit status.
257
258The child process is specified by the C<pid> argument (if set to C<0>, it
259watches for any child process exit). The watcher will trigger as often
260as status change for the child are received. This works by installing a
261signal handler for C<SIGCHLD>. The callback will be called with the pid
262and exit status (as returned by waitpid).
263
264There is a slight catch to child watchers, however: you usually start them
265I<after> the child process was created, and this means the process could
266have exited already (and no SIGCHLD will be sent anymore).
267
268Not all event models handle this correctly (POE doesn't), but even for
269event models that I<do> handle this correctly, they usually need to be
270loaded before the process exits (i.e. before you fork in the first place).
271
272This means you cannot create a child watcher as the very first thing in an
273AnyEvent program, you I<have> to create at least one watcher before you
274C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
275
276Example: fork a process and wait for it
277
278 my $done = AnyEvent->condvar;
279
280 AnyEvent::detect; # force event module to be initialised
281
282 my $pid = fork or exit 5;
283
284 my $w = AnyEvent->child (
285 pid => $pid,
286 cb => sub {
287 my ($pid, $status) = @_;
288 warn "pid $pid exited with status $status";
289 $done->broadcast;
290 },
291 );
292
293 # do something else, then wait for process exit
294 $done->wait;
295
116=head2 CONDITION WATCHERS 296=head2 CONDITION VARIABLES
117 297
118Condition watchers can be created by calling the C<< AnyEvent->condvar >> 298Condition variables can be created by calling the C<< AnyEvent->condvar >>
119method without any arguments. 299method without any arguments.
120 300
121A condition watcher watches for a condition - precisely that the C<< 301A condition variable waits for a condition - precisely that the C<<
122->broadcast >> method has been called. 302->broadcast >> method has been called.
123 303
124The watcher has only two methods: 304They are very useful to signal that a condition has been fulfilled, for
305example, if you write a module that does asynchronous http requests,
306then a condition variable would be the ideal candidate to signal the
307availability of results.
308
309You can also use condition variables to block your main program until
310an event occurs - for example, you could C<< ->wait >> in your main
311program until the user clicks the Quit button in your app, which would C<<
312->broadcast >> the "quit" event.
313
314Note that condition variables recurse into the event loop - if you have
315two pirces of code that call C<< ->wait >> in a round-robbin fashion, you
316lose. Therefore, condition variables are good to export to your caller, but
317you should avoid making a blocking wait yourself, at least in callbacks,
318as this asks for trouble.
319
320This object has two methods:
125 321
126=over 4 322=over 4
127 323
128=item $cv->wait 324=item $cv->wait
129 325
130Wait (blocking if necessary) until the C<< ->broadcast >> method has been 326Wait (blocking if necessary) until the C<< ->broadcast >> method has been
131called on c<$cv>, while servicing other watchers normally. 327called on c<$cv>, while servicing other watchers normally.
132 328
133Not all event models support a blocking wait - some die in that case, so
134if you are using this from a module, never require a blocking wait, but
135let the caller decide wether the call will block or not (for example,
136by coupling condition variables with some kind of request results and
137supporting callbacks so the caller knows that getting the result will not
138block, while still suppporting blockign waits if the caller so desires).
139
140You can only wait once on a condition - additional calls will return 329You can only wait once on a condition - additional calls will return
141immediately. 330immediately.
142 331
332Not all event models support a blocking wait - some die in that case
333(programs might want to do that to stay interactive), so I<if you are
334using this from a module, never require a blocking wait>, but let the
335caller decide whether the call will block or not (for example, by coupling
336condition variables with some kind of request results and supporting
337callbacks so the caller knows that getting the result will not block,
338while still suppporting blocking waits if the caller so desires).
339
340Another reason I<never> to C<< ->wait >> in a module is that you cannot
341sensibly have two C<< ->wait >>'s in parallel, as that would require
342multiple interpreters or coroutines/threads, none of which C<AnyEvent>
343can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and
344L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
345from different coroutines, however).
346
143=item $cv->broadcast 347=item $cv->broadcast
144 348
145Flag the condition as ready - a running C<< ->wait >> and all further 349Flag the condition as ready - a running C<< ->wait >> and all further
146calls to C<wait> will return after this method has been called. If nobody 350calls to C<wait> will (eventually) return after this method has been
147is waiting the broadcast will be remembered.. 351called. If nobody is waiting the broadcast will be remembered..
352
353=back
148 354
149Example: 355Example:
150 356
151 # wait till the result is ready 357 # wait till the result is ready
152 my $result_ready = AnyEvent->condvar; 358 my $result_ready = AnyEvent->condvar;
153 359
154 # do something such as adding a timer 360 # do something such as adding a timer
155 # or socket watcher the calls $result_ready->broadcast 361 # or socket watcher the calls $result_ready->broadcast
156 # when the "result" is ready. 362 # when the "result" is ready.
363 # in this case, we simply use a timer:
364 my $w = AnyEvent->timer (
365 after => 1,
366 cb => sub { $result_ready->broadcast },
367 );
157 368
369 # this "blocks" (while handling events) till the watcher
370 # calls broadcast
158 $result_ready->wait; 371 $result_ready->wait;
159 372
160=back 373=head1 GLOBAL VARIABLES AND FUNCTIONS
161
162=head2 SIGNAL WATCHERS
163
164You can listen for signals using a signal watcher, C<signal> is the signal
165I<name> without any C<SIG> prefix. Multiple signals events can be clumped
166together into one callback invocation, and callback invocation might or
167might not be asynchronous.
168
169These watchers might use C<%SIG>, so programs overwriting those signals
170directly will likely not work correctly.
171
172Example: exit on SIGINT
173
174 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
175
176=head2 CHILD PROCESS WATCHERS
177
178You can also listen for the status of a child process specified by the
179C<pid> argument (or any child if the pid argument is 0). The watcher will
180trigger as often as status change for the child are received. This works
181by installing a signal handler for C<SIGCHLD>. The callback will be called with
182the pid and exit status (as returned by waitpid).
183
184Example: wait for pid 1333
185
186 my $w = AnyEvent->child (pid => 1333, cb => sub { warn "exit status $?" });
187
188=head1 GLOBALS
189 374
190=over 4 375=over 4
191 376
192=item $AnyEvent::MODEL 377=item $AnyEvent::MODEL
193 378
198AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). 383AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
199 384
200The known classes so far are: 385The known classes so far are:
201 386
202 AnyEvent::Impl::CoroEV based on Coro::EV, best choice. 387 AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
388 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
203 AnyEvent::Impl::EV based on EV (an interface to libev, also best choice). 389 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
204 AnyEvent::Impl::Coro based on Coro::Event, second best choice.
205 AnyEvent::Impl::Event based on Event, also second best choice :) 390 AnyEvent::Impl::Event based on Event, second best choice.
206 AnyEvent::Impl::Glib based on Glib, second-best choice. 391 AnyEvent::Impl::Glib based on Glib, third-best choice.
392 AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
207 AnyEvent::Impl::Tk based on Tk, very bad choice. 393 AnyEvent::Impl::Tk based on Tk, very bad choice.
208 AnyEvent::Impl::Perl pure-perl implementation, inefficient. 394 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
395 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
396 AnyEvent::Impl::POE based on POE, not generic enough for full support.
397
398There is no support for WxWidgets, as WxWidgets has no support for
399watching file handles. However, you can use WxWidgets through the
400POE Adaptor, as POE has a Wx backend that simply polls 20 times per
401second, which was considered to be too horrible to even consider for
402AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
403it's adaptor.
404
405AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
406autodetecting them.
209 407
210=item AnyEvent::detect 408=item AnyEvent::detect
211 409
212Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if 410Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
213necessary. You should only call this function right before you would have 411if necessary. You should only call this function right before you would
214created an AnyEvent watcher anyway, that is, very late at runtime. 412have created an AnyEvent watcher anyway, that is, as late as possible at
413runtime.
215 414
216=back 415=back
217 416
218=head1 WHAT TO DO IN A MODULE 417=head1 WHAT TO DO IN A MODULE
219 418
220As a module author, you should "use AnyEvent" and call AnyEvent methods 419As a module author, you should C<use AnyEvent> and call AnyEvent methods
221freely, but you should not load a specific event module or rely on it. 420freely, but you should not load a specific event module or rely on it.
222 421
223Be careful when you create watchers in the module body - Anyevent will 422Be careful when you create watchers in the module body - AnyEvent will
224decide which event module to use as soon as the first method is called, so 423decide which event module to use as soon as the first method is called, so
225by calling AnyEvent in your module body you force the user of your module 424by calling AnyEvent in your module body you force the user of your module
226to load the event module first. 425to load the event module first.
227 426
427Never call C<< ->wait >> on a condition variable unless you I<know> that
428the C<< ->broadcast >> method has been called on it already. This is
429because it will stall the whole program, and the whole point of using
430events is to stay interactive.
431
432It is fine, however, to call C<< ->wait >> when the user of your module
433requests it (i.e. if you create a http request object ad have a method
434called C<results> that returns the results, it should call C<< ->wait >>
435freely, as the user of your module knows what she is doing. always).
436
228=head1 WHAT TO DO IN THE MAIN PROGRAM 437=head1 WHAT TO DO IN THE MAIN PROGRAM
229 438
230There will always be a single main program - the only place that should 439There will always be a single main program - the only place that should
231dictate which event model to use. 440dictate which event model to use.
232 441
233If it doesn't care, it can just "use AnyEvent" and use it itself, or not 442If it doesn't care, it can just "use AnyEvent" and use it itself, or not
234do anything special and let AnyEvent decide which implementation to chose. 443do anything special (it does not need to be event-based) and let AnyEvent
444decide which implementation to chose if some module relies on it.
235 445
236If the main program relies on a specific event model (for example, in Gtk2 446If the main program relies on a specific event model. For example, in
237programs you have to rely on either Glib or Glib::Event), you should load 447Gtk2 programs you have to rely on the Glib module. You should load the
238it before loading AnyEvent or any module that uses it, generally, as early 448event module before loading AnyEvent or any module that uses it: generally
239as possible. The reason is that modules might create watchers when they 449speaking, you should load it as early as possible. The reason is that
240are loaded, and AnyEvent will decide on the event model to use as soon as 450modules might create watchers when they are loaded, and AnyEvent will
241it creates watchers, and it might chose the wrong one unless you load the 451decide on the event model to use as soon as it creates watchers, and it
242correct one yourself. 452might chose the wrong one unless you load the correct one yourself.
243 453
244You can chose to use a rather inefficient pure-perl implementation by 454You can chose to use a rather inefficient pure-perl implementation by
245loading the C<AnyEvent::Impl::Perl> module, but letting AnyEvent chose is 455loading the C<AnyEvent::Impl::Perl> module, which gives you similar
246generally better. 456behaviour everywhere, but letting AnyEvent chose is generally better.
247 457
248=cut 458=cut
249 459
250package AnyEvent; 460package AnyEvent;
251 461
252no warnings; 462no warnings;
253use strict; 463use strict;
254 464
255use Carp; 465use Carp;
256 466
257our $VERSION = '2.8'; 467our $VERSION = '3.3';
258our $MODEL; 468our $MODEL;
259 469
260our $AUTOLOAD; 470our $AUTOLOAD;
261our @ISA; 471our @ISA;
262 472
264 474
265our @REGISTRY; 475our @REGISTRY;
266 476
267my @models = ( 477my @models = (
268 [Coro::EV:: => AnyEvent::Impl::CoroEV::], 478 [Coro::EV:: => AnyEvent::Impl::CoroEV::],
479 [Coro::Event:: => AnyEvent::Impl::CoroEvent::],
269 [EV:: => AnyEvent::Impl::EV::], 480 [EV:: => AnyEvent::Impl::EV::],
270 [Coro::Event:: => AnyEvent::Impl::Coro::],
271 [Event:: => AnyEvent::Impl::Event::], 481 [Event:: => AnyEvent::Impl::Event::],
272 [Glib:: => AnyEvent::Impl::Glib::], 482 [Glib:: => AnyEvent::Impl::Glib::],
273 [Tk:: => AnyEvent::Impl::Tk::], 483 [Tk:: => AnyEvent::Impl::Tk::],
484 [Wx:: => AnyEvent::Impl::POE::],
485 [Prima:: => AnyEvent::Impl::POE::],
274 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 486 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
487 # everything below here will not be autoprobed as the pureperl backend should work everywhere
488 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
489 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
490 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
275); 491);
276 492
277our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY); 493our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);
278 494
279sub detect() { 495sub detect() {
280 unless ($MODEL) { 496 unless ($MODEL) {
281 no strict 'refs'; 497 no strict 'refs';
282 498
499 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
500 my $model = "AnyEvent::Impl::$1";
501 if (eval "require $model") {
502 $MODEL = $model;
503 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;
504 } else {
505 warn "AnyEvent: unable to load model '$model' (from \$PERL_ANYEVENT_MODEL):\n$@" if $verbose;
506 }
507 }
508
283 # check for already loaded models 509 # check for already loaded models
510 unless ($MODEL) {
284 for (@REGISTRY, @models) { 511 for (@REGISTRY, @models) {
285 my ($package, $model) = @$_; 512 my ($package, $model) = @$_;
286 if (${"$package\::VERSION"} > 0) { 513 if (${"$package\::VERSION"} > 0) {
287 if (eval "require $model") { 514 if (eval "require $model") {
288 $MODEL = $model; 515 $MODEL = $model;
289 warn "AnyEvent: found model '$model', using it.\n" if $verbose > 1; 516 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
290 last; 517 last;
518 }
291 } 519 }
292 } 520 }
293 }
294 521
295 unless ($MODEL) { 522 unless ($MODEL) {
296 # try to load a model 523 # try to load a model
297 524
298 for (@REGISTRY, @models) { 525 for (@REGISTRY, @models) {
299 my ($package, $model) = @$_; 526 my ($package, $model) = @$_;
300 if (eval "require $package" 527 if (eval "require $package"
301 and ${"$package\::VERSION"} > 0 528 and ${"$package\::VERSION"} > 0
302 and eval "require $model") { 529 and eval "require $model") {
303 $MODEL = $model; 530 $MODEL = $model;
304 warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1; 531 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
305 last; 532 last;
533 }
306 } 534 }
535
536 $MODEL
537 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib.";
307 } 538 }
308
309 $MODEL
310 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event), Glib or Tk.";
311 } 539 }
312 540
313 unshift @ISA, $MODEL; 541 unshift @ISA, $MODEL;
314 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 542 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
315 } 543 }
426 undef $CHLD_W unless keys %PID_CB; 654 undef $CHLD_W unless keys %PID_CB;
427} 655}
428 656
429=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 657=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
430 658
659This is an advanced topic that you do not normally need to use AnyEvent in
660a module. This section is only of use to event loop authors who want to
661provide AnyEvent compatibility.
662
431If you need to support another event library which isn't directly 663If you need to support another event library which isn't directly
432supported by AnyEvent, you can supply your own interface to it by 664supported by AnyEvent, you can supply your own interface to it by
433pushing, before the first watcher gets created, the package name of 665pushing, before the first watcher gets created, the package name of
434the event module and the package name of the interface to use onto 666the event module and the package name of the interface to use onto
435C<@AnyEvent::REGISTRY>. You can do that before and even without loading 667C<@AnyEvent::REGISTRY>. You can do that before and even without loading
436AnyEvent. 668AnyEvent, so it is reasonably cheap.
437 669
438Example: 670Example:
439 671
440 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 672 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
441 673
442This tells AnyEvent to (literally) use the C<urxvt::anyevent::> 674This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
443package/class when it finds the C<urxvt> package/module is loaded. When 675package/class when it finds the C<urxvt> package/module is already loaded.
676
444AnyEvent is loaded and asked to find a suitable event model, it will 677When AnyEvent is loaded and asked to find a suitable event model, it
445first check for the presence of urxvt. 678will first check for the presence of urxvt by trying to C<use> the
679C<urxvt::anyevent> module.
446 680
447The class should provide implementations for all watcher types (see 681The class should provide implementations for all watcher types. See
448L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib> 682L<AnyEvent::Impl::EV> (source code), L<AnyEvent::Impl::Glib> (Source code)
449(Source code) and so on for actual examples, use C<perldoc -m 683and so on for actual examples. Use C<perldoc -m AnyEvent::Impl::Glib> to
450AnyEvent::Impl::Glib> to see the sources). 684see the sources.
451 685
686If you don't provide C<signal> and C<child> watchers than AnyEvent will
687provide suitable (hopefully) replacements.
688
452The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt) 689The above example isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)
453uses the above line as-is. An interface isn't included in AnyEvent 690terminal emulator uses the above line as-is. An interface isn't included
454because it doesn't make sense outside the embedded interpreter inside 691in AnyEvent because it doesn't make sense outside the embedded interpreter
455I<rxvt-unicode>, and it is updated and maintained as part of the 692inside I<rxvt-unicode>, and it is updated and maintained as part of the
456I<rxvt-unicode> distribution. 693I<rxvt-unicode> distribution.
457 694
458I<rxvt-unicode> also cheats a bit by not providing blocking access to 695I<rxvt-unicode> also cheats a bit by not providing blocking access to
459condition variables: code blocking while waiting for a condition will 696condition variables: code blocking while waiting for a condition will
460C<die>. This still works with most modules/usages, and blocking calls must 697C<die>. This still works with most modules/usages, and blocking calls must
461not be in an interactive application, so it makes sense. 698not be done in an interactive application, so it makes sense.
462 699
463=head1 ENVIRONMENT VARIABLES 700=head1 ENVIRONMENT VARIABLES
464 701
465The following environment variables are used by this module: 702The following environment variables are used by this module:
466 703
467C<PERL_ANYEVENT_VERBOSE> when set to C<2> or higher, reports which event 704=over 4
468model gets used.
469 705
706=item C<PERL_ANYEVENT_VERBOSE>
707
708By default, AnyEvent will be completely silent except in fatal
709conditions. You can set this environment variable to make AnyEvent more
710talkative.
711
712When set to C<1> or higher, causes AnyEvent to warn about unexpected
713conditions, such as not being able to load the event model specified by
714C<PERL_ANYEVENT_MODEL>.
715
716When set to C<2> or higher, cause AnyEvent to report to STDERR which event
717model it chooses.
718
719=item C<PERL_ANYEVENT_MODEL>
720
721This can be used to specify the event model to be used by AnyEvent, before
722autodetection and -probing kicks in. It must be a string consisting
723entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
724and the resulting module name is loaded and if the load was successful,
725used as event model. If it fails to load AnyEvent will proceed with
726autodetection and -probing.
727
728This functionality might change in future versions.
729
730For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
731could start your program like this:
732
733 PERL_ANYEVENT_MODEL=Perl perl ...
734
735=back
736
470=head1 EXAMPLE 737=head1 EXAMPLE PROGRAM
471 738
472The following program uses an io watcher to read data from stdin, a timer 739The following program uses an I/O watcher to read data from STDIN, a timer
473to display a message once per second, and a condvar to exit the program 740to display a message once per second, and a condition variable to quit the
474when the user enters quit: 741program when the user enters quit:
475 742
476 use AnyEvent; 743 use AnyEvent;
477 744
478 my $cv = AnyEvent->condvar; 745 my $cv = AnyEvent->condvar;
479 746
480 my $io_watcher = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 747 my $io_watcher = AnyEvent->io (
748 fh => \*STDIN,
749 poll => 'r',
750 cb => sub {
481 warn "io event <$_[0]>\n"; # will always output <r> 751 warn "io event <$_[0]>\n"; # will always output <r>
482 chomp (my $input = <STDIN>); # read a line 752 chomp (my $input = <STDIN>); # read a line
483 warn "read: $input\n"; # output what has been read 753 warn "read: $input\n"; # output what has been read
484 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i 754 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i
755 },
485 }); 756 );
486 757
487 my $time_watcher; # can only be used once 758 my $time_watcher; # can only be used once
488 759
489 sub new_timer { 760 sub new_timer {
490 $timer = AnyEvent->timer (after => 1, cb => sub { 761 $timer = AnyEvent->timer (after => 1, cb => sub {
572 $txn->{finished}->wait; 843 $txn->{finished}->wait;
573 return $txn->{result}; 844 return $txn->{result};
574 845
575The actual code goes further and collects all errors (C<die>s, exceptions) 846The actual code goes further and collects all errors (C<die>s, exceptions)
576that occured during request processing. The C<result> method detects 847that occured during request processing. The C<result> method detects
577wether an exception as thrown (it is stored inside the $txn object) 848whether an exception as thrown (it is stored inside the $txn object)
578and just throws the exception, which means connection errors and other 849and just throws the exception, which means connection errors and other
579problems get reported tot he code that tries to use the result, not in a 850problems get reported tot he code that tries to use the result, not in a
580random callback. 851random callback.
581 852
582All of this enables the following usage styles: 853All of this enables the following usage styles:
583 854
5841. Blocking: 8551. Blocking:
585 856
586 my $data = $fcp->client_get ($url); 857 my $data = $fcp->client_get ($url);
587 858
5882. Blocking, but parallelizing: 8592. Blocking, but running in parallel:
589 860
590 my @datas = map $_->result, 861 my @datas = map $_->result,
591 map $fcp->txn_client_get ($_), 862 map $fcp->txn_client_get ($_),
592 @urls; 863 @urls;
593 864
594Both blocking examples work without the module user having to know 865Both blocking examples work without the module user having to know
595anything about events. 866anything about events.
596 867
5973a. Event-based in a main program, using any support Event module: 8683a. Event-based in a main program, using any supported event module:
598 869
599 use Event; 870 use EV;
600 871
601 $fcp->txn_client_get ($url)->cb (sub { 872 $fcp->txn_client_get ($url)->cb (sub {
602 my $txn = shift; 873 my $txn = shift;
603 my $data = $txn->result; 874 my $data = $txn->result;
604 ... 875 ...
605 }); 876 });
606 877
607 Event::loop; 878 EV::loop;
608 879
6093b. The module user could use AnyEvent, too: 8803b. The module user could use AnyEvent, too:
610 881
611 use AnyEvent; 882 use AnyEvent;
612 883
617 $quit->broadcast; 888 $quit->broadcast;
618 }); 889 });
619 890
620 $quit->wait; 891 $quit->wait;
621 892
893
894=head1 BENCHMARK
895
896To give you an idea of the performance and overheads that AnyEvent adds
897over the event loops themselves (and to give you an impression of the
898speed of various event loops), here is a benchmark of various supported
899event models natively and with anyevent. The benchmark creates a lot of
900timers (with a zero timeout) and I/O watchers (watching STDOUT, a pty, to
901become writable, which it is), lets them fire exactly once and destroys
902them again.
903
904Rewriting the benchmark to use many different sockets instead of using
905the same filehandle for all I/O watchers results in a much longer runtime
906(socket creation is expensive), but qualitatively the same figures, so it
907was not used.
908
909=head2 Explanation of the columns
910
911I<watcher> is the number of event watchers created/destroyed. Since
912different event models feature vastly different performances, each event
913loop was given a number of watchers so that overall runtime is acceptable
914and similar between tested event loop (and keep them from crashing): Glib
915would probably take thousands of years if asked to process the same number
916of watchers as EV in this benchmark.
917
918I<bytes> is the number of bytes (as measured by the resident set size,
919RSS) consumed by each watcher. This method of measuring captures both C
920and Perl-based overheads.
921
922I<create> is the time, in microseconds (millionths of seconds), that it
923takes to create a single watcher. The callback is a closure shared between
924all watchers, to avoid adding memory overhead. That means closure creation
925and memory usage is not included in the figures.
926
927I<invoke> is the time, in microseconds, used to invoke a simple
928callback. The callback simply counts down a Perl variable and after it was
929invoked "watcher" times, it would C<< ->broadcast >> a condvar once to
930signal the end of this phase.
931
932I<destroy> is the time, in microseconds, that it takes to destroy a single
933watcher.
934
935=head2 Results
936
937 name watchers bytes create invoke destroy comment
938 EV/EV 400000 244 0.56 0.46 0.31 EV native interface
939 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers
940 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal
941 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation
942 Event/Event 16000 516 31.88 31.30 0.85 Event native interface
943 Event/Any 16000 936 39.17 33.63 1.43 Event + AnyEvent watchers
944 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour
945 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers
946 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event
947 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select
948
949=head2 Discussion
950
951The benchmark does I<not> measure scalability of the event loop very
952well. For example, a select-based event loop (such as the pure perl one)
953can never compete with an event loop that uses epoll when the number of
954file descriptors grows high. In this benchmark, all events become ready at
955the same time, so select/poll-based implementations get an unnatural speed
956boost.
957
958C<EV> is the sole leader regarding speed and memory use, which are both
959maximal/minimal, respectively. Even when going through AnyEvent, it uses
960far less memory than any other event loop and is still faster than Event
961natively.
962
963The pure perl implementation is hit in a few sweet spots (both the
964zero timeout and the use of a single fd hit optimisations in the perl
965interpreter and the backend itself, and all watchers become ready at the
966same time). Nevertheless this shows that it adds very little overhead in
967itself. Like any select-based backend its performance becomes really bad
968with lots of file descriptors (and few of them active), of course, but
969this was not subject of this benchmark.
970
971The C<Event> module has a relatively high setup and callback invocation cost,
972but overall scores on the third place.
973
974C<Glib>'s memory usage is quite a bit bit higher, but it features a
975faster callback invocation and overall ends up in the same class as
976C<Event>. However, Glib scales extremely badly, doubling the number of
977watchers increases the processing time by more than a factor of four,
978making it completely unusable when using larger numbers of watchers
979(note that only a single file descriptor was used in the benchmark, so
980inefficiencies of C<poll> do not account for this).
981
982The C<Tk> adaptor works relatively well. The fact that it crashes with
983more than 2000 watchers is a big setback, however, as correctness takes
984precedence over speed. Nevertheless, its performance is surprising, as the
985file descriptor is dup()ed for each watcher. This shows that the dup()
986employed by some adaptors is not a big performance issue (it does incur a
987hidden memory cost inside the kernel, though, that is not reflected in the
988figures above).
989
990C<POE>, regardless of underlying event loop (wether using its pure perl
991select-based backend or the Event module) shows abysmal performance and
992memory usage: Watchers use almost 30 times as much memory as EV watchers,
993and 10 times as much memory as both Event or EV via AnyEvent. Watcher
994invocation is almost 900 times slower than with AnyEvent's pure perl
995implementation. The design of the POE adaptor class in AnyEvent can not
996really account for this, as session creation overhead is small compared
997to execution of the state machine, which is coded pretty optimally within
998L<AnyEvent::Impl::POE>. POE simply seems to be abysmally slow.
999
1000=head2 Summary
1001
1002Using EV through AnyEvent is faster than any other event loop, but most
1003event loops have acceptable performance with or without AnyEvent.
1004
1005The overhead AnyEvent adds is usually much smaller than the overhead of
1006the actual event loop, only with extremely fast event loops such as the EV
1007adds AnyEvent significant overhead.
1008
1009And you should simply avoid POE like the plague if you want performance or
1010reasonable memory usage.
1011
1012
1013=head1 FORK
1014
1015Most event libraries are not fork-safe. The ones who are usually are
1016because they are so inefficient. Only L<EV> is fully fork-aware.
1017
1018If you have to fork, you must either do so I<before> creating your first
1019watcher OR you must not use AnyEvent at all in the child.
1020
1021
1022=head1 SECURITY CONSIDERATIONS
1023
1024AnyEvent can be forced to load any event model via
1025$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used to
1026execute arbitrary code or directly gain access, it can easily be used to
1027make the program hang or malfunction in subtle ways, as AnyEvent watchers
1028will not be active when the program uses a different event model than
1029specified in the variable.
1030
1031You can make AnyEvent completely ignore this variable by deleting it
1032before the first watcher gets created, e.g. with a C<BEGIN> block:
1033
1034 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1035
1036 use AnyEvent;
1037
1038
622=head1 SEE ALSO 1039=head1 SEE ALSO
623 1040
624Event modules: L<Coro::Event>, L<Coro>, L<Event>, L<Glib::Event>, L<Glib>. 1041Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,
1042L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,
1043L<Event::Lib>, L<Qt>, L<POE>.
625 1044
1045Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,
626Implementations: L<AnyEvent::Impl::Coro>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>. 1046L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,
1047L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,
1048L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>.
627 1049
628Nontrivial usage example: L<Net::FCP>. 1050Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.
629 1051
630=head1 1052
1053=head1 AUTHOR
1054
1055 Marc Lehmann <schmorp@schmorp.de>
1056 http://home.schmorp.de/
631 1057
632=cut 1058=cut
633 1059
6341 10601
635 1061

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines