ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.271 by root, Wed Aug 5 20:50:27 2009 UTC vs.
Revision 1.309 by root, Sat Dec 26 08:59:35 2009 UTC

363might affect timers and time-outs. 363might affect timers and time-outs.
364 364
365When this is the case, you can call this method, which will update the 365When this is the case, you can call this method, which will update the
366event loop's idea of "current time". 366event loop's idea of "current time".
367 367
368A typical example would be a script in a web server (e.g. C<mod_perl>) -
369when mod_perl executes the script, then the event loop will have the wrong
370idea about the "current time" (being potentially far in the past, when the
371script ran the last time). In that case you should arrange a call to C<<
372AnyEvent->now_update >> each time the web server process wakes up again
373(e.g. at the start of your script, or in a handler).
374
368Note that updating the time I<might> cause some events to be handled. 375Note that updating the time I<might> cause some events to be handled.
369 376
370=back 377=back
371 378
372=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
395correctly. 402correctly.
396 403
397Example: exit on SIGINT 404Example: exit on SIGINT
398 405
399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
407
408=head3 Restart Behaviour
409
410While restart behaviour is up to the event loop implementation, most will
411not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
412pure perl implementation).
413
414=head3 Safe/Unsafe Signals
415
416Perl signals can be either "safe" (synchronous to opcode handling) or
417"unsafe" (asynchronous) - the former might get delayed indefinitely, the
418latter might corrupt your memory.
419
420AnyEvent signal handlers are, in addition, synchronous to the event loop,
421i.e. they will not interrupt your running perl program but will only be
422called as part of the normal event handling (just like timer, I/O etc.
423callbacks, too).
400 424
401=head3 Signal Races, Delays and Workarounds 425=head3 Signal Races, Delays and Workarounds
402 426
403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404callbacks to signals in a generic way, which is a pity, as you cannot 428callbacks to signals in a generic way, which is a pity, as you cannot
479 503
480=head2 IDLE WATCHERS 504=head2 IDLE WATCHERS
481 505
482 $w = AnyEvent->idle (cb => <callback>); 506 $w = AnyEvent->idle (cb => <callback>);
483 507
484Sometimes there is a need to do something, but it is not so important 508Repeatedly invoke the callback after the process becomes idle, until
485to do it instantly, but only when there is nothing better to do. This 509either the watcher is destroyed or new events have been detected.
486"nothing better to do" is usually defined to be "no other events need
487attention by the event loop".
488 510
489Idle watchers ideally get invoked when the event loop has nothing 511Idle watchers are useful when there is a need to do something, but it
490better to do, just before it would block the process to wait for new 512is not so important (or wise) to do it instantly. The callback will be
491events. Instead of blocking, the idle watcher is invoked. 513invoked only when there is "nothing better to do", which is usually
514defined as "all outstanding events have been handled and no new events
515have been detected". That means that idle watchers ideally get invoked
516when the event loop has just polled for new events but none have been
517detected. Instead of blocking to wait for more events, the idle watchers
518will be invoked.
492 519
493Most event loops unfortunately do not really support idle watchers (only 520Unfortunately, most event loops do not really support idle watchers (only
494EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent 521EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
495will simply call the callback "from time to time". 522will simply call the callback "from time to time".
496 523
497Example: read lines from STDIN, but only process them when the 524Example: read lines from STDIN, but only process them when the
498program is otherwise idle: 525program is otherwise idle:
592 after => 1, 619 after => 1,
593 cb => sub { $result_ready->send }, 620 cb => sub { $result_ready->send },
594 ); 621 );
595 622
596 # this "blocks" (while handling events) till the callback 623 # this "blocks" (while handling events) till the callback
597 # calls -<send 624 # calls ->send
598 $result_ready->recv; 625 $result_ready->recv;
599 626
600Example: wait for a timer, but take advantage of the fact that condition 627Example: wait for a timer, but take advantage of the fact that condition
601variables are also callable directly. 628variables are also callable directly.
602 629
666one. For example, a function that pings many hosts in parallel might want 693one. For example, a function that pings many hosts in parallel might want
667to use a condition variable for the whole process. 694to use a condition variable for the whole process.
668 695
669Every call to C<< ->begin >> will increment a counter, and every call to 696Every call to C<< ->begin >> will increment a counter, and every call to
670C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 697C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671>>, the (last) callback passed to C<begin> will be executed. That callback 698>>, the (last) callback passed to C<begin> will be executed, passing the
672is I<supposed> to call C<< ->send >>, but that is not required. If no 699condvar as first argument. That callback is I<supposed> to call C<< ->send
673callback was set, C<send> will be called without any arguments. 700>>, but that is not required. If no group callback was set, C<send> will
701be called without any arguments.
674 702
675You can think of C<< $cv->send >> giving you an OR condition (one call 703You can think of C<< $cv->send >> giving you an OR condition (one call
676sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 704sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677condition (all C<begin> calls must be C<end>'ed before the condvar sends). 705condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678 706
705begung can potentially be zero: 733begung can potentially be zero:
706 734
707 my $cv = AnyEvent->condvar; 735 my $cv = AnyEvent->condvar;
708 736
709 my %result; 737 my %result;
710 $cv->begin (sub { $cv->send (\%result) }); 738 $cv->begin (sub { shift->send (\%result) });
711 739
712 for my $host (@list_of_hosts) { 740 for my $host (@list_of_hosts) {
713 $cv->begin; 741 $cv->begin;
714 ping_host_then_call_callback $host, sub { 742 ping_host_then_call_callback $host, sub {
715 $result{$host} = ...; 743 $result{$host} = ...;
806=over 4 834=over 4
807 835
808=item Backends that are autoprobed when no other event loop can be found. 836=item Backends that are autoprobed when no other event loop can be found.
809 837
810EV is the preferred backend when no other event loop seems to be in 838EV is the preferred backend when no other event loop seems to be in
811use. If EV is not installed, then AnyEvent will try Event, and, failing 839use. If EV is not installed, then AnyEvent will fall back to its own
812that, will fall back to its own pure-perl implementation, which is 840pure-perl implementation, which is available everywhere as it comes with
813available everywhere as it comes with AnyEvent itself. 841AnyEvent itself.
814 842
815 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 843 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816 AnyEvent::Impl::Event based on Event, very stable, few glitches.
817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 844 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818 845
819=item Backends that are transparently being picked up when they are used. 846=item Backends that are transparently being picked up when they are used.
820 847
821These will be used when they are currently loaded when the first watcher 848These will be used when they are currently loaded when the first watcher
822is created, in which case it is assumed that the application is using 849is created, in which case it is assumed that the application is using
823them. This means that AnyEvent will automatically pick the right backend 850them. This means that AnyEvent will automatically pick the right backend
824when the main program loads an event module before anything starts to 851when the main program loads an event module before anything starts to
825create watchers. Nothing special needs to be done by the main program. 852create watchers. Nothing special needs to be done by the main program.
826 853
854 AnyEvent::Impl::Event based on Event, very stable, few glitches.
827 AnyEvent::Impl::Glib based on Glib, slow but very stable. 855 AnyEvent::Impl::Glib based on Glib, slow but very stable.
828 AnyEvent::Impl::Tk based on Tk, very broken. 856 AnyEvent::Impl::Tk based on Tk, very broken.
829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 857 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830 AnyEvent::Impl::POE based on POE, very slow, some limitations. 858 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 AnyEvent::Impl::Irssi used when running within irssi. 859 AnyEvent::Impl::Irssi used when running within irssi.
941You should check C<$AnyEvent::MODEL> before adding to this array, though: 969You should check C<$AnyEvent::MODEL> before adding to this array, though:
942if it is defined then the event loop has already been detected, and the 970if it is defined then the event loop has already been detected, and the
943array will be ignored. 971array will be ignored.
944 972
945Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 973Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
946it,as it takes care of these details. 974it, as it takes care of these details.
947 975
948This variable is mainly useful for modules that can do something useful 976This variable is mainly useful for modules that can do something useful
949when AnyEvent is used and thus want to know when it is initialised, but do 977when AnyEvent is used and thus want to know when it is initialised, but do
950not need to even load it by default. This array provides the means to hook 978not need to even load it by default. This array provides the means to hook
951into AnyEvent passively, without loading it. 979into AnyEvent passively, without loading it.
980
981Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
982together, you could put this into Coro (this is the actual code used by
983Coro to accomplish this):
984
985 if (defined $AnyEvent::MODEL) {
986 # AnyEvent already initialised, so load Coro::AnyEvent
987 require Coro::AnyEvent;
988 } else {
989 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
990 # as soon as it is
991 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
992 }
952 993
953=back 994=back
954 995
955=head1 WHAT TO DO IN A MODULE 996=head1 WHAT TO DO IN A MODULE
956 997
1105 1146
1106package AnyEvent; 1147package AnyEvent;
1107 1148
1108# basically a tuned-down version of common::sense 1149# basically a tuned-down version of common::sense
1109sub common_sense { 1150sub common_sense {
1110 # no warnings 1151 # from common:.sense 1.0
1111 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1152 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1112 # use strict vars subs 1153 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1113 $^H |= 0x00000600; 1154 $^H |= 0x00000600;
1114} 1155}
1115 1156
1116BEGIN { AnyEvent::common_sense } 1157BEGIN { AnyEvent::common_sense }
1117 1158
1118use Carp (); 1159use Carp ();
1119 1160
1120our $VERSION = 4.901; 1161our $VERSION = '5.23';
1121our $MODEL; 1162our $MODEL;
1122 1163
1123our $AUTOLOAD; 1164our $AUTOLOAD;
1124our @ISA; 1165our @ISA;
1125 1166
1126our @REGISTRY; 1167our @REGISTRY;
1127
1128our $WIN32;
1129 1168
1130our $VERBOSE; 1169our $VERBOSE;
1131 1170
1132BEGIN { 1171BEGIN {
1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1172 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1190 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152} 1191}
1153 1192
1154my @models = ( 1193my @models = (
1155 [EV:: => AnyEvent::Impl::EV:: , 1], 1194 [EV:: => AnyEvent::Impl::EV:: , 1],
1156 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1195 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158 # everything below here will not (normally) be autoprobed 1196 # everything below here will not (normally) be autoprobed
1159 # as the pureperl backend should work everywhere 1197 # as the pureperl backend should work everywhere
1160 # and is usually faster 1198 # and is usually faster
1199 [Event:: => AnyEvent::Impl::Event::, 1],
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1200 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1201 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1202 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1203 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1204 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1168 [Prima:: => AnyEvent::Impl::POE::], 1207 [Prima:: => AnyEvent::Impl::POE::],
1169 # IO::Async is just too broken - we would need workarounds for its 1208 # IO::Async is just too broken - we would need workarounds for its
1170 # byzantine signal and broken child handling, among others. 1209 # byzantine signal and broken child handling, among others.
1171 # IO::Async is rather hard to detect, as it doesn't have any 1210 # IO::Async is rather hard to detect, as it doesn't have any
1172 # obvious default class. 1211 # obvious default class.
1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1212 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1213 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1214 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1215 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176); 1216);
1177 1217
1178our %method = map +($_ => 1), 1218our %method = map +($_ => 1),
1179 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1219 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180 1220
1287 # we assume CLOEXEC is already set by perl in all important cases 1327 # we assume CLOEXEC is already set by perl in all important cases
1288 1328
1289 ($fh2, $rw) 1329 ($fh2, $rw)
1290} 1330}
1291 1331
1332=head1 SIMPLIFIED AE API
1333
1334Starting with version 5.0, AnyEvent officially supports a second, much
1335simpler, API that is designed to reduce the calling, typing and memory
1336overhead.
1337
1338See the L<AE> manpage for details.
1339
1340=cut
1341
1342package AE;
1343
1344our $VERSION = $AnyEvent::VERSION;
1345
1346sub io($$$) {
1347 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1348}
1349
1350sub timer($$$) {
1351 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1352}
1353
1354sub signal($$) {
1355 AnyEvent->signal (signal => $_[0], cb => $_[1])
1356}
1357
1358sub child($$) {
1359 AnyEvent->child (pid => $_[0], cb => $_[1])
1360}
1361
1362sub idle($) {
1363 AnyEvent->idle (cb => $_[0])
1364}
1365
1366sub cv(;&) {
1367 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1368}
1369
1370sub now() {
1371 AnyEvent->now
1372}
1373
1374sub now_update() {
1375 AnyEvent->now_update
1376}
1377
1378sub time() {
1379 AnyEvent->time
1380}
1381
1292package AnyEvent::Base; 1382package AnyEvent::Base;
1293 1383
1294# default implementations for many methods 1384# default implementations for many methods
1295 1385
1296sub _time { 1386sub _time() {
1297 # probe for availability of Time::HiRes 1387 # probe for availability of Time::HiRes
1298 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1388 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1389 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1300 *_time = \&Time::HiRes::time; 1390 *_time = \&Time::HiRes::time;
1301 # if (eval "use POSIX (); (POSIX::times())... 1391 # if (eval "use POSIX (); (POSIX::times())...
1321 1411
1322our $HAVE_ASYNC_INTERRUPT; 1412our $HAVE_ASYNC_INTERRUPT;
1323 1413
1324sub _have_async_interrupt() { 1414sub _have_async_interrupt() {
1325 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1415 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326 && eval "use Async::Interrupt 1.0 (); 1") 1416 && eval "use Async::Interrupt 1.02 (); 1")
1327 unless defined $HAVE_ASYNC_INTERRUPT; 1417 unless defined $HAVE_ASYNC_INTERRUPT;
1328 1418
1329 $HAVE_ASYNC_INTERRUPT 1419 $HAVE_ASYNC_INTERRUPT
1330} 1420}
1331 1421
1334our ($SIG_COUNT, $SIG_TW); 1424our ($SIG_COUNT, $SIG_TW);
1335 1425
1336sub _signal_exec { 1426sub _signal_exec {
1337 $HAVE_ASYNC_INTERRUPT 1427 $HAVE_ASYNC_INTERRUPT
1338 ? $SIGPIPE_R->drain 1428 ? $SIGPIPE_R->drain
1339 : sysread $SIGPIPE_R, my $dummy, 9; 1429 : sysread $SIGPIPE_R, (my $dummy), 9;
1340 1430
1341 while (%SIG_EV) { 1431 while (%SIG_EV) {
1342 for (keys %SIG_EV) { 1432 for (keys %SIG_EV) {
1343 delete $SIG_EV{$_}; 1433 delete $SIG_EV{$_};
1344 $_->() for values %{ $SIG_CB{$_} || {} }; 1434 $_->() for values %{ $SIG_CB{$_} || {} };
1348 1438
1349# install a dummy wakeup watcher to reduce signal catching latency 1439# install a dummy wakeup watcher to reduce signal catching latency
1350sub _sig_add() { 1440sub _sig_add() {
1351 unless ($SIG_COUNT++) { 1441 unless ($SIG_COUNT++) {
1352 # try to align timer on a full-second boundary, if possible 1442 # try to align timer on a full-second boundary, if possible
1353 my $NOW = AnyEvent->now; 1443 my $NOW = AE::now;
1354 1444
1355 $SIG_TW = AnyEvent->timer ( 1445 $SIG_TW = AE::timer
1356 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1446 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357 interval => $MAX_SIGNAL_LATENCY, 1447 $MAX_SIGNAL_LATENCY,
1358 cb => sub { }, # just for the PERL_ASYNC_CHECK 1448 sub { } # just for the PERL_ASYNC_CHECK
1359 ); 1449 ;
1360 } 1450 }
1361} 1451}
1362 1452
1363sub _sig_del { 1453sub _sig_del {
1364 undef $SIG_TW 1454 undef $SIG_TW
1401 # probe for availability of Async::Interrupt 1491 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) { 1492 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1493 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404 1494
1405 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1495 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1496 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407 1497
1408 } else { 1498 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1499 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410 1500
1411 require Fcntl; 1501 require Fcntl;
1427 } 1517 }
1428 1518
1429 $SIGPIPE_R 1519 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1520 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431 1521
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1522 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433 } 1523 }
1434 1524
1435 *signal = sub { 1525 *signal = sub {
1436 my (undef, %arg) = @_; 1526 my (undef, %arg) = @_;
1437 1527
1526 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1616 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527 ? 1 1617 ? 1
1528 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1618 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1529 1619
1530 unless ($CHLD_W) { 1620 unless ($CHLD_W) {
1531 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1621 $CHLD_W = AE::signal CHLD => \&_sigchld;
1532 # child could be a zombie already, so make at least one round 1622 # child could be a zombie already, so make at least one round
1533 &_sigchld; 1623 &_sigchld;
1534 } 1624 }
1535 1625
1536 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1626 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1562 # never use more then 50% of the time for the idle watcher, 1652 # never use more then 50% of the time for the idle watcher,
1563 # within some limits 1653 # within some limits
1564 $w = 0.0001 if $w < 0.0001; 1654 $w = 0.0001 if $w < 0.0001;
1565 $w = 5 if $w > 5; 1655 $w = 5 if $w > 5;
1566 1656
1567 $w = AnyEvent->timer (after => $w, cb => $rcb); 1657 $w = AE::timer $w, 0, $rcb;
1568 } else { 1658 } else {
1569 # clean up... 1659 # clean up...
1570 undef $w; 1660 undef $w;
1571 undef $rcb; 1661 undef $rcb;
1572 } 1662 }
1573 }; 1663 };
1574 1664
1575 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1665 $w = AE::timer 0.05, 0, $rcb;
1576 1666
1577 bless \\$cb, "AnyEvent::Base::idle" 1667 bless \\$cb, "AnyEvent::Base::idle"
1578} 1668}
1579 1669
1580sub AnyEvent::Base::idle::DESTROY { 1670sub AnyEvent::Base::idle::DESTROY {
1657} 1747}
1658 1748
1659# undocumented/compatibility with pre-3.4 1749# undocumented/compatibility with pre-3.4
1660*broadcast = \&send; 1750*broadcast = \&send;
1661*wait = \&_wait; 1751*wait = \&_wait;
1662
1663#############################################################################
1664# "new" API, currently only emulation of it
1665#############################################################################
1666
1667package AE;
1668
1669sub io($$$) {
1670 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1671}
1672
1673sub timer($$$) {
1674 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1675}
1676
1677sub signal($$) {
1678 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1679}
1680
1681sub child($$) {
1682 AnyEvent->child (pid => $_[0], cb => $_[1]);
1683}
1684
1685sub idle($) {
1686 AnyEvent->idle (cb => $_[0]);
1687}
1688
1689sub cv() {
1690 AnyEvent->condvar
1691}
1692
1693sub now() {
1694 AnyEvent->now
1695}
1696
1697sub now_update() {
1698 AnyEvent->now_update
1699}
1700
1701sub time() {
1702 AnyEvent->time
1703}
1704 1752
1705=head1 ERROR AND EXCEPTION HANDLING 1753=head1 ERROR AND EXCEPTION HANDLING
1706 1754
1707In general, AnyEvent does not do any error handling - it relies on the 1755In general, AnyEvent does not do any error handling - it relies on the
1708caller to do that if required. The L<AnyEvent::Strict> module (see also 1756caller to do that if required. The L<AnyEvent::Strict> module (see also
1902 warn "read: $input\n"; # output what has been read 1950 warn "read: $input\n"; # output what has been read
1903 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1951 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1904 }, 1952 },
1905 ); 1953 );
1906 1954
1907 my $time_watcher; # can only be used once
1908
1909 sub new_timer {
1910 $timer = AnyEvent->timer (after => 1, cb => sub { 1955 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1911 warn "timeout\n"; # print 'timeout' about every second 1956 warn "timeout\n"; # print 'timeout' at most every second
1912 &new_timer; # and restart the time
1913 }); 1957 });
1914 }
1915
1916 new_timer; # create first timer
1917 1958
1918 $cv->recv; # wait until user enters /^q/i 1959 $cv->recv; # wait until user enters /^q/i
1919 1960
1920=head1 REAL-WORLD EXAMPLE 1961=head1 REAL-WORLD EXAMPLE
1921 1962
2052through AnyEvent. The benchmark creates a lot of timers (with a zero 2093through AnyEvent. The benchmark creates a lot of timers (with a zero
2053timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2094timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2054which it is), lets them fire exactly once and destroys them again. 2095which it is), lets them fire exactly once and destroys them again.
2055 2096
2056Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2097Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2057distribution. 2098distribution. It uses the L<AE> interface, which makes a real difference
2099for the EV and Perl backends only.
2058 2100
2059=head3 Explanation of the columns 2101=head3 Explanation of the columns
2060 2102
2061I<watcher> is the number of event watchers created/destroyed. Since 2103I<watcher> is the number of event watchers created/destroyed. Since
2062different event models feature vastly different performances, each event 2104different event models feature vastly different performances, each event
2083watcher. 2125watcher.
2084 2126
2085=head3 Results 2127=head3 Results
2086 2128
2087 name watchers bytes create invoke destroy comment 2129 name watchers bytes create invoke destroy comment
2088 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2130 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2089 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2131 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2090 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2132 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2091 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2133 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2092 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2134 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2093 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2135 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2094 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2136 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2095 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2137 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2096 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2138 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2097 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2139 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2098 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2140 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2099 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2141 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2100 2142
2101=head3 Discussion 2143=head3 Discussion
2102 2144
2103The benchmark does I<not> measure scalability of the event loop very 2145The benchmark does I<not> measure scalability of the event loop very
2104well. For example, a select-based event loop (such as the pure perl one) 2146well. For example, a select-based event loop (such as the pure perl one)
2116benchmark machine, handling an event takes roughly 1600 CPU cycles with 2158benchmark machine, handling an event takes roughly 1600 CPU cycles with
2117EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2159EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2118cycles with POE. 2160cycles with POE.
2119 2161
2120C<EV> is the sole leader regarding speed and memory use, which are both 2162C<EV> is the sole leader regarding speed and memory use, which are both
2121maximal/minimal, respectively. Even when going through AnyEvent, it uses 2163maximal/minimal, respectively. When using the L<AE> API there is zero
2164overhead (when going through the AnyEvent API create is about 5-6 times
2165slower, with other times being equal, so still uses far less memory than
2122far less memory than any other event loop and is still faster than Event 2166any other event loop and is still faster than Event natively).
2123natively.
2124 2167
2125The pure perl implementation is hit in a few sweet spots (both the 2168The pure perl implementation is hit in a few sweet spots (both the
2126constant timeout and the use of a single fd hit optimisations in the perl 2169constant timeout and the use of a single fd hit optimisations in the perl
2127interpreter and the backend itself). Nevertheless this shows that it 2170interpreter and the backend itself). Nevertheless this shows that it
2128adds very little overhead in itself. Like any select-based backend its 2171adds very little overhead in itself. Like any select-based backend its
2202In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2245In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2203(1%) are active. This mirrors the activity of large servers with many 2246(1%) are active. This mirrors the activity of large servers with many
2204connections, most of which are idle at any one point in time. 2247connections, most of which are idle at any one point in time.
2205 2248
2206Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2249Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2207distribution. 2250distribution. It uses the L<AE> interface, which makes a real difference
2251for the EV and Perl backends only.
2208 2252
2209=head3 Explanation of the columns 2253=head3 Explanation of the columns
2210 2254
2211I<sockets> is the number of sockets, and twice the number of "servers" (as 2255I<sockets> is the number of sockets, and twice the number of "servers" (as
2212each server has a read and write socket end). 2256each server has a read and write socket end).
2220a new one that moves the timeout into the future. 2264a new one that moves the timeout into the future.
2221 2265
2222=head3 Results 2266=head3 Results
2223 2267
2224 name sockets create request 2268 name sockets create request
2225 EV 20000 69.01 11.16 2269 EV 20000 62.66 7.99
2226 Perl 20000 73.32 35.87 2270 Perl 20000 68.32 32.64
2227 IOAsync 20000 157.00 98.14 epoll 2271 IOAsync 20000 174.06 101.15 epoll
2228 IOAsync 20000 159.31 616.06 poll 2272 IOAsync 20000 174.67 610.84 poll
2229 Event 20000 212.62 257.32 2273 Event 20000 202.69 242.91
2230 Glib 20000 651.16 1896.30 2274 Glib 20000 557.01 1689.52
2231 POE 20000 349.67 12317.24 uses POE::Loop::Event 2275 POE 20000 341.54 12086.32 uses POE::Loop::Event
2232 2276
2233=head3 Discussion 2277=head3 Discussion
2234 2278
2235This benchmark I<does> measure scalability and overall performance of the 2279This benchmark I<does> measure scalability and overall performance of the
2236particular event loop. 2280particular event loop.
2362As you can see, the AnyEvent + EV combination even beats the 2406As you can see, the AnyEvent + EV combination even beats the
2363hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2407hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2364backend easily beats IO::Lambda and POE. 2408backend easily beats IO::Lambda and POE.
2365 2409
2366And even the 100% non-blocking version written using the high-level (and 2410And even the 100% non-blocking version written using the high-level (and
2367slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2411slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2368large margin, even though it does all of DNS, tcp-connect and socket I/O 2412higher level ("unoptimised") abstractions by a large margin, even though
2369in a non-blocking way. 2413it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2370 2414
2371The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2415The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2372F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2416F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2373part of the IO::lambda distribution and were used without any changes. 2417part of the IO::Lambda distribution and were used without any changes.
2374 2418
2375 2419
2376=head1 SIGNALS 2420=head1 SIGNALS
2377 2421
2378AnyEvent currently installs handlers for these signals: 2422AnyEvent currently installs handlers for these signals:
2420it's built-in modules) are required to use it. 2464it's built-in modules) are required to use it.
2421 2465
2422That does not mean that AnyEvent won't take advantage of some additional 2466That does not mean that AnyEvent won't take advantage of some additional
2423modules if they are installed. 2467modules if they are installed.
2424 2468
2425This section epxlains which additional modules will be used, and how they 2469This section explains which additional modules will be used, and how they
2426affect AnyEvent's operetion. 2470affect AnyEvent's operation.
2427 2471
2428=over 4 2472=over 4
2429 2473
2430=item L<Async::Interrupt> 2474=item L<Async::Interrupt>
2431 2475
2436catch the signals) with some delay (default is 10 seconds, look for 2480catch the signals) with some delay (default is 10 seconds, look for
2437C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2481C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2438 2482
2439If this module is available, then it will be used to implement signal 2483If this module is available, then it will be used to implement signal
2440catching, which means that signals will not be delayed, and the event loop 2484catching, which means that signals will not be delayed, and the event loop
2441will not be interrupted regularly, which is more efficient (And good for 2485will not be interrupted regularly, which is more efficient (and good for
2442battery life on laptops). 2486battery life on laptops).
2443 2487
2444This affects not just the pure-perl event loop, but also other event loops 2488This affects not just the pure-perl event loop, but also other event loops
2445that have no signal handling on their own (e.g. Glib, Tk, Qt). 2489that have no signal handling on their own (e.g. Glib, Tk, Qt).
2446 2490
2467lot less memory), but otherwise doesn't affect guard operation much. It is 2511lot less memory), but otherwise doesn't affect guard operation much. It is
2468purely used for performance. 2512purely used for performance.
2469 2513
2470=item L<JSON> and L<JSON::XS> 2514=item L<JSON> and L<JSON::XS>
2471 2515
2472This module is required when you want to read or write JSON data via 2516One of these modules is required when you want to read or write JSON data
2473L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2517via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2474advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2518advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2475 2519
2476In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2520In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2477installed. 2521installed.
2478 2522
2493 2537
2494 2538
2495=head1 FORK 2539=head1 FORK
2496 2540
2497Most event libraries are not fork-safe. The ones who are usually are 2541Most event libraries are not fork-safe. The ones who are usually are
2498because they rely on inefficient but fork-safe C<select> or C<poll> 2542because they rely on inefficient but fork-safe C<select> or C<poll> calls
2499calls. Only L<EV> is fully fork-aware. 2543- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2544are usually badly thought-out hacks that are incompatible with fork in
2545one way or another. Only L<EV> is fully fork-aware and ensures that you
2546continue event-processing in both parent and child (or both, if you know
2547what you are doing).
2548
2549This means that, in general, you cannot fork and do event processing in
2550the child if the event library was initialised before the fork (which
2551usually happens when the first AnyEvent watcher is created, or the library
2552is loaded).
2500 2553
2501If you have to fork, you must either do so I<before> creating your first 2554If you have to fork, you must either do so I<before> creating your first
2502watcher OR you must not use AnyEvent at all in the child OR you must do 2555watcher OR you must not use AnyEvent at all in the child OR you must do
2503something completely out of the scope of AnyEvent. 2556something completely out of the scope of AnyEvent.
2557
2558The problem of doing event processing in the parent I<and> the child
2559is much more complicated: even for backends that I<are> fork-aware or
2560fork-safe, their behaviour is not usually what you want: fork clones all
2561watchers, that means all timers, I/O watchers etc. are active in both
2562parent and child, which is almost never what you want. USing C<exec>
2563to start worker children from some kind of manage rprocess is usually
2564preferred, because it is much easier and cleaner, at the expense of having
2565to have another binary.
2504 2566
2505 2567
2506=head1 SECURITY CONSIDERATIONS 2568=head1 SECURITY CONSIDERATIONS
2507 2569
2508AnyEvent can be forced to load any event model via 2570AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines