… | |
… | |
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 | |
… | |
… | |
307 | |
319 | |
308 | In either case, if you care (and in most cases, you don't), then you |
320 | In either case, if you care (and in most cases, you don't), then you |
309 | can get whatever behaviour you want with any event loop, by taking the |
321 | can get whatever behaviour you want with any event loop, by taking the |
310 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
322 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
311 | account. |
323 | account. |
|
|
324 | |
|
|
325 | =item AnyEvent->now_update |
|
|
326 | |
|
|
327 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
|
|
328 | the current time for each loop iteration (see the discussion of L<< |
|
|
329 | AnyEvent->now >>, above). |
|
|
330 | |
|
|
331 | When a callback runs for a long time (or when the process sleeps), then |
|
|
332 | this "current" time will differ substantially from the real time, which |
|
|
333 | might affect timers and time-outs. |
|
|
334 | |
|
|
335 | When this is the case, you can call this method, which will update the |
|
|
336 | event loop's idea of "current time". |
|
|
337 | |
|
|
338 | Note that updating the time I<might> cause some events to be handled. |
312 | |
339 | |
313 | =back |
340 | =back |
314 | |
341 | |
315 | =head2 SIGNAL WATCHERS |
342 | =head2 SIGNAL WATCHERS |
316 | |
343 | |
… | |
… | |
825 | =item L<AnyEvent::IGS> |
852 | =item L<AnyEvent::IGS> |
826 | |
853 | |
827 | A non-blocking interface to the Internet Go Server protocol (used by |
854 | A non-blocking interface to the Internet Go Server protocol (used by |
828 | L<App::IGS>). |
855 | L<App::IGS>). |
829 | |
856 | |
830 | =item L<Net::IRC3> |
857 | =item L<AnyEvent::IRC> |
831 | |
858 | |
832 | AnyEvent based IRC client module family. |
859 | AnyEvent based IRC client module family (replacing the older Net::IRC3). |
833 | |
860 | |
834 | =item L<Net::XMPP2> |
861 | =item L<Net::XMPP2> |
835 | |
862 | |
836 | AnyEvent based XMPP (Jabber protocol) module family. |
863 | AnyEvent based XMPP (Jabber protocol) module family. |
837 | |
864 | |
… | |
… | |
861 | no warnings; |
888 | no warnings; |
862 | use strict qw(vars subs); |
889 | use strict qw(vars subs); |
863 | |
890 | |
864 | use Carp; |
891 | use Carp; |
865 | |
892 | |
866 | our $VERSION = 4.3; |
893 | our $VERSION = 4.351; |
867 | our $MODEL; |
894 | our $MODEL; |
868 | |
895 | |
869 | our $AUTOLOAD; |
896 | our $AUTOLOAD; |
870 | our @ISA; |
897 | our @ISA; |
871 | |
898 | |
… | |
… | |
903 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
930 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
904 | [Wx:: => AnyEvent::Impl::POE::], |
931 | [Wx:: => AnyEvent::Impl::POE::], |
905 | [Prima:: => AnyEvent::Impl::POE::], |
932 | [Prima:: => AnyEvent::Impl::POE::], |
906 | ); |
933 | ); |
907 | |
934 | |
908 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
935 | our %method = map +($_ => 1), |
|
|
936 | qw(io timer time now now_update signal child condvar one_event DESTROY); |
909 | |
937 | |
910 | our @post_detect; |
938 | our @post_detect; |
911 | |
939 | |
912 | sub post_detect(&) { |
940 | sub post_detect(&) { |
913 | my ($cb) = @_; |
941 | my ($cb) = @_; |
… | |
… | |
970 | last; |
998 | last; |
971 | } |
999 | } |
972 | } |
1000 | } |
973 | |
1001 | |
974 | $MODEL |
1002 | $MODEL |
975 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
1003 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
976 | } |
1004 | } |
977 | } |
1005 | } |
978 | |
1006 | |
979 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1007 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
980 | |
1008 | |
… | |
… | |
1004 | # to support binding more than one watcher per filehandle (they usually |
1032 | # 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). |
1033 | # allow only one watcher per fd, so we dup it to get a different one). |
1006 | sub _dupfh($$$$) { |
1034 | sub _dupfh($$$$) { |
1007 | my ($poll, $fh, $r, $w) = @_; |
1035 | my ($poll, $fh, $r, $w) = @_; |
1008 | |
1036 | |
1009 | require Fcntl; |
|
|
1010 | |
|
|
1011 | # cygwin requires the fh mode to be matching, unix doesn't |
1037 | # cygwin requires the fh mode to be matching, unix doesn't |
1012 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1038 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1013 | : $poll eq "w" ? ($w, ">") |
1039 | : $poll eq "w" ? ($w, ">") |
1014 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1040 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1015 | |
1041 | |
1016 | open my $fh2, "$mode&" . fileno $fh |
1042 | open my $fh2, "$mode&" . fileno $fh |
1017 | or die "cannot dup() filehandle: $!"; |
1043 | or die "cannot dup() filehandle: $!,"; |
1018 | |
1044 | |
1019 | # we assume CLOEXEC is already set by perl in all important cases |
1045 | # we assume CLOEXEC is already set by perl in all important cases |
1020 | |
1046 | |
1021 | ($fh2, $rw) |
1047 | ($fh2, $rw) |
1022 | } |
1048 | } |
1023 | |
1049 | |
1024 | package AnyEvent::Base; |
1050 | package AnyEvent::Base; |
1025 | |
1051 | |
1026 | # default implementation for now and time |
1052 | # default implementations for many methods |
1027 | |
1053 | |
1028 | BEGIN { |
1054 | BEGIN { |
1029 | if (eval "use Time::HiRes (); time (); 1") { |
1055 | if (eval "use Time::HiRes (); time (); 1") { |
1030 | *_time = \&Time::HiRes::time; |
1056 | *_time = \&Time::HiRes::time; |
1031 | # if (eval "use POSIX (); (POSIX::times())... |
1057 | # if (eval "use POSIX (); (POSIX::times())... |
… | |
… | |
1034 | } |
1060 | } |
1035 | } |
1061 | } |
1036 | |
1062 | |
1037 | sub time { _time } |
1063 | sub time { _time } |
1038 | sub now { _time } |
1064 | sub now { _time } |
|
|
1065 | sub now_update { } |
1039 | |
1066 | |
1040 | # default implementation for ->condvar |
1067 | # default implementation for ->condvar |
1041 | |
1068 | |
1042 | sub condvar { |
1069 | sub condvar { |
1043 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1070 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1044 | } |
1071 | } |
1045 | |
1072 | |
1046 | # default implementation for ->signal |
1073 | # default implementation for ->signal |
1047 | |
1074 | |
1048 | our %SIG_CB; |
1075 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
|
|
1076 | |
|
|
1077 | sub _signal_exec { |
|
|
1078 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1079 | |
|
|
1080 | while (%SIG_EV) { |
|
|
1081 | for (keys %SIG_EV) { |
|
|
1082 | delete $SIG_EV{$_}; |
|
|
1083 | $_->() for values %{ $SIG_CB{$_} || {} }; |
|
|
1084 | } |
|
|
1085 | } |
|
|
1086 | } |
1049 | |
1087 | |
1050 | sub signal { |
1088 | sub signal { |
1051 | my (undef, %arg) = @_; |
1089 | my (undef, %arg) = @_; |
1052 | |
1090 | |
|
|
1091 | unless ($SIGPIPE_R) { |
|
|
1092 | require Fcntl; |
|
|
1093 | |
|
|
1094 | if (AnyEvent::WIN32) { |
|
|
1095 | require AnyEvent::Util; |
|
|
1096 | |
|
|
1097 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
|
|
1098 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
|
|
1099 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
|
|
1100 | } else { |
|
|
1101 | pipe $SIGPIPE_R, $SIGPIPE_W; |
|
|
1102 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
|
|
1103 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1104 | } |
|
|
1105 | |
|
|
1106 | $SIGPIPE_R |
|
|
1107 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
|
|
1108 | |
|
|
1109 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1110 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1111 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1112 | |
|
|
1113 | $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); |
|
|
1114 | } |
|
|
1115 | |
1053 | my $signal = uc $arg{signal} |
1116 | my $signal = uc $arg{signal} |
1054 | or Carp::croak "required option 'signal' is missing"; |
1117 | or Carp::croak "required option 'signal' is missing"; |
1055 | |
1118 | |
1056 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1119 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1057 | $SIG{$signal} ||= sub { |
1120 | $SIG{$signal} ||= sub { |
1058 | $_->() for values %{ $SIG_CB{$signal} || {} }; |
1121 | local $!; |
|
|
1122 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
|
|
1123 | undef $SIG_EV{$signal}; |
1059 | }; |
1124 | }; |
1060 | |
1125 | |
1061 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1126 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1062 | } |
1127 | } |
1063 | |
1128 | |
… | |
… | |
1263 | used, and preference will be given to protocols mentioned earlier in the |
1328 | used, and preference will be given to protocols mentioned earlier in the |
1264 | list. |
1329 | list. |
1265 | |
1330 | |
1266 | This variable can effectively be used for denial-of-service attacks |
1331 | This variable can effectively be used for denial-of-service attacks |
1267 | against local programs (e.g. when setuid), although the impact is likely |
1332 | against local programs (e.g. when setuid), although the impact is likely |
1268 | small, as the program has to handle connection errors already- |
1333 | small, as the program has to handle conenction and other failures anyways. |
1269 | |
1334 | |
1270 | Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, |
1335 | 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> |
1336 | but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> |
1272 | - only support IPv4, never try to resolve or contact IPv6 |
1337 | - only support IPv4, never try to resolve or contact IPv6 |
1273 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
1338 | addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or |
… | |
… | |
1533 | watcher. |
1598 | watcher. |
1534 | |
1599 | |
1535 | =head3 Results |
1600 | =head3 Results |
1536 | |
1601 | |
1537 | name watchers bytes create invoke destroy comment |
1602 | name watchers bytes create invoke destroy comment |
1538 | EV/EV 400000 244 0.56 0.46 0.31 EV native interface |
1603 | 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 |
1604 | 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 |
1605 | 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 |
1606 | 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 |
1607 | 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 |
1608 | 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 |
1609 | 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 |
1610 | 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 |
1611 | 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 |
1612 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1548 | |
1613 | |
1549 | =head3 Discussion |
1614 | =head3 Discussion |
1550 | |
1615 | |
1551 | The benchmark does I<not> measure scalability of the event loop very |
1616 | 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) |
1617 | well. For example, a select-based event loop (such as the pure perl one) |
… | |
… | |
1754 | watchers, as the management overhead dominates. |
1819 | watchers, as the management overhead dominates. |
1755 | |
1820 | |
1756 | =back |
1821 | =back |
1757 | |
1822 | |
1758 | |
1823 | |
|
|
1824 | =head1 SIGNALS |
|
|
1825 | |
|
|
1826 | AnyEvent currently installs handlers for these signals: |
|
|
1827 | |
|
|
1828 | =over 4 |
|
|
1829 | |
|
|
1830 | =item SIGCHLD |
|
|
1831 | |
|
|
1832 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
|
|
1833 | emulation for event loops that do not support them natively. Also, some |
|
|
1834 | event loops install a similar handler. |
|
|
1835 | |
|
|
1836 | =item SIGPIPE |
|
|
1837 | |
|
|
1838 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
|
|
1839 | when AnyEvent gets loaded. |
|
|
1840 | |
|
|
1841 | The rationale for this is that AnyEvent users usually do not really depend |
|
|
1842 | on SIGPIPE delivery (which is purely an optimisation for shell use, or |
|
|
1843 | badly-written programs), but C<SIGPIPE> can cause spurious and rare |
|
|
1844 | program exits as a lot of people do not expect C<SIGPIPE> when writing to |
|
|
1845 | some random socket. |
|
|
1846 | |
|
|
1847 | The rationale for installing a no-op handler as opposed to ignoring it is |
|
|
1848 | that this way, the handler will be restored to defaults on exec. |
|
|
1849 | |
|
|
1850 | Feel free to install your own handler, or reset it to defaults. |
|
|
1851 | |
|
|
1852 | =back |
|
|
1853 | |
|
|
1854 | =cut |
|
|
1855 | |
|
|
1856 | $SIG{PIPE} = sub { } |
|
|
1857 | unless defined $SIG{PIPE}; |
|
|
1858 | |
|
|
1859 | |
1759 | =head1 FORK |
1860 | =head1 FORK |
1760 | |
1861 | |
1761 | Most event libraries are not fork-safe. The ones who are usually are |
1862 | 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> |
1863 | because they rely on inefficient but fork-safe C<select> or C<poll> |
1763 | calls. Only L<EV> is fully fork-aware. |
1864 | calls. Only L<EV> is fully fork-aware. |
… | |
… | |
1791 | =head1 BUGS |
1892 | =head1 BUGS |
1792 | |
1893 | |
1793 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
1894 | 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 |
1895 | 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 |
1896 | 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 |
1897 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
1797 | pronounced). |
1898 | pronounced). |
1798 | |
1899 | |
1799 | |
1900 | |
1800 | =head1 SEE ALSO |
1901 | =head1 SEE ALSO |
1801 | |
1902 | |