… | |
… | |
152 | =head2 I/O WATCHERS |
152 | =head2 I/O WATCHERS |
153 | |
153 | |
154 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
154 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
155 | with the following mandatory key-value pairs as arguments: |
155 | with the following mandatory key-value pairs as arguments: |
156 | |
156 | |
157 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch |
157 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events |
158 | for events. C<poll> must be a string that is either C<r> or C<w>, |
158 | (AnyEvent might or might not keep a reference to this file handle). C<poll> |
159 | which creates a watcher waiting for "r"eadable or "w"ritable events, |
159 | must be a string that is either C<r> or C<w>, which creates a watcher |
160 | respectively. C<cb> is the callback to invoke each time the file handle |
160 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
161 | becomes ready. |
161 | callback to invoke each time the file handle becomes ready. |
162 | |
162 | |
163 | Although the callback might get passed parameters, their value and |
163 | Although the callback might get passed parameters, their value and |
164 | presence is undefined and you cannot rely on them. Portable AnyEvent |
164 | presence is undefined and you cannot rely on them. Portable AnyEvent |
165 | callbacks cannot use arguments passed to I/O watcher callbacks. |
165 | callbacks cannot use arguments passed to I/O watcher callbacks. |
166 | |
166 | |
… | |
… | |
170 | |
170 | |
171 | Some event loops issue spurious readyness notifications, so you should |
171 | Some event loops issue spurious readyness notifications, so you should |
172 | always use non-blocking calls when reading/writing from/to your file |
172 | always use non-blocking calls when reading/writing from/to your file |
173 | handles. |
173 | handles. |
174 | |
174 | |
175 | Example: |
|
|
176 | |
|
|
177 | # wait for readability of STDIN, then read a line and disable the watcher |
175 | Example: wait for readability of STDIN, then read a line and disable the |
|
|
176 | watcher. |
|
|
177 | |
178 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
178 | my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
179 | chomp (my $input = <STDIN>); |
179 | chomp (my $input = <STDIN>); |
180 | warn "read: $input\n"; |
180 | warn "read: $input\n"; |
181 | undef $w; |
181 | undef $w; |
182 | }); |
182 | }); |
… | |
… | |
192 | |
192 | |
193 | Although the callback might get passed parameters, their value and |
193 | Although the callback might get passed parameters, their value and |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
195 | callbacks cannot use arguments passed to time watcher callbacks. |
195 | callbacks cannot use arguments passed to time watcher callbacks. |
196 | |
196 | |
197 | The timer callback will be invoked at most once: if you want a repeating |
197 | The callback will normally be invoked once only. If you specify another |
198 | timer you have to create a new watcher (this is a limitation by both Tk |
198 | parameter, C<interval>, as a strictly positive number (> 0), then the |
199 | and Glib). |
199 | callback will be invoked regularly at that interval (in fractional |
|
|
200 | seconds) after the first invocation. If C<interval> is specified with a |
|
|
201 | false value, then it is treated as if it were missing. |
200 | |
202 | |
201 | Example: |
203 | The callback will be rescheduled before invoking the callback, but no |
|
|
204 | attempt is done to avoid timer drift in most backends, so the interval is |
|
|
205 | only approximate. |
202 | |
206 | |
203 | # fire an event after 7.7 seconds |
207 | Example: fire an event after 7.7 seconds. |
|
|
208 | |
204 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
209 | my $w = AnyEvent->timer (after => 7.7, cb => sub { |
205 | warn "timeout\n"; |
210 | warn "timeout\n"; |
206 | }); |
211 | }); |
207 | |
212 | |
208 | # to cancel the timer: |
213 | # to cancel the timer: |
209 | undef $w; |
214 | undef $w; |
210 | |
215 | |
211 | Example 2: |
|
|
212 | |
|
|
213 | # fire an event after 0.5 seconds, then roughly every second |
216 | Example 2: fire an event after 0.5 seconds, then roughly every second. |
214 | my $w; |
|
|
215 | |
217 | |
216 | my $cb = sub { |
|
|
217 | # cancel the old timer while creating a new one |
|
|
218 | $w = AnyEvent->timer (after => 1, cb => $cb); |
218 | my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { |
|
|
219 | warn "timeout\n"; |
219 | }; |
220 | }; |
220 | |
|
|
221 | # start the "loop" by creating the first watcher |
|
|
222 | $w = AnyEvent->timer (after => 0.5, cb => $cb); |
|
|
223 | |
221 | |
224 | =head3 TIMING ISSUES |
222 | =head3 TIMING ISSUES |
225 | |
223 | |
226 | There are two ways to handle timers: based on real time (relative, "fire |
224 | There are two ways to handle timers: based on real time (relative, "fire |
227 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
225 | in 10 seconds") and based on wallclock time (absolute, "fire at 12 |
… | |
… | |
305 | =back |
303 | =back |
306 | |
304 | |
307 | =head2 SIGNAL WATCHERS |
305 | =head2 SIGNAL WATCHERS |
308 | |
306 | |
309 | You can watch for signals using a signal watcher, C<signal> is the signal |
307 | You can watch for signals using a signal watcher, C<signal> is the signal |
310 | I<name> without any C<SIG> prefix, C<cb> is the Perl callback to |
308 | I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl |
311 | be invoked whenever a signal occurs. |
309 | callback to be invoked whenever a signal occurs. |
312 | |
310 | |
313 | Although the callback might get passed parameters, their value and |
311 | Although the callback might get passed parameters, their value and |
314 | presence is undefined and you cannot rely on them. Portable AnyEvent |
312 | presence is undefined and you cannot rely on them. Portable AnyEvent |
315 | callbacks cannot use arguments passed to signal watcher callbacks. |
313 | callbacks cannot use arguments passed to signal watcher callbacks. |
316 | |
314 | |
… | |
… | |
738 | =item L<AnyEvent::Util> |
736 | =item L<AnyEvent::Util> |
739 | |
737 | |
740 | Contains various utility functions that replace often-used but blocking |
738 | Contains various utility functions that replace often-used but blocking |
741 | functions such as C<inet_aton> by event-/callback-based versions. |
739 | functions such as C<inet_aton> by event-/callback-based versions. |
742 | |
740 | |
743 | =item L<AnyEvent::Handle> |
|
|
744 | |
|
|
745 | Provide read and write buffers and manages watchers for reads and writes. |
|
|
746 | |
|
|
747 | =item L<AnyEvent::Socket> |
741 | =item L<AnyEvent::Socket> |
748 | |
742 | |
749 | Provides various utility functions for (internet protocol) sockets, |
743 | Provides various utility functions for (internet protocol) sockets, |
750 | addresses and name resolution. Also functions to create non-blocking tcp |
744 | addresses and name resolution. Also functions to create non-blocking tcp |
751 | connections or tcp servers, with IPv6 and SRV record support and more. |
745 | connections or tcp servers, with IPv6 and SRV record support and more. |
752 | |
746 | |
|
|
747 | =item L<AnyEvent::Handle> |
|
|
748 | |
|
|
749 | Provide read and write buffers, manages watchers for reads and writes, |
|
|
750 | supports raw and formatted I/O, I/O queued and fully transparent and |
|
|
751 | non-blocking SSL/TLS. |
|
|
752 | |
753 | =item L<AnyEvent::DNS> |
753 | =item L<AnyEvent::DNS> |
754 | |
754 | |
755 | Provides rich asynchronous DNS resolver capabilities. |
755 | Provides rich asynchronous DNS resolver capabilities. |
756 | |
756 | |
757 | =item L<AnyEvent::HTTP> |
757 | =item L<AnyEvent::HTTP> |
… | |
… | |
767 | |
767 | |
768 | The fastest ping in the west. |
768 | The fastest ping in the west. |
769 | |
769 | |
770 | =item L<AnyEvent::DBI> |
770 | =item L<AnyEvent::DBI> |
771 | |
771 | |
772 | Executes DBI requests asynchronously in a proxy process. |
772 | Executes L<DBI> requests asynchronously in a proxy process. |
|
|
773 | |
|
|
774 | =item L<AnyEvent::AIO> |
|
|
775 | |
|
|
776 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
777 | programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent |
|
|
778 | together. |
|
|
779 | |
|
|
780 | =item L<AnyEvent::BDB> |
|
|
781 | |
|
|
782 | Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses |
|
|
783 | L<BDB> and AnyEvent together. |
|
|
784 | |
|
|
785 | =item L<AnyEvent::GPSD> |
|
|
786 | |
|
|
787 | A non-blocking interface to gpsd, a daemon delivering GPS information. |
|
|
788 | |
|
|
789 | =item L<AnyEvent::IGS> |
|
|
790 | |
|
|
791 | A non-blocking interface to the Internet Go Server protocol (used by |
|
|
792 | L<App::IGS>). |
773 | |
793 | |
774 | =item L<Net::IRC3> |
794 | =item L<Net::IRC3> |
775 | |
795 | |
776 | AnyEvent based IRC client module family. |
796 | AnyEvent based IRC client module family. |
777 | |
797 | |
… | |
… | |
790 | |
810 | |
791 | =item L<Coro> |
811 | =item L<Coro> |
792 | |
812 | |
793 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
813 | Has special support for AnyEvent via L<Coro::AnyEvent>. |
794 | |
814 | |
795 | =item L<AnyEvent::AIO>, L<IO::AIO> |
|
|
796 | |
|
|
797 | Truly asynchronous I/O, should be in the toolbox of every event |
|
|
798 | programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent |
|
|
799 | together. |
|
|
800 | |
|
|
801 | =item L<AnyEvent::BDB>, L<BDB> |
|
|
802 | |
|
|
803 | Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses |
|
|
804 | IO::AIO and AnyEvent together. |
|
|
805 | |
|
|
806 | =item L<IO::Lambda> |
815 | =item L<IO::Lambda> |
807 | |
816 | |
808 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
817 | The lambda approach to I/O - don't ask, look there. Can use AnyEvent. |
809 | |
818 | |
810 | =back |
819 | =back |
… | |
… | |
816 | no warnings; |
825 | no warnings; |
817 | use strict; |
826 | use strict; |
818 | |
827 | |
819 | use Carp; |
828 | use Carp; |
820 | |
829 | |
821 | our $VERSION = 4.151; |
830 | our $VERSION = 4.2; |
822 | our $MODEL; |
831 | our $MODEL; |
823 | |
832 | |
824 | our $AUTOLOAD; |
833 | our $AUTOLOAD; |
825 | our @ISA; |
834 | our @ISA; |
826 | |
835 | |
… | |
… | |
929 | $MODEL |
938 | $MODEL |
930 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
939 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
931 | } |
940 | } |
932 | } |
941 | } |
933 | |
942 | |
934 | unshift @ISA, $MODEL; |
|
|
935 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
943 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
|
|
944 | |
|
|
945 | if ($ENV{PERL_ANYEVENT_STRICT}) { |
|
|
946 | unshift @AnyEvent::Base::Strict::ISA, $MODEL; |
|
|
947 | unshift @ISA, AnyEvent::Base::Strict:: |
|
|
948 | } else { |
|
|
949 | unshift @ISA, $MODEL; |
|
|
950 | } |
936 | |
951 | |
937 | (shift @post_detect)->() while @post_detect; |
952 | (shift @post_detect)->() while @post_detect; |
938 | } |
953 | } |
939 | |
954 | |
940 | $MODEL |
955 | $MODEL |
… | |
… | |
988 | sub AnyEvent::Base::Signal::DESTROY { |
1003 | sub AnyEvent::Base::Signal::DESTROY { |
989 | my ($signal, $cb) = @{$_[0]}; |
1004 | my ($signal, $cb) = @{$_[0]}; |
990 | |
1005 | |
991 | delete $SIG_CB{$signal}{$cb}; |
1006 | delete $SIG_CB{$signal}{$cb}; |
992 | |
1007 | |
993 | $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; |
1008 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
994 | } |
1009 | } |
995 | |
1010 | |
996 | # default implementation for ->child |
1011 | # default implementation for ->child |
997 | |
1012 | |
998 | our %PID_CB; |
1013 | our %PID_CB; |
… | |
… | |
1106 | |
1121 | |
1107 | # undocumented/compatibility with pre-3.4 |
1122 | # undocumented/compatibility with pre-3.4 |
1108 | *broadcast = \&send; |
1123 | *broadcast = \&send; |
1109 | *wait = \&_wait; |
1124 | *wait = \&_wait; |
1110 | |
1125 | |
|
|
1126 | package AnyEvent::Base::Strict; |
|
|
1127 | |
|
|
1128 | use Carp qw(croak); |
|
|
1129 | |
|
|
1130 | # supply checks for argument validity for many functions |
|
|
1131 | |
|
|
1132 | sub io { |
|
|
1133 | my $class = shift; |
|
|
1134 | my %arg = @_; |
|
|
1135 | |
|
|
1136 | ref $arg{cb} |
|
|
1137 | or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'"; |
|
|
1138 | delete $arg{cb}; |
|
|
1139 | |
|
|
1140 | fileno $arg{fh} |
|
|
1141 | or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'"; |
|
|
1142 | delete $arg{fh}; |
|
|
1143 | |
|
|
1144 | $arg{poll} =~ /^[rw]$/ |
|
|
1145 | or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'"; |
|
|
1146 | delete $arg{poll}; |
|
|
1147 | |
|
|
1148 | croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg |
|
|
1149 | if keys %arg; |
|
|
1150 | |
|
|
1151 | $class->SUPER::io (@_) |
|
|
1152 | } |
|
|
1153 | |
|
|
1154 | sub timer { |
|
|
1155 | my $class = shift; |
|
|
1156 | my %arg = @_; |
|
|
1157 | |
|
|
1158 | ref $arg{cb} |
|
|
1159 | or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'"; |
|
|
1160 | delete $arg{cb}; |
|
|
1161 | |
|
|
1162 | exists $arg{after} |
|
|
1163 | or croak "AnyEvent->timer called without mandatory 'after' parameter"; |
|
|
1164 | delete $arg{after}; |
|
|
1165 | |
|
|
1166 | $arg{interval} > 0 || !$arg{interval} |
|
|
1167 | or croak "AnyEvent->timer called with illegal interval argument '$arg{interval}'"; |
|
|
1168 | delete $arg{interval}; |
|
|
1169 | |
|
|
1170 | croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg |
|
|
1171 | if keys %arg; |
|
|
1172 | |
|
|
1173 | $class->SUPER::timer (@_) |
|
|
1174 | } |
|
|
1175 | |
|
|
1176 | sub signal { |
|
|
1177 | my $class = shift; |
|
|
1178 | my %arg = @_; |
|
|
1179 | |
|
|
1180 | ref $arg{cb} |
|
|
1181 | or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; |
|
|
1182 | delete $arg{cb}; |
|
|
1183 | |
|
|
1184 | eval "require POSIX; defined &POSIX::SIG$arg{signal}" |
|
|
1185 | or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'"; |
|
|
1186 | delete $arg{signal}; |
|
|
1187 | |
|
|
1188 | croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg |
|
|
1189 | if keys %arg; |
|
|
1190 | |
|
|
1191 | $class->SUPER::signal (@_) |
|
|
1192 | } |
|
|
1193 | |
|
|
1194 | sub child { |
|
|
1195 | my $class = shift; |
|
|
1196 | my %arg = @_; |
|
|
1197 | |
|
|
1198 | ref $arg{cb} |
|
|
1199 | or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; |
|
|
1200 | delete $arg{cb}; |
|
|
1201 | |
|
|
1202 | $arg{pid} =~ /^-?\d+$/ |
|
|
1203 | or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'"; |
|
|
1204 | delete $arg{pid}; |
|
|
1205 | |
|
|
1206 | croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg |
|
|
1207 | if keys %arg; |
|
|
1208 | |
|
|
1209 | $class->SUPER::child (@_) |
|
|
1210 | } |
|
|
1211 | |
|
|
1212 | sub condvar { |
|
|
1213 | my $class = shift; |
|
|
1214 | my %arg = @_; |
|
|
1215 | |
|
|
1216 | !exists $arg{cb} or ref $arg{cb} |
|
|
1217 | or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'"; |
|
|
1218 | delete $arg{cb}; |
|
|
1219 | |
|
|
1220 | croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg |
|
|
1221 | if keys %arg; |
|
|
1222 | |
|
|
1223 | $class->SUPER::condvar (@_) |
|
|
1224 | } |
|
|
1225 | |
|
|
1226 | sub time { |
|
|
1227 | my $class = shift; |
|
|
1228 | |
|
|
1229 | @_ |
|
|
1230 | and croak "AnyEvent->time wrongly called with paramaters"; |
|
|
1231 | |
|
|
1232 | $class->SUPER::time (@_) |
|
|
1233 | } |
|
|
1234 | |
|
|
1235 | sub now { |
|
|
1236 | my $class = shift; |
|
|
1237 | |
|
|
1238 | @_ |
|
|
1239 | and croak "AnyEvent->now wrongly called with paramaters"; |
|
|
1240 | |
|
|
1241 | $class->SUPER::now (@_) |
|
|
1242 | } |
|
|
1243 | |
1111 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1244 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1112 | |
1245 | |
1113 | This is an advanced topic that you do not normally need to use AnyEvent in |
1246 | This is an advanced topic that you do not normally need to use AnyEvent in |
1114 | a module. This section is only of use to event loop authors who want to |
1247 | a module. This section is only of use to event loop authors who want to |
1115 | provide AnyEvent compatibility. |
1248 | provide AnyEvent compatibility. |
… | |
… | |
1167 | conditions, such as not being able to load the event model specified by |
1300 | conditions, such as not being able to load the event model specified by |
1168 | C<PERL_ANYEVENT_MODEL>. |
1301 | C<PERL_ANYEVENT_MODEL>. |
1169 | |
1302 | |
1170 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1303 | When set to C<2> or higher, cause AnyEvent to report to STDERR which event |
1171 | model it chooses. |
1304 | model it chooses. |
|
|
1305 | |
|
|
1306 | =item C<PERL_ANYEVENT_STRICT> |
|
|
1307 | |
|
|
1308 | AnyEvent does not do much argument checking by default, as thorough |
|
|
1309 | argument checking is very costly. Setting this variable to a true value |
|
|
1310 | will cause AnyEvent to thoroughly check the arguments passed to most |
|
|
1311 | method calls and croaks if it finds any problems. In other words, enables |
|
|
1312 | "strict" mode. Unlike C<use strict> it is definitely recommended ot keep |
|
|
1313 | it off in production. |
1172 | |
1314 | |
1173 | =item C<PERL_ANYEVENT_MODEL> |
1315 | =item C<PERL_ANYEVENT_MODEL> |
1174 | |
1316 | |
1175 | This can be used to specify the event model to be used by AnyEvent, before |
1317 | This can be used to specify the event model to be used by AnyEvent, before |
1176 | auto detection and -probing kicks in. It must be a string consisting |
1318 | auto detection and -probing kicks in. It must be a string consisting |
… | |
… | |
1673 | |
1815 | |
1674 | use AnyEvent; |
1816 | use AnyEvent; |
1675 | |
1817 | |
1676 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1818 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1677 | be used to probe what backend is used and gain other information (which is |
1819 | be used to probe what backend is used and gain other information (which is |
1678 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL). |
1820 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
|
|
1821 | $ENV{PERL_ANYEGENT_STRICT}. |
1679 | |
1822 | |
1680 | |
1823 | |
1681 | =head1 BUGS |
1824 | =head1 BUGS |
1682 | |
1825 | |
1683 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
1826 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |