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