ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/README
(Generate patch)

Comparing AnyEvent/README (file contents):
Revision 1.41 by root, Fri Jun 26 06:33:17 2009 UTC vs.
Revision 1.67 by root, Fri Aug 26 05:33:53 2011 UTC

1NAME 1NAME
2 AnyEvent - provide framework for multiple event loops 2 AnyEvent - the DBI of event loop programming
3 3
4 EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 4 EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async,
5 event loops. 5 Qt, FLTK and POE are various supported event loops/environments.
6 6
7SYNOPSIS 7SYNOPSIS
8 use AnyEvent; 8 use AnyEvent;
9 9
10 # if you prefer function calls, look at the AE manpage for
11 # an alternative API.
12
10 # file descriptor readable 13 # file handle or descriptor readable
11 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); 14 my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... });
12 15
13 # one-shot or repeating timers 16 # one-shot or repeating timers
14 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); 17 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
15 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... 18 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...);
16 19
17 print AnyEvent->now; # prints current event loop time 20 print AnyEvent->now; # prints current event loop time
18 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. 21 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
19 22
20 # POSIX signal 23 # POSIX signal
37 40
38INTRODUCTION/TUTORIAL 41INTRODUCTION/TUTORIAL
39 This manpage is mainly a reference manual. If you are interested in a 42 This manpage is mainly a reference manual. If you are interested in a
40 tutorial or some gentle introduction, have a look at the AnyEvent::Intro 43 tutorial or some gentle introduction, have a look at the AnyEvent::Intro
41 manpage. 44 manpage.
45
46SUPPORT
47 An FAQ document is available as AnyEvent::FAQ.
48
49 There also is a mailinglist for discussing all things AnyEvent, and an
50 IRC channel, too.
51
52 See the AnyEvent project page at the Schmorpforge Ta-Sa Software
53 Repository, at <http://anyevent.schmorp.de>, for more info.
42 54
43WHY YOU SHOULD USE THIS MODULE (OR NOT) 55WHY YOU SHOULD USE THIS MODULE (OR NOT)
44 Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56 Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
45 nowadays. So what is different about AnyEvent? 57 nowadays. So what is different about AnyEvent?
46 58
61 module users into the same thing by forcing them to use the same event 73 module users into the same thing by forcing them to use the same event
62 model you use. 74 model you use.
63 75
64 For modules like POE or IO::Async (which is a total misnomer as it is 76 For modules like POE or IO::Async (which is a total misnomer as it is
65 actually doing all I/O *synchronously*...), using them in your module is 77 actually doing all I/O *synchronously*...), using them in your module is
66 like joining a cult: After you joined, you are dependent on them and you 78 like joining a cult: After you join, you are dependent on them and you
67 cannot use anything else, as they are simply incompatible to everything 79 cannot use anything else, as they are simply incompatible to everything
68 that isn't them. What's worse, all the potential users of your module 80 that isn't them. What's worse, all the potential users of your module
69 are *also* forced to use the same event loop you use. 81 are *also* forced to use the same event loop you use.
70 82
71 AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 83 AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
72 fine. AnyEvent + Tk works fine etc. etc. but none of these work together 84 fine. AnyEvent + Tk works fine etc. etc. but none of these work together
73 with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if your 85 with the rest: POE + EV? No go. Tk + Event? No go. Again: if your module
74 module uses one of those, every user of your module has to use it, too. 86 uses one of those, every user of your module has to use it, too. But if
75 But if your module uses AnyEvent, it works transparently with all event 87 your module uses AnyEvent, it works transparently with all event models
76 models it supports (including stuff like IO::Async, as long as those use 88 it supports (including stuff like IO::Async, as long as those use one of
77 one of the supported event loops. It is trivial to add new event loops 89 the supported event loops. It is easy to add new event loops to
78 to AnyEvent, too, so it is future-proof). 90 AnyEvent, too, so it is future-proof).
79 91
80 In addition to being free of having to use *the one and only true event 92 In addition to being free of having to use *the one and only true event
81 model*, AnyEvent also is free of bloat and policy: with POE or similar 93 model*, AnyEvent also is free of bloat and policy: with POE or similar
82 modules, you get an enormous amount of code and strict rules you have to 94 modules, you get an enormous amount of code and strict rules you have to
83 follow. AnyEvent, on the other hand, is lean and up to the point, by 95 follow. AnyEvent, on the other hand, is lean and to the point, by only
84 only offering the functionality that is necessary, in as thin as a 96 offering the functionality that is necessary, in as thin as a wrapper as
85 wrapper as technically possible. 97 technically possible.
86 98
87 Of course, AnyEvent comes with a big (and fully optional!) toolbox of 99 Of course, AnyEvent comes with a big (and fully optional!) toolbox of
88 useful functionality, such as an asynchronous DNS resolver, 100% 100 useful functionality, such as an asynchronous DNS resolver, 100%
89 non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms 101 non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms
90 such as Windows) and lots of real-world knowledge and workarounds for 102 such as Windows) and lots of real-world knowledge and workarounds for
93 Now, if you *do want* lots of policy (this can arguably be somewhat 105 Now, if you *do want* lots of policy (this can arguably be somewhat
94 useful) and you want to force your users to use the one and only event 106 useful) and you want to force your users to use the one and only event
95 model, you should *not* use this module. 107 model, you should *not* use this module.
96 108
97DESCRIPTION 109DESCRIPTION
98 AnyEvent provides an identical interface to multiple event loops. This 110 AnyEvent provides a uniform interface to various event loops. This
99 allows module authors to utilise an event loop without forcing module 111 allows module authors to use event loop functionality without forcing
100 users to use the same event loop (as only a single event loop can 112 module users to use a specific event loop implementation (since more
101 coexist peacefully at any one time). 113 than one event loop cannot coexist peacefully).
102 114
103 The interface itself is vaguely similar, but not identical to the Event 115 The interface itself is vaguely similar, but not identical to the Event
104 module. 116 module.
105 117
106 During the first call of any watcher-creation method, the module tries 118 During the first call of any watcher-creation method, the module tries
107 to detect the currently loaded event loop by probing whether one of the 119 to detect the currently loaded event loop by probing whether one of the
108 following modules is already loaded: EV, Event, Glib, 120 following modules is already loaded: EV, AnyEvent::Loop, Event, Glib,
109 AnyEvent::Impl::Perl, Tk, Event::Lib, Qt, POE. The first one found is 121 Tk, Event::Lib, Qt, POE. The first one found is used. If none are
110 used. If none are found, the module tries to load these modules 122 detected, the module tries to load the first four modules in the order
111 (excluding Tk, Event::Lib, Qt and POE as the pure perl adaptor should 123 given; but note that if EV is not available, the pure-perl
112 always succeed) in the order given. The first one that can be 124 AnyEvent::Loop should always work, so the other two are not normally
113 successfully loaded will be used. If, after this, still none could be 125 tried.
114 found, AnyEvent will fall back to a pure-perl event loop, which is not
115 very efficient, but should work everywhere.
116 126
117 Because AnyEvent first checks for modules that are already loaded, 127 Because AnyEvent first checks for modules that are already loaded,
118 loading an event model explicitly before first using AnyEvent will 128 loading an event model explicitly before first using AnyEvent will
119 likely make that model the default. For example: 129 likely make that model the default. For example:
120 130
122 use AnyEvent; 132 use AnyEvent;
123 133
124 # .. AnyEvent will likely default to Tk 134 # .. AnyEvent will likely default to Tk
125 135
126 The *likely* means that, if any module loads another event model and 136 The *likely* means that, if any module loads another event model and
127 starts using it, all bets are off. Maybe you should tell their authors 137 starts using it, all bets are off - this case should be very rare
128 to use AnyEvent so their modules work together with others seamlessly... 138 though, as very few modules hardcode event loops without announcing this
139 very loudly.
129 140
130 The pure-perl implementation of AnyEvent is called 141 The pure-perl implementation of AnyEvent is called "AnyEvent::Loop".
131 "AnyEvent::Impl::Perl". Like other event modules you can load it 142 Like other event modules you can load it explicitly and enjoy the high
132 explicitly and enjoy the high availability of that event loop :) 143 availability of that event loop :)
133 144
134WATCHERS 145WATCHERS
135 AnyEvent has the central concept of a *watcher*, which is an object that 146 AnyEvent has the central concept of a *watcher*, which is an object that
136 stores relevant data for each kind of event you are waiting for, such as 147 stores relevant data for each kind of event you are waiting for, such as
137 the callback to call, the file handle to watch, etc. 148 the callback to call, the file handle to watch, etc.
141 callback when the event occurs (of course, only when the event model is 152 callback when the event occurs (of course, only when the event model is
142 in control). 153 in control).
143 154
144 Note that callbacks must not permanently change global variables 155 Note that callbacks must not permanently change global variables
145 potentially in use by the event loop (such as $_ or $[) and that 156 potentially in use by the event loop (such as $_ or $[) and that
146 callbacks must not "die". The former is good programming practise in 157 callbacks must not "die". The former is good programming practice in
147 Perl and the latter stems from the fact that exception handling differs 158 Perl and the latter stems from the fact that exception handling differs
148 widely between event loops. 159 widely between event loops.
149 160
150 To disable the watcher you have to destroy it (e.g. by setting the 161 To disable a watcher you have to destroy it (e.g. by setting the
151 variable you store it in to "undef" or otherwise deleting all references 162 variable you store it in to "undef" or otherwise deleting all references
152 to it). 163 to it).
153 164
154 All watchers are created by calling a method on the "AnyEvent" class. 165 All watchers are created by calling a method on the "AnyEvent" class.
155 166
156 Many watchers either are used with "recursion" (repeating timers for 167 Many watchers either are used with "recursion" (repeating timers for
157 example), or need to refer to their watcher object in other ways. 168 example), or need to refer to their watcher object in other ways.
158 169
159 An any way to achieve that is this pattern: 170 One way to achieve that is this pattern:
160 171
161 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 172 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
162 # you can use $w here, for example to undef it 173 # you can use $w here, for example to undef it
163 undef $w; 174 undef $w;
164 }); 175 });
166 Note that "my $w; $w =" combination. This is necessary because in Perl, 177 Note that "my $w; $w =" combination. This is necessary because in Perl,
167 my variables are only visible after the statement in which they are 178 my variables are only visible after the statement in which they are
168 declared. 179 declared.
169 180
170 I/O WATCHERS 181 I/O WATCHERS
182 $w = AnyEvent->io (
183 fh => <filehandle_or_fileno>,
184 poll => <"r" or "w">,
185 cb => <callback>,
186 );
187
171 You can create an I/O watcher by calling the "AnyEvent->io" method with 188 You can create an I/O watcher by calling the "AnyEvent->io" method with
172 the following mandatory key-value pairs as arguments: 189 the following mandatory key-value pairs as arguments:
173 190
174 "fh" is the Perl *file handle* (*not* file descriptor) to watch for 191 "fh" is the Perl *file handle* (or a naked file descriptor) to watch for
175 events (AnyEvent might or might not keep a reference to this file 192 events (AnyEvent might or might not keep a reference to this file
176 handle). Note that only file handles pointing to things for which 193 handle). Note that only file handles pointing to things for which
177 non-blocking operation makes sense are allowed. This includes sockets, 194 non-blocking operation makes sense are allowed. This includes sockets,
178 most character devices, pipes, fifos and so on, but not for example 195 most character devices, pipes, fifos and so on, but not for example
179 files or block devices. 196 files or block devices.
189 206
190 The I/O watcher might use the underlying file descriptor or a copy of 207 The I/O watcher might use the underlying file descriptor or a copy of
191 it. You must not close a file handle as long as any watcher is active on 208 it. You must not close a file handle as long as any watcher is active on
192 the underlying file descriptor. 209 the underlying file descriptor.
193 210
194 Some event loops issue spurious readyness notifications, so you should 211 Some event loops issue spurious readiness notifications, so you should
195 always use non-blocking calls when reading/writing from/to your file 212 always use non-blocking calls when reading/writing from/to your file
196 handles. 213 handles.
197 214
198 Example: wait for readability of STDIN, then read a line and disable the 215 Example: wait for readability of STDIN, then read a line and disable the
199 watcher. 216 watcher.
203 warn "read: $input\n"; 220 warn "read: $input\n";
204 undef $w; 221 undef $w;
205 }); 222 });
206 223
207 TIME WATCHERS 224 TIME WATCHERS
225 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
226
227 $w = AnyEvent->timer (
228 after => <fractional_seconds>,
229 interval => <fractional_seconds>,
230 cb => <callback>,
231 );
232
208 You can create a time watcher by calling the "AnyEvent->timer" method 233 You can create a time watcher by calling the "AnyEvent->timer" method
209 with the following mandatory arguments: 234 with the following mandatory arguments:
210 235
211 "after" specifies after how many seconds (fractional values are 236 "after" specifies after how many seconds (fractional values are
212 supported) the callback should be invoked. "cb" is the callback to 237 supported) the callback should be invoked. "cb" is the callback to
214 239
215 Although the callback might get passed parameters, their value and 240 Although the callback might get passed parameters, their value and
216 presence is undefined and you cannot rely on them. Portable AnyEvent 241 presence is undefined and you cannot rely on them. Portable AnyEvent
217 callbacks cannot use arguments passed to time watcher callbacks. 242 callbacks cannot use arguments passed to time watcher callbacks.
218 243
219 The callback will normally be invoked once only. If you specify another 244 The callback will normally be invoked only once. If you specify another
220 parameter, "interval", as a strictly positive number (> 0), then the 245 parameter, "interval", as a strictly positive number (> 0), then the
221 callback will be invoked regularly at that interval (in fractional 246 callback will be invoked regularly at that interval (in fractional
222 seconds) after the first invocation. If "interval" is specified with a 247 seconds) after the first invocation. If "interval" is specified with a
223 false value, then it is treated as if it were missing. 248 false value, then it is treated as if it were not specified at all.
224 249
225 The callback will be rescheduled before invoking the callback, but no 250 The callback will be rescheduled before invoking the callback, but no
226 attempt is done to avoid timer drift in most backends, so the interval 251 attempt is made to avoid timer drift in most backends, so the interval
227 is only approximate. 252 is only approximate.
228 253
229 Example: fire an event after 7.7 seconds. 254 Example: fire an event after 7.7 seconds.
230 255
231 my $w = AnyEvent->timer (after => 7.7, cb => sub { 256 my $w = AnyEvent->timer (after => 7.7, cb => sub {
248 273
249 While most event loops expect timers to specified in a relative way, 274 While most event loops expect timers to specified in a relative way,
250 they use absolute time internally. This makes a difference when your 275 they use absolute time internally. This makes a difference when your
251 clock "jumps", for example, when ntp decides to set your clock backwards 276 clock "jumps", for example, when ntp decides to set your clock backwards
252 from the wrong date of 2014-01-01 to 2008-01-01, a watcher that is 277 from the wrong date of 2014-01-01 to 2008-01-01, a watcher that is
253 supposed to fire "after" a second might actually take six years to 278 supposed to fire "after a second" might actually take six years to
254 finally fire. 279 finally fire.
255 280
256 AnyEvent cannot compensate for this. The only event loop that is 281 AnyEvent cannot compensate for this. The only event loop that is
257 conscious about these issues is EV, which offers both relative 282 conscious of these issues is EV, which offers both relative (ev_timer,
258 (ev_timer, based on true relative time) and absolute (ev_periodic, based 283 based on true relative time) and absolute (ev_periodic, based on
259 on wallclock time) timers. 284 wallclock time) timers.
260 285
261 AnyEvent always prefers relative timers, if available, matching the 286 AnyEvent always prefers relative timers, if available, matching the
262 AnyEvent API. 287 AnyEvent API.
263 288
264 AnyEvent has two additional methods that return the "current time": 289 AnyEvent has two additional methods that return the "current time":
283 *In almost all cases (in all cases if you don't care), this is the 308 *In almost all cases (in all cases if you don't care), this is the
284 function to call when you want to know the current time.* 309 function to call when you want to know the current time.*
285 310
286 This function is also often faster then "AnyEvent->time", and thus 311 This function is also often faster then "AnyEvent->time", and thus
287 the preferred method if you want some timestamp (for example, 312 the preferred method if you want some timestamp (for example,
288 AnyEvent::Handle uses this to update it's activity timeouts). 313 AnyEvent::Handle uses this to update its activity timeouts).
289 314
290 The rest of this section is only of relevance if you try to be very 315 The rest of this section is only of relevance if you try to be very
291 exact with your timing, you can skip it without bad conscience. 316 exact with your timing; you can skip it without a bad conscience.
292 317
293 For a practical example of when these times differ, consider 318 For a practical example of when these times differ, consider
294 Event::Lib and EV and the following set-up: 319 Event::Lib and EV and the following set-up:
295 320
296 The event loop is running and has just invoked one of your callback 321 The event loop is running and has just invoked one of your callbacks
297 at time=500 (assume no other callbacks delay processing). In your 322 at time=500 (assume no other callbacks delay processing). In your
298 callback, you wait a second by executing "sleep 1" (blocking the 323 callback, you wait a second by executing "sleep 1" (blocking the
299 process for a second) and then (at time=501) you create a relative 324 process for a second) and then (at time=501) you create a relative
300 timer that fires after three seconds. 325 timer that fires after three seconds.
301 326
322 can get whatever behaviour you want with any event loop, by taking 347 can get whatever behaviour you want with any event loop, by taking
323 the difference between "AnyEvent->time" and "AnyEvent->now" into 348 the difference between "AnyEvent->time" and "AnyEvent->now" into
324 account. 349 account.
325 350
326 AnyEvent->now_update 351 AnyEvent->now_update
327 Some event loops (such as EV or AnyEvent::Impl::Perl) cache the 352 Some event loops (such as EV or AnyEvent::Loop) cache the current
328 current time for each loop iteration (see the discussion of 353 time for each loop iteration (see the discussion of AnyEvent->now,
329 AnyEvent->now, above). 354 above).
330 355
331 When a callback runs for a long time (or when the process sleeps), 356 When a callback runs for a long time (or when the process sleeps),
332 then this "current" time will differ substantially from the real 357 then this "current" time will differ substantially from the real
333 time, which might affect timers and time-outs. 358 time, which might affect timers and time-outs.
334 359
335 When this is the case, you can call this method, which will update 360 When this is the case, you can call this method, which will update
336 the event loop's idea of "current time". 361 the event loop's idea of "current time".
337 362
363 A typical example would be a script in a web server (e.g.
364 "mod_perl") - when mod_perl executes the script, then the event loop
365 will have the wrong idea about the "current time" (being potentially
366 far in the past, when the script ran the last time). In that case
367 you should arrange a call to "AnyEvent->now_update" each time the
368 web server process wakes up again (e.g. at the start of your script,
369 or in a handler).
370
338 Note that updating the time *might* cause some events to be handled. 371 Note that updating the time *might* cause some events to be handled.
339 372
340 SIGNAL WATCHERS 373 SIGNAL WATCHERS
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
375
341 You can watch for signals using a signal watcher, "signal" is the signal 376 You can watch for signals using a signal watcher, "signal" is the signal
342 *name* in uppercase and without any "SIG" prefix, "cb" is the Perl 377 *name* in uppercase and without any "SIG" prefix, "cb" is the Perl
343 callback to be invoked whenever a signal occurs. 378 callback to be invoked whenever a signal occurs.
344 379
345 Although the callback might get passed parameters, their value and 380 Although the callback might get passed parameters, their value and
350 invocation, and callback invocation will be synchronous. Synchronous 385 invocation, and callback invocation will be synchronous. Synchronous
351 means that it might take a while until the signal gets handled by the 386 means that it might take a while until the signal gets handled by the
352 process, but it is guaranteed not to interrupt any other callbacks. 387 process, but it is guaranteed not to interrupt any other callbacks.
353 388
354 The main advantage of using these watchers is that you can share a 389 The main advantage of using these watchers is that you can share a
355 signal between multiple watchers. 390 signal between multiple watchers, and AnyEvent will ensure that signals
391 will not interrupt your program at bad times.
356 392
357 This watcher might use %SIG, so programs overwriting those signals 393 This watcher might use %SIG (depending on the event loop used), so
358 directly will likely not work correctly. 394 programs overwriting those signals directly will likely not work
395 correctly.
359 396
360 Example: exit on SIGINT 397 Example: exit on SIGINT
361 398
362 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
363 400
401 Restart Behaviour
402 While restart behaviour is up to the event loop implementation, most
403 will not restart syscalls (that includes Async::Interrupt and AnyEvent's
404 pure perl implementation).
405
406 Safe/Unsafe Signals
407 Perl signals can be either "safe" (synchronous to opcode handling) or
408 "unsafe" (asynchronous) - the former might get delayed indefinitely, the
409 latter might corrupt your memory.
410
411 AnyEvent signal handlers are, in addition, synchronous to the event
412 loop, i.e. they will not interrupt your running perl program but will
413 only be called as part of the normal event handling (just like timer,
414 I/O etc. callbacks, too).
415
416 Signal Races, Delays and Workarounds
417 Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
418 callbacks to signals in a generic way, which is a pity, as you cannot do
419 race-free signal handling in perl, requiring C libraries for this.
420 AnyEvent will try to do its best, which means in some cases, signals
421 will be delayed. The maximum time a signal might be delayed is specified
422 in $AnyEvent::MAX_SIGNAL_LATENCY (default: 10 seconds). This variable
423 can be changed only before the first signal watcher is created, and
424 should be left alone otherwise. This variable determines how often
425 AnyEvent polls for signals (in case a wake-up was missed). Higher values
426 will cause fewer spurious wake-ups, which is better for power and CPU
427 saving.
428
429 All these problems can be avoided by installing the optional
430 Async::Interrupt module, which works with most event loops. It will not
431 work with inherently broken event loops such as Event or Event::Lib (and
432 not with POE currently, as POE does its own workaround with one-second
433 latency). For those, you just have to suffer the delays.
434
364 CHILD PROCESS WATCHERS 435 CHILD PROCESS WATCHERS
436 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
437
365 You can also watch on a child process exit and catch its exit status. 438 You can also watch for a child process exit and catch its exit status.
366 439
367 The child process is specified by the "pid" argument (if set to 0, it 440 The child process is specified by the "pid" argument (on some backends,
368 watches for any child process exit). The watcher will triggered only 441 using 0 watches for any child process exit, on others this will croak).
369 when the child process has finished and an exit status is available, not 442 The watcher will be triggered only when the child process has finished
370 on any trace events (stopped/continued). 443 and an exit status is available, not on any trace events
444 (stopped/continued).
371 445
372 The callback will be called with the pid and exit status (as returned by 446 The callback will be called with the pid and exit status (as returned by
373 waitpid), so unlike other watcher types, you *can* rely on child watcher 447 waitpid), so unlike other watcher types, you *can* rely on child watcher
374 callback arguments. 448 callback arguments.
375 449
390 of when you start the watcher. 464 of when you start the watcher.
391 465
392 This means you cannot create a child watcher as the very first thing in 466 This means you cannot create a child watcher as the very first thing in
393 an AnyEvent program, you *have* to create at least one watcher before 467 an AnyEvent program, you *have* to create at least one watcher before
394 you "fork" the child (alternatively, you can call "AnyEvent::detect"). 468 you "fork" the child (alternatively, you can call "AnyEvent::detect").
469
470 As most event loops do not support waiting for child events, they will
471 be emulated by AnyEvent in most cases, in which case the latency and
472 race problems mentioned in the description of signal watchers apply.
395 473
396 Example: fork a process and wait for it 474 Example: fork a process and wait for it
397 475
398 my $done = AnyEvent->condvar; 476 my $done = AnyEvent->condvar;
399 477
410 488
411 # do something else, then wait for process exit 489 # do something else, then wait for process exit
412 $done->recv; 490 $done->recv;
413 491
414 IDLE WATCHERS 492 IDLE WATCHERS
415 Sometimes there is a need to do something, but it is not so important to 493 $w = AnyEvent->idle (cb => <callback>);
416 do it instantly, but only when there is nothing better to do. This
417 "nothing better to do" is usually defined to be "no other events need
418 attention by the event loop".
419 494
420 Idle watchers ideally get invoked when the event loop has nothing better 495 This will repeatedly invoke the callback after the process becomes idle,
421 to do, just before it would block the process to wait for new events. 496 until either the watcher is destroyed or new events have been detected.
422 Instead of blocking, the idle watcher is invoked.
423 497
424 Most event loops unfortunately do not really support idle watchers (only 498 Idle watchers are useful when there is a need to do something, but it is
499 not so important (or wise) to do it instantly. The callback will be
500 invoked only when there is "nothing better to do", which is usually
501 defined as "all outstanding events have been handled and no new events
502 have been detected". That means that idle watchers ideally get invoked
503 when the event loop has just polled for new events but none have been
504 detected. Instead of blocking to wait for more events, the idle watchers
505 will be invoked.
506
507 Unfortunately, most event loops do not really support idle watchers
425 EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 508 (only EV, Event and Glib do it in a usable fashion) - for the rest,
426 will simply call the callback "from time to time". 509 AnyEvent will simply call the callback "from time to time".
427 510
428 Example: read lines from STDIN, but only process them when the program 511 Example: read lines from STDIN, but only process them when the program
429 is otherwise idle: 512 is otherwise idle:
430 513
431 my @lines; # read data 514 my @lines; # read data
444 } 527 }
445 }); 528 });
446 }); 529 });
447 530
448 CONDITION VARIABLES 531 CONDITION VARIABLES
532 $cv = AnyEvent->condvar;
533
534 $cv->send (<list>);
535 my @res = $cv->recv;
536
449 If you are familiar with some event loops you will know that all of them 537 If you are familiar with some event loops you will know that all of them
450 require you to run some blocking "loop", "run" or similar function that 538 require you to run some blocking "loop", "run" or similar function that
451 will actively watch for new events and call your callbacks. 539 will actively watch for new events and call your callbacks.
452 540
453 AnyEvent is different, it expects somebody else to run the event loop 541 AnyEvent is slightly different: it expects somebody else to run the
454 and will only block when necessary (usually when told by the user). 542 event loop and will only block when necessary (usually when told by the
543 user).
455 544
456 The instrument to do that is called a "condition variable", so called 545 The tool to do that is called a "condition variable", so called because
457 because they represent a condition that must become true. 546 they represent a condition that must become true.
547
548 Now is probably a good time to look at the examples further below.
458 549
459 Condition variables can be created by calling the "AnyEvent->condvar" 550 Condition variables can be created by calling the "AnyEvent->condvar"
460 method, usually without arguments. The only argument pair allowed is 551 method, usually without arguments. The only argument pair allowed is
461
462 "cb", which specifies a callback to be called when the condition 552 "cb", which specifies a callback to be called when the condition
463 variable becomes true, with the condition variable as the first argument 553 variable becomes true, with the condition variable as the first argument
464 (but not the results). 554 (but not the results).
465 555
466 After creation, the condition variable is "false" until it becomes 556 After creation, the condition variable is "false" until it becomes
467 "true" by calling the "send" method (or calling the condition variable 557 "true" by calling the "send" method (or calling the condition variable
468 as if it were a callback, read about the caveats in the description for 558 as if it were a callback, read about the caveats in the description for
469 the "->send" method). 559 the "->send" method).
470 560
471 Condition variables are similar to callbacks, except that you can 561 Since condition variables are the most complex part of the AnyEvent API,
472 optionally wait for them. They can also be called merge points - points 562 here are some different mental models of what they are - pick the ones
473 in time where multiple outstanding events have been processed. And yet 563 you can connect to:
474 another way to call them is transactions - each condition variable can 564
475 be used to represent a transaction, which finishes at some point and 565 * Condition variables are like callbacks - you can call them (and pass
476 delivers a result. 566 them instead of callbacks). Unlike callbacks however, you can also
567 wait for them to be called.
568
569 * Condition variables are signals - one side can emit or send them,
570 the other side can wait for them, or install a handler that is
571 called when the signal fires.
572
573 * Condition variables are like "Merge Points" - points in your program
574 where you merge multiple independent results/control flows into one.
575
576 * Condition variables represent a transaction - functions that start
577 some kind of transaction can return them, leaving the caller the
578 choice between waiting in a blocking fashion, or setting a callback.
579
580 * Condition variables represent future values, or promises to deliver
581 some result, long before the result is available.
477 582
478 Condition variables are very useful to signal that something has 583 Condition variables are very useful to signal that something has
479 finished, for example, if you write a module that does asynchronous http 584 finished, for example, if you write a module that does asynchronous http
480 requests, then a condition variable would be the ideal candidate to 585 requests, then a condition variable would be the ideal candidate to
481 signal the availability of results. The user can either act when the 586 signal the availability of results. The user can either act when the
494 599
495 Condition variables are represented by hash refs in perl, and the keys 600 Condition variables are represented by hash refs in perl, and the keys
496 used by AnyEvent itself are all named "_ae_XXX" to make subclassing easy 601 used by AnyEvent itself are all named "_ae_XXX" to make subclassing easy
497 (it is often useful to build your own transaction class on top of 602 (it is often useful to build your own transaction class on top of
498 AnyEvent). To subclass, use "AnyEvent::CondVar" as base class and call 603 AnyEvent). To subclass, use "AnyEvent::CondVar" as base class and call
499 it's "new" method in your own "new" method. 604 its "new" method in your own "new" method.
500 605
501 There are two "sides" to a condition variable - the "producer side" 606 There are two "sides" to a condition variable - the "producer side"
502 which eventually calls "-> send", and the "consumer side", which waits 607 which eventually calls "-> send", and the "consumer side", which waits
503 for the send to occur. 608 for the send to occur.
504 609
505 Example: wait for a timer. 610 Example: wait for a timer.
506 611
507 # wait till the result is ready 612 # condition: "wait till the timer is fired"
508 my $result_ready = AnyEvent->condvar; 613 my $timer_fired = AnyEvent->condvar;
509 614
510 # do something such as adding a timer 615 # create the timer - we could wait for, say
511 # or socket watcher the calls $result_ready->send 616 # a handle becomign ready, or even an
512 # when the "result" is ready. 617 # AnyEvent::HTTP request to finish, but
513 # in this case, we simply use a timer: 618 # in this case, we simply use a timer:
514 my $w = AnyEvent->timer ( 619 my $w = AnyEvent->timer (
515 after => 1, 620 after => 1,
516 cb => sub { $result_ready->send }, 621 cb => sub { $timer_fired->send },
517 ); 622 );
518 623
519 # this "blocks" (while handling events) till the callback 624 # this "blocks" (while handling events) till the callback
520 # calls send 625 # calls ->send
521 $result_ready->recv; 626 $timer_fired->recv;
522 627
523 Example: wait for a timer, but take advantage of the fact that condition 628 Example: wait for a timer, but take advantage of the fact that condition
524 variables are also code references. 629 variables are also callable directly.
525 630
526 my $done = AnyEvent->condvar; 631 my $done = AnyEvent->condvar;
527 my $delay = AnyEvent->timer (after => 5, cb => $done); 632 my $delay = AnyEvent->timer (after => 5, cb => $done);
528 $done->recv; 633 $done->recv;
529 634
535 640
536 ... 641 ...
537 642
538 my @info = $couchdb->info->recv; 643 my @info = $couchdb->info->recv;
539 644
540 And this is how you would just ste a callback to be called whenever the 645 And this is how you would just set a callback to be called whenever the
541 results are available: 646 results are available:
542 647
543 $couchdb->info->cb (sub { 648 $couchdb->info->cb (sub {
544 my @info = $_[0]->recv; 649 my @info = $_[0]->recv;
545 }); 650 });
560 665
561 Any arguments passed to the "send" call will be returned by all 666 Any arguments passed to the "send" call will be returned by all
562 future "->recv" calls. 667 future "->recv" calls.
563 668
564 Condition variables are overloaded so one can call them directly (as 669 Condition variables are overloaded so one can call them directly (as
565 a code reference). Calling them directly is the same as calling 670 if they were a code reference). Calling them directly is the same as
566 "send". Note, however, that many C-based event loops do not handle 671 calling "send".
567 overloading, so as tempting as it may be, passing a condition
568 variable instead of a callback does not work. Both the pure perl and
569 EV loops support overloading, however, as well as all functions that
570 use perl to invoke a callback (as in AnyEvent::Socket and
571 AnyEvent::DNS for example).
572 672
573 $cv->croak ($error) 673 $cv->croak ($error)
574 Similar to send, but causes all call's to "->recv" to invoke 674 Similar to send, but causes all calls to "->recv" to invoke
575 "Carp::croak" with the given error message/object/scalar. 675 "Carp::croak" with the given error message/object/scalar.
576 676
577 This can be used to signal any errors to the condition variable 677 This can be used to signal any errors to the condition variable
578 user/consumer. 678 user/consumer. Doing it this way instead of calling "croak" directly
679 delays the error detection, but has the overwhelming advantage that
680 it diagnoses the error at the place where the result is expected,
681 and not deep in some event callback with no connection to the actual
682 code causing the problem.
579 683
580 $cv->begin ([group callback]) 684 $cv->begin ([group callback])
581 $cv->end 685 $cv->end
582 These two methods are EXPERIMENTAL and MIGHT CHANGE.
583
584 These two methods can be used to combine many transactions/events 686 These two methods can be used to combine many transactions/events
585 into one. For example, a function that pings many hosts in parallel 687 into one. For example, a function that pings many hosts in parallel
586 might want to use a condition variable for the whole process. 688 might want to use a condition variable for the whole process.
587 689
588 Every call to "->begin" will increment a counter, and every call to 690 Every call to "->begin" will increment a counter, and every call to
589 "->end" will decrement it. If the counter reaches 0 in "->end", the 691 "->end" will decrement it. If the counter reaches 0 in "->end", the
590 (last) callback passed to "begin" will be executed. That callback is 692 (last) callback passed to "begin" will be executed, passing the
591 *supposed* to call "->send", but that is not required. If no 693 condvar as first argument. That callback is *supposed* to call
694 "->send", but that is not required. If no group callback was set,
592 callback was set, "send" will be called without any arguments. 695 "send" will be called without any arguments.
593 696
594 Let's clarify this with the ping example: 697 You can think of "$cv->send" giving you an OR condition (one call
698 sends), while "$cv->begin" and "$cv->end" giving you an AND
699 condition (all "begin" calls must be "end"'ed before the condvar
700 sends).
701
702 Let's start with a simple example: you have two I/O watchers (for
703 example, STDOUT and STDERR for a program), and you want to wait for
704 both streams to close before activating a condvar:
595 705
596 my $cv = AnyEvent->condvar; 706 my $cv = AnyEvent->condvar;
597 707
708 $cv->begin; # first watcher
709 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
710 defined sysread $fh1, my $buf, 4096
711 or $cv->end;
712 });
713
714 $cv->begin; # second watcher
715 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
716 defined sysread $fh2, my $buf, 4096
717 or $cv->end;
718 });
719
720 $cv->recv;
721
722 This works because for every event source (EOF on file handle),
723 there is one call to "begin", so the condvar waits for all calls to
724 "end" before sending.
725
726 The ping example mentioned above is slightly more complicated, as
727 the there are results to be passwd back, and the number of tasks
728 that are begun can potentially be zero:
729
730 my $cv = AnyEvent->condvar;
731
598 my %result; 732 my %result;
599 $cv->begin (sub { $cv->send (\%result) }); 733 $cv->begin (sub { shift->send (\%result) });
600 734
601 for my $host (@list_of_hosts) { 735 for my $host (@list_of_hosts) {
602 $cv->begin; 736 $cv->begin;
603 ping_host_then_call_callback $host, sub { 737 ping_host_then_call_callback $host, sub {
604 $result{$host} = ...; 738 $result{$host} = ...;
619 the loop, which serves two important purposes: first, it sets the 753 the loop, which serves two important purposes: first, it sets the
620 callback to be called once the counter reaches 0, and second, it 754 callback to be called once the counter reaches 0, and second, it
621 ensures that "send" is called even when "no" hosts are being pinged 755 ensures that "send" is called even when "no" hosts are being pinged
622 (the loop doesn't execute once). 756 (the loop doesn't execute once).
623 757
624 This is the general pattern when you "fan out" into multiple 758 This is the general pattern when you "fan out" into multiple (but
625 subrequests: use an outer "begin"/"end" pair to set the callback and 759 potentially zero) subrequests: use an outer "begin"/"end" pair to
626 ensure "end" is called at least once, and then, for each subrequest 760 set the callback and ensure "end" is called at least once, and then,
627 you start, call "begin" and for each subrequest you finish, call 761 for each subrequest you start, call "begin" and for each subrequest
628 "end". 762 you finish, call "end".
629 763
630 METHODS FOR CONSUMERS 764 METHODS FOR CONSUMERS
631 These methods should only be used by the consuming side, i.e. the code 765 These methods should only be used by the consuming side, i.e. the code
632 awaits the condition. 766 awaits the condition.
633 767
634 $cv->recv 768 $cv->recv
635 Wait (blocking if necessary) until the "->send" or "->croak" methods 769 Wait (blocking if necessary) until the "->send" or "->croak" methods
636 have been called on c<$cv>, while servicing other watchers normally. 770 have been called on $cv, while servicing other watchers normally.
637 771
638 You can only wait once on a condition - additional calls are valid 772 You can only wait once on a condition - additional calls are valid
639 but will return immediately. 773 but will return immediately.
640 774
641 If an error condition has been set by calling "->croak", then this 775 If an error condition has been set by calling "->croak", then this
642 function will call "croak". 776 function will call "croak".
643 777
644 In list context, all parameters passed to "send" will be returned, 778 In list context, all parameters passed to "send" will be returned,
645 in scalar context only the first one will be returned. 779 in scalar context only the first one will be returned.
646 780
781 Note that doing a blocking wait in a callback is not supported by
782 any event loop, that is, recursive invocation of a blocking "->recv"
783 is not allowed, and the "recv" call will "croak" if such a condition
784 is detected. This condition can be slightly loosened by using
785 Coro::AnyEvent, which allows you to do a blocking "->recv" from any
786 thread that doesn't run the event loop itself.
787
647 Not all event models support a blocking wait - some die in that case 788 Not all event models support a blocking wait - some die in that case
648 (programs might want to do that to stay interactive), so *if you are 789 (programs might want to do that to stay interactive), so *if you are
649 using this from a module, never require a blocking wait*, but let 790 using this from a module, never require a blocking wait*. Instead,
650 the caller decide whether the call will block or not (for example, 791 let the caller decide whether the call will block or not (for
651 by coupling condition variables with some kind of request results 792 example, by coupling condition variables with some kind of request
652 and supporting callbacks so the caller knows that getting the result 793 results and supporting callbacks so the caller knows that getting
653 will not block, while still supporting blocking waits if the caller 794 the result will not block, while still supporting blocking waits if
654 so desires). 795 the caller so desires).
655 796
656 Another reason *never* to "->recv" in a module is that you cannot
657 sensibly have two "->recv"'s in parallel, as that would require
658 multiple interpreters or coroutines/threads, none of which
659 "AnyEvent" can supply.
660
661 The Coro module, however, *can* and *does* supply coroutines and, in
662 fact, Coro::AnyEvent replaces AnyEvent's condvars by coroutine-safe
663 versions and also integrates coroutines into AnyEvent, making
664 blocking "->recv" calls perfectly safe as long as they are done from
665 another coroutine (one that doesn't run the event loop).
666
667 You can ensure that "-recv" never blocks by setting a callback and 797 You can ensure that "->recv" never blocks by setting a callback and
668 only calling "->recv" from within that callback (or at a later 798 only calling "->recv" from within that callback (or at a later
669 time). This will work even when the event loop does not support 799 time). This will work even when the event loop does not support
670 blocking waits otherwise. 800 blocking waits otherwise.
671 801
672 $bool = $cv->ready 802 $bool = $cv->ready
677 This is a mutator function that returns the callback set and 807 This is a mutator function that returns the callback set and
678 optionally replaces it before doing so. 808 optionally replaces it before doing so.
679 809
680 The callback will be called when the condition becomes "true", i.e. 810 The callback will be called when the condition becomes "true", i.e.
681 when "send" or "croak" are called, with the only argument being the 811 when "send" or "croak" are called, with the only argument being the
682 condition variable itself. Calling "recv" inside the callback or at 812 condition variable itself. If the condition is already true, the
813 callback is called immediately when it is set. Calling "recv" inside
683 any later time is guaranteed not to block. 814 the callback or at any later time is guaranteed not to block.
815
816SUPPORTED EVENT LOOPS/BACKENDS
817 The available backend classes are (every class has its own manpage):
818
819 Backends that are autoprobed when no other event loop can be found.
820 EV is the preferred backend when no other event loop seems to be in
821 use. If EV is not installed, then AnyEvent will fall back to its own
822 pure-perl implementation, which is available everywhere as it comes
823 with AnyEvent itself.
824
825 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
826 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
827
828 Backends that are transparently being picked up when they are used.
829 These will be used if they are already loaded when the first watcher
830 is created, in which case it is assumed that the application is
831 using them. This means that AnyEvent will automatically pick the
832 right backend when the main program loads an event module before
833 anything starts to create watchers. Nothing special needs to be done
834 by the main program.
835
836 AnyEvent::Impl::Event based on Event, very stable, few glitches.
837 AnyEvent::Impl::Glib based on Glib, slow but very stable.
838 AnyEvent::Impl::Tk based on Tk, very broken.
839 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
840 AnyEvent::Impl::POE based on POE, very slow, some limitations.
841 AnyEvent::Impl::Irssi used when running within irssi.
842 AnyEvent::Impl::IOAsync based on IO::Async.
843 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
844 AnyEvent::Impl::FLTK2 based on FLTK (fltk 2 binding).
845
846 Backends with special needs.
847 Qt requires the Qt::Application to be instantiated first, but will
848 otherwise be picked up automatically. As long as the main program
849 instantiates the application before any AnyEvent watchers are
850 created, everything should just work.
851
852 AnyEvent::Impl::Qt based on Qt.
853
854 Event loops that are indirectly supported via other backends.
855 Some event loops can be supported via other modules:
856
857 There is no direct support for WxWidgets (Wx) or Prima.
858
859 WxWidgets has no support for watching file handles. However, you can
860 use WxWidgets through the POE adaptor, as POE has a Wx backend that
861 simply polls 20 times per second, which was considered to be too
862 horrible to even consider for AnyEvent.
863
864 Prima is not supported as nobody seems to be using it, but it has a
865 POE backend, so it can be supported through POE.
866
867 AnyEvent knows about both Prima and Wx, however, and will try to
868 load POE when detecting them, in the hope that POE will pick them
869 up, in which case everything will be automatic.
684 870
685GLOBAL VARIABLES AND FUNCTIONS 871GLOBAL VARIABLES AND FUNCTIONS
872 These are not normally required to use AnyEvent, but can be useful to
873 write AnyEvent extension modules.
874
686 $AnyEvent::MODEL 875 $AnyEvent::MODEL
687 Contains "undef" until the first watcher is being created. Then it 876 Contains "undef" until the first watcher is being created, before
877 the backend has been autodetected.
878
688 contains the event model that is being used, which is the name of 879 Afterwards it contains the event model that is being used, which is
689 the Perl class implementing the model. This class is usually one of 880 the name of the Perl class implementing the model. This class is
690 the "AnyEvent::Impl:xxx" modules, but can be any other class in the 881 usually one of the "AnyEvent::Impl::xxx" modules, but can be any
691 case AnyEvent has been extended at runtime (e.g. in *rxvt-unicode*). 882 other class in the case AnyEvent has been extended at runtime (e.g.
692 883 in *rxvt-unicode* it will be "urxvt::anyevent").
693 The known classes so far are:
694
695 AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
696 AnyEvent::Impl::Event based on Event, second best choice.
697 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
698 AnyEvent::Impl::Glib based on Glib, third-best choice.
699 AnyEvent::Impl::Tk based on Tk, very bad choice.
700 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
701 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
702 AnyEvent::Impl::POE based on POE, not generic enough for full support.
703
704 # warning, support for IO::Async is only partial, as it is too broken
705 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
706 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
707
708 There is no support for WxWidgets, as WxWidgets has no support for
709 watching file handles. However, you can use WxWidgets through the
710 POE Adaptor, as POE has a Wx backend that simply polls 20 times per
711 second, which was considered to be too horrible to even consider for
712 AnyEvent. Likewise, other POE backends can be used by AnyEvent by
713 using it's adaptor.
714
715 AnyEvent knows about Prima and Wx and will try to use POE when
716 autodetecting them.
717 884
718 AnyEvent::detect 885 AnyEvent::detect
719 Returns $AnyEvent::MODEL, forcing autodetection of the event model 886 Returns $AnyEvent::MODEL, forcing autodetection of the event model
720 if necessary. You should only call this function right before you 887 if necessary. You should only call this function right before you
721 would have created an AnyEvent watcher anyway, that is, as late as 888 would have created an AnyEvent watcher anyway, that is, as late as
722 possible at runtime. 889 possible at runtime, and not e.g. during initialisation of your
890 module.
891
892 The effect of calling this function is as if a watcher had been
893 created (specifically, actions that happen "when the first watcher
894 is created" happen when calling detetc as well).
895
896 If you need to do some initialisation before AnyEvent watchers are
897 created, use "post_detect".
723 898
724 $guard = AnyEvent::post_detect { BLOCK } 899 $guard = AnyEvent::post_detect { BLOCK }
725 Arranges for the code block to be executed as soon as the event 900 Arranges for the code block to be executed as soon as the event
726 model is autodetected (or immediately if this has already happened). 901 model is autodetected (or immediately if that has already happened).
902
903 The block will be executed *after* the actual backend has been
904 detected ($AnyEvent::MODEL is set), but *before* any watchers have
905 been created, so it is possible to e.g. patch @AnyEvent::ISA or do
906 other initialisations - see the sources of AnyEvent::Strict or
907 AnyEvent::AIO to see how this is used.
908
909 The most common usage is to create some global watchers, without
910 forcing event module detection too early, for example, AnyEvent::AIO
911 creates and installs the global IO::AIO watcher in a "post_detect"
912 block to avoid autodetecting the event module at load time.
727 913
728 If called in scalar or list context, then it creates and returns an 914 If called in scalar or list context, then it creates and returns an
729 object that automatically removes the callback again when it is 915 object that automatically removes the callback again when it is
916 destroyed (or "undef" when the hook was immediately executed). See
730 destroyed. See Coro::BDB for a case where this is useful. 917 AnyEvent::AIO for a case where this is useful.
918
919 Example: Create a watcher for the IO::AIO module and store it in
920 $WATCHER, but do so only do so after the event loop is initialised.
921
922 our WATCHER;
923
924 my $guard = AnyEvent::post_detect {
925 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
926 };
927
928 # the ||= is important in case post_detect immediately runs the block,
929 # as to not clobber the newly-created watcher. assigning both watcher and
930 # post_detect guard to the same variable has the advantage of users being
931 # able to just C<undef $WATCHER> if the watcher causes them grief.
932
933 $WATCHER ||= $guard;
731 934
732 @AnyEvent::post_detect 935 @AnyEvent::post_detect
733 If there are any code references in this array (you can "push" to it 936 If there are any code references in this array (you can "push" to it
734 before or after loading AnyEvent), then they will called directly 937 before or after loading AnyEvent), then they will be called directly
735 after the event loop has been chosen. 938 after the event loop has been chosen.
736 939
737 You should check $AnyEvent::MODEL before adding to this array, 940 You should check $AnyEvent::MODEL before adding to this array,
738 though: if it contains a true value then the event loop has already 941 though: if it is defined then the event loop has already been
739 been detected, and the array will be ignored. 942 detected, and the array will be ignored.
740 943
741 Best use "AnyEvent::post_detect { BLOCK }" instead. 944 Best use "AnyEvent::post_detect { BLOCK }" when your application
945 allows it, as it takes care of these details.
946
947 This variable is mainly useful for modules that can do something
948 useful when AnyEvent is used and thus want to know when it is
949 initialised, but do not need to even load it by default. This array
950 provides the means to hook into AnyEvent passively, without loading
951 it.
952
953 Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
954 together, you could put this into Coro (this is the actual code used
955 by Coro to accomplish this):
956
957 if (defined $AnyEvent::MODEL) {
958 # AnyEvent already initialised, so load Coro::AnyEvent
959 require Coro::AnyEvent;
960 } else {
961 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
962 # as soon as it is
963 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
964 }
965
966 AnyEvent::postpone { BLOCK }
967 Arranges for the block to be executed as soon as possible, but not
968 before the call itself returns. In practise, the block will be
969 executed just before the event loop polls for new events, or shortly
970 afterwards.
971
972 This function never returns anything (to make the "return postpone {
973 ... }" idiom more useful.
974
975 To understand the usefulness of this function, consider a function
976 that asynchronously does something for you and returns some
977 transaction object or guard to let you cancel the operation. For
978 example, "AnyEvent::Socket::tcp_connect":
979
980 # start a conenction attempt unless one is active
981 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
982 delete $self->{connect_guard};
983 ...
984 };
985
986 Imagine that this function could instantly call the callback, for
987 example, because it detects an obvious error such as a negative port
988 number. Invoking the callback before the function returns causes
989 problems however: the callback will be called and will try to delete
990 the guard object. But since the function hasn't returned yet, there
991 is nothing to delete. When the function eventually returns it will
992 assign the guard object to "$self->{connect_guard}", where it will
993 likely never be deleted, so the program thinks it is still trying to
994 connect.
995
996 This is where "AnyEvent::postpone" should be used. Instead of
997 calling the callback directly on error:
998
999 $cb->(undef), return # signal error to callback, BAD!
1000 if $some_error_condition;
1001
1002 It should use "postpone":
1003
1004 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1005 if $some_error_condition;
1006
1007 AnyEvent::log $level, $msg[, @args]
1008 Log the given $msg at the given $level.
1009
1010 If AnyEvent::Log is not loaded then this function makes a simple
1011 test to see whether the message will be logged. If the test succeeds
1012 it will load AnyEvent::Log and call "AnyEvent::Log::log" -
1013 consequently, look at the AnyEvent::Log documentation for details.
1014
1015 If the test fails it will simply return.
1016
1017 If you want to sprinkle loads of logging calls around your code,
1018 consider creating a logger callback with the "AnyEvent::Log::logger"
1019 function, which can reduce typing, codesize and can reduce the
1020 logging overhead enourmously.
742 1021
743WHAT TO DO IN A MODULE 1022WHAT TO DO IN A MODULE
744 As a module author, you should "use AnyEvent" and call AnyEvent methods 1023 As a module author, you should "use AnyEvent" and call AnyEvent methods
745 freely, but you should not load a specific event module or rely on it. 1024 freely, but you should not load a specific event module or rely on it.
746 1025
754 stall the whole program, and the whole point of using events is to stay 1033 stall the whole program, and the whole point of using events is to stay
755 interactive. 1034 interactive.
756 1035
757 It is fine, however, to call "->recv" when the user of your module 1036 It is fine, however, to call "->recv" when the user of your module
758 requests it (i.e. if you create a http request object ad have a method 1037 requests it (i.e. if you create a http request object ad have a method
759 called "results" that returns the results, it should call "->recv" 1038 called "results" that returns the results, it may call "->recv" freely,
760 freely, as the user of your module knows what she is doing. always). 1039 as the user of your module knows what she is doing. Always).
761 1040
762WHAT TO DO IN THE MAIN PROGRAM 1041WHAT TO DO IN THE MAIN PROGRAM
763 There will always be a single main program - the only place that should 1042 There will always be a single main program - the only place that should
764 dictate which event model to use. 1043 dictate which event model to use.
765 1044
766 If it doesn't care, it can just "use AnyEvent" and use it itself, or not 1045 If the program is not event-based, it need not do anything special, even
767 do anything special (it does not need to be event-based) and let 1046 when it depends on a module that uses an AnyEvent. If the program itself
768 AnyEvent decide which implementation to chose if some module relies on 1047 uses AnyEvent, but does not care which event loop is used, all it needs
769 it. 1048 to do is "use AnyEvent". In either case, AnyEvent will choose the best
1049 available loop implementation.
770 1050
771 If the main program relies on a specific event model - for example, in 1051 If the main program relies on a specific event model - for example, in
772 Gtk2 programs you have to rely on the Glib module - you should load the 1052 Gtk2 programs you have to rely on the Glib module - you should load the
773 event module before loading AnyEvent or any module that uses it: 1053 event module before loading AnyEvent or any module that uses it:
774 generally speaking, you should load it as early as possible. The reason 1054 generally speaking, you should load it as early as possible. The reason
775 is that modules might create watchers when they are loaded, and AnyEvent 1055 is that modules might create watchers when they are loaded, and AnyEvent
776 will decide on the event model to use as soon as it creates watchers, 1056 will decide on the event model to use as soon as it creates watchers,
777 and it might chose the wrong one unless you load the correct one 1057 and it might choose the wrong one unless you load the correct one
778 yourself. 1058 yourself.
779 1059
780 You can chose to use a pure-perl implementation by loading the 1060 You can chose to use a pure-perl implementation by loading the
781 "AnyEvent::Impl::Perl" module, which gives you similar behaviour 1061 "AnyEvent::Loop" module, which gives you similar behaviour everywhere,
782 everywhere, but letting AnyEvent chose the model is generally better. 1062 but letting AnyEvent chose the model is generally better.
783 1063
784 MAINLOOP EMULATION 1064 MAINLOOP EMULATION
785 Sometimes (often for short test scripts, or even standalone programs who 1065 Sometimes (often for short test scripts, or even standalone programs who
786 only want to use AnyEvent), you do not want to run a specific event 1066 only want to use AnyEvent), you do not want to run a specific event
787 loop. 1067 loop.
797 variable somewhere, waiting for it, and sending it when the program 1077 variable somewhere, waiting for it, and sending it when the program
798 should exit cleanly. 1078 should exit cleanly.
799 1079
800OTHER MODULES 1080OTHER MODULES
801 The following is a non-exhaustive list of additional modules that use 1081 The following is a non-exhaustive list of additional modules that use
802 AnyEvent and can therefore be mixed easily with other AnyEvent modules 1082 AnyEvent as a client and can therefore be mixed easily with other
803 in the same program. Some of the modules come with AnyEvent, some are 1083 AnyEvent modules and other event loops in the same program. Some of the
804 available via CPAN. 1084 modules come as part of AnyEvent, the others are available via CPAN (see
1085 <http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for a longer
1086 non-exhaustive list), and the list is heavily biased towards modules of
1087 the AnyEvent author himself :)
805 1088
806 AnyEvent::Util 1089 AnyEvent::Util
807 Contains various utility functions that replace often-used but 1090 Contains various utility functions that replace often-used blocking
808 blocking functions such as "inet_aton" by event-/callback-based 1091 functions such as "inet_aton" with event/callback-based versions.
809 versions.
810 1092
811 AnyEvent::Socket 1093 AnyEvent::Socket
812 Provides various utility functions for (internet protocol) sockets, 1094 Provides various utility functions for (internet protocol) sockets,
813 addresses and name resolution. Also functions to create non-blocking 1095 addresses and name resolution. Also functions to create non-blocking
814 tcp connections or tcp servers, with IPv6 and SRV record support and 1096 tcp connections or tcp servers, with IPv6 and SRV record support and
815 more. 1097 more.
816 1098
817 AnyEvent::Handle 1099 AnyEvent::Handle
818 Provide read and write buffers, manages watchers for reads and 1100 Provide read and write buffers, manages watchers for reads and
819 writes, supports raw and formatted I/O, I/O queued and fully 1101 writes, supports raw and formatted I/O, I/O queued and fully
820 transparent and non-blocking SSL/TLS. 1102 transparent and non-blocking SSL/TLS (via AnyEvent::TLS).
821 1103
822 AnyEvent::DNS 1104 AnyEvent::DNS
823 Provides rich asynchronous DNS resolver capabilities. 1105 Provides rich asynchronous DNS resolver capabilities.
824 1106
1107 AnyEvent::HTTP, AnyEvent::IRC, AnyEvent::XMPP, AnyEvent::GPSD,
1108 AnyEvent::IGS, AnyEvent::FCP
1109 Implement event-based interfaces to the protocols of the same name
1110 (for the curious, IGS is the International Go Server and FCP is the
1111 Freenet Client Protocol).
1112
825 AnyEvent::HTTP 1113 AnyEvent::AIO
826 A simple-to-use HTTP library that is capable of making a lot of 1114 Truly asynchronous (as opposed to non-blocking) I/O, should be in
827 concurrent HTTP requests. 1115 the toolbox of every event programmer. AnyEvent::AIO transparently
1116 fuses IO::AIO and AnyEvent together, giving AnyEvent access to
1117 event-based file I/O, and much more.
1118
1119 AnyEvent::Filesys::Notify
1120 AnyEvent is good for non-blocking stuff, but it can't detect file or
1121 path changes (e.g. "watch this directory for new files", "watch this
1122 file for changes"). The AnyEvent::Filesys::Notify module promises to
1123 do just that in a portbale fashion, supporting inotify on GNU/Linux
1124 and some weird, without doubt broken, stuff on OS X to monitor
1125 files. It can fall back to blocking scans at regular intervals
1126 transparently on other platforms, so it's about as portable as it
1127 gets.
1128
1129 (I haven't used it myself, but I haven't heard anybody complaining
1130 about it yet).
1131
1132 AnyEvent::DBI
1133 Executes DBI requests asynchronously in a proxy process for you,
1134 notifying you in an event-based way when the operation is finished.
828 1135
829 AnyEvent::HTTPD 1136 AnyEvent::HTTPD
830 Provides a simple web application server framework. 1137 A simple embedded webserver.
831 1138
832 AnyEvent::FastPing 1139 AnyEvent::FastPing
833 The fastest ping in the west. 1140 The fastest ping in the west.
834 1141
835 AnyEvent::DBI
836 Executes DBI requests asynchronously in a proxy process.
837
838 AnyEvent::AIO
839 Truly asynchronous I/O, should be in the toolbox of every event
840 programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
841 together.
842
843 AnyEvent::BDB
844 Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently
845 fuses BDB and AnyEvent together.
846
847 AnyEvent::GPSD
848 A non-blocking interface to gpsd, a daemon delivering GPS
849 information.
850
851 AnyEvent::IGS
852 A non-blocking interface to the Internet Go Server protocol (used by
853 App::IGS).
854
855 AnyEvent::IRC
856 AnyEvent based IRC client module family (replacing the older
857 Net::IRC3).
858
859 Net::XMPP2
860 AnyEvent based XMPP (Jabber protocol) module family.
861
862 Net::FCP
863 AnyEvent-based implementation of the Freenet Client Protocol,
864 birthplace of AnyEvent.
865
866 Event::ExecFlow
867 High level API for event-based execution flow control.
868
869 Coro 1142 Coro
870 Has special support for AnyEvent via Coro::AnyEvent. 1143 Has special support for AnyEvent via Coro::AnyEvent, which allows
1144 you to simply invert the flow control - don't call us, we will call
1145 you:
871 1146
872 IO::Lambda 1147 async {
873 The lambda approach to I/O - don't ask, look there. Can use 1148 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
874 AnyEvent. 1149 print "5 seconds later!\n";
1150
1151 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1152 my $line = <STDIN>; # works for ttys
1153
1154 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1155 my ($body, $hdr) = Coro::rouse_wait;
1156 };
1157
1158SIMPLIFIED AE API
1159 Starting with version 5.0, AnyEvent officially supports a second, much
1160 simpler, API that is designed to reduce the calling, typing and memory
1161 overhead by using function call syntax and a fixed number of parameters.
1162
1163 See the AE manpage for details.
875 1164
876ERROR AND EXCEPTION HANDLING 1165ERROR AND EXCEPTION HANDLING
877 In general, AnyEvent does not do any error handling - it relies on the 1166 In general, AnyEvent does not do any error handling - it relies on the
878 caller to do that if required. The AnyEvent::Strict module (see also the 1167 caller to do that if required. The AnyEvent::Strict module (see also the
879 "PERL_ANYEVENT_STRICT" environment variable, below) provides strict 1168 "PERL_ANYEVENT_STRICT" environment variable, below) provides strict
888 The pure perl event loop simply re-throws the exception (usually within 1177 The pure perl event loop simply re-throws the exception (usually within
889 "condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()", 1178 "condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()",
890 Glib uses "install_exception_handler" and so on. 1179 Glib uses "install_exception_handler" and so on.
891 1180
892ENVIRONMENT VARIABLES 1181ENVIRONMENT VARIABLES
893 The following environment variables are used by this module or its 1182 AnyEvent supports a number of environment variables that tune the
894 submodules. 1183 runtime behaviour. They are usually evaluated when AnyEvent is loaded,
1184 initialised, or a submodule that uses them is loaded. Many of them also
1185 cause AnyEvent to load additional modules - for example,
1186 "PERL_ANYEVENT_DEBUG_WRAP" causes the AnyEvent::Debug module to be
1187 loaded.
895 1188
896 Note that AnyEvent will remove *all* environment variables starting with 1189 All the environment variables documented here start with
897 "PERL_ANYEVENT_" from %ENV when it is loaded while taint mode is 1190 "PERL_ANYEVENT_", which is what AnyEvent considers its own namespace.
898 enabled. 1191 Other modules are encouraged (but by no means required) to use
1192 "PERL_ANYEVENT_SUBMODULE" if they have registered the
1193 AnyEvent::Submodule namespace on CPAN, for any submodule. For example,
1194 AnyEvent::HTTP could be expected to use "PERL_ANYEVENT_HTTP_PROXY" (it
1195 should not access env variables starting with "AE_", see below).
1196
1197 All variables can also be set via the "AE_" prefix, that is, instead of
1198 setting "PERL_ANYEVENT_VERBOSE" you can also set "AE_VERBOSE". In case
1199 there is a clash btween anyevent and another program that uses
1200 "AE_something" you can set the corresponding "PERL_ANYEVENT_something"
1201 variable to the empty string, as those variables take precedence.
1202
1203 When AnyEvent is first loaded, it copies all "AE_xxx" env variables to
1204 their "PERL_ANYEVENT_xxx" counterpart unless that variable already
1205 exists. If taint mode is on, then AnyEvent will remove *all* environment
1206 variables starting with "PERL_ANYEVENT_" from %ENV (or replace them with
1207 "undef" or the empty string, if the corresaponding "AE_" variable is
1208 set).
1209
1210 The exact algorithm is currently:
1211
1212 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
1213 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
1214 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
1215
1216 This ensures that child processes will not see the "AE_" variables.
1217
1218 The following environment variables are currently known to AnyEvent:
899 1219
900 "PERL_ANYEVENT_VERBOSE" 1220 "PERL_ANYEVENT_VERBOSE"
901 By default, AnyEvent will be completely silent except in fatal 1221 By default, AnyEvent will be completely silent except in fatal
902 conditions. You can set this environment variable to make AnyEvent 1222 conditions. You can set this environment variable to make AnyEvent
903 more talkative. 1223 more talkative. If you want to do more than just set the global
1224 logging level you should have a look at "PERL_ANYEVENT_LOG", which
1225 allows much more complex specifications.
904 1226
905 When set to 1 or higher, causes AnyEvent to warn about unexpected 1227 When set to 5 or higher (warn), causes AnyEvent to warn about
906 conditions, such as not being able to load the event model specified 1228 unexpected conditions, such as not being able to load the event
907 by "PERL_ANYEVENT_MODEL". 1229 model specified by "PERL_ANYEVENT_MODEL", or a guard callback
1230 throwing an exception - this is the minimum recommended level.
908 1231
909 When set to 2 or higher, cause AnyEvent to report to STDERR which 1232 When set to 7 or higher (info), cause AnyEvent to report which event
910 event model it chooses. 1233 model it chooses.
1234
1235 When set to 8 or higher (debug), then AnyEvent will report extra
1236 information on which optional modules it loads and how it implements
1237 certain features.
1238
1239 "PERL_ANYEVENT_LOG"
1240 Accepts rather complex logging specifications. For example, you
1241 could log all "debug" messages of some module to stderr, warnings
1242 and above to stderr, and errors and above to syslog, with:
1243
1244 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
1245
1246 For the rather extensive details, see AnyEvent::Log.
1247
1248 This variable is evaluated when AnyEvent (or AnyEvent::Log) is
1249 loaded, so will take effect even before AnyEvent has initialised
1250 itself.
1251
1252 Note that specifying this environment variable causes the
1253 AnyEvent::Log module to be loaded, while "PERL_ANYEVENT_VERBOSE"
1254 does not, so only using the latter saves a few hundred kB of memory
1255 until the first message is being logged.
911 1256
912 "PERL_ANYEVENT_STRICT" 1257 "PERL_ANYEVENT_STRICT"
913 AnyEvent does not do much argument checking by default, as thorough 1258 AnyEvent does not do much argument checking by default, as thorough
914 argument checking is very costly. Setting this variable to a true 1259 argument checking is very costly. Setting this variable to a true
915 value will cause AnyEvent to load "AnyEvent::Strict" and then to 1260 value will cause AnyEvent to load "AnyEvent::Strict" and then to
916 thoroughly check the arguments passed to most method calls. If it 1261 thoroughly check the arguments passed to most method calls. If it
917 finds any problems, it will croak. 1262 finds any problems, it will croak.
918 1263
919 In other words, enables "strict" mode. 1264 In other words, enables "strict" mode.
920 1265
921 Unlike "use strict", it is definitely recommended to keep it off in 1266 Unlike "use strict" (or its modern cousin, "use common::sense", it
922 production. Keeping "PERL_ANYEVENT_STRICT=1" in your environment 1267 is definitely recommended to keep it off in production. Keeping
1268 "PERL_ANYEVENT_STRICT=1" in your environment while developing
923 while developing programs can be very useful, however. 1269 programs can be very useful, however.
1270
1271 "PERL_ANYEVENT_DEBUG_SHELL"
1272 If this env variable is set, then its contents will be interpreted
1273 by "AnyEvent::Socket::parse_hostport" (after replacing every
1274 occurance of $$ by the process pid) and an "AnyEvent::Debug::shell"
1275 is bound on that port. The shell object is saved in
1276 $AnyEvent::Debug::SHELL.
1277
1278 This happens when the first watcher is created.
1279
1280 For example, to bind a debug shell on a unix domain socket in
1281 /tmp/debug<pid>.sock, you could use this:
1282
1283 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
1284
1285 Note that creating sockets in /tmp is very unsafe on multiuser
1286 systems.
1287
1288 "PERL_ANYEVENT_DEBUG_WRAP"
1289 Can be set to 0, 1 or 2 and enables wrapping of all watchers for
1290 debugging purposes. See "AnyEvent::Debug::wrap" for details.
924 1291
925 "PERL_ANYEVENT_MODEL" 1292 "PERL_ANYEVENT_MODEL"
926 This can be used to specify the event model to be used by AnyEvent, 1293 This can be used to specify the event model to be used by AnyEvent,
927 before auto detection and -probing kicks in. It must be a string 1294 before auto detection and -probing kicks in.
928 consisting entirely of ASCII letters. The string "AnyEvent::Impl::" 1295
929 gets prepended and the resulting module name is loaded and if the 1296 It normally is a string consisting entirely of ASCII letters (e.g.
930 load was successful, used as event model. If it fails to load 1297 "EV" or "IOAsync"). The string "AnyEvent::Impl::" gets prepended and
1298 the resulting module name is loaded and - if the load was successful
1299 - used as event model backend. If it fails to load then AnyEvent
931 AnyEvent will proceed with auto detection and -probing. 1300 will proceed with auto detection and -probing.
932 1301
933 This functionality might change in future versions. 1302 If the string ends with "::" instead (e.g. "AnyEvent::Impl::EV::")
1303 then nothing gets prepended and the module name is used as-is (hint:
1304 "::" at the end of a string designates a module name and quotes it
1305 appropriately).
934 1306
935 For example, to force the pure perl model (AnyEvent::Impl::Perl) you 1307 For example, to force the pure perl model (AnyEvent::Loop::Perl) you
936 could start your program like this: 1308 could start your program like this:
937 1309
938 PERL_ANYEVENT_MODEL=Perl perl ... 1310 PERL_ANYEVENT_MODEL=Perl perl ...
939 1311
940 "PERL_ANYEVENT_PROTOCOLS" 1312 "PERL_ANYEVENT_PROTOCOLS"
957 "PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to 1329 "PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to
958 resolve or contact IPv6 addresses. 1330 resolve or contact IPv6 addresses.
959 "PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but 1331 "PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but
960 prefer IPv6 over IPv4. 1332 prefer IPv6 over IPv4.
961 1333
1334 "PERL_ANYEVENT_HOSTS"
1335 This variable, if specified, overrides the /etc/hosts file used by
1336 AnyEvent::Socket"::resolve_sockaddr", i.e. hosts aliases will be
1337 read from that file instead.
1338
962 "PERL_ANYEVENT_EDNS0" 1339 "PERL_ANYEVENT_EDNS0"
963 Used by AnyEvent::DNS to decide whether to use the EDNS0 extension 1340 Used by AnyEvent::DNS to decide whether to use the EDNS0 extension
964 for DNS. This extension is generally useful to reduce DNS traffic, 1341 for DNS. This extension is generally useful to reduce DNS traffic,
965 but some (broken) firewalls drop such DNS packets, which is why it 1342 especially when DNSSEC is involved, but some (broken) firewalls drop
966 is off by default. 1343 such DNS packets, which is why it is off by default.
967 1344
968 Setting this variable to 1 will cause AnyEvent::DNS to announce 1345 Setting this variable to 1 will cause AnyEvent::DNS to announce
969 EDNS0 in its DNS requests. 1346 EDNS0 in its DNS requests.
970 1347
971 "PERL_ANYEVENT_MAX_FORKS" 1348 "PERL_ANYEVENT_MAX_FORKS"
972 The maximum number of child processes that 1349 The maximum number of child processes that
973 "AnyEvent::Util::fork_call" will create in parallel. 1350 "AnyEvent::Util::fork_call" will create in parallel.
1351
1352 "PERL_ANYEVENT_MAX_OUTSTANDING_DNS"
1353 The default value for the "max_outstanding" parameter for the
1354 default DNS resolver - this is the maximum number of parallel DNS
1355 requests that are sent to the DNS server.
1356
1357 "PERL_ANYEVENT_RESOLV_CONF"
1358 The absolute path to a resolv.conf-style file to use instead of
1359 /etc/resolv.conf (or the OS-specific configuration) in the default
1360 resolver, or the empty string to select the default configuration.
1361
1362 "PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH".
1363 When neither "ca_file" nor "ca_path" was specified during
1364 AnyEvent::TLS context creation, and either of these environment
1365 variables are nonempty, they will be used to specify CA certificate
1366 locations instead of a system-dependent default.
1367
1368 "PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT"
1369 When these are set to 1, then the respective modules are not loaded.
1370 Mostly good for testing AnyEvent itself.
974 1371
975SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1372SUPPLYING YOUR OWN EVENT MODEL INTERFACE
976 This is an advanced topic that you do not normally need to use AnyEvent 1373 This is an advanced topic that you do not normally need to use AnyEvent
977 in a module. This section is only of use to event loop authors who want 1374 in a module. This section is only of use to event loop authors who want
978 to provide AnyEvent compatibility. 1375 to provide AnyEvent compatibility.
1033 warn "read: $input\n"; # output what has been read 1430 warn "read: $input\n"; # output what has been read
1034 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1431 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1035 }, 1432 },
1036 ); 1433 );
1037 1434
1038 my $time_watcher; # can only be used once
1039
1040 sub new_timer {
1041 $timer = AnyEvent->timer (after => 1, cb => sub { 1435 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1042 warn "timeout\n"; # print 'timeout' about every second 1436 warn "timeout\n"; # print 'timeout' at most every second
1043 &new_timer; # and restart the time
1044 });
1045 } 1437 });
1046
1047 new_timer; # create first timer
1048 1438
1049 $cv->recv; # wait until user enters /^q/i 1439 $cv->recv; # wait until user enters /^q/i
1050 1440
1051REAL-WORLD EXAMPLE 1441REAL-WORLD EXAMPLE
1052 Consider the Net::FCP module. It features (among others) the following 1442 Consider the Net::FCP module. It features (among others) the following
1124 1514
1125 The actual code goes further and collects all errors ("die"s, 1515 The actual code goes further and collects all errors ("die"s,
1126 exceptions) that occurred during request processing. The "result" method 1516 exceptions) that occurred during request processing. The "result" method
1127 detects whether an exception as thrown (it is stored inside the $txn 1517 detects whether an exception as thrown (it is stored inside the $txn
1128 object) and just throws the exception, which means connection errors and 1518 object) and just throws the exception, which means connection errors and
1129 other problems get reported tot he code that tries to use the result, 1519 other problems get reported to the code that tries to use the result,
1130 not in a random callback. 1520 not in a random callback.
1131 1521
1132 All of this enables the following usage styles: 1522 All of this enables the following usage styles:
1133 1523
1134 1. Blocking: 1524 1. Blocking:
1179 through AnyEvent. The benchmark creates a lot of timers (with a zero 1569 through AnyEvent. The benchmark creates a lot of timers (with a zero
1180 timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1570 timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1181 which it is), lets them fire exactly once and destroys them again. 1571 which it is), lets them fire exactly once and destroys them again.
1182 1572
1183 Source code for this benchmark is found as eg/bench in the AnyEvent 1573 Source code for this benchmark is found as eg/bench in the AnyEvent
1184 distribution. 1574 distribution. It uses the AE interface, which makes a real difference
1575 for the EV and Perl backends only.
1185 1576
1186 Explanation of the columns 1577 Explanation of the columns
1187 *watcher* is the number of event watchers created/destroyed. Since 1578 *watcher* is the number of event watchers created/destroyed. Since
1188 different event models feature vastly different performances, each event 1579 different event models feature vastly different performances, each event
1189 loop was given a number of watchers so that overall runtime is 1580 loop was given a number of watchers so that overall runtime is
1208 *destroy* is the time, in microseconds, that it takes to destroy a 1599 *destroy* is the time, in microseconds, that it takes to destroy a
1209 single watcher. 1600 single watcher.
1210 1601
1211 Results 1602 Results
1212 name watchers bytes create invoke destroy comment 1603 name watchers bytes create invoke destroy comment
1213 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 1604 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
1214 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 1605 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
1215 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 1606 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
1216 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 1607 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
1217 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 1608 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
1218 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 1609 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
1219 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 1610 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
1220 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 1611 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
1221 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 1612 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
1222 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 1613 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
1223 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 1614 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
1224 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 1615 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
1225 1616
1226 Discussion 1617 Discussion
1227 The benchmark does *not* measure scalability of the event loop very 1618 The benchmark does *not* measure scalability of the event loop very
1228 well. For example, a select-based event loop (such as the pure perl one) 1619 well. For example, a select-based event loop (such as the pure perl one)
1229 can never compete with an event loop that uses epoll when the number of 1620 can never compete with an event loop that uses epoll when the number of
1240 benchmark machine, handling an event takes roughly 1600 CPU cycles with 1631 benchmark machine, handling an event takes roughly 1600 CPU cycles with
1241 EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 1632 EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000
1242 CPU cycles with POE. 1633 CPU cycles with POE.
1243 1634
1244 "EV" is the sole leader regarding speed and memory use, which are both 1635 "EV" is the sole leader regarding speed and memory use, which are both
1245 maximal/minimal, respectively. Even when going through AnyEvent, it uses 1636 maximal/minimal, respectively. When using the AE API there is zero
1637 overhead (when going through the AnyEvent API create is about 5-6 times
1638 slower, with other times being equal, so still uses far less memory than
1246 far less memory than any other event loop and is still faster than Event 1639 any other event loop and is still faster than Event natively).
1247 natively.
1248 1640
1249 The pure perl implementation is hit in a few sweet spots (both the 1641 The pure perl implementation is hit in a few sweet spots (both the
1250 constant timeout and the use of a single fd hit optimisations in the 1642 constant timeout and the use of a single fd hit optimisations in the
1251 perl interpreter and the backend itself). Nevertheless this shows that 1643 perl interpreter and the backend itself). Nevertheless this shows that
1252 it adds very little overhead in itself. Like any select-based backend 1644 it adds very little overhead in itself. Like any select-based backend
1298 when used without AnyEvent), but most event loops have acceptable 1690 when used without AnyEvent), but most event loops have acceptable
1299 performance with or without AnyEvent. 1691 performance with or without AnyEvent.
1300 1692
1301 * The overhead AnyEvent adds is usually much smaller than the overhead 1693 * The overhead AnyEvent adds is usually much smaller than the overhead
1302 of the actual event loop, only with extremely fast event loops such 1694 of the actual event loop, only with extremely fast event loops such
1303 as EV adds AnyEvent significant overhead. 1695 as EV does AnyEvent add significant overhead.
1304 1696
1305 * You should avoid POE like the plague if you want performance or 1697 * You should avoid POE like the plague if you want performance or
1306 reasonable memory usage. 1698 reasonable memory usage.
1307 1699
1308 BENCHMARKING THE LARGE SERVER CASE 1700 BENCHMARKING THE LARGE SERVER CASE
1322 In this benchmark, we use 10000 socket pairs (20000 sockets), of which 1714 In this benchmark, we use 10000 socket pairs (20000 sockets), of which
1323 100 (1%) are active. This mirrors the activity of large servers with 1715 100 (1%) are active. This mirrors the activity of large servers with
1324 many connections, most of which are idle at any one point in time. 1716 many connections, most of which are idle at any one point in time.
1325 1717
1326 Source code for this benchmark is found as eg/bench2 in the AnyEvent 1718 Source code for this benchmark is found as eg/bench2 in the AnyEvent
1327 distribution. 1719 distribution. It uses the AE interface, which makes a real difference
1720 for the EV and Perl backends only.
1328 1721
1329 Explanation of the columns 1722 Explanation of the columns
1330 *sockets* is the number of sockets, and twice the number of "servers" 1723 *sockets* is the number of sockets, and twice the number of "servers"
1331 (as each server has a read and write socket end). 1724 (as each server has a read and write socket end).
1332 1725
1338 forwarding it to another server. This includes deleting the old timeout 1731 forwarding it to another server. This includes deleting the old timeout
1339 and creating a new one that moves the timeout into the future. 1732 and creating a new one that moves the timeout into the future.
1340 1733
1341 Results 1734 Results
1342 name sockets create request 1735 name sockets create request
1343 EV 20000 69.01 11.16 1736 EV 20000 62.66 7.99
1344 Perl 20000 73.32 35.87 1737 Perl 20000 68.32 32.64
1345 IOAsync 20000 157.00 98.14 epoll 1738 IOAsync 20000 174.06 101.15 epoll
1346 IOAsync 20000 159.31 616.06 poll 1739 IOAsync 20000 174.67 610.84 poll
1347 Event 20000 212.62 257.32 1740 Event 20000 202.69 242.91
1348 Glib 20000 651.16 1896.30 1741 Glib 20000 557.01 1689.52
1349 POE 20000 349.67 12317.24 uses POE::Loop::Event 1742 POE 20000 341.54 12086.32 uses POE::Loop::Event
1350 1743
1351 Discussion 1744 Discussion
1352 This benchmark *does* measure scalability and overall performance of the 1745 This benchmark *does* measure scalability and overall performance of the
1353 particular event loop. 1746 particular event loop.
1354 1747
1467 As you can see, the AnyEvent + EV combination even beats the 1860 As you can see, the AnyEvent + EV combination even beats the
1468 hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 1861 hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
1469 backend easily beats IO::Lambda and POE. 1862 backend easily beats IO::Lambda and POE.
1470 1863
1471 And even the 100% non-blocking version written using the high-level (and 1864 And even the 100% non-blocking version written using the high-level (and
1472 slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda by a 1865 slow :) AnyEvent::Handle abstraction beats both POE and IO::Lambda
1473 large margin, even though it does all of DNS, tcp-connect and socket I/O 1866 higher level ("unoptimised") abstractions by a large margin, even though
1474 in a non-blocking way. 1867 it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
1475 1868
1476 The two AnyEvent benchmarks programs can be found as eg/ae0.pl and 1869 The two AnyEvent benchmarks programs can be found as eg/ae0.pl and
1477 eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are 1870 eg/ae2.pl in the AnyEvent distribution, the remaining benchmarks are
1478 part of the IO::lambda distribution and were used without any changes. 1871 part of the IO::Lambda distribution and were used without any changes.
1479 1872
1480SIGNALS 1873SIGNALS
1481 AnyEvent currently installs handlers for these signals: 1874 AnyEvent currently installs handlers for these signals:
1482 1875
1483 SIGCHLD 1876 SIGCHLD
1484 A handler for "SIGCHLD" is installed by AnyEvent's child watcher 1877 A handler for "SIGCHLD" is installed by AnyEvent's child watcher
1485 emulation for event loops that do not support them natively. Also, 1878 emulation for event loops that do not support them natively. Also,
1486 some event loops install a similar handler. 1879 some event loops install a similar handler.
1487 1880
1488 If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent 1881 Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE,
1489 will reset it to default, to avoid losing child exit statuses. 1882 then AnyEvent will reset it to default, to avoid losing child exit
1883 statuses.
1490 1884
1491 SIGPIPE 1885 SIGPIPE
1492 A no-op handler is installed for "SIGPIPE" when $SIG{PIPE} is 1886 A no-op handler is installed for "SIGPIPE" when $SIG{PIPE} is
1493 "undef" when AnyEvent gets loaded. 1887 "undef" when AnyEvent gets loaded.
1494 1888
1502 it is that this way, the handler will be restored to defaults on 1896 it is that this way, the handler will be restored to defaults on
1503 exec. 1897 exec.
1504 1898
1505 Feel free to install your own handler, or reset it to defaults. 1899 Feel free to install your own handler, or reset it to defaults.
1506 1900
1901RECOMMENDED/OPTIONAL MODULES
1902 One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and
1903 its built-in modules) are required to use it.
1904
1905 That does not mean that AnyEvent won't take advantage of some additional
1906 modules if they are installed.
1907
1908 This section explains which additional modules will be used, and how
1909 they affect AnyEvent's operation.
1910
1911 Async::Interrupt
1912 This slightly arcane module is used to implement fast signal
1913 handling: To my knowledge, there is no way to do completely
1914 race-free and quick signal handling in pure perl. To ensure that
1915 signals still get delivered, AnyEvent will start an interval timer
1916 to wake up perl (and catch the signals) with some delay (default is
1917 10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY).
1918
1919 If this module is available, then it will be used to implement
1920 signal catching, which means that signals will not be delayed, and
1921 the event loop will not be interrupted regularly, which is more
1922 efficient (and good for battery life on laptops).
1923
1924 This affects not just the pure-perl event loop, but also other event
1925 loops that have no signal handling on their own (e.g. Glib, Tk, Qt).
1926
1927 Some event loops (POE, Event, Event::Lib) offer signal watchers
1928 natively, and either employ their own workarounds (POE) or use
1929 AnyEvent's workaround (using $AnyEvent::MAX_SIGNAL_LATENCY).
1930 Installing Async::Interrupt does nothing for those backends.
1931
1932 EV This module isn't really "optional", as it is simply one of the
1933 backend event loops that AnyEvent can use. However, it is simply the
1934 best event loop available in terms of features, speed and stability:
1935 It supports the AnyEvent API optimally, implements all the watcher
1936 types in XS, does automatic timer adjustments even when no monotonic
1937 clock is available, can take avdantage of advanced kernel interfaces
1938 such as "epoll" and "kqueue", and is the fastest backend *by far*.
1939 You can even embed Glib/Gtk2 in it (or vice versa, see EV::Glib and
1940 Glib::EV).
1941
1942 If you only use backends that rely on another event loop (e.g.
1943 "Tk"), then this module will do nothing for you.
1944
1945 Guard
1946 The guard module, when used, will be used to implement
1947 "AnyEvent::Util::guard". This speeds up guards considerably (and
1948 uses a lot less memory), but otherwise doesn't affect guard
1949 operation much. It is purely used for performance.
1950
1951 JSON and JSON::XS
1952 One of these modules is required when you want to read or write JSON
1953 data via AnyEvent::Handle. JSON is also written in pure-perl, but
1954 can take advantage of the ultra-high-speed JSON::XS module when it
1955 is installed.
1956
1957 Net::SSLeay
1958 Implementing TLS/SSL in Perl is certainly interesting, but not very
1959 worthwhile: If this module is installed, then AnyEvent::Handle (with
1960 the help of AnyEvent::TLS), gains the ability to do TLS/SSL.
1961
1962 Time::HiRes
1963 This module is part of perl since release 5.008. It will be used
1964 when the chosen event library does not come with a timing source of
1965 its own. The pure-perl event loop (AnyEvent::Loop) will additionally
1966 load it to try to use a monotonic clock for timing stability.
1967
1507FORK 1968FORK
1508 Most event libraries are not fork-safe. The ones who are usually are 1969 Most event libraries are not fork-safe. The ones who are usually are
1509 because they rely on inefficient but fork-safe "select" or "poll" calls. 1970 because they rely on inefficient but fork-safe "select" or "poll" calls
1510 Only EV is fully fork-aware. 1971 - higher performance APIs such as BSD's kqueue or the dreaded Linux
1972 epoll are usually badly thought-out hacks that are incompatible with
1973 fork in one way or another. Only EV is fully fork-aware and ensures that
1974 you continue event-processing in both parent and child (or both, if you
1975 know what you are doing).
1976
1977 This means that, in general, you cannot fork and do event processing in
1978 the child if the event library was initialised before the fork (which
1979 usually happens when the first AnyEvent watcher is created, or the
1980 library is loaded).
1511 1981
1512 If you have to fork, you must either do so *before* creating your first 1982 If you have to fork, you must either do so *before* creating your first
1513 watcher OR you must not use AnyEvent at all in the child. 1983 watcher OR you must not use AnyEvent at all in the child OR you must do
1984 something completely out of the scope of AnyEvent.
1985
1986 The problem of doing event processing in the parent *and* the child is
1987 much more complicated: even for backends that *are* fork-aware or
1988 fork-safe, their behaviour is not usually what you want: fork clones all
1989 watchers, that means all timers, I/O watchers etc. are active in both
1990 parent and child, which is almost never what you want. USing "exec" to
1991 start worker children from some kind of manage rprocess is usually
1992 preferred, because it is much easier and cleaner, at the expense of
1993 having to have another binary.
1514 1994
1515SECURITY CONSIDERATIONS 1995SECURITY CONSIDERATIONS
1516 AnyEvent can be forced to load any event model via 1996 AnyEvent can be forced to load any event model via
1517 $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used 1997 $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
1518 to execute arbitrary code or directly gain access, it can easily be used 1998 to execute arbitrary code or directly gain access, it can easily be used
1542 5.10 and check wether the leaks still show up. (Perl 5.10.0 has other 2022 5.10 and check wether the leaks still show up. (Perl 5.10.0 has other
1543 annoying memleaks, such as leaking on "map" and "grep" but it is usually 2023 annoying memleaks, such as leaking on "map" and "grep" but it is usually
1544 not as pronounced). 2024 not as pronounced).
1545 2025
1546SEE ALSO 2026SEE ALSO
1547 Utility functions: AnyEvent::Util. 2027 Tutorial/Introduction: AnyEvent::Intro.
1548 2028
1549 Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk, 2029 FAQ: AnyEvent::FAQ.
1550 Event::Lib, Qt, POE. 2030
2031 Utility functions: AnyEvent::Util (misc. grab-bag), AnyEvent::Log
2032 (simply logging).
2033
2034 Development/Debugging: AnyEvent::Strict (stricter checking),
2035 AnyEvent::Debug (interactive shell, watcher tracing).
2036
2037 Supported event modules: AnyEvent::Loop, EV, EV::Glib, Glib::EV, Event,
2038 Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK.
1551 2039
1552 Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, 2040 Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,
1553 AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, 2041 AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,
1554 AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE. 2042 AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,
2043 AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi, AnyEvent::Impl::FLTK.
1555 2044
1556 Non-blocking file handles, sockets, TCP clients and servers: 2045 Non-blocking handles, pipes, stream sockets, TCP clients and servers:
1557 AnyEvent::Handle, AnyEvent::Socket. 2046 AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.
1558 2047
1559 Asynchronous DNS: AnyEvent::DNS. 2048 Asynchronous DNS: AnyEvent::DNS.
1560 2049
1561 Coroutine support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event, 2050 Thread support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event.
1562 2051
1563 Nontrivial usage examples: Net::FCP, Net::XMPP2, AnyEvent::DNS. 2052 Nontrivial usage examples: AnyEvent::GPSD, AnyEvent::IRC,
2053 AnyEvent::HTTP.
1564 2054
1565AUTHOR 2055AUTHOR
1566 Marc Lehmann <schmorp@schmorp.de> 2056 Marc Lehmann <schmorp@schmorp.de>
1567 http://home.schmorp.de/ 2057 http://home.schmorp.de/
1568 2058

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines