1 | NAME |
1 | NAME |
2 | AnyEvent - provide framework for multiple event loops |
2 | AnyEvent - provide framework for multiple event loops |
3 | |
3 | |
4 | EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - |
4 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
5 | various supported event loops |
5 | event loops. |
6 | |
6 | |
7 | SYNOPSIS |
7 | SYNOPSIS |
8 | use AnyEvent; |
8 | use AnyEvent; |
9 | |
9 | |
|
|
10 | # file descriptor readable |
10 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
|
|
12 | |
|
|
13 | # one-shot or repeating timers |
|
|
14 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
|
|
15 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
|
|
16 | |
|
|
17 | print AnyEvent->now; # prints current event loop time |
|
|
18 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
|
|
19 | |
|
|
20 | # POSIX signal |
|
|
21 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
|
|
22 | |
|
|
23 | # child process exit |
|
|
24 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
|
|
25 | my ($pid, $status) = @_; |
11 | ... |
26 | ... |
12 | }); |
27 | }); |
13 | |
28 | |
14 | my $w = AnyEvent->timer (after => $seconds, cb => sub { |
29 | # called when event loop idle (if applicable) |
15 | ... |
30 | my $w = AnyEvent->idle (cb => sub { ... }); |
16 | }); |
|
|
17 | |
31 | |
18 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
32 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
|
|
33 | $w->send; # wake up current and all future recv's |
19 | $w->wait; # enters "main loop" till $condvar gets ->broadcast |
34 | $w->recv; # enters "main loop" till $condvar gets ->send |
20 | $w->broadcast; # wake up current and all future wait's |
35 | # use a condvar in callback mode: |
|
|
36 | $w->cb (sub { $_[0]->recv }); |
|
|
37 | |
|
|
38 | INTRODUCTION/TUTORIAL |
|
|
39 | 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 |
|
|
41 | manpage. |
21 | |
42 | |
22 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
43 | WHY YOU SHOULD USE THIS MODULE (OR NOT) |
23 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
44 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
24 | nowadays. So what is different about AnyEvent? |
45 | nowadays. So what is different about AnyEvent? |
25 | |
46 | |
26 | Executive Summary: AnyEvent is *compatible*, AnyEvent is *free of |
47 | Executive Summary: AnyEvent is *compatible*, AnyEvent is *free of |
27 | policy* and AnyEvent is *small and efficient*. |
48 | policy* and AnyEvent is *small and efficient*. |
28 | |
49 | |
29 | First and foremost, *AnyEvent is not an event model* itself, it only |
50 | First and foremost, *AnyEvent is not an event model* itself, it only |
30 | interfaces to whatever event model the main program happens to use in a |
51 | interfaces to whatever event model the main program happens to use, in a |
31 | pragmatic way. For event models and certain classes of immortals alike, |
52 | pragmatic way. For event models and certain classes of immortals alike, |
32 | the statement "there can only be one" is a bitter reality: In general, |
53 | the statement "there can only be one" is a bitter reality: In general, |
33 | only one event loop can be active at the same time in a process. |
54 | only one event loop can be active at the same time in a process. |
34 | AnyEvent helps hiding the differences between those event loops. |
55 | AnyEvent cannot change this, but it can hide the differences between |
|
|
56 | those event loops. |
35 | |
57 | |
36 | The goal of AnyEvent is to offer module authors the ability to do event |
58 | The goal of AnyEvent is to offer module authors the ability to do event |
37 | programming (waiting for I/O or timer events) without subscribing to a |
59 | programming (waiting for I/O or timer events) without subscribing to a |
38 | religion, a way of living, and most importantly: without forcing your |
60 | religion, a way of living, and most importantly: without forcing your |
39 | module users into the same thing by forcing them to use the same event |
61 | module users into the same thing by forcing them to use the same event |
40 | model you use. |
62 | model you use. |
41 | |
63 | |
42 | For modules like POE or IO::Async (which is a total misnomer as it is |
64 | For modules like POE or IO::Async (which is a total misnomer as it is |
43 | actually doing all I/O *synchronously*...), using them in your module is |
65 | actually doing all I/O *synchronously*...), using them in your module is |
44 | like joining a cult: After you joined, you are dependent on them and you |
66 | like joining a cult: After you joined, you are dependent on them and you |
45 | cannot use anything else, as it is simply incompatible to everything |
67 | cannot use anything else, as they are simply incompatible to everything |
46 | that isn't itself. What's worse, all the potential users of your module |
68 | that isn't them. What's worse, all the potential users of your module |
47 | are *also* forced to use the same event loop you use. |
69 | are *also* forced to use the same event loop you use. |
48 | |
70 | |
49 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
71 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
50 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
72 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
51 | with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if your |
73 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if your |
52 | module uses one of those, every user of your module has to use it, too. |
74 | module uses one of those, every user of your module has to use it, too. |
53 | But if your module uses AnyEvent, it works transparently with all event |
75 | But if your module uses AnyEvent, it works transparently with all event |
54 | models it supports (including stuff like POE and IO::Async, as long as |
76 | models it supports (including stuff like IO::Async, as long as those use |
55 | those use one of the supported event loops. It is trivial to add new |
77 | one of the supported event loops. It is trivial to add new event loops |
56 | event loops to AnyEvent, too, so it is future-proof). |
78 | to AnyEvent, too, so it is future-proof). |
57 | |
79 | |
58 | In addition to being free of having to use *the one and only true event |
80 | In addition to being free of having to use *the one and only true event |
59 | model*, AnyEvent also is free of bloat and policy: with POE or similar |
81 | model*, AnyEvent also is free of bloat and policy: with POE or similar |
60 | modules, you get an enourmous amount of code and strict rules you have |
82 | modules, you get an enormous amount of code and strict rules you have to |
61 | to follow. AnyEvent, on the other hand, is lean and up to the point, by |
83 | follow. AnyEvent, on the other hand, is lean and up to the point, by |
62 | only offering the functionality that is necessary, in as thin as a |
84 | only offering the functionality that is necessary, in as thin as a |
63 | wrapper as technically possible. |
85 | wrapper as technically possible. |
64 | |
86 | |
|
|
87 | Of course, AnyEvent comes with a big (and fully optional!) toolbox of |
|
|
88 | useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
89 | 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 |
|
|
91 | platform bugs and differences. |
|
|
92 | |
65 | Of course, if you want lots of policy (this can arguably be somewhat |
93 | Now, if you *do want* lots of policy (this can arguably be somewhat |
66 | useful) and you want to force your users to use the one and only event |
94 | useful) and you want to force your users to use the one and only event |
67 | model, you should *not* use this module. |
95 | model, you should *not* use this module. |
68 | |
96 | |
69 | DESCRIPTION |
97 | DESCRIPTION |
70 | AnyEvent provides an identical interface to multiple event loops. This |
98 | AnyEvent provides an identical interface to multiple event loops. This |
… | |
… | |
75 | The interface itself is vaguely similar, but not identical to the Event |
103 | The interface itself is vaguely similar, but not identical to the Event |
76 | module. |
104 | module. |
77 | |
105 | |
78 | During the first call of any watcher-creation method, the module tries |
106 | During the first call of any watcher-creation method, the module tries |
79 | to detect the currently loaded event loop by probing whether one of the |
107 | to detect the currently loaded event loop by probing whether one of the |
80 | following modules is already loaded: Coro::EV, Coro::Event, EV, Event, |
108 | following modules is already loaded: EV, Event, Glib, |
81 | Glib, AnyEvent::Impl::Perl, Tk, Event::Lib, Qt, POE. The first one found |
109 | AnyEvent::Impl::Perl, Tk, Event::Lib, Qt, POE. The first one found is |
82 | is used. If none are found, the module tries to load these modules |
110 | used. If none are found, the module tries to load these modules |
83 | (excluding Tk, Event::Lib, Qt and POE as the pure perl adaptor should |
111 | (excluding Tk, Event::Lib, Qt and POE as the pure perl adaptor should |
84 | always succeed) in the order given. The first one that can be |
112 | always succeed) in the order given. The first one that can be |
85 | successfully loaded will be used. If, after this, still none could be |
113 | successfully loaded will be used. If, after this, still none could be |
86 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
114 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
87 | very efficient, but should work everywhere. |
115 | very efficient, but should work everywhere. |
… | |
… | |
99 | starts using it, all bets are off. Maybe you should tell their authors |
127 | starts using it, all bets are off. Maybe you should tell their authors |
100 | to use AnyEvent so their modules work together with others seamlessly... |
128 | to use AnyEvent so their modules work together with others seamlessly... |
101 | |
129 | |
102 | The pure-perl implementation of AnyEvent is called |
130 | The pure-perl implementation of AnyEvent is called |
103 | "AnyEvent::Impl::Perl". Like other event modules you can load it |
131 | "AnyEvent::Impl::Perl". Like other event modules you can load it |
104 | explicitly. |
132 | explicitly and enjoy the high availability of that event loop :) |
105 | |
133 | |
106 | WATCHERS |
134 | WATCHERS |
107 | AnyEvent has the central concept of a *watcher*, which is an object that |
135 | AnyEvent has the central concept of a *watcher*, which is an object that |
108 | stores relevant data for each kind of event you are waiting for, such as |
136 | stores relevant data for each kind of event you are waiting for, such as |
109 | the callback to call, the filehandle to watch, etc. |
137 | the callback to call, the file handle to watch, etc. |
110 | |
138 | |
111 | These watchers are normal Perl objects with normal Perl lifetime. After |
139 | These watchers are normal Perl objects with normal Perl lifetime. After |
112 | creating a watcher it will immediately "watch" for events and invoke the |
140 | creating a watcher it will immediately "watch" for events and invoke the |
113 | callback when the event occurs (of course, only when the event model is |
141 | callback when the event occurs (of course, only when the event model is |
114 | in control). |
142 | in control). |
115 | |
143 | |
|
|
144 | Note that callbacks must not permanently change global variables |
|
|
145 | potentially in use by the event loop (such as $_ or $[) and that |
|
|
146 | callbacks must not "die". The former is good programming practise in |
|
|
147 | Perl and the latter stems from the fact that exception handling differs |
|
|
148 | widely between event loops. |
|
|
149 | |
116 | To disable the watcher you have to destroy it (e.g. by setting the |
150 | To disable the watcher you have to destroy it (e.g. by setting the |
117 | variable you store it in to "undef" or otherwise deleting all references |
151 | variable you store it in to "undef" or otherwise deleting all references |
118 | to it). |
152 | to it). |
119 | |
153 | |
120 | All watchers are created by calling a method on the "AnyEvent" class. |
154 | All watchers are created by calling a method on the "AnyEvent" class. |
… | |
… | |
122 | Many watchers either are used with "recursion" (repeating timers for |
156 | Many watchers either are used with "recursion" (repeating timers for |
123 | example), or need to refer to their watcher object in other ways. |
157 | example), or need to refer to their watcher object in other ways. |
124 | |
158 | |
125 | An any way to achieve that is this pattern: |
159 | An any way to achieve that is this pattern: |
126 | |
160 | |
127 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
161 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
128 | # you can use $w here, for example to undef it |
162 | # you can use $w here, for example to undef it |
129 | undef $w; |
163 | undef $w; |
130 | }); |
164 | }); |
131 | |
165 | |
132 | Note that "my $w; $w =" combination. This is necessary because in Perl, |
166 | Note that "my $w; $w =" combination. This is necessary because in Perl, |
133 | my variables are only visible after the statement in which they are |
167 | my variables are only visible after the statement in which they are |
134 | declared. |
168 | declared. |
135 | |
169 | |
136 | I/O WATCHERS |
170 | I/O WATCHERS |
137 | You can create an I/O watcher by calling the "AnyEvent->io" method with |
171 | You can create an I/O watcher by calling the "AnyEvent->io" method with |
138 | the following mandatory key-value pairs as arguments: |
172 | the following mandatory key-value pairs as arguments: |
139 | |
173 | |
140 | "fh" the Perl *file handle* (*not* file descriptor) to watch for events. |
174 | "fh" is the Perl *file handle* (*not* file descriptor) to watch for |
|
|
175 | events (AnyEvent might or might not keep a reference to this file |
|
|
176 | handle). Note that only file handles pointing to things for which |
|
|
177 | non-blocking operation makes sense are allowed. This includes sockets, |
|
|
178 | most character devices, pipes, fifos and so on, but not for example |
|
|
179 | files or block devices. |
|
|
180 | |
141 | "poll" must be a string that is either "r" or "w", which creates a |
181 | "poll" must be a string that is either "r" or "w", which creates a |
142 | watcher waiting for "r"eadable or "w"ritable events, respectively. "cb" |
182 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
|
|
183 | |
143 | is the callback to invoke each time the file handle becomes ready. |
184 | "cb" is the callback to invoke each time the file handle becomes ready. |
144 | |
185 | |
145 | Although the callback might get passed parameters, their value and |
186 | Although the callback might get passed parameters, their value and |
146 | presence is undefined and you cannot rely on them. Portable AnyEvent |
187 | presence is undefined and you cannot rely on them. Portable AnyEvent |
147 | callbacks cannot use arguments passed to I/O watcher callbacks. |
188 | callbacks cannot use arguments passed to I/O watcher callbacks. |
148 | |
189 | |
… | |
… | |
152 | |
193 | |
153 | Some event loops issue spurious readyness notifications, so you should |
194 | Some event loops issue spurious readyness notifications, so you should |
154 | always use non-blocking calls when reading/writing from/to your file |
195 | always use non-blocking calls when reading/writing from/to your file |
155 | handles. |
196 | handles. |
156 | |
197 | |
157 | Example: |
|
|
158 | |
|
|
159 | # wait for readability of STDIN, then read a line and disable the watcher |
198 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
199 | watcher. |
|
|
200 | |
160 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
201 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
161 | chomp (my $input = <STDIN>); |
202 | chomp (my $input = <STDIN>); |
162 | warn "read: $input\n"; |
203 | warn "read: $input\n"; |
163 | undef $w; |
204 | undef $w; |
164 | }); |
205 | }); |
… | |
… | |
173 | |
214 | |
174 | Although the callback might get passed parameters, their value and |
215 | Although the callback might get passed parameters, their value and |
175 | presence is undefined and you cannot rely on them. Portable AnyEvent |
216 | presence is undefined and you cannot rely on them. Portable AnyEvent |
176 | callbacks cannot use arguments passed to time watcher callbacks. |
217 | callbacks cannot use arguments passed to time watcher callbacks. |
177 | |
218 | |
178 | The timer callback will be invoked at most once: if you want a repeating |
219 | The callback will normally be invoked once only. If you specify another |
179 | timer you have to create a new watcher (this is a limitation by both Tk |
220 | parameter, "interval", as a strictly positive number (> 0), then the |
180 | and Glib). |
221 | callback will be invoked regularly at that interval (in fractional |
|
|
222 | seconds) after the first invocation. If "interval" is specified with a |
|
|
223 | false value, then it is treated as if it were missing. |
181 | |
224 | |
182 | Example: |
225 | 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 |
|
|
227 | is only approximate. |
183 | |
228 | |
184 | # fire an event after 7.7 seconds |
229 | Example: fire an event after 7.7 seconds. |
|
|
230 | |
185 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
231 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
186 | warn "timeout\n"; |
232 | warn "timeout\n"; |
187 | }); |
233 | }); |
188 | |
234 | |
189 | # to cancel the timer: |
235 | # to cancel the timer: |
190 | undef $w; |
236 | undef $w; |
191 | |
237 | |
192 | Example 2: |
|
|
193 | |
|
|
194 | # fire an event after 0.5 seconds, then roughly every second |
238 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
195 | my $w; |
|
|
196 | |
239 | |
197 | my $cb = sub { |
|
|
198 | # cancel the old timer while creating a new one |
|
|
199 | $w = AnyEvent->timer (after => 1, cb => $cb); |
240 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
241 | warn "timeout\n"; |
200 | }; |
242 | }; |
201 | |
|
|
202 | # start the "loop" by creating the first watcher |
|
|
203 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
204 | |
243 | |
205 | TIMING ISSUES |
244 | TIMING ISSUES |
206 | There are two ways to handle timers: based on real time (relative, "fire |
245 | There are two ways to handle timers: based on real time (relative, "fire |
207 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
246 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
208 | o'clock"). |
247 | o'clock"). |
… | |
… | |
220 | on wallclock time) timers. |
259 | on wallclock time) timers. |
221 | |
260 | |
222 | AnyEvent always prefers relative timers, if available, matching the |
261 | AnyEvent always prefers relative timers, if available, matching the |
223 | AnyEvent API. |
262 | AnyEvent API. |
224 | |
263 | |
|
|
264 | AnyEvent has two additional methods that return the "current time": |
|
|
265 | |
|
|
266 | AnyEvent->time |
|
|
267 | This returns the "current wallclock time" as a fractional number of |
|
|
268 | seconds since the Epoch (the same thing as "time" or |
|
|
269 | "Time::HiRes::time" return, and the result is guaranteed to be |
|
|
270 | compatible with those). |
|
|
271 | |
|
|
272 | It progresses independently of any event loop processing, i.e. each |
|
|
273 | call will check the system clock, which usually gets updated |
|
|
274 | frequently. |
|
|
275 | |
|
|
276 | AnyEvent->now |
|
|
277 | This also returns the "current wallclock time", but unlike "time", |
|
|
278 | above, this value might change only once per event loop iteration, |
|
|
279 | depending on the event loop (most return the same time as "time", |
|
|
280 | above). This is the time that AnyEvent's timers get scheduled |
|
|
281 | against. |
|
|
282 | |
|
|
283 | *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.* |
|
|
285 | |
|
|
286 | This function is also often faster then "AnyEvent->time", and thus |
|
|
287 | the preferred method if you want some timestamp (for example, |
|
|
288 | AnyEvent::Handle uses this to update it's activity timeouts). |
|
|
289 | |
|
|
290 | 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. |
|
|
292 | |
|
|
293 | For a practical example of when these times differ, consider |
|
|
294 | Event::Lib and EV and the following set-up: |
|
|
295 | |
|
|
296 | The event loop is running and has just invoked one of your callback |
|
|
297 | at time=500 (assume no other callbacks delay processing). In your |
|
|
298 | 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 |
|
|
300 | timer that fires after three seconds. |
|
|
301 | |
|
|
302 | With Event::Lib, "AnyEvent->time" and "AnyEvent->now" will both |
|
|
303 | return 501, because that is the current time, and the timer will be |
|
|
304 | scheduled to fire at time=504 (501 + 3). |
|
|
305 | |
|
|
306 | With EV, "AnyEvent->time" returns 501 (as that is the current time), |
|
|
307 | but "AnyEvent->now" returns 500, as that is the time the last event |
|
|
308 | processing phase started. With EV, your timer gets scheduled to run |
|
|
309 | at time=503 (500 + 3). |
|
|
310 | |
|
|
311 | In one sense, Event::Lib is more exact, as it uses the current time |
|
|
312 | regardless of any delays introduced by event processing. However, |
|
|
313 | most callbacks do not expect large delays in processing, so this |
|
|
314 | causes a higher drift (and a lot more system calls to get the |
|
|
315 | current time). |
|
|
316 | |
|
|
317 | In another sense, EV is more exact, as your timer will be scheduled |
|
|
318 | at the same time, regardless of how long event processing actually |
|
|
319 | took. |
|
|
320 | |
|
|
321 | In either case, if you care (and in most cases, you don't), then you |
|
|
322 | can get whatever behaviour you want with any event loop, by taking |
|
|
323 | the difference between "AnyEvent->time" and "AnyEvent->now" into |
|
|
324 | account. |
|
|
325 | |
|
|
326 | AnyEvent->now_update |
|
|
327 | Some event loops (such as EV or AnyEvent::Impl::Perl) cache the |
|
|
328 | current time for each loop iteration (see the discussion of |
|
|
329 | AnyEvent->now, above). |
|
|
330 | |
|
|
331 | When a callback runs for a long time (or when the process sleeps), |
|
|
332 | then this "current" time will differ substantially from the real |
|
|
333 | time, which might affect timers and time-outs. |
|
|
334 | |
|
|
335 | When this is the case, you can call this method, which will update |
|
|
336 | the event loop's idea of "current time". |
|
|
337 | |
|
|
338 | Note that updating the time *might* cause some events to be handled. |
|
|
339 | |
225 | SIGNAL WATCHERS |
340 | SIGNAL WATCHERS |
226 | You can watch for signals using a signal watcher, "signal" is the signal |
341 | You can watch for signals using a signal watcher, "signal" is the signal |
227 | *name* without any "SIG" prefix, "cb" is the Perl callback to be invoked |
342 | *name* in uppercase and without any "SIG" prefix, "cb" is the Perl |
228 | whenever a signal occurs. |
343 | callback to be invoked whenever a signal occurs. |
229 | |
344 | |
230 | Although the callback might get passed parameters, their value and |
345 | Although the callback might get passed parameters, their value and |
231 | presence is undefined and you cannot rely on them. Portable AnyEvent |
346 | presence is undefined and you cannot rely on them. Portable AnyEvent |
232 | callbacks cannot use arguments passed to signal watcher callbacks. |
347 | callbacks cannot use arguments passed to signal watcher callbacks. |
233 | |
348 | |
234 | Multiple signal occurances can be clumped together into one callback |
349 | Multiple signal occurrences can be clumped together into one callback |
235 | invocation, and callback invocation will be synchronous. synchronous |
350 | invocation, and callback invocation will be synchronous. Synchronous |
236 | means that it might take a while until the signal gets handled by the |
351 | means that it might take a while until the signal gets handled by the |
237 | process, but it is guarenteed not to interrupt any other callbacks. |
352 | process, but it is guaranteed not to interrupt any other callbacks. |
238 | |
353 | |
239 | The main advantage of using these watchers is that you can share a |
354 | The main advantage of using these watchers is that you can share a |
240 | signal between multiple watchers. |
355 | signal between multiple watchers. |
241 | |
356 | |
242 | This watcher might use %SIG, so programs overwriting those signals |
357 | This watcher might use %SIG, so programs overwriting those signals |
… | |
… | |
248 | |
363 | |
249 | CHILD PROCESS WATCHERS |
364 | CHILD PROCESS WATCHERS |
250 | You can also watch on a child process exit and catch its exit status. |
365 | You can also watch on a child process exit and catch its exit status. |
251 | |
366 | |
252 | The child process is specified by the "pid" argument (if set to 0, it |
367 | The child process is specified by the "pid" argument (if set to 0, it |
253 | watches for any child process exit). The watcher will trigger as often |
368 | watches for any child process exit). The watcher will triggered only |
254 | as status change for the child are received. This works by installing a |
369 | when the child process has finished and an exit status is available, not |
255 | signal handler for "SIGCHLD". The callback will be called with the pid |
370 | on any trace events (stopped/continued). |
256 | and exit status (as returned by waitpid), so unlike other watcher types, |
371 | |
257 | you *can* rely on child watcher callback arguments. |
372 | 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 |
|
|
374 | callback arguments. |
|
|
375 | |
|
|
376 | This watcher type works by installing a signal handler for "SIGCHLD", |
|
|
377 | and since it cannot be shared, nothing else should use SIGCHLD or reap |
|
|
378 | random child processes (waiting for specific child processes, e.g. |
|
|
379 | inside "system", is just fine). |
258 | |
380 | |
259 | There is a slight catch to child watchers, however: you usually start |
381 | There is a slight catch to child watchers, however: you usually start |
260 | them *after* the child process was created, and this means the process |
382 | them *after* the child process was created, and this means the process |
261 | could have exited already (and no SIGCHLD will be sent anymore). |
383 | could have exited already (and no SIGCHLD will be sent anymore). |
262 | |
384 | |
… | |
… | |
269 | an AnyEvent program, you *have* to create at least one watcher before |
391 | an AnyEvent program, you *have* to create at least one watcher before |
270 | you "fork" the child (alternatively, you can call "AnyEvent::detect"). |
392 | you "fork" the child (alternatively, you can call "AnyEvent::detect"). |
271 | |
393 | |
272 | Example: fork a process and wait for it |
394 | Example: fork a process and wait for it |
273 | |
395 | |
274 | my $done = AnyEvent->condvar; |
396 | my $done = AnyEvent->condvar; |
275 | |
397 | |
276 | AnyEvent::detect; # force event module to be initialised |
|
|
277 | |
|
|
278 | my $pid = fork or exit 5; |
398 | my $pid = fork or exit 5; |
279 | |
399 | |
280 | my $w = AnyEvent->child ( |
400 | my $w = AnyEvent->child ( |
281 | pid => $pid, |
401 | pid => $pid, |
282 | cb => sub { |
402 | cb => sub { |
283 | my ($pid, $status) = @_; |
403 | my ($pid, $status) = @_; |
284 | warn "pid $pid exited with status $status"; |
404 | warn "pid $pid exited with status $status"; |
285 | $done->broadcast; |
405 | $done->send; |
286 | }, |
406 | }, |
287 | ); |
407 | ); |
288 | |
408 | |
289 | # do something else, then wait for process exit |
409 | # do something else, then wait for process exit |
290 | $done->wait; |
410 | $done->recv; |
|
|
411 | |
|
|
412 | IDLE WATCHERS |
|
|
413 | Sometimes there is a need to do something, but it is not so important to |
|
|
414 | do it instantly, but only when there is nothing better to do. This |
|
|
415 | "nothing better to do" is usually defined to be "no other events need |
|
|
416 | attention by the event loop". |
|
|
417 | |
|
|
418 | Idle watchers ideally get invoked when the event loop has nothing better |
|
|
419 | to do, just before it would block the process to wait for new events. |
|
|
420 | Instead of blocking, the idle watcher is invoked. |
|
|
421 | |
|
|
422 | Most event loops unfortunately do not really support idle watchers (only |
|
|
423 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
424 | will simply call the callback "from time to time". |
|
|
425 | |
|
|
426 | Example: read lines from STDIN, but only process them when the program |
|
|
427 | is otherwise idle: |
|
|
428 | |
|
|
429 | my @lines; # read data |
|
|
430 | my $idle_w; |
|
|
431 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
432 | push @lines, scalar <STDIN>; |
|
|
433 | |
|
|
434 | # start an idle watcher, if not already done |
|
|
435 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
436 | # handle only one line, when there are lines left |
|
|
437 | if (my $line = shift @lines) { |
|
|
438 | print "handled when idle: $line"; |
|
|
439 | } else { |
|
|
440 | # otherwise disable the idle watcher again |
|
|
441 | undef $idle_w; |
|
|
442 | } |
|
|
443 | }); |
|
|
444 | }); |
291 | |
445 | |
292 | CONDITION VARIABLES |
446 | CONDITION VARIABLES |
|
|
447 | If you are familiar with some event loops you will know that all of them |
|
|
448 | require you to run some blocking "loop", "run" or similar function that |
|
|
449 | will actively watch for new events and call your callbacks. |
|
|
450 | |
|
|
451 | AnyEvent is different, it expects somebody else to run the event loop |
|
|
452 | and will only block when necessary (usually when told by the user). |
|
|
453 | |
|
|
454 | The instrument to do that is called a "condition variable", so called |
|
|
455 | because they represent a condition that must become true. |
|
|
456 | |
293 | Condition variables can be created by calling the "AnyEvent->condvar" |
457 | Condition variables can be created by calling the "AnyEvent->condvar" |
294 | method without any arguments. |
458 | method, usually without arguments. The only argument pair allowed is |
295 | |
459 | |
296 | A condition variable waits for a condition - precisely that the |
460 | "cb", which specifies a callback to be called when the condition |
297 | "->broadcast" method has been called. |
461 | variable becomes true, with the condition variable as the first argument |
|
|
462 | (but not the results). |
298 | |
463 | |
299 | They are very useful to signal that a condition has been fulfilled, for |
464 | After creation, the condition variable is "false" until it becomes |
|
|
465 | "true" by calling the "send" method (or calling the condition variable |
|
|
466 | as if it were a callback, read about the caveats in the description for |
|
|
467 | the "->send" method). |
|
|
468 | |
|
|
469 | Condition variables are similar to callbacks, except that you can |
|
|
470 | optionally wait for them. They can also be called merge points - points |
|
|
471 | in time where multiple outstanding events have been processed. And yet |
|
|
472 | another way to call them is transactions - each condition variable can |
|
|
473 | be used to represent a transaction, which finishes at some point and |
|
|
474 | delivers a result. |
|
|
475 | |
|
|
476 | Condition variables are very useful to signal that something has |
300 | example, if you write a module that does asynchronous http requests, |
477 | finished, for example, if you write a module that does asynchronous http |
301 | then a condition variable would be the ideal candidate to signal the |
478 | requests, then a condition variable would be the ideal candidate to |
302 | availability of results. |
479 | signal the availability of results. The user can either act when the |
|
|
480 | callback is called or can synchronously "->recv" for the results. |
303 | |
481 | |
304 | You can also use condition variables to block your main program until an |
482 | You can also use them to simulate traditional event loops - for example, |
305 | event occurs - for example, you could "->wait" in your main program |
483 | you can block your main program until an event occurs - for example, you |
306 | until the user clicks the Quit button in your app, which would |
484 | could "->recv" in your main program until the user clicks the Quit |
307 | "->broadcast" the "quit" event. |
485 | button of your app, which would "->send" the "quit" event. |
308 | |
486 | |
309 | Note that condition variables recurse into the event loop - if you have |
487 | Note that condition variables recurse into the event loop - if you have |
310 | two pirces of code that call "->wait" in a round-robbin fashion, you |
488 | two pieces of code that call "->recv" in a round-robin fashion, you |
311 | lose. Therefore, condition variables are good to export to your caller, |
489 | lose. Therefore, condition variables are good to export to your caller, |
312 | but you should avoid making a blocking wait yourself, at least in |
490 | but you should avoid making a blocking wait yourself, at least in |
313 | callbacks, as this asks for trouble. |
491 | callbacks, as this asks for trouble. |
314 | |
492 | |
315 | This object has two methods: |
493 | Condition variables are represented by hash refs in perl, and the keys |
|
|
494 | used by AnyEvent itself are all named "_ae_XXX" to make subclassing easy |
|
|
495 | (it is often useful to build your own transaction class on top of |
|
|
496 | AnyEvent). To subclass, use "AnyEvent::CondVar" as base class and call |
|
|
497 | it's "new" method in your own "new" method. |
316 | |
498 | |
317 | $cv->wait |
499 | There are two "sides" to a condition variable - the "producer side" |
|
|
500 | which eventually calls "-> send", and the "consumer side", which waits |
|
|
501 | for the send to occur. |
|
|
502 | |
|
|
503 | Example: wait for a timer. |
|
|
504 | |
|
|
505 | # wait till the result is ready |
|
|
506 | my $result_ready = AnyEvent->condvar; |
|
|
507 | |
|
|
508 | # do something such as adding a timer |
|
|
509 | # or socket watcher the calls $result_ready->send |
|
|
510 | # when the "result" is ready. |
|
|
511 | # in this case, we simply use a timer: |
|
|
512 | my $w = AnyEvent->timer ( |
|
|
513 | after => 1, |
|
|
514 | cb => sub { $result_ready->send }, |
|
|
515 | ); |
|
|
516 | |
|
|
517 | # this "blocks" (while handling events) till the callback |
|
|
518 | # calls send |
|
|
519 | $result_ready->recv; |
|
|
520 | |
|
|
521 | Example: wait for a timer, but take advantage of the fact that condition |
|
|
522 | variables are also code references. |
|
|
523 | |
|
|
524 | my $done = AnyEvent->condvar; |
|
|
525 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
526 | $done->recv; |
|
|
527 | |
|
|
528 | Example: Imagine an API that returns a condvar and doesn't support |
|
|
529 | callbacks. This is how you make a synchronous call, for example from the |
|
|
530 | main program: |
|
|
531 | |
|
|
532 | use AnyEvent::CouchDB; |
|
|
533 | |
|
|
534 | ... |
|
|
535 | |
|
|
536 | my @info = $couchdb->info->recv; |
|
|
537 | |
|
|
538 | And this is how you would just ste a callback to be called whenever the |
|
|
539 | results are available: |
|
|
540 | |
|
|
541 | $couchdb->info->cb (sub { |
|
|
542 | my @info = $_[0]->recv; |
|
|
543 | }); |
|
|
544 | |
|
|
545 | METHODS FOR PRODUCERS |
|
|
546 | These methods should only be used by the producing side, i.e. the |
|
|
547 | code/module that eventually sends the signal. Note that it is also the |
|
|
548 | producer side which creates the condvar in most cases, but it isn't |
|
|
549 | uncommon for the consumer to create it as well. |
|
|
550 | |
|
|
551 | $cv->send (...) |
|
|
552 | Flag the condition as ready - a running "->recv" and all further |
|
|
553 | calls to "recv" will (eventually) return after this method has been |
|
|
554 | called. If nobody is waiting the send will be remembered. |
|
|
555 | |
|
|
556 | If a callback has been set on the condition variable, it is called |
|
|
557 | immediately from within send. |
|
|
558 | |
|
|
559 | Any arguments passed to the "send" call will be returned by all |
|
|
560 | future "->recv" calls. |
|
|
561 | |
|
|
562 | Condition variables are overloaded so one can call them directly (as |
|
|
563 | a code reference). Calling them directly is the same as calling |
|
|
564 | "send". Note, however, that many C-based event loops do not handle |
|
|
565 | overloading, so as tempting as it may be, passing a condition |
|
|
566 | variable instead of a callback does not work. Both the pure perl and |
|
|
567 | EV loops support overloading, however, as well as all functions that |
|
|
568 | use perl to invoke a callback (as in AnyEvent::Socket and |
|
|
569 | AnyEvent::DNS for example). |
|
|
570 | |
|
|
571 | $cv->croak ($error) |
|
|
572 | Similar to send, but causes all call's to "->recv" to invoke |
|
|
573 | "Carp::croak" with the given error message/object/scalar. |
|
|
574 | |
|
|
575 | This can be used to signal any errors to the condition variable |
|
|
576 | user/consumer. |
|
|
577 | |
|
|
578 | $cv->begin ([group callback]) |
|
|
579 | $cv->end |
|
|
580 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
581 | |
|
|
582 | These two methods can be used to combine many transactions/events |
|
|
583 | into one. For example, a function that pings many hosts in parallel |
|
|
584 | might want to use a condition variable for the whole process. |
|
|
585 | |
|
|
586 | Every call to "->begin" will increment a counter, and every call to |
|
|
587 | "->end" will decrement it. If the counter reaches 0 in "->end", the |
|
|
588 | (last) callback passed to "begin" will be executed. That callback is |
|
|
589 | *supposed* to call "->send", but that is not required. If no |
|
|
590 | callback was set, "send" will be called without any arguments. |
|
|
591 | |
|
|
592 | Let's clarify this with the ping example: |
|
|
593 | |
|
|
594 | my $cv = AnyEvent->condvar; |
|
|
595 | |
|
|
596 | my %result; |
|
|
597 | $cv->begin (sub { $cv->send (\%result) }); |
|
|
598 | |
|
|
599 | for my $host (@list_of_hosts) { |
|
|
600 | $cv->begin; |
|
|
601 | ping_host_then_call_callback $host, sub { |
|
|
602 | $result{$host} = ...; |
|
|
603 | $cv->end; |
|
|
604 | }; |
|
|
605 | } |
|
|
606 | |
|
|
607 | $cv->end; |
|
|
608 | |
|
|
609 | This code fragment supposedly pings a number of hosts and calls |
|
|
610 | "send" after results for all then have have been gathered - in any |
|
|
611 | order. To achieve this, the code issues a call to "begin" when it |
|
|
612 | starts each ping request and calls "end" when it has received some |
|
|
613 | result for it. Since "begin" and "end" only maintain a counter, the |
|
|
614 | order in which results arrive is not relevant. |
|
|
615 | |
|
|
616 | There is an additional bracketing call to "begin" and "end" outside |
|
|
617 | the loop, which serves two important purposes: first, it sets the |
|
|
618 | callback to be called once the counter reaches 0, and second, it |
|
|
619 | ensures that "send" is called even when "no" hosts are being pinged |
|
|
620 | (the loop doesn't execute once). |
|
|
621 | |
|
|
622 | This is the general pattern when you "fan out" into multiple |
|
|
623 | subrequests: use an outer "begin"/"end" pair to set the callback and |
|
|
624 | ensure "end" is called at least once, and then, for each subrequest |
|
|
625 | you start, call "begin" and for each subrequest you finish, call |
|
|
626 | "end". |
|
|
627 | |
|
|
628 | METHODS FOR CONSUMERS |
|
|
629 | These methods should only be used by the consuming side, i.e. the code |
|
|
630 | awaits the condition. |
|
|
631 | |
|
|
632 | $cv->recv |
318 | Wait (blocking if necessary) until the "->broadcast" method has been |
633 | Wait (blocking if necessary) until the "->send" or "->croak" methods |
319 | called on c<$cv>, while servicing other watchers normally. |
634 | have been called on c<$cv>, while servicing other watchers normally. |
320 | |
635 | |
321 | You can only wait once on a condition - additional calls will return |
636 | You can only wait once on a condition - additional calls are valid |
322 | immediately. |
637 | but will return immediately. |
|
|
638 | |
|
|
639 | If an error condition has been set by calling "->croak", then this |
|
|
640 | function will call "croak". |
|
|
641 | |
|
|
642 | In list context, all parameters passed to "send" will be returned, |
|
|
643 | in scalar context only the first one will be returned. |
323 | |
644 | |
324 | Not all event models support a blocking wait - some die in that case |
645 | Not all event models support a blocking wait - some die in that case |
325 | (programs might want to do that to stay interactive), so *if you are |
646 | (programs might want to do that to stay interactive), so *if you are |
326 | using this from a module, never require a blocking wait*, but let |
647 | using this from a module, never require a blocking wait*, but let |
327 | the caller decide whether the call will block or not (for example, |
648 | the caller decide whether the call will block or not (for example, |
328 | by coupling condition variables with some kind of request results |
649 | by coupling condition variables with some kind of request results |
329 | and supporting callbacks so the caller knows that getting the result |
650 | and supporting callbacks so the caller knows that getting the result |
330 | will not block, while still suppporting blocking waits if the caller |
651 | will not block, while still supporting blocking waits if the caller |
331 | so desires). |
652 | so desires). |
332 | |
653 | |
333 | Another reason *never* to "->wait" in a module is that you cannot |
654 | Another reason *never* to "->recv" in a module is that you cannot |
334 | sensibly have two "->wait"'s in parallel, as that would require |
655 | sensibly have two "->recv"'s in parallel, as that would require |
335 | multiple interpreters or coroutines/threads, none of which |
656 | multiple interpreters or coroutines/threads, none of which |
336 | "AnyEvent" can supply (the coroutine-aware backends |
657 | "AnyEvent" can supply. |
337 | AnyEvent::Impl::CoroEV and AnyEvent::Impl::CoroEvent explicitly |
|
|
338 | support concurrent "->wait"'s from different coroutines, however). |
|
|
339 | |
658 | |
340 | $cv->broadcast |
659 | The Coro module, however, *can* and *does* supply coroutines and, in |
341 | Flag the condition as ready - a running "->wait" and all further |
660 | fact, Coro::AnyEvent replaces AnyEvent's condvars by coroutine-safe |
342 | calls to "wait" will (eventually) return after this method has been |
661 | versions and also integrates coroutines into AnyEvent, making |
343 | called. If nobody is waiting the broadcast will be remembered.. |
662 | blocking "->recv" calls perfectly safe as long as they are done from |
|
|
663 | another coroutine (one that doesn't run the event loop). |
344 | |
664 | |
345 | Example: |
665 | You can ensure that "-recv" never blocks by setting a callback and |
|
|
666 | only calling "->recv" from within that callback (or at a later |
|
|
667 | time). This will work even when the event loop does not support |
|
|
668 | blocking waits otherwise. |
346 | |
669 | |
347 | # wait till the result is ready |
670 | $bool = $cv->ready |
348 | my $result_ready = AnyEvent->condvar; |
671 | Returns true when the condition is "true", i.e. whether "send" or |
|
|
672 | "croak" have been called. |
349 | |
673 | |
350 | # do something such as adding a timer |
674 | $cb = $cv->cb ($cb->($cv)) |
351 | # or socket watcher the calls $result_ready->broadcast |
675 | This is a mutator function that returns the callback set and |
352 | # when the "result" is ready. |
676 | optionally replaces it before doing so. |
353 | # in this case, we simply use a timer: |
|
|
354 | my $w = AnyEvent->timer ( |
|
|
355 | after => 1, |
|
|
356 | cb => sub { $result_ready->broadcast }, |
|
|
357 | ); |
|
|
358 | |
677 | |
359 | # this "blocks" (while handling events) till the watcher |
678 | The callback will be called when the condition becomes "true", i.e. |
360 | # calls broadcast |
679 | when "send" or "croak" are called, with the only argument being the |
361 | $result_ready->wait; |
680 | condition variable itself. Calling "recv" inside the callback or at |
|
|
681 | any later time is guaranteed not to block. |
362 | |
682 | |
363 | GLOBAL VARIABLES AND FUNCTIONS |
683 | GLOBAL VARIABLES AND FUNCTIONS |
364 | $AnyEvent::MODEL |
684 | $AnyEvent::MODEL |
365 | Contains "undef" until the first watcher is being created. Then it |
685 | Contains "undef" until the first watcher is being created. Then it |
366 | contains the event model that is being used, which is the name of |
686 | contains the event model that is being used, which is the name of |
… | |
… | |
368 | the "AnyEvent::Impl:xxx" modules, but can be any other class in the |
688 | the "AnyEvent::Impl:xxx" modules, but can be any other class in the |
369 | case AnyEvent has been extended at runtime (e.g. in *rxvt-unicode*). |
689 | case AnyEvent has been extended at runtime (e.g. in *rxvt-unicode*). |
370 | |
690 | |
371 | The known classes so far are: |
691 | The known classes so far are: |
372 | |
692 | |
373 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
|
|
374 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
|
|
375 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
693 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
376 | AnyEvent::Impl::Event based on Event, second best choice. |
694 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
695 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
377 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
696 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
378 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
|
|
379 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
697 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
380 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
698 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
381 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
699 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
382 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
700 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
383 | |
701 | |
… | |
… | |
395 | Returns $AnyEvent::MODEL, forcing autodetection of the event model |
713 | Returns $AnyEvent::MODEL, forcing autodetection of the event model |
396 | if necessary. You should only call this function right before you |
714 | if necessary. You should only call this function right before you |
397 | would have created an AnyEvent watcher anyway, that is, as late as |
715 | would have created an AnyEvent watcher anyway, that is, as late as |
398 | possible at runtime. |
716 | possible at runtime. |
399 | |
717 | |
|
|
718 | $guard = AnyEvent::post_detect { BLOCK } |
|
|
719 | Arranges for the code block to be executed as soon as the event |
|
|
720 | model is autodetected (or immediately if this has already happened). |
|
|
721 | |
|
|
722 | If called in scalar or list context, then it creates and returns an |
|
|
723 | object that automatically removes the callback again when it is |
|
|
724 | destroyed. See Coro::BDB for a case where this is useful. |
|
|
725 | |
|
|
726 | @AnyEvent::post_detect |
|
|
727 | If there are any code references in this array (you can "push" to it |
|
|
728 | before or after loading AnyEvent), then they will called directly |
|
|
729 | after the event loop has been chosen. |
|
|
730 | |
|
|
731 | You should check $AnyEvent::MODEL before adding to this array, |
|
|
732 | though: if it contains a true value then the event loop has already |
|
|
733 | been detected, and the array will be ignored. |
|
|
734 | |
|
|
735 | Best use "AnyEvent::post_detect { BLOCK }" instead. |
|
|
736 | |
400 | WHAT TO DO IN A MODULE |
737 | WHAT TO DO IN A MODULE |
401 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
738 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
402 | freely, but you should not load a specific event module or rely on it. |
739 | freely, but you should not load a specific event module or rely on it. |
403 | |
740 | |
404 | Be careful when you create watchers in the module body - AnyEvent will |
741 | Be careful when you create watchers in the module body - AnyEvent will |
405 | decide which event module to use as soon as the first method is called, |
742 | decide which event module to use as soon as the first method is called, |
406 | so by calling AnyEvent in your module body you force the user of your |
743 | so by calling AnyEvent in your module body you force the user of your |
407 | module to load the event module first. |
744 | module to load the event module first. |
408 | |
745 | |
409 | Never call "->wait" on a condition variable unless you *know* that the |
746 | Never call "->recv" on a condition variable unless you *know* that the |
410 | "->broadcast" method has been called on it already. This is because it |
747 | "->send" method has been called on it already. This is because it will |
411 | will stall the whole program, and the whole point of using events is to |
748 | stall the whole program, and the whole point of using events is to stay |
412 | stay interactive. |
749 | interactive. |
413 | |
750 | |
414 | It is fine, however, to call "->wait" when the user of your module |
751 | It is fine, however, to call "->recv" when the user of your module |
415 | requests it (i.e. if you create a http request object ad have a method |
752 | requests it (i.e. if you create a http request object ad have a method |
416 | called "results" that returns the results, it should call "->wait" |
753 | called "results" that returns the results, it should call "->recv" |
417 | freely, as the user of your module knows what she is doing. always). |
754 | freely, as the user of your module knows what she is doing. always). |
418 | |
755 | |
419 | WHAT TO DO IN THE MAIN PROGRAM |
756 | WHAT TO DO IN THE MAIN PROGRAM |
420 | There will always be a single main program - the only place that should |
757 | There will always be a single main program - the only place that should |
421 | dictate which event model to use. |
758 | dictate which event model to use. |
… | |
… | |
423 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
760 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
424 | do anything special (it does not need to be event-based) and let |
761 | do anything special (it does not need to be event-based) and let |
425 | AnyEvent decide which implementation to chose if some module relies on |
762 | AnyEvent decide which implementation to chose if some module relies on |
426 | it. |
763 | it. |
427 | |
764 | |
428 | If the main program relies on a specific event model. For example, in |
765 | If the main program relies on a specific event model - for example, in |
429 | Gtk2 programs you have to rely on the Glib module. You should load the |
766 | Gtk2 programs you have to rely on the Glib module - you should load the |
430 | event module before loading AnyEvent or any module that uses it: |
767 | event module before loading AnyEvent or any module that uses it: |
431 | generally speaking, you should load it as early as possible. The reason |
768 | generally speaking, you should load it as early as possible. The reason |
432 | is that modules might create watchers when they are loaded, and AnyEvent |
769 | is that modules might create watchers when they are loaded, and AnyEvent |
433 | will decide on the event model to use as soon as it creates watchers, |
770 | will decide on the event model to use as soon as it creates watchers, |
434 | and it might chose the wrong one unless you load the correct one |
771 | and it might chose the wrong one unless you load the correct one |
435 | yourself. |
772 | yourself. |
436 | |
773 | |
437 | You can chose to use a rather inefficient pure-perl implementation by |
774 | You can chose to use a pure-perl implementation by loading the |
438 | loading the "AnyEvent::Impl::Perl" module, which gives you similar |
775 | "AnyEvent::Impl::Perl" module, which gives you similar behaviour |
439 | behaviour everywhere, but letting AnyEvent chose is generally better. |
776 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
777 | |
|
|
778 | MAINLOOP EMULATION |
|
|
779 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
780 | only want to use AnyEvent), you do not want to run a specific event |
|
|
781 | loop. |
|
|
782 | |
|
|
783 | In that case, you can use a condition variable like this: |
|
|
784 | |
|
|
785 | AnyEvent->condvar->recv; |
|
|
786 | |
|
|
787 | This has the effect of entering the event loop and looping forever. |
|
|
788 | |
|
|
789 | Note that usually your program has some exit condition, in which case it |
|
|
790 | is better to use the "traditional" approach of storing a condition |
|
|
791 | variable somewhere, waiting for it, and sending it when the program |
|
|
792 | should exit cleanly. |
440 | |
793 | |
441 | OTHER MODULES |
794 | OTHER MODULES |
442 | The following is a non-exhaustive list of additional modules that use |
795 | The following is a non-exhaustive list of additional modules that use |
443 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
796 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
444 | in the same program. Some of the modules come with AnyEvent, some are |
797 | in the same program. Some of the modules come with AnyEvent, some are |
… | |
… | |
447 | AnyEvent::Util |
800 | AnyEvent::Util |
448 | Contains various utility functions that replace often-used but |
801 | Contains various utility functions that replace often-used but |
449 | blocking functions such as "inet_aton" by event-/callback-based |
802 | blocking functions such as "inet_aton" by event-/callback-based |
450 | versions. |
803 | versions. |
451 | |
804 | |
|
|
805 | AnyEvent::Socket |
|
|
806 | Provides various utility functions for (internet protocol) sockets, |
|
|
807 | addresses and name resolution. Also functions to create non-blocking |
|
|
808 | tcp connections or tcp servers, with IPv6 and SRV record support and |
|
|
809 | more. |
|
|
810 | |
452 | AnyEvent::Handle |
811 | AnyEvent::Handle |
453 | Provide read and write buffers and manages watchers for reads and |
812 | Provide read and write buffers, manages watchers for reads and |
454 | writes. |
813 | writes, supports raw and formatted I/O, I/O queued and fully |
|
|
814 | transparent and non-blocking SSL/TLS. |
455 | |
815 | |
456 | AnyEvent::Socket |
816 | AnyEvent::DNS |
457 | Provides a means to do non-blocking connects, accepts etc. |
817 | Provides rich asynchronous DNS resolver capabilities. |
|
|
818 | |
|
|
819 | AnyEvent::HTTP |
|
|
820 | A simple-to-use HTTP library that is capable of making a lot of |
|
|
821 | concurrent HTTP requests. |
458 | |
822 | |
459 | AnyEvent::HTTPD |
823 | AnyEvent::HTTPD |
460 | Provides a simple web application server framework. |
824 | Provides a simple web application server framework. |
461 | |
825 | |
462 | AnyEvent::DNS |
|
|
463 | Provides asynchronous DNS resolver capabilities, beyond what |
|
|
464 | AnyEvent::Util offers. |
|
|
465 | |
|
|
466 | AnyEvent::FastPing |
826 | AnyEvent::FastPing |
467 | The fastest ping in the west. |
827 | The fastest ping in the west. |
468 | |
828 | |
|
|
829 | AnyEvent::DBI |
|
|
830 | Executes DBI requests asynchronously in a proxy process. |
|
|
831 | |
|
|
832 | AnyEvent::AIO |
|
|
833 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
834 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
835 | together. |
|
|
836 | |
|
|
837 | AnyEvent::BDB |
|
|
838 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently |
|
|
839 | fuses BDB and AnyEvent together. |
|
|
840 | |
|
|
841 | AnyEvent::GPSD |
|
|
842 | A non-blocking interface to gpsd, a daemon delivering GPS |
|
|
843 | information. |
|
|
844 | |
|
|
845 | AnyEvent::IGS |
|
|
846 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
847 | App::IGS). |
|
|
848 | |
|
|
849 | AnyEvent::IRC |
|
|
850 | AnyEvent based IRC client module family (replacing the older |
469 | Net::IRC3 |
851 | Net::IRC3). |
470 | AnyEvent based IRC client module family. |
|
|
471 | |
852 | |
472 | Net::XMPP2 |
853 | Net::XMPP2 |
473 | AnyEvent based XMPP (Jabber protocol) module family. |
854 | AnyEvent based XMPP (Jabber protocol) module family. |
474 | |
855 | |
475 | Net::FCP |
856 | Net::FCP |
… | |
… | |
478 | |
859 | |
479 | Event::ExecFlow |
860 | Event::ExecFlow |
480 | High level API for event-based execution flow control. |
861 | High level API for event-based execution flow control. |
481 | |
862 | |
482 | Coro |
863 | Coro |
483 | Has special support for AnyEvent. |
864 | Has special support for AnyEvent via Coro::AnyEvent. |
484 | |
865 | |
485 | IO::Lambda |
866 | IO::Lambda |
486 | The lambda approach to I/O - don't ask, look there. Can use |
867 | The lambda approach to I/O - don't ask, look there. Can use |
487 | AnyEvent. |
868 | AnyEvent. |
488 | |
869 | |
489 | IO::AIO |
870 | ERROR AND EXCEPTION HANDLING |
490 | Truly asynchronous I/O, should be in the toolbox of every event |
871 | In general, AnyEvent does not do any error handling - it relies on the |
491 | programmer. Can be trivially made to use AnyEvent. |
872 | caller to do that if required. The AnyEvent::Strict module (see also the |
|
|
873 | "PERL_ANYEVENT_STRICT" environment variable, below) provides strict |
|
|
874 | checking of all AnyEvent methods, however, which is highly useful during |
|
|
875 | development. |
492 | |
876 | |
493 | BDB Truly asynchronous Berkeley DB access. Can be trivially made to use |
877 | As for exception handling (i.e. runtime errors and exceptions thrown |
494 | AnyEvent. |
878 | while executing a callback), this is not only highly event-loop |
|
|
879 | specific, but also not in any way wrapped by this module, as this is the |
|
|
880 | job of the main program. |
|
|
881 | |
|
|
882 | The pure perl event loop simply re-throws the exception (usually within |
|
|
883 | "condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()", |
|
|
884 | Glib uses "install_exception_handler" and so on. |
|
|
885 | |
|
|
886 | ENVIRONMENT VARIABLES |
|
|
887 | The following environment variables are used by this module or its |
|
|
888 | submodules: |
|
|
889 | |
|
|
890 | "PERL_ANYEVENT_VERBOSE" |
|
|
891 | By default, AnyEvent will be completely silent except in fatal |
|
|
892 | conditions. You can set this environment variable to make AnyEvent |
|
|
893 | more talkative. |
|
|
894 | |
|
|
895 | When set to 1 or higher, causes AnyEvent to warn about unexpected |
|
|
896 | conditions, such as not being able to load the event model specified |
|
|
897 | by "PERL_ANYEVENT_MODEL". |
|
|
898 | |
|
|
899 | When set to 2 or higher, cause AnyEvent to report to STDERR which |
|
|
900 | event model it chooses. |
|
|
901 | |
|
|
902 | "PERL_ANYEVENT_STRICT" |
|
|
903 | AnyEvent does not do much argument checking by default, as thorough |
|
|
904 | argument checking is very costly. Setting this variable to a true |
|
|
905 | value will cause AnyEvent to load "AnyEvent::Strict" and then to |
|
|
906 | thoroughly check the arguments passed to most method calls. If it |
|
|
907 | finds any problems it will croak. |
|
|
908 | |
|
|
909 | In other words, enables "strict" mode. |
|
|
910 | |
|
|
911 | Unlike "use strict", it is definitely recommended ot keep it off in |
|
|
912 | production. Keeping "PERL_ANYEVENT_STRICT=1" in your environment |
|
|
913 | while developing programs can be very useful, however. |
|
|
914 | |
|
|
915 | "PERL_ANYEVENT_MODEL" |
|
|
916 | This can be used to specify the event model to be used by AnyEvent, |
|
|
917 | before auto detection and -probing kicks in. It must be a string |
|
|
918 | consisting entirely of ASCII letters. The string "AnyEvent::Impl::" |
|
|
919 | gets prepended and the resulting module name is loaded and if the |
|
|
920 | load was successful, used as event model. If it fails to load |
|
|
921 | AnyEvent will proceed with auto detection and -probing. |
|
|
922 | |
|
|
923 | This functionality might change in future versions. |
|
|
924 | |
|
|
925 | For example, to force the pure perl model (AnyEvent::Impl::Perl) you |
|
|
926 | could start your program like this: |
|
|
927 | |
|
|
928 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
929 | |
|
|
930 | "PERL_ANYEVENT_PROTOCOLS" |
|
|
931 | Used by both AnyEvent::DNS and AnyEvent::Socket to determine |
|
|
932 | preferences for IPv4 or IPv6. The default is unspecified (and might |
|
|
933 | change, or be the result of auto probing). |
|
|
934 | |
|
|
935 | Must be set to a comma-separated list of protocols or address |
|
|
936 | families, current supported: "ipv4" and "ipv6". Only protocols |
|
|
937 | mentioned will be used, and preference will be given to protocols |
|
|
938 | mentioned earlier in the list. |
|
|
939 | |
|
|
940 | This variable can effectively be used for denial-of-service attacks |
|
|
941 | against local programs (e.g. when setuid), although the impact is |
|
|
942 | likely small, as the program has to handle conenction and other |
|
|
943 | failures anyways. |
|
|
944 | |
|
|
945 | Examples: "PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6" - prefer IPv4 over |
|
|
946 | IPv6, but support both and try to use both. |
|
|
947 | "PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to |
|
|
948 | resolve or contact IPv6 addresses. |
|
|
949 | "PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but |
|
|
950 | prefer IPv6 over IPv4. |
|
|
951 | |
|
|
952 | "PERL_ANYEVENT_EDNS0" |
|
|
953 | Used by AnyEvent::DNS to decide whether to use the EDNS0 extension |
|
|
954 | for DNS. This extension is generally useful to reduce DNS traffic, |
|
|
955 | but some (broken) firewalls drop such DNS packets, which is why it |
|
|
956 | is off by default. |
|
|
957 | |
|
|
958 | Setting this variable to 1 will cause AnyEvent::DNS to announce |
|
|
959 | EDNS0 in its DNS requests. |
|
|
960 | |
|
|
961 | "PERL_ANYEVENT_MAX_FORKS" |
|
|
962 | The maximum number of child processes that |
|
|
963 | "AnyEvent::Util::fork_call" will create in parallel. |
495 | |
964 | |
496 | SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
965 | SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
497 | This is an advanced topic that you do not normally need to use AnyEvent |
966 | This is an advanced topic that you do not normally need to use AnyEvent |
498 | in a module. This section is only of use to event loop authors who want |
967 | in a module. This section is only of use to event loop authors who want |
499 | to provide AnyEvent compatibility. |
968 | to provide AnyEvent compatibility. |
… | |
… | |
533 | |
1002 | |
534 | *rxvt-unicode* also cheats a bit by not providing blocking access to |
1003 | *rxvt-unicode* also cheats a bit by not providing blocking access to |
535 | condition variables: code blocking while waiting for a condition will |
1004 | condition variables: code blocking while waiting for a condition will |
536 | "die". This still works with most modules/usages, and blocking calls |
1005 | "die". This still works with most modules/usages, and blocking calls |
537 | must not be done in an interactive application, so it makes sense. |
1006 | must not be done in an interactive application, so it makes sense. |
538 | |
|
|
539 | ENVIRONMENT VARIABLES |
|
|
540 | The following environment variables are used by this module: |
|
|
541 | |
|
|
542 | "PERL_ANYEVENT_VERBOSE" |
|
|
543 | By default, AnyEvent will be completely silent except in fatal |
|
|
544 | conditions. You can set this environment variable to make AnyEvent |
|
|
545 | more talkative. |
|
|
546 | |
|
|
547 | When set to 1 or higher, causes AnyEvent to warn about unexpected |
|
|
548 | conditions, such as not being able to load the event model specified |
|
|
549 | by "PERL_ANYEVENT_MODEL". |
|
|
550 | |
|
|
551 | When set to 2 or higher, cause AnyEvent to report to STDERR which |
|
|
552 | event model it chooses. |
|
|
553 | |
|
|
554 | "PERL_ANYEVENT_MODEL" |
|
|
555 | This can be used to specify the event model to be used by AnyEvent, |
|
|
556 | before autodetection and -probing kicks in. It must be a string |
|
|
557 | consisting entirely of ASCII letters. The string "AnyEvent::Impl::" |
|
|
558 | gets prepended and the resulting module name is loaded and if the |
|
|
559 | load was successful, used as event model. If it fails to load |
|
|
560 | AnyEvent will proceed with autodetection and -probing. |
|
|
561 | |
|
|
562 | This functionality might change in future versions. |
|
|
563 | |
|
|
564 | For example, to force the pure perl model (AnyEvent::Impl::Perl) you |
|
|
565 | could start your program like this: |
|
|
566 | |
|
|
567 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
568 | |
1007 | |
569 | EXAMPLE PROGRAM |
1008 | EXAMPLE PROGRAM |
570 | The following program uses an I/O watcher to read data from STDIN, a |
1009 | The following program uses an I/O watcher to read data from STDIN, a |
571 | timer to display a message once per second, and a condition variable to |
1010 | timer to display a message once per second, and a condition variable to |
572 | quit the program when the user enters quit: |
1011 | quit the program when the user enters quit: |
… | |
… | |
580 | poll => 'r', |
1019 | poll => 'r', |
581 | cb => sub { |
1020 | cb => sub { |
582 | warn "io event <$_[0]>\n"; # will always output <r> |
1021 | warn "io event <$_[0]>\n"; # will always output <r> |
583 | chomp (my $input = <STDIN>); # read a line |
1022 | chomp (my $input = <STDIN>); # read a line |
584 | warn "read: $input\n"; # output what has been read |
1023 | warn "read: $input\n"; # output what has been read |
585 | $cv->broadcast if $input =~ /^q/i; # quit program if /^q/i |
1024 | $cv->send if $input =~ /^q/i; # quit program if /^q/i |
586 | }, |
1025 | }, |
587 | ); |
1026 | ); |
588 | |
1027 | |
589 | my $time_watcher; # can only be used once |
1028 | my $time_watcher; # can only be used once |
590 | |
1029 | |
… | |
… | |
595 | }); |
1034 | }); |
596 | } |
1035 | } |
597 | |
1036 | |
598 | new_timer; # create first timer |
1037 | new_timer; # create first timer |
599 | |
1038 | |
600 | $cv->wait; # wait until user enters /^q/i |
1039 | $cv->recv; # wait until user enters /^q/i |
601 | |
1040 | |
602 | REAL-WORLD EXAMPLE |
1041 | REAL-WORLD EXAMPLE |
603 | Consider the Net::FCP module. It features (among others) the following |
1042 | Consider the Net::FCP module. It features (among others) the following |
604 | API calls, which are to freenet what HTTP GET requests are to http: |
1043 | API calls, which are to freenet what HTTP GET requests are to http: |
605 | |
1044 | |
… | |
… | |
654 | syswrite $txn->{fh}, $txn->{request} |
1093 | syswrite $txn->{fh}, $txn->{request} |
655 | or die "connection or write error"; |
1094 | or die "connection or write error"; |
656 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1095 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
657 | |
1096 | |
658 | Again, "fh_ready_r" waits till all data has arrived, and then stores the |
1097 | Again, "fh_ready_r" waits till all data has arrived, and then stores the |
659 | result and signals any possible waiters that the request ahs finished: |
1098 | result and signals any possible waiters that the request has finished: |
660 | |
1099 | |
661 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1100 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
662 | |
1101 | |
663 | if (end-of-file or data complete) { |
1102 | if (end-of-file or data complete) { |
664 | $txn->{result} = $txn->{buf}; |
1103 | $txn->{result} = $txn->{buf}; |
665 | $txn->{finished}->broadcast; |
1104 | $txn->{finished}->send; |
666 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
1105 | $txb->{cb}->($txn) of $txn->{cb}; # also call callback |
667 | } |
1106 | } |
668 | |
1107 | |
669 | The "result" method, finally, just waits for the finished signal (if the |
1108 | The "result" method, finally, just waits for the finished signal (if the |
670 | request was already finished, it doesn't wait, of course, and returns |
1109 | request was already finished, it doesn't wait, of course, and returns |
671 | the data: |
1110 | the data: |
672 | |
1111 | |
673 | $txn->{finished}->wait; |
1112 | $txn->{finished}->recv; |
674 | return $txn->{result}; |
1113 | return $txn->{result}; |
675 | |
1114 | |
676 | The actual code goes further and collects all errors ("die"s, |
1115 | The actual code goes further and collects all errors ("die"s, |
677 | exceptions) that occured during request processing. The "result" method |
1116 | exceptions) that occurred during request processing. The "result" method |
678 | detects whether an exception as thrown (it is stored inside the $txn |
1117 | detects whether an exception as thrown (it is stored inside the $txn |
679 | object) and just throws the exception, which means connection errors and |
1118 | object) and just throws the exception, which means connection errors and |
680 | other problems get reported tot he code that tries to use the result, |
1119 | other problems get reported tot he code that tries to use the result, |
681 | not in a random callback. |
1120 | not in a random callback. |
682 | |
1121 | |
… | |
… | |
713 | |
1152 | |
714 | my $quit = AnyEvent->condvar; |
1153 | my $quit = AnyEvent->condvar; |
715 | |
1154 | |
716 | $fcp->txn_client_get ($url)->cb (sub { |
1155 | $fcp->txn_client_get ($url)->cb (sub { |
717 | ... |
1156 | ... |
718 | $quit->broadcast; |
1157 | $quit->send; |
719 | }); |
1158 | }); |
720 | |
1159 | |
721 | $quit->wait; |
1160 | $quit->recv; |
722 | |
1161 | |
723 | BENCHMARKS |
1162 | BENCHMARKS |
724 | To give you an idea of the performance and overheads that AnyEvent adds |
1163 | To give you an idea of the performance and overheads that AnyEvent adds |
725 | over the event loops themselves and to give you an impression of the |
1164 | over the event loops themselves and to give you an impression of the |
726 | speed of various event loops I prepared some benchmarks. |
1165 | speed of various event loops I prepared some benchmarks. |
727 | |
1166 | |
728 | BENCHMARKING ANYEVENT OVERHEAD |
1167 | BENCHMARKING ANYEVENT OVERHEAD |
729 | Here is a benchmark of various supported event models used natively and |
1168 | Here is a benchmark of various supported event models used natively and |
730 | through anyevent. The benchmark creates a lot of timers (with a zero |
1169 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
731 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1170 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
732 | which it is), lets them fire exactly once and destroys them again. |
1171 | which it is), lets them fire exactly once and destroys them again. |
733 | |
1172 | |
734 | Source code for this benchmark is found as eg/bench in the AnyEvent |
1173 | Source code for this benchmark is found as eg/bench in the AnyEvent |
735 | distribution. |
1174 | distribution. |
… | |
… | |
751 | between all watchers, to avoid adding memory overhead. That means |
1190 | between all watchers, to avoid adding memory overhead. That means |
752 | closure creation and memory usage is not included in the figures. |
1191 | closure creation and memory usage is not included in the figures. |
753 | |
1192 | |
754 | *invoke* is the time, in microseconds, used to invoke a simple callback. |
1193 | *invoke* is the time, in microseconds, used to invoke a simple callback. |
755 | The callback simply counts down a Perl variable and after it was invoked |
1194 | The callback simply counts down a Perl variable and after it was invoked |
756 | "watcher" times, it would "->broadcast" a condvar once to signal the end |
1195 | "watcher" times, it would "->send" a condvar once to signal the end of |
757 | of this phase. |
1196 | this phase. |
758 | |
1197 | |
759 | *destroy* is the time, in microseconds, that it takes to destroy a |
1198 | *destroy* is the time, in microseconds, that it takes to destroy a |
760 | single watcher. |
1199 | single watcher. |
761 | |
1200 | |
762 | Results |
1201 | Results |
763 | name watchers bytes create invoke destroy comment |
1202 | name watchers bytes create invoke destroy comment |
764 | EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
1203 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
765 | EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers |
1204 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
766 | CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal |
1205 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
767 | Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation |
1206 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
768 | Event/Event 16000 516 31.88 31.30 0.85 Event native interface |
1207 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
769 | Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers |
1208 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
770 | Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour |
1209 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
771 | Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers |
1210 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
772 | POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event |
1211 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
773 | POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select |
1212 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
774 | |
1213 | |
775 | Discussion |
1214 | Discussion |
776 | The benchmark does *not* measure scalability of the event loop very |
1215 | The benchmark does *not* measure scalability of the event loop very |
777 | well. For example, a select-based event loop (such as the pure perl one) |
1216 | well. For example, a select-based event loop (such as the pure perl one) |
778 | can never compete with an event loop that uses epoll when the number of |
1217 | can never compete with an event loop that uses epoll when the number of |
… | |
… | |
823 | the figures above). |
1262 | the figures above). |
824 | |
1263 | |
825 | "POE", regardless of underlying event loop (whether using its pure perl |
1264 | "POE", regardless of underlying event loop (whether using its pure perl |
826 | select-based backend or the Event module, the POE-EV backend couldn't be |
1265 | select-based backend or the Event module, the POE-EV backend couldn't be |
827 | tested because it wasn't working) shows abysmal performance and memory |
1266 | tested because it wasn't working) shows abysmal performance and memory |
828 | usage: Watchers use almost 30 times as much memory as EV watchers, and |
1267 | usage with AnyEvent: Watchers use almost 30 times as much memory as EV |
829 | 10 times as much memory as Event (the high memory requirements are |
1268 | watchers, and 10 times as much memory as Event (the high memory |
830 | caused by requiring a session for each watcher). Watcher invocation |
1269 | requirements are caused by requiring a session for each watcher). |
831 | speed is almost 900 times slower than with AnyEvent's pure perl |
1270 | Watcher invocation speed is almost 900 times slower than with AnyEvent's |
|
|
1271 | pure perl implementation. |
|
|
1272 | |
832 | implementation. The design of the POE adaptor class in AnyEvent can not |
1273 | The design of the POE adaptor class in AnyEvent can not really account |
833 | really account for this, as session creation overhead is small compared |
1274 | for the performance issues, though, as session creation overhead is |
834 | to execution of the state machine, which is coded pretty optimally |
1275 | small compared to execution of the state machine, which is coded pretty |
835 | within AnyEvent::Impl::POE. POE simply seems to be abysmally slow. |
1276 | optimally within AnyEvent::Impl::POE (and while everybody agrees that |
|
|
1277 | using multiple sessions is not a good approach, especially regarding |
|
|
1278 | memory usage, even the author of POE could not come up with a faster |
|
|
1279 | design). |
836 | |
1280 | |
837 | Summary |
1281 | Summary |
838 | * Using EV through AnyEvent is faster than any other event loop (even |
1282 | * Using EV through AnyEvent is faster than any other event loop (even |
839 | when used without AnyEvent), but most event loops have acceptable |
1283 | when used without AnyEvent), but most event loops have acceptable |
840 | performance with or without AnyEvent. |
1284 | performance with or without AnyEvent. |
… | |
… | |
845 | |
1289 | |
846 | * You should avoid POE like the plague if you want performance or |
1290 | * You should avoid POE like the plague if you want performance or |
847 | reasonable memory usage. |
1291 | reasonable memory usage. |
848 | |
1292 | |
849 | BENCHMARKING THE LARGE SERVER CASE |
1293 | BENCHMARKING THE LARGE SERVER CASE |
850 | This benchmark atcually benchmarks the event loop itself. It works by |
1294 | This benchmark actually benchmarks the event loop itself. It works by |
851 | creating a number of "servers": each server consists of a socketpair, a |
1295 | creating a number of "servers": each server consists of a socket pair, a |
852 | timeout watcher that gets reset on activity (but never fires), and an |
1296 | timeout watcher that gets reset on activity (but never fires), and an |
853 | I/O watcher waiting for input on one side of the socket. Each time the |
1297 | I/O watcher waiting for input on one side of the socket. Each time the |
854 | socket watcher reads a byte it will write that byte to a random other |
1298 | socket watcher reads a byte it will write that byte to a random other |
855 | "server". |
1299 | "server". |
856 | |
1300 | |
857 | The effect is that there will be a lot of I/O watchers, only part of |
1301 | The effect is that there will be a lot of I/O watchers, only part of |
858 | which are active at any one point (so there is a constant number of |
1302 | which are active at any one point (so there is a constant number of |
859 | active fds for each loop iterstaion, but which fds these are is random). |
1303 | active fds for each loop iteration, but which fds these are is random). |
860 | The timeout is reset each time something is read because that reflects |
1304 | The timeout is reset each time something is read because that reflects |
861 | how most timeouts work (and puts extra pressure on the event loops). |
1305 | how most timeouts work (and puts extra pressure on the event loops). |
862 | |
1306 | |
863 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which |
1307 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which |
864 | 100 (1%) are active. This mirrors the activity of large servers with |
1308 | 100 (1%) are active. This mirrors the activity of large servers with |
865 | many connections, most of which are idle at any one point in time. |
1309 | many connections, most of which are idle at any one point in time. |
866 | |
1310 | |
867 | Source code for this benchmark is found as eg/bench2 in the AnyEvent |
1311 | Source code for this benchmark is found as eg/bench2 in the AnyEvent |
868 | distribution. |
1312 | distribution. |
869 | |
1313 | |
870 | Explanation of the columns |
1314 | Explanation of the columns |
871 | *sockets* is the number of sockets, and twice the number of "servers" |
1315 | *sockets* is the number of sockets, and twice the number of "servers" |
872 | (as each server has a read and write socket end). |
1316 | (as each server has a read and write socket end). |
873 | |
1317 | |
874 | *create* is the time it takes to create a socketpair (which is |
1318 | *create* is the time it takes to create a socket pair (which is |
875 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1319 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
876 | |
1320 | |
877 | *request*, the most important value, is the time it takes to handle a |
1321 | *request*, the most important value, is the time it takes to handle a |
878 | single "request", that is, reading the token from the pipe and |
1322 | single "request", that is, reading the token from the pipe and |
879 | forwarding it to another server. This includes deleting the old timeout |
1323 | forwarding it to another server. This includes deleting the old timeout |
… | |
… | |
909 | POE is still completely out of the picture, taking over 1000 times as |
1353 | POE is still completely out of the picture, taking over 1000 times as |
910 | long as EV, and over 100 times as long as the Perl implementation, even |
1354 | long as EV, and over 100 times as long as the Perl implementation, even |
911 | though it uses a C-based event loop in this case. |
1355 | though it uses a C-based event loop in this case. |
912 | |
1356 | |
913 | Summary |
1357 | Summary |
914 | * The pure perl implementation performs extremely well, considering |
1358 | * The pure perl implementation performs extremely well. |
915 | that it uses select. |
|
|
916 | |
1359 | |
917 | * Avoid Glib or POE in large projects where performance matters. |
1360 | * Avoid Glib or POE in large projects where performance matters. |
918 | |
1361 | |
919 | BENCHMARKING SMALL SERVERS |
1362 | BENCHMARKING SMALL SERVERS |
920 | While event loops should scale (and select-based ones do not...) even to |
1363 | While event loops should scale (and select-based ones do not...) even to |
… | |
… | |
944 | and speed most when you have lots of watchers, not when you only have a |
1387 | and speed most when you have lots of watchers, not when you only have a |
945 | few of them). |
1388 | few of them). |
946 | |
1389 | |
947 | EV is again fastest. |
1390 | EV is again fastest. |
948 | |
1391 | |
949 | Perl again comes second. It is noticably faster than the C-based event |
1392 | Perl again comes second. It is noticeably faster than the C-based event |
950 | loops Event and Glib, although the difference is too small to really |
1393 | loops Event and Glib, although the difference is too small to really |
951 | matter. |
1394 | matter. |
952 | |
1395 | |
953 | POE also performs much better in this case, but is is still far behind |
1396 | POE also performs much better in this case, but is is still far behind |
954 | the others. |
1397 | the others. |
955 | |
1398 | |
956 | Summary |
1399 | Summary |
957 | * C-based event loops perform very well with small number of watchers, |
1400 | * C-based event loops perform very well with small number of watchers, |
958 | as the management overhead dominates. |
1401 | as the management overhead dominates. |
959 | |
1402 | |
|
|
1403 | SIGNALS |
|
|
1404 | AnyEvent currently installs handlers for these signals: |
|
|
1405 | |
|
|
1406 | SIGCHLD |
|
|
1407 | A handler for "SIGCHLD" is installed by AnyEvent's child watcher |
|
|
1408 | emulation for event loops that do not support them natively. Also, |
|
|
1409 | some event loops install a similar handler. |
|
|
1410 | |
|
|
1411 | SIGPIPE |
|
|
1412 | A no-op handler is installed for "SIGPIPE" when $SIG{PIPE} is |
|
|
1413 | "undef" when AnyEvent gets loaded. |
|
|
1414 | |
|
|
1415 | The rationale for this is that AnyEvent users usually do not really |
|
|
1416 | depend on SIGPIPE delivery (which is purely an optimisation for |
|
|
1417 | shell use, or badly-written programs), but "SIGPIPE" can cause |
|
|
1418 | spurious and rare program exits as a lot of people do not expect |
|
|
1419 | "SIGPIPE" when writing to some random socket. |
|
|
1420 | |
|
|
1421 | The rationale for installing a no-op handler as opposed to ignoring |
|
|
1422 | it is that this way, the handler will be restored to defaults on |
|
|
1423 | exec. |
|
|
1424 | |
|
|
1425 | Feel free to install your own handler, or reset it to defaults. |
|
|
1426 | |
960 | FORK |
1427 | FORK |
961 | Most event libraries are not fork-safe. The ones who are usually are |
1428 | Most event libraries are not fork-safe. The ones who are usually are |
962 | because they are so inefficient. Only EV is fully fork-aware. |
1429 | because they rely on inefficient but fork-safe "select" or "poll" calls. |
|
|
1430 | Only EV is fully fork-aware. |
963 | |
1431 | |
964 | If you have to fork, you must either do so *before* creating your first |
1432 | If you have to fork, you must either do so *before* creating your first |
965 | watcher OR you must not use AnyEvent at all in the child. |
1433 | watcher OR you must not use AnyEvent at all in the child. |
966 | |
1434 | |
967 | SECURITY CONSIDERATIONS |
1435 | SECURITY CONSIDERATIONS |
… | |
… | |
973 | model than specified in the variable. |
1441 | model than specified in the variable. |
974 | |
1442 | |
975 | You can make AnyEvent completely ignore this variable by deleting it |
1443 | You can make AnyEvent completely ignore this variable by deleting it |
976 | before the first watcher gets created, e.g. with a "BEGIN" block: |
1444 | before the first watcher gets created, e.g. with a "BEGIN" block: |
977 | |
1445 | |
978 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1446 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
979 | |
1447 | |
980 | use AnyEvent; |
1448 | use AnyEvent; |
|
|
1449 | |
|
|
1450 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
|
|
1451 | be used to probe what backend is used and gain other information (which |
|
|
1452 | is probably even less useful to an attacker than PERL_ANYEVENT_MODEL), |
|
|
1453 | and $ENV{PERL_ANYEGENT_STRICT}. |
|
|
1454 | |
|
|
1455 | BUGS |
|
|
1456 | Perl 5.8 has numerous memleaks that sometimes hit this module and are |
|
|
1457 | hard to work around. If you suffer from memleaks, first upgrade to Perl |
|
|
1458 | 5.10 and check wether the leaks still show up. (Perl 5.10.0 has other |
|
|
1459 | annoying memleaks, such as leaking on "map" and "grep" but it is usually |
|
|
1460 | not as pronounced). |
981 | |
1461 | |
982 | SEE ALSO |
1462 | SEE ALSO |
983 | Event modules: Coro::EV, EV, EV::Glib, Glib::EV, Coro::Event, Event, |
1463 | Utility functions: AnyEvent::Util. |
984 | Glib::Event, Glib, Coro, Tk, Event::Lib, Qt, POE. |
|
|
985 | |
1464 | |
986 | Implementations: AnyEvent::Impl::CoroEV, AnyEvent::Impl::EV, |
1465 | Event modules: EV, EV::Glib, Glib::EV, Event, Glib::Event, Glib, Tk, |
987 | AnyEvent::Impl::CoroEvent, AnyEvent::Impl::Event, AnyEvent::Impl::Glib, |
1466 | Event::Lib, Qt, POE. |
988 | AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, AnyEvent::Impl::EventLib, |
1467 | |
|
|
1468 | Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, |
|
|
1469 | AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, |
989 | AnyEvent::Impl::Qt, AnyEvent::Impl::POE. |
1470 | AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE. |
990 | |
1471 | |
|
|
1472 | Non-blocking file handles, sockets, TCP clients and servers: |
|
|
1473 | AnyEvent::Handle, AnyEvent::Socket. |
|
|
1474 | |
|
|
1475 | Asynchronous DNS: AnyEvent::DNS. |
|
|
1476 | |
|
|
1477 | Coroutine support: Coro, Coro::AnyEvent, Coro::EV, Coro::Event, |
|
|
1478 | |
991 | Nontrivial usage examples: Net::FCP, Net::XMPP2. |
1479 | Nontrivial usage examples: Net::FCP, Net::XMPP2, AnyEvent::DNS. |
992 | |
1480 | |
993 | AUTHOR |
1481 | AUTHOR |
994 | Marc Lehmann <schmorp@schmorp.de> |
1482 | Marc Lehmann <schmorp@schmorp.de> |
995 | http://home.schmorp.de/ |
1483 | http://home.schmorp.de/ |
996 | |
1484 | |