… | |
… | |
17 | }); |
17 | }); |
18 | |
18 | |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
19 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
20 | $w->send; # wake up current and all future recv's |
20 | $w->send; # wake up current and all future recv's |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
21 | $w->recv; # enters "main loop" till $condvar gets ->send |
|
|
22 | |
|
|
23 | =head1 INTRODUCTION/TUTORIAL |
|
|
24 | |
|
|
25 | This manpage is mainly a reference manual. If you are interested |
|
|
26 | in a tutorial or some gentle introduction, have a look at the |
|
|
27 | L<AnyEvent::Intro> manpage. |
22 | |
28 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
29 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
30 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
31 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
32 | nowadays. So what is different about AnyEvent? |
… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
54 | 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. |
55 | I<also> forced to use the same event loop you use. |
50 | |
56 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
57 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
52 | fine. AnyEvent + Tk works fine etc. etc. but none of these work together |
58 | 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 |
59 | 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, |
60 | 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 |
61 | 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 |
62 | 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 |
63 | 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). |
64 | event loops to AnyEvent, too, so it is future-proof). |
59 | |
65 | |
60 | In addition to being free of having to use I<the one and only true event |
66 | 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 |
67 | 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 |
68 | modules, you get an enormous 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 |
69 | 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 |
70 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
71 | technically possible. |
66 | |
72 | |
|
|
73 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
74 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
75 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
76 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
77 | platform bugs and differences. |
|
|
78 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
79 | Now, if you I<do 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 |
80 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
81 | model, you should I<not> use this module. |
70 | |
82 | |
71 | =head1 DESCRIPTION |
83 | =head1 DESCRIPTION |
72 | |
84 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
114 | 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... |
115 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
116 | |
105 | The pure-perl implementation of AnyEvent is called |
117 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
118 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
119 | explicitly and enjoy the high availability of that event loop :) |
108 | |
120 | |
109 | =head1 WATCHERS |
121 | =head1 WATCHERS |
110 | |
122 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
123 | AnyEvent has the central concept of a I<watcher>, which is an object that |
112 | stores relevant data for each kind of event you are waiting for, such as |
124 | stores relevant data for each kind of event you are waiting for, such as |
113 | the callback to call, the filehandle to watch, etc. |
125 | the callback to call, the file handle to watch, etc. |
114 | |
126 | |
115 | These watchers are normal Perl objects with normal Perl lifetime. After |
127 | These watchers are normal Perl objects with normal Perl lifetime. After |
116 | creating a watcher it will immediately "watch" for events and invoke the |
128 | 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 |
129 | callback when the event occurs (of course, only when the event model |
118 | is in control). |
130 | is in control). |
… | |
… | |
227 | timers. |
239 | timers. |
228 | |
240 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
241 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
242 | AnyEvent API. |
231 | |
243 | |
|
|
244 | AnyEvent has two additional methods that return the "current time": |
|
|
245 | |
|
|
246 | =over 4 |
|
|
247 | |
|
|
248 | =item AnyEvent->time |
|
|
249 | |
|
|
250 | This returns the "current wallclock time" as a fractional number of |
|
|
251 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
252 | return, and the result is guaranteed to be compatible with those). |
|
|
253 | |
|
|
254 | It progresses independently of any event loop processing, i.e. each call |
|
|
255 | will check the system clock, which usually gets updated frequently. |
|
|
256 | |
|
|
257 | =item AnyEvent->now |
|
|
258 | |
|
|
259 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
260 | this value might change only once per event loop iteration, depending on |
|
|
261 | the event loop (most return the same time as C<time>, above). This is the |
|
|
262 | time that AnyEvent's timers get scheduled against. |
|
|
263 | |
|
|
264 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
265 | function to call when you want to know the current time.> |
|
|
266 | |
|
|
267 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
268 | thus the preferred method if you want some timestamp (for example, |
|
|
269 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
270 | |
|
|
271 | The rest of this section is only of relevance if you try to be very exact |
|
|
272 | with your timing, you can skip it without bad conscience. |
|
|
273 | |
|
|
274 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
275 | and L<EV> and the following set-up: |
|
|
276 | |
|
|
277 | The event loop is running and has just invoked one of your callback at |
|
|
278 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
279 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
280 | second) and then (at time=501) you create a relative timer that fires |
|
|
281 | after three seconds. |
|
|
282 | |
|
|
283 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
284 | both return C<501>, because that is the current time, and the timer will |
|
|
285 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
286 | |
|
|
287 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
288 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
289 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
290 | to run at time=503 (C<500> + C<3>). |
|
|
291 | |
|
|
292 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
293 | regardless of any delays introduced by event processing. However, most |
|
|
294 | callbacks do not expect large delays in processing, so this causes a |
|
|
295 | higher drift (and a lot more system calls to get the current time). |
|
|
296 | |
|
|
297 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
298 | the same time, regardless of how long event processing actually took. |
|
|
299 | |
|
|
300 | In either case, if you care (and in most cases, you don't), then you |
|
|
301 | can get whatever behaviour you want with any event loop, by taking the |
|
|
302 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
303 | account. |
|
|
304 | |
|
|
305 | =back |
|
|
306 | |
232 | =head2 SIGNAL WATCHERS |
307 | =head2 SIGNAL WATCHERS |
233 | |
308 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
309 | You can watch for signals using a signal watcher, C<signal> is the signal |
235 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
310 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
236 | be invoked whenever a signal occurs. |
311 | be invoked whenever a signal occurs. |
237 | |
312 | |
238 | Although the callback might get passed parameters, their value and |
313 | Although the callback might get passed parameters, their value and |
239 | presence is undefined and you cannot rely on them. Portable AnyEvent |
314 | presence is undefined and you cannot rely on them. Portable AnyEvent |
240 | callbacks cannot use arguments passed to signal watcher callbacks. |
315 | callbacks cannot use arguments passed to signal watcher callbacks. |
241 | |
316 | |
242 | Multiple signal occurances can be clumped together into one callback |
317 | Multiple signal occurrences can be clumped together into one callback |
243 | invocation, and callback invocation will be synchronous. synchronous means |
318 | invocation, and callback invocation will be synchronous. Synchronous means |
244 | that it might take a while until the signal gets handled by the process, |
319 | that it might take a while until the signal gets handled by the process, |
245 | but it is guarenteed not to interrupt any other callbacks. |
320 | but it is guaranteed not to interrupt any other callbacks. |
246 | |
321 | |
247 | The main advantage of using these watchers is that you can share a signal |
322 | The main advantage of using these watchers is that you can share a signal |
248 | between multiple watchers. |
323 | between multiple watchers. |
249 | |
324 | |
250 | This watcher might use C<%SIG>, so programs overwriting those signals |
325 | This watcher might use C<%SIG>, so programs overwriting those signals |
… | |
… | |
310 | Condition variables can be created by calling the C<< AnyEvent->condvar |
385 | Condition variables can be created by calling the C<< AnyEvent->condvar |
311 | >> method, usually without arguments. The only argument pair allowed is |
386 | >> method, usually without arguments. The only argument pair allowed is |
312 | C<cb>, which specifies a callback to be called when the condition variable |
387 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
388 | becomes true. |
314 | |
389 | |
315 | After creation, the conditon variable is "false" until it becomes "true" |
390 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method. |
391 | by calling the C<send> method (or calling the condition variable as if it |
|
|
392 | were a callback, read about the caveats in the description for the C<< |
|
|
393 | ->send >> method). |
317 | |
394 | |
318 | Condition variables are similar to callbacks, except that you can |
395 | Condition variables are similar to callbacks, except that you can |
319 | optionally wait for them. They can also be called merge points - points |
396 | optionally wait for them. They can also be called merge points - points |
320 | in time where multiple outstandign events have been processed. And yet |
397 | in time where multiple outstanding events have been processed. And yet |
321 | another way to call them is transations - each condition variable can be |
398 | another way to call them is transactions - each condition variable can be |
322 | used to represent a transaction, which finishes at some point and delivers |
399 | used to represent a transaction, which finishes at some point and delivers |
323 | a result. |
400 | a result. |
324 | |
401 | |
325 | Condition variables are very useful to signal that something has finished, |
402 | Condition variables are very useful to signal that something has finished, |
326 | for example, if you write a module that does asynchronous http requests, |
403 | for example, if you write a module that does asynchronous http requests, |
… | |
… | |
332 | you can block your main program until an event occurs - for example, you |
409 | you can block your main program until an event occurs - for example, you |
333 | could C<< ->recv >> in your main program until the user clicks the Quit |
410 | could C<< ->recv >> in your main program until the user clicks the Quit |
334 | button of your app, which would C<< ->send >> the "quit" event. |
411 | button of your app, which would C<< ->send >> the "quit" event. |
335 | |
412 | |
336 | Note that condition variables recurse into the event loop - if you have |
413 | Note that condition variables recurse into the event loop - if you have |
337 | two pieces of code that call C<< ->recv >> in a round-robbin fashion, you |
414 | two pieces of code that call C<< ->recv >> in a round-robin fashion, you |
338 | lose. Therefore, condition variables are good to export to your caller, but |
415 | lose. Therefore, condition variables are good to export to your caller, but |
339 | you should avoid making a blocking wait yourself, at least in callbacks, |
416 | you should avoid making a blocking wait yourself, at least in callbacks, |
340 | as this asks for trouble. |
417 | as this asks for trouble. |
341 | |
418 | |
342 | Condition variables are represented by hash refs in perl, and the keys |
419 | Condition variables are represented by hash refs in perl, and the keys |
… | |
… | |
347 | |
424 | |
348 | There are two "sides" to a condition variable - the "producer side" which |
425 | There are two "sides" to a condition variable - the "producer side" which |
349 | eventually calls C<< -> send >>, and the "consumer side", which waits |
426 | eventually calls C<< -> send >>, and the "consumer side", which waits |
350 | for the send to occur. |
427 | for the send to occur. |
351 | |
428 | |
352 | Example: |
429 | Example: wait for a timer. |
353 | |
430 | |
354 | # wait till the result is ready |
431 | # wait till the result is ready |
355 | my $result_ready = AnyEvent->condvar; |
432 | my $result_ready = AnyEvent->condvar; |
356 | |
433 | |
357 | # do something such as adding a timer |
434 | # do something such as adding a timer |
… | |
… | |
365 | |
442 | |
366 | # this "blocks" (while handling events) till the callback |
443 | # this "blocks" (while handling events) till the callback |
367 | # calls send |
444 | # calls send |
368 | $result_ready->recv; |
445 | $result_ready->recv; |
369 | |
446 | |
|
|
447 | Example: wait for a timer, but take advantage of the fact that |
|
|
448 | condition variables are also code references. |
|
|
449 | |
|
|
450 | my $done = AnyEvent->condvar; |
|
|
451 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
452 | $done->recv; |
|
|
453 | |
370 | =head3 METHODS FOR PRODUCERS |
454 | =head3 METHODS FOR PRODUCERS |
371 | |
455 | |
372 | These methods should only be used by the producing side, i.e. the |
456 | These methods should only be used by the producing side, i.e. the |
373 | code/module that eventually sends the signal. Note that it is also |
457 | code/module that eventually sends the signal. Note that it is also |
374 | the producer side which creates the condvar in most cases, but it isn't |
458 | the producer side which creates the condvar in most cases, but it isn't |
… | |
… | |
385 | If a callback has been set on the condition variable, it is called |
469 | If a callback has been set on the condition variable, it is called |
386 | immediately from within send. |
470 | immediately from within send. |
387 | |
471 | |
388 | Any arguments passed to the C<send> call will be returned by all |
472 | Any arguments passed to the C<send> call will be returned by all |
389 | future C<< ->recv >> calls. |
473 | future C<< ->recv >> calls. |
|
|
474 | |
|
|
475 | Condition variables are overloaded so one can call them directly |
|
|
476 | (as a code reference). Calling them directly is the same as calling |
|
|
477 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
478 | overloading, so as tempting as it may be, passing a condition variable |
|
|
479 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
480 | support overloading, however, as well as all functions that use perl to |
|
|
481 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
482 | example). |
390 | |
483 | |
391 | =item $cv->croak ($error) |
484 | =item $cv->croak ($error) |
392 | |
485 | |
393 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
486 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
394 | C<Carp::croak> with the given error message/object/scalar. |
487 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
443 | doesn't execute once). |
536 | doesn't execute once). |
444 | |
537 | |
445 | This is the general pattern when you "fan out" into multiple subrequests: |
538 | This is the general pattern when you "fan out" into multiple subrequests: |
446 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
539 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
447 | is called at least once, and then, for each subrequest you start, call |
540 | is called at least once, and then, for each subrequest you start, call |
448 | C<begin> and for eahc subrequest you finish, call C<end>. |
541 | C<begin> and for each subrequest you finish, call C<end>. |
449 | |
542 | |
450 | =back |
543 | =back |
451 | |
544 | |
452 | =head3 METHODS FOR CONSUMERS |
545 | =head3 METHODS FOR CONSUMERS |
453 | |
546 | |
… | |
… | |
475 | (programs might want to do that to stay interactive), so I<if you are |
568 | (programs might want to do that to stay interactive), so I<if you are |
476 | using this from a module, never require a blocking wait>, but let the |
569 | using this from a module, never require a blocking wait>, but let the |
477 | caller decide whether the call will block or not (for example, by coupling |
570 | caller decide whether the call will block or not (for example, by coupling |
478 | condition variables with some kind of request results and supporting |
571 | condition variables with some kind of request results and supporting |
479 | callbacks so the caller knows that getting the result will not block, |
572 | callbacks so the caller knows that getting the result will not block, |
480 | while still suppporting blocking waits if the caller so desires). |
573 | while still supporting blocking waits if the caller so desires). |
481 | |
574 | |
482 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
575 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
483 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
576 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
577 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
485 | can supply. |
578 | can supply. |
… | |
… | |
601 | |
694 | |
602 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
695 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
603 | do anything special (it does not need to be event-based) and let AnyEvent |
696 | do anything special (it does not need to be event-based) and let AnyEvent |
604 | decide which implementation to chose if some module relies on it. |
697 | decide which implementation to chose if some module relies on it. |
605 | |
698 | |
606 | If the main program relies on a specific event model. For example, in |
699 | If the main program relies on a specific event model - for example, in |
607 | Gtk2 programs you have to rely on the Glib module. You should load the |
700 | Gtk2 programs you have to rely on the Glib module - you should load the |
608 | event module before loading AnyEvent or any module that uses it: generally |
701 | event module before loading AnyEvent or any module that uses it: generally |
609 | speaking, you should load it as early as possible. The reason is that |
702 | speaking, you should load it as early as possible. The reason is that |
610 | modules might create watchers when they are loaded, and AnyEvent will |
703 | modules might create watchers when they are loaded, and AnyEvent will |
611 | decide on the event model to use as soon as it creates watchers, and it |
704 | decide on the event model to use as soon as it creates watchers, and it |
612 | might chose the wrong one unless you load the correct one yourself. |
705 | might chose the wrong one unless you load the correct one yourself. |
613 | |
706 | |
614 | You can chose to use a rather inefficient pure-perl implementation by |
707 | You can chose to use a pure-perl implementation by loading the |
615 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
708 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
616 | behaviour everywhere, but letting AnyEvent chose is generally better. |
709 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
710 | |
|
|
711 | =head2 MAINLOOP EMULATION |
|
|
712 | |
|
|
713 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
714 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
715 | |
|
|
716 | In that case, you can use a condition variable like this: |
|
|
717 | |
|
|
718 | AnyEvent->condvar->recv; |
|
|
719 | |
|
|
720 | This has the effect of entering the event loop and looping forever. |
|
|
721 | |
|
|
722 | Note that usually your program has some exit condition, in which case |
|
|
723 | it is better to use the "traditional" approach of storing a condition |
|
|
724 | variable somewhere, waiting for it, and sending it when the program should |
|
|
725 | exit cleanly. |
|
|
726 | |
617 | |
727 | |
618 | =head1 OTHER MODULES |
728 | =head1 OTHER MODULES |
619 | |
729 | |
620 | The following is a non-exhaustive list of additional modules that use |
730 | The following is a non-exhaustive list of additional modules that use |
621 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
731 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
… | |
… | |
631 | |
741 | |
632 | =item L<AnyEvent::Handle> |
742 | =item L<AnyEvent::Handle> |
633 | |
743 | |
634 | Provide read and write buffers and manages watchers for reads and writes. |
744 | Provide read and write buffers and manages watchers for reads and writes. |
635 | |
745 | |
|
|
746 | =item L<AnyEvent::Socket> |
|
|
747 | |
|
|
748 | Provides various utility functions for (internet protocol) sockets, |
|
|
749 | addresses and name resolution. Also functions to create non-blocking tcp |
|
|
750 | connections or tcp servers, with IPv6 and SRV record support and more. |
|
|
751 | |
|
|
752 | =item L<AnyEvent::DNS> |
|
|
753 | |
|
|
754 | Provides rich asynchronous DNS resolver capabilities. |
|
|
755 | |
636 | =item L<AnyEvent::HTTPD> |
756 | =item L<AnyEvent::HTTPD> |
637 | |
757 | |
638 | Provides a simple web application server framework. |
758 | Provides a simple web application server framework. |
639 | |
|
|
640 | =item L<AnyEvent::DNS> |
|
|
641 | |
|
|
642 | Provides asynchronous DNS resolver capabilities, beyond what |
|
|
643 | L<AnyEvent::Util> offers. |
|
|
644 | |
759 | |
645 | =item L<AnyEvent::FastPing> |
760 | =item L<AnyEvent::FastPing> |
646 | |
761 | |
647 | The fastest ping in the west. |
762 | The fastest ping in the west. |
648 | |
763 | |
… | |
… | |
691 | no warnings; |
806 | no warnings; |
692 | use strict; |
807 | use strict; |
693 | |
808 | |
694 | use Carp; |
809 | use Carp; |
695 | |
810 | |
696 | our $VERSION = '3.6'; |
811 | our $VERSION = 4.11; |
697 | our $MODEL; |
812 | our $MODEL; |
698 | |
813 | |
699 | our $AUTOLOAD; |
814 | our $AUTOLOAD; |
700 | our @ISA; |
815 | our @ISA; |
701 | |
816 | |
|
|
817 | our @REGISTRY; |
|
|
818 | |
|
|
819 | our $WIN32; |
|
|
820 | |
|
|
821 | BEGIN { |
|
|
822 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
823 | eval "sub WIN32(){ $win32 }"; |
|
|
824 | } |
|
|
825 | |
702 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
826 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
703 | |
827 | |
704 | our @REGISTRY; |
828 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
|
|
829 | |
|
|
830 | { |
|
|
831 | my $idx; |
|
|
832 | $PROTOCOL{$_} = ++$idx |
|
|
833 | for reverse split /\s*,\s*/, |
|
|
834 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
|
|
835 | } |
705 | |
836 | |
706 | my @models = ( |
837 | my @models = ( |
707 | [EV:: => AnyEvent::Impl::EV::], |
838 | [EV:: => AnyEvent::Impl::EV::], |
708 | [Event:: => AnyEvent::Impl::Event::], |
839 | [Event:: => AnyEvent::Impl::Event::], |
709 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
710 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
711 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
712 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
840 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
713 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
841 | # everything below here will not be autoprobed |
714 | [Glib:: => AnyEvent::Impl::Glib::], |
842 | # as the pureperl backend should work everywhere |
|
|
843 | # and is usually faster |
|
|
844 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
845 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
715 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
846 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
716 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
847 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
717 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
848 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
849 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
850 | [Prima:: => AnyEvent::Impl::POE::], |
718 | ); |
851 | ); |
719 | |
852 | |
720 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
853 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
721 | |
854 | |
722 | our @post_detect; |
855 | our @post_detect; |
723 | |
856 | |
724 | sub post_detect(&) { |
857 | sub post_detect(&) { |
725 | my ($cb) = @_; |
858 | my ($cb) = @_; |
… | |
… | |
742 | } |
875 | } |
743 | |
876 | |
744 | sub detect() { |
877 | sub detect() { |
745 | unless ($MODEL) { |
878 | unless ($MODEL) { |
746 | no strict 'refs'; |
879 | no strict 'refs'; |
|
|
880 | local $SIG{__DIE__}; |
747 | |
881 | |
748 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
882 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
749 | my $model = "AnyEvent::Impl::$1"; |
883 | my $model = "AnyEvent::Impl::$1"; |
750 | if (eval "require $model") { |
884 | if (eval "require $model") { |
751 | $MODEL = $model; |
885 | $MODEL = $model; |
… | |
… | |
808 | $class->$func (@_); |
942 | $class->$func (@_); |
809 | } |
943 | } |
810 | |
944 | |
811 | package AnyEvent::Base; |
945 | package AnyEvent::Base; |
812 | |
946 | |
|
|
947 | # default implementation for now and time |
|
|
948 | |
|
|
949 | use Time::HiRes (); |
|
|
950 | |
|
|
951 | sub time { Time::HiRes::time } |
|
|
952 | sub now { Time::HiRes::time } |
|
|
953 | |
813 | # default implementation for ->condvar |
954 | # default implementation for ->condvar |
814 | |
955 | |
815 | sub condvar { |
956 | sub condvar { |
816 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
957 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
817 | } |
958 | } |
… | |
… | |
874 | or Carp::croak "required option 'pid' is missing"; |
1015 | or Carp::croak "required option 'pid' is missing"; |
875 | |
1016 | |
876 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1017 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
877 | |
1018 | |
878 | unless ($WNOHANG) { |
1019 | unless ($WNOHANG) { |
879 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1020 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
880 | } |
1021 | } |
881 | |
1022 | |
882 | unless ($CHLD_W) { |
1023 | unless ($CHLD_W) { |
883 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1024 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
884 | # child could be a zombie already, so make at least one round |
1025 | # child could be a zombie already, so make at least one round |
… | |
… | |
900 | package AnyEvent::CondVar; |
1041 | package AnyEvent::CondVar; |
901 | |
1042 | |
902 | our @ISA = AnyEvent::CondVar::Base::; |
1043 | our @ISA = AnyEvent::CondVar::Base::; |
903 | |
1044 | |
904 | package AnyEvent::CondVar::Base; |
1045 | package AnyEvent::CondVar::Base; |
|
|
1046 | |
|
|
1047 | use overload |
|
|
1048 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
1049 | fallback => 1; |
905 | |
1050 | |
906 | sub _send { |
1051 | sub _send { |
907 | # nop |
1052 | # nop |
908 | } |
1053 | } |
909 | |
1054 | |
… | |
… | |
1016 | model it chooses. |
1161 | model it chooses. |
1017 | |
1162 | |
1018 | =item C<PERL_ANYEVENT_MODEL> |
1163 | =item C<PERL_ANYEVENT_MODEL> |
1019 | |
1164 | |
1020 | This can be used to specify the event model to be used by AnyEvent, before |
1165 | This can be used to specify the event model to be used by AnyEvent, before |
1021 | autodetection and -probing kicks in. It must be a string consisting |
1166 | auto detection and -probing kicks in. It must be a string consisting |
1022 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1167 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1023 | and the resulting module name is loaded and if the load was successful, |
1168 | and the resulting module name is loaded and if the load was successful, |
1024 | used as event model. If it fails to load AnyEvent will proceed with |
1169 | used as event model. If it fails to load AnyEvent will proceed with |
1025 | autodetection and -probing. |
1170 | auto detection and -probing. |
1026 | |
1171 | |
1027 | This functionality might change in future versions. |
1172 | This functionality might change in future versions. |
1028 | |
1173 | |
1029 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1174 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1030 | could start your program like this: |
1175 | could start your program like this: |
1031 | |
1176 | |
1032 | PERL_ANYEVENT_MODEL=Perl perl ... |
1177 | PERL_ANYEVENT_MODEL=Perl perl ... |
|
|
1178 | |
|
|
1179 | =item C<PERL_ANYEVENT_PROTOCOLS> |
|
|
1180 | |
|
|
1181 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
|
|
1182 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
|
|
1183 | of auto probing). |
|
|
1184 | |
|
|
1185 | Must be set to a comma-separated list of protocols or address families, |
|
|
1186 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
|
|
1187 | used, and preference will be given to protocols mentioned earlier in the |
|
|
1188 | list. |
|
|
1189 | |
|
|
1190 | This variable can effectively be used for denial-of-service attacks |
|
|
1191 | against local programs (e.g. when setuid), although the impact is likely |
|
|
1192 | small, as the program has to handle connection errors already- |
|
|
1193 | |
|
|
1194 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
|
|
1195 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
|
|
1196 | - only support IPv4, never try to resolve or contact IPv6 |
|
|
1197 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
|
|
1198 | IPv6, but prefer IPv6 over IPv4. |
|
|
1199 | |
|
|
1200 | =item C<PERL_ANYEVENT_EDNS0> |
|
|
1201 | |
|
|
1202 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
|
|
1203 | for DNS. This extension is generally useful to reduce DNS traffic, but |
|
|
1204 | some (broken) firewalls drop such DNS packets, which is why it is off by |
|
|
1205 | default. |
|
|
1206 | |
|
|
1207 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
|
|
1208 | EDNS0 in its DNS requests. |
|
|
1209 | |
|
|
1210 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1211 | |
|
|
1212 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1213 | will create in parallel. |
1033 | |
1214 | |
1034 | =back |
1215 | =back |
1035 | |
1216 | |
1036 | =head1 EXAMPLE PROGRAM |
1217 | =head1 EXAMPLE PROGRAM |
1037 | |
1218 | |
… | |
… | |
1123 | syswrite $txn->{fh}, $txn->{request} |
1304 | syswrite $txn->{fh}, $txn->{request} |
1124 | or die "connection or write error"; |
1305 | or die "connection or write error"; |
1125 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1306 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1126 | |
1307 | |
1127 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1308 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1128 | result and signals any possible waiters that the request ahs finished: |
1309 | result and signals any possible waiters that the request has finished: |
1129 | |
1310 | |
1130 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1311 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1131 | |
1312 | |
1132 | if (end-of-file or data complete) { |
1313 | if (end-of-file or data complete) { |
1133 | $txn->{result} = $txn->{buf}; |
1314 | $txn->{result} = $txn->{buf}; |
… | |
… | |
1141 | |
1322 | |
1142 | $txn->{finished}->recv; |
1323 | $txn->{finished}->recv; |
1143 | return $txn->{result}; |
1324 | return $txn->{result}; |
1144 | |
1325 | |
1145 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1326 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1146 | that occured during request processing. The C<result> method detects |
1327 | that occurred during request processing. The C<result> method detects |
1147 | whether an exception as thrown (it is stored inside the $txn object) |
1328 | whether an exception as thrown (it is stored inside the $txn object) |
1148 | and just throws the exception, which means connection errors and other |
1329 | and just throws the exception, which means connection errors and other |
1149 | problems get reported tot he code that tries to use the result, not in a |
1330 | problems get reported tot he code that tries to use the result, not in a |
1150 | random callback. |
1331 | random callback. |
1151 | |
1332 | |
… | |
… | |
1197 | of various event loops I prepared some benchmarks. |
1378 | of various event loops I prepared some benchmarks. |
1198 | |
1379 | |
1199 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1380 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1200 | |
1381 | |
1201 | Here is a benchmark of various supported event models used natively and |
1382 | Here is a benchmark of various supported event models used natively and |
1202 | through anyevent. The benchmark creates a lot of timers (with a zero |
1383 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1203 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1384 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1204 | which it is), lets them fire exactly once and destroys them again. |
1385 | which it is), lets them fire exactly once and destroys them again. |
1205 | |
1386 | |
1206 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1387 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1207 | distribution. |
1388 | distribution. |
… | |
… | |
1330 | |
1511 | |
1331 | =back |
1512 | =back |
1332 | |
1513 | |
1333 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1514 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1334 | |
1515 | |
1335 | This benchmark atcually benchmarks the event loop itself. It works by |
1516 | This benchmark actually benchmarks the event loop itself. It works by |
1336 | creating a number of "servers": each server consists of a socketpair, a |
1517 | creating a number of "servers": each server consists of a socket pair, a |
1337 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1518 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1338 | watcher waiting for input on one side of the socket. Each time the socket |
1519 | watcher waiting for input on one side of the socket. Each time the socket |
1339 | watcher reads a byte it will write that byte to a random other "server". |
1520 | watcher reads a byte it will write that byte to a random other "server". |
1340 | |
1521 | |
1341 | The effect is that there will be a lot of I/O watchers, only part of which |
1522 | The effect is that there will be a lot of I/O watchers, only part of which |
1342 | are active at any one point (so there is a constant number of active |
1523 | are active at any one point (so there is a constant number of active |
1343 | fds for each loop iterstaion, but which fds these are is random). The |
1524 | fds for each loop iteration, but which fds these are is random). The |
1344 | timeout is reset each time something is read because that reflects how |
1525 | timeout is reset each time something is read because that reflects how |
1345 | most timeouts work (and puts extra pressure on the event loops). |
1526 | most timeouts work (and puts extra pressure on the event loops). |
1346 | |
1527 | |
1347 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 |
1528 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1348 | (1%) are active. This mirrors the activity of large servers with many |
1529 | (1%) are active. This mirrors the activity of large servers with many |
1349 | connections, most of which are idle at any one point in time. |
1530 | connections, most of which are idle at any one point in time. |
1350 | |
1531 | |
1351 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1532 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1352 | distribution. |
1533 | distribution. |
… | |
… | |
1354 | =head3 Explanation of the columns |
1535 | =head3 Explanation of the columns |
1355 | |
1536 | |
1356 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1537 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1357 | each server has a read and write socket end). |
1538 | each server has a read and write socket end). |
1358 | |
1539 | |
1359 | I<create> is the time it takes to create a socketpair (which is |
1540 | I<create> is the time it takes to create a socket pair (which is |
1360 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1541 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1361 | |
1542 | |
1362 | I<request>, the most important value, is the time it takes to handle a |
1543 | I<request>, the most important value, is the time it takes to handle a |
1363 | single "request", that is, reading the token from the pipe and forwarding |
1544 | single "request", that is, reading the token from the pipe and forwarding |
1364 | it to another server. This includes deleting the old timeout and creating |
1545 | it to another server. This includes deleting the old timeout and creating |
… | |
… | |
1437 | speed most when you have lots of watchers, not when you only have a few of |
1618 | speed most when you have lots of watchers, not when you only have a few of |
1438 | them). |
1619 | them). |
1439 | |
1620 | |
1440 | EV is again fastest. |
1621 | EV is again fastest. |
1441 | |
1622 | |
1442 | Perl again comes second. It is noticably faster than the C-based event |
1623 | Perl again comes second. It is noticeably faster than the C-based event |
1443 | loops Event and Glib, although the difference is too small to really |
1624 | loops Event and Glib, although the difference is too small to really |
1444 | matter. |
1625 | matter. |
1445 | |
1626 | |
1446 | POE also performs much better in this case, but is is still far behind the |
1627 | POE also performs much better in this case, but is is still far behind the |
1447 | others. |
1628 | others. |
… | |
… | |
1487 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1668 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1488 | |
1669 | |
1489 | |
1670 | |
1490 | =head1 SEE ALSO |
1671 | =head1 SEE ALSO |
1491 | |
1672 | |
|
|
1673 | Utility functions: L<AnyEvent::Util>. |
|
|
1674 | |
1492 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1675 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1493 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1676 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1494 | |
1677 | |
1495 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1678 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1496 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1679 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1497 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1680 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1498 | L<AnyEvent::Impl::POE>. |
1681 | L<AnyEvent::Impl::POE>. |
1499 | |
1682 | |
|
|
1683 | Non-blocking file handles, sockets, TCP clients and |
|
|
1684 | servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>. |
|
|
1685 | |
1500 | Asynchronous DNS: L<AnyEvent::DNS>. |
1686 | Asynchronous DNS: L<AnyEvent::DNS>. |
1501 | |
1687 | |
1502 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1688 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1503 | |
1689 | |
1504 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
1690 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. |
1505 | |
1691 | |
1506 | |
1692 | |
1507 | =head1 AUTHOR |
1693 | =head1 AUTHOR |
1508 | |
1694 | |
1509 | Marc Lehmann <schmorp@schmorp.de> |
1695 | Marc Lehmann <schmorp@schmorp.de> |