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.196 by root, Thu Mar 26 07:47:42 2009 UTC vs.
Revision 1.206 by root, Mon Apr 20 14:34:18 2009 UTC

168=head2 I/O WATCHERS 168=head2 I/O WATCHERS
169 169
170You can create an I/O watcher by calling the C<< AnyEvent->io >> method 170You can create an I/O watcher by calling the C<< AnyEvent->io >> method
171with the following mandatory key-value pairs as arguments: 171with the following mandatory key-value pairs as arguments:
172 172
173C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events 173C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
174(AnyEvent might or might not keep a reference to this file handle). C<poll> 174for events (AnyEvent might or might not keep a reference to this file
175handle). Note that only file handles pointing to things for which
176non-blocking operation makes sense are allowed. This includes sockets,
177most character devices, pipes, fifos and so on, but not for example files
178or block devices.
179
175must be a string that is either C<r> or C<w>, which creates a watcher 180C<poll> must be a string that is either C<r> or C<w>, which creates a
176waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 181watcher waiting for "r"eadable or "w"ritable events, respectively.
182
177callback to invoke each time the file handle becomes ready. 183C<cb> is the callback to invoke each time the file handle becomes ready.
178 184
179Although the callback might get passed parameters, their value and 185Although the callback might get passed parameters, their value and
180presence is undefined and you cannot rely on them. Portable AnyEvent 186presence is undefined and you cannot rely on them. Portable AnyEvent
181callbacks cannot use arguments passed to I/O watcher callbacks. 187callbacks cannot use arguments passed to I/O watcher callbacks.
182 188
313 319
314In either case, if you care (and in most cases, you don't), then you 320In either case, if you care (and in most cases, you don't), then you
315can get whatever behaviour you want with any event loop, by taking the 321can get whatever behaviour you want with any event loop, by taking the
316difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 322difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
317account. 323account.
324
325=item AnyEvent->now_update
326
327Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
328the current time for each loop iteration (see the discussion of L<<
329AnyEvent->now >>, above).
330
331When a callback runs for a long time (or when the process sleeps), then
332this "current" time will differ substantially from the real time, which
333might affect timers and time-outs.
334
335When this is the case, you can call this method, which will update the
336event loop's idea of "current time".
337
338Note that updating the time I<might> cause some events to be handled.
318 339
319=back 340=back
320 341
321=head2 SIGNAL WATCHERS 342=head2 SIGNAL WATCHERS
322 343
867no warnings; 888no warnings;
868use strict qw(vars subs); 889use strict qw(vars subs);
869 890
870use Carp; 891use Carp;
871 892
872our $VERSION = 4.341; 893our $VERSION = 4.352;
873our $MODEL; 894our $MODEL;
874 895
875our $AUTOLOAD; 896our $AUTOLOAD;
876our @ISA; 897our @ISA;
877 898
909 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 930 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
910 [Wx:: => AnyEvent::Impl::POE::], 931 [Wx:: => AnyEvent::Impl::POE::],
911 [Prima:: => AnyEvent::Impl::POE::], 932 [Prima:: => AnyEvent::Impl::POE::],
912); 933);
913 934
914our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 935our %method = map +($_ => 1),
936 qw(io timer time now now_update signal child condvar one_event DESTROY);
915 937
916our @post_detect; 938our @post_detect;
917 939
918sub post_detect(&) { 940sub post_detect(&) {
919 my ($cb) = @_; 941 my ($cb) = @_;
976 last; 998 last;
977 } 999 }
978 } 1000 }
979 1001
980 $MODEL 1002 $MODEL
981 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";
982 } 1004 }
983 } 1005 }
984 1006
985 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1007 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
986 1008
1016 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1038 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1017 : $poll eq "w" ? ($w, ">") 1039 : $poll eq "w" ? ($w, ">")
1018 : 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'";
1019 1041
1020 open my $fh2, "$mode&" . fileno $fh 1042 open my $fh2, "$mode&" . fileno $fh
1021 or die "cannot dup() filehandle: $!"; 1043 or die "cannot dup() filehandle: $!,";
1022 1044
1023 # 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
1024 1046
1025 ($fh2, $rw) 1047 ($fh2, $rw)
1026} 1048}
1027 1049
1028package AnyEvent::Base; 1050package AnyEvent::Base;
1029 1051
1030# default implementation for now and time 1052# default implementations for many methods
1031 1053
1032BEGIN { 1054BEGIN {
1033 if (eval "use Time::HiRes (); time (); 1") { 1055 if (eval "use Time::HiRes (); time (); 1") {
1034 *_time = \&Time::HiRes::time; 1056 *_time = \&Time::HiRes::time;
1035 # if (eval "use POSIX (); (POSIX::times())... 1057 # if (eval "use POSIX (); (POSIX::times())...
1038 } 1060 }
1039} 1061}
1040 1062
1041sub time { _time } 1063sub time { _time }
1042sub now { _time } 1064sub now { _time }
1065sub now_update { }
1043 1066
1044# default implementation for ->condvar 1067# default implementation for ->condvar
1045 1068
1046sub condvar { 1069sub condvar {
1047 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1070 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1050# default implementation for ->signal 1073# default implementation for ->signal
1051 1074
1052our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); 1075our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1053 1076
1054sub _signal_exec { 1077sub _signal_exec {
1078 sysread $SIGPIPE_R, my $dummy, 4;
1079
1055 while (%SIG_EV) { 1080 while (%SIG_EV) {
1056 sysread $SIGPIPE_R, my $dummy, 4;
1057 for (keys %SIG_EV) { 1081 for (keys %SIG_EV) {
1058 delete $SIG_EV{$_}; 1082 delete $SIG_EV{$_};
1059 $_->() for values %{ $SIG_CB{$_} || {} }; 1083 $_->() for values %{ $SIG_CB{$_} || {} };
1060 } 1084 }
1061 } 1085 }
1063 1087
1064sub signal { 1088sub signal {
1065 my (undef, %arg) = @_; 1089 my (undef, %arg) = @_;
1066 1090
1067 unless ($SIGPIPE_R) { 1091 unless ($SIGPIPE_R) {
1092 require Fcntl;
1093
1068 if (AnyEvent::WIN32) { 1094 if (AnyEvent::WIN32) {
1095 require AnyEvent::Util;
1096
1069 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1097 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1070 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; 1098 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1071 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case 1099 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1072 } else { 1100 } else {
1073 pipe $SIGPIPE_R, $SIGPIPE_W; 1101 pipe $SIGPIPE_R, $SIGPIPE_W;
1074 require Fcntl;
1075 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; 1102 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1076 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case 1103 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1077 } 1104 }
1078 1105
1079 $SIGPIPE_R 1106 $SIGPIPE_R
1080 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1107 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1081 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
1082 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1113 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1083 } 1114 }
1084 1115
1085 my $signal = uc $arg{signal} 1116 my $signal = uc $arg{signal}
1086 or Carp::croak "required option 'signal' is missing"; 1117 or Carp::croak "required option 'signal' is missing";
1087 1118
1088 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1119 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1089 $SIG{$signal} ||= sub { 1120 $SIG{$signal} ||= sub {
1121 local $!;
1090 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1122 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1091 undef $SIG_EV{$signal}; 1123 undef $SIG_EV{$signal};
1092 }; 1124 };
1093 1125
1094 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1126 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
1860=head1 BUGS 1892=head1 BUGS
1861 1893
1862Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 1894Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1863to work around. If you suffer from memleaks, first upgrade to Perl 5.10 1895to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1864and check wether the leaks still show up. (Perl 5.10.0 has other annoying 1896and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1865mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 1897memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1866pronounced). 1898pronounced).
1867 1899
1868 1900
1869=head1 SEE ALSO 1901=head1 SEE ALSO
1870 1902

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines