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.266 by root, Thu Jul 30 03:41:56 2009 UTC vs.
Revision 1.303 by root, Sat Dec 5 02:52:03 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
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 });
400 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).
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 do 428callbacks to signals in a generic way, which is a pity, as you cannot
405race-free signal handling in perl. AnyEvent will try to do it's best, but 429do race-free signal handling in perl, requiring C libraries for
430this. AnyEvent will try to do it's best, which means in some cases,
406in some cases, signals will be delayed. The maximum time a signal might 431signals will be delayed. The maximum time a signal might be delayed is
407be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 432specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
408seconds). This variable can be changed only before the first signal 433variable can be changed only before the first signal watcher is created,
409watcher is created, and should be left alone otherwise. Higher values 434and should be left alone otherwise. This variable determines how often
435AnyEvent polls for signals (in case a wake-up was missed). Higher values
410will cause fewer spurious wake-ups, which is better for power and CPU 436will cause fewer spurious wake-ups, which is better for power and CPU
437saving.
438
411saving. All these problems can be avoided by installing the optional 439All these problems can be avoided by installing the optional
412L<Async::Interrupt> module. This will not work with inherently broken 440L<Async::Interrupt> module, which works with most event loops. It will not
413event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 441work with inherently broken event loops such as L<Event> or L<Event::Lib>
414currently, as POE does it's own workaround with one-second latency). With 442(and not with L<POE> currently, as POE does it's own workaround with
415those, you just have to suffer the delays. 443one-second latency). For those, you just have to suffer the delays.
416 444
417=head2 CHILD PROCESS WATCHERS 445=head2 CHILD PROCESS WATCHERS
418 446
419 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 447 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
420 448
588 after => 1, 616 after => 1,
589 cb => sub { $result_ready->send }, 617 cb => sub { $result_ready->send },
590 ); 618 );
591 619
592 # this "blocks" (while handling events) till the callback 620 # this "blocks" (while handling events) till the callback
593 # calls -<send 621 # calls ->send
594 $result_ready->recv; 622 $result_ready->recv;
595 623
596Example: wait for a timer, but take advantage of the fact that condition 624Example: wait for a timer, but take advantage of the fact that condition
597variables are also callable directly. 625variables are also callable directly.
598 626
662one. For example, a function that pings many hosts in parallel might want 690one. For example, a function that pings many hosts in parallel might want
663to use a condition variable for the whole process. 691to use a condition variable for the whole process.
664 692
665Every call to C<< ->begin >> will increment a counter, and every call to 693Every call to C<< ->begin >> will increment a counter, and every call to
666C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 694C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
667>>, the (last) callback passed to C<begin> will be executed. That callback 695>>, the (last) callback passed to C<begin> will be executed, passing the
668is I<supposed> to call C<< ->send >>, but that is not required. If no 696condvar as first argument. That callback is I<supposed> to call C<< ->send
669callback was set, C<send> will be called without any arguments. 697>>, but that is not required. If no group callback was set, C<send> will
698be called without any arguments.
670 699
671You can think of C<< $cv->send >> giving you an OR condition (one call 700You can think of C<< $cv->send >> giving you an OR condition (one call
672sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 701sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
673condition (all C<begin> calls must be C<end>'ed before the condvar sends). 702condition (all C<begin> calls must be C<end>'ed before the condvar sends).
674 703
701begung can potentially be zero: 730begung can potentially be zero:
702 731
703 my $cv = AnyEvent->condvar; 732 my $cv = AnyEvent->condvar;
704 733
705 my %result; 734 my %result;
706 $cv->begin (sub { $cv->send (\%result) }); 735 $cv->begin (sub { shift->send (\%result) });
707 736
708 for my $host (@list_of_hosts) { 737 for my $host (@list_of_hosts) {
709 $cv->begin; 738 $cv->begin;
710 ping_host_then_call_callback $host, sub { 739 ping_host_then_call_callback $host, sub {
711 $result{$host} = ...; 740 $result{$host} = ...;
786=item $cb = $cv->cb ($cb->($cv)) 815=item $cb = $cv->cb ($cb->($cv))
787 816
788This is a mutator function that returns the callback set and optionally 817This is a mutator function that returns the callback set and optionally
789replaces it before doing so. 818replaces it before doing so.
790 819
791The callback will be called when the condition becomes "true", i.e. when 820The callback will be called when the condition becomes (or already was)
792C<send> or C<croak> are called, with the only argument being the condition 821"true", i.e. when C<send> or C<croak> are called (or were called), with
793variable itself. Calling C<recv> inside the callback or at any later time 822the only argument being the condition variable itself. Calling C<recv>
794is guaranteed not to block. 823inside the callback or at any later time is guaranteed not to block.
795 824
796=back 825=back
797 826
798=head1 SUPPORTED EVENT LOOPS/BACKENDS 827=head1 SUPPORTED EVENT LOOPS/BACKENDS
799 828
802=over 4 831=over 4
803 832
804=item Backends that are autoprobed when no other event loop can be found. 833=item Backends that are autoprobed when no other event loop can be found.
805 834
806EV is the preferred backend when no other event loop seems to be in 835EV is the preferred backend when no other event loop seems to be in
807use. If EV is not installed, then AnyEvent will try Event, and, failing 836use. If EV is not installed, then AnyEvent will fall back to its own
808that, will fall back to its own pure-perl implementation, which is 837pure-perl implementation, which is available everywhere as it comes with
809available everywhere as it comes with AnyEvent itself. 838AnyEvent itself.
810 839
811 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 840 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
812 AnyEvent::Impl::Event based on Event, very stable, few glitches.
813 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 841 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
814 842
815=item Backends that are transparently being picked up when they are used. 843=item Backends that are transparently being picked up when they are used.
816 844
817These will be used when they are currently loaded when the first watcher 845These will be used when they are currently loaded when the first watcher
818is created, in which case it is assumed that the application is using 846is created, in which case it is assumed that the application is using
819them. This means that AnyEvent will automatically pick the right backend 847them. This means that AnyEvent will automatically pick the right backend
820when the main program loads an event module before anything starts to 848when the main program loads an event module before anything starts to
821create watchers. Nothing special needs to be done by the main program. 849create watchers. Nothing special needs to be done by the main program.
822 850
851 AnyEvent::Impl::Event based on Event, very stable, few glitches.
823 AnyEvent::Impl::Glib based on Glib, slow but very stable. 852 AnyEvent::Impl::Glib based on Glib, slow but very stable.
824 AnyEvent::Impl::Tk based on Tk, very broken. 853 AnyEvent::Impl::Tk based on Tk, very broken.
825 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 854 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
826 AnyEvent::Impl::POE based on POE, very slow, some limitations. 855 AnyEvent::Impl::POE based on POE, very slow, some limitations.
827 AnyEvent::Impl::Irssi used when running within irssi. 856 AnyEvent::Impl::Irssi used when running within irssi.
1101 1130
1102package AnyEvent; 1131package AnyEvent;
1103 1132
1104# basically a tuned-down version of common::sense 1133# basically a tuned-down version of common::sense
1105sub common_sense { 1134sub common_sense {
1106 # no warnings 1135 # from common:.sense 1.0
1107 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1136 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1108 # use strict vars subs 1137 # use strict vars subs
1109 $^H |= 0x00000600; 1138 $^H |= 0x00000600;
1110} 1139}
1111 1140
1112BEGIN { AnyEvent::common_sense } 1141BEGIN { AnyEvent::common_sense }
1113 1142
1114use Carp (); 1143use Carp ();
1115 1144
1116our $VERSION = 4.881; 1145our $VERSION = '5.22';
1117our $MODEL; 1146our $MODEL;
1118 1147
1119our $AUTOLOAD; 1148our $AUTOLOAD;
1120our @ISA; 1149our @ISA;
1121 1150
1122our @REGISTRY; 1151our @REGISTRY;
1123
1124our $WIN32;
1125 1152
1126our $VERBOSE; 1153our $VERBOSE;
1127 1154
1128BEGIN { 1155BEGIN {
1129 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1156 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1147 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1174 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1148} 1175}
1149 1176
1150my @models = ( 1177my @models = (
1151 [EV:: => AnyEvent::Impl::EV:: , 1], 1178 [EV:: => AnyEvent::Impl::EV:: , 1],
1152 [Event:: => AnyEvent::Impl::Event::, 1],
1153 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1179 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1154 # everything below here will not (normally) be autoprobed 1180 # everything below here will not (normally) be autoprobed
1155 # as the pureperl backend should work everywhere 1181 # as the pureperl backend should work everywhere
1156 # and is usually faster 1182 # and is usually faster
1183 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1184 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1158 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1185 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1159 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1186 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1160 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1187 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1161 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1188 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1164 [Prima:: => AnyEvent::Impl::POE::], 1191 [Prima:: => AnyEvent::Impl::POE::],
1165 # IO::Async is just too broken - we would need workarounds for its 1192 # IO::Async is just too broken - we would need workarounds for its
1166 # byzantine signal and broken child handling, among others. 1193 # byzantine signal and broken child handling, among others.
1167 # IO::Async is rather hard to detect, as it doesn't have any 1194 # IO::Async is rather hard to detect, as it doesn't have any
1168 # obvious default class. 1195 # obvious default class.
1169# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1196 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1170# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1197 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1171# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1198 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1199 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1172); 1200);
1173 1201
1174our %method = map +($_ => 1), 1202our %method = map +($_ => 1),
1175 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1203 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1176 1204
1283 # we assume CLOEXEC is already set by perl in all important cases 1311 # we assume CLOEXEC is already set by perl in all important cases
1284 1312
1285 ($fh2, $rw) 1313 ($fh2, $rw)
1286} 1314}
1287 1315
1316=head1 SIMPLIFIED AE API
1317
1318Starting with version 5.0, AnyEvent officially supports a second, much
1319simpler, API that is designed to reduce the calling, typing and memory
1320overhead.
1321
1322See the L<AE> manpage for details.
1323
1324=cut
1325
1326package AE;
1327
1328our $VERSION = $AnyEvent::VERSION;
1329
1330sub io($$$) {
1331 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1332}
1333
1334sub timer($$$) {
1335 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1336}
1337
1338sub signal($$) {
1339 AnyEvent->signal (signal => $_[0], cb => $_[1])
1340}
1341
1342sub child($$) {
1343 AnyEvent->child (pid => $_[0], cb => $_[1])
1344}
1345
1346sub idle($) {
1347 AnyEvent->idle (cb => $_[0])
1348}
1349
1350sub cv(;&) {
1351 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1352}
1353
1354sub now() {
1355 AnyEvent->now
1356}
1357
1358sub now_update() {
1359 AnyEvent->now_update
1360}
1361
1362sub time() {
1363 AnyEvent->time
1364}
1365
1288package AnyEvent::Base; 1366package AnyEvent::Base;
1289 1367
1290# default implementations for many methods 1368# default implementations for many methods
1291 1369
1292sub _time { 1370sub _time() {
1293 # probe for availability of Time::HiRes 1371 # probe for availability of Time::HiRes
1294 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1372 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1295 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1373 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1296 *_time = \&Time::HiRes::time; 1374 *_time = \&Time::HiRes::time;
1297 # if (eval "use POSIX (); (POSIX::times())... 1375 # if (eval "use POSIX (); (POSIX::times())...
1317 1395
1318our $HAVE_ASYNC_INTERRUPT; 1396our $HAVE_ASYNC_INTERRUPT;
1319 1397
1320sub _have_async_interrupt() { 1398sub _have_async_interrupt() {
1321 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1399 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1322 && eval "use Async::Interrupt 1.0 (); 1") 1400 && eval "use Async::Interrupt 1.02 (); 1")
1323 unless defined $HAVE_ASYNC_INTERRUPT; 1401 unless defined $HAVE_ASYNC_INTERRUPT;
1324 1402
1325 $HAVE_ASYNC_INTERRUPT 1403 $HAVE_ASYNC_INTERRUPT
1326} 1404}
1327 1405
1330our ($SIG_COUNT, $SIG_TW); 1408our ($SIG_COUNT, $SIG_TW);
1331 1409
1332sub _signal_exec { 1410sub _signal_exec {
1333 $HAVE_ASYNC_INTERRUPT 1411 $HAVE_ASYNC_INTERRUPT
1334 ? $SIGPIPE_R->drain 1412 ? $SIGPIPE_R->drain
1335 : sysread $SIGPIPE_R, my $dummy, 9; 1413 : sysread $SIGPIPE_R, (my $dummy), 9;
1336 1414
1337 while (%SIG_EV) { 1415 while (%SIG_EV) {
1338 for (keys %SIG_EV) { 1416 for (keys %SIG_EV) {
1339 delete $SIG_EV{$_}; 1417 delete $SIG_EV{$_};
1340 $_->() for values %{ $SIG_CB{$_} || {} }; 1418 $_->() for values %{ $SIG_CB{$_} || {} };
1344 1422
1345# install a dummy wakeup watcher to reduce signal catching latency 1423# install a dummy wakeup watcher to reduce signal catching latency
1346sub _sig_add() { 1424sub _sig_add() {
1347 unless ($SIG_COUNT++) { 1425 unless ($SIG_COUNT++) {
1348 # try to align timer on a full-second boundary, if possible 1426 # try to align timer on a full-second boundary, if possible
1349 my $NOW = AnyEvent->now; 1427 my $NOW = AE::now;
1350 1428
1351 $SIG_TW = AnyEvent->timer ( 1429 $SIG_TW = AE::timer
1352 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1430 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1353 interval => $MAX_SIGNAL_LATENCY, 1431 $MAX_SIGNAL_LATENCY,
1354 cb => sub { }, # just for the PERL_ASYNC_CHECK 1432 sub { } # just for the PERL_ASYNC_CHECK
1355 ); 1433 ;
1356 } 1434 }
1357} 1435}
1358 1436
1359sub _sig_del { 1437sub _sig_del {
1360 undef $SIG_TW 1438 undef $SIG_TW
1397 # probe for availability of Async::Interrupt 1475 # probe for availability of Async::Interrupt
1398 if (_have_async_interrupt) { 1476 if (_have_async_interrupt) {
1399 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1477 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1400 1478
1401 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1479 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1402 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1480 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1403 1481
1404 } else { 1482 } else {
1405 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1483 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1406 1484
1407 require Fcntl; 1485 require Fcntl;
1423 } 1501 }
1424 1502
1425 $SIGPIPE_R 1503 $SIGPIPE_R
1426 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1504 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1427 1505
1428 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1506 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1429 } 1507 }
1430 1508
1431 *signal = sub { 1509 *signal = sub {
1432 my (undef, %arg) = @_; 1510 my (undef, %arg) = @_;
1433 1511
1522 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1600 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1523 ? 1 1601 ? 1
1524 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1602 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1525 1603
1526 unless ($CHLD_W) { 1604 unless ($CHLD_W) {
1527 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1605 $CHLD_W = AE::signal CHLD => \&_sigchld;
1528 # child could be a zombie already, so make at least one round 1606 # child could be a zombie already, so make at least one round
1529 &_sigchld; 1607 &_sigchld;
1530 } 1608 }
1531 1609
1532 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1610 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1558 # never use more then 50% of the time for the idle watcher, 1636 # never use more then 50% of the time for the idle watcher,
1559 # within some limits 1637 # within some limits
1560 $w = 0.0001 if $w < 0.0001; 1638 $w = 0.0001 if $w < 0.0001;
1561 $w = 5 if $w > 5; 1639 $w = 5 if $w > 5;
1562 1640
1563 $w = AnyEvent->timer (after => $w, cb => $rcb); 1641 $w = AE::timer $w, 0, $rcb;
1564 } else { 1642 } else {
1565 # clean up... 1643 # clean up...
1566 undef $w; 1644 undef $w;
1567 undef $rcb; 1645 undef $rcb;
1568 } 1646 }
1569 }; 1647 };
1570 1648
1571 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1649 $w = AE::timer 0.05, 0, $rcb;
1572 1650
1573 bless \\$cb, "AnyEvent::Base::idle" 1651 bless \\$cb, "AnyEvent::Base::idle"
1574} 1652}
1575 1653
1576sub AnyEvent::Base::idle::DESTROY { 1654sub AnyEvent::Base::idle::DESTROY {
1630 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1708 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1631 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1709 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1632} 1710}
1633 1711
1634sub cb { 1712sub cb {
1635 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1713 my $cv = shift;
1714
1715 @_
1716 and $cv->{_ae_cb} = shift
1717 and $cv->{_ae_sent}
1718 and (delete $cv->{_ae_cb})->($cv);
1719
1636 $_[0]{_ae_cb} 1720 $cv->{_ae_cb}
1637} 1721}
1638 1722
1639sub begin { 1723sub begin {
1640 ++$_[0]{_ae_counter}; 1724 ++$_[0]{_ae_counter};
1641 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1725 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1647} 1731}
1648 1732
1649# undocumented/compatibility with pre-3.4 1733# undocumented/compatibility with pre-3.4
1650*broadcast = \&send; 1734*broadcast = \&send;
1651*wait = \&_wait; 1735*wait = \&_wait;
1652
1653#############################################################################
1654# "new" API, currently only emulation of it
1655#############################################################################
1656
1657package AE;
1658
1659sub io($$$) {
1660 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1661}
1662
1663sub timer($$$) {
1664 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1665}
1666
1667sub signal($$) {
1668 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1669}
1670
1671sub child($$) {
1672 AnyEvent->child (pid => $_[0], cb => $_[1]);
1673}
1674
1675sub idle($) {
1676 AnyEvent->idle (cb => $_[0]);
1677}
1678
1679sub cv() {
1680 AnyEvent->condvar
1681}
1682
1683sub now() {
1684 AnyEvent->now
1685}
1686
1687sub now_update() {
1688 AnyEvent->now_update
1689}
1690
1691sub time() {
1692 AnyEvent->time
1693}
1694 1736
1695=head1 ERROR AND EXCEPTION HANDLING 1737=head1 ERROR AND EXCEPTION HANDLING
1696 1738
1697In general, AnyEvent does not do any error handling - it relies on the 1739In general, AnyEvent does not do any error handling - it relies on the
1698caller to do that if required. The L<AnyEvent::Strict> module (see also 1740caller to do that if required. The L<AnyEvent::Strict> module (see also
1892 warn "read: $input\n"; # output what has been read 1934 warn "read: $input\n"; # output what has been read
1893 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1935 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1894 }, 1936 },
1895 ); 1937 );
1896 1938
1897 my $time_watcher; # can only be used once
1898
1899 sub new_timer {
1900 $timer = AnyEvent->timer (after => 1, cb => sub { 1939 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1901 warn "timeout\n"; # print 'timeout' about every second 1940 warn "timeout\n"; # print 'timeout' at most every second
1902 &new_timer; # and restart the time
1903 }); 1941 });
1904 }
1905
1906 new_timer; # create first timer
1907 1942
1908 $cv->recv; # wait until user enters /^q/i 1943 $cv->recv; # wait until user enters /^q/i
1909 1944
1910=head1 REAL-WORLD EXAMPLE 1945=head1 REAL-WORLD EXAMPLE
1911 1946
2042through AnyEvent. The benchmark creates a lot of timers (with a zero 2077through AnyEvent. The benchmark creates a lot of timers (with a zero
2043timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2078timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2044which it is), lets them fire exactly once and destroys them again. 2079which it is), lets them fire exactly once and destroys them again.
2045 2080
2046Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2081Source code for this benchmark is found as F<eg/bench> in the AnyEvent
2047distribution. 2082distribution. It uses the L<AE> interface, which makes a real difference
2083for the EV and Perl backends only.
2048 2084
2049=head3 Explanation of the columns 2085=head3 Explanation of the columns
2050 2086
2051I<watcher> is the number of event watchers created/destroyed. Since 2087I<watcher> is the number of event watchers created/destroyed. Since
2052different event models feature vastly different performances, each event 2088different event models feature vastly different performances, each event
2073watcher. 2109watcher.
2074 2110
2075=head3 Results 2111=head3 Results
2076 2112
2077 name watchers bytes create invoke destroy comment 2113 name watchers bytes create invoke destroy comment
2078 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2114 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2079 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2115 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2080 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2116 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2081 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2117 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2082 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2118 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2083 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2119 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2084 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2120 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2085 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2121 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2086 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2122 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2087 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2123 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2088 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2124 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2089 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2125 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2090 2126
2091=head3 Discussion 2127=head3 Discussion
2092 2128
2093The benchmark does I<not> measure scalability of the event loop very 2129The benchmark does I<not> measure scalability of the event loop very
2094well. For example, a select-based event loop (such as the pure perl one) 2130well. For example, a select-based event loop (such as the pure perl one)
2106benchmark machine, handling an event takes roughly 1600 CPU cycles with 2142benchmark machine, handling an event takes roughly 1600 CPU cycles with
2107EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2143EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2108cycles with POE. 2144cycles with POE.
2109 2145
2110C<EV> is the sole leader regarding speed and memory use, which are both 2146C<EV> is the sole leader regarding speed and memory use, which are both
2111maximal/minimal, respectively. Even when going through AnyEvent, it uses 2147maximal/minimal, respectively. When using the L<AE> API there is zero
2148overhead (when going through the AnyEvent API create is about 5-6 times
2149slower, with other times being equal, so still uses far less memory than
2112far less memory than any other event loop and is still faster than Event 2150any other event loop and is still faster than Event natively).
2113natively.
2114 2151
2115The pure perl implementation is hit in a few sweet spots (both the 2152The pure perl implementation is hit in a few sweet spots (both the
2116constant timeout and the use of a single fd hit optimisations in the perl 2153constant timeout and the use of a single fd hit optimisations in the perl
2117interpreter and the backend itself). Nevertheless this shows that it 2154interpreter and the backend itself). Nevertheless this shows that it
2118adds very little overhead in itself. Like any select-based backend its 2155adds very little overhead in itself. Like any select-based backend its
2192In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2229In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2193(1%) are active. This mirrors the activity of large servers with many 2230(1%) are active. This mirrors the activity of large servers with many
2194connections, most of which are idle at any one point in time. 2231connections, most of which are idle at any one point in time.
2195 2232
2196Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2233Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2197distribution. 2234distribution. It uses the L<AE> interface, which makes a real difference
2235for the EV and Perl backends only.
2198 2236
2199=head3 Explanation of the columns 2237=head3 Explanation of the columns
2200 2238
2201I<sockets> is the number of sockets, and twice the number of "servers" (as 2239I<sockets> is the number of sockets, and twice the number of "servers" (as
2202each server has a read and write socket end). 2240each server has a read and write socket end).
2210a new one that moves the timeout into the future. 2248a new one that moves the timeout into the future.
2211 2249
2212=head3 Results 2250=head3 Results
2213 2251
2214 name sockets create request 2252 name sockets create request
2215 EV 20000 69.01 11.16 2253 EV 20000 62.66 7.99
2216 Perl 20000 73.32 35.87 2254 Perl 20000 68.32 32.64
2217 IOAsync 20000 157.00 98.14 epoll 2255 IOAsync 20000 174.06 101.15 epoll
2218 IOAsync 20000 159.31 616.06 poll 2256 IOAsync 20000 174.67 610.84 poll
2219 Event 20000 212.62 257.32 2257 Event 20000 202.69 242.91
2220 Glib 20000 651.16 1896.30 2258 Glib 20000 557.01 1689.52
2221 POE 20000 349.67 12317.24 uses POE::Loop::Event 2259 POE 20000 341.54 12086.32 uses POE::Loop::Event
2222 2260
2223=head3 Discussion 2261=head3 Discussion
2224 2262
2225This benchmark I<does> measure scalability and overall performance of the 2263This benchmark I<does> measure scalability and overall performance of the
2226particular event loop. 2264particular event loop.
2352As you can see, the AnyEvent + EV combination even beats the 2390As you can see, the AnyEvent + EV combination even beats the
2353hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2391hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2354backend easily beats IO::Lambda and POE. 2392backend easily beats IO::Lambda and POE.
2355 2393
2356And even the 100% non-blocking version written using the high-level (and 2394And even the 100% non-blocking version written using the high-level (and
2357slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2395slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2358large margin, even though it does all of DNS, tcp-connect and socket I/O 2396higher level ("unoptimised") abstractions by a large margin, even though
2359in a non-blocking way. 2397it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2360 2398
2361The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2399The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2362F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2400F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2363part of the IO::lambda distribution and were used without any changes. 2401part of the IO::Lambda distribution and were used without any changes.
2364 2402
2365 2403
2366=head1 SIGNALS 2404=head1 SIGNALS
2367 2405
2368AnyEvent currently installs handlers for these signals: 2406AnyEvent currently installs handlers for these signals:
2410it's built-in modules) are required to use it. 2448it's built-in modules) are required to use it.
2411 2449
2412That does not mean that AnyEvent won't take advantage of some additional 2450That does not mean that AnyEvent won't take advantage of some additional
2413modules if they are installed. 2451modules if they are installed.
2414 2452
2415This section epxlains which additional modules will be used, and how they 2453This section explains which additional modules will be used, and how they
2416affect AnyEvent's operetion. 2454affect AnyEvent's operation.
2417 2455
2418=over 4 2456=over 4
2419 2457
2420=item L<Async::Interrupt> 2458=item L<Async::Interrupt>
2421 2459
2426catch the signals) with some delay (default is 10 seconds, look for 2464catch the signals) with some delay (default is 10 seconds, look for
2427C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2465C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2428 2466
2429If this module is available, then it will be used to implement signal 2467If this module is available, then it will be used to implement signal
2430catching, which means that signals will not be delayed, and the event loop 2468catching, which means that signals will not be delayed, and the event loop
2431will not be interrupted regularly, which is more efficient (And good for 2469will not be interrupted regularly, which is more efficient (and good for
2432battery life on laptops). 2470battery life on laptops).
2433 2471
2434This affects not just the pure-perl event loop, but also other event loops 2472This affects not just the pure-perl event loop, but also other event loops
2435that have no signal handling on their own (e.g. Glib, Tk, Qt). 2473that have no signal handling on their own (e.g. Glib, Tk, Qt).
2436 2474
2457lot less memory), but otherwise doesn't affect guard operation much. It is 2495lot less memory), but otherwise doesn't affect guard operation much. It is
2458purely used for performance. 2496purely used for performance.
2459 2497
2460=item L<JSON> and L<JSON::XS> 2498=item L<JSON> and L<JSON::XS>
2461 2499
2462This module is required when you want to read or write JSON data via 2500One of these modules is required when you want to read or write JSON data
2463L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2501via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2464advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2502advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2465 2503
2466In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2504In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2467installed. 2505installed.
2468 2506
2486 2524
2487Most event libraries are not fork-safe. The ones who are usually are 2525Most event libraries are not fork-safe. The ones who are usually are
2488because they rely on inefficient but fork-safe C<select> or C<poll> 2526because they rely on inefficient but fork-safe C<select> or C<poll>
2489calls. Only L<EV> is fully fork-aware. 2527calls. Only L<EV> is fully fork-aware.
2490 2528
2529This means that, in general, you cannot fork and do event processing
2530in the child if a watcher was created before the fork (which in turn
2531initialises the event library).
2532
2491If you have to fork, you must either do so I<before> creating your first 2533If you have to fork, you must either do so I<before> creating your first
2492watcher OR you must not use AnyEvent at all in the child OR you must do 2534watcher OR you must not use AnyEvent at all in the child OR you must do
2493something completely out of the scope of AnyEvent. 2535something completely out of the scope of AnyEvent.
2536
2537The problem of doing event processing in the parent I<and> the child
2538is much more complicated: even for backends that I<are> fork-aware or
2539fork-safe, their behaviour is not usually what you want: fork clones all
2540watchers, that means all timers, I/O watchers etc. are active in both
2541parent and child, which is almost never what you want.
2494 2542
2495 2543
2496=head1 SECURITY CONSIDERATIONS 2544=head1 SECURITY CONSIDERATIONS
2497 2545
2498AnyEvent can be forced to load any event model via 2546AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines