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.125 by root, Fri May 23 23:37:13 2008 UTC vs.
Revision 1.128 by root, Sat May 24 02:50:45 2008 UTC

57as those use one of the supported event loops. It is trivial to add new 57as those use one of the supported event loops. It is trivial to add new
58event loops to AnyEvent, too, so it is future-proof). 58event loops to AnyEvent, too, so it is future-proof).
59 59
60In addition to being free of having to use I<the one and only true event 60In addition to being free of having to use I<the one and only true event
61model>, AnyEvent also is free of bloat and policy: with POE or similar 61model>, AnyEvent also is free of bloat and policy: with POE or similar
62modules, you get an enourmous amount of code and strict rules you have to 62modules, you get an enormous amount of code and strict rules you have to
63follow. AnyEvent, on the other hand, is lean and up to the point, by only 63follow. AnyEvent, on the other hand, is lean and up to the point, by only
64offering the functionality that is necessary, in as thin as a wrapper as 64offering the functionality that is necessary, in as thin as a wrapper as
65technically possible. 65technically possible.
66 66
67Of course, if you want lots of policy (this can arguably be somewhat 67Of course, if you want lots of policy (this can arguably be somewhat
108 108
109=head1 WATCHERS 109=head1 WATCHERS
110 110
111AnyEvent has the central concept of a I<watcher>, which is an object that 111AnyEvent has the central concept of a I<watcher>, which is an object that
112stores relevant data for each kind of event you are waiting for, such as 112stores relevant data for each kind of event you are waiting for, such as
113the callback to call, the filehandle to watch, etc. 113the callback to call, the file handle to watch, etc.
114 114
115These watchers are normal Perl objects with normal Perl lifetime. After 115These watchers are normal Perl objects with normal Perl lifetime. After
116creating a watcher it will immediately "watch" for events and invoke the 116creating a watcher it will immediately "watch" for events and invoke the
117callback when the event occurs (of course, only when the event model 117callback when the event occurs (of course, only when the event model
118is in control). 118is in control).
705our @ISA; 705our @ISA;
706 706
707our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 707our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
708 708
709our @REGISTRY; 709our @REGISTRY;
710
711our %PROTOCOL; # (ipv4|ipv6) => (1|2)
712
713{
714 my $idx;
715 $PROTOCOL{$_} = ++$idx
716 for split /\s*,\s*/, $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
717}
710 718
711my @models = ( 719my @models = (
712 [EV:: => AnyEvent::Impl::EV::], 720 [EV:: => AnyEvent::Impl::EV::],
713 [Event:: => AnyEvent::Impl::Event::], 721 [Event:: => AnyEvent::Impl::Event::],
714 [Tk:: => AnyEvent::Impl::Tk::], 722 [Tk:: => AnyEvent::Impl::Tk::],
1021model it chooses. 1029model it chooses.
1022 1030
1023=item C<PERL_ANYEVENT_MODEL> 1031=item C<PERL_ANYEVENT_MODEL>
1024 1032
1025This can be used to specify the event model to be used by AnyEvent, before 1033This can be used to specify the event model to be used by AnyEvent, before
1026autodetection and -probing kicks in. It must be a string consisting 1034auto detection and -probing kicks in. It must be a string consisting
1027entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1035entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1028and the resulting module name is loaded and if the load was successful, 1036and the resulting module name is loaded and if the load was successful,
1029used as event model. If it fails to load AnyEvent will proceed with 1037used as event model. If it fails to load AnyEvent will proceed with
1030autodetection and -probing. 1038auto detection and -probing.
1031 1039
1032This functionality might change in future versions. 1040This functionality might change in future versions.
1033 1041
1034For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1042For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1035could start your program like this: 1043could start your program like this:
1038 1046
1039=item C<PERL_ANYEVENT_PROTOCOLS> 1047=item C<PERL_ANYEVENT_PROTOCOLS>
1040 1048
1041Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 1049Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1042for IPv4 or IPv6. The default is unspecified (and might change, or be the result 1050for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1043of autoprobing). 1051of auto probing).
1044 1052
1045Must be set to a comma-separated list of protocols or address families, 1053Must be set to a comma-separated list of protocols or address families,
1046current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be 1054current supported: C<ipv4> and C<ipv6>. Only protocols mentioned will be
1047used, and preference will be given to protocols mentioned earlier in the 1055used, and preference will be given to protocols mentioned earlier in the
1048list. 1056list.
1049 1057
1058This variable can effectively be used for denial-of-service attacks
1059against local programs (e.g. when setuid), although the impact is likely
1060small, as the program has to handle connection errors already-
1061
1050Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, 1062Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1051but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 1063but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1052- only support IPv4, never try to resolve or contact IPv6 1064- only support IPv4, never try to resolve or contact IPv6
1053addressses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 1065addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1054IPv6, but prefer IPv6 over IPv4. 1066IPv6, but prefer IPv6 over IPv4.
1067
1068=item C<PERL_ANYEVENT_EDNS0>
1069
1070Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension
1071for DNS. This extension is generally useful to reduce DNS traffic, but
1072some (broken) firewalls drop such DNS packets, which is why it is off by
1073default.
1074
1075Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1076EDNS0 in its DNS requests.
1055 1077
1056=back 1078=back
1057 1079
1058=head1 EXAMPLE PROGRAM 1080=head1 EXAMPLE PROGRAM
1059 1081
1145 syswrite $txn->{fh}, $txn->{request} 1167 syswrite $txn->{fh}, $txn->{request}
1146 or die "connection or write error"; 1168 or die "connection or write error";
1147 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r }); 1169 $txn->{w} = AnyEvent->io (fh => $txn->{fh}, poll => 'r', cb => sub { $txn->fh_ready_r });
1148 1170
1149Again, C<fh_ready_r> waits till all data has arrived, and then stores the 1171Again, C<fh_ready_r> waits till all data has arrived, and then stores the
1150result and signals any possible waiters that the request ahs finished: 1172result and signals any possible waiters that the request has finished:
1151 1173
1152 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf}; 1174 sysread $txn->{fh}, $txn->{buf}, length $txn->{$buf};
1153 1175
1154 if (end-of-file or data complete) { 1176 if (end-of-file or data complete) {
1155 $txn->{result} = $txn->{buf}; 1177 $txn->{result} = $txn->{buf};
1163 1185
1164 $txn->{finished}->recv; 1186 $txn->{finished}->recv;
1165 return $txn->{result}; 1187 return $txn->{result};
1166 1188
1167The actual code goes further and collects all errors (C<die>s, exceptions) 1189The actual code goes further and collects all errors (C<die>s, exceptions)
1168that occured during request processing. The C<result> method detects 1190that occurred during request processing. The C<result> method detects
1169whether an exception as thrown (it is stored inside the $txn object) 1191whether an exception as thrown (it is stored inside the $txn object)
1170and just throws the exception, which means connection errors and other 1192and just throws the exception, which means connection errors and other
1171problems get reported tot he code that tries to use the result, not in a 1193problems get reported tot he code that tries to use the result, not in a
1172random callback. 1194random callback.
1173 1195
1219of various event loops I prepared some benchmarks. 1241of various event loops I prepared some benchmarks.
1220 1242
1221=head2 BENCHMARKING ANYEVENT OVERHEAD 1243=head2 BENCHMARKING ANYEVENT OVERHEAD
1222 1244
1223Here is a benchmark of various supported event models used natively and 1245Here is a benchmark of various supported event models used natively and
1224through anyevent. The benchmark creates a lot of timers (with a zero 1246through AnyEvent. The benchmark creates a lot of timers (with a zero
1225timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 1247timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1226which it is), lets them fire exactly once and destroys them again. 1248which it is), lets them fire exactly once and destroys them again.
1227 1249
1228Source code for this benchmark is found as F<eg/bench> in the AnyEvent 1250Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1229distribution. 1251distribution.
1352 1374
1353=back 1375=back
1354 1376
1355=head2 BENCHMARKING THE LARGE SERVER CASE 1377=head2 BENCHMARKING THE LARGE SERVER CASE
1356 1378
1357This benchmark atcually benchmarks the event loop itself. It works by 1379This benchmark actually benchmarks the event loop itself. It works by
1358creating a number of "servers": each server consists of a socketpair, a 1380creating a number of "servers": each server consists of a socket pair, a
1359timeout watcher that gets reset on activity (but never fires), and an I/O 1381timeout watcher that gets reset on activity (but never fires), and an I/O
1360watcher waiting for input on one side of the socket. Each time the socket 1382watcher waiting for input on one side of the socket. Each time the socket
1361watcher reads a byte it will write that byte to a random other "server". 1383watcher reads a byte it will write that byte to a random other "server".
1362 1384
1363The effect is that there will be a lot of I/O watchers, only part of which 1385The effect is that there will be a lot of I/O watchers, only part of which
1364are active at any one point (so there is a constant number of active 1386are active at any one point (so there is a constant number of active
1365fds for each loop iterstaion, but which fds these are is random). The 1387fds for each loop iteration, but which fds these are is random). The
1366timeout is reset each time something is read because that reflects how 1388timeout is reset each time something is read because that reflects how
1367most timeouts work (and puts extra pressure on the event loops). 1389most timeouts work (and puts extra pressure on the event loops).
1368 1390
1369In this benchmark, we use 10000 socketpairs (20000 sockets), of which 100 1391In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
1370(1%) are active. This mirrors the activity of large servers with many 1392(1%) are active. This mirrors the activity of large servers with many
1371connections, most of which are idle at any one point in time. 1393connections, most of which are idle at any one point in time.
1372 1394
1373Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 1395Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
1374distribution. 1396distribution.
1376=head3 Explanation of the columns 1398=head3 Explanation of the columns
1377 1399
1378I<sockets> is the number of sockets, and twice the number of "servers" (as 1400I<sockets> is the number of sockets, and twice the number of "servers" (as
1379each server has a read and write socket end). 1401each server has a read and write socket end).
1380 1402
1381I<create> is the time it takes to create a socketpair (which is 1403I<create> is the time it takes to create a socket pair (which is
1382nontrivial) and two watchers: an I/O watcher and a timeout watcher. 1404nontrivial) and two watchers: an I/O watcher and a timeout watcher.
1383 1405
1384I<request>, the most important value, is the time it takes to handle a 1406I<request>, the most important value, is the time it takes to handle a
1385single "request", that is, reading the token from the pipe and forwarding 1407single "request", that is, reading the token from the pipe and forwarding
1386it to another server. This includes deleting the old timeout and creating 1408it to another server. This includes deleting the old timeout and creating

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines