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.242 by root, Fri Jul 17 22:05:12 2009 UTC vs.
Revision 1.260 by root, Tue Jul 28 11:02:19 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt
6event loops. 6and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
… …
40=head1 INTRODUCTION/TUTORIAL 40=head1 INTRODUCTION/TUTORIAL
41 41
42This manpage is mainly a reference manual. If you are interested 42This manpage is mainly a reference manual. If you are interested
43in a tutorial or some gentle introduction, have a look at the 43in a tutorial or some gentle introduction, have a look at the
44L<AnyEvent::Intro> manpage. 44L<AnyEvent::Intro> manpage.
45
46=head1 SUPPORT
47
48There is a mailinglist for discussing all things AnyEvent, and an IRC
49channel, too.
50
51See the AnyEvent project page at the B<Schmorpforge Ta-Sa Software
52Repository>, at L<http://anyevent.schmorp.de>, for more info.
45 53
46=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 54=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
47 55
48Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 56Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
49nowadays. So what is different about AnyEvent? 57nowadays. So what is different about AnyEvent?
… …
368 376
369This watcher might use C<%SIG> (depending on the event loop used), 377This watcher might use C<%SIG> (depending on the event loop used),
370so programs overwriting those signals directly will likely not work 378so programs overwriting those signals directly will likely not work
371correctly. 379correctly.
372 380
381Example: exit on SIGINT
382
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384
385=head3 Signal Races, Delays and Workarounds
386
373Also note that many event loops (e.g. Glib, Tk, Qt, IO::Async) do not 387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
374support attaching callbacks to signals, which is a pity, as you cannot do 388callbacks to signals in a generic way, which is a pity, as you cannot do
375race-free signal handling in perl. AnyEvent will try to do it's best, but 389race-free signal handling in perl. AnyEvent will try to do it's best, but
376in some cases, signals will be delayed. The maximum time a signal might 390in some cases, signals will be delayed. The maximum time a signal might
377be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10
378seconds). This variable can be changed only before the first signal 392seconds). This variable can be changed only before the first signal
379watcher is created, and should be left alone otherwise. Higher values 393watcher is created, and should be left alone otherwise. Higher values
380will cause fewer spurious wake-ups, which is better for power and CPU 394will cause fewer spurious wake-ups, which is better for power and CPU
381saving. All these problems can be avoided by installing the optional 395saving. All these problems can be avoided by installing the optional
382L<Async::Interrupt> module. 396L<Async::Interrupt> module. This will not work with inherently broken
383 397event loops such as L<Event> or L<Event::Lib> (and not with L<POE>
384Example: exit on SIGINT 398currently, as POE does it's own workaround with one-second latency). With
385 399those, you just have to suffer the delays.
386 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
387 400
388=head2 CHILD PROCESS WATCHERS 401=head2 CHILD PROCESS WATCHERS
389 402
390You can also watch on a child process exit and catch its exit status. 403You can also watch on a child process exit and catch its exit status.
391 404
392The child process is specified by the C<pid> argument (if set to C<0>, it 405The child process is specified by the C<pid> argument (one some backends,
393watches for any child process exit). The watcher will triggered only when 406using C<0> watches for any child process exit, on others this will
394the child process has finished and an exit status is available, not on 407croak). The watcher will be triggered only when the child process has
395any trace events (stopped/continued). 408finished and an exit status is available, not on any trace events
409(stopped/continued).
396 410
397The callback will be called with the pid and exit status (as returned by 411The callback will be called with the pid and exit status (as returned by
398waitpid), so unlike other watcher types, you I<can> rely on child watcher 412waitpid), so unlike other watcher types, you I<can> rely on child watcher
399callback arguments. 413callback arguments.
400 414
… …
504Condition variables are similar to callbacks, except that you can 518Condition variables are similar to callbacks, except that you can
505optionally wait for them. They can also be called merge points - points 519optionally wait for them. They can also be called merge points - points
506in time where multiple outstanding events have been processed. And yet 520in time where multiple outstanding events have been processed. And yet
507another way to call them is transactions - each condition variable can be 521another way to call them is transactions - each condition variable can be
508used to represent a transaction, which finishes at some point and delivers 522used to represent a transaction, which finishes at some point and delivers
509a result. 523a result. And yet some people know them as "futures" - a promise to
524compute/deliver something that you can wait for.
510 525
511Condition variables are very useful to signal that something has finished, 526Condition variables are very useful to signal that something has finished,
512for example, if you write a module that does asynchronous http requests, 527for example, if you write a module that does asynchronous http requests,
513then a condition variable would be the ideal candidate to signal the 528then a condition variable would be the ideal candidate to signal the
514availability of results. The user can either act when the callback is 529availability of results. The user can either act when the callback is
… …
782 797
783 AnyEvent::Impl::Glib based on Glib, slow but very stable. 798 AnyEvent::Impl::Glib based on Glib, slow but very stable.
784 AnyEvent::Impl::Tk based on Tk, very broken. 799 AnyEvent::Impl::Tk based on Tk, very broken.
785 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
786 AnyEvent::Impl::POE based on POE, very slow, some limitations. 801 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi.
787 803
788=item Backends with special needs. 804=item Backends with special needs.
789 805
790Qt requires the Qt::Application to be instantiated first, but will 806Qt requires the Qt::Application to be instantiated first, but will
791otherwise be picked up automatically. As long as the main program 807otherwise be picked up automatically. As long as the main program
… …
865event module detection too early, for example, L<AnyEvent::AIO> creates 881event module detection too early, for example, L<AnyEvent::AIO> creates
866and installs the global L<IO::AIO> watcher in a C<post_detect> block to 882and installs the global L<IO::AIO> watcher in a C<post_detect> block to
867avoid autodetecting the event module at load time. 883avoid autodetecting the event module at load time.
868 884
869If called in scalar or list context, then it creates and returns an object 885If called in scalar or list context, then it creates and returns an object
870that automatically removes the callback again when it is destroyed. See 886that automatically removes the callback again when it is destroyed (or
887C<undef> when the hook was immediately executed). See L<AnyEvent::AIO> for
871L<Coro::BDB> for a case where this is useful. 888a case where this is useful.
889
890Example: Create a watcher for the IO::AIO module and store it in
891C<$WATCHER>. Only do so after the event loop is initialised, though.
892
893 our WATCHER;
894
895 my $guard = AnyEvent::post_detect {
896 $WATCHER = AnyEvent->io (fh => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb);
897 };
898
899 # the ||= is important in case post_detect immediately runs the block,
900 # as to not clobber the newly-created watcher. assigning both watcher and
901 # post_detect guard to the same variable has the advantage of users being
902 # able to just C<undef $WATCHER> if the watcher causes them grief.
903
904 $WATCHER ||= $guard;
872 905
873=item @AnyEvent::post_detect 906=item @AnyEvent::post_detect
874 907
875If there are any code references in this array (you can C<push> to it 908If there are any code references in this array (you can C<push> to it
876before or after loading AnyEvent), then they will called directly after 909before or after loading AnyEvent), then they will called directly after
… …
1041 1074
1042=cut 1075=cut
1043 1076
1044package AnyEvent; 1077package AnyEvent;
1045 1078
1079# basically a tuned-down version of common::sense
1080sub common_sense {
1046no warnings; 1081 # no warnings
1082 ${^WARNING_BITS} ^= ${^WARNING_BITS};
1047use strict qw(vars subs); 1083 # use strict vars subs
1084 $^H |= 0x00000600;
1085}
1086
1087BEGIN { AnyEvent::common_sense }
1048 1088
1049use Carp (); 1089use Carp ();
1050 1090
1051our $VERSION = 4.83; 1091our $VERSION = 4.881;
1052our $MODEL; 1092our $MODEL;
1053 1093
1054our $AUTOLOAD; 1094our $AUTOLOAD;
1055our @ISA; 1095our @ISA;
1056 1096
… …
1081 for reverse split /\s*,\s*/, 1121 for reverse split /\s*,\s*/,
1082 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1083} 1123}
1084 1124
1085my @models = ( 1125my @models = (
1086 [EV:: => AnyEvent::Impl::EV::], 1126 [EV:: => AnyEvent::Impl::EV:: , 1],
1087 [Event:: => AnyEvent::Impl::Event::], 1127 [Event:: => AnyEvent::Impl::Event::, 1],
1088 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::], 1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1089 # everything below here will not be autoprobed 1129 # everything below here will not (normally) be autoprobed
1090 # as the pureperl backend should work everywhere 1130 # as the pureperl backend should work everywhere
1091 # and is usually faster 1131 # and is usually faster
1092 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers 1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1093 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1094 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1095 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1096 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1137 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1097 [Wx:: => AnyEvent::Impl::POE::], 1138 [Wx:: => AnyEvent::Impl::POE::],
1098 [Prima:: => AnyEvent::Impl::POE::], 1139 [Prima:: => AnyEvent::Impl::POE::],
1099 # IO::Async is just too broken - we would need workarounds for its 1140 # IO::Async is just too broken - we would need workarounds for its
1100 # byzantine signal and broken child handling, among others. 1141 # byzantine signal and broken child handling, among others.
1101 # IO::Async is rather hard to detect, as it doesn't have any 1142 # IO::Async is rather hard to detect, as it doesn't have any
1102 # obvious default class. 1143 # obvious default class.
1103# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1104# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1105# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1106); 1147);
1107 1148
1108our %method = map +($_ => 1), 1149our %method = map +($_ => 1),
1109 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1110 1151
… …
1114 my ($cb) = @_; 1155 my ($cb) = @_;
1115 1156
1116 if ($MODEL) { 1157 if ($MODEL) {
1117 $cb->(); 1158 $cb->();
1118 1159
1119 1 1160 undef
1120 } else { 1161 } else {
1121 push @post_detect, $cb; 1162 push @post_detect, $cb;
1122 1163
1123 defined wantarray 1164 defined wantarray
1124 ? bless \$cb, "AnyEvent::Util::postdetect" 1165 ? bless \$cb, "AnyEvent::Util::postdetect"
… …
1130 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1171 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1131} 1172}
1132 1173
1133sub detect() { 1174sub detect() {
1134 unless ($MODEL) { 1175 unless ($MODEL) {
1135 no strict 'refs';
1136 local $SIG{__DIE__}; 1176 local $SIG{__DIE__};
1137 1177
1138 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1178 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
1139 my $model = "AnyEvent::Impl::$1"; 1179 my $model = "AnyEvent::Impl::$1";
1140 if (eval "require $model") { 1180 if (eval "require $model") {
… …
1157 } 1197 }
1158 } 1198 }
1159 } 1199 }
1160 1200
1161 unless ($MODEL) { 1201 unless ($MODEL) {
1162 # try to load a model 1202 # try to autoload a model
1163
1164 for (@REGISTRY, @models) { 1203 for (@REGISTRY, @models) {
1165 my ($package, $model) = @$_; 1204 my ($package, $model, $autoload) = @$_;
1205 if (
1206 $autoload
1166 if (eval "require $package" 1207 and eval "require $package"
1167 and ${"$package\::VERSION"} > 0 1208 and ${"$package\::VERSION"} > 0
1168 and eval "require $model") { 1209 and eval "require $model"
1210 ) {
1169 $MODEL = $model; 1211 $MODEL = $model;
1170 warn "AnyEvent: autoprobed model '$model', using it.\n" if $VERBOSE >= 2; 1212 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1171 last; 1213 last;
1172 } 1214 }
1173 } 1215 }
1174 1216
1175 $MODEL 1217 $MODEL
… …
1264 $_->() for values %{ $SIG_CB{$_} || {} }; 1306 $_->() for values %{ $SIG_CB{$_} || {} };
1265 } 1307 }
1266 } 1308 }
1267} 1309}
1268 1310
1311# install a dumym wakeupw atcher to reduce signal catching latency
1312sub _sig_add() {
1313 unless ($SIG_COUNT++) {
1314 # try to align timer on a full-second boundary, if possible
1315 my $NOW = AnyEvent->now;
1316
1317 $SIG_TW = AnyEvent->timer (
1318 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1319 interval => $MAX_SIGNAL_LATENCY,
1320 cb => sub { }, # just for the PERL_ASYNC_CHECK
1321 );
1322 }
1323}
1324
1325sub _sig_del {
1326 undef $SIG_TW
1327 unless --$SIG_COUNT;
1328}
1329
1269sub _signal { 1330sub _signal {
1270 my (undef, %arg) = @_; 1331 my (undef, %arg) = @_;
1271 1332
1272 my $signal = uc $arg{signal} 1333 my $signal = uc $arg{signal}
1273 or Carp::croak "required option 'signal' is missing"; 1334 or Carp::croak "required option 'signal' is missing";
… …
1297 undef $SIG_EV{$signal}; 1358 undef $SIG_EV{$signal};
1298 }; 1359 };
1299 1360
1300 # can't do signal processing without introducing races in pure perl, 1361 # can't do signal processing without introducing races in pure perl,
1301 # so limit the signal latency. 1362 # so limit the signal latency.
1302 ++$SIG_COUNT; 1363 _sig_add;
1303 $SIG_TW ||= AnyEvent->timer (
1304 after => $MAX_SIGNAL_LATENCY,
1305 interval => $MAX_SIGNAL_LATENCY,
1306 cb => sub { }, # just for the PERL_ASYNC_CHECK
1307 );
1308 } 1364 }
1309 1365
1310 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1366 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1311} 1367}
1312 1368
… …
1351} 1407}
1352 1408
1353sub AnyEvent::Base::signal::DESTROY { 1409sub AnyEvent::Base::signal::DESTROY {
1354 my ($signal, $cb) = @{$_[0]}; 1410 my ($signal, $cb) = @{$_[0]};
1355 1411
1356 undef $SIG_TW 1412 _sig_del;
1357 unless --$SIG_COUNT;
1358 1413
1359 delete $SIG_CB{$signal}{$cb}; 1414 delete $SIG_CB{$signal}{$cb};
1360 1415
1416 $HAVE_ASYNC_INTERRUPT
1417 ? delete $SIG_ASY{$signal}
1361 # delete doesn't work with older perls - they then 1418 : # delete doesn't work with older perls - they then
1362 # print weird messages, or just unconditionally exit 1419 # print weird messages, or just unconditionally exit
1363 # instead of getting the default action. 1420 # instead of getting the default action.
1364 undef $SIG{$signal} 1421 undef $SIG{$signal}
1365 unless keys %{ $SIG_CB{$signal} }; 1422 unless keys %{ $SIG_CB{$signal} };
1366} 1423}
1367 1424
1368# default implementation for ->child 1425# default implementation for ->child
1369 1426
1370our %PID_CB; 1427our %PID_CB;
1371our $CHLD_W; 1428our $CHLD_W;
1372our $CHLD_DELAY_W; 1429our $CHLD_DELAY_W;
1373our $WNOHANG; 1430our $WNOHANG;
1374 1431
1432sub _emit_childstatus($$) {
1433 my (undef, $rpid, $rstatus) = @_;
1434
1435 $_->($rpid, $rstatus)
1436 for values %{ $PID_CB{$rpid} || {} },
1437 values %{ $PID_CB{0} || {} };
1438}
1439
1375sub _sigchld { 1440sub _sigchld {
1441 my $pid;
1442
1443 AnyEvent->_emit_childstatus ($pid, $?)
1376 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1444 while ($pid = waitpid -1, $WNOHANG) > 0;
1377 $_->($pid, $?)
1378 for values %{ $PID_CB{$pid} || {} },
1379 values %{ $PID_CB{0} || {} };
1380 }
1381} 1445}
1382 1446
1383sub child { 1447sub child {
1384 my (undef, %arg) = @_; 1448 my (undef, %arg) = @_;
1385 1449
1386 defined (my $pid = $arg{pid} + 0) 1450 defined (my $pid = $arg{pid} + 0)
1387 or Carp::croak "required option 'pid' is missing"; 1451 or Carp::croak "required option 'pid' is missing";
1388 1452
1389 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1453 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1390 1454
1455 # WNOHANG is almost cetrainly 1 everywhere
1456 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1457 ? 1
1391 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1458 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1392 1459
1393 unless ($CHLD_W) { 1460 unless ($CHLD_W) {
1394 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1461 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1395 # child could be a zombie already, so make at least one round 1462 # child could be a zombie already, so make at least one round
1396 &_sigchld; 1463 &_sigchld;
… …
1448 1515
1449our @ISA = AnyEvent::CondVar::Base::; 1516our @ISA = AnyEvent::CondVar::Base::;
1450 1517
1451package AnyEvent::CondVar::Base; 1518package AnyEvent::CondVar::Base;
1452 1519
1453use overload 1520#use overload
1454 '&{}' => sub { my $self = shift; sub { $self->send (@_) } }, 1521# '&{}' => sub { my $self = shift; sub { $self->send (@_) } },
1455 fallback => 1; 1522# fallback => 1;
1523
1524# save 300+ kilobytes by dirtily hardcoding overloading
1525${"AnyEvent::CondVar::Base::OVERLOAD"}{dummy}++; # Register with magic by touching.
1526*{'AnyEvent::CondVar::Base::()'} = sub { }; # "Make it findable via fetchmethod."
1527*{'AnyEvent::CondVar::Base::(&{}'} = sub { my $self = shift; sub { $self->send (@_) } }; # &{}
1528${'AnyEvent::CondVar::Base::()'} = 1; # fallback
1456 1529
1457our $WAITING; 1530our $WAITING;
1458 1531
1459sub _send { 1532sub _send {
1460 # nop 1533 # nop
… …
1551C<PERL_ANYEVENT_MODEL>. 1624C<PERL_ANYEVENT_MODEL>.
1552 1625
1553When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1626When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1554model it chooses. 1627model it chooses.
1555 1628
1629When set to C<8> or higher, then AnyEvent will report extra information on
1630which optional modules it loads and how it implements certain features.
1631
1556=item C<PERL_ANYEVENT_STRICT> 1632=item C<PERL_ANYEVENT_STRICT>
1557 1633
1558AnyEvent does not do much argument checking by default, as thorough 1634AnyEvent does not do much argument checking by default, as thorough
1559argument checking is very costly. Setting this variable to a true value 1635argument checking is very costly. Setting this variable to a true value
1560will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1636will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1561check the arguments passed to most method calls. If it finds any problems, 1637check the arguments passed to most method calls. If it finds any problems,
1562it will croak. 1638it will croak.
1563 1639
1564In other words, enables "strict" mode. 1640In other words, enables "strict" mode.
1565 1641
1566Unlike C<use strict>, it is definitely recommended to keep it off in 1642Unlike C<use strict> (or it's modern cousin, C<< use L<common::sense>
1567production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1643>>, it is definitely recommended to keep it off in production. Keeping
1568developing programs can be very useful, however. 1644C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1645can be very useful, however.
1569 1646
1570=item C<PERL_ANYEVENT_MODEL> 1647=item C<PERL_ANYEVENT_MODEL>
1571 1648
1572This can be used to specify the event model to be used by AnyEvent, before 1649This can be used to specify the event model to be used by AnyEvent, before
1573auto detection and -probing kicks in. It must be a string consisting 1650auto detection and -probing kicks in. It must be a string consisting
… …
1635 1712
1636When neither C<ca_file> nor C<ca_path> was specified during 1713When neither C<ca_file> nor C<ca_path> was specified during
1637L<AnyEvent::TLS> context creation, and either of these environment 1714L<AnyEvent::TLS> context creation, and either of these environment
1638variables exist, they will be used to specify CA certificate locations 1715variables exist, they will be used to specify CA certificate locations
1639instead of a system-dependent default. 1716instead of a system-dependent default.
1717
1718=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1719
1720When these are set to C<1>, then the respective modules are not
1721loaded. Mostly good for testing AnyEvent itself.
1640 1722
1641=back 1723=back
1642 1724
1643=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1725=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1644 1726
… …
2231 2313
2232This slightly arcane module is used to implement fast signal handling: To 2314This slightly arcane module is used to implement fast signal handling: To
2233my knowledge, there is no way to do completely race-free and quick 2315my knowledge, there is no way to do completely race-free and quick
2234signal handling in pure perl. To ensure that signals still get 2316signal handling in pure perl. To ensure that signals still get
2235delivered, AnyEvent will start an interval timer to wake up perl (and 2317delivered, AnyEvent will start an interval timer to wake up perl (and
2236catch the signals) with soemd elay (default is 10 seconds, look for 2318catch the signals) with some delay (default is 10 seconds, look for
2237C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2319C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2238 2320
2239If this module is available, then it will be used to implement signal 2321If this module is available, then it will be used to implement signal
2240catching, which means that signals will not be delayed, and the event loop 2322catching, which means that signals will not be delayed, and the event loop
2241will not be interrupted regularly, which is more efficient (And good for 2323will not be interrupted regularly, which is more efficient (And good for
2242battery life on laptops). 2324battery life on laptops).
2243 2325
2244This affects not just the pure-perl event loop, but also other event loops 2326This affects not just the pure-perl event loop, but also other event loops
2245that have no signal handling on their own (e.g. Glib, Tk, Qt). 2327that have no signal handling on their own (e.g. Glib, Tk, Qt).
2328
2329Some event loops (POE, Event, Event::Lib) offer signal watchers natively,
2330and either employ their own workarounds (POE) or use AnyEvent's workaround
2331(using C<$AnyEvent::MAX_SIGNAL_LATENCY>). Installing L<Async::Interrupt>
2332does nothing for those backends.
2246 2333
2247=item L<EV> 2334=item L<EV>
2248 2335
2249This module isn't really "optional", as it is simply one of the backend 2336This module isn't really "optional", as it is simply one of the backend
2250event loops that AnyEvent can use. However, it is simply the best event 2337event loops that AnyEvent can use. However, it is simply the best event
… …
2264 2351
2265=item L<JSON> and L<JSON::XS> 2352=item L<JSON> and L<JSON::XS>
2266 2353
2267This module is required when you want to read or write JSON data via 2354This module is required when you want to read or write JSON data via
2268L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2355L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2269advantage of the ulta-high-speed L<JSON::XS> module when it is installed. 2356advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2270 2357
2271In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2358In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2272installed. 2359installed.
2273 2360
2274=item L<Net::SSLeay> 2361=item L<Net::SSLeay>
… …
2341L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 2428L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2342 2429
2343Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 2430Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2344L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 2431L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2345L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 2432L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2346L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>. 2433L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>.
2347 2434
2348Non-blocking file handles, sockets, TCP clients and 2435Non-blocking file handles, sockets, TCP clients and
2349servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 2436servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2350 2437
2351Asynchronous DNS: L<AnyEvent::DNS>. 2438Asynchronous DNS: L<AnyEvent::DNS>.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines