… | |
… | |
7 | |
7 | |
8 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
9 | |
9 | |
10 | use AnyEvent; |
10 | use AnyEvent; |
11 | |
11 | |
|
|
12 | # if you prefer function calls, look at the AE manpage for |
|
|
13 | # an alternative API. |
|
|
14 | |
12 | # file descriptor readable |
15 | # file handle or descriptor readable |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
16 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
14 | |
17 | |
15 | # one-shot or repeating timers |
18 | # one-shot or repeating timers |
16 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
19 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
17 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
20 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...); |
18 | |
21 | |
19 | print AnyEvent->now; # prints current event loop time |
22 | print AnyEvent->now; # prints current event loop time |
20 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
23 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
21 | |
24 | |
22 | # POSIX signal |
25 | # POSIX signal |
… | |
… | |
73 | module users into the same thing by forcing them to use the same event |
76 | module users into the same thing by forcing them to use the same event |
74 | model you use. |
77 | model you use. |
75 | |
78 | |
76 | For modules like POE or IO::Async (which is a total misnomer as it is |
79 | For modules like POE or IO::Async (which is a total misnomer as it is |
77 | actually doing all I/O I<synchronously>...), using them in your module is |
80 | actually doing all I/O I<synchronously>...), using them in your module is |
78 | like joining a cult: After you joined, you are dependent on them and you |
81 | like joining a cult: After you join, you are dependent on them and you |
79 | cannot use anything else, as they are simply incompatible to everything |
82 | cannot use anything else, as they are simply incompatible to everything |
80 | that isn't them. What's worse, all the potential users of your |
83 | that isn't them. What's worse, all the potential users of your |
81 | module are I<also> forced to use the same event loop you use. |
84 | module are I<also> forced to use the same event loop you use. |
82 | |
85 | |
83 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
86 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
84 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
87 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
85 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
88 | with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if |
86 | your module uses one of those, every user of your module has to use it, |
89 | your module uses one of those, every user of your module has to use it, |
87 | too. But if your module uses AnyEvent, it works transparently with all |
90 | too. But if your module uses AnyEvent, it works transparently with all |
88 | event models it supports (including stuff like IO::Async, as long as those |
91 | event models it supports (including stuff like IO::Async, as long as those |
89 | use one of the supported event loops. It is trivial to add new event loops |
92 | use one of the supported event loops. It is easy to add new event loops |
90 | to AnyEvent, too, so it is future-proof). |
93 | to AnyEvent, too, so it is future-proof). |
91 | |
94 | |
92 | In addition to being free of having to use I<the one and only true event |
95 | In addition to being free of having to use I<the one and only true event |
93 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
96 | model>, AnyEvent also is free of bloat and policy: with POE or similar |
94 | modules, you get an enormous amount of code and strict rules you have to |
97 | modules, you get an enormous amount of code and strict rules you have to |
95 | follow. AnyEvent, on the other hand, is lean and up to the point, by only |
98 | follow. AnyEvent, on the other hand, is lean and to the point, by only |
96 | offering the functionality that is necessary, in as thin as a wrapper as |
99 | offering the functionality that is necessary, in as thin as a wrapper as |
97 | technically possible. |
100 | technically possible. |
98 | |
101 | |
99 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
102 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
100 | of useful functionality, such as an asynchronous DNS resolver, 100% |
103 | of useful functionality, such as an asynchronous DNS resolver, 100% |
… | |
… | |
106 | useful) and you want to force your users to use the one and only event |
109 | useful) and you want to force your users to use the one and only event |
107 | model, you should I<not> use this module. |
110 | model, you should I<not> use this module. |
108 | |
111 | |
109 | =head1 DESCRIPTION |
112 | =head1 DESCRIPTION |
110 | |
113 | |
111 | L<AnyEvent> provides an identical interface to multiple event loops. This |
114 | L<AnyEvent> provides a uniform interface to various event loops. This |
112 | allows module authors to utilise an event loop without forcing module |
115 | allows module authors to use event loop functionality without forcing |
113 | users to use the same event loop (as only a single event loop can coexist |
116 | module users to use a specific event loop implementation (since more |
114 | peacefully at any one time). |
117 | than one event loop cannot coexist peacefully). |
115 | |
118 | |
116 | The interface itself is vaguely similar, but not identical to the L<Event> |
119 | The interface itself is vaguely similar, but not identical to the L<Event> |
117 | module. |
120 | module. |
118 | |
121 | |
119 | During the first call of any watcher-creation method, the module tries |
122 | During the first call of any watcher-creation method, the module tries |
120 | to detect the currently loaded event loop by probing whether one of the |
123 | to detect the currently loaded event loop by probing whether one of the |
121 | following modules is already loaded: L<EV>, |
124 | following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, |
122 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
125 | L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one |
123 | L<POE>. The first one found is used. If none are found, the module tries |
126 | found is used. If none are detected, the module tries to load the first |
124 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
127 | four modules in the order given; but note that if L<EV> is not |
125 | adaptor should always succeed) in the order given. The first one that can |
128 | available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so |
126 | be successfully loaded will be used. If, after this, still none could be |
129 | the other two are not normally tried. |
127 | found, AnyEvent will fall back to a pure-perl event loop, which is not |
|
|
128 | very efficient, but should work everywhere. |
|
|
129 | |
130 | |
130 | Because AnyEvent first checks for modules that are already loaded, loading |
131 | Because AnyEvent first checks for modules that are already loaded, loading |
131 | an event model explicitly before first using AnyEvent will likely make |
132 | an event model explicitly before first using AnyEvent will likely make |
132 | that model the default. For example: |
133 | that model the default. For example: |
133 | |
134 | |
… | |
… | |
135 | use AnyEvent; |
136 | use AnyEvent; |
136 | |
137 | |
137 | # .. AnyEvent will likely default to Tk |
138 | # .. AnyEvent will likely default to Tk |
138 | |
139 | |
139 | The I<likely> means that, if any module loads another event model and |
140 | The I<likely> means that, if any module loads another event model and |
140 | starts using it, all bets are off. Maybe you should tell their authors to |
141 | starts using it, all bets are off - this case should be very rare though, |
141 | use AnyEvent so their modules work together with others seamlessly... |
142 | as very few modules hardcode event loops without announcing this very |
|
|
143 | loudly. |
142 | |
144 | |
143 | The pure-perl implementation of AnyEvent is called |
145 | The pure-perl implementation of AnyEvent is called |
144 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
146 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
145 | explicitly and enjoy the high availability of that event loop :) |
147 | explicitly and enjoy the high availability of that event loop :) |
146 | |
148 | |
… | |
… | |
155 | callback when the event occurs (of course, only when the event model |
157 | callback when the event occurs (of course, only when the event model |
156 | is in control). |
158 | is in control). |
157 | |
159 | |
158 | Note that B<callbacks must not permanently change global variables> |
160 | Note that B<callbacks must not permanently change global variables> |
159 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
161 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
160 | callbacks must not C<die> >>. The former is good programming practise in |
162 | callbacks must not C<die> >>. The former is good programming practice in |
161 | Perl and the latter stems from the fact that exception handling differs |
163 | Perl and the latter stems from the fact that exception handling differs |
162 | widely between event loops. |
164 | widely between event loops. |
163 | |
165 | |
164 | To disable the watcher you have to destroy it (e.g. by setting the |
166 | To disable a watcher you have to destroy it (e.g. by setting the |
165 | variable you store it in to C<undef> or otherwise deleting all references |
167 | variable you store it in to C<undef> or otherwise deleting all references |
166 | to it). |
168 | to it). |
167 | |
169 | |
168 | All watchers are created by calling a method on the C<AnyEvent> class. |
170 | All watchers are created by calling a method on the C<AnyEvent> class. |
169 | |
171 | |
170 | Many watchers either are used with "recursion" (repeating timers for |
172 | Many watchers either are used with "recursion" (repeating timers for |
171 | example), or need to refer to their watcher object in other ways. |
173 | example), or need to refer to their watcher object in other ways. |
172 | |
174 | |
173 | An any way to achieve that is this pattern: |
175 | One way to achieve that is this pattern: |
174 | |
176 | |
175 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
177 | my $w; $w = AnyEvent->type (arg => value ..., cb => sub { |
176 | # you can use $w here, for example to undef it |
178 | # you can use $w here, for example to undef it |
177 | undef $w; |
179 | undef $w; |
178 | }); |
180 | }); |
… | |
… | |
210 | |
212 | |
211 | The I/O watcher might use the underlying file descriptor or a copy of it. |
213 | The I/O watcher might use the underlying file descriptor or a copy of it. |
212 | You must not close a file handle as long as any watcher is active on the |
214 | You must not close a file handle as long as any watcher is active on the |
213 | underlying file descriptor. |
215 | underlying file descriptor. |
214 | |
216 | |
215 | Some event loops issue spurious readyness notifications, so you should |
217 | Some event loops issue spurious readiness notifications, so you should |
216 | always use non-blocking calls when reading/writing from/to your file |
218 | always use non-blocking calls when reading/writing from/to your file |
217 | handles. |
219 | handles. |
218 | |
220 | |
219 | Example: wait for readability of STDIN, then read a line and disable the |
221 | Example: wait for readability of STDIN, then read a line and disable the |
220 | watcher. |
222 | watcher. |
… | |
… | |
244 | |
246 | |
245 | Although the callback might get passed parameters, their value and |
247 | Although the callback might get passed parameters, their value and |
246 | presence is undefined and you cannot rely on them. Portable AnyEvent |
248 | presence is undefined and you cannot rely on them. Portable AnyEvent |
247 | callbacks cannot use arguments passed to time watcher callbacks. |
249 | callbacks cannot use arguments passed to time watcher callbacks. |
248 | |
250 | |
249 | The callback will normally be invoked once only. If you specify another |
251 | The callback will normally be invoked only once. If you specify another |
250 | parameter, C<interval>, as a strictly positive number (> 0), then the |
252 | parameter, C<interval>, as a strictly positive number (> 0), then the |
251 | callback will be invoked regularly at that interval (in fractional |
253 | callback will be invoked regularly at that interval (in fractional |
252 | seconds) after the first invocation. If C<interval> is specified with a |
254 | seconds) after the first invocation. If C<interval> is specified with a |
253 | false value, then it is treated as if it were missing. |
255 | false value, then it is treated as if it were not specified at all. |
254 | |
256 | |
255 | The callback will be rescheduled before invoking the callback, but no |
257 | The callback will be rescheduled before invoking the callback, but no |
256 | attempt is done to avoid timer drift in most backends, so the interval is |
258 | attempt is made to avoid timer drift in most backends, so the interval is |
257 | only approximate. |
259 | only approximate. |
258 | |
260 | |
259 | Example: fire an event after 7.7 seconds. |
261 | Example: fire an event after 7.7 seconds. |
260 | |
262 | |
261 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
263 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
… | |
… | |
279 | |
281 | |
280 | While most event loops expect timers to specified in a relative way, they |
282 | While most event loops expect timers to specified in a relative way, they |
281 | use absolute time internally. This makes a difference when your clock |
283 | use absolute time internally. This makes a difference when your clock |
282 | "jumps", for example, when ntp decides to set your clock backwards from |
284 | "jumps", for example, when ntp decides to set your clock backwards from |
283 | the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to |
285 | the wrong date of 2014-01-01 to 2008-01-01, a watcher that is supposed to |
284 | fire "after" a second might actually take six years to finally fire. |
286 | fire "after a second" might actually take six years to finally fire. |
285 | |
287 | |
286 | AnyEvent cannot compensate for this. The only event loop that is conscious |
288 | AnyEvent cannot compensate for this. The only event loop that is conscious |
287 | about these issues is L<EV>, which offers both relative (ev_timer, based |
289 | of these issues is L<EV>, which offers both relative (ev_timer, based |
288 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
290 | on true relative time) and absolute (ev_periodic, based on wallclock time) |
289 | timers. |
291 | timers. |
290 | |
292 | |
291 | AnyEvent always prefers relative timers, if available, matching the |
293 | AnyEvent always prefers relative timers, if available, matching the |
292 | AnyEvent API. |
294 | AnyEvent API. |
… | |
… | |
314 | I<In almost all cases (in all cases if you don't care), this is the |
316 | I<In almost all cases (in all cases if you don't care), this is the |
315 | function to call when you want to know the current time.> |
317 | function to call when you want to know the current time.> |
316 | |
318 | |
317 | This function is also often faster then C<< AnyEvent->time >>, and |
319 | This function is also often faster then C<< AnyEvent->time >>, and |
318 | thus the preferred method if you want some timestamp (for example, |
320 | thus the preferred method if you want some timestamp (for example, |
319 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
321 | L<AnyEvent::Handle> uses this to update its activity timeouts). |
320 | |
322 | |
321 | The rest of this section is only of relevance if you try to be very exact |
323 | The rest of this section is only of relevance if you try to be very exact |
322 | with your timing, you can skip it without bad conscience. |
324 | with your timing; you can skip it without a bad conscience. |
323 | |
325 | |
324 | For a practical example of when these times differ, consider L<Event::Lib> |
326 | For a practical example of when these times differ, consider L<Event::Lib> |
325 | and L<EV> and the following set-up: |
327 | and L<EV> and the following set-up: |
326 | |
328 | |
327 | The event loop is running and has just invoked one of your callback at |
329 | The event loop is running and has just invoked one of your callbacks at |
328 | time=500 (assume no other callbacks delay processing). In your callback, |
330 | time=500 (assume no other callbacks delay processing). In your callback, |
329 | you wait a second by executing C<sleep 1> (blocking the process for a |
331 | you wait a second by executing C<sleep 1> (blocking the process for a |
330 | second) and then (at time=501) you create a relative timer that fires |
332 | second) and then (at time=501) you create a relative timer that fires |
331 | after three seconds. |
333 | after three seconds. |
332 | |
334 | |
… | |
… | |
425 | =head3 Signal Races, Delays and Workarounds |
427 | =head3 Signal Races, Delays and Workarounds |
426 | |
428 | |
427 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
429 | Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching |
428 | callbacks to signals in a generic way, which is a pity, as you cannot |
430 | callbacks to signals in a generic way, which is a pity, as you cannot |
429 | do race-free signal handling in perl, requiring C libraries for |
431 | do race-free signal handling in perl, requiring C libraries for |
430 | this. AnyEvent will try to do it's best, which means in some cases, |
432 | this. AnyEvent will try to do its best, which means in some cases, |
431 | signals will be delayed. The maximum time a signal might be delayed is |
433 | signals will be delayed. The maximum time a signal might be delayed is |
432 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
434 | specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This |
433 | variable can be changed only before the first signal watcher is created, |
435 | variable can be changed only before the first signal watcher is created, |
434 | and should be left alone otherwise. This variable determines how often |
436 | and should be left alone otherwise. This variable determines how often |
435 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
437 | AnyEvent polls for signals (in case a wake-up was missed). Higher values |
… | |
… | |
437 | saving. |
439 | saving. |
438 | |
440 | |
439 | All these problems can be avoided by installing the optional |
441 | All these problems can be avoided by installing the optional |
440 | L<Async::Interrupt> module, which works with most event loops. It will not |
442 | L<Async::Interrupt> module, which works with most event loops. It will not |
441 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
443 | work with inherently broken event loops such as L<Event> or L<Event::Lib> |
442 | (and not with L<POE> currently, as POE does it's own workaround with |
444 | (and not with L<POE> currently, as POE does its own workaround with |
443 | one-second latency). For those, you just have to suffer the delays. |
445 | one-second latency). For those, you just have to suffer the delays. |
444 | |
446 | |
445 | =head2 CHILD PROCESS WATCHERS |
447 | =head2 CHILD PROCESS WATCHERS |
446 | |
448 | |
447 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
449 | $w = AnyEvent->child (pid => <process id>, cb => <callback>); |
448 | |
450 | |
449 | You can also watch on a child process exit and catch its exit status. |
451 | You can also watch for a child process exit and catch its exit status. |
450 | |
452 | |
451 | The child process is specified by the C<pid> argument (one some backends, |
453 | The child process is specified by the C<pid> argument (on some backends, |
452 | using C<0> watches for any child process exit, on others this will |
454 | using C<0> watches for any child process exit, on others this will |
453 | croak). The watcher will be triggered only when the child process has |
455 | croak). The watcher will be triggered only when the child process has |
454 | finished and an exit status is available, not on any trace events |
456 | finished and an exit status is available, not on any trace events |
455 | (stopped/continued). |
457 | (stopped/continued). |
456 | |
458 | |
… | |
… | |
503 | |
505 | |
504 | =head2 IDLE WATCHERS |
506 | =head2 IDLE WATCHERS |
505 | |
507 | |
506 | $w = AnyEvent->idle (cb => <callback>); |
508 | $w = AnyEvent->idle (cb => <callback>); |
507 | |
509 | |
508 | Sometimes there is a need to do something, but it is not so important |
510 | This will repeatedly invoke the callback after the process becomes idle, |
509 | to do it instantly, but only when there is nothing better to do. This |
511 | until either the watcher is destroyed or new events have been detected. |
510 | "nothing better to do" is usually defined to be "no other events need |
|
|
511 | attention by the event loop". |
|
|
512 | |
512 | |
513 | Idle watchers ideally get invoked when the event loop has nothing |
513 | Idle watchers are useful when there is a need to do something, but it |
514 | better to do, just before it would block the process to wait for new |
514 | is not so important (or wise) to do it instantly. The callback will be |
515 | events. Instead of blocking, the idle watcher is invoked. |
515 | invoked only when there is "nothing better to do", which is usually |
|
|
516 | defined as "all outstanding events have been handled and no new events |
|
|
517 | have been detected". That means that idle watchers ideally get invoked |
|
|
518 | when the event loop has just polled for new events but none have been |
|
|
519 | detected. Instead of blocking to wait for more events, the idle watchers |
|
|
520 | will be invoked. |
516 | |
521 | |
517 | Most event loops unfortunately do not really support idle watchers (only |
522 | Unfortunately, most event loops do not really support idle watchers (only |
518 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
523 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
519 | will simply call the callback "from time to time". |
524 | will simply call the callback "from time to time". |
520 | |
525 | |
521 | Example: read lines from STDIN, but only process them when the |
526 | Example: read lines from STDIN, but only process them when the |
522 | program is otherwise idle: |
527 | program is otherwise idle: |
… | |
… | |
550 | will actively watch for new events and call your callbacks. |
555 | will actively watch for new events and call your callbacks. |
551 | |
556 | |
552 | AnyEvent is slightly different: it expects somebody else to run the event |
557 | AnyEvent is slightly different: it expects somebody else to run the event |
553 | loop and will only block when necessary (usually when told by the user). |
558 | loop and will only block when necessary (usually when told by the user). |
554 | |
559 | |
555 | The instrument to do that is called a "condition variable", so called |
560 | The tool to do that is called a "condition variable", so called because |
556 | because they represent a condition that must become true. |
561 | they represent a condition that must become true. |
557 | |
562 | |
558 | Now is probably a good time to look at the examples further below. |
563 | Now is probably a good time to look at the examples further below. |
559 | |
564 | |
560 | Condition variables can be created by calling the C<< AnyEvent->condvar |
565 | Condition variables can be created by calling the C<< AnyEvent->condvar |
561 | >> method, usually without arguments. The only argument pair allowed is |
566 | >> method, usually without arguments. The only argument pair allowed is |
… | |
… | |
566 | After creation, the condition variable is "false" until it becomes "true" |
571 | After creation, the condition variable is "false" until it becomes "true" |
567 | by calling the C<send> method (or calling the condition variable as if it |
572 | by calling the C<send> method (or calling the condition variable as if it |
568 | were a callback, read about the caveats in the description for the C<< |
573 | were a callback, read about the caveats in the description for the C<< |
569 | ->send >> method). |
574 | ->send >> method). |
570 | |
575 | |
571 | Condition variables are similar to callbacks, except that you can |
576 | Since condition variables are the most complex part of the AnyEvent API, here are |
572 | optionally wait for them. They can also be called merge points - points |
577 | some different mental models of what they are - pick the ones you can connect to: |
573 | in time where multiple outstanding events have been processed. And yet |
578 | |
574 | another way to call them is transactions - each condition variable can be |
579 | =over 4 |
575 | used to represent a transaction, which finishes at some point and delivers |
580 | |
576 | a result. And yet some people know them as "futures" - a promise to |
581 | =item * Condition variables are like callbacks - you can call them (and pass them instead |
577 | compute/deliver something that you can wait for. |
582 | of callbacks). Unlike callbacks however, you can also wait for them to be called. |
|
|
583 | |
|
|
584 | =item * Condition variables are signals - one side can emit or send them, |
|
|
585 | the other side can wait for them, or install a handler that is called when |
|
|
586 | the signal fires. |
|
|
587 | |
|
|
588 | =item * Condition variables are like "Merge Points" - points in your program |
|
|
589 | where you merge multiple independent results/control flows into one. |
|
|
590 | |
|
|
591 | =item * Condition variables represent a transaction - functions that start |
|
|
592 | some kind of transaction can return them, leaving the caller the choice |
|
|
593 | between waiting in a blocking fashion, or setting a callback. |
|
|
594 | |
|
|
595 | =item * Condition variables represent future values, or promises to deliver |
|
|
596 | some result, long before the result is available. |
|
|
597 | |
|
|
598 | =back |
578 | |
599 | |
579 | Condition variables are very useful to signal that something has finished, |
600 | Condition variables are very useful to signal that something has finished, |
580 | for example, if you write a module that does asynchronous http requests, |
601 | for example, if you write a module that does asynchronous http requests, |
581 | then a condition variable would be the ideal candidate to signal the |
602 | then a condition variable would be the ideal candidate to signal the |
582 | availability of results. The user can either act when the callback is |
603 | availability of results. The user can either act when the callback is |
… | |
… | |
595 | |
616 | |
596 | Condition variables are represented by hash refs in perl, and the keys |
617 | Condition variables are represented by hash refs in perl, and the keys |
597 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
618 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
598 | easy (it is often useful to build your own transaction class on top of |
619 | easy (it is often useful to build your own transaction class on top of |
599 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
620 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
600 | it's C<new> method in your own C<new> method. |
621 | its C<new> method in your own C<new> method. |
601 | |
622 | |
602 | There are two "sides" to a condition variable - the "producer side" which |
623 | There are two "sides" to a condition variable - the "producer side" which |
603 | eventually calls C<< -> send >>, and the "consumer side", which waits |
624 | eventually calls C<< -> send >>, and the "consumer side", which waits |
604 | for the send to occur. |
625 | for the send to occur. |
605 | |
626 | |
606 | Example: wait for a timer. |
627 | Example: wait for a timer. |
607 | |
628 | |
608 | # wait till the result is ready |
629 | # condition: "wait till the timer is fired" |
609 | my $result_ready = AnyEvent->condvar; |
630 | my $timer_fired = AnyEvent->condvar; |
610 | |
631 | |
611 | # do something such as adding a timer |
632 | # create the timer - we could wait for, say |
612 | # or socket watcher the calls $result_ready->send |
633 | # a handle becomign ready, or even an |
613 | # when the "result" is ready. |
634 | # AnyEvent::HTTP request to finish, but |
614 | # in this case, we simply use a timer: |
635 | # in this case, we simply use a timer: |
615 | my $w = AnyEvent->timer ( |
636 | my $w = AnyEvent->timer ( |
616 | after => 1, |
637 | after => 1, |
617 | cb => sub { $result_ready->send }, |
638 | cb => sub { $timer_fired->send }, |
618 | ); |
639 | ); |
619 | |
640 | |
620 | # this "blocks" (while handling events) till the callback |
641 | # this "blocks" (while handling events) till the callback |
621 | # calls ->send |
642 | # calls ->send |
622 | $result_ready->recv; |
643 | $timer_fired->recv; |
623 | |
644 | |
624 | Example: wait for a timer, but take advantage of the fact that condition |
645 | Example: wait for a timer, but take advantage of the fact that condition |
625 | variables are also callable directly. |
646 | variables are also callable directly. |
626 | |
647 | |
627 | my $done = AnyEvent->condvar; |
648 | my $done = AnyEvent->condvar; |
… | |
… | |
670 | they were a code reference). Calling them directly is the same as calling |
691 | they were a code reference). Calling them directly is the same as calling |
671 | C<send>. |
692 | C<send>. |
672 | |
693 | |
673 | =item $cv->croak ($error) |
694 | =item $cv->croak ($error) |
674 | |
695 | |
675 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
696 | Similar to send, but causes all calls to C<< ->recv >> to invoke |
676 | C<Carp::croak> with the given error message/object/scalar. |
697 | C<Carp::croak> with the given error message/object/scalar. |
677 | |
698 | |
678 | This can be used to signal any errors to the condition variable |
699 | This can be used to signal any errors to the condition variable |
679 | user/consumer. Doing it this way instead of calling C<croak> directly |
700 | user/consumer. Doing it this way instead of calling C<croak> directly |
680 | delays the error detetcion, but has the overwhelmign advantage that it |
701 | delays the error detection, but has the overwhelming advantage that it |
681 | diagnoses the error at the place where the result is expected, and not |
702 | diagnoses the error at the place where the result is expected, and not |
682 | deep in some event clalback without connection to the actual code causing |
703 | deep in some event callback with no connection to the actual code causing |
683 | the problem. |
704 | the problem. |
684 | |
705 | |
685 | =item $cv->begin ([group callback]) |
706 | =item $cv->begin ([group callback]) |
686 | |
707 | |
687 | =item $cv->end |
708 | =item $cv->end |
… | |
… | |
725 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
746 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
726 | sending. |
747 | sending. |
727 | |
748 | |
728 | The ping example mentioned above is slightly more complicated, as the |
749 | The ping example mentioned above is slightly more complicated, as the |
729 | there are results to be passwd back, and the number of tasks that are |
750 | there are results to be passwd back, and the number of tasks that are |
730 | begung can potentially be zero: |
751 | begun can potentially be zero: |
731 | |
752 | |
732 | my $cv = AnyEvent->condvar; |
753 | my $cv = AnyEvent->condvar; |
733 | |
754 | |
734 | my %result; |
755 | my %result; |
735 | $cv->begin (sub { shift->send (\%result) }); |
756 | $cv->begin (sub { shift->send (\%result) }); |
… | |
… | |
756 | to be called once the counter reaches C<0>, and second, it ensures that |
777 | to be called once the counter reaches C<0>, and second, it ensures that |
757 | C<send> is called even when C<no> hosts are being pinged (the loop |
778 | C<send> is called even when C<no> hosts are being pinged (the loop |
758 | doesn't execute once). |
779 | doesn't execute once). |
759 | |
780 | |
760 | This is the general pattern when you "fan out" into multiple (but |
781 | This is the general pattern when you "fan out" into multiple (but |
761 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
782 | potentially zero) subrequests: use an outer C<begin>/C<end> pair to set |
762 | the callback and ensure C<end> is called at least once, and then, for each |
783 | the callback and ensure C<end> is called at least once, and then, for each |
763 | subrequest you start, call C<begin> and for each subrequest you finish, |
784 | subrequest you start, call C<begin> and for each subrequest you finish, |
764 | call C<end>. |
785 | call C<end>. |
765 | |
786 | |
766 | =back |
787 | =back |
… | |
… | |
773 | =over 4 |
794 | =over 4 |
774 | |
795 | |
775 | =item $cv->recv |
796 | =item $cv->recv |
776 | |
797 | |
777 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
798 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
778 | >> methods have been called on c<$cv>, while servicing other watchers |
799 | >> methods have been called on C<$cv>, while servicing other watchers |
779 | normally. |
800 | normally. |
780 | |
801 | |
781 | You can only wait once on a condition - additional calls are valid but |
802 | You can only wait once on a condition - additional calls are valid but |
782 | will return immediately. |
803 | will return immediately. |
783 | |
804 | |
… | |
… | |
800 | caller decide whether the call will block or not (for example, by coupling |
821 | caller decide whether the call will block or not (for example, by coupling |
801 | condition variables with some kind of request results and supporting |
822 | condition variables with some kind of request results and supporting |
802 | callbacks so the caller knows that getting the result will not block, |
823 | callbacks so the caller knows that getting the result will not block, |
803 | while still supporting blocking waits if the caller so desires). |
824 | while still supporting blocking waits if the caller so desires). |
804 | |
825 | |
805 | You can ensure that C<< -recv >> never blocks by setting a callback and |
826 | You can ensure that C<< ->recv >> never blocks by setting a callback and |
806 | only calling C<< ->recv >> from within that callback (or at a later |
827 | only calling C<< ->recv >> from within that callback (or at a later |
807 | time). This will work even when the event loop does not support blocking |
828 | time). This will work even when the event loop does not support blocking |
808 | waits otherwise. |
829 | waits otherwise. |
809 | |
830 | |
810 | =item $bool = $cv->ready |
831 | =item $bool = $cv->ready |
… | |
… | |
815 | =item $cb = $cv->cb ($cb->($cv)) |
836 | =item $cb = $cv->cb ($cb->($cv)) |
816 | |
837 | |
817 | This is a mutator function that returns the callback set and optionally |
838 | This is a mutator function that returns the callback set and optionally |
818 | replaces it before doing so. |
839 | replaces it before doing so. |
819 | |
840 | |
820 | The callback will be called when the condition becomes (or already was) |
841 | The callback will be called when the condition becomes "true", i.e. when |
821 | "true", i.e. when C<send> or C<croak> are called (or were called), with |
842 | C<send> or C<croak> are called, with the only argument being the |
822 | the only argument being the condition variable itself. Calling C<recv> |
843 | condition variable itself. If the condition is already true, the |
|
|
844 | callback is called immediately when it is set. Calling C<recv> inside |
823 | inside the callback or at any later time is guaranteed not to block. |
845 | the callback or at any later time is guaranteed not to block. |
824 | |
846 | |
825 | =back |
847 | =back |
826 | |
848 | |
827 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
849 | =head1 SUPPORTED EVENT LOOPS/BACKENDS |
828 | |
850 | |
… | |
… | |
840 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
862 | AnyEvent::Impl::EV based on EV (interface to libev, best choice). |
841 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
863 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
842 | |
864 | |
843 | =item Backends that are transparently being picked up when they are used. |
865 | =item Backends that are transparently being picked up when they are used. |
844 | |
866 | |
845 | These will be used when they are currently loaded when the first watcher |
867 | These will be used if they are already loaded when the first watcher |
846 | is created, in which case it is assumed that the application is using |
868 | is created, in which case it is assumed that the application is using |
847 | them. This means that AnyEvent will automatically pick the right backend |
869 | them. This means that AnyEvent will automatically pick the right backend |
848 | when the main program loads an event module before anything starts to |
870 | when the main program loads an event module before anything starts to |
849 | create watchers. Nothing special needs to be done by the main program. |
871 | create watchers. Nothing special needs to be done by the main program. |
850 | |
872 | |
… | |
… | |
866 | |
888 | |
867 | Support for IO::Async can only be partial, as it is too broken and |
889 | Support for IO::Async can only be partial, as it is too broken and |
868 | architecturally limited to even support the AnyEvent API. It also |
890 | architecturally limited to even support the AnyEvent API. It also |
869 | is the only event loop that needs the loop to be set explicitly, so |
891 | is the only event loop that needs the loop to be set explicitly, so |
870 | it can only be used by a main program knowing about AnyEvent. See |
892 | it can only be used by a main program knowing about AnyEvent. See |
871 | L<AnyEvent::Impl::Async> for the gory details. |
893 | L<AnyEvent::Impl::IOAsync> for the gory details. |
872 | |
894 | |
873 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
895 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed. |
874 | |
896 | |
875 | =item Event loops that are indirectly supported via other backends. |
897 | =item Event loops that are indirectly supported via other backends. |
876 | |
898 | |
… | |
… | |
904 | Contains C<undef> until the first watcher is being created, before the |
926 | Contains C<undef> until the first watcher is being created, before the |
905 | backend has been autodetected. |
927 | backend has been autodetected. |
906 | |
928 | |
907 | Afterwards it contains the event model that is being used, which is the |
929 | Afterwards it contains the event model that is being used, which is the |
908 | name of the Perl class implementing the model. This class is usually one |
930 | name of the Perl class implementing the model. This class is usually one |
909 | of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the |
931 | of the C<AnyEvent::Impl::xxx> modules, but can be any other class in the |
910 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
932 | case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it |
911 | will be C<urxvt::anyevent>). |
933 | will be C<urxvt::anyevent>). |
912 | |
934 | |
913 | =item AnyEvent::detect |
935 | =item AnyEvent::detect |
914 | |
936 | |
915 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
937 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
916 | if necessary. You should only call this function right before you would |
938 | if necessary. You should only call this function right before you would |
917 | have created an AnyEvent watcher anyway, that is, as late as possible at |
939 | have created an AnyEvent watcher anyway, that is, as late as possible at |
918 | runtime, and not e.g. while initialising of your module. |
940 | runtime, and not e.g. during initialisation of your module. |
919 | |
941 | |
920 | If you need to do some initialisation before AnyEvent watchers are |
942 | If you need to do some initialisation before AnyEvent watchers are |
921 | created, use C<post_detect>. |
943 | created, use C<post_detect>. |
922 | |
944 | |
923 | =item $guard = AnyEvent::post_detect { BLOCK } |
945 | =item $guard = AnyEvent::post_detect { BLOCK } |
924 | |
946 | |
925 | Arranges for the code block to be executed as soon as the event model is |
947 | Arranges for the code block to be executed as soon as the event model is |
926 | autodetected (or immediately if this has already happened). |
948 | autodetected (or immediately if that has already happened). |
927 | |
949 | |
928 | The block will be executed I<after> the actual backend has been detected |
950 | The block will be executed I<after> the actual backend has been detected |
929 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
951 | (C<$AnyEvent::MODEL> is set), but I<before> any watchers have been |
930 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
952 | created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do |
931 | other initialisations - see the sources of L<AnyEvent::Strict> or |
953 | other initialisations - see the sources of L<AnyEvent::Strict> or |
… | |
… | |
940 | that automatically removes the callback again when it is destroyed (or |
962 | that automatically removes the callback again when it is destroyed (or |
941 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
963 | C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for |
942 | a case where this is useful. |
964 | a case where this is useful. |
943 | |
965 | |
944 | Example: Create a watcher for the IO::AIO module and store it in |
966 | Example: Create a watcher for the IO::AIO module and store it in |
945 | C<$WATCHER>. Only do so after the event loop is initialised, though. |
967 | C<$WATCHER>, but do so only do so after the event loop is initialised. |
946 | |
968 | |
947 | our WATCHER; |
969 | our WATCHER; |
948 | |
970 | |
949 | my $guard = AnyEvent::post_detect { |
971 | my $guard = AnyEvent::post_detect { |
950 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
972 | $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); |
… | |
… | |
958 | $WATCHER ||= $guard; |
980 | $WATCHER ||= $guard; |
959 | |
981 | |
960 | =item @AnyEvent::post_detect |
982 | =item @AnyEvent::post_detect |
961 | |
983 | |
962 | If there are any code references in this array (you can C<push> to it |
984 | If there are any code references in this array (you can C<push> to it |
963 | before or after loading AnyEvent), then they will called directly after |
985 | before or after loading AnyEvent), then they will be called directly |
964 | the event loop has been chosen. |
986 | after the event loop has been chosen. |
965 | |
987 | |
966 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
988 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
967 | if it is defined then the event loop has already been detected, and the |
989 | if it is defined then the event loop has already been detected, and the |
968 | array will be ignored. |
990 | array will be ignored. |
969 | |
991 | |
… | |
… | |
1005 | because it will stall the whole program, and the whole point of using |
1027 | because it will stall the whole program, and the whole point of using |
1006 | events is to stay interactive. |
1028 | events is to stay interactive. |
1007 | |
1029 | |
1008 | It is fine, however, to call C<< ->recv >> when the user of your module |
1030 | It is fine, however, to call C<< ->recv >> when the user of your module |
1009 | requests it (i.e. if you create a http request object ad have a method |
1031 | requests it (i.e. if you create a http request object ad have a method |
1010 | called C<results> that returns the results, it should call C<< ->recv >> |
1032 | called C<results> that returns the results, it may call C<< ->recv >> |
1011 | freely, as the user of your module knows what she is doing. always). |
1033 | freely, as the user of your module knows what she is doing. Always). |
1012 | |
1034 | |
1013 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
1035 | =head1 WHAT TO DO IN THE MAIN PROGRAM |
1014 | |
1036 | |
1015 | There will always be a single main program - the only place that should |
1037 | There will always be a single main program - the only place that should |
1016 | dictate which event model to use. |
1038 | dictate which event model to use. |
1017 | |
1039 | |
1018 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
1040 | If the program is not event-based, it need not do anything special, even |
1019 | do anything special (it does not need to be event-based) and let AnyEvent |
1041 | when it depends on a module that uses an AnyEvent. If the program itself |
1020 | decide which implementation to chose if some module relies on it. |
1042 | uses AnyEvent, but does not care which event loop is used, all it needs |
|
|
1043 | to do is C<use AnyEvent>. In either case, AnyEvent will choose the best |
|
|
1044 | available loop implementation. |
1021 | |
1045 | |
1022 | If the main program relies on a specific event model - for example, in |
1046 | If the main program relies on a specific event model - for example, in |
1023 | Gtk2 programs you have to rely on the Glib module - you should load the |
1047 | Gtk2 programs you have to rely on the Glib module - you should load the |
1024 | event module before loading AnyEvent or any module that uses it: generally |
1048 | event module before loading AnyEvent or any module that uses it: generally |
1025 | speaking, you should load it as early as possible. The reason is that |
1049 | speaking, you should load it as early as possible. The reason is that |
1026 | modules might create watchers when they are loaded, and AnyEvent will |
1050 | modules might create watchers when they are loaded, and AnyEvent will |
1027 | decide on the event model to use as soon as it creates watchers, and it |
1051 | decide on the event model to use as soon as it creates watchers, and it |
1028 | might chose the wrong one unless you load the correct one yourself. |
1052 | might choose the wrong one unless you load the correct one yourself. |
1029 | |
1053 | |
1030 | You can chose to use a pure-perl implementation by loading the |
1054 | You can chose to use a pure-perl implementation by loading the |
1031 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1055 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
1032 | everywhere, but letting AnyEvent chose the model is generally better. |
1056 | everywhere, but letting AnyEvent chose the model is generally better. |
1033 | |
1057 | |
… | |
… | |
1051 | =head1 OTHER MODULES |
1075 | =head1 OTHER MODULES |
1052 | |
1076 | |
1053 | The following is a non-exhaustive list of additional modules that use |
1077 | The following is a non-exhaustive list of additional modules that use |
1054 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1078 | AnyEvent as a client and can therefore be mixed easily with other AnyEvent |
1055 | modules and other event loops in the same program. Some of the modules |
1079 | modules and other event loops in the same program. Some of the modules |
1056 | come with AnyEvent, most are available via CPAN. |
1080 | come as part of AnyEvent, the others are available via CPAN. |
1057 | |
1081 | |
1058 | =over 4 |
1082 | =over 4 |
1059 | |
1083 | |
1060 | =item L<AnyEvent::Util> |
1084 | =item L<AnyEvent::Util> |
1061 | |
1085 | |
1062 | Contains various utility functions that replace often-used but blocking |
1086 | Contains various utility functions that replace often-used blocking |
1063 | functions such as C<inet_aton> by event-/callback-based versions. |
1087 | functions such as C<inet_aton> with event/callback-based versions. |
1064 | |
1088 | |
1065 | =item L<AnyEvent::Socket> |
1089 | =item L<AnyEvent::Socket> |
1066 | |
1090 | |
1067 | Provides various utility functions for (internet protocol) sockets, |
1091 | Provides various utility functions for (internet protocol) sockets, |
1068 | addresses and name resolution. Also functions to create non-blocking tcp |
1092 | addresses and name resolution. Also functions to create non-blocking tcp |
… | |
… | |
1070 | |
1094 | |
1071 | =item L<AnyEvent::Handle> |
1095 | =item L<AnyEvent::Handle> |
1072 | |
1096 | |
1073 | Provide read and write buffers, manages watchers for reads and writes, |
1097 | Provide read and write buffers, manages watchers for reads and writes, |
1074 | supports raw and formatted I/O, I/O queued and fully transparent and |
1098 | supports raw and formatted I/O, I/O queued and fully transparent and |
1075 | non-blocking SSL/TLS (via L<AnyEvent::TLS>. |
1099 | non-blocking SSL/TLS (via L<AnyEvent::TLS>). |
1076 | |
1100 | |
1077 | =item L<AnyEvent::DNS> |
1101 | =item L<AnyEvent::DNS> |
1078 | |
1102 | |
1079 | Provides rich asynchronous DNS resolver capabilities. |
1103 | Provides rich asynchronous DNS resolver capabilities. |
1080 | |
1104 | |
|
|
1105 | =item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> |
|
|
1106 | |
|
|
1107 | Implement event-based interfaces to the protocols of the same name (for |
|
|
1108 | the curious, IGS is the International Go Server and FCP is the Freenet |
|
|
1109 | Client Protocol). |
|
|
1110 | |
|
|
1111 | =item L<AnyEvent::Handle::UDP> |
|
|
1112 | |
|
|
1113 | Here be danger! |
|
|
1114 | |
|
|
1115 | As Pauli would put it, "Not only is it not right, it's not even wrong!" - |
|
|
1116 | there are so many things wrong with AnyEvent::Handle::UDP, most notably |
|
|
1117 | its use of a stream-based API with a protocol that isn't streamable, that |
|
|
1118 | the only way to improve it is to delete it. |
|
|
1119 | |
|
|
1120 | It features data corruption (but typically only under load) and general |
|
|
1121 | confusion. On top, the author is not only clueless about UDP but also |
|
|
1122 | fact-resistant - some gems of his understanding: "connect doesn't work |
|
|
1123 | with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not |
|
|
1124 | packets", "I don't need to implement proper error checking as UDP doesn't |
|
|
1125 | support error checking" and so on - he doesn't even understand what's |
|
|
1126 | wrong with his module when it is explained to him. |
|
|
1127 | |
1081 | =item L<AnyEvent::HTTP> |
1128 | =item L<AnyEvent::DBI> |
1082 | |
1129 | |
1083 | A simple-to-use HTTP library that is capable of making a lot of concurrent |
1130 | Executes L<DBI> requests asynchronously in a proxy process for you, |
1084 | HTTP requests. |
1131 | notifying you in an event-based way when the operation is finished. |
|
|
1132 | |
|
|
1133 | =item L<AnyEvent::AIO> |
|
|
1134 | |
|
|
1135 | Truly asynchronous (as opposed to non-blocking) I/O, should be in the |
|
|
1136 | toolbox of every event programmer. AnyEvent::AIO transparently fuses |
|
|
1137 | L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based |
|
|
1138 | file I/O, and much more. |
1085 | |
1139 | |
1086 | =item L<AnyEvent::HTTPD> |
1140 | =item L<AnyEvent::HTTPD> |
1087 | |
1141 | |
1088 | Provides a simple web application server framework. |
1142 | A simple embedded webserver. |
1089 | |
1143 | |
1090 | =item L<AnyEvent::FastPing> |
1144 | =item L<AnyEvent::FastPing> |
1091 | |
1145 | |
1092 | The fastest ping in the west. |
1146 | The fastest ping in the west. |
1093 | |
|
|
1094 | =item L<AnyEvent::DBI> |
|
|
1095 | |
|
|
1096 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
1097 | |
|
|
1098 | =item L<AnyEvent::AIO> |
|
|
1099 | |
|
|
1100 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
1101 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
1102 | together. |
|
|
1103 | |
|
|
1104 | =item L<AnyEvent::BDB> |
|
|
1105 | |
|
|
1106 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
1107 | L<BDB> and AnyEvent together. |
|
|
1108 | |
|
|
1109 | =item L<AnyEvent::GPSD> |
|
|
1110 | |
|
|
1111 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
1112 | |
|
|
1113 | =item L<AnyEvent::IRC> |
|
|
1114 | |
|
|
1115 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
|
|
1116 | |
|
|
1117 | =item L<AnyEvent::XMPP> |
|
|
1118 | |
|
|
1119 | AnyEvent based XMPP (Jabber protocol) module family (replacing the older |
|
|
1120 | Net::XMPP2>. |
|
|
1121 | |
|
|
1122 | =item L<AnyEvent::IGS> |
|
|
1123 | |
|
|
1124 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
1125 | L<App::IGS>). |
|
|
1126 | |
|
|
1127 | =item L<Net::FCP> |
|
|
1128 | |
|
|
1129 | AnyEvent-based implementation of the Freenet Client Protocol, birthplace |
|
|
1130 | of AnyEvent. |
|
|
1131 | |
|
|
1132 | =item L<Event::ExecFlow> |
|
|
1133 | |
|
|
1134 | High level API for event-based execution flow control. |
|
|
1135 | |
1147 | |
1136 | =item L<Coro> |
1148 | =item L<Coro> |
1137 | |
1149 | |
1138 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1150 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
1139 | |
1151 | |
… | |
… | |
1143 | |
1155 | |
1144 | package AnyEvent; |
1156 | package AnyEvent; |
1145 | |
1157 | |
1146 | # basically a tuned-down version of common::sense |
1158 | # basically a tuned-down version of common::sense |
1147 | sub common_sense { |
1159 | sub common_sense { |
1148 | # from common:.sense 1.0 |
1160 | # from common:.sense 3.3 |
1149 | ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00"; |
1161 | ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf3\x0f\xc0\xf0\xfc\x33\x00"; |
1150 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1162 | # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl) |
1151 | $^H |= 0x00000600; |
1163 | $^H |= 0x00000600; |
1152 | } |
1164 | } |
1153 | |
1165 | |
1154 | BEGIN { AnyEvent::common_sense } |
1166 | BEGIN { AnyEvent::common_sense } |
1155 | |
1167 | |
1156 | use Carp (); |
1168 | use Carp (); |
1157 | |
1169 | |
1158 | our $VERSION = '5.22'; |
1170 | our $VERSION = '5.271'; |
1159 | our $MODEL; |
1171 | our $MODEL; |
1160 | |
1172 | |
1161 | our $AUTOLOAD; |
1173 | our $AUTOLOAD; |
1162 | our @ISA; |
1174 | our @ISA; |
1163 | |
1175 | |
1164 | our @REGISTRY; |
1176 | our @REGISTRY; |
1165 | |
1177 | |
1166 | our $VERBOSE; |
1178 | our $VERBOSE; |
1167 | |
1179 | |
1168 | BEGIN { |
1180 | BEGIN { |
1169 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
1181 | require "AnyEvent/constants.pl"; |
|
|
1182 | |
1170 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
1183 | eval "sub TAINT (){" . (${^TAINT}*1) . "}"; |
1171 | |
1184 | |
1172 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1185 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
1173 | if ${^TAINT}; |
1186 | if ${^TAINT}; |
1174 | |
1187 | |
1175 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1188 | $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
… | |
… | |
1218 | our @post_detect; |
1231 | our @post_detect; |
1219 | |
1232 | |
1220 | sub post_detect(&) { |
1233 | sub post_detect(&) { |
1221 | my ($cb) = @_; |
1234 | my ($cb) = @_; |
1222 | |
1235 | |
1223 | if ($MODEL) { |
|
|
1224 | $cb->(); |
|
|
1225 | |
|
|
1226 | undef |
|
|
1227 | } else { |
|
|
1228 | push @post_detect, $cb; |
1236 | push @post_detect, $cb; |
1229 | |
1237 | |
1230 | defined wantarray |
1238 | defined wantarray |
1231 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1239 | ? bless \$cb, "AnyEvent::Util::postdetect" |
1232 | : () |
1240 | : () |
1233 | } |
|
|
1234 | } |
1241 | } |
1235 | |
1242 | |
1236 | sub AnyEvent::Util::postdetect::DESTROY { |
1243 | sub AnyEvent::Util::postdetect::DESTROY { |
1237 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1244 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1238 | } |
1245 | } |
1239 | |
1246 | |
1240 | sub detect() { |
1247 | sub detect() { |
|
|
1248 | # free some memory |
|
|
1249 | *detect = sub () { $MODEL }; |
|
|
1250 | |
|
|
1251 | local $!; # for good measure |
|
|
1252 | local $SIG{__DIE__}; |
|
|
1253 | |
|
|
1254 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
|
|
1255 | my $model = "AnyEvent::Impl::$1"; |
|
|
1256 | if (eval "require $model") { |
|
|
1257 | $MODEL = $model; |
|
|
1258 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
|
|
1259 | } else { |
|
|
1260 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
|
|
1261 | } |
|
|
1262 | } |
|
|
1263 | |
|
|
1264 | # check for already loaded models |
1241 | unless ($MODEL) { |
1265 | unless ($MODEL) { |
1242 | local $SIG{__DIE__}; |
1266 | for (@REGISTRY, @models) { |
1243 | |
1267 | my ($package, $model) = @$_; |
1244 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
1268 | if (${"$package\::VERSION"} > 0) { |
1245 | my $model = "AnyEvent::Impl::$1"; |
|
|
1246 | if (eval "require $model") { |
1269 | if (eval "require $model") { |
1247 | $MODEL = $model; |
1270 | $MODEL = $model; |
1248 | warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; |
1271 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1249 | } else { |
1272 | last; |
1250 | warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; |
1273 | } |
1251 | } |
1274 | } |
1252 | } |
1275 | } |
1253 | |
1276 | |
1254 | # check for already loaded models |
|
|
1255 | unless ($MODEL) { |
1277 | unless ($MODEL) { |
|
|
1278 | # try to autoload a model |
1256 | for (@REGISTRY, @models) { |
1279 | for (@REGISTRY, @models) { |
1257 | my ($package, $model) = @$_; |
1280 | my ($package, $model, $autoload) = @$_; |
|
|
1281 | if ( |
|
|
1282 | $autoload |
|
|
1283 | and eval "require $package" |
1258 | if (${"$package\::VERSION"} > 0) { |
1284 | and ${"$package\::VERSION"} > 0 |
1259 | if (eval "require $model") { |
1285 | and eval "require $model" |
|
|
1286 | ) { |
1260 | $MODEL = $model; |
1287 | $MODEL = $model; |
1261 | warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; |
1288 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
1262 | last; |
1289 | last; |
1263 | } |
|
|
1264 | } |
1290 | } |
1265 | } |
1291 | } |
1266 | |
1292 | |
1267 | unless ($MODEL) { |
|
|
1268 | # try to autoload a model |
|
|
1269 | for (@REGISTRY, @models) { |
|
|
1270 | my ($package, $model, $autoload) = @$_; |
|
|
1271 | if ( |
|
|
1272 | $autoload |
|
|
1273 | and eval "require $package" |
|
|
1274 | and ${"$package\::VERSION"} > 0 |
|
|
1275 | and eval "require $model" |
|
|
1276 | ) { |
|
|
1277 | $MODEL = $model; |
|
|
1278 | warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2; |
|
|
1279 | last; |
|
|
1280 | } |
|
|
1281 | } |
|
|
1282 | |
|
|
1283 | $MODEL |
1293 | $MODEL |
1284 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1294 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
1285 | } |
|
|
1286 | } |
1295 | } |
1287 | |
|
|
1288 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1289 | |
|
|
1290 | unshift @ISA, $MODEL; |
|
|
1291 | |
|
|
1292 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1293 | |
|
|
1294 | (shift @post_detect)->() while @post_detect; |
|
|
1295 | } |
1296 | } |
|
|
1297 | |
|
|
1298 | @models = (); # free probe data |
|
|
1299 | |
|
|
1300 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
1301 | unshift @ISA, $MODEL; |
|
|
1302 | |
|
|
1303 | # now nuke some methods that are overriden by the backend. |
|
|
1304 | # SUPER is not allowed. |
|
|
1305 | for (qw(time signal child idle)) { |
|
|
1306 | undef &{"AnyEvent::Base::$_"} |
|
|
1307 | if defined &{"$MODEL\::$_"}; |
|
|
1308 | } |
|
|
1309 | |
|
|
1310 | require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT}; |
|
|
1311 | |
|
|
1312 | (shift @post_detect)->() while @post_detect; |
|
|
1313 | |
|
|
1314 | *post_detect = sub(&) { |
|
|
1315 | shift->(); |
|
|
1316 | |
|
|
1317 | undef |
|
|
1318 | }; |
1296 | |
1319 | |
1297 | $MODEL |
1320 | $MODEL |
1298 | } |
1321 | } |
1299 | |
1322 | |
1300 | sub AUTOLOAD { |
1323 | sub AUTOLOAD { |
1301 | (my $func = $AUTOLOAD) =~ s/.*://; |
1324 | (my $func = $AUTOLOAD) =~ s/.*://; |
1302 | |
1325 | |
1303 | $method{$func} |
1326 | $method{$func} |
1304 | or Carp::croak "$func: not a valid method for AnyEvent objects"; |
1327 | or Carp::croak "$func: not a valid AnyEvent class method"; |
1305 | |
1328 | |
1306 | detect unless $MODEL; |
1329 | detect; |
1307 | |
1330 | |
1308 | my $class = shift; |
1331 | my $class = shift; |
1309 | $class->$func (@_); |
1332 | $class->$func (@_); |
1310 | } |
1333 | } |
1311 | |
1334 | |
… | |
… | |
1328 | |
1351 | |
1329 | =head1 SIMPLIFIED AE API |
1352 | =head1 SIMPLIFIED AE API |
1330 | |
1353 | |
1331 | Starting with version 5.0, AnyEvent officially supports a second, much |
1354 | Starting with version 5.0, AnyEvent officially supports a second, much |
1332 | simpler, API that is designed to reduce the calling, typing and memory |
1355 | simpler, API that is designed to reduce the calling, typing and memory |
1333 | overhead. |
1356 | overhead by using function call syntax and a fixed number of parameters. |
1334 | |
1357 | |
1335 | See the L<AE> manpage for details. |
1358 | See the L<AE> manpage for details. |
1336 | |
1359 | |
1337 | =cut |
1360 | =cut |
1338 | |
1361 | |
1339 | package AE; |
1362 | package AE; |
1340 | |
1363 | |
1341 | our $VERSION = $AnyEvent::VERSION; |
1364 | our $VERSION = $AnyEvent::VERSION; |
|
|
1365 | |
|
|
1366 | # fall back to the main API by default - backends and AnyEvent::Base |
|
|
1367 | # implementations can overwrite these. |
1342 | |
1368 | |
1343 | sub io($$$) { |
1369 | sub io($$$) { |
1344 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1370 | AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) |
1345 | } |
1371 | } |
1346 | |
1372 | |
… | |
… | |
1378 | |
1404 | |
1379 | package AnyEvent::Base; |
1405 | package AnyEvent::Base; |
1380 | |
1406 | |
1381 | # default implementations for many methods |
1407 | # default implementations for many methods |
1382 | |
1408 | |
1383 | sub _time() { |
1409 | sub time { |
|
|
1410 | eval q{ # poor man's autoloading {} |
1384 | # probe for availability of Time::HiRes |
1411 | # probe for availability of Time::HiRes |
1385 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1412 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1386 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1413 | warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; |
1387 | *_time = \&Time::HiRes::time; |
1414 | *AE::time = \&Time::HiRes::time; |
1388 | # if (eval "use POSIX (); (POSIX::times())... |
1415 | # if (eval "use POSIX (); (POSIX::times())... |
1389 | } else { |
1416 | } else { |
1390 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1417 | warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; |
1391 | *_time = sub { time }; # epic fail |
1418 | *AE::time = sub (){ time }; # epic fail |
|
|
1419 | } |
|
|
1420 | |
|
|
1421 | *time = sub { AE::time }; # different prototypes |
1392 | } |
1422 | }; |
|
|
1423 | die if $@; |
1393 | |
1424 | |
1394 | &_time |
1425 | &time |
1395 | } |
1426 | } |
1396 | |
1427 | |
1397 | sub time { _time } |
1428 | *now = \&time; |
1398 | sub now { _time } |
1429 | |
1399 | sub now_update { } |
1430 | sub now_update { } |
1400 | |
1431 | |
1401 | # default implementation for ->condvar |
1432 | # default implementation for ->condvar |
1402 | |
1433 | |
1403 | sub condvar { |
1434 | sub condvar { |
|
|
1435 | eval q{ # poor man's autoloading {} |
|
|
1436 | *condvar = sub { |
1404 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1437 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
|
|
1438 | }; |
|
|
1439 | |
|
|
1440 | *AE::cv = sub (;&) { |
|
|
1441 | bless { @_ ? (_ae_cb => shift) : () }, "AnyEvent::CondVar" |
|
|
1442 | }; |
|
|
1443 | }; |
|
|
1444 | die if $@; |
|
|
1445 | |
|
|
1446 | &condvar |
1405 | } |
1447 | } |
1406 | |
1448 | |
1407 | # default implementation for ->signal |
1449 | # default implementation for ->signal |
1408 | |
1450 | |
1409 | our $HAVE_ASYNC_INTERRUPT; |
1451 | our $HAVE_ASYNC_INTERRUPT; |
… | |
… | |
1418 | |
1460 | |
1419 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1461 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1420 | our (%SIG_ASY, %SIG_ASY_W); |
1462 | our (%SIG_ASY, %SIG_ASY_W); |
1421 | our ($SIG_COUNT, $SIG_TW); |
1463 | our ($SIG_COUNT, $SIG_TW); |
1422 | |
1464 | |
1423 | sub _signal_exec { |
|
|
1424 | $HAVE_ASYNC_INTERRUPT |
|
|
1425 | ? $SIGPIPE_R->drain |
|
|
1426 | : sysread $SIGPIPE_R, (my $dummy), 9; |
|
|
1427 | |
|
|
1428 | while (%SIG_EV) { |
|
|
1429 | for (keys %SIG_EV) { |
|
|
1430 | delete $SIG_EV{$_}; |
|
|
1431 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1432 | } |
|
|
1433 | } |
|
|
1434 | } |
|
|
1435 | |
|
|
1436 | # install a dummy wakeup watcher to reduce signal catching latency |
1465 | # install a dummy wakeup watcher to reduce signal catching latency |
|
|
1466 | # used by Impls |
1437 | sub _sig_add() { |
1467 | sub _sig_add() { |
1438 | unless ($SIG_COUNT++) { |
1468 | unless ($SIG_COUNT++) { |
1439 | # try to align timer on a full-second boundary, if possible |
1469 | # try to align timer on a full-second boundary, if possible |
1440 | my $NOW = AE::now; |
1470 | my $NOW = AE::now; |
1441 | |
1471 | |
… | |
… | |
1451 | undef $SIG_TW |
1481 | undef $SIG_TW |
1452 | unless --$SIG_COUNT; |
1482 | unless --$SIG_COUNT; |
1453 | } |
1483 | } |
1454 | |
1484 | |
1455 | our $_sig_name_init; $_sig_name_init = sub { |
1485 | our $_sig_name_init; $_sig_name_init = sub { |
1456 | eval q{ # poor man's autoloading |
1486 | eval q{ # poor man's autoloading {} |
1457 | undef $_sig_name_init; |
1487 | undef $_sig_name_init; |
1458 | |
1488 | |
1459 | if (_have_async_interrupt) { |
1489 | if (_have_async_interrupt) { |
1460 | *sig2num = \&Async::Interrupt::sig2num; |
1490 | *sig2num = \&Async::Interrupt::sig2num; |
1461 | *sig2name = \&Async::Interrupt::sig2name; |
1491 | *sig2name = \&Async::Interrupt::sig2name; |
… | |
… | |
1493 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1523 | $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; |
1494 | |
1524 | |
1495 | } else { |
1525 | } else { |
1496 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1526 | warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; |
1497 | |
1527 | |
1498 | require Fcntl; |
|
|
1499 | |
|
|
1500 | if (AnyEvent::WIN32) { |
1528 | if (AnyEvent::WIN32) { |
1501 | require AnyEvent::Util; |
1529 | require AnyEvent::Util; |
1502 | |
1530 | |
1503 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1531 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1504 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
1532 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R; |
1505 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
1533 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case |
1506 | } else { |
1534 | } else { |
1507 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1535 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1508 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1536 | fcntl $SIGPIPE_R, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_R; |
1509 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1537 | fcntl $SIGPIPE_W, AnyEvent::F_SETFL, AnyEvent::O_NONBLOCK if $SIGPIPE_W; # just in case |
1510 | |
1538 | |
1511 | # not strictly required, as $^F is normally 2, but let's make sure... |
1539 | # not strictly required, as $^F is normally 2, but let's make sure... |
1512 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1540 | fcntl $SIGPIPE_R, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
1513 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1541 | fcntl $SIGPIPE_W, AnyEvent::F_SETFD, AnyEvent::FD_CLOEXEC; |
1514 | } |
1542 | } |
1515 | |
1543 | |
1516 | $SIGPIPE_R |
1544 | $SIGPIPE_R |
1517 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1545 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1518 | |
1546 | |
1519 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
1547 | $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec; |
1520 | } |
1548 | } |
1521 | |
1549 | |
1522 | *signal = sub { |
1550 | *signal = $HAVE_ASYNC_INTERRUPT |
|
|
1551 | ? sub { |
1523 | my (undef, %arg) = @_; |
1552 | my (undef, %arg) = @_; |
1524 | |
1553 | |
1525 | my $signal = uc $arg{signal} |
|
|
1526 | or Carp::croak "required option 'signal' is missing"; |
|
|
1527 | |
|
|
1528 | if ($HAVE_ASYNC_INTERRUPT) { |
|
|
1529 | # async::interrupt |
1554 | # async::interrupt |
1530 | |
|
|
1531 | $signal = sig2num $signal; |
1555 | my $signal = sig2num $arg{signal}; |
1532 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1556 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1533 | |
1557 | |
1534 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1558 | $SIG_ASY{$signal} ||= new Async::Interrupt |
1535 | cb => sub { undef $SIG_EV{$signal} }, |
1559 | cb => sub { undef $SIG_EV{$signal} }, |
1536 | signal => $signal, |
1560 | signal => $signal, |
1537 | pipe => [$SIGPIPE_R->filenos], |
1561 | pipe => [$SIGPIPE_R->filenos], |
1538 | pipe_autodrain => 0, |
1562 | pipe_autodrain => 0, |
1539 | ; |
1563 | ; |
1540 | |
1564 | |
1541 | } else { |
1565 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1566 | } |
|
|
1567 | : sub { |
|
|
1568 | my (undef, %arg) = @_; |
|
|
1569 | |
1542 | # pure perl |
1570 | # pure perl |
1543 | |
|
|
1544 | # AE::Util has been loaded in signal |
|
|
1545 | $signal = sig2name $signal; |
1571 | my $signal = sig2name $arg{signal}; |
1546 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1572 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1547 | |
1573 | |
1548 | $SIG{$signal} ||= sub { |
1574 | $SIG{$signal} ||= sub { |
1549 | local $!; |
1575 | local $!; |
1550 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1576 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1551 | undef $SIG_EV{$signal}; |
1577 | undef $SIG_EV{$signal}; |
1552 | }; |
1578 | }; |
1553 | |
1579 | |
1554 | # can't do signal processing without introducing races in pure perl, |
1580 | # can't do signal processing without introducing races in pure perl, |
1555 | # so limit the signal latency. |
1581 | # so limit the signal latency. |
1556 | _sig_add; |
1582 | _sig_add; |
1557 | } |
|
|
1558 | |
1583 | |
1559 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1584 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
|
|
1585 | } |
1560 | }; |
1586 | ; |
1561 | |
1587 | |
1562 | *AnyEvent::Base::signal::DESTROY = sub { |
1588 | *AnyEvent::Base::signal::DESTROY = sub { |
1563 | my ($signal, $cb) = @{$_[0]}; |
1589 | my ($signal, $cb) = @{$_[0]}; |
1564 | |
1590 | |
1565 | _sig_del; |
1591 | _sig_del; |
… | |
… | |
1572 | # print weird messages, or just unconditionally exit |
1598 | # print weird messages, or just unconditionally exit |
1573 | # instead of getting the default action. |
1599 | # instead of getting the default action. |
1574 | undef $SIG{$signal} |
1600 | undef $SIG{$signal} |
1575 | unless keys %{ $SIG_CB{$signal} }; |
1601 | unless keys %{ $SIG_CB{$signal} }; |
1576 | }; |
1602 | }; |
|
|
1603 | |
|
|
1604 | *_signal_exec = sub { |
|
|
1605 | $HAVE_ASYNC_INTERRUPT |
|
|
1606 | ? $SIGPIPE_R->drain |
|
|
1607 | : sysread $SIGPIPE_R, (my $dummy), 9; |
|
|
1608 | |
|
|
1609 | while (%SIG_EV) { |
|
|
1610 | for (keys %SIG_EV) { |
|
|
1611 | delete $SIG_EV{$_}; |
|
|
1612 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1613 | } |
|
|
1614 | } |
|
|
1615 | }; |
1577 | }; |
1616 | }; |
1578 | die if $@; |
1617 | die if $@; |
|
|
1618 | |
1579 | &signal |
1619 | &signal |
1580 | } |
1620 | } |
1581 | |
1621 | |
1582 | # default implementation for ->child |
1622 | # default implementation for ->child |
1583 | |
1623 | |
1584 | our %PID_CB; |
1624 | our %PID_CB; |
1585 | our $CHLD_W; |
1625 | our $CHLD_W; |
1586 | our $CHLD_DELAY_W; |
1626 | our $CHLD_DELAY_W; |
1587 | our $WNOHANG; |
1627 | our $WNOHANG; |
1588 | |
1628 | |
|
|
1629 | # used by many Impl's |
1589 | sub _emit_childstatus($$) { |
1630 | sub _emit_childstatus($$) { |
1590 | my (undef, $rpid, $rstatus) = @_; |
1631 | my (undef, $rpid, $rstatus) = @_; |
1591 | |
1632 | |
1592 | $_->($rpid, $rstatus) |
1633 | $_->($rpid, $rstatus) |
1593 | for values %{ $PID_CB{$rpid} || {} }, |
1634 | for values %{ $PID_CB{$rpid} || {} }, |
1594 | values %{ $PID_CB{0} || {} }; |
1635 | values %{ $PID_CB{0} || {} }; |
1595 | } |
1636 | } |
1596 | |
1637 | |
1597 | sub _sigchld { |
|
|
1598 | my $pid; |
|
|
1599 | |
|
|
1600 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1601 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1602 | } |
|
|
1603 | |
|
|
1604 | sub child { |
1638 | sub child { |
|
|
1639 | eval q{ # poor man's autoloading {} |
|
|
1640 | *_sigchld = sub { |
|
|
1641 | my $pid; |
|
|
1642 | |
|
|
1643 | AnyEvent->_emit_childstatus ($pid, $?) |
|
|
1644 | while ($pid = waitpid -1, $WNOHANG) > 0; |
|
|
1645 | }; |
|
|
1646 | |
|
|
1647 | *child = sub { |
1605 | my (undef, %arg) = @_; |
1648 | my (undef, %arg) = @_; |
1606 | |
1649 | |
1607 | defined (my $pid = $arg{pid} + 0) |
1650 | defined (my $pid = $arg{pid} + 0) |
1608 | or Carp::croak "required option 'pid' is missing"; |
1651 | or Carp::croak "required option 'pid' is missing"; |
1609 | |
1652 | |
1610 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1653 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1611 | |
1654 | |
1612 | # WNOHANG is almost cetrainly 1 everywhere |
1655 | # WNOHANG is almost cetrainly 1 everywhere |
1613 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1656 | $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ |
1614 | ? 1 |
1657 | ? 1 |
1615 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1658 | : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1616 | |
1659 | |
1617 | unless ($CHLD_W) { |
1660 | unless ($CHLD_W) { |
1618 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1661 | $CHLD_W = AE::signal CHLD => \&_sigchld; |
1619 | # child could be a zombie already, so make at least one round |
1662 | # child could be a zombie already, so make at least one round |
1620 | &_sigchld; |
1663 | &_sigchld; |
1621 | } |
1664 | } |
1622 | |
1665 | |
1623 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1666 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1624 | } |
1667 | }; |
1625 | |
1668 | |
1626 | sub AnyEvent::Base::child::DESTROY { |
1669 | *AnyEvent::Base::child::DESTROY = sub { |
1627 | my ($pid, $cb) = @{$_[0]}; |
1670 | my ($pid, $cb) = @{$_[0]}; |
1628 | |
1671 | |
1629 | delete $PID_CB{$pid}{$cb}; |
1672 | delete $PID_CB{$pid}{$cb}; |
1630 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1673 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1631 | |
1674 | |
1632 | undef $CHLD_W unless keys %PID_CB; |
1675 | undef $CHLD_W unless keys %PID_CB; |
|
|
1676 | }; |
|
|
1677 | }; |
|
|
1678 | die if $@; |
|
|
1679 | |
|
|
1680 | &child |
1633 | } |
1681 | } |
1634 | |
1682 | |
1635 | # idle emulation is done by simply using a timer, regardless |
1683 | # idle emulation is done by simply using a timer, regardless |
1636 | # of whether the process is idle or not, and not letting |
1684 | # of whether the process is idle or not, and not letting |
1637 | # the callback use more than 50% of the time. |
1685 | # the callback use more than 50% of the time. |
1638 | sub idle { |
1686 | sub idle { |
|
|
1687 | eval q{ # poor man's autoloading {} |
|
|
1688 | *idle = sub { |
1639 | my (undef, %arg) = @_; |
1689 | my (undef, %arg) = @_; |
1640 | |
1690 | |
1641 | my ($cb, $w, $rcb) = $arg{cb}; |
1691 | my ($cb, $w, $rcb) = $arg{cb}; |
1642 | |
1692 | |
1643 | $rcb = sub { |
1693 | $rcb = sub { |
1644 | if ($cb) { |
1694 | if ($cb) { |
1645 | $w = _time; |
1695 | $w = _time; |
1646 | &$cb; |
1696 | &$cb; |
1647 | $w = _time - $w; |
1697 | $w = _time - $w; |
1648 | |
1698 | |
1649 | # never use more then 50% of the time for the idle watcher, |
1699 | # never use more then 50% of the time for the idle watcher, |
1650 | # within some limits |
1700 | # within some limits |
1651 | $w = 0.0001 if $w < 0.0001; |
1701 | $w = 0.0001 if $w < 0.0001; |
1652 | $w = 5 if $w > 5; |
1702 | $w = 5 if $w > 5; |
1653 | |
1703 | |
1654 | $w = AE::timer $w, 0, $rcb; |
1704 | $w = AE::timer $w, 0, $rcb; |
1655 | } else { |
1705 | } else { |
1656 | # clean up... |
1706 | # clean up... |
1657 | undef $w; |
1707 | undef $w; |
1658 | undef $rcb; |
1708 | undef $rcb; |
|
|
1709 | } |
|
|
1710 | }; |
|
|
1711 | |
|
|
1712 | $w = AE::timer 0.05, 0, $rcb; |
|
|
1713 | |
|
|
1714 | bless \\$cb, "AnyEvent::Base::idle" |
1659 | } |
1715 | }; |
|
|
1716 | |
|
|
1717 | *AnyEvent::Base::idle::DESTROY = sub { |
|
|
1718 | undef $${$_[0]}; |
|
|
1719 | }; |
1660 | }; |
1720 | }; |
|
|
1721 | die if $@; |
1661 | |
1722 | |
1662 | $w = AE::timer 0.05, 0, $rcb; |
1723 | &idle |
1663 | |
|
|
1664 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1665 | } |
|
|
1666 | |
|
|
1667 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1668 | undef $${$_[0]}; |
|
|
1669 | } |
1724 | } |
1670 | |
1725 | |
1671 | package AnyEvent::CondVar; |
1726 | package AnyEvent::CondVar; |
1672 | |
1727 | |
1673 | our @ISA = AnyEvent::CondVar::Base::; |
1728 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1800 | check the arguments passed to most method calls. If it finds any problems, |
1855 | check the arguments passed to most method calls. If it finds any problems, |
1801 | it will croak. |
1856 | it will croak. |
1802 | |
1857 | |
1803 | In other words, enables "strict" mode. |
1858 | In other words, enables "strict" mode. |
1804 | |
1859 | |
1805 | Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense> |
1860 | Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> |
1806 | >>, it is definitely recommended to keep it off in production. Keeping |
1861 | >>, it is definitely recommended to keep it off in production. Keeping |
1807 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1862 | C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs |
1808 | can be very useful, however. |
1863 | can be very useful, however. |
1809 | |
1864 | |
1810 | =item C<PERL_ANYEVENT_MODEL> |
1865 | =item C<PERL_ANYEVENT_MODEL> |
… | |
… | |
2032 | |
2087 | |
2033 | The actual code goes further and collects all errors (C<die>s, exceptions) |
2088 | The actual code goes further and collects all errors (C<die>s, exceptions) |
2034 | that occurred during request processing. The C<result> method detects |
2089 | that occurred during request processing. The C<result> method detects |
2035 | whether an exception as thrown (it is stored inside the $txn object) |
2090 | whether an exception as thrown (it is stored inside the $txn object) |
2036 | and just throws the exception, which means connection errors and other |
2091 | and just throws the exception, which means connection errors and other |
2037 | problems get reported tot he code that tries to use the result, not in a |
2092 | problems get reported to the code that tries to use the result, not in a |
2038 | random callback. |
2093 | random callback. |
2039 | |
2094 | |
2040 | All of this enables the following usage styles: |
2095 | All of this enables the following usage styles: |
2041 | |
2096 | |
2042 | 1. Blocking: |
2097 | 1. Blocking: |
… | |
… | |
2456 | unless defined $SIG{PIPE}; |
2511 | unless defined $SIG{PIPE}; |
2457 | |
2512 | |
2458 | =head1 RECOMMENDED/OPTIONAL MODULES |
2513 | =head1 RECOMMENDED/OPTIONAL MODULES |
2459 | |
2514 | |
2460 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
2515 | One of AnyEvent's main goals is to be 100% Pure-Perl(tm): only perl (and |
2461 | it's built-in modules) are required to use it. |
2516 | its built-in modules) are required to use it. |
2462 | |
2517 | |
2463 | That does not mean that AnyEvent won't take advantage of some additional |
2518 | That does not mean that AnyEvent won't take advantage of some additional |
2464 | modules if they are installed. |
2519 | modules if they are installed. |
2465 | |
2520 | |
2466 | This section explains which additional modules will be used, and how they |
2521 | This section explains which additional modules will be used, and how they |
… | |
… | |
2499 | automatic timer adjustments even when no monotonic clock is available, |
2554 | automatic timer adjustments even when no monotonic clock is available, |
2500 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
2555 | can take avdantage of advanced kernel interfaces such as C<epoll> and |
2501 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
2556 | C<kqueue>, and is the fastest backend I<by far>. You can even embed |
2502 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
2557 | L<Glib>/L<Gtk2> in it (or vice versa, see L<EV::Glib> and L<Glib::EV>). |
2503 | |
2558 | |
|
|
2559 | If you only use backends that rely on another event loop (e.g. C<Tk>), |
|
|
2560 | then this module will do nothing for you. |
|
|
2561 | |
2504 | =item L<Guard> |
2562 | =item L<Guard> |
2505 | |
2563 | |
2506 | The guard module, when used, will be used to implement |
2564 | The guard module, when used, will be used to implement |
2507 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
2565 | C<AnyEvent::Util::guard>. This speeds up guards considerably (and uses a |
2508 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2566 | lot less memory), but otherwise doesn't affect guard operation much. It is |
2509 | purely used for performance. |
2567 | purely used for performance. |
2510 | |
2568 | |
2511 | =item L<JSON> and L<JSON::XS> |
2569 | =item L<JSON> and L<JSON::XS> |
2512 | |
2570 | |
2513 | One of these modules is required when you want to read or write JSON data |
2571 | One of these modules is required when you want to read or write JSON data |
2514 | via L<AnyEvent::Handle>. It is also written in pure-perl, but can take |
2572 | via L<AnyEvent::Handle>. L<JSON> is also written in pure-perl, but can take |
2515 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2573 | advantage of the ultra-high-speed L<JSON::XS> module when it is installed. |
2516 | |
|
|
2517 | In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is |
|
|
2518 | installed. |
|
|
2519 | |
2574 | |
2520 | =item L<Net::SSLeay> |
2575 | =item L<Net::SSLeay> |
2521 | |
2576 | |
2522 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
2577 | Implementing TLS/SSL in Perl is certainly interesting, but not very |
2523 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
2578 | worthwhile: If this module is installed, then L<AnyEvent::Handle> (with |
2524 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
2579 | the help of L<AnyEvent::TLS>), gains the ability to do TLS/SSL. |
2525 | |
2580 | |
2526 | =item L<Time::HiRes> |
2581 | =item L<Time::HiRes> |
2527 | |
2582 | |
2528 | This module is part of perl since release 5.008. It will be used when the |
2583 | This module is part of perl since release 5.008. It will be used when the |
2529 | chosen event library does not come with a timing source on it's own. The |
2584 | chosen event library does not come with a timing source of its own. The |
2530 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2585 | pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to |
2531 | try to use a monotonic clock for timing stability. |
2586 | try to use a monotonic clock for timing stability. |
2532 | |
2587 | |
2533 | =back |
2588 | =back |
2534 | |
2589 | |
2535 | |
2590 | |
2536 | =head1 FORK |
2591 | =head1 FORK |
2537 | |
2592 | |
2538 | Most event libraries are not fork-safe. The ones who are usually are |
2593 | Most event libraries are not fork-safe. The ones who are usually are |
2539 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2594 | because they rely on inefficient but fork-safe C<select> or C<poll> calls |
2540 | calls. Only L<EV> is fully fork-aware. |
2595 | - higher performance APIs such as BSD's kqueue or the dreaded Linux epoll |
|
|
2596 | are usually badly thought-out hacks that are incompatible with fork in |
|
|
2597 | one way or another. Only L<EV> is fully fork-aware and ensures that you |
|
|
2598 | continue event-processing in both parent and child (or both, if you know |
|
|
2599 | what you are doing). |
2541 | |
2600 | |
2542 | This means that, in general, you cannot fork and do event processing |
2601 | This means that, in general, you cannot fork and do event processing in |
2543 | in the child if a watcher was created before the fork (which in turn |
2602 | the child if the event library was initialised before the fork (which |
2544 | initialises the event library). |
2603 | usually happens when the first AnyEvent watcher is created, or the library |
|
|
2604 | is loaded). |
2545 | |
2605 | |
2546 | If you have to fork, you must either do so I<before> creating your first |
2606 | If you have to fork, you must either do so I<before> creating your first |
2547 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2607 | watcher OR you must not use AnyEvent at all in the child OR you must do |
2548 | something completely out of the scope of AnyEvent. |
2608 | something completely out of the scope of AnyEvent. |
2549 | |
2609 | |
2550 | The problem of doing event processing in the parent I<and> the child |
2610 | The problem of doing event processing in the parent I<and> the child |
2551 | is much more complicated: even for backends that I<are> fork-aware or |
2611 | is much more complicated: even for backends that I<are> fork-aware or |
2552 | fork-safe, their behaviour is not usually what you want: fork clones all |
2612 | fork-safe, their behaviour is not usually what you want: fork clones all |
2553 | watchers, that means all timers, I/O watchers etc. are active in both |
2613 | watchers, that means all timers, I/O watchers etc. are active in both |
2554 | parent and child, which is almost never what you want. |
2614 | parent and child, which is almost never what you want. USing C<exec> |
|
|
2615 | to start worker children from some kind of manage rprocess is usually |
|
|
2616 | preferred, because it is much easier and cleaner, at the expense of having |
|
|
2617 | to have another binary. |
2555 | |
2618 | |
2556 | |
2619 | |
2557 | =head1 SECURITY CONSIDERATIONS |
2620 | =head1 SECURITY CONSIDERATIONS |
2558 | |
2621 | |
2559 | AnyEvent can be forced to load any event model via |
2622 | AnyEvent can be forced to load any event model via |