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 | EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
… | |
… | |
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 whether 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 ->send |
21 | $w->broadcast; # wake up current and all future wait's |
21 | $w->send; # wake up current and all future wait's |
22 | |
22 | |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
23 | =head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) |
24 | |
24 | |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
25 | Glib, POE, IO::Async, Event... CPAN offers event models by the dozen |
26 | nowadays. So what is different about AnyEvent? |
26 | nowadays. So what is different about AnyEvent? |
… | |
… | |
78 | The interface itself is vaguely similar, but not identical to the L<Event> |
78 | The interface itself is vaguely similar, but not identical to the L<Event> |
79 | module. |
79 | module. |
80 | |
80 | |
81 | During the first call of any watcher-creation method, the module tries |
81 | During the first call of any watcher-creation method, the module tries |
82 | to detect the currently loaded event loop by probing whether one of the |
82 | to detect the currently loaded event loop by probing whether one of the |
83 | following modules is already loaded: L<Coro::EV>, L<Coro::Event>, L<EV>, |
83 | following modules is already loaded: L<EV>, |
84 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
84 | L<Event>, L<Glib>, L<AnyEvent::Impl::Perl>, L<Tk>, L<Event::Lib>, L<Qt>, |
85 | L<POE>. The first one found is used. If none are found, the module tries |
85 | L<POE>. The first one found is used. If none are found, the module tries |
86 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
86 | to load these modules (excluding Tk, Event::Lib, Qt and POE as the pure perl |
87 | adaptor should always succeed) in the order given. The first one that can |
87 | adaptor should always succeed) in the order given. The first one that can |
88 | be successfully loaded will be used. If, after this, still none could be |
88 | be successfully loaded will be used. If, after this, still none could be |
… | |
… | |
288 | my $w = AnyEvent->child ( |
288 | my $w = AnyEvent->child ( |
289 | pid => $pid, |
289 | pid => $pid, |
290 | cb => sub { |
290 | cb => sub { |
291 | my ($pid, $status) = @_; |
291 | my ($pid, $status) = @_; |
292 | warn "pid $pid exited with status $status"; |
292 | warn "pid $pid exited with status $status"; |
293 | $done->broadcast; |
293 | $done->send; |
294 | }, |
294 | }, |
295 | ); |
295 | ); |
296 | |
296 | |
297 | # do something else, then wait for process exit |
297 | # do something else, then wait for process exit |
298 | $done->wait; |
298 | $done->wait; |
299 | |
299 | |
300 | =head2 CONDITION VARIABLES |
300 | =head2 CONDITION VARIABLES |
301 | |
301 | |
|
|
302 | If you are familiar with some event loops you will know that all of them |
|
|
303 | require you to run some blocking "loop", "run" or similar function that |
|
|
304 | will actively watch for new events and call your callbacks. |
|
|
305 | |
|
|
306 | AnyEvent is different, it expects somebody else to run the event loop and |
|
|
307 | will only block when necessary (usually when told by the user). |
|
|
308 | |
|
|
309 | The instrument to do that is called a "condition variable", so called |
|
|
310 | because they represent a condition that must become true. |
|
|
311 | |
302 | Condition variables can be created by calling the C<< AnyEvent->condvar >> |
312 | Condition variables can be created by calling the C<< AnyEvent->condvar |
303 | method without any arguments. |
313 | >> method, usually without arguments. The only argument pair allowed is |
|
|
314 | C<cb>, which specifies a callback to be called when the condition variable |
|
|
315 | becomes true. |
304 | |
316 | |
305 | A condition variable waits for a condition - precisely that the C<< |
317 | After creation, the conditon variable is "false" until it becomes "true" |
306 | ->broadcast >> method has been called. |
318 | by calling the C<send> method. |
307 | |
319 | |
308 | They are very useful to signal that a condition has been fulfilled, for |
320 | Condition variables are similar to callbacks, except that you can |
|
|
321 | optionally wait for them. They can also be called merge points - points |
|
|
322 | in time where multiple outstandign events have been processed. And yet |
|
|
323 | another way to call them is transations - each condition variable can be |
|
|
324 | used to represent a transaction, which finishes at some point and delivers |
|
|
325 | a result. |
|
|
326 | |
|
|
327 | Condition variables are very useful to signal that something has finished, |
309 | example, if you write a module that does asynchronous http requests, |
328 | for example, if you write a module that does asynchronous http requests, |
310 | then a condition variable would be the ideal candidate to signal the |
329 | then a condition variable would be the ideal candidate to signal the |
311 | availability of results. |
330 | availability of results. The user can either act when the callback is |
|
|
331 | called or can synchronously C<< ->wait >> for the results. |
312 | |
332 | |
313 | You can also use condition variables to block your main program until |
333 | You can also use them to simulate traditional event loops - for example, |
314 | an event occurs - for example, you could C<< ->wait >> in your main |
334 | you can block your main program until an event occurs - for example, you |
315 | program until the user clicks the Quit button in your app, which would C<< |
335 | could C<< ->wait >> in your main program until the user clicks the Quit |
316 | ->broadcast >> the "quit" event. |
336 | button of your app, which would C<< ->send >> the "quit" event. |
317 | |
337 | |
318 | Note that condition variables recurse into the event loop - if you have |
338 | Note that condition variables recurse into the event loop - if you have |
319 | two pirces of code that call C<< ->wait >> in a round-robbin fashion, you |
339 | two pieces of code that call C<< ->wait >> in a round-robbin fashion, you |
320 | lose. Therefore, condition variables are good to export to your caller, but |
340 | lose. Therefore, condition variables are good to export to your caller, but |
321 | you should avoid making a blocking wait yourself, at least in callbacks, |
341 | you should avoid making a blocking wait yourself, at least in callbacks, |
322 | as this asks for trouble. |
342 | as this asks for trouble. |
323 | |
343 | |
324 | This object has two methods: |
344 | Condition variables are represented by hash refs in perl, and the keys |
|
|
345 | used by AnyEvent itself are all named C<_ae_XXX> to make subclassing |
|
|
346 | easy (it is often useful to build your own transaction class on top of |
|
|
347 | AnyEvent). To subclass, use C<AnyEvent::CondVar> as base class and call |
|
|
348 | it's C<new> method in your own C<new> method. |
|
|
349 | |
|
|
350 | There are two "sides" to a condition variable - the "producer side" which |
|
|
351 | eventually calls C<< -> send >>, and the "consumer side", which waits |
|
|
352 | for the send to occur. |
|
|
353 | |
|
|
354 | Example: |
|
|
355 | |
|
|
356 | # wait till the result is ready |
|
|
357 | my $result_ready = AnyEvent->condvar; |
|
|
358 | |
|
|
359 | # do something such as adding a timer |
|
|
360 | # or socket watcher the calls $result_ready->send |
|
|
361 | # when the "result" is ready. |
|
|
362 | # in this case, we simply use a timer: |
|
|
363 | my $w = AnyEvent->timer ( |
|
|
364 | after => 1, |
|
|
365 | cb => sub { $result_ready->send }, |
|
|
366 | ); |
|
|
367 | |
|
|
368 | # this "blocks" (while handling events) till the callback |
|
|
369 | # calls send |
|
|
370 | $result_ready->wait; |
|
|
371 | |
|
|
372 | =head3 METHODS FOR PRODUCERS |
|
|
373 | |
|
|
374 | These methods should only be used by the producing side, i.e. the |
|
|
375 | code/module that eventually sends the signal. Note that it is also |
|
|
376 | the producer side which creates the condvar in most cases, but it isn't |
|
|
377 | uncommon for the consumer to create it as well. |
325 | |
378 | |
326 | =over 4 |
379 | =over 4 |
327 | |
380 | |
|
|
381 | =item $cv->send (...) |
|
|
382 | |
|
|
383 | Flag the condition as ready - a running C<< ->wait >> and all further |
|
|
384 | calls to C<wait> will (eventually) return after this method has been |
|
|
385 | called. If nobody is waiting the send will be remembered. |
|
|
386 | |
|
|
387 | If a callback has been set on the condition variable, it is called |
|
|
388 | immediately from within send. |
|
|
389 | |
|
|
390 | Any arguments passed to the C<send> call will be returned by all |
|
|
391 | future C<< ->wait >> calls. |
|
|
392 | |
|
|
393 | =item $cv->croak ($error) |
|
|
394 | |
|
|
395 | Similar to send, but causes all call's wait C<< ->wait >> to invoke |
|
|
396 | C<Carp::croak> with the given error message/object/scalar. |
|
|
397 | |
|
|
398 | This can be used to signal any errors to the condition variable |
|
|
399 | user/consumer. |
|
|
400 | |
|
|
401 | =item $cv->begin ([group callback]) |
|
|
402 | |
|
|
403 | =item $cv->end |
|
|
404 | |
|
|
405 | These two methods can be used to combine many transactions/events into |
|
|
406 | one. For example, a function that pings many hosts in parallel might want |
|
|
407 | to use a condition variable for the whole process. |
|
|
408 | |
|
|
409 | Every call to C<< ->begin >> will increment a counter, and every call to |
|
|
410 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
|
|
411 | >>, the (last) callback passed to C<begin> will be executed. That callback |
|
|
412 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
|
|
413 | callback was set, C<send> will be called without any arguments. |
|
|
414 | |
|
|
415 | Let's clarify this with the ping example: |
|
|
416 | |
|
|
417 | my $cv = AnyEvent->condvar; |
|
|
418 | |
|
|
419 | my %result; |
|
|
420 | $cv->begin (sub { $cv->send (\%result) }); |
|
|
421 | |
|
|
422 | for my $host (@list_of_hosts) { |
|
|
423 | $cv->begin; |
|
|
424 | ping_host_then_call_callback $host, sub { |
|
|
425 | $result{$host} = ...; |
|
|
426 | $cv->end; |
|
|
427 | }; |
|
|
428 | } |
|
|
429 | |
|
|
430 | $cv->end; |
|
|
431 | |
|
|
432 | This code fragment supposedly pings a number of hosts and calls |
|
|
433 | C<send> after results for all then have have been gathered - in any |
|
|
434 | order. To achieve this, the code issues a call to C<begin> when it starts |
|
|
435 | each ping request and calls C<end> when it has received some result for |
|
|
436 | it. Since C<begin> and C<end> only maintain a counter, the order in which |
|
|
437 | results arrive is not relevant. |
|
|
438 | |
|
|
439 | There is an additional bracketing call to C<begin> and C<end> outside the |
|
|
440 | loop, which serves two important purposes: first, it sets the callback |
|
|
441 | to be called once the counter reaches C<0>, and second, it ensures that |
|
|
442 | C<send> is called even when C<no> hosts are being pinged (the loop |
|
|
443 | doesn't execute once). |
|
|
444 | |
|
|
445 | 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> |
|
|
447 | 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>. |
|
|
449 | |
|
|
450 | =back |
|
|
451 | |
|
|
452 | =head3 METHODS FOR CONSUMERS |
|
|
453 | |
|
|
454 | These methods should only be used by the consuming side, i.e. the |
|
|
455 | code awaits the condition. |
|
|
456 | |
|
|
457 | =over 4 |
|
|
458 | |
328 | =item $cv->wait |
459 | =item $cv->wait |
329 | |
460 | |
330 | Wait (blocking if necessary) until the C<< ->broadcast >> method has been |
461 | Wait (blocking if necessary) until the C<< ->send >> or C<< ->croak |
331 | called on c<$cv>, while servicing other watchers normally. |
462 | >> methods have been called on c<$cv>, while servicing other watchers |
|
|
463 | normally. |
332 | |
464 | |
333 | You can only wait once on a condition - additional calls will return |
465 | You can only wait once on a condition - additional calls are valid but |
334 | immediately. |
466 | will return immediately. |
|
|
467 | |
|
|
468 | If an error condition has been set by calling C<< ->croak >>, then this |
|
|
469 | function will call C<croak>. |
|
|
470 | |
|
|
471 | In list context, all parameters passed to C<send> will be returned, |
|
|
472 | in scalar context only the first one will be returned. |
335 | |
473 | |
336 | Not all event models support a blocking wait - some die in that case |
474 | Not all event models support a blocking wait - some die in that case |
337 | (programs might want to do that to stay interactive), so I<if you are |
475 | (programs might want to do that to stay interactive), so I<if you are |
338 | using this from a module, never require a blocking wait>, but let the |
476 | using this from a module, never require a blocking wait>, but let the |
339 | caller decide whether the call will block or not (for example, by coupling |
477 | caller decide whether the call will block or not (for example, by coupling |
… | |
… | |
342 | while still suppporting blocking waits if the caller so desires). |
480 | while still suppporting blocking waits if the caller so desires). |
343 | |
481 | |
344 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
482 | Another reason I<never> to C<< ->wait >> in a module is that you cannot |
345 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
483 | sensibly have two C<< ->wait >>'s in parallel, as that would require |
346 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
484 | multiple interpreters or coroutines/threads, none of which C<AnyEvent> |
347 | can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and |
485 | can supply. |
348 | L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s |
|
|
349 | from different coroutines, however). |
|
|
350 | |
486 | |
351 | =item $cv->broadcast |
487 | The L<Coro> module, however, I<can> and I<does> supply coroutines and, in |
|
|
488 | fact, L<Coro::AnyEvent> replaces AnyEvent's condvars by coroutine-safe |
|
|
489 | versions and also integrates coroutines into AnyEvent, making blocking |
|
|
490 | C<< ->wait >> calls perfectly safe as long as they are done from another |
|
|
491 | coroutine (one that doesn't run the event loop). |
352 | |
492 | |
353 | Flag the condition as ready - a running C<< ->wait >> and all further |
493 | You can ensure that C<< -wait >> never blocks by setting a callback and |
354 | calls to C<wait> will (eventually) return after this method has been |
494 | only calling C<< ->wait >> from within that callback (or at a later |
355 | called. If nobody is waiting the broadcast will be remembered.. |
495 | time). This will work even when the event loop does not support blocking |
|
|
496 | waits otherwise. |
|
|
497 | |
|
|
498 | =item $bool = $cv->ready |
|
|
499 | |
|
|
500 | Returns true when the condition is "true", i.e. whether C<send> or |
|
|
501 | C<croak> have been called. |
|
|
502 | |
|
|
503 | =item $cb = $cv->cb ([new callback]) |
|
|
504 | |
|
|
505 | This is a mutator function that returns the callback set and optionally |
|
|
506 | replaces it before doing so. |
|
|
507 | |
|
|
508 | The callback will be called when the condition becomes "true", i.e. when |
|
|
509 | C<send> or C<croak> are called. Calling C<wait> inside the callback |
|
|
510 | or at any later time is guaranteed not to block. |
356 | |
511 | |
357 | =back |
512 | =back |
358 | |
|
|
359 | Example: |
|
|
360 | |
|
|
361 | # wait till the result is ready |
|
|
362 | my $result_ready = AnyEvent->condvar; |
|
|
363 | |
|
|
364 | # do something such as adding a timer |
|
|
365 | # or socket watcher the calls $result_ready->broadcast |
|
|
366 | # when the "result" is ready. |
|
|
367 | # in this case, we simply use a timer: |
|
|
368 | my $w = AnyEvent->timer ( |
|
|
369 | after => 1, |
|
|
370 | cb => sub { $result_ready->broadcast }, |
|
|
371 | ); |
|
|
372 | |
|
|
373 | # this "blocks" (while handling events) till the watcher |
|
|
374 | # calls broadcast |
|
|
375 | $result_ready->wait; |
|
|
376 | |
513 | |
377 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
514 | =head1 GLOBAL VARIABLES AND FUNCTIONS |
378 | |
515 | |
379 | =over 4 |
516 | =over 4 |
380 | |
517 | |
… | |
… | |
386 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
523 | C<AnyEvent::Impl:xxx> modules, but can be any other class in the case |
387 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
524 | AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>). |
388 | |
525 | |
389 | The known classes so far are: |
526 | The known classes so far are: |
390 | |
527 | |
391 | AnyEvent::Impl::CoroEV based on Coro::EV, best choice. |
|
|
392 | AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice. |
|
|
393 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
528 | AnyEvent::Impl::EV based on EV (an interface to libev, best choice). |
394 | AnyEvent::Impl::Event based on Event, second best choice. |
529 | AnyEvent::Impl::Event based on Event, second best choice. |
|
|
530 | AnyEvent::Impl::Perl pure-perl implementation, fast and portable. |
395 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
531 | AnyEvent::Impl::Glib based on Glib, third-best choice. |
396 | AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable. |
|
|
397 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
532 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
398 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
533 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
399 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
534 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
400 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
535 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
401 | |
536 | |
… | |
… | |
414 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
549 | Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model |
415 | if necessary. You should only call this function right before you would |
550 | if necessary. You should only call this function right before you would |
416 | have created an AnyEvent watcher anyway, that is, as late as possible at |
551 | have created an AnyEvent watcher anyway, that is, as late as possible at |
417 | runtime. |
552 | runtime. |
418 | |
553 | |
|
|
554 | =item $guard = AnyEvent::post_detect { BLOCK } |
|
|
555 | |
|
|
556 | Arranges for the code block to be executed as soon as the event model is |
|
|
557 | autodetected (or immediately if this has already happened). |
|
|
558 | |
|
|
559 | If called in scalar or list context, then it creates and returns an object |
|
|
560 | that automatically removes the callback again when it is destroyed. See |
|
|
561 | L<Coro::BDB> for a case where this is useful. |
|
|
562 | |
|
|
563 | =item @AnyEvent::post_detect |
|
|
564 | |
|
|
565 | If there are any code references in this array (you can C<push> to it |
|
|
566 | before or after loading AnyEvent), then they will called directly after |
|
|
567 | the event loop has been chosen. |
|
|
568 | |
|
|
569 | You should check C<$AnyEvent::MODEL> before adding to this array, though: |
|
|
570 | if it contains a true value then the event loop has already been detected, |
|
|
571 | and the array will be ignored. |
|
|
572 | |
|
|
573 | Best use C<AnyEvent::post_detect { BLOCK }> instead. |
|
|
574 | |
419 | =back |
575 | =back |
420 | |
576 | |
421 | =head1 WHAT TO DO IN A MODULE |
577 | =head1 WHAT TO DO IN A MODULE |
422 | |
578 | |
423 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
579 | As a module author, you should C<use AnyEvent> and call AnyEvent methods |
… | |
… | |
427 | decide which event module to use as soon as the first method is called, so |
583 | decide which event module to use as soon as the first method is called, so |
428 | by calling AnyEvent in your module body you force the user of your module |
584 | by calling AnyEvent in your module body you force the user of your module |
429 | to load the event module first. |
585 | to load the event module first. |
430 | |
586 | |
431 | Never call C<< ->wait >> on a condition variable unless you I<know> that |
587 | Never call C<< ->wait >> on a condition variable unless you I<know> that |
432 | the C<< ->broadcast >> method has been called on it already. This is |
588 | the C<< ->send >> method has been called on it already. This is |
433 | because it will stall the whole program, and the whole point of using |
589 | because it will stall the whole program, and the whole point of using |
434 | events is to stay interactive. |
590 | events is to stay interactive. |
435 | |
591 | |
436 | It is fine, however, to call C<< ->wait >> when the user of your module |
592 | It is fine, however, to call C<< ->wait >> when the user of your module |
437 | requests it (i.e. if you create a http request object ad have a method |
593 | requests it (i.e. if you create a http request object ad have a method |
… | |
… | |
511 | |
667 | |
512 | High level API for event-based execution flow control. |
668 | High level API for event-based execution flow control. |
513 | |
669 | |
514 | =item L<Coro> |
670 | =item L<Coro> |
515 | |
671 | |
516 | Has special support for AnyEvent. |
672 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
517 | |
673 | |
518 | =item L<IO::Lambda> |
674 | =item L<IO::Lambda> |
519 | |
675 | |
520 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
676 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
521 | |
677 | |
… | |
… | |
538 | no warnings; |
694 | no warnings; |
539 | use strict; |
695 | use strict; |
540 | |
696 | |
541 | use Carp; |
697 | use Carp; |
542 | |
698 | |
543 | our $VERSION = '3.3'; |
699 | our $VERSION = '3.4'; |
544 | our $MODEL; |
700 | our $MODEL; |
545 | |
701 | |
546 | our $AUTOLOAD; |
702 | our $AUTOLOAD; |
547 | our @ISA; |
703 | our @ISA; |
548 | |
704 | |
549 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
705 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
550 | |
706 | |
551 | our @REGISTRY; |
707 | our @REGISTRY; |
552 | |
708 | |
553 | my @models = ( |
709 | my @models = ( |
554 | [Coro::EV:: => AnyEvent::Impl::CoroEV::], |
|
|
555 | [Coro::Event:: => AnyEvent::Impl::CoroEvent::], |
|
|
556 | [EV:: => AnyEvent::Impl::EV::], |
710 | [EV:: => AnyEvent::Impl::EV::], |
557 | [Event:: => AnyEvent::Impl::Event::], |
711 | [Event:: => AnyEvent::Impl::Event::], |
558 | [Glib:: => AnyEvent::Impl::Glib::], |
|
|
559 | [Tk:: => AnyEvent::Impl::Tk::], |
712 | [Tk:: => AnyEvent::Impl::Tk::], |
560 | [Wx:: => AnyEvent::Impl::POE::], |
713 | [Wx:: => AnyEvent::Impl::POE::], |
561 | [Prima:: => AnyEvent::Impl::POE::], |
714 | [Prima:: => AnyEvent::Impl::POE::], |
562 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
715 | [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], |
563 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
716 | # everything below here will not be autoprobed as the pureperl backend should work everywhere |
|
|
717 | [Glib:: => AnyEvent::Impl::Glib::], |
564 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
718 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
565 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
719 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
566 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
720 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
567 | ); |
721 | ); |
568 | |
722 | |
569 | our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY); |
723 | our %method = map +($_ => 1), qw(io timer signal child condvar one_event DESTROY); |
|
|
724 | |
|
|
725 | our @post_detect; |
|
|
726 | |
|
|
727 | sub post_detect(&) { |
|
|
728 | my ($cb) = @_; |
|
|
729 | |
|
|
730 | if ($MODEL) { |
|
|
731 | $cb->(); |
|
|
732 | |
|
|
733 | 1 |
|
|
734 | } else { |
|
|
735 | push @post_detect, $cb; |
|
|
736 | |
|
|
737 | defined wantarray |
|
|
738 | ? bless \$cb, "AnyEvent::Util::Guard" |
|
|
739 | : () |
|
|
740 | } |
|
|
741 | } |
|
|
742 | |
|
|
743 | sub AnyEvent::Util::Guard::DESTROY { |
|
|
744 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
|
|
745 | } |
570 | |
746 | |
571 | sub detect() { |
747 | sub detect() { |
572 | unless ($MODEL) { |
748 | unless ($MODEL) { |
573 | no strict 'refs'; |
749 | no strict 'refs'; |
574 | |
750 | |
… | |
… | |
608 | last; |
784 | last; |
609 | } |
785 | } |
610 | } |
786 | } |
611 | |
787 | |
612 | $MODEL |
788 | $MODEL |
613 | 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."; |
789 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
614 | } |
790 | } |
615 | } |
791 | } |
616 | |
792 | |
617 | unshift @ISA, $MODEL; |
793 | unshift @ISA, $MODEL; |
618 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
794 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
795 | |
|
|
796 | (shift @post_detect)->() while @post_detect; |
619 | } |
797 | } |
620 | |
798 | |
621 | $MODEL |
799 | $MODEL |
622 | } |
800 | } |
623 | |
801 | |
… | |
… | |
1234 | |
1412 | |
1235 | |
1413 | |
1236 | =head1 FORK |
1414 | =head1 FORK |
1237 | |
1415 | |
1238 | Most event libraries are not fork-safe. The ones who are usually are |
1416 | Most event libraries are not fork-safe. The ones who are usually are |
1239 | because they are so inefficient. Only L<EV> is fully fork-aware. |
1417 | because they rely on inefficient but fork-safe C<select> or C<poll> |
|
|
1418 | calls. Only L<EV> is fully fork-aware. |
1240 | |
1419 | |
1241 | If you have to fork, you must either do so I<before> creating your first |
1420 | If you have to fork, you must either do so I<before> creating your first |
1242 | watcher OR you must not use AnyEvent at all in the child. |
1421 | watcher OR you must not use AnyEvent at all in the child. |
1243 | |
1422 | |
1244 | |
1423 | |
… | |
… | |
1256 | |
1435 | |
1257 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1436 | BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } |
1258 | |
1437 | |
1259 | use AnyEvent; |
1438 | use AnyEvent; |
1260 | |
1439 | |
|
|
1440 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
|
|
1441 | be used to probe what backend is used and gain other information (which is |
|
|
1442 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
|
|
1443 | |
1261 | |
1444 | |
1262 | =head1 SEE ALSO |
1445 | =head1 SEE ALSO |
1263 | |
1446 | |
1264 | Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>, |
1447 | Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, |
1265 | L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>, |
|
|
1266 | L<Event::Lib>, L<Qt>, L<POE>. |
1448 | L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. |
1267 | |
1449 | |
1268 | Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>, |
1450 | Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, |
1269 | L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, |
1451 | L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, |
1270 | L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>, |
1452 | L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, |
1271 | L<AnyEvent::Impl::Qt>, L<AnyEvent::Impl::POE>. |
1453 | L<AnyEvent::Impl::POE>. |
|
|
1454 | |
|
|
1455 | Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>, |
1272 | |
1456 | |
1273 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
1457 | Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>. |
1274 | |
1458 | |
1275 | |
1459 | |
1276 | =head1 AUTHOR |
1460 | =head1 AUTHOR |