… | |
… | |
137 | These watchers are normal Perl objects with normal Perl lifetime. After |
137 | These watchers are normal Perl objects with normal Perl lifetime. After |
138 | creating a watcher it will immediately "watch" for events and invoke the |
138 | creating a watcher it will immediately "watch" for events and invoke the |
139 | callback when the event occurs (of course, only when the event model |
139 | callback when the event occurs (of course, only when the event model |
140 | is in control). |
140 | is in control). |
141 | |
141 | |
|
|
142 | Note that B<callbacks must not permanently change global variables> |
|
|
143 | potentially in use by the event loop (such as C<$_> or C<$[>) and that B<< |
|
|
144 | callbacks must not C<die> >>. The former is good programming practise in |
|
|
145 | Perl and the latter stems from the fact that exception handling differs |
|
|
146 | widely between event loops. |
|
|
147 | |
142 | To disable the watcher you have to destroy it (e.g. by setting the |
148 | To disable the watcher you have to destroy it (e.g. by setting the |
143 | variable you store it in to C<undef> or otherwise deleting all references |
149 | variable you store it in to C<undef> or otherwise deleting all references |
144 | to it). |
150 | to it). |
145 | |
151 | |
146 | All watchers are created by calling a method on the C<AnyEvent> class. |
152 | All watchers are created by calling a method on the C<AnyEvent> class. |
… | |
… | |
162 | =head2 I/O WATCHERS |
168 | =head2 I/O WATCHERS |
163 | |
169 | |
164 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
170 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
165 | with the following mandatory key-value pairs as arguments: |
171 | with the following mandatory key-value pairs as arguments: |
166 | |
172 | |
167 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events |
173 | C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch |
168 | (AnyEvent might or might not keep a reference to this file handle). C<poll> |
174 | for events (AnyEvent might or might not keep a reference to this file |
|
|
175 | handle). Note that only file handles pointing to things for which |
|
|
176 | non-blocking operation makes sense are allowed. This includes sockets, |
|
|
177 | most character devices, pipes, fifos and so on, but not for example files |
|
|
178 | or block devices. |
|
|
179 | |
169 | must be a string that is either C<r> or C<w>, which creates a watcher |
180 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
170 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
181 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
|
|
182 | |
171 | callback to invoke each time the file handle becomes ready. |
183 | C<cb> is the callback to invoke each time the file handle becomes ready. |
172 | |
184 | |
173 | Although the callback might get passed parameters, their value and |
185 | Although the callback might get passed parameters, their value and |
174 | presence is undefined and you cannot rely on them. Portable AnyEvent |
186 | presence is undefined and you cannot rely on them. Portable AnyEvent |
175 | callbacks cannot use arguments passed to I/O watcher callbacks. |
187 | callbacks cannot use arguments passed to I/O watcher callbacks. |
176 | |
188 | |
… | |
… | |
825 | =item L<AnyEvent::IGS> |
837 | =item L<AnyEvent::IGS> |
826 | |
838 | |
827 | A non-blocking interface to the Internet Go Server protocol (used by |
839 | A non-blocking interface to the Internet Go Server protocol (used by |
828 | L<App::IGS>). |
840 | L<App::IGS>). |
829 | |
841 | |
830 | =item L<Net::IRC3> |
842 | =item L<AnyEvent::IRC> |
831 | |
843 | |
832 | AnyEvent based IRC client module family. |
844 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
833 | |
845 | |
834 | =item L<Net::XMPP2> |
846 | =item L<Net::XMPP2> |
835 | |
847 | |
836 | AnyEvent based XMPP (Jabber protocol) module family. |
848 | AnyEvent based XMPP (Jabber protocol) module family. |
837 | |
849 | |
… | |
… | |
861 | no warnings; |
873 | no warnings; |
862 | use strict qw(vars subs); |
874 | use strict qw(vars subs); |
863 | |
875 | |
864 | use Carp; |
876 | use Carp; |
865 | |
877 | |
866 | our $VERSION = 4.3; |
878 | our $VERSION = 4.351; |
867 | our $MODEL; |
879 | our $MODEL; |
868 | |
880 | |
869 | our $AUTOLOAD; |
881 | our $AUTOLOAD; |
870 | our @ISA; |
882 | our @ISA; |
871 | |
883 | |
… | |
… | |
970 | last; |
982 | last; |
971 | } |
983 | } |
972 | } |
984 | } |
973 | |
985 | |
974 | $MODEL |
986 | $MODEL |
975 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
987 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
976 | } |
988 | } |
977 | } |
989 | } |
978 | |
990 | |
979 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
991 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
980 | |
992 | |
… | |
… | |
1004 | # to support binding more than one watcher per filehandle (they usually |
1016 | # to support binding more than one watcher per filehandle (they usually |
1005 | # allow only one watcher per fd, so we dup it to get a different one). |
1017 | # allow only one watcher per fd, so we dup it to get a different one). |
1006 | sub _dupfh($$$$) { |
1018 | sub _dupfh($$$$) { |
1007 | my ($poll, $fh, $r, $w) = @_; |
1019 | my ($poll, $fh, $r, $w) = @_; |
1008 | |
1020 | |
1009 | require Fcntl; |
|
|
1010 | |
|
|
1011 | # cygwin requires the fh mode to be matching, unix doesn't |
1021 | # cygwin requires the fh mode to be matching, unix doesn't |
1012 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1022 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1013 | : $poll eq "w" ? ($w, ">") |
1023 | : $poll eq "w" ? ($w, ">") |
1014 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1024 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1015 | |
1025 | |
1016 | open my $fh2, "$mode&" . fileno $fh |
1026 | open my $fh2, "$mode&" . fileno $fh |
1017 | or die "cannot dup() filehandle: $!"; |
1027 | or die "cannot dup() filehandle: $!,"; |
1018 | |
1028 | |
1019 | # we assume CLOEXEC is already set by perl in all important cases |
1029 | # we assume CLOEXEC is already set by perl in all important cases |
1020 | |
1030 | |
1021 | ($fh2, $rw) |
1031 | ($fh2, $rw) |
1022 | } |
1032 | } |
… | |
… | |
1043 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1053 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1044 | } |
1054 | } |
1045 | |
1055 | |
1046 | # default implementation for ->signal |
1056 | # default implementation for ->signal |
1047 | |
1057 | |
1048 | our %SIG_CB; |
1058 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1059 | |
|
|
1060 | sub _signal_exec { |
|
|
1061 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1062 | |
|
|
1063 | while (%SIG_EV) { |
|
|
1064 | for (keys %SIG_EV) { |
|
|
1065 | delete $SIG_EV{$_}; |
|
|
1066 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1067 | } |
|
|
1068 | } |
|
|
1069 | } |
1049 | |
1070 | |
1050 | sub signal { |
1071 | sub signal { |
1051 | my (undef, %arg) = @_; |
1072 | my (undef, %arg) = @_; |
1052 | |
1073 | |
|
|
1074 | unless ($SIGPIPE_R) { |
|
|
1075 | require Fcntl; |
|
|
1076 | |
|
|
1077 | if (AnyEvent::WIN32) { |
|
|
1078 | require AnyEvent::Util; |
|
|
1079 | |
|
|
1080 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1081 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1082 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1083 | } else { |
|
|
1084 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1085 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1086 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1087 | } |
|
|
1088 | |
|
|
1089 | $SIGPIPE_R |
|
|
1090 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1091 | |
|
|
1092 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1093 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1094 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1095 | |
|
|
1096 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1097 | } |
|
|
1098 | |
1053 | my $signal = uc $arg{signal} |
1099 | my $signal = uc $arg{signal} |
1054 | or Carp::croak "required option 'signal' is missing"; |
1100 | or Carp::croak "required option 'signal' is missing"; |
1055 | |
1101 | |
1056 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1102 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1057 | $SIG{$signal} ||= sub { |
1103 | $SIG{$signal} ||= sub { |
1058 | $_->() for values %{ $SIG_CB{$signal} || {} }; |
1104 | local $!; |
|
|
1105 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1106 | undef $SIG_EV{$signal}; |
1059 | }; |
1107 | }; |
1060 | |
1108 | |
1061 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1109 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1062 | } |
1110 | } |
1063 | |
1111 | |
… | |
… | |
1263 | used, and preference will be given to protocols mentioned earlier in the |
1311 | used, and preference will be given to protocols mentioned earlier in the |
1264 | list. |
1312 | list. |
1265 | |
1313 | |
1266 | This variable can effectively be used for denial-of-service attacks |
1314 | This variable can effectively be used for denial-of-service attacks |
1267 | against local programs (e.g. when setuid), although the impact is likely |
1315 | against local programs (e.g. when setuid), although the impact is likely |
1268 | small, as the program has to handle connection errors already- |
1316 | small, as the program has to handle conenction and other failures anyways. |
1269 | |
1317 | |
1270 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1318 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1271 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1319 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1272 | - only support IPv4, never try to resolve or contact IPv6 |
1320 | - only support IPv4, never try to resolve or contact IPv6 |
1273 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1321 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
… | |
… | |
1533 | watcher. |
1581 | watcher. |
1534 | |
1582 | |
1535 | =head3 Results |
1583 | =head3 Results |
1536 | |
1584 | |
1537 | name watchers bytes create invoke destroy comment |
1585 | name watchers bytes create invoke destroy comment |
1538 | EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
1586 | EV/EV 400000 224 0.47 0.35 0.27 EV native interface |
1539 | EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers |
1587 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1540 | CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal |
1588 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1541 | Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation |
1589 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1542 | Event/Event 16000 516 31.88 31.30 0.85 Event native interface |
1590 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1543 | Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers |
1591 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
1544 | Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour |
1592 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1545 | Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers |
1593 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1546 | POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event |
1594 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1547 | POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select |
1595 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1548 | |
1596 | |
1549 | =head3 Discussion |
1597 | =head3 Discussion |
1550 | |
1598 | |
1551 | The benchmark does I<not> measure scalability of the event loop very |
1599 | The benchmark does I<not> measure scalability of the event loop very |
1552 | well. For example, a select-based event loop (such as the pure perl one) |
1600 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1754 | watchers, as the management overhead dominates. |
1802 | watchers, as the management overhead dominates. |
1755 | |
1803 | |
1756 | =back |
1804 | =back |
1757 | |
1805 | |
1758 | |
1806 | |
|
|
1807 | =head1 SIGNALS |
|
|
1808 | |
|
|
1809 | AnyEvent currently installs handlers for these signals: |
|
|
1810 | |
|
|
1811 | =over 4 |
|
|
1812 | |
|
|
1813 | =item SIGCHLD |
|
|
1814 | |
|
|
1815 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
|
|
1816 | emulation for event loops that do not support them natively. Also, some |
|
|
1817 | event loops install a similar handler. |
|
|
1818 | |
|
|
1819 | =item SIGPIPE |
|
|
1820 | |
|
|
1821 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
|
|
1822 | when AnyEvent gets loaded. |
|
|
1823 | |
|
|
1824 | The rationale for this is that AnyEvent users usually do not really depend |
|
|
1825 | on SIGPIPE delivery (which is purely an optimisation for shell use, or |
|
|
1826 | badly-written programs), but C<SIGPIPE> can cause spurious and rare |
|
|
1827 | program exits as a lot of people do not expect C<SIGPIPE> when writing to |
|
|
1828 | some random socket. |
|
|
1829 | |
|
|
1830 | The rationale for installing a no-op handler as opposed to ignoring it is |
|
|
1831 | that this way, the handler will be restored to defaults on exec. |
|
|
1832 | |
|
|
1833 | Feel free to install your own handler, or reset it to defaults. |
|
|
1834 | |
|
|
1835 | =back |
|
|
1836 | |
|
|
1837 | =cut |
|
|
1838 | |
|
|
1839 | $SIG{PIPE} = sub { } |
|
|
1840 | unless defined $SIG{PIPE}; |
|
|
1841 | |
|
|
1842 | |
1759 | =head1 FORK |
1843 | =head1 FORK |
1760 | |
1844 | |
1761 | Most event libraries are not fork-safe. The ones who are usually are |
1845 | Most event libraries are not fork-safe. The ones who are usually are |
1762 | because they rely on inefficient but fork-safe C<select> or C<poll> |
1846 | because they rely on inefficient but fork-safe C<select> or C<poll> |
1763 | calls. Only L<EV> is fully fork-aware. |
1847 | calls. Only L<EV> is fully fork-aware. |
… | |
… | |
1791 | =head1 BUGS |
1875 | =head1 BUGS |
1792 | |
1876 | |
1793 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
1877 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
1794 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
1878 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
1795 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
1879 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
1796 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
1880 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
1797 | pronounced). |
1881 | pronounced). |
1798 | |
1882 | |
1799 | |
1883 | |
1800 | =head1 SEE ALSO |
1884 | =head1 SEE ALSO |
1801 | |
1885 | |