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.281 by root, Mon Aug 10 01:17:38 2009 UTC vs.
Revision 1.312 by root, Mon Feb 15 18:02:35 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
942You should check C<$AnyEvent::MODEL> before adding to this array, though: 969You should check C<$AnyEvent::MODEL> before adding to this array, though:
943if 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
944array will be ignored. 971array will be ignored.
945 972
946Best use C<AnyEvent::post_detect { BLOCK }> when your application allows 973Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
947it,as it takes care of these details. 974it, as it takes care of these details.
948 975
949This variable is mainly useful for modules that can do something useful 976This variable is mainly useful for modules that can do something useful
950when 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
951not 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
952into 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 }
953 993
954=back 994=back
955 995
956=head1 WHAT TO DO IN A MODULE 996=head1 WHAT TO DO IN A MODULE
957 997
1106 1146
1107package AnyEvent; 1147package AnyEvent;
1108 1148
1109# basically a tuned-down version of common::sense 1149# basically a tuned-down version of common::sense
1110sub common_sense { 1150sub common_sense {
1111 # no warnings 1151 # from common:.sense 1.0
1112 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1152 ${^WARNING_BITS} = "\xfc\x3f\x33\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x00";
1113 # use strict vars subs 1153 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1114 $^H |= 0x00000600; 1154 $^H |= 0x00000600;
1115} 1155}
1116 1156
1117BEGIN { AnyEvent::common_sense } 1157BEGIN { AnyEvent::common_sense }
1118 1158
1119use Carp (); 1159use Carp ();
1120 1160
1121our $VERSION = '5.01'; 1161our $VERSION = '5.24';
1122our $MODEL; 1162our $MODEL;
1123 1163
1124our $AUTOLOAD; 1164our $AUTOLOAD;
1125our @ISA; 1165our @ISA;
1126 1166
1127our @REGISTRY; 1167our @REGISTRY;
1128 1168
1129our $WIN32;
1130
1131our $VERBOSE; 1169our $VERBOSE;
1132 1170
1133BEGIN { 1171BEGIN {
1172 eval "sub CYGWIN(){" . (($^O =~ /cygwin/i) *1) . "}";
1134 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1173 eval "sub WIN32 (){" . (($^O =~ /mswin32/i)*1) . "}";
1135 eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; 1174 eval "sub TAINT (){" . (${^TAINT} *1) . "}";
1136 1175
1137 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1176 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1138 if ${^TAINT}; 1177 if ${^TAINT};
1139 1178
1140 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1179 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1;
1201sub AnyEvent::Util::postdetect::DESTROY { 1240sub AnyEvent::Util::postdetect::DESTROY {
1202 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1241 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1203} 1242}
1204 1243
1205sub detect() { 1244sub detect() {
1245 # free some memory
1246 *detect = sub () { $MODEL };
1247
1248 local $!; # for good measure
1249 local $SIG{__DIE__};
1250
1251 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1252 my $model = "AnyEvent::Impl::$1";
1253 if (eval "require $model") {
1254 $MODEL = $model;
1255 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1256 } else {
1257 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE;
1258 }
1259 }
1260
1261 # check for already loaded models
1206 unless ($MODEL) { 1262 unless ($MODEL) {
1207 local $SIG{__DIE__}; 1263 for (@REGISTRY, @models) {
1208 1264 my ($package, $model) = @$_;
1209 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1265 if (${"$package\::VERSION"} > 0) {
1210 my $model = "AnyEvent::Impl::$1";
1211 if (eval "require $model") { 1266 if (eval "require $model") {
1212 $MODEL = $model; 1267 $MODEL = $model;
1213 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2; 1268 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2;
1214 } else { 1269 last;
1215 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1270 }
1216 } 1271 }
1217 } 1272 }
1218 1273
1219 # check for already loaded models
1220 unless ($MODEL) { 1274 unless ($MODEL) {
1275 # try to autoload a model
1221 for (@REGISTRY, @models) { 1276 for (@REGISTRY, @models) {
1222 my ($package, $model) = @$_; 1277 my ($package, $model, $autoload) = @$_;
1278 if (
1279 $autoload
1280 and eval "require $package"
1223 if (${"$package\::VERSION"} > 0) { 1281 and ${"$package\::VERSION"} > 0
1224 if (eval "require $model") { 1282 and eval "require $model"
1283 ) {
1225 $MODEL = $model; 1284 $MODEL = $model;
1226 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1285 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1227 last; 1286 last;
1228 }
1229 } 1287 }
1230 } 1288 }
1231 1289
1232 unless ($MODEL) {
1233 # try to autoload a model
1234 for (@REGISTRY, @models) {
1235 my ($package, $model, $autoload) = @$_;
1236 if (
1237 $autoload
1238 and eval "require $package"
1239 and ${"$package\::VERSION"} > 0
1240 and eval "require $model"
1241 ) {
1242 $MODEL = $model;
1243 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1244 last;
1245 }
1246 }
1247
1248 $MODEL 1290 $MODEL
1249 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; 1291 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
1250 }
1251 } 1292 }
1252
1253 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1254
1255 unshift @ISA, $MODEL;
1256
1257 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1258
1259 (shift @post_detect)->() while @post_detect;
1260 } 1293 }
1294
1295 @models = (); # free probe data
1296
1297 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1298 unshift @ISA, $MODEL;
1299
1300 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
1301
1302 (shift @post_detect)->() while @post_detect;
1261 1303
1262 $MODEL 1304 $MODEL
1263} 1305}
1264 1306
1265sub AUTOLOAD { 1307sub AUTOLOAD {
1266 (my $func = $AUTOLOAD) =~ s/.*://; 1308 (my $func = $AUTOLOAD) =~ s/.*://;
1267 1309
1268 $method{$func} 1310 $method{$func}
1269 or Carp::croak "$func: not a valid method for AnyEvent objects"; 1311 or Carp::croak "$func: not a valid AnyEvent class method";
1270 1312
1271 detect unless $MODEL; 1313 detect;
1272 1314
1273 my $class = shift; 1315 my $class = shift;
1274 $class->$func (@_); 1316 $class->$func (@_);
1275} 1317}
1276 1318
1343 1385
1344package AnyEvent::Base; 1386package AnyEvent::Base;
1345 1387
1346# default implementations for many methods 1388# default implementations for many methods
1347 1389
1348sub _time { 1390sub _time() {
1391 eval q{ # poor man's autoloading
1349 # probe for availability of Time::HiRes 1392 # probe for availability of Time::HiRes
1350 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1393 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1351 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1394 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1352 *_time = \&Time::HiRes::time; 1395 *_time = \&Time::HiRes::time;
1353 # if (eval "use POSIX (); (POSIX::times())... 1396 # if (eval "use POSIX (); (POSIX::times())...
1354 } else { 1397 } else {
1355 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1398 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE;
1356 *_time = sub { time }; # epic fail 1399 *_time = sub (){ time }; # epic fail
1400 }
1357 } 1401 };
1402 die if $@;
1358 1403
1359 &_time 1404 &_time
1360} 1405}
1361 1406
1362sub time { _time } 1407sub time { _time }
1373 1418
1374our $HAVE_ASYNC_INTERRUPT; 1419our $HAVE_ASYNC_INTERRUPT;
1375 1420
1376sub _have_async_interrupt() { 1421sub _have_async_interrupt() {
1377 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1422 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1378 && eval "use Async::Interrupt 1.0 (); 1") 1423 && eval "use Async::Interrupt 1.02 (); 1")
1379 unless defined $HAVE_ASYNC_INTERRUPT; 1424 unless defined $HAVE_ASYNC_INTERRUPT;
1380 1425
1381 $HAVE_ASYNC_INTERRUPT 1426 $HAVE_ASYNC_INTERRUPT
1382} 1427}
1383 1428
1384our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1429our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1385our (%SIG_ASY, %SIG_ASY_W); 1430our (%SIG_ASY, %SIG_ASY_W);
1386our ($SIG_COUNT, $SIG_TW); 1431our ($SIG_COUNT, $SIG_TW);
1387 1432
1388sub _signal_exec {
1389 $HAVE_ASYNC_INTERRUPT
1390 ? $SIGPIPE_R->drain
1391 : sysread $SIGPIPE_R, my $dummy, 9;
1392
1393 while (%SIG_EV) {
1394 for (keys %SIG_EV) {
1395 delete $SIG_EV{$_};
1396 $_->() for values %{ $SIG_CB{$_} || {} };
1397 }
1398 }
1399}
1400
1401# install a dummy wakeup watcher to reduce signal catching latency 1433# install a dummy wakeup watcher to reduce signal catching latency
1434# used by Impls
1402sub _sig_add() { 1435sub _sig_add() {
1403 unless ($SIG_COUNT++) { 1436 unless ($SIG_COUNT++) {
1404 # try to align timer on a full-second boundary, if possible 1437 # try to align timer on a full-second boundary, if possible
1405 my $NOW = AE::now; 1438 my $NOW = AE::now;
1406 1439
1537 # print weird messages, or just unconditionally exit 1570 # print weird messages, or just unconditionally exit
1538 # instead of getting the default action. 1571 # instead of getting the default action.
1539 undef $SIG{$signal} 1572 undef $SIG{$signal}
1540 unless keys %{ $SIG_CB{$signal} }; 1573 unless keys %{ $SIG_CB{$signal} };
1541 }; 1574 };
1575
1576 *_signal_exec = sub {
1577 $HAVE_ASYNC_INTERRUPT
1578 ? $SIGPIPE_R->drain
1579 : sysread $SIGPIPE_R, (my $dummy), 9;
1580
1581 while (%SIG_EV) {
1582 for (keys %SIG_EV) {
1583 delete $SIG_EV{$_};
1584 $_->() for values %{ $SIG_CB{$_} || {} };
1585 }
1586 }
1587 };
1542 }; 1588 };
1543 die if $@; 1589 die if $@;
1590
1544 &signal 1591 &signal
1545} 1592}
1546 1593
1547# default implementation for ->child 1594# default implementation for ->child
1548 1595
1549our %PID_CB; 1596our %PID_CB;
1550our $CHLD_W; 1597our $CHLD_W;
1551our $CHLD_DELAY_W; 1598our $CHLD_DELAY_W;
1552our $WNOHANG; 1599our $WNOHANG;
1553 1600
1601# used by many Impl's
1554sub _emit_childstatus($$) { 1602sub _emit_childstatus($$) {
1555 my (undef, $rpid, $rstatus) = @_; 1603 my (undef, $rpid, $rstatus) = @_;
1556 1604
1557 $_->($rpid, $rstatus) 1605 $_->($rpid, $rstatus)
1558 for values %{ $PID_CB{$rpid} || {} }, 1606 for values %{ $PID_CB{$rpid} || {} },
1559 values %{ $PID_CB{0} || {} }; 1607 values %{ $PID_CB{0} || {} };
1560} 1608}
1561 1609
1562sub _sigchld {
1563 my $pid;
1564
1565 AnyEvent->_emit_childstatus ($pid, $?)
1566 while ($pid = waitpid -1, $WNOHANG) > 0;
1567}
1568
1569sub child { 1610sub child {
1611 eval q{ # poor man's autoloading {}
1612 *_sigchld = sub {
1613 my $pid;
1614
1615 AnyEvent->_emit_childstatus ($pid, $?)
1616 while ($pid = waitpid -1, $WNOHANG) > 0;
1617 };
1618
1619 *child = sub {
1570 my (undef, %arg) = @_; 1620 my (undef, %arg) = @_;
1571 1621
1572 defined (my $pid = $arg{pid} + 0) 1622 defined (my $pid = $arg{pid} + 0)
1573 or Carp::croak "required option 'pid' is missing"; 1623 or Carp::croak "required option 'pid' is missing";
1574 1624
1575 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1625 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1576 1626
1577 # WNOHANG is almost cetrainly 1 everywhere 1627 # WNOHANG is almost cetrainly 1 everywhere
1578 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1628 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1579 ? 1 1629 ? 1
1580 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1630 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1581 1631
1582 unless ($CHLD_W) { 1632 unless ($CHLD_W) {
1583 $CHLD_W = AE::signal CHLD => \&_sigchld; 1633 $CHLD_W = AE::signal CHLD => \&_sigchld;
1584 # child could be a zombie already, so make at least one round 1634 # child could be a zombie already, so make at least one round
1585 &_sigchld; 1635 &_sigchld;
1586 } 1636 }
1587 1637
1588 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1638 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1589} 1639 };
1590 1640
1591sub AnyEvent::Base::child::DESTROY { 1641 *AnyEvent::Base::child::DESTROY = sub {
1592 my ($pid, $cb) = @{$_[0]}; 1642 my ($pid, $cb) = @{$_[0]};
1593 1643
1594 delete $PID_CB{$pid}{$cb}; 1644 delete $PID_CB{$pid}{$cb};
1595 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1645 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1596 1646
1597 undef $CHLD_W unless keys %PID_CB; 1647 undef $CHLD_W unless keys %PID_CB;
1648 };
1649 };
1650 die if $@;
1651
1652 &child
1598} 1653}
1599 1654
1600# idle emulation is done by simply using a timer, regardless 1655# idle emulation is done by simply using a timer, regardless
1601# of whether the process is idle or not, and not letting 1656# of whether the process is idle or not, and not letting
1602# the callback use more than 50% of the time. 1657# the callback use more than 50% of the time.
1603sub idle { 1658sub idle {
1659 eval q{ # poor man's autoloading {}
1660 *idle = sub {
1604 my (undef, %arg) = @_; 1661 my (undef, %arg) = @_;
1605 1662
1606 my ($cb, $w, $rcb) = $arg{cb}; 1663 my ($cb, $w, $rcb) = $arg{cb};
1607 1664
1608 $rcb = sub { 1665 $rcb = sub {
1609 if ($cb) { 1666 if ($cb) {
1610 $w = _time; 1667 $w = _time;
1611 &$cb; 1668 &$cb;
1612 $w = _time - $w; 1669 $w = _time - $w;
1613 1670
1614 # never use more then 50% of the time for the idle watcher, 1671 # never use more then 50% of the time for the idle watcher,
1615 # within some limits 1672 # within some limits
1616 $w = 0.0001 if $w < 0.0001; 1673 $w = 0.0001 if $w < 0.0001;
1617 $w = 5 if $w > 5; 1674 $w = 5 if $w > 5;
1618 1675
1619 $w = AE::timer $w, 0, $rcb; 1676 $w = AE::timer $w, 0, $rcb;
1620 } else { 1677 } else {
1621 # clean up... 1678 # clean up...
1622 undef $w; 1679 undef $w;
1623 undef $rcb; 1680 undef $rcb;
1681 }
1682 };
1683
1684 $w = AE::timer 0.05, 0, $rcb;
1685
1686 bless \\$cb, "AnyEvent::Base::idle"
1624 } 1687 };
1688
1689 *AnyEvent::Base::idle::DESTROY = sub {
1690 undef $${$_[0]};
1691 };
1625 }; 1692 };
1693 die if $@;
1626 1694
1627 $w = AE::timer 0.05, 0, $rcb; 1695 &idle
1628
1629 bless \\$cb, "AnyEvent::Base::idle"
1630}
1631
1632sub AnyEvent::Base::idle::DESTROY {
1633 undef $${$_[0]};
1634} 1696}
1635 1697
1636package AnyEvent::CondVar; 1698package AnyEvent::CondVar;
1637 1699
1638our @ISA = AnyEvent::CondVar::Base::; 1700our @ISA = AnyEvent::CondVar::Base::;
1912 warn "read: $input\n"; # output what has been read 1974 warn "read: $input\n"; # output what has been read
1913 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1975 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1914 }, 1976 },
1915 ); 1977 );
1916 1978
1917 my $time_watcher; # can only be used once
1918
1919 sub new_timer {
1920 $timer = AnyEvent->timer (after => 1, cb => sub { 1979 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1921 warn "timeout\n"; # print 'timeout' about every second 1980 warn "timeout\n"; # print 'timeout' at most every second
1922 &new_timer; # and restart the time
1923 }); 1981 });
1924 }
1925
1926 new_timer; # create first timer
1927 1982
1928 $cv->recv; # wait until user enters /^q/i 1983 $cv->recv; # wait until user enters /^q/i
1929 1984
1930=head1 REAL-WORLD EXAMPLE 1985=head1 REAL-WORLD EXAMPLE
1931 1986
2375As you can see, the AnyEvent + EV combination even beats the 2430As you can see, the AnyEvent + EV combination even beats the
2376hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2431hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2377backend easily beats IO::Lambda and POE. 2432backend easily beats IO::Lambda and POE.
2378 2433
2379And even the 100% non-blocking version written using the high-level (and 2434And even the 100% non-blocking version written using the high-level (and
2380slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2435slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2381large margin, even though it does all of DNS, tcp-connect and socket I/O 2436higher level ("unoptimised") abstractions by a large margin, even though
2382in a non-blocking way. 2437it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2383 2438
2384The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2439The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2385F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2440F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2386part of the IO::lambda distribution and were used without any changes. 2441part of the IO::Lambda distribution and were used without any changes.
2387 2442
2388 2443
2389=head1 SIGNALS 2444=head1 SIGNALS
2390 2445
2391AnyEvent currently installs handlers for these signals: 2446AnyEvent currently installs handlers for these signals:
2433it's built-in modules) are required to use it. 2488it's built-in modules) are required to use it.
2434 2489
2435That does not mean that AnyEvent won't take advantage of some additional 2490That does not mean that AnyEvent won't take advantage of some additional
2436modules if they are installed. 2491modules if they are installed.
2437 2492
2438This section epxlains which additional modules will be used, and how they 2493This section explains which additional modules will be used, and how they
2439affect AnyEvent's operetion. 2494affect AnyEvent's operation.
2440 2495
2441=over 4 2496=over 4
2442 2497
2443=item L<Async::Interrupt> 2498=item L<Async::Interrupt>
2444 2499
2449catch the signals) with some delay (default is 10 seconds, look for 2504catch the signals) with some delay (default is 10 seconds, look for
2450C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2505C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2451 2506
2452If this module is available, then it will be used to implement signal 2507If this module is available, then it will be used to implement signal
2453catching, which means that signals will not be delayed, and the event loop 2508catching, which means that signals will not be delayed, and the event loop
2454will not be interrupted regularly, which is more efficient (And good for 2509will not be interrupted regularly, which is more efficient (and good for
2455battery life on laptops). 2510battery life on laptops).
2456 2511
2457This affects not just the pure-perl event loop, but also other event loops 2512This affects not just the pure-perl event loop, but also other event loops
2458that have no signal handling on their own (e.g. Glib, Tk, Qt). 2513that have no signal handling on their own (e.g. Glib, Tk, Qt).
2459 2514
2480lot less memory), but otherwise doesn't affect guard operation much. It is 2535lot less memory), but otherwise doesn't affect guard operation much. It is
2481purely used for performance. 2536purely used for performance.
2482 2537
2483=item L<JSON> and L<JSON::XS> 2538=item L<JSON> and L<JSON::XS>
2484 2539
2485This module is required when you want to read or write JSON data via 2540One of these modules is required when you want to read or write JSON data
2486L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2541via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2487advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2542advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2488 2543
2489In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2544In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2490installed. 2545installed.
2491 2546
2506 2561
2507 2562
2508=head1 FORK 2563=head1 FORK
2509 2564
2510Most event libraries are not fork-safe. The ones who are usually are 2565Most event libraries are not fork-safe. The ones who are usually are
2511because they rely on inefficient but fork-safe C<select> or C<poll> 2566because they rely on inefficient but fork-safe C<select> or C<poll> calls
2512calls. Only L<EV> is fully fork-aware. 2567- higher performance APIs such as BSD's kqueue or the dreaded Linux epoll
2568are usually badly thought-out hacks that are incompatible with fork in
2569one way or another. Only L<EV> is fully fork-aware and ensures that you
2570continue event-processing in both parent and child (or both, if you know
2571what you are doing).
2572
2573This means that, in general, you cannot fork and do event processing in
2574the child if the event library was initialised before the fork (which
2575usually happens when the first AnyEvent watcher is created, or the library
2576is loaded).
2513 2577
2514If you have to fork, you must either do so I<before> creating your first 2578If you have to fork, you must either do so I<before> creating your first
2515watcher OR you must not use AnyEvent at all in the child OR you must do 2579watcher OR you must not use AnyEvent at all in the child OR you must do
2516something completely out of the scope of AnyEvent. 2580something completely out of the scope of AnyEvent.
2581
2582The problem of doing event processing in the parent I<and> the child
2583is much more complicated: even for backends that I<are> fork-aware or
2584fork-safe, their behaviour is not usually what you want: fork clones all
2585watchers, that means all timers, I/O watchers etc. are active in both
2586parent and child, which is almost never what you want. USing C<exec>
2587to start worker children from some kind of manage rprocess is usually
2588preferred, because it is much easier and cleaner, at the expense of having
2589to have another binary.
2517 2590
2518 2591
2519=head1 SECURITY CONSIDERATIONS 2592=head1 SECURITY CONSIDERATIONS
2520 2593
2521AnyEvent can be forced to load any event model via 2594AnyEvent can be forced to load any event model via

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines