… | |
… | |
48 | isn't itself. What's worse, all the potential users of your module are |
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. |
49 | I<also> forced to use the same event loop you use. |
50 | |
50 | |
51 | AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works |
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 |
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 |
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, |
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 |
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 |
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 |
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). |
58 | event loops to AnyEvent, too, so it is future-proof). |
59 | |
59 | |
60 | In addition to being free of having to use I<the one and only true event |
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 |
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 |
62 | 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 |
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 |
64 | offering the functionality that is necessary, in as thin as a wrapper as |
65 | technically possible. |
65 | technically possible. |
66 | |
66 | |
|
|
67 | Of course, AnyEvent comes with a big (and fully optional!) toolbox |
|
|
68 | of useful functionality, such as an asynchronous DNS resolver, 100% |
|
|
69 | non-blocking connects (even with TLS/SSL, IPv6 and on broken platforms |
|
|
70 | such as Windows) and lots of real-world knowledge and workarounds for |
|
|
71 | platform bugs and differences. |
|
|
72 | |
67 | Of course, if you want lots of policy (this can arguably be somewhat |
73 | 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 |
74 | useful) and you want to force your users to use the one and only event |
69 | model, you should I<not> use this module. |
75 | model, you should I<not> use this module. |
70 | |
76 | |
71 | =head1 DESCRIPTION |
77 | =head1 DESCRIPTION |
72 | |
78 | |
… | |
… | |
102 | starts using it, all bets are off. Maybe you should tell their authors to |
108 | 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... |
109 | use AnyEvent so their modules work together with others seamlessly... |
104 | |
110 | |
105 | The pure-perl implementation of AnyEvent is called |
111 | The pure-perl implementation of AnyEvent is called |
106 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
112 | C<AnyEvent::Impl::Perl>. Like other event modules you can load it |
107 | explicitly. |
113 | explicitly and enjoy the high availability of that event loop :) |
108 | |
114 | |
109 | =head1 WATCHERS |
115 | =head1 WATCHERS |
110 | |
116 | |
111 | AnyEvent has the central concept of a I<watcher>, which is an object that |
117 | 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 |
118 | stores relevant data for each kind of event you are waiting for, such as |
113 | the callback to call, the filehandle to watch, etc. |
119 | the callback to call, the file handle to watch, etc. |
114 | |
120 | |
115 | These watchers are normal Perl objects with normal Perl lifetime. After |
121 | These watchers are normal Perl objects with normal Perl lifetime. After |
116 | creating a watcher it will immediately "watch" for events and invoke the |
122 | 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 |
123 | callback when the event occurs (of course, only when the event model |
118 | is in control). |
124 | is in control). |
… | |
… | |
227 | timers. |
233 | timers. |
228 | |
234 | |
229 | AnyEvent always prefers relative timers, if available, matching the |
235 | AnyEvent always prefers relative timers, if available, matching the |
230 | AnyEvent API. |
236 | AnyEvent API. |
231 | |
237 | |
|
|
238 | AnyEvent has two additional methods that return the "current time": |
|
|
239 | |
|
|
240 | =over 4 |
|
|
241 | |
|
|
242 | =item AnyEvent->time |
|
|
243 | |
|
|
244 | This returns the "current wallclock time" as a fractional number of |
|
|
245 | seconds since the Epoch (the same thing as C<time> or C<Time::HiRes::time> |
|
|
246 | return, and the result is guaranteed to be compatible with those). |
|
|
247 | |
|
|
248 | It progresses independently of any event loop processing, i.e. each call |
|
|
249 | will check the system clock, which usually gets updated frequently. |
|
|
250 | |
|
|
251 | =item AnyEvent->now |
|
|
252 | |
|
|
253 | This also returns the "current wallclock time", but unlike C<time>, above, |
|
|
254 | this value might change only once per event loop iteration, depending on |
|
|
255 | the event loop (most return the same time as C<time>, above). This is the |
|
|
256 | time that AnyEvent's timers get scheduled against. |
|
|
257 | |
|
|
258 | I<In almost all cases (in all cases if you don't care), this is the |
|
|
259 | function to call when you want to know the current time.> |
|
|
260 | |
|
|
261 | This function is also often faster then C<< AnyEvent->time >>, and |
|
|
262 | thus the preferred method if you want some timestamp (for example, |
|
|
263 | L<AnyEvent::Handle> uses this to update it's activity timeouts). |
|
|
264 | |
|
|
265 | The rest of this section is only of relevance if you try to be very exact |
|
|
266 | with your timing, you can skip it without bad conscience. |
|
|
267 | |
|
|
268 | For a practical example of when these times differ, consider L<Event::Lib> |
|
|
269 | and L<EV> and the following set-up: |
|
|
270 | |
|
|
271 | The event loop is running and has just invoked one of your callback at |
|
|
272 | time=500 (assume no other callbacks delay processing). In your callback, |
|
|
273 | you wait a second by executing C<sleep 1> (blocking the process for a |
|
|
274 | second) and then (at time=501) you create a relative timer that fires |
|
|
275 | after three seconds. |
|
|
276 | |
|
|
277 | With L<Event::Lib>, C<< AnyEvent->time >> and C<< AnyEvent->now >> will |
|
|
278 | both return C<501>, because that is the current time, and the timer will |
|
|
279 | be scheduled to fire at time=504 (C<501> + C<3>). |
|
|
280 | |
|
|
281 | With L<EV>, C<< AnyEvent->time >> returns C<501> (as that is the current |
|
|
282 | time), but C<< AnyEvent->now >> returns C<500>, as that is the time the |
|
|
283 | last event processing phase started. With L<EV>, your timer gets scheduled |
|
|
284 | to run at time=503 (C<500> + C<3>). |
|
|
285 | |
|
|
286 | In one sense, L<Event::Lib> is more exact, as it uses the current time |
|
|
287 | regardless of any delays introduced by event processing. However, most |
|
|
288 | callbacks do not expect large delays in processing, so this causes a |
|
|
289 | higher drift (and a lot more system calls to get the current time). |
|
|
290 | |
|
|
291 | In another sense, L<EV> is more exact, as your timer will be scheduled at |
|
|
292 | the same time, regardless of how long event processing actually took. |
|
|
293 | |
|
|
294 | In either case, if you care (and in most cases, you don't), then you |
|
|
295 | can get whatever behaviour you want with any event loop, by taking the |
|
|
296 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
|
|
297 | account. |
|
|
298 | |
|
|
299 | =back |
|
|
300 | |
232 | =head2 SIGNAL WATCHERS |
301 | =head2 SIGNAL WATCHERS |
233 | |
302 | |
234 | You can watch for signals using a signal watcher, C<signal> is the signal |
303 | 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 |
304 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
236 | be invoked whenever a signal occurs. |
305 | be invoked whenever a signal occurs. |
237 | |
306 | |
238 | Although the callback might get passed parameters, their value and |
307 | Although the callback might get passed parameters, their value and |
239 | presence is undefined and you cannot rely on them. Portable AnyEvent |
308 | presence is undefined and you cannot rely on them. Portable AnyEvent |
240 | callbacks cannot use arguments passed to signal watcher callbacks. |
309 | callbacks cannot use arguments passed to signal watcher callbacks. |
241 | |
310 | |
242 | Multiple signal occurances can be clumped together into one callback |
311 | Multiple signal occurrences can be clumped together into one callback |
243 | invocation, and callback invocation will be synchronous. synchronous means |
312 | invocation, and callback invocation will be synchronous. Synchronous means |
244 | that it might take a while until the signal gets handled by the process, |
313 | 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. |
314 | but it is guaranteed not to interrupt any other callbacks. |
246 | |
315 | |
247 | The main advantage of using these watchers is that you can share a signal |
316 | The main advantage of using these watchers is that you can share a signal |
248 | between multiple watchers. |
317 | between multiple watchers. |
249 | |
318 | |
250 | This watcher might use C<%SIG>, so programs overwriting those signals |
319 | This watcher might use C<%SIG>, so programs overwriting those signals |
… | |
… | |
310 | Condition variables can be created by calling the C<< AnyEvent->condvar |
379 | Condition variables can be created by calling the C<< AnyEvent->condvar |
311 | >> method, usually without arguments. The only argument pair allowed is |
380 | >> method, usually without arguments. The only argument pair allowed is |
312 | C<cb>, which specifies a callback to be called when the condition variable |
381 | C<cb>, which specifies a callback to be called when the condition variable |
313 | becomes true. |
382 | becomes true. |
314 | |
383 | |
315 | After creation, the conditon variable is "false" until it becomes "true" |
384 | After creation, the condition variable is "false" until it becomes "true" |
316 | by calling the C<send> method. |
385 | by calling the C<send> method (or calling the condition variable as if it |
|
|
386 | were a callback, read about the caveats in the description for the C<< |
|
|
387 | ->send >> method). |
317 | |
388 | |
318 | Condition variables are similar to callbacks, except that you can |
389 | Condition variables are similar to callbacks, except that you can |
319 | optionally wait for them. They can also be called merge points - points |
390 | optionally wait for them. They can also be called merge points - points |
320 | in time where multiple outstandign events have been processed. And yet |
391 | in time where multiple outstanding events have been processed. And yet |
321 | another way to call them is transations - each condition variable can be |
392 | 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 |
393 | used to represent a transaction, which finishes at some point and delivers |
323 | a result. |
394 | a result. |
324 | |
395 | |
325 | Condition variables are very useful to signal that something has finished, |
396 | Condition variables are very useful to signal that something has finished, |
326 | for example, if you write a module that does asynchronous http requests, |
397 | 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 |
403 | 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 |
404 | 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. |
405 | button of your app, which would C<< ->send >> the "quit" event. |
335 | |
406 | |
336 | Note that condition variables recurse into the event loop - if you have |
407 | 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 |
408 | 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 |
409 | 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, |
410 | you should avoid making a blocking wait yourself, at least in callbacks, |
340 | as this asks for trouble. |
411 | as this asks for trouble. |
341 | |
412 | |
342 | Condition variables are represented by hash refs in perl, and the keys |
413 | Condition variables are represented by hash refs in perl, and the keys |
… | |
… | |
347 | |
418 | |
348 | There are two "sides" to a condition variable - the "producer side" which |
419 | There are two "sides" to a condition variable - the "producer side" which |
349 | eventually calls C<< -> send >>, and the "consumer side", which waits |
420 | eventually calls C<< -> send >>, and the "consumer side", which waits |
350 | for the send to occur. |
421 | for the send to occur. |
351 | |
422 | |
352 | Example: |
423 | Example: wait for a timer. |
353 | |
424 | |
354 | # wait till the result is ready |
425 | # wait till the result is ready |
355 | my $result_ready = AnyEvent->condvar; |
426 | my $result_ready = AnyEvent->condvar; |
356 | |
427 | |
357 | # do something such as adding a timer |
428 | # do something such as adding a timer |
… | |
… | |
365 | |
436 | |
366 | # this "blocks" (while handling events) till the callback |
437 | # this "blocks" (while handling events) till the callback |
367 | # calls send |
438 | # calls send |
368 | $result_ready->recv; |
439 | $result_ready->recv; |
369 | |
440 | |
|
|
441 | Example: wait for a timer, but take advantage of the fact that |
|
|
442 | condition variables are also code references. |
|
|
443 | |
|
|
444 | my $done = AnyEvent->condvar; |
|
|
445 | my $delay = AnyEvent->timer (after => 5, cb => $done); |
|
|
446 | $done->recv; |
|
|
447 | |
370 | =head3 METHODS FOR PRODUCERS |
448 | =head3 METHODS FOR PRODUCERS |
371 | |
449 | |
372 | These methods should only be used by the producing side, i.e. the |
450 | 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 |
451 | 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 |
452 | 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 |
463 | If a callback has been set on the condition variable, it is called |
386 | immediately from within send. |
464 | immediately from within send. |
387 | |
465 | |
388 | Any arguments passed to the C<send> call will be returned by all |
466 | Any arguments passed to the C<send> call will be returned by all |
389 | future C<< ->recv >> calls. |
467 | future C<< ->recv >> calls. |
|
|
468 | |
|
|
469 | Condition variables are overloaded so one can call them directly |
|
|
470 | (as a code reference). Calling them directly is the same as calling |
|
|
471 | C<send>. Note, however, that many C-based event loops do not handle |
|
|
472 | overloading, so as tempting as it may be, passing a condition variable |
|
|
473 | instead of a callback does not work. Both the pure perl and EV loops |
|
|
474 | support overloading, however, as well as all functions that use perl to |
|
|
475 | invoke a callback (as in L<AnyEvent::Socket> and L<AnyEvent::DNS> for |
|
|
476 | example). |
390 | |
477 | |
391 | =item $cv->croak ($error) |
478 | =item $cv->croak ($error) |
392 | |
479 | |
393 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
480 | Similar to send, but causes all call's to C<< ->recv >> to invoke |
394 | C<Carp::croak> with the given error message/object/scalar. |
481 | C<Carp::croak> with the given error message/object/scalar. |
… | |
… | |
443 | doesn't execute once). |
530 | doesn't execute once). |
444 | |
531 | |
445 | This is the general pattern when you "fan out" into multiple subrequests: |
532 | 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> |
533 | 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 |
534 | 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>. |
535 | C<begin> and for each subrequest you finish, call C<end>. |
449 | |
536 | |
450 | =back |
537 | =back |
451 | |
538 | |
452 | =head3 METHODS FOR CONSUMERS |
539 | =head3 METHODS FOR CONSUMERS |
453 | |
540 | |
… | |
… | |
475 | (programs might want to do that to stay interactive), so I<if you are |
562 | (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 |
563 | 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 |
564 | caller decide whether the call will block or not (for example, by coupling |
478 | condition variables with some kind of request results and supporting |
565 | condition variables with some kind of request results and supporting |
479 | callbacks so the caller knows that getting the result will not block, |
566 | callbacks so the caller knows that getting the result will not block, |
480 | while still suppporting blocking waits if the caller so desires). |
567 | while still supporting blocking waits if the caller so desires). |
481 | |
568 | |
482 | Another reason I<never> to C<< ->recv >> in a module is that you cannot |
569 | 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 |
570 | sensibly have two C<< ->recv >>'s in parallel, as that would require |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
571 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
485 | can supply. |
572 | can supply. |
… | |
… | |
601 | |
688 | |
602 | If it doesn't care, it can just "use AnyEvent" and use it itself, or not |
689 | 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 |
690 | 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. |
691 | decide which implementation to chose if some module relies on it. |
605 | |
692 | |
606 | If the main program relies on a specific event model. For example, in |
693 | 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 |
694 | 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 |
695 | 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 |
696 | 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 |
697 | 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 |
698 | 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. |
699 | might chose the wrong one unless you load the correct one yourself. |
613 | |
700 | |
614 | You can chose to use a rather inefficient pure-perl implementation by |
701 | You can chose to use a pure-perl implementation by loading the |
615 | loading the C<AnyEvent::Impl::Perl> module, which gives you similar |
702 | C<AnyEvent::Impl::Perl> module, which gives you similar behaviour |
616 | behaviour everywhere, but letting AnyEvent chose is generally better. |
703 | everywhere, but letting AnyEvent chose the model is generally better. |
|
|
704 | |
|
|
705 | =head2 MAINLOOP EMULATION |
|
|
706 | |
|
|
707 | Sometimes (often for short test scripts, or even standalone programs who |
|
|
708 | only want to use AnyEvent), you do not want to run a specific event loop. |
|
|
709 | |
|
|
710 | In that case, you can use a condition variable like this: |
|
|
711 | |
|
|
712 | AnyEvent->condvar->recv; |
|
|
713 | |
|
|
714 | This has the effect of entering the event loop and looping forever. |
|
|
715 | |
|
|
716 | Note that usually your program has some exit condition, in which case |
|
|
717 | it is better to use the "traditional" approach of storing a condition |
|
|
718 | variable somewhere, waiting for it, and sending it when the program should |
|
|
719 | exit cleanly. |
|
|
720 | |
617 | |
721 | |
618 | =head1 OTHER MODULES |
722 | =head1 OTHER MODULES |
619 | |
723 | |
620 | The following is a non-exhaustive list of additional modules that use |
724 | The following is a non-exhaustive list of additional modules that use |
621 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
725 | AnyEvent and can therefore be mixed easily with other AnyEvent modules |
… | |
… | |
637 | |
741 | |
638 | Provides various utility functions for (internet protocol) sockets, |
742 | Provides various utility functions for (internet protocol) sockets, |
639 | addresses and name resolution. Also functions to create non-blocking tcp |
743 | addresses and name resolution. Also functions to create non-blocking tcp |
640 | connections or tcp servers, with IPv6 and SRV record support and more. |
744 | connections or tcp servers, with IPv6 and SRV record support and more. |
641 | |
745 | |
|
|
746 | =item L<AnyEvent::DNS> |
|
|
747 | |
|
|
748 | Provides rich asynchronous DNS resolver capabilities. |
|
|
749 | |
642 | =item L<AnyEvent::HTTPD> |
750 | =item L<AnyEvent::HTTPD> |
643 | |
751 | |
644 | Provides a simple web application server framework. |
752 | Provides a simple web application server framework. |
645 | |
|
|
646 | =item L<AnyEvent::DNS> |
|
|
647 | |
|
|
648 | Provides rich asynchronous DNS resolver capabilities. |
|
|
649 | |
753 | |
650 | =item L<AnyEvent::FastPing> |
754 | =item L<AnyEvent::FastPing> |
651 | |
755 | |
652 | The fastest ping in the west. |
756 | The fastest ping in the west. |
653 | |
757 | |
… | |
… | |
696 | no warnings; |
800 | no warnings; |
697 | use strict; |
801 | use strict; |
698 | |
802 | |
699 | use Carp; |
803 | use Carp; |
700 | |
804 | |
701 | our $VERSION = '3.6'; |
805 | our $VERSION = '4.1'; |
702 | our $MODEL; |
806 | our $MODEL; |
703 | |
807 | |
704 | our $AUTOLOAD; |
808 | our $AUTOLOAD; |
705 | our @ISA; |
809 | our @ISA; |
706 | |
810 | |
|
|
811 | our @REGISTRY; |
|
|
812 | |
|
|
813 | our $WIN32; |
|
|
814 | |
|
|
815 | BEGIN { |
|
|
816 | my $win32 = ! ! ($^O =~ /mswin32/i); |
|
|
817 | eval "sub WIN32(){ $win32 }"; |
|
|
818 | } |
|
|
819 | |
707 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
820 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
708 | |
821 | |
709 | our @REGISTRY; |
822 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
710 | |
|
|
711 | our %PROTOCOL; # (ipv4|ipv6) => (1|2) |
|
|
712 | |
823 | |
713 | { |
824 | { |
714 | my $idx; |
825 | my $idx; |
715 | $PROTOCOL{$_} = ++$idx |
826 | $PROTOCOL{$_} = ++$idx |
|
|
827 | for reverse split /\s*,\s*/, |
716 | for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
828 | $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; |
717 | } |
829 | } |
718 | |
830 | |
719 | my @models = ( |
831 | my @models = ( |
720 | [EV:: => AnyEvent::Impl::EV::], |
832 | [EV:: => AnyEvent::Impl::EV::], |
721 | [Event:: => AnyEvent::Impl::Event::], |
833 | [Event:: => AnyEvent::Impl::Event::], |
722 | [Tk:: => AnyEvent::Impl::Tk::], |
|
|
723 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
724 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
725 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
834 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
726 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
835 | # everything below here will not be autoprobed |
727 | [Glib:: => AnyEvent::Impl::Glib::], |
836 | # as the pureperl backend should work everywhere |
|
|
837 | # and is usually faster |
|
|
838 | [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles |
|
|
839 | [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers |
728 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
840 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
729 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
841 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
730 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
842 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
|
|
843 | [Wx:: => AnyEvent::Impl::POE::], |
|
|
844 | [Prima:: => AnyEvent::Impl::POE::], |
731 | ); |
845 | ); |
732 | |
846 | |
733 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
847 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
734 | |
848 | |
735 | our @post_detect; |
849 | our @post_detect; |
736 | |
850 | |
737 | sub post_detect(&) { |
851 | sub post_detect(&) { |
738 | my ($cb) = @_; |
852 | my ($cb) = @_; |
… | |
… | |
755 | } |
869 | } |
756 | |
870 | |
757 | sub detect() { |
871 | sub detect() { |
758 | unless ($MODEL) { |
872 | unless ($MODEL) { |
759 | no strict 'refs'; |
873 | no strict 'refs'; |
|
|
874 | local $SIG{__DIE__}; |
760 | |
875 | |
761 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
876 | if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { |
762 | my $model = "AnyEvent::Impl::$1"; |
877 | my $model = "AnyEvent::Impl::$1"; |
763 | if (eval "require $model") { |
878 | if (eval "require $model") { |
764 | $MODEL = $model; |
879 | $MODEL = $model; |
… | |
… | |
821 | $class->$func (@_); |
936 | $class->$func (@_); |
822 | } |
937 | } |
823 | |
938 | |
824 | package AnyEvent::Base; |
939 | package AnyEvent::Base; |
825 | |
940 | |
|
|
941 | # default implementation for now and time |
|
|
942 | |
|
|
943 | use Time::HiRes (); |
|
|
944 | |
|
|
945 | sub time { Time::HiRes::time } |
|
|
946 | sub now { Time::HiRes::time } |
|
|
947 | |
826 | # default implementation for ->condvar |
948 | # default implementation for ->condvar |
827 | |
949 | |
828 | sub condvar { |
950 | sub condvar { |
829 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
951 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
830 | } |
952 | } |
… | |
… | |
887 | or Carp::croak "required option 'pid' is missing"; |
1009 | or Carp::croak "required option 'pid' is missing"; |
888 | |
1010 | |
889 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1011 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
890 | |
1012 | |
891 | unless ($WNOHANG) { |
1013 | unless ($WNOHANG) { |
892 | $WNOHANG = eval { require POSIX; &POSIX::WNOHANG } || 1; |
1014 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
893 | } |
1015 | } |
894 | |
1016 | |
895 | unless ($CHLD_W) { |
1017 | unless ($CHLD_W) { |
896 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1018 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
897 | # child could be a zombie already, so make at least one round |
1019 | # child could be a zombie already, so make at least one round |
… | |
… | |
913 | package AnyEvent::CondVar; |
1035 | package AnyEvent::CondVar; |
914 | |
1036 | |
915 | our @ISA = AnyEvent::CondVar::Base::; |
1037 | our @ISA = AnyEvent::CondVar::Base::; |
916 | |
1038 | |
917 | package AnyEvent::CondVar::Base; |
1039 | package AnyEvent::CondVar::Base; |
|
|
1040 | |
|
|
1041 | use overload |
|
|
1042 | '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, |
|
|
1043 | fallback => 1; |
918 | |
1044 | |
919 | sub _send { |
1045 | sub _send { |
920 | # nop |
1046 | # nop |
921 | } |
1047 | } |
922 | |
1048 | |
… | |
… | |
1029 | model it chooses. |
1155 | model it chooses. |
1030 | |
1156 | |
1031 | =item C<PERL_ANYEVENT_MODEL> |
1157 | =item C<PERL_ANYEVENT_MODEL> |
1032 | |
1158 | |
1033 | This can be used to specify the event model to be used by AnyEvent, before |
1159 | This can be used to specify the event model to be used by AnyEvent, before |
1034 | autodetection and -probing kicks in. It must be a string consisting |
1160 | auto detection and -probing kicks in. It must be a string consisting |
1035 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1161 | entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended |
1036 | and the resulting module name is loaded and if the load was successful, |
1162 | and the resulting module name is loaded and if the load was successful, |
1037 | used as event model. If it fails to load AnyEvent will proceed with |
1163 | used as event model. If it fails to load AnyEvent will proceed with |
1038 | autodetection and -probing. |
1164 | auto detection and -probing. |
1039 | |
1165 | |
1040 | This functionality might change in future versions. |
1166 | This functionality might change in future versions. |
1041 | |
1167 | |
1042 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1168 | For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you |
1043 | could start your program like this: |
1169 | could start your program like this: |
… | |
… | |
1046 | |
1172 | |
1047 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1173 | =item C<PERL_ANYEVENT_PROTOCOLS> |
1048 | |
1174 | |
1049 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1175 | Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences |
1050 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1176 | for IPv4 or IPv6. The default is unspecified (and might change, or be the result |
1051 | of autoprobing). |
1177 | of auto probing). |
1052 | |
1178 | |
1053 | Must be set to a comma-separated list of protocols or address families, |
1179 | Must be set to a comma-separated list of protocols or address families, |
1054 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
1180 | current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be |
1055 | used, and preference will be given to protocols mentioned earlier in the |
1181 | used, and preference will be given to protocols mentioned earlier in the |
1056 | list. |
1182 | list. |
… | |
… | |
1060 | small, as the program has to handle connection errors already- |
1186 | small, as the program has to handle connection errors already- |
1061 | |
1187 | |
1062 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1188 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1063 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1189 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1064 | - only support IPv4, never try to resolve or contact IPv6 |
1190 | - only support IPv4, never try to resolve or contact IPv6 |
1065 | addressses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1191 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1066 | IPv6, but prefer IPv6 over IPv4. |
1192 | IPv6, but prefer IPv6 over IPv4. |
1067 | |
1193 | |
1068 | =item C<PERL_ANYEVENT_EDNS0> |
1194 | =item C<PERL_ANYEVENT_EDNS0> |
1069 | |
1195 | |
1070 | Used by L<AnyEvent::DNS> to decide wether to use the EDNS0 extension |
1196 | Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension |
1071 | for DNS. This extension is generally useful to reduce DNS traffic, but |
1197 | for DNS. This extension is generally useful to reduce DNS traffic, but |
1072 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1198 | some (broken) firewalls drop such DNS packets, which is why it is off by |
1073 | default. |
1199 | default. |
1074 | |
1200 | |
1075 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1201 | Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce |
1076 | EDNS0 in its DNS requests. |
1202 | EDNS0 in its DNS requests. |
|
|
1203 | |
|
|
1204 | =item C<PERL_ANYEVENT_MAX_FORKS> |
|
|
1205 | |
|
|
1206 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
|
|
1207 | will create in parallel. |
1077 | |
1208 | |
1078 | =back |
1209 | =back |
1079 | |
1210 | |
1080 | =head1 EXAMPLE PROGRAM |
1211 | =head1 EXAMPLE PROGRAM |
1081 | |
1212 | |
… | |
… | |
1167 | syswrite $txn->{fh}, $txn->{request} |
1298 | syswrite $txn->{fh}, $txn->{request} |
1168 | or die "connection or write error"; |
1299 | or die "connection or write error"; |
1169 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1300 | $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); |
1170 | |
1301 | |
1171 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1302 | Again, C<fh_ready_r> waits till all data has arrived, and then stores the |
1172 | result and signals any possible waiters that the request ahs finished: |
1303 | result and signals any possible waiters that the request has finished: |
1173 | |
1304 | |
1174 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1305 | sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; |
1175 | |
1306 | |
1176 | if (end-of-file or data complete) { |
1307 | if (end-of-file or data complete) { |
1177 | $txn->{result} = $txn->{buf}; |
1308 | $txn->{result} = $txn->{buf}; |
… | |
… | |
1185 | |
1316 | |
1186 | $txn->{finished}->recv; |
1317 | $txn->{finished}->recv; |
1187 | return $txn->{result}; |
1318 | return $txn->{result}; |
1188 | |
1319 | |
1189 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1320 | The actual code goes further and collects all errors (C<die>s, exceptions) |
1190 | that occured during request processing. The C<result> method detects |
1321 | that occurred during request processing. The C<result> method detects |
1191 | whether an exception as thrown (it is stored inside the $txn object) |
1322 | whether an exception as thrown (it is stored inside the $txn object) |
1192 | and just throws the exception, which means connection errors and other |
1323 | and just throws the exception, which means connection errors and other |
1193 | problems get reported tot he code that tries to use the result, not in a |
1324 | problems get reported tot he code that tries to use the result, not in a |
1194 | random callback. |
1325 | random callback. |
1195 | |
1326 | |
… | |
… | |
1241 | of various event loops I prepared some benchmarks. |
1372 | of various event loops I prepared some benchmarks. |
1242 | |
1373 | |
1243 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1374 | =head2 BENCHMARKING ANYEVENT OVERHEAD |
1244 | |
1375 | |
1245 | Here is a benchmark of various supported event models used natively and |
1376 | Here is a benchmark of various supported event models used natively and |
1246 | through anyevent. The benchmark creates a lot of timers (with a zero |
1377 | through AnyEvent. The benchmark creates a lot of timers (with a zero |
1247 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1378 | timeout) and I/O watchers (watching STDOUT, a pty, to become writable, |
1248 | which it is), lets them fire exactly once and destroys them again. |
1379 | which it is), lets them fire exactly once and destroys them again. |
1249 | |
1380 | |
1250 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1381 | Source code for this benchmark is found as F<eg/bench> in the AnyEvent |
1251 | distribution. |
1382 | distribution. |
… | |
… | |
1374 | |
1505 | |
1375 | =back |
1506 | =back |
1376 | |
1507 | |
1377 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1508 | =head2 BENCHMARKING THE LARGE SERVER CASE |
1378 | |
1509 | |
1379 | This benchmark atcually benchmarks the event loop itself. It works by |
1510 | This benchmark actually benchmarks the event loop itself. It works by |
1380 | creating a number of "servers": each server consists of a socketpair, a |
1511 | creating a number of "servers": each server consists of a socket pair, a |
1381 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1512 | timeout watcher that gets reset on activity (but never fires), and an I/O |
1382 | watcher waiting for input on one side of the socket. Each time the socket |
1513 | watcher waiting for input on one side of the socket. Each time the socket |
1383 | watcher reads a byte it will write that byte to a random other "server". |
1514 | watcher reads a byte it will write that byte to a random other "server". |
1384 | |
1515 | |
1385 | The effect is that there will be a lot of I/O watchers, only part of which |
1516 | The effect is that there will be a lot of I/O watchers, only part of which |
1386 | are active at any one point (so there is a constant number of active |
1517 | are active at any one point (so there is a constant number of active |
1387 | fds for each loop iterstaion, but which fds these are is random). The |
1518 | fds for each loop iteration, but which fds these are is random). The |
1388 | timeout is reset each time something is read because that reflects how |
1519 | timeout is reset each time something is read because that reflects how |
1389 | most timeouts work (and puts extra pressure on the event loops). |
1520 | most timeouts work (and puts extra pressure on the event loops). |
1390 | |
1521 | |
1391 | In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 |
1522 | In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 |
1392 | (1%) are active. This mirrors the activity of large servers with many |
1523 | (1%) are active. This mirrors the activity of large servers with many |
1393 | connections, most of which are idle at any one point in time. |
1524 | connections, most of which are idle at any one point in time. |
1394 | |
1525 | |
1395 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1526 | Source code for this benchmark is found as F<eg/bench2> in the AnyEvent |
1396 | distribution. |
1527 | distribution. |
… | |
… | |
1398 | =head3 Explanation of the columns |
1529 | =head3 Explanation of the columns |
1399 | |
1530 | |
1400 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1531 | I<sockets> is the number of sockets, and twice the number of "servers" (as |
1401 | each server has a read and write socket end). |
1532 | each server has a read and write socket end). |
1402 | |
1533 | |
1403 | I<create> is the time it takes to create a socketpair (which is |
1534 | I<create> is the time it takes to create a socket pair (which is |
1404 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1535 | nontrivial) and two watchers: an I/O watcher and a timeout watcher. |
1405 | |
1536 | |
1406 | I<request>, the most important value, is the time it takes to handle a |
1537 | I<request>, the most important value, is the time it takes to handle a |
1407 | single "request", that is, reading the token from the pipe and forwarding |
1538 | single "request", that is, reading the token from the pipe and forwarding |
1408 | it to another server. This includes deleting the old timeout and creating |
1539 | it to another server. This includes deleting the old timeout and creating |
… | |
… | |
1481 | speed most when you have lots of watchers, not when you only have a few of |
1612 | speed most when you have lots of watchers, not when you only have a few of |
1482 | them). |
1613 | them). |
1483 | |
1614 | |
1484 | EV is again fastest. |
1615 | EV is again fastest. |
1485 | |
1616 | |
1486 | Perl again comes second. It is noticably faster than the C-based event |
1617 | Perl again comes second. It is noticeably faster than the C-based event |
1487 | loops Event and Glib, although the difference is too small to really |
1618 | loops Event and Glib, although the difference is too small to really |
1488 | matter. |
1619 | matter. |
1489 | |
1620 | |
1490 | POE also performs much better in this case, but is is still far behind the |
1621 | POE also performs much better in this case, but is is still far behind the |
1491 | others. |
1622 | others. |