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.269 by root, Fri Jul 31 20:16:29 2009 UTC vs.
Revision 1.310 by root, Tue Jan 5 10:45:25 2010 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.9; 1161our $VERSION = '5.24';
1121our $MODEL; 1162our $MODEL;
1122 1163
1123our $AUTOLOAD; 1164our $AUTOLOAD;
1124our @ISA; 1165our @ISA;
1125 1166
1126our @REGISTRY; 1167our @REGISTRY;
1127 1168
1128our $WIN32;
1129
1130our $VERBOSE; 1169our $VERBOSE;
1131 1170
1132BEGIN { 1171BEGIN {
1172 eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1173 eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1134 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1174 eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1135 1175
1136 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1176 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1137 if ${^TAINT}; 1177 if ${^TAINT};
1138 1178
1139 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1179 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1191 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152} 1192}
1153 1193
1154my @models = ( 1194my @models = (
1155 [EV:: => AnyEvent::Impl::EV:: , 1], 1195 [EV:: => AnyEvent::Impl::EV:: , 1],
1156 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1196 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158 # everything below here will not (normally) be autoprobed 1197 # everything below here will not (normally) be autoprobed
1159 # as the pureperl backend should work everywhere 1198 # as the pureperl backend should work everywhere
1160 # and is usually faster 1199 # and is usually faster
1200 [Event:: => AnyEvent::Impl::Event::, 1],
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1201 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1202 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1203 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1204 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1205 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1168 [Prima:: => AnyEvent::Impl::POE::], 1208 [Prima:: => AnyEvent::Impl::POE::],
1169 # IO::Async is just too broken - we would need workarounds for its 1209 # IO::Async is just too broken - we would need workarounds for its
1170 # byzantine signal and broken child handling, among others. 1210 # byzantine signal and broken child handling, among others.
1171 # IO::Async is rather hard to detect, as it doesn't have any 1211 # IO::Async is rather hard to detect, as it doesn't have any
1172 # obvious default class. 1212 # obvious default class.
1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1213 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1214 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1215 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1216 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176); 1217);
1177 1218
1178our %method = map +($_ => 1), 1219our %method = map +($_ => 1),
1179 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1220 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1180 1221
1287 # we assume CLOEXEC is already set by perl in all important cases 1328 # we assume CLOEXEC is already set by perl in all important cases
1288 1329
1289 ($fh2, $rw) 1330 ($fh2, $rw)
1290} 1331}
1291 1332
1333=head1 SIMPLIFIED AE API
1334
1335Starting with version 5.0, AnyEvent officially supports a second, much
1336simpler, API that is designed to reduce the calling, typing and memory
1337overhead.
1338
1339See the L<AE> manpage for details.
1340
1341=cut
1342
1343package AE;
1344
1345our $VERSION = $AnyEvent::VERSION;
1346
1347sub io($$$) {
1348 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1349}
1350
1351sub timer($$$) {
1352 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1353}
1354
1355sub signal($$) {
1356 AnyEvent->signal (signal => $_[0], cb => $_[1])
1357}
1358
1359sub child($$) {
1360 AnyEvent->child (pid => $_[0], cb => $_[1])
1361}
1362
1363sub idle($) {
1364 AnyEvent->idle (cb => $_[0])
1365}
1366
1367sub cv(;&) {
1368 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1369}
1370
1371sub now() {
1372 AnyEvent->now
1373}
1374
1375sub now_update() {
1376 AnyEvent->now_update
1377}
1378
1379sub time() {
1380 AnyEvent->time
1381}
1382
1292package AnyEvent::Base; 1383package AnyEvent::Base;
1293 1384
1294# default implementations for many methods 1385# default implementations for many methods
1295 1386
1296sub _time { 1387sub _time() {
1297 # probe for availability of Time::HiRes 1388 # probe for availability of Time::HiRes
1298 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1389 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1299 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1390 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1300 *_time = \&Time::HiRes::time; 1391 *_time = \&Time::HiRes::time;
1301 # if (eval "use POSIX (); (POSIX::times())... 1392 # if (eval "use POSIX (); (POSIX::times())...
1321 1412
1322our $HAVE_ASYNC_INTERRUPT; 1413our $HAVE_ASYNC_INTERRUPT;
1323 1414
1324sub _have_async_interrupt() { 1415sub _have_async_interrupt() {
1325 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1416 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1326 && eval "use Async::Interrupt 1.0 (); 1") 1417 && eval "use Async::Interrupt 1.02 (); 1")
1327 unless defined $HAVE_ASYNC_INTERRUPT; 1418 unless defined $HAVE_ASYNC_INTERRUPT;
1328 1419
1329 $HAVE_ASYNC_INTERRUPT 1420 $HAVE_ASYNC_INTERRUPT
1330} 1421}
1331 1422
1334our ($SIG_COUNT, $SIG_TW); 1425our ($SIG_COUNT, $SIG_TW);
1335 1426
1336sub _signal_exec { 1427sub _signal_exec {
1337 $HAVE_ASYNC_INTERRUPT 1428 $HAVE_ASYNC_INTERRUPT
1338 ? $SIGPIPE_R->drain 1429 ? $SIGPIPE_R->drain
1339 : sysread $SIGPIPE_R, my $dummy, 9; 1430 : sysread $SIGPIPE_R, (my $dummy), 9;
1340 1431
1341 while (%SIG_EV) { 1432 while (%SIG_EV) {
1342 for (keys %SIG_EV) { 1433 for (keys %SIG_EV) {
1343 delete $SIG_EV{$_}; 1434 delete $SIG_EV{$_};
1344 $_->() for values %{ $SIG_CB{$_} || {} }; 1435 $_->() for values %{ $SIG_CB{$_} || {} };
1348 1439
1349# install a dummy wakeup watcher to reduce signal catching latency 1440# install a dummy wakeup watcher to reduce signal catching latency
1350sub _sig_add() { 1441sub _sig_add() {
1351 unless ($SIG_COUNT++) { 1442 unless ($SIG_COUNT++) {
1352 # try to align timer on a full-second boundary, if possible 1443 # try to align timer on a full-second boundary, if possible
1353 my $NOW = AnyEvent->now; 1444 my $NOW = AE::now;
1354 1445
1355 $SIG_TW = AnyEvent->timer ( 1446 $SIG_TW = AE::timer
1356 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1447 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357 interval => $MAX_SIGNAL_LATENCY, 1448 $MAX_SIGNAL_LATENCY,
1358 cb => sub { }, # just for the PERL_ASYNC_CHECK 1449 sub { } # just for the PERL_ASYNC_CHECK
1359 ); 1450 ;
1360 } 1451 }
1361} 1452}
1362 1453
1363sub _sig_del { 1454sub _sig_del {
1364 undef $SIG_TW 1455 undef $SIG_TW
1401 # probe for availability of Async::Interrupt 1492 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) { 1493 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1494 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404 1495
1405 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1496 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1497 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407 1498
1408 } else { 1499 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1500 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410 1501
1411 require Fcntl; 1502 require Fcntl;
1427 } 1518 }
1428 1519
1429 $SIGPIPE_R 1520 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1521 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431 1522
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1523 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433 } 1524 }
1434 1525
1435 *signal = sub { 1526 *signal = sub {
1436 my (undef, %arg) = @_; 1527 my (undef, %arg) = @_;
1437 1528
1526 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1617 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527 ? 1 1618 ? 1
1528 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1619 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1529 1620
1530 unless ($CHLD_W) { 1621 unless ($CHLD_W) {
1531 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1622 $CHLD_W = AE::signal CHLD => \&_sigchld;
1532 # child could be a zombie already, so make at least one round 1623 # child could be a zombie already, so make at least one round
1533 &_sigchld; 1624 &_sigchld;
1534 } 1625 }
1535 1626
1536 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1627 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1562 # never use more then 50% of the time for the idle watcher, 1653 # never use more then 50% of the time for the idle watcher,
1563 # within some limits 1654 # within some limits
1564 $w = 0.0001 if $w < 0.0001; 1655 $w = 0.0001 if $w < 0.0001;
1565 $w = 5 if $w > 5; 1656 $w = 5 if $w > 5;
1566 1657
1567 $w = AnyEvent->timer (after => $w, cb => $rcb); 1658 $w = AE::timer $w, 0, $rcb;
1568 } else { 1659 } else {
1569 # clean up... 1660 # clean up...
1570 undef $w; 1661 undef $w;
1571 undef $rcb; 1662 undef $rcb;
1572 } 1663 }
1573 }; 1664 };
1574 1665
1575 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1666 $w = AE::timer 0.05, 0, $rcb;
1576 1667
1577 bless \\$cb, "AnyEvent::Base::idle" 1668 bless \\$cb, "AnyEvent::Base::idle"
1578} 1669}
1579 1670
1580sub AnyEvent::Base::idle::DESTROY { 1671sub AnyEvent::Base::idle::DESTROY {
1640 1731
1641 @_ 1732 @_
1642 and $cv->{_ae_cb} = shift 1733 and $cv->{_ae_cb} = shift
1643 and $cv->{_ae_sent} 1734 and $cv->{_ae_sent}
1644 and (delete $cv->{_ae_cb})->($cv); 1735 and (delete $cv->{_ae_cb})->($cv);
1736
1645 $cv->{_ae_cb} 1737 $cv->{_ae_cb}
1646} 1738}
1647 1739
1648sub begin { 1740sub begin {
1649 ++$_[0]{_ae_counter}; 1741 ++$_[0]{_ae_counter};
1656} 1748}
1657 1749
1658# undocumented/compatibility with pre-3.4 1750# undocumented/compatibility with pre-3.4
1659*broadcast = \&send; 1751*broadcast = \&send;
1660*wait = \&_wait; 1752*wait = \&_wait;
1661
1662#############################################################################
1663# "new" API, currently only emulation of it
1664#############################################################################
1665
1666package AE;
1667
1668sub io($$$) {
1669 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1670}
1671
1672sub timer($$$) {
1673 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1674}
1675
1676sub signal($$) {
1677 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1678}
1679
1680sub child($$) {
1681 AnyEvent->child (pid => $_[0], cb => $_[1]);
1682}
1683
1684sub idle($) {
1685 AnyEvent->idle (cb => $_[0]);
1686}
1687
1688sub cv() {
1689 AnyEvent->condvar
1690}
1691
1692sub now() {
1693 AnyEvent->now
1694}
1695
1696sub now_update() {
1697 AnyEvent->now_update
1698}
1699
1700sub time() {
1701 AnyEvent->time
1702}
1703 1753
1704=head1 ERROR AND EXCEPTION HANDLING 1754=head1 ERROR AND EXCEPTION HANDLING
1705 1755
1706In general, AnyEvent does not do any error handling - it relies on the 1756In general, AnyEvent does not do any error handling - it relies on the
1707caller to do that if required. The L<AnyEvent::Strict> module (see also 1757caller to do that if required. The L<AnyEvent::Strict> module (see also
1901 warn "read: $input\n"; # output what has been read 1951 warn "read: $input\n"; # output what has been read
1902 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1952 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1903 }, 1953 },
1904 ); 1954 );
1905 1955
1906 my $time_watcher; # can only be used once
1907
1908 sub new_timer {
1909 $timer = AnyEvent->timer (after => 1, cb => sub { 1956 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1910 warn "timeout\n"; # print 'timeout' about every second 1957 warn "timeout\n"; # print 'timeout' at most every second
1911 &new_timer; # and restart the time
1912 }); 1958 });
1913 }
1914
1915 new_timer; # create first timer
1916 1959
1917 $cv->recv; # wait until user enters /^q/i 1960 $cv->recv; # wait until user enters /^q/i
1918 1961
1919=head1 REAL-WORLD EXAMPLE 1962=head1 REAL-WORLD EXAMPLE
1920 1963
2051through AnyEvent. The benchmark creates a lot of timers (with a zero 2094through AnyEvent. The benchmark creates a lot of timers (with a zero
2052timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2095timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2053which it is), lets them fire exactly once and destroys them again. 2096which it is), lets them fire exactly once and destroys them again.
2054 2097
2055Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2098Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2056distribution. 2099distribution. It uses the L<AE> interface, which makes a real difference
2100for the EV and Perl backends only.
2057 2101
2058=head3 Explanation of the columns 2102=head3 Explanation of the columns
2059 2103
2060I<watcher> is the number of event watchers created/destroyed. Since 2104I<watcher> is the number of event watchers created/destroyed. Since
2061different event models feature vastly different performances, each event 2105different event models feature vastly different performances, each event
2082watcher. 2126watcher.
2083 2127
2084=head3 Results 2128=head3 Results
2085 2129
2086 name watchers bytes create invoke destroy comment 2130 name watchers bytes create invoke destroy comment
2087 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2131 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2088 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2132 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2089 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2133 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2090 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2134 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2091 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2135 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2092 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2136 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2093 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2137 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2094 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2138 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2095 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2139 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2096 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2140 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2097 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2141 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2098 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2142 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2099 2143
2100=head3 Discussion 2144=head3 Discussion
2101 2145
2102The benchmark does I<not> measure scalability of the event loop very 2146The benchmark does I<not> measure scalability of the event loop very
2103well. For example, a select-based event loop (such as the pure perl one) 2147well. For example, a select-based event loop (such as the pure perl one)
2115benchmark machine, handling an event takes roughly 1600 CPU cycles with 2159benchmark machine, handling an event takes roughly 1600 CPU cycles with
2116EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2160EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2117cycles with POE. 2161cycles with POE.
2118 2162
2119C<EV> is the sole leader regarding speed and memory use, which are both 2163C<EV> is the sole leader regarding speed and memory use, which are both
2120maximal/minimal, respectively. Even when going through AnyEvent, it uses 2164maximal/minimal, respectively. When using the L<AE> API there is zero
2165overhead (when going through the AnyEvent API create is about 5-6 times
2166slower, with other times being equal, so still uses far less memory than
2121far less memory than any other event loop and is still faster than Event 2167any other event loop and is still faster than Event natively).
2122natively.
2123 2168
2124The pure perl implementation is hit in a few sweet spots (both the 2169The pure perl implementation is hit in a few sweet spots (both the
2125constant timeout and the use of a single fd hit optimisations in the perl 2170constant timeout and the use of a single fd hit optimisations in the perl
2126interpreter and the backend itself). Nevertheless this shows that it 2171interpreter and the backend itself). Nevertheless this shows that it
2127adds very little overhead in itself. Like any select-based backend its 2172adds very little overhead in itself. Like any select-based backend its
2201In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2246In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2202(1%) are active. This mirrors the activity of large servers with many 2247(1%) are active. This mirrors the activity of large servers with many
2203connections, most of which are idle at any one point in time. 2248connections, most of which are idle at any one point in time.
2204 2249
2205Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2250Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2206distribution. 2251distribution. It uses the L<AE> interface, which makes a real difference
2252for the EV and Perl backends only.
2207 2253
2208=head3 Explanation of the columns 2254=head3 Explanation of the columns
2209 2255
2210I<sockets> is the number of sockets, and twice the number of "servers" (as 2256I<sockets> is the number of sockets, and twice the number of "servers" (as
2211each server has a read and write socket end). 2257each server has a read and write socket end).
2219a new one that moves the timeout into the future. 2265a new one that moves the timeout into the future.
2220 2266
2221=head3 Results 2267=head3 Results
2222 2268
2223 name sockets create request 2269 name sockets create request
2224 EV 20000 69.01 11.16 2270 EV 20000 62.66 7.99
2225 Perl 20000 73.32 35.87 2271 Perl 20000 68.32 32.64
2226 IOAsync 20000 157.00 98.14 epoll 2272 IOAsync 20000 174.06 101.15 epoll
2227 IOAsync 20000 159.31 616.06 poll 2273 IOAsync 20000 174.67 610.84 poll
2228 Event 20000 212.62 257.32 2274 Event 20000 202.69 242.91
2229 Glib 20000 651.16 1896.30 2275 Glib 20000 557.01 1689.52
2230 POE 20000 349.67 12317.24 uses POE::Loop::Event 2276 POE 20000 341.54 12086.32 uses POE::Loop::Event
2231 2277
2232=head3 Discussion 2278=head3 Discussion
2233 2279
2234This benchmark I<does> measure scalability and overall performance of the 2280This benchmark I<does> measure scalability and overall performance of the
2235particular event loop. 2281particular event loop.
2361As you can see, the AnyEvent + EV combination even beats the 2407As you can see, the AnyEvent + EV combination even beats the
2362hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2408hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2363backend easily beats IO::Lambda and POE. 2409backend easily beats IO::Lambda and POE.
2364 2410
2365And even the 100% non-blocking version written using the high-level (and 2411And even the 100% non-blocking version written using the high-level (and
2366slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2412slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2367large margin, even though it does all of DNS, tcp-connect and socket I/O 2413higher level ("unoptimised") abstractions by a large margin, even though
2368in a non-blocking way. 2414it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2369 2415
2370The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2416The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2371F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2417F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2372part of the IO::lambda distribution and were used without any changes. 2418part of the IO::Lambda distribution and were used without any changes.
2373 2419
2374 2420
2375=head1 SIGNALS 2421=head1 SIGNALS
2376 2422
2377AnyEvent currently installs handlers for these signals: 2423AnyEvent currently installs handlers for these signals:
2419it's built-in modules) are required to use it. 2465it's built-in modules) are required to use it.
2420 2466
2421That does not mean that AnyEvent won't take advantage of some additional 2467That does not mean that AnyEvent won't take advantage of some additional
2422modules if they are installed. 2468modules if they are installed.
2423 2469
2424This section epxlains which additional modules will be used, and how they 2470This section explains which additional modules will be used, and how they
2425affect AnyEvent's operetion. 2471affect AnyEvent's operation.
2426 2472
2427=over 4 2473=over 4
2428 2474
2429=item L<Async::Interrupt> 2475=item L<Async::Interrupt>
2430 2476
2435catch the signals) with some delay (default is 10 seconds, look for 2481catch the signals) with some delay (default is 10 seconds, look for
2436C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2482C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2437 2483
2438If this module is available, then it will be used to implement signal 2484If this module is available, then it will be used to implement signal
2439catching, which means that signals will not be delayed, and the event loop 2485catching, which means that signals will not be delayed, and the event loop
2440will not be interrupted regularly, which is more efficient (And good for 2486will not be interrupted regularly, which is more efficient (and good for
2441battery life on laptops). 2487battery life on laptops).
2442 2488
2443This affects not just the pure-perl event loop, but also other event loops 2489This affects not just the pure-perl event loop, but also other event loops
2444that have no signal handling on their own (e.g. Glib, Tk, Qt). 2490that have no signal handling on their own (e.g. Glib, Tk, Qt).
2445 2491
2466lot less memory), but otherwise doesn't affect guard operation much. It is 2512lot less memory), but otherwise doesn't affect guard operation much. It is
2467purely used for performance. 2513purely used for performance.
2468 2514
2469=item L<JSON> and L<JSON::XS> 2515=item L<JSON> and L<JSON::XS>
2470 2516
2471This module is required when you want to read or write JSON data via 2517One of these modules is required when you want to read or write JSON data
2472L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2518via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2473advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2519advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2474 2520
2475In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2521In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2476installed. 2522installed.
2477 2523
2492 2538
2493 2539
2494=head1 FORK 2540=head1 FORK
2495 2541
2496Most event libraries are not fork-safe. The ones who are usually are 2542Most event libraries are not fork-safe. The ones who are usually are
2497because they rely on inefficient but fork-safe C<select> or C<poll> 2543because they rely on inefficient but fork-safe C<select> or C<poll> calls
2498calls. Only L<EV> is fully fork-aware. 2544- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2545are usually badly thought-out hacks that are incompatible with fork in
2546one way or another. Only L<EV> is fully fork-aware and ensures that you
2547continue event-processing in both parent and child (or both, if you know
2548what you are doing).
2549
2550This means that, in general, you cannot fork and do event processing in
2551the child if the event library was initialised before the fork (which
2552usually happens when the first AnyEvent watcher is created, or the library
2553is loaded).
2499 2554
2500If you have to fork, you must either do so I<before> creating your first 2555If you have to fork, you must either do so I<before> creating your first
2501watcher OR you must not use AnyEvent at all in the child OR you must do 2556watcher OR you must not use AnyEvent at all in the child OR you must do
2502something completely out of the scope of AnyEvent. 2557something completely out of the scope of AnyEvent.
2558
2559The problem of doing event processing in the parent I<and> the child
2560is much more complicated: even for backends that I<are> fork-aware or
2561fork-safe, their behaviour is not usually what you want: fork clones all
2562watchers, that means all timers, I/O watchers etc. are active in both
2563parent and child, which is almost never what you want. USing C<exec>
2564to start worker children from some kind of manage rprocess is usually
2565preferred, because it is much easier and cleaner, at the expense of having
2566to have another binary.
2503 2567
2504 2568
2505=head1 SECURITY CONSIDERATIONS 2569=head1 SECURITY CONSIDERATIONS
2506 2570
2507AnyEvent can be forced to load any event model via 2571AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines