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.51 by root, Wed Apr 16 15:10:10 2008 UTC vs.
Revision 1.59 by root, Thu Apr 24 08:38:13 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, Coro::EV, Coro::Event, Glib, Tk, Perl - various supported event loops 5EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt - 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 22
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 24
… …
29policy> and AnyEvent is I<small and efficient>. 29policy> and AnyEvent is I<small and efficient>.
30 30
31First and foremost, I<AnyEvent is not an event model> itself, it only 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 32interfaces to whatever event model the main program happens to use in a
33pragmatic way. For event models and certain classes of immortals alike, 33pragmatic way. For event models and certain classes of immortals alike,
34the statement "there can only be one" is a bitter reality, and AnyEvent 34the statement "there can only be one" is a bitter reality: In general,
35helps hiding the differences. 35only one event loop can be active at the same time in a process. AnyEvent
36helps hiding the differences between those event loops.
36 37
37The goal of AnyEvent is to offer module authors the ability to do event 38The goal of AnyEvent is to offer module authors the ability to do event
38programming (waiting for I/O or timer events) without subscribing to a 39programming (waiting for I/O or timer events) without subscribing to a
39religion, a way of living, and most importantly: without forcing your 40religion, a way of living, and most importantly: without forcing your
40module users into the same thing by forcing them to use the same event 41module users into the same thing by forcing them to use the same event
41model you use. 42model you use.
42 43
43For modules like POE or IO::Async (which is actually doing all I/O 44For modules like POE or IO::Async (which is a total misnomer as it is
44I<synchronously>...), using them in your module is like joining a 45actually doing all I/O I<synchronously>...), using them in your module is
45cult: After you joined, you are dependent on them and you cannot use 46like joining a cult: After you joined, you are dependent on them and you
46anything else, as it is simply incompatible to everything that isn't 47cannot use anything else, as it is simply incompatible to everything that
47itself. 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.
48 50
49AnyEvent + POE works fine. AnyEvent + Glib works fine. AnyEvent + Tk 51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
50works fine etc. etc. but none of these work together with the rest: POE 52fine. AnyEvent + Tk works fine etc. etc. but none of these work together
51+ IO::Async? no go. Tk + Event? no go. If your module uses one of 53with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if
52those, every user of your module has to use it, too. If your module 54your module uses one of those, every user of your module has to use it,
53uses AnyEvent, it works transparently with all event models it supports 55too. But if your module uses AnyEvent, it works transparently with all
54(including stuff like POE and IO::Async). 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).
55 59
56In addition of being free of having to use I<the one and only true event 60In addition to being free of having to use I<the one and only true event
57model>, AnyEvent also is free of bloat and policy: with POE or similar 61model>, AnyEvent also is free of bloat and policy: with POE or similar
58modules, you get an enourmous amount of code and strict rules you have 62modules, you get an enourmous amount of code and strict rules you have to
59to follow. AnyEvent, on the other hand, is lean and to the point by only 63follow. AnyEvent, on the other hand, is lean and up to the point, by only
60offering the functionality that is useful, in as thin as a wrapper as 64offering the functionality that is necessary, in as thin as a wrapper as
61technically possible. 65technically possible.
62 66
63Of course, if you want lots of policy (this can arguably be somewhat 67Of course, if you want lots of policy (this can arguably be somewhat
64useful) and you want to force your users to use the one and only event 68useful) and you want to force your users to use the one and only event
65model, you should I<not> use this module. 69model, you should I<not> use this module.
… …
70L<AnyEvent> provides an identical interface to multiple event loops. This 74L<AnyEvent> provides an identical interface to multiple event loops. This
71allows module authors to utilise an event loop without forcing module 75allows module authors to utilise an event loop without forcing module
72users 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
73peacefully at any one time). 77peacefully at any one time).
74 78
75The interface itself is vaguely similar but not identical to the Event 79The interface itself is vaguely similar, but not identical to the L<Event>
76module. 80module.
77 81
78On 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
79loaded event loop by probing wether any of the following modules is 83to detect the currently loaded event loop by probing whether one of
80loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, L<Event>, L<Glib>, L<Tk>. The 84the following modules is already loaded: L<Coro::EV>, L<Coro::Event>,
85L<EV>, L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>. The first one
81first one found is used. If none are found, the module tries to load these 86found is used. If none are found, the module tries to load these modules
82modules in the order given. The first one that could be successfully 87(excluding Event::Lib and Qt) in the order given. The first one that can
83loaded will be used. If still none could be found, AnyEvent will fall back 88be successfully loaded will be used. If, after this, still none could be
84to a pure-perl event loop, which is also not very efficient. 89found, AnyEvent will fall back to a pure-perl event loop, which is not
90very efficient, but should work everywhere.
85 91
86Because AnyEvent first checks for modules that are already loaded, loading 92Because AnyEvent first checks for modules that are already loaded, loading
87an Event model explicitly before first using AnyEvent will likely make 93an event model explicitly before first using AnyEvent will likely make
88that model the default. For example: 94that model the default. For example:
89 95
90 use Tk; 96 use Tk;
91 use AnyEvent; 97 use AnyEvent;
92 98
93 # .. AnyEvent will likely default to Tk 99 # .. AnyEvent will likely default to Tk
100
101The I<likely> means that, if any module loads another event model and
102starts using it, all bets are off. Maybe you should tell their authors to
103use AnyEvent so their modules work together with others seamlessly...
94 104
95The pure-perl implementation of AnyEvent is called 105The pure-perl implementation of AnyEvent is called
96C<AnyEvent::Impl::Perl>. Like other event modules you can load it 106C<AnyEvent::Impl::Perl>. Like other event modules you can load it
97explicitly. 107explicitly.
98 108
… …
101AnyEvent has the central concept of a I<watcher>, which is an object that 111AnyEvent has the central concept of a I<watcher>, which is an object that
102stores relevant data for each kind of event you are waiting for, such as 112stores relevant data for each kind of event you are waiting for, such as
103the callback to call, the filehandle to watch, etc. 113the callback to call, the filehandle to watch, etc.
104 114
105These watchers are normal Perl objects with normal Perl lifetime. After 115These watchers are normal Perl objects with normal Perl lifetime. After
106creating a watcher it will immediately "watch" for events and invoke 116creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model
118is in control).
119
107the callback. To disable the watcher you have to destroy it (e.g. by 120To disable the watcher you have to destroy it (e.g. by setting the
108setting the variable that stores it to C<undef> or otherwise deleting all 121variable you store it in to C<undef> or otherwise deleting all references
109references to it). 122to it).
110 123
111All watchers are created by calling a method on the C<AnyEvent> class. 124All watchers are created by calling a method on the C<AnyEvent> class.
112 125
126Many watchers either are used with "recursion" (repeating timers for
127example), or need to refer to their watcher object in other ways.
128
129An any way to achieve that is this pattern:
130
131 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
132 # you can use $w here, for example to undef it
133 undef $w;
134 });
135
136Note that C<my $w; $w => combination. This is necessary because in Perl,
137my variables are only visible after the statement in which they are
138declared.
139
113=head2 IO WATCHERS 140=head2 IO WATCHERS
114 141
115You can create I/O watcher by calling the C<< AnyEvent->io >> method with 142You can create an I/O watcher by calling the C<< AnyEvent->io >> method
116the following mandatory arguments: 143with the following mandatory key-value pairs as arguments:
117 144
118C<fh> the Perl I<filehandle> (not filedescriptor) to watch for 145C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for
119events. C<poll> must be a string that is either C<r> or C<w>, that creates 146events. C<poll> must be a string that is either C<r> or C<w>, which
120a watcher waiting for "r"eadable or "w"ritable events. C<cb> the callback 147creates a watcher waiting for "r"eadable or "w"ritable events,
121to invoke everytime the filehandle becomes ready. 148respectively. C<cb> is the callback to invoke each time the file handle
149becomes ready.
122 150
123Filehandles will be kept alive, so as long as the watcher exists, the 151As long as the I/O watcher exists it will keep the file descriptor or a
124filehandle exists, too. 152copy of it alive/open.
153
154It is not allowed to close a file handle as long as any watcher is active
155on the underlying file descriptor.
156
157Some event loops issue spurious readyness notifications, so you should
158always use non-blocking calls when reading/writing from/to your file
159handles.
125 160
126Example: 161Example:
127 162
128 # wait for readability of STDIN, then read a line and disable the watcher 163 # wait for readability of STDIN, then read a line and disable the watcher
129 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 164 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
… …
135=head2 TIME WATCHERS 170=head2 TIME WATCHERS
136 171
137You can create a time watcher by calling the C<< AnyEvent->timer >> 172You can create a time watcher by calling the C<< AnyEvent->timer >>
138method with the following mandatory arguments: 173method with the following mandatory arguments:
139 174
140C<after> after how many seconds (fractions are supported) should the timer 175C<after> specifies after how many seconds (fractional values are
141activate. C<cb> the callback to invoke. 176supported) should the timer activate. C<cb> the callback to invoke in that
177case.
142 178
143The timer callback will be invoked at most once: if you want a repeating 179The timer callback will be invoked at most once: if you want a repeating
144timer you have to create a new watcher (this is a limitation by both Tk 180timer you have to create a new watcher (this is a limitation by both Tk
145and Glib). 181and Glib).
146 182
… …
152 }); 188 });
153 189
154 # to cancel the timer: 190 # to cancel the timer:
155 undef $w; 191 undef $w;
156 192
193Example 2:
194
195 # fire an event after 0.5 seconds, then roughly every second
196 my $w;
197
198 my $cb = sub {
199 # cancel the old timer while creating a new one
200 $w = AnyEvent->timer (after => 1, cb => $cb);
201 };
202
203 # start the "loop" by creating the first watcher
204 $w = AnyEvent->timer (after => 0.5, cb => $cb);
205
206=head3 TIMING ISSUES
207
208There are two ways to handle timers: based on real time (relative, "fire
209in 10 seconds") and based on wallclock time (absolute, "fire at 12
210o'clock").
211
212While most event loops expect timers to specified in a relative way, they
213use absolute time internally. This makes a difference when your clock
214"jumps", for example, when ntp decides to set your clock backwards from
215the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to
216fire "after" a second might actually take six years to finally fire.
217
218AnyEvent cannot compensate for this. The only event loop that is conscious
219about these issues is L<EV>, which offers both relative (ev_timer, based
220on true relative time) and absolute (ev_periodic, based on wallclock time)
221timers.
222
223AnyEvent always prefers relative timers, if available, matching the
224AnyEvent API.
225
226=head2 SIGNAL WATCHERS
227
228You can watch for signals using a signal watcher, C<signal> is the signal
229I<name> without any C<SIG> prefix, C<cb> is the Perl callback to
230be invoked whenever a signal occurs.
231
232Multiple signal occurances can be clumped together into one callback
233invocation, and callback invocation will be synchronous. synchronous means
234that it might take a while until the signal gets handled by the process,
235but it is guarenteed not to interrupt any other callbacks.
236
237The main advantage of using these watchers is that you can share a signal
238between multiple watchers.
239
240This watcher might use C<%SIG>, so programs overwriting those signals
241directly will likely not work correctly.
242
243Example: exit on SIGINT
244
245 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
246
247=head2 CHILD PROCESS WATCHERS
248
249You can also watch on a child process exit and catch its exit status.
250
251The child process is specified by the C<pid> argument (if set to C<0>, it
252watches for any child process exit). The watcher will trigger as often
253as status change for the child are received. This works by installing a
254signal handler for C<SIGCHLD>. The callback will be called with the pid
255and exit status (as returned by waitpid).
256
257Example: wait for pid 1333
258
259 my $w = AnyEvent->child (
260 pid => 1333,
261 cb => sub {
262 my ($pid, $status) = @_;
263 warn "pid $pid exited with status $status";
264 },
265 );
266
157=head2 CONDITION WATCHERS 267=head2 CONDITION VARIABLES
158 268
159Condition watchers can be created by calling the C<< AnyEvent->condvar >> 269Condition variables can be created by calling the C<< AnyEvent->condvar >>
160method without any arguments. 270method without any arguments.
161 271
162A condition watcher watches for a condition - precisely that the C<< 272A condition variable waits for a condition - precisely that the C<<
163->broadcast >> method has been called. 273->broadcast >> method has been called.
164 274
275They are very useful to signal that a condition has been fulfilled, for
276example, if you write a module that does asynchronous http requests,
277then a condition variable would be the ideal candidate to signal the
278availability of results.
279
280You can also use condition variables to block your main program until
281an event occurs - for example, you could C<< ->wait >> in your main
282program until the user clicks the Quit button in your app, which would C<<
283->broadcast >> the "quit" event.
284
165Note that condition watchers recurse into the event loop - if you have 285Note that condition variables recurse into the event loop - if you have
166two watchers that call C<< ->wait >> in a round-robbin fashion, you 286two pirces of code that call C<< ->wait >> in a round-robbin fashion, you
167lose. Therefore, condition watchers are good to export to your caller, but 287lose. Therefore, condition variables are good to export to your caller, but
168you should avoid making a blocking wait, at least in callbacks, as this 288you should avoid making a blocking wait yourself, at least in callbacks,
169usually asks for trouble. 289as this asks for trouble.
170 290
171The watcher has only two methods: 291This object has two methods:
172 292
173=over 4 293=over 4
174 294
175=item $cv->wait 295=item $cv->wait
176 296
… …
179 299
180You can only wait once on a condition - additional calls will return 300You can only wait once on a condition - additional calls will return
181immediately. 301immediately.
182 302
183Not all event models support a blocking wait - some die in that case 303Not all event models support a blocking wait - some die in that case
184(programs might want to do that so they stay interactive), so I<if you 304(programs might want to do that to stay interactive), so I<if you are
185are using this from a module, never require a blocking wait>, but let the 305using this from a module, never require a blocking wait>, but let the
186caller decide wether the call will block or not (for example, by coupling 306caller decide whether the call will block or not (for example, by coupling
187condition variables with some kind of request results and supporting 307condition variables with some kind of request results and supporting
188callbacks so the caller knows that getting the result will not block, 308callbacks so the caller knows that getting the result will not block,
189while still suppporting blocking waits if the caller so desires). 309while still suppporting blocking waits if the caller so desires).
190 310
191Another reason I<never> to C<< ->wait >> in a module is that you cannot 311Another reason I<never> to C<< ->wait >> in a module is that you cannot
192sensibly have two C<< ->wait >>'s in parallel, as that would require 312sensibly have two C<< ->wait >>'s in parallel, as that would require
193multiple interpreters or coroutines/threads, none of which C<AnyEvent> 313multiple interpreters or coroutines/threads, none of which C<AnyEvent>
194can supply (the coroutine-aware backends C<Coro::EV> and C<Coro::Event> 314can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and
195explicitly support concurrent C<< ->wait >>'s from different coroutines, 315L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
196however). 316from different coroutines, however).
197 317
198=item $cv->broadcast 318=item $cv->broadcast
199 319
200Flag the condition as ready - a running C<< ->wait >> and all further 320Flag the condition as ready - a running C<< ->wait >> and all further
201calls to C<wait> will return after this method has been called. If nobody 321calls to C<wait> will (eventually) return after this method has been
202is waiting the broadcast will be remembered.. 322called. If nobody is waiting the broadcast will be remembered..
323
324=back
203 325
204Example: 326Example:
205 327
206 # wait till the result is ready 328 # wait till the result is ready
207 my $result_ready = AnyEvent->condvar; 329 my $result_ready = AnyEvent->condvar;
208 330
209 # do something such as adding a timer 331 # do something such as adding a timer
210 # or socket watcher the calls $result_ready->broadcast 332 # or socket watcher the calls $result_ready->broadcast
211 # when the "result" is ready. 333 # when the "result" is ready.
334 # in this case, we simply use a timer:
335 my $w = AnyEvent->timer (
336 after => 1,
337 cb => sub { $result_ready->broadcast },
338 );
212 339
340 # this "blocks" (while handling events) till the watcher
341 # calls broadcast
213 $result_ready->wait; 342 $result_ready->wait;
214 343
215=back 344=head1 GLOBAL VARIABLES AND FUNCTIONS
216
217=head2 SIGNAL WATCHERS
218
219You can listen for signals using a signal watcher, C<signal> is the signal
220I<name> without any C<SIG> prefix. Multiple signals events can be clumped
221together into one callback invocation, and callback invocation might or
222might not be asynchronous.
223
224These watchers might use C<%SIG>, so programs overwriting those signals
225directly will likely not work correctly.
226
227Example: exit on SIGINT
228
229 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
230
231=head2 CHILD PROCESS WATCHERS
232
233You can also listen for the status of a child process specified by the
234C<pid> argument (or any child if the pid argument is 0). The watcher will
235trigger as often as status change for the child are received. This works
236by installing a signal handler for C<SIGCHLD>. The callback will be called with
237the pid and exit status (as returned by waitpid).
238
239Example: wait for pid 1333
240
241 my $w = AnyEvent->child (pid => 1333, cb => sub { warn "exit status $?" });
242
243=head1 GLOBALS
244 345
245=over 4 346=over 4
246 347
247=item $AnyEvent::MODEL 348=item $AnyEvent::MODEL
248 349
… …
254 355
255The known classes so far are: 356The known classes so far are:
256 357
257 AnyEvent::Impl::CoroEV based on Coro::EV, best choice. 358 AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
258 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. 359 AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
259 AnyEvent::Impl::EV based on EV (an interface to libev, also best choice). 360 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
260 AnyEvent::Impl::Event based on Event, also second best choice :) 361 AnyEvent::Impl::Event based on Event, second best choice.
261 AnyEvent::Impl::Glib based on Glib, third-best choice. 362 AnyEvent::Impl::Glib based on Glib, third-best choice.
262 AnyEvent::Impl::Tk based on Tk, very bad choice. 363 AnyEvent::Impl::Tk based on Tk, very bad choice.
263 AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. 364 AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
365 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
366 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
264 367
265=item AnyEvent::detect 368=item AnyEvent::detect
266 369
267Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model if 370Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
268necessary. You should only call this function right before you would have 371if necessary. You should only call this function right before you would
269created an AnyEvent watcher anyway, that is, very late at runtime. 372have created an AnyEvent watcher anyway, that is, as late as possible at
373runtime.
270 374
271=back 375=back
272 376
273=head1 WHAT TO DO IN A MODULE 377=head1 WHAT TO DO IN A MODULE
274 378
275As a module author, you should "use AnyEvent" and call AnyEvent methods 379As a module author, you should C<use AnyEvent> and call AnyEvent methods
276freely, but you should not load a specific event module or rely on it. 380freely, but you should not load a specific event module or rely on it.
277 381
278Be careful when you create watchers in the module body - Anyevent will 382Be careful when you create watchers in the module body - AnyEvent will
279decide which event module to use as soon as the first method is called, so 383decide which event module to use as soon as the first method is called, so
280by calling AnyEvent in your module body you force the user of your module 384by calling AnyEvent in your module body you force the user of your module
281to load the event module first. 385to load the event module first.
282 386
387Never call C<< ->wait >> on a condition variable unless you I<know> that
388the C<< ->broadcast >> method has been called on it already. This is
389because it will stall the whole program, and the whole point of using
390events is to stay interactive.
391
392It is fine, however, to call C<< ->wait >> when the user of your module
393requests it (i.e. if you create a http request object ad have a method
394called C<results> that returns the results, it should call C<< ->wait >>
395freely, as the user of your module knows what she is doing. always).
396
283=head1 WHAT TO DO IN THE MAIN PROGRAM 397=head1 WHAT TO DO IN THE MAIN PROGRAM
284 398
285There will always be a single main program - the only place that should 399There will always be a single main program - the only place that should
286dictate which event model to use. 400dictate which event model to use.
287 401
288If it doesn't care, it can just "use AnyEvent" and use it itself, or not 402If it doesn't care, it can just "use AnyEvent" and use it itself, or not
289do anything special and let AnyEvent decide which implementation to chose. 403do anything special (it does not need to be event-based) and let AnyEvent
404decide which implementation to chose if some module relies on it.
290 405
291If the main program relies on a specific event model (for example, in Gtk2 406If the main program relies on a specific event model. For example, in
292programs you have to rely on either Glib or Glib::Event), you should load 407Gtk2 programs you have to rely on the Glib module. You should load the
293it before loading AnyEvent or any module that uses it, generally, as early 408event module before loading AnyEvent or any module that uses it: generally
294as possible. The reason is that modules might create watchers when they 409speaking, you should load it as early as possible. The reason is that
295are loaded, and AnyEvent will decide on the event model to use as soon as 410modules might create watchers when they are loaded, and AnyEvent will
296it creates watchers, and it might chose the wrong one unless you load the 411decide on the event model to use as soon as it creates watchers, and it
297correct one yourself. 412might chose the wrong one unless you load the correct one yourself.
298 413
299You can chose to use a rather inefficient pure-perl implementation by 414You can chose to use a rather inefficient pure-perl implementation by
300loading the C<AnyEvent::Impl::Perl> module, but letting AnyEvent chose is 415loading the C<AnyEvent::Impl::Perl> module, which gives you similar
301generally better. 416behaviour everywhere, but letting AnyEvent chose is generally better.
302 417
303=cut 418=cut
304 419
305package AnyEvent; 420package AnyEvent;
306 421
307no warnings; 422no warnings;
308use strict; 423use strict;
309 424
310use Carp; 425use Carp;
311 426
312our $VERSION = '3.1'; 427our $VERSION = '3.2';
313our $MODEL; 428our $MODEL;
314 429
315our $AUTOLOAD; 430our $AUTOLOAD;
316our @ISA; 431our @ISA;
317 432
… …
326 [Event:: => AnyEvent::Impl::Event::], 441 [Event:: => AnyEvent::Impl::Event::],
327 [Glib:: => AnyEvent::Impl::Glib::], 442 [Glib:: => AnyEvent::Impl::Glib::],
328 [Tk:: => AnyEvent::Impl::Tk::], 443 [Tk:: => AnyEvent::Impl::Tk::],
329 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 444 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
330); 445);
446my @models_detect = (
447 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
448 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
449);
331 450
332our %method = map +($_ => 1), qw(io timer condvar broadcast wait signal one_event DESTROY); 451our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);
333 452
334sub detect() { 453sub detect() {
335 unless ($MODEL) { 454 unless ($MODEL) {
336 no strict 'refs'; 455 no strict 'refs';
337 456
457 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
458 my $model = "AnyEvent::Impl::$1";
459 if (eval "require $model") {
460 $MODEL = $model;
461 warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;
462 }
463 }
464
338 # check for already loaded models 465 # check for already loaded models
466 unless ($MODEL) {
339 for (@REGISTRY, @models) { 467 for (@REGISTRY, @models, @models_detect) {
340 my ($package, $model) = @$_; 468 my ($package, $model) = @$_;
341 if (${"$package\::VERSION"} > 0) { 469 if (${"$package\::VERSION"} > 0) {
342 if (eval "require $model") { 470 if (eval "require $model") {
343 $MODEL = $model; 471 $MODEL = $model;
344 warn "AnyEvent: found model '$model', using it.\n" if $verbose > 1; 472 warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
345 last; 473 last;
474 }
346 } 475 }
347 } 476 }
348 }
349 477
350 unless ($MODEL) { 478 unless ($MODEL) {
351 # try to load a model 479 # try to load a model
352 480
353 for (@REGISTRY, @models) { 481 for (@REGISTRY, @models) {
354 my ($package, $model) = @$_; 482 my ($package, $model) = @$_;
355 if (eval "require $package" 483 if (eval "require $package"
356 and ${"$package\::VERSION"} > 0 484 and ${"$package\::VERSION"} > 0
357 and eval "require $model") { 485 and eval "require $model") {
358 $MODEL = $model; 486 $MODEL = $model;
359 warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1; 487 warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
360 last; 488 last;
489 }
361 } 490 }
491
492 $MODEL
493 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.";
362 } 494 }
363
364 $MODEL
365 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.";
366 } 495 }
367 496
368 unshift @ISA, $MODEL; 497 unshift @ISA, $MODEL;
369 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 498 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
370 } 499 }
… …
481 undef $CHLD_W unless keys %PID_CB; 610 undef $CHLD_W unless keys %PID_CB;
482} 611}
483 612
484=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 613=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
485 614
615This is an advanced topic that you do not normally need to use AnyEvent in
616a module. This section is only of use to event loop authors who want to
617provide AnyEvent compatibility.
618
486If you need to support another event library which isn't directly 619If you need to support another event library which isn't directly
487supported by AnyEvent, you can supply your own interface to it by 620supported by AnyEvent, you can supply your own interface to it by
488pushing, before the first watcher gets created, the package name of 621pushing, before the first watcher gets created, the package name of
489the event module and the package name of the interface to use onto 622the event module and the package name of the interface to use onto
490C<@AnyEvent::REGISTRY>. You can do that before and even without loading 623C<@AnyEvent::REGISTRY>. You can do that before and even without loading
491AnyEvent. 624AnyEvent, so it is reasonably cheap.
492 625
493Example: 626Example:
494 627
495 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 628 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
496 629
497This tells AnyEvent to (literally) use the C<urxvt::anyevent::> 630This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
498package/class when it finds the C<urxvt> package/module is loaded. When 631package/class when it finds the C<urxvt> package/module is already loaded.
632
499AnyEvent is loaded and asked to find a suitable event model, it will 633When AnyEvent is loaded and asked to find a suitable event model, it
500first check for the presence of urxvt. 634will first check for the presence of urxvt by trying to C<use> the
635C<urxvt::anyevent> module.
501 636
502The class should provide implementations for all watcher types (see 637The class should provide implementations for all watcher types. See
503L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib> 638L<AnyEvent::Impl::EV> (source code), L<AnyEvent::Impl::Glib> (Source code)
504(Source code) and so on for actual examples, use C<perldoc -m 639and so on for actual examples. Use C<perldoc -m AnyEvent::Impl::Glib> to
505AnyEvent::Impl::Glib> to see the sources). 640see the sources.
506 641
642If you don't provide C<signal> and C<child> watchers than AnyEvent will
643provide suitable (hopefully) replacements.
644
507The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt) 645The above example isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)
508uses the above line as-is. An interface isn't included in AnyEvent 646terminal emulator uses the above line as-is. An interface isn't included
509because it doesn't make sense outside the embedded interpreter inside 647in AnyEvent because it doesn't make sense outside the embedded interpreter
510I<rxvt-unicode>, and it is updated and maintained as part of the 648inside I<rxvt-unicode>, and it is updated and maintained as part of the
511I<rxvt-unicode> distribution. 649I<rxvt-unicode> distribution.
512 650
513I<rxvt-unicode> also cheats a bit by not providing blocking access to 651I<rxvt-unicode> also cheats a bit by not providing blocking access to
514condition variables: code blocking while waiting for a condition will 652condition variables: code blocking while waiting for a condition will
515C<die>. This still works with most modules/usages, and blocking calls must 653C<die>. This still works with most modules/usages, and blocking calls must
516not be in an interactive application, so it makes sense. 654not be done in an interactive application, so it makes sense.
517 655
518=head1 ENVIRONMENT VARIABLES 656=head1 ENVIRONMENT VARIABLES
519 657
520The following environment variables are used by this module: 658The following environment variables are used by this module:
521 659
522C<PERL_ANYEVENT_VERBOSE> when set to C<2> or higher, reports which event 660=over 4
523model gets used.
524 661
662=item C<PERL_ANYEVENT_VERBOSE>
663
664When set to C<2> or higher, cause AnyEvent to report to STDERR which event
665model it chooses.
666
667=item C<PERL_ANYEVENT_MODEL>
668
669This can be used to specify the event model to be used by AnyEvent, before
670autodetection and -probing kicks in. It must be a string consisting
671entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
672and the resulting module name is loaded and if the load was successful,
673used as event model. If it fails to load AnyEvent will proceed with
674autodetection and -probing.
675
676This functionality might change in future versions.
677
678For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
679could start your program like this:
680
681 PERL_ANYEVENT_MODEL=Perl perl ...
682
683=back
684
525=head1 EXAMPLE 685=head1 EXAMPLE PROGRAM
526 686
527The following program uses an io watcher to read data from stdin, a timer 687The following program uses an IO watcher to read data from STDIN, a timer
528to display a message once per second, and a condvar to exit the program 688to display a message once per second, and a condition variable to quit the
529when the user enters quit: 689program when the user enters quit:
530 690
531 use AnyEvent; 691 use AnyEvent;
532 692
533 my $cv = AnyEvent->condvar; 693 my $cv = AnyEvent->condvar;
534 694
535 my $io_watcher = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 695 my $io_watcher = AnyEvent->io (
696 fh => \*STDIN,
697 poll => 'r',
698 cb => sub {
536 warn "io event <$_[0]>\n"; # will always output <r> 699 warn "io event <$_[0]>\n"; # will always output <r>
537 chomp (my $input = <STDIN>); # read a line 700 chomp (my $input = <STDIN>); # read a line
538 warn "read: $input\n"; # output what has been read 701 warn "read: $input\n"; # output what has been read
539 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i 702 $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i
703 },
540 }); 704 );
541 705
542 my $time_watcher; # can only be used once 706 my $time_watcher; # can only be used once
543 707
544 sub new_timer { 708 sub new_timer {
545 $timer = AnyEvent->timer (after => 1, cb => sub { 709 $timer = AnyEvent->timer (after => 1, cb => sub {
… …
627 $txn->{finished}->wait; 791 $txn->{finished}->wait;
628 return $txn->{result}; 792 return $txn->{result};
629 793
630The actual code goes further and collects all errors (C<die>s, exceptions) 794The actual code goes further and collects all errors (C<die>s, exceptions)
631that occured during request processing. The C<result> method detects 795that occured during request processing. The C<result> method detects
632wether an exception as thrown (it is stored inside the $txn object) 796whether an exception as thrown (it is stored inside the $txn object)
633and just throws the exception, which means connection errors and other 797and just throws the exception, which means connection errors and other
634problems get reported tot he code that tries to use the result, not in a 798problems get reported tot he code that tries to use the result, not in a
635random callback. 799random callback.
636 800
637All of this enables the following usage styles: 801All of this enables the following usage styles:
… …
672 $quit->broadcast; 836 $quit->broadcast;
673 }); 837 });
674 838
675 $quit->wait; 839 $quit->wait;
676 840
841=head1 FORK
842
843Most event libraries are not fork-safe. The ones who are usually are
844because they are so inefficient. Only L<EV> is fully fork-aware.
845
846If you have to fork, you must either do so I<before> creating your first
847watcher OR you must not use AnyEvent at all in the child.
848
849=head1 SECURITY CONSIDERATIONS
850
851AnyEvent can be forced to load any event model via
852$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used to
853execute arbitrary code or directly gain access, it can easily be used to
854make the program hang or malfunction in subtle ways, as AnyEvent watchers
855will not be active when the program uses a different event model than
856specified in the variable.
857
858You can make AnyEvent completely ignore this variable by deleting it
859before the first watcher gets created, e.g. with a C<BEGIN> block:
860
861 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
862
863 use AnyEvent;
864
677=head1 SEE ALSO 865=head1 SEE ALSO
678 866
679Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, 867Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,
680L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>. 868L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,
869L<Event::Lib>, L<Qt>.
681 870
682Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, 871Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,
683L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, 872L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,
684L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>. 873L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,
874L<AnyEvent::Impl::Qt>.
685 875
686Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. 876Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.
687 877
688=head1 878=head1 AUTHOR
879
880 Marc Lehmann <schmorp@schmorp.de>
881 http://home.schmorp.de/
689 882
690=cut 883=cut
691 884
6921 8851
693 886

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines