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.351 by root, Tue Aug 2 22:07:16 2011 UTC vs.
Revision 1.414 by root, Wed Aug 21 08:40:28 2013 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - the DBI of event loop programming 3AnyEvent - the DBI of event loop programming
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt 5EV, Event, Glib, Tk, Perl, Event::Lib, Irssi, rxvt-unicode, IO::Async, Qt,
6and POE are various supported event loops/environments. 6FLTK and POE are various supported event loops/environments.
7 7
8=head1 SYNOPSIS 8=head1 SYNOPSIS
9 9
10 use AnyEvent; 10 use AnyEvent;
11 11
121The interface itself is vaguely similar, but not identical to the L<Event> 121The interface itself is vaguely similar, but not identical to the L<Event>
122module. 122module.
123 123
124During the first call of any watcher-creation method, the module tries 124During the first call of any watcher-creation method, the module tries
125to detect the currently loaded event loop by probing whether one of the 125to detect the currently loaded event loop by probing whether one of the
126following modules is already loaded: L<EV>, L<AnyEvent::Impl::Perl>, 126following modules is already loaded: L<EV>, L<AnyEvent::Loop>,
127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one 127L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. The first one
128found is used. If none are detected, the module tries to load the first 128found is used. If none are detected, the module tries to load the first
129four modules in the order given; but note that if L<EV> is not 129four modules in the order given; but note that if L<EV> is not
130available, the pure-perl L<AnyEvent::Impl::Perl> should always work, so 130available, the pure-perl L<AnyEvent::Loop> should always work, so
131the other two are not normally tried. 131the other two are not normally tried.
132 132
133Because AnyEvent first checks for modules that are already loaded, loading 133Because AnyEvent first checks for modules that are already loaded, loading
134an event model explicitly before first using AnyEvent will likely make 134an event model explicitly before first using AnyEvent will likely make
135that model the default. For example: 135that model the default. For example:
142The I<likely> means that, if any module loads another event model and 142The I<likely> means that, if any module loads another event model and
143starts using it, all bets are off - this case should be very rare though, 143starts using it, all bets are off - this case should be very rare though,
144as very few modules hardcode event loops without announcing this very 144as very few modules hardcode event loops without announcing this very
145loudly. 145loudly.
146 146
147The pure-perl implementation of AnyEvent is called 147The pure-perl implementation of AnyEvent is called C<AnyEvent::Loop>. Like
148C<AnyEvent::Impl::Perl>. Like other event modules you can load it 148other event modules you can load it explicitly and enjoy the high
149explicitly and enjoy the high availability of that event loop :) 149availability of that event loop :)
150 150
151=head1 WATCHERS 151=head1 WATCHERS
152 152
153AnyEvent has the central concept of a I<watcher>, which is an object that 153AnyEvent has the central concept of a I<watcher>, which is an object that
154stores relevant data for each kind of event you are waiting for, such as 154stores relevant data for each kind of event you are waiting for, such as
271 271
272Example 2: fire an event after 0.5 seconds, then roughly every second. 272Example 2: fire an event after 0.5 seconds, then roughly every second.
273 273
274 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub { 274 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
275 warn "timeout\n"; 275 warn "timeout\n";
276 }; 276 });
277 277
278=head3 TIMING ISSUES 278=head3 TIMING ISSUES
279 279
280There are two ways to handle timers: based on real time (relative, "fire 280There are two ways to handle timers: based on real time (relative, "fire
281in 10 seconds") and based on wallclock time (absolute, "fire at 12 281in 10 seconds") and based on wallclock time (absolute, "fire at 12
356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 356difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
357account. 357account.
358 358
359=item AnyEvent->now_update 359=item AnyEvent->now_update
360 360
361Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache 361Some event loops (such as L<EV> or L<AnyEvent::Loop>) cache the current
362the current time for each loop iteration (see the discussion of L<< 362time for each loop iteration (see the discussion of L<< AnyEvent->now >>,
363AnyEvent->now >>, above). 363above).
364 364
365When a callback runs for a long time (or when the process sleeps), then 365When a callback runs for a long time (or when the process sleeps), then
366this "current" time will differ substantially from the real time, which 366this "current" time will differ substantially from the real time, which
367might affect timers and time-outs. 367might affect timers and time-outs.
368 368
415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation). 416pure perl implementation).
417 417
418=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
419 419
420Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
422latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
423 423
424AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too). 427callbacks, too).
428 428
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
433do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
434this. AnyEvent will try to do its best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
435signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
437variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442 440
443All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
447one-second latency). For those, you just have to suffer the delays. 445delays.
448 446
449=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
450 448
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 450
765 }; 763 };
766 } 764 }
767 765
768 $cv->end; 766 $cv->end;
769 767
768 ...
769
770 my $results = $cv->recv;
771
770This code fragment supposedly pings a number of hosts and calls 772This code fragment supposedly pings a number of hosts and calls
771C<send> after results for all then have have been gathered - in any 773C<send> after results for all then have have been gathered - in any
772order. To achieve this, the code issues a call to C<begin> when it starts 774order. To achieve this, the code issues a call to C<begin> when it starts
773each ping request and calls C<end> when it has received some result for 775each ping request and calls C<end> when it has received some result for
774it. Since C<begin> and C<end> only maintain a counter, the order in which 776it. Since C<begin> and C<end> only maintain a counter, the order in which
809 811
810In list context, all parameters passed to C<send> will be returned, 812In list context, all parameters passed to C<send> will be returned,
811in scalar context only the first one will be returned. 813in scalar context only the first one will be returned.
812 814
813Note that doing a blocking wait in a callback is not supported by any 815Note that doing a blocking wait in a callback is not supported by any
814event loop, that is, recursive invocation of a blocking C<< ->recv 816event loop, that is, recursive invocation of a blocking C<< ->recv >> is
815>> is not allowed, and the C<recv> call will C<croak> if such a 817not allowed and the C<recv> call will C<croak> if such a condition is
816condition is detected. This condition can be slightly loosened by using 818detected. This requirement can be dropped by relying on L<Coro::AnyEvent>
817L<Coro::AnyEvent>, which allows you to do a blocking C<< ->recv >> from 819, which allows you to do a blocking C<< ->recv >> from any thread
818any thread that doesn't run the event loop itself. 820that doesn't run the event loop itself. L<Coro::AnyEvent> is loaded
821automatically when L<Coro> is used with L<AnyEvent>, so code does not need
822to do anything special to take advantage of that: any code that would
823normally block your program because it calls C<recv>, be executed in an
824C<async> thread instead without blocking other threads.
819 825
820Not all event models support a blocking wait - some die in that case 826Not all event models support a blocking wait - some die in that case
821(programs might want to do that to stay interactive), so I<if you are 827(programs might want to do that to stay interactive), so I<if you are
822using this from a module, never require a blocking wait>. Instead, let the 828using this from a module, never require a blocking wait>. Instead, let the
823caller decide whether the call will block or not (for example, by coupling 829caller decide whether the call will block or not (for example, by coupling
860use. If EV is not installed, then AnyEvent will fall back to its own 866use. If EV is not installed, then AnyEvent will fall back to its own
861pure-perl implementation, which is available everywhere as it comes with 867pure-perl implementation, which is available everywhere as it comes with
862AnyEvent itself. 868AnyEvent itself.
863 869
864 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 870 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
865 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 871 AnyEvent::Impl::Perl pure-perl AnyEvent::Loop, fast and portable.
866 872
867=item Backends that are transparently being picked up when they are used. 873=item Backends that are transparently being picked up when they are used.
868 874
869These will be used if they are already loaded when the first watcher 875These will be used if they are already loaded when the first watcher
870is created, in which case it is assumed that the application is using 876is created, in which case it is assumed that the application is using
878 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 884 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
879 AnyEvent::Impl::POE based on POE, very slow, some limitations. 885 AnyEvent::Impl::POE based on POE, very slow, some limitations.
880 AnyEvent::Impl::Irssi used when running within irssi. 886 AnyEvent::Impl::Irssi used when running within irssi.
881 AnyEvent::Impl::IOAsync based on IO::Async. 887 AnyEvent::Impl::IOAsync based on IO::Async.
882 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop. 888 AnyEvent::Impl::Cocoa based on Cocoa::EventLoop.
883 AnyEvent::Impl::FLTK based on FLTK. 889 AnyEvent::Impl::FLTK based on FLTK (fltk 2 binding).
884 890
885=item Backends with special needs. 891=item Backends with special needs.
886 892
887Qt requires the Qt::Application to be instantiated first, but will 893Qt requires the Qt::Application to be instantiated first, but will
888otherwise be picked up automatically. As long as the main program 894otherwise be picked up automatically. As long as the main program
933 939
934Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model 940Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
935if necessary. You should only call this function right before you would 941if necessary. You should only call this function right before you would
936have created an AnyEvent watcher anyway, that is, as late as possible at 942have created an AnyEvent watcher anyway, that is, as late as possible at
937runtime, and not e.g. during initialisation of your module. 943runtime, and not e.g. during initialisation of your module.
944
945The effect of calling this function is as if a watcher had been created
946(specifically, actions that happen "when the first watcher is created"
947happen when calling detetc as well).
938 948
939If you need to do some initialisation before AnyEvent watchers are 949If you need to do some initialisation before AnyEvent watchers are
940created, use C<post_detect>. 950created, use C<post_detect>.
941 951
942=item $guard = AnyEvent::post_detect { BLOCK } 952=item $guard = AnyEvent::post_detect { BLOCK }
1005 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent 1015 # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
1006 # as soon as it is 1016 # as soon as it is
1007 push @AnyEvent::post_detect, sub { require Coro::AnyEvent }; 1017 push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
1008 } 1018 }
1009 1019
1020=item AnyEvent::postpone { BLOCK }
1021
1022Arranges for the block to be executed as soon as possible, but not before
1023the call itself returns. In practise, the block will be executed just
1024before the event loop polls for new events, or shortly afterwards.
1025
1026This function never returns anything (to make the C<return postpone { ...
1027}> idiom more useful.
1028
1029To understand the usefulness of this function, consider a function that
1030asynchronously does something for you and returns some transaction
1031object or guard to let you cancel the operation. For example,
1032C<AnyEvent::Socket::tcp_connect>:
1033
1034 # start a conenction attempt unless one is active
1035 $self->{connect_guard} ||= AnyEvent::Socket::tcp_connect "www.example.net", 80, sub {
1036 delete $self->{connect_guard};
1037 ...
1038 };
1039
1040Imagine that this function could instantly call the callback, for
1041example, because it detects an obvious error such as a negative port
1042number. Invoking the callback before the function returns causes problems
1043however: the callback will be called and will try to delete the guard
1044object. But since the function hasn't returned yet, there is nothing to
1045delete. When the function eventually returns it will assign the guard
1046object to C<< $self->{connect_guard} >>, where it will likely never be
1047deleted, so the program thinks it is still trying to connect.
1048
1049This is where C<AnyEvent::postpone> should be used. Instead of calling the
1050callback directly on error:
1051
1052 $cb->(undef), return # signal error to callback, BAD!
1053 if $some_error_condition;
1054
1055It should use C<postpone>:
1056
1057 AnyEvent::postpone { $cb->(undef) }, return # signal error to callback, later
1058 if $some_error_condition;
1059
1060=item AnyEvent::log $level, $msg[, @args]
1061
1062Log the given C<$msg> at the given C<$level>.
1063
1064If L<AnyEvent::Log> is not loaded then this function makes a simple test
1065to see whether the message will be logged. If the test succeeds it will
1066load AnyEvent::Log and call C<AnyEvent::Log::log> - consequently, look at
1067the L<AnyEvent::Log> documentation for details.
1068
1069If the test fails it will simply return. Right now this happens when a
1070numerical loglevel is used and it is larger than the level specified via
1071C<$ENV{PERL_ANYEVENT_VERBOSE}>.
1072
1073If you want to sprinkle loads of logging calls around your code, consider
1074creating a logger callback with the C<AnyEvent::Log::logger> function,
1075which can reduce typing, codesize and can reduce the logging overhead
1076enourmously.
1077
1010=back 1078=back
1011 1079
1012=head1 WHAT TO DO IN A MODULE 1080=head1 WHAT TO DO IN A MODULE
1013 1081
1014As a module author, you should C<use AnyEvent> and call AnyEvent methods 1082As a module author, you should C<use AnyEvent> and call AnyEvent methods
1047modules might create watchers when they are loaded, and AnyEvent will 1115modules might create watchers when they are loaded, and AnyEvent will
1048decide on the event model to use as soon as it creates watchers, and it 1116decide on the event model to use as soon as it creates watchers, and it
1049might choose the wrong one unless you load the correct one yourself. 1117might choose the wrong one unless you load the correct one yourself.
1050 1118
1051You can chose to use a pure-perl implementation by loading the 1119You can chose to use a pure-perl implementation by loading the
1052C<AnyEvent::Impl::Perl> module, which gives you similar behaviour 1120C<AnyEvent::Loop> module, which gives you similar behaviour
1053everywhere, but letting AnyEvent chose the model is generally better. 1121everywhere, but letting AnyEvent chose the model is generally better.
1054 1122
1055=head2 MAINLOOP EMULATION 1123=head2 MAINLOOP EMULATION
1056 1124
1057Sometimes (often for short test scripts, or even standalone programs who 1125Sometimes (often for short test scripts, or even standalone programs who
1070 1138
1071 1139
1072=head1 OTHER MODULES 1140=head1 OTHER MODULES
1073 1141
1074The following is a non-exhaustive list of additional modules that use 1142The following is a non-exhaustive list of additional modules that use
1075AnyEvent as a client and can therefore be mixed easily with other AnyEvent 1143AnyEvent as a client and can therefore be mixed easily with other
1076modules and other event loops in the same program. Some of the modules 1144AnyEvent modules and other event loops in the same program. Some of the
1077come as part of AnyEvent, the others are available via CPAN. 1145modules come as part of AnyEvent, the others are available via CPAN (see
1146L<http://search.cpan.org/search?m=module&q=anyevent%3A%3A*> for
1147a longer non-exhaustive list), and the list is heavily biased towards
1148modules of the AnyEvent author himself :)
1078 1149
1079=over 4 1150=over 4
1080 1151
1081=item L<AnyEvent::Util> 1152=item L<AnyEvent::Util> (part of the AnyEvent distribution)
1082 1153
1083Contains various utility functions that replace often-used blocking 1154Contains various utility functions that replace often-used blocking
1084functions such as C<inet_aton> with event/callback-based versions. 1155functions such as C<inet_aton> with event/callback-based versions.
1085 1156
1086=item L<AnyEvent::Socket> 1157=item L<AnyEvent::Socket> (part of the AnyEvent distribution)
1087 1158
1088Provides various utility functions for (internet protocol) sockets, 1159Provides various utility functions for (internet protocol) sockets,
1089addresses and name resolution. Also functions to create non-blocking tcp 1160addresses and name resolution. Also functions to create non-blocking tcp
1090connections or tcp servers, with IPv6 and SRV record support and more. 1161connections or tcp servers, with IPv6 and SRV record support and more.
1091 1162
1092=item L<AnyEvent::Handle> 1163=item L<AnyEvent::Handle> (part of the AnyEvent distribution)
1093 1164
1094Provide read and write buffers, manages watchers for reads and writes, 1165Provide read and write buffers, manages watchers for reads and writes,
1095supports raw and formatted I/O, I/O queued and fully transparent and 1166supports raw and formatted I/O, I/O queued and fully transparent and
1096non-blocking SSL/TLS (via L<AnyEvent::TLS>). 1167non-blocking SSL/TLS (via L<AnyEvent::TLS>).
1097 1168
1098=item L<AnyEvent::DNS> 1169=item L<AnyEvent::DNS> (part of the AnyEvent distribution)
1099 1170
1100Provides rich asynchronous DNS resolver capabilities. 1171Provides rich asynchronous DNS resolver capabilities.
1101 1172
1102=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP> 1173=item L<AnyEvent::HTTP>, L<AnyEvent::IRC>, L<AnyEvent::XMPP>, L<AnyEvent::GPSD>, L<AnyEvent::IGS>, L<AnyEvent::FCP>
1103 1174
1104Implement event-based interfaces to the protocols of the same name (for 1175Implement event-based interfaces to the protocols of the same name (for
1105the curious, IGS is the International Go Server and FCP is the Freenet 1176the curious, IGS is the International Go Server and FCP is the Freenet
1106Client Protocol). 1177Client Protocol).
1107 1178
1108=item L<AnyEvent::Handle::UDP> 1179=item L<AnyEvent::AIO> (part of the AnyEvent distribution)
1109
1110Here be danger!
1111
1112As Pauli would put it, "Not only is it not right, it's not even wrong!" -
1113there are so many things wrong with AnyEvent::Handle::UDP, most notably
1114its use of a stream-based API with a protocol that isn't streamable, that
1115the only way to improve it is to delete it.
1116
1117It features data corruption (but typically only under load) and general
1118confusion. On top, the author is not only clueless about UDP but also
1119fact-resistant - some gems of his understanding: "connect doesn't work
1120with UDP", "UDP packets are not IP packets", "UDP only has datagrams, not
1121packets", "I don't need to implement proper error checking as UDP doesn't
1122support error checking" and so on - he doesn't even understand what's
1123wrong with his module when it is explained to him.
1124
1125=item L<AnyEvent::DBI>
1126
1127Executes L<DBI> requests asynchronously in a proxy process for you,
1128notifying you in an event-based way when the operation is finished.
1129
1130=item L<AnyEvent::AIO>
1131 1180
1132Truly asynchronous (as opposed to non-blocking) I/O, should be in the 1181Truly asynchronous (as opposed to non-blocking) I/O, should be in the
1133toolbox of every event programmer. AnyEvent::AIO transparently fuses 1182toolbox of every event programmer. AnyEvent::AIO transparently fuses
1134L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based 1183L<IO::AIO> and AnyEvent together, giving AnyEvent access to event-based
1135file I/O, and much more. 1184file I/O, and much more.
1136 1185
1186=item L<AnyEvent::Filesys::Notify>
1187
1188AnyEvent is good for non-blocking stuff, but it can't detect file or
1189path changes (e.g. "watch this directory for new files", "watch this
1190file for changes"). The L<AnyEvent::Filesys::Notify> module promises to
1191do just that in a portbale fashion, supporting inotify on GNU/Linux and
1192some weird, without doubt broken, stuff on OS X to monitor files. It can
1193fall back to blocking scans at regular intervals transparently on other
1194platforms, so it's about as portable as it gets.
1195
1196(I haven't used it myself, but I haven't heard anybody complaining about
1197it yet).
1198
1199=item L<AnyEvent::DBI>
1200
1201Executes L<DBI> requests asynchronously in a proxy process for you,
1202notifying you in an event-based way when the operation is finished.
1203
1137=item L<AnyEvent::HTTPD> 1204=item L<AnyEvent::HTTPD>
1138 1205
1139A simple embedded webserver. 1206A simple embedded webserver.
1140 1207
1141=item L<AnyEvent::FastPing> 1208=item L<AnyEvent::FastPing>
1142 1209
1143The fastest ping in the west. 1210The fastest ping in the west.
1144 1211
1145=item L<Coro> 1212=item L<Coro>
1146 1213
1147Has special support for AnyEvent via L<Coro::AnyEvent>. 1214Has special support for AnyEvent via L<Coro::AnyEvent>, which allows you
1215to simply invert the flow control - don't call us, we will call you:
1216
1217 async {
1218 Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it
1219 print "5 seconds later!\n";
1220
1221 Coro::AnyEvent::readable *STDIN; # uses an I/O watcher
1222 my $line = <STDIN>; # works for ttys
1223
1224 AnyEvent::HTTP::http_get "url", Coro::rouse_cb;
1225 my ($body, $hdr) = Coro::rouse_wait;
1226 };
1148 1227
1149=back 1228=back
1150 1229
1151=cut 1230=cut
1152 1231
1153package AnyEvent; 1232package AnyEvent;
1154
1155# basically a tuned-down version of common::sense
1156sub common_sense {
1157 # from common:.sense 3.4
1158 ${^WARNING_BITS} ^= ${^WARNING_BITS} ^ "\x3c\x3f\x33\x00\x0f\xf0\x0f\xc0\xf0\xfc\x33\x00";
1159 # use strict vars subs - NO UTF-8, as Util.pm doesn't like this atm. (uts46data.pl)
1160 $^H |= 0x00000600;
1161}
1162
1163BEGIN { AnyEvent::common_sense }
1164
1165use Carp ();
1166
1167our $VERSION = '5.34';
1168our $MODEL;
1169
1170our $AUTOLOAD;
1171our @ISA;
1172
1173our @REGISTRY;
1174
1175our $VERBOSE;
1176 1233
1177BEGIN { 1234BEGIN {
1178 require "AnyEvent/constants.pl"; 1235 require "AnyEvent/constants.pl";
1236 &AnyEvent::common_sense;
1237}
1179 1238
1239use Carp ();
1240
1241our $VERSION = '7.05';
1242our $MODEL;
1243our @ISA;
1244our @REGISTRY;
1245our $VERBOSE;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1247our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1248
1249BEGIN {
1180 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1250 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1181 1251
1182 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} 1252 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
1183 if ${^TAINT}; 1253 if ${^TAINT};
1184 1254
1185 $VERBOSE = $ENV{PERL_ANYEVENT_VERBOSE}*1; 1255 $ENV{"PERL_ANYEVENT_$_"} = $ENV{"AE_$_"}
1256 for grep s/^AE_// && !exists $ENV{"PERL_ANYEVENT_$_"}, keys %ENV;
1186 1257
1187} 1258 @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} = ()
1259 if ${^TAINT};
1188 1260
1189our $MAX_SIGNAL_LATENCY = 10; 1261 # $ENV{PERL_ANYEVENT_xxx} now valid
1190 1262
1191our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1263 $VERBOSE = length $ENV{PERL_ANYEVENT_VERBOSE} ? $ENV{PERL_ANYEVENT_VERBOSE}*1 : 4;
1192 1264
1193{
1194 my $idx; 1265 my $idx;
1195 $PROTOCOL{$_} = ++$idx 1266 $PROTOCOL{$_} = ++$idx
1196 for reverse split /\s*,\s*/, 1267 for reverse split /\s*,\s*/,
1197 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1268 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1198} 1269}
1199 1270
1271our @post_detect;
1272
1273sub post_detect(&) {
1274 my ($cb) = @_;
1275
1276 push @post_detect, $cb;
1277
1278 defined wantarray
1279 ? bless \$cb, "AnyEvent::Util::postdetect"
1280 : ()
1281}
1282
1283sub AnyEvent::Util::postdetect::DESTROY {
1284 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1285}
1286
1287our $POSTPONE_W;
1288our @POSTPONE;
1289
1290sub _postpone_exec {
1291 undef $POSTPONE_W;
1292
1293 &{ shift @POSTPONE }
1294 while @POSTPONE;
1295}
1296
1297sub postpone(&) {
1298 push @POSTPONE, shift;
1299
1300 $POSTPONE_W ||= AE::timer (0, 0, \&_postpone_exec);
1301
1302 ()
1303}
1304
1305sub log($$;@) {
1306 # only load the big bloated module when we actually are about to log something
1307 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1308 local ($!, $@);
1309 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1310 # AnyEvent::Log overwrites this function
1311 goto &log;
1312 }
1313
1314 0 # not logged
1315}
1316
1317sub _logger($;$) {
1318 my ($level, $renabled) = @_;
1319
1320 $$renabled = $level <= $VERBOSE;
1321
1322 my $logger = [(caller)[0], $level, $renabled];
1323
1324 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1325
1326# return unless defined wantarray;
1327#
1328# require AnyEvent::Util;
1329# my $guard = AnyEvent::Util::guard (sub {
1330# # "clean up"
1331# delete $LOGGER{$logger+0};
1332# });
1333#
1334# sub {
1335# return 0 unless $$renabled;
1336#
1337# $guard if 0; # keep guard alive, but don't cause runtime overhead
1338# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1339# package AnyEvent::Log;
1340# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1341# }
1342}
1343
1344if (length $ENV{PERL_ANYEVENT_LOG}) {
1345 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1346}
1347
1200my @models = ( 1348our @models = (
1201 [EV:: => AnyEvent::Impl::EV:: , 1], 1349 [EV:: => AnyEvent::Impl::EV::],
1202 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1350 [AnyEvent::Loop:: => AnyEvent::Impl::Perl::],
1203 # everything below here will not (normally) be autoprobed 1351 # everything below here will not (normally) be autoprobed
1204 # as the pureperl backend should work everywhere 1352 # as the pure perl backend should work everywhere
1205 # and is usually faster 1353 # and is usually faster
1354 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package, so msut be near the top
1206 [Event:: => AnyEvent::Impl::Event::, 1], 1355 [Event:: => AnyEvent::Impl::Event::], # slow, stable
1207 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1356 [Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1357 # everything below here should not be autoloaded
1208 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1358 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1209 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1210 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1359 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1211 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1360 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1212 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1361 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1213 [Wx:: => AnyEvent::Impl::POE::], 1362 [Wx:: => AnyEvent::Impl::POE::],
1214 [Prima:: => AnyEvent::Impl::POE::], 1363 [Prima:: => AnyEvent::Impl::POE::],
1215 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], 1364 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # a bitch to autodetect
1216 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::], 1365 [Cocoa::EventLoop:: => AnyEvent::Impl::Cocoa::],
1217 [FLTK:: => AnyEvent::Impl::FLTK::], 1366 [FLTK:: => AnyEvent::Impl::FLTK::],
1218); 1367);
1219 1368
1220our %method = map +($_ => 1), 1369our @isa_hook;
1370
1371sub _isa_set {
1372 my @pkg = ("AnyEvent", (map $_->[0], grep defined, @isa_hook), $MODEL);
1373
1374 @{"$pkg[$_-1]::ISA"} = $pkg[$_]
1375 for 1 .. $#pkg;
1376
1377 grep $_ && $_->[1], @isa_hook
1378 and AE::_reset ();
1379}
1380
1381# used for hooking AnyEvent::Strict and AnyEvent::Debug::Wrap into the class hierarchy
1382sub _isa_hook($$;$) {
1383 my ($i, $pkg, $reset_ae) = @_;
1384
1385 $isa_hook[$i] = $pkg ? [$pkg, $reset_ae] : undef;
1386
1387 _isa_set;
1388}
1389
1390# all autoloaded methods reserve the complete glob, not just the method slot.
1391# due to bugs in perls method cache implementation.
1221 qw(io timer time now now_update signal child idle condvar DESTROY); 1392our @methods = qw(io timer time now now_update signal child idle condvar);
1222
1223our @post_detect;
1224
1225sub post_detect(&) {
1226 my ($cb) = @_;
1227
1228 push @post_detect, $cb;
1229
1230 defined wantarray
1231 ? bless \$cb, "AnyEvent::Util::postdetect"
1232 : ()
1233}
1234
1235sub AnyEvent::Util::postdetect::DESTROY {
1236 @post_detect = grep $_ != ${$_[0]}, @post_detect;
1237}
1238 1393
1239sub detect() { 1394sub detect() {
1395 return $MODEL if $MODEL; # some programs keep references to detect
1396
1397 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1398 # the author knows about the problems and what it does to AnyEvent as a whole
1399 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1400 # anyway.
1401 AnyEvent::log fatal => "IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1402 . "design, abuses internals and breaks AnyEvent - will not continue."
1403 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1404
1405 local $!; # for good measure
1406 local $SIG{__DIE__}; # we use eval
1407
1240 # free some memory 1408 # free some memory
1241 *detect = sub () { $MODEL }; 1409 *detect = sub () { $MODEL };
1410 # undef &func doesn't correctly update the method cache. grmbl.
1411 # so we delete the whole glob. grmbl.
1412 # otoh, perl doesn't let me undef an active usb, but it lets me free
1413 # a glob with an active sub. hrm. i hope it works, but perl is
1414 # usually buggy in this department. sigh.
1415 delete @{"AnyEvent::"}{@methods};
1416 undef @methods;
1242 1417
1243 local $!; # for good measure
1244 local $SIG{__DIE__};
1245
1246 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) { 1418 if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z0-9:]+)$/) {
1247 my $model = "AnyEvent::Impl::$1"; 1419 my $model = $1;
1420 $model = "AnyEvent::Impl::$model" unless $model =~ s/::$//;
1248 if (eval "require $model") { 1421 if (eval "require $model") {
1422 AnyEvent::log 7 => "Loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.";
1249 $MODEL = $model; 1423 $MODEL = $model;
1250 warn "AnyEvent: loaded model '$model' (forced by \$ENV{PERL_ANYEVENT_MODEL}), using it.\n" if $VERBOSE >= 2;
1251 } else { 1424 } else {
1252 warn "AnyEvent: unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@" if $VERBOSE; 1425 AnyEvent::log 4 => "Unable to load model '$model' (from \$ENV{PERL_ANYEVENT_MODEL}):\n$@";
1253 } 1426 }
1254 } 1427 }
1255 1428
1256 # check for already loaded models 1429 # check for already loaded models
1257 unless ($MODEL) { 1430 unless ($MODEL) {
1258 for (@REGISTRY, @models) { 1431 for (@REGISTRY, @models) {
1259 my ($package, $model) = @$_; 1432 my ($package, $model) = @$_;
1260 if (${"$package\::VERSION"} > 0) { 1433 if (${"$package\::VERSION"} > 0) {
1261 if (eval "require $model") { 1434 if (eval "require $model") {
1435 AnyEvent::log 7 => "Autodetected model '$model', using it.";
1262 $MODEL = $model; 1436 $MODEL = $model;
1263 warn "AnyEvent: autodetected model '$model', using it.\n" if $VERBOSE >= 2; 1437 last;
1438 } else {
1439 AnyEvent::log 8 => "Detected event loop $package, but cannot load '$model', skipping: $@";
1440 }
1441 }
1442 }
1443
1444 unless ($MODEL) {
1445 # try to autoload a model
1446 for (@REGISTRY, @models) {
1447 my ($package, $model) = @$_;
1448 if (
1449 eval "require $package"
1450 and ${"$package\::VERSION"} > 0
1451 and eval "require $model"
1452 ) {
1453 AnyEvent::log 7 => "Autoloaded model '$model', using it.";
1454 $MODEL = $model;
1264 last; 1455 last;
1265 } 1456 }
1266 } 1457 }
1267 }
1268
1269 unless ($MODEL) {
1270 # try to autoload a model
1271 for (@REGISTRY, @models) {
1272 my ($package, $model, $autoload) = @$_;
1273 if (
1274 $autoload
1275 and eval "require $package"
1276 and ${"$package\::VERSION"} > 0
1277 and eval "require $model"
1278 ) {
1279 $MODEL = $model;
1280 warn "AnyEvent: autoloaded model '$model', using it.\n" if $VERBOSE >= 2;
1281 last;
1282 }
1283 }
1284 1458
1285 $MODEL 1459 $MODEL
1286 or die "AnyEvent: backend autodetection failed - did you properly install AnyEvent?\n"; 1460 or AnyEvent::log fatal => "Backend autodetection failed - did you properly install AnyEvent?";
1287 } 1461 }
1288 } 1462 }
1289 1463
1290 @models = (); # free probe data 1464 # free memory only needed for probing
1465 undef @models;
1466 undef @REGISTRY;
1291 1467
1292 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1468 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
1293 unshift @ISA, $MODEL;
1294 1469
1295 # now nuke some methods that are overridden by the backend. 1470 # now nuke some methods that are overridden by the backend.
1296 # SUPER is not allowed. 1471 # SUPER usage is not allowed in these.
1297 for (qw(time signal child idle)) { 1472 for (qw(time signal child idle)) {
1298 undef &{"AnyEvent::Base::$_"} 1473 undef &{"AnyEvent::Base::$_"}
1299 if defined &{"$MODEL\::$_"}; 1474 if defined &{"$MODEL\::$_"};
1300 } 1475 }
1301 1476
1477 _isa_set;
1478
1479 # we're officially open!
1480
1302 if ($ENV{PERL_ANYEVENT_STRICT}) { 1481 if ($ENV{PERL_ANYEVENT_STRICT}) {
1303 eval { require AnyEvent::Strict }; 1482 require AnyEvent::Strict;
1304 warn "AnyEvent: cannot load AnyEvent::Strict: $@"
1305 if $@ && $VERBOSE;
1306 } 1483 }
1307 1484
1485 if ($ENV{PERL_ANYEVENT_DEBUG_WRAP}) {
1486 require AnyEvent::Debug;
1487 AnyEvent::Debug::wrap ($ENV{PERL_ANYEVENT_DEBUG_WRAP});
1488 }
1489
1490 if (length $ENV{PERL_ANYEVENT_DEBUG_SHELL}) {
1491 require AnyEvent::Socket;
1492 require AnyEvent::Debug;
1493
1494 my $shell = $ENV{PERL_ANYEVENT_DEBUG_SHELL};
1495 $shell =~ s/\$\$/$$/g;
1496
1497 my ($host, $service) = AnyEvent::Socket::parse_hostport ($shell);
1498 $AnyEvent::Debug::SHELL = AnyEvent::Debug::shell ($host, $service);
1499 }
1500
1501 # now the anyevent environment is set up as the user told us to, so
1502 # call the actual user code - post detects
1503
1308 (shift @post_detect)->() while @post_detect; 1504 (shift @post_detect)->() while @post_detect;
1505 undef @post_detect;
1309 1506
1310 *post_detect = sub(&) { 1507 *post_detect = sub(&) {
1311 shift->(); 1508 shift->();
1312 1509
1313 undef 1510 undef
1314 }; 1511 };
1315 1512
1316 $MODEL 1513 $MODEL
1317} 1514}
1318 1515
1319sub AUTOLOAD { 1516for my $name (@methods) {
1320 (my $func = $AUTOLOAD) =~ s/.*://; 1517 *$name = sub {
1321
1322 $method{$func}
1323 or Carp::croak "$func: not a valid AnyEvent class method";
1324
1325 detect; 1518 detect;
1326 1519 # we use goto because
1327 my $class = shift; 1520 # a) it makes the thunk more transparent
1328 $class->$func (@_); 1521 # b) it allows us to delete the thunk later
1522 goto &{ UNIVERSAL::can AnyEvent => "SUPER::$name" }
1523 };
1329} 1524}
1330 1525
1331# utility function to dup a filehandle. this is used by many backends 1526# utility function to dup a filehandle. this is used by many backends
1332# to support binding more than one watcher per filehandle (they usually 1527# to support binding more than one watcher per filehandle (they usually
1333# allow only one watcher per fd, so we dup it to get a different one). 1528# allow only one watcher per fd, so we dup it to get a different one).
1357 1552
1358package AE; 1553package AE;
1359 1554
1360our $VERSION = $AnyEvent::VERSION; 1555our $VERSION = $AnyEvent::VERSION;
1361 1556
1557sub _reset() {
1558 eval q{
1362# fall back to the main API by default - backends and AnyEvent::Base 1559 # fall back to the main API by default - backends and AnyEvent::Base
1363# implementations can overwrite these. 1560 # implementations can overwrite these.
1364 1561
1365sub io($$$) { 1562 sub io($$$) {
1366 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2]) 1563 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1367} 1564 }
1368 1565
1369sub timer($$$) { 1566 sub timer($$$) {
1370 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]) 1567 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1371} 1568 }
1372 1569
1373sub signal($$) { 1570 sub signal($$) {
1374 AnyEvent->signal (signal => $_[0], cb => $_[1]) 1571 AnyEvent->signal (signal => $_[0], cb => $_[1])
1375} 1572 }
1376 1573
1377sub child($$) { 1574 sub child($$) {
1378 AnyEvent->child (pid => $_[0], cb => $_[1]) 1575 AnyEvent->child (pid => $_[0], cb => $_[1])
1379} 1576 }
1380 1577
1381sub idle($) { 1578 sub idle($) {
1382 AnyEvent->idle (cb => $_[0]) 1579 AnyEvent->idle (cb => $_[0]);
1383} 1580 }
1384 1581
1385sub cv(;&) { 1582 sub cv(;&) {
1386 AnyEvent->condvar (@_ ? (cb => $_[0]) : ()) 1583 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1387} 1584 }
1388 1585
1389sub now() { 1586 sub now() {
1390 AnyEvent->now 1587 AnyEvent->now
1391} 1588 }
1392 1589
1393sub now_update() { 1590 sub now_update() {
1394 AnyEvent->now_update 1591 AnyEvent->now_update
1395} 1592 }
1396 1593
1397sub time() { 1594 sub time() {
1398 AnyEvent->time 1595 AnyEvent->time
1596 }
1597
1598 *postpone = \&AnyEvent::postpone;
1599 *log = \&AnyEvent::log;
1600 };
1601 die if $@;
1399} 1602}
1603
1604BEGIN { _reset }
1400 1605
1401package AnyEvent::Base; 1606package AnyEvent::Base;
1402 1607
1403# default implementations for many methods 1608# default implementations for many methods
1404 1609
1405sub time { 1610sub time {
1406 eval q{ # poor man's autoloading {} 1611 eval q{ # poor man's autoloading {}
1407 # probe for availability of Time::HiRes 1612 # probe for availability of Time::HiRes
1408 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1613 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1409 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1614 *time = sub { Time::HiRes::time () };
1410 *AE::time = \&Time::HiRes::time; 1615 *AE::time = \& Time::HiRes::time ;
1616 *now = \&time;
1617 AnyEvent::log 8 => "using Time::HiRes for sub-second timing accuracy.";
1411 # if (eval "use POSIX (); (POSIX::times())... 1618 # if (eval "use POSIX (); (POSIX::times())...
1412 } else { 1619 } else {
1413 warn "AnyEvent: using built-in time(), WARNING, no sub-second resolution!\n" if $VERBOSE; 1620 *time = sub { CORE::time };
1414 *AE::time = sub (){ time }; # epic fail 1621 *AE::time = sub (){ CORE::time };
1622 *now = \&time;
1623 AnyEvent::log 3 => "Using built-in time(), no sub-second resolution!";
1415 } 1624 }
1416
1417 *time = sub { AE::time }; # different prototypes
1418 }; 1625 };
1419 die if $@; 1626 die if $@;
1420 1627
1421 &time 1628 &time
1422} 1629}
1423 1630
1424*now = \&time; 1631*now = \&time;
1425
1426sub now_update { } 1632sub now_update { }
1427 1633
1634sub _poll {
1635 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught";
1636}
1637
1428# default implementation for ->condvar 1638# default implementation for ->condvar
1639# in fact, the default should not be overwritten
1429 1640
1430sub condvar { 1641sub condvar {
1431 eval q{ # poor man's autoloading {} 1642 eval q{ # poor man's autoloading {}
1432 *condvar = sub { 1643 *condvar = sub {
1433 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" 1644 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1511 1722
1512sub signal { 1723sub signal {
1513 eval q{ # poor man's autoloading {} 1724 eval q{ # poor man's autoloading {}
1514 # probe for availability of Async::Interrupt 1725 # probe for availability of Async::Interrupt
1515 if (_have_async_interrupt) { 1726 if (_have_async_interrupt) {
1516 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1727 AnyEvent::log 8 => "Using Async::Interrupt for race-free signal handling.";
1517 1728
1518 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1729 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1519 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec; 1730 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1520 1731
1521 } else { 1732 } else {
1522 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1733 AnyEvent::log 8 => "Using emulated perl signal handling with latency timer.";
1523 1734
1524 if (AnyEvent::WIN32) { 1735 if (AnyEvent::WIN32) {
1525 require AnyEvent::Util; 1736 require AnyEvent::Util;
1526 1737
1527 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); 1738 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1603 : sysread $SIGPIPE_R, (my $dummy), 9; 1814 : sysread $SIGPIPE_R, (my $dummy), 9;
1604 1815
1605 while (%SIG_EV) { 1816 while (%SIG_EV) {
1606 for (keys %SIG_EV) { 1817 for (keys %SIG_EV) {
1607 delete $SIG_EV{$_}; 1818 delete $SIG_EV{$_};
1608 $_->() for values %{ $SIG_CB{$_} || {} }; 1819 &$_ for values %{ $SIG_CB{$_} || {} };
1609 } 1820 }
1610 } 1821 }
1611 }; 1822 };
1612 }; 1823 };
1613 die if $@; 1824 die if $@;
1680 1891
1681 my ($cb, $w, $rcb) = $arg{cb}; 1892 my ($cb, $w, $rcb) = $arg{cb};
1682 1893
1683 $rcb = sub { 1894 $rcb = sub {
1684 if ($cb) { 1895 if ($cb) {
1685 $w = _time; 1896 $w = AE::time;
1686 &$cb; 1897 &$cb;
1687 $w = _time - $w; 1898 $w = AE::time - $w;
1688 1899
1689 # never use more then 50% of the time for the idle watcher, 1900 # never use more then 50% of the time for the idle watcher,
1690 # within some limits 1901 # within some limits
1691 $w = 0.0001 if $w < 0.0001; 1902 $w = 0.0001 if $w < 0.0001;
1692 $w = 5 if $w > 5; 1903 $w = 5 if $w > 5;
1740sub _send { 1951sub _send {
1741 # nop 1952 # nop
1742} 1953}
1743 1954
1744sub _wait { 1955sub _wait {
1745 Carp::croak "$AnyEvent::MODEL does not support blocking waits. Caught"; 1956 AnyEvent->_poll until $_[0]{_ae_sent};
1746} 1957}
1747 1958
1748sub send { 1959sub send {
1749 my $cv = shift; 1960 my $cv = shift;
1750 $cv->{_ae_sent} = [@_]; 1961 $cv->{_ae_sent} = [@_];
1762} 1973}
1763 1974
1764sub recv { 1975sub recv {
1765 unless ($_[0]{_ae_sent}) { 1976 unless ($_[0]{_ae_sent}) {
1766 $WAITING 1977 $WAITING
1767 and Carp::croak "AnyEvent::CondVar: recursive blocking wait detected"; 1978 and Carp::croak "AnyEvent::CondVar: recursive blocking wait attempted";
1768 1979
1769 local $WAITING = 1; 1980 local $WAITING = 1;
1770 $_[0]->_wait; 1981 $_[0]->_wait;
1771 } 1982 }
1772 1983
1821$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and 2032$Event/EV::DIED->() >>, L<Glib> uses C<< install_exception_handler >> and
1822so on. 2033so on.
1823 2034
1824=head1 ENVIRONMENT VARIABLES 2035=head1 ENVIRONMENT VARIABLES
1825 2036
1826The following environment variables are used by this module or its 2037AnyEvent supports a number of environment variables that tune the
1827submodules. 2038runtime behaviour. They are usually evaluated when AnyEvent is
2039loaded, initialised, or a submodule that uses them is loaded. Many of
2040them also cause AnyEvent to load additional modules - for example,
2041C<PERL_ANYEVENT_DEBUG_WRAP> causes the L<AnyEvent::Debug> module to be
2042loaded.
1828 2043
1829Note that AnyEvent will remove I<all> environment variables starting with 2044All the environment variables documented here start with
1830C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is 2045C<PERL_ANYEVENT_>, which is what AnyEvent considers its own
1831enabled. 2046namespace. Other modules are encouraged (but by no means required) to use
2047C<PERL_ANYEVENT_SUBMODULE> if they have registered the AnyEvent::Submodule
2048namespace on CPAN, for any submodule. For example, L<AnyEvent::HTTP> could
2049be expected to use C<PERL_ANYEVENT_HTTP_PROXY> (it should not access env
2050variables starting with C<AE_>, see below).
2051
2052All variables can also be set via the C<AE_> prefix, that is, instead
2053of setting C<PERL_ANYEVENT_VERBOSE> you can also set C<AE_VERBOSE>. In
2054case there is a clash btween anyevent and another program that uses
2055C<AE_something> you can set the corresponding C<PERL_ANYEVENT_something>
2056variable to the empty string, as those variables take precedence.
2057
2058When AnyEvent is first loaded, it copies all C<AE_xxx> env variables
2059to their C<PERL_ANYEVENT_xxx> counterpart unless that variable already
2060exists. If taint mode is on, then AnyEvent will remove I<all> environment
2061variables starting with C<PERL_ANYEVENT_> from C<%ENV> (or replace them
2062with C<undef> or the empty string, if the corresaponding C<AE_> variable
2063is set).
2064
2065The exact algorithm is currently:
2066
2067 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV
2068 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists
2069 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef.
2070
2071This ensures that child processes will not see the C<AE_> variables.
2072
2073The following environment variables are currently known to AnyEvent:
1832 2074
1833=over 4 2075=over 4
1834 2076
1835=item C<PERL_ANYEVENT_VERBOSE> 2077=item C<PERL_ANYEVENT_VERBOSE>
1836 2078
1837By default, AnyEvent will be completely silent except in fatal 2079By default, AnyEvent will log messages with loglevel C<4> (C<error>) or
1838conditions. You can set this environment variable to make AnyEvent more 2080higher (see L<AnyEvent::Log>). You can set this environment variable to a
1839talkative. 2081numerical loglevel to make AnyEvent more (or less) talkative.
1840 2082
2083If you want to do more than just set the global logging level
2084you should have a look at C<PERL_ANYEVENT_LOG>, which allows much more
2085complex specifications.
2086
2087When set to C<0> (C<off>), then no messages whatsoever will be logged with
2088everything else at defaults.
2089
1841When set to C<1> or higher, causes AnyEvent to warn about unexpected 2090When set to C<5> or higher (C<warn>), AnyEvent warns about unexpected
1842conditions, such as not being able to load the event model specified by 2091conditions, such as not being able to load the event model specified by
1843C<PERL_ANYEVENT_MODEL>. 2092C<PERL_ANYEVENT_MODEL>, or a guard callback throwing an exception - this
2093is the minimum recommended level for use during development.
1844 2094
1845When set to C<2> or higher, cause AnyEvent to report to STDERR which event 2095When set to C<7> or higher (info), AnyEvent reports which event model it
1846model it chooses. 2096chooses.
1847 2097
1848When set to C<8> or higher, then AnyEvent will report extra information on 2098When set to C<8> or higher (debug), then AnyEvent will report extra
1849which optional modules it loads and how it implements certain features. 2099information on which optional modules it loads and how it implements
2100certain features.
2101
2102=item C<PERL_ANYEVENT_LOG>
2103
2104Accepts rather complex logging specifications. For example, you could log
2105all C<debug> messages of some module to stderr, warnings and above to
2106stderr, and errors and above to syslog, with:
2107
2108 PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog
2109
2110For the rather extensive details, see L<AnyEvent::Log>.
2111
2112This variable is evaluated when AnyEvent (or L<AnyEvent::Log>) is loaded,
2113so will take effect even before AnyEvent has initialised itself.
2114
2115Note that specifying this environment variable causes the L<AnyEvent::Log>
2116module to be loaded, while C<PERL_ANYEVENT_VERBOSE> does not, so only
2117using the latter saves a few hundred kB of memory unless a module
2118explicitly needs the extra features of AnyEvent::Log.
1850 2119
1851=item C<PERL_ANYEVENT_STRICT> 2120=item C<PERL_ANYEVENT_STRICT>
1852 2121
1853AnyEvent does not do much argument checking by default, as thorough 2122AnyEvent does not do much argument checking by default, as thorough
1854argument checking is very costly. Setting this variable to a true value 2123argument checking is very costly. Setting this variable to a true value
1861Unlike C<use strict> (or its modern cousin, C<< use L<common::sense> 2130Unlike C<use strict> (or its modern cousin, C<< use L<common::sense>
1862>>, it is definitely recommended to keep it off in production. Keeping 2131>>, it is definitely recommended to keep it off in production. Keeping
1863C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs 2132C<PERL_ANYEVENT_STRICT=1> in your environment while developing programs
1864can be very useful, however. 2133can be very useful, however.
1865 2134
2135=item C<PERL_ANYEVENT_DEBUG_SHELL>
2136
2137If this env variable is nonempty, then its contents will be interpreted by
2138C<AnyEvent::Socket::parse_hostport> and C<AnyEvent::Debug::shell> (after
2139replacing every occurance of C<$$> by the process pid). The shell object
2140is saved in C<$AnyEvent::Debug::SHELL>.
2141
2142This happens when the first watcher is created.
2143
2144For example, to bind a debug shell on a unix domain socket in
2145F<< /tmp/debug<pid>.sock >>, you could use this:
2146
2147 PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog
2148 # connect with e.g.: socat readline /tmp/debug123.sock
2149
2150Or to bind to tcp port 4545 on localhost:
2151
2152 PERL_ANYEVENT_DEBUG_SHELL=127.0.0.1:4545 perlprog
2153 # connect with e.g.: telnet localhost 4545
2154
2155Note that creating sockets in F</tmp> or on localhost is very unsafe on
2156multiuser systems.
2157
2158=item C<PERL_ANYEVENT_DEBUG_WRAP>
2159
2160Can be set to C<0>, C<1> or C<2> and enables wrapping of all watchers for
2161debugging purposes. See C<AnyEvent::Debug::wrap> for details.
2162
1866=item C<PERL_ANYEVENT_MODEL> 2163=item C<PERL_ANYEVENT_MODEL>
1867 2164
1868This can be used to specify the event model to be used by AnyEvent, before 2165This can be used to specify the event model to be used by AnyEvent, before
1869auto detection and -probing kicks in. It must be a string consisting 2166auto detection and -probing kicks in.
1870entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 2167
2168It normally is a string consisting entirely of ASCII letters (e.g. C<EV>
2169or C<IOAsync>). The string C<AnyEvent::Impl::> gets prepended and the
1871and the resulting module name is loaded and if the load was successful, 2170resulting module name is loaded and - if the load was successful - used as
1872used as event model. If it fails to load AnyEvent will proceed with 2171event model backend. If it fails to load then AnyEvent will proceed with
1873auto detection and -probing. 2172auto detection and -probing.
1874 2173
1875This functionality might change in future versions. 2174If the string ends with C<::> instead (e.g. C<AnyEvent::Impl::EV::>) then
2175nothing gets prepended and the module name is used as-is (hint: C<::> at
2176the end of a string designates a module name and quotes it appropriately).
1876 2177
1877For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 2178For example, to force the pure perl model (L<AnyEvent::Loop::Perl>) you
1878could start your program like this: 2179could start your program like this:
1879 2180
1880 PERL_ANYEVENT_MODEL=Perl perl ... 2181 PERL_ANYEVENT_MODEL=Perl perl ...
2182
2183=item C<PERL_ANYEVENT_IO_MODEL>
2184
2185The current file I/O model - see L<AnyEvent::IO> for more info.
2186
2187At the moment, only C<Perl> (small, pure-perl, synchronous) and
2188C<IOAIO> (truly asynchronous) are supported. The default is C<IOAIO> if
2189L<AnyEvent::AIO> can be loaded, otherwise it is C<Perl>.
1881 2190
1882=item C<PERL_ANYEVENT_PROTOCOLS> 2191=item C<PERL_ANYEVENT_PROTOCOLS>
1883 2192
1884Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 2193Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1885for IPv4 or IPv6. The default is unspecified (and might change, or be the result 2194for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1898but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 2207but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1899- only support IPv4, never try to resolve or contact IPv6 2208- only support IPv4, never try to resolve or contact IPv6
1900addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 2209addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1901IPv6, but prefer IPv6 over IPv4. 2210IPv6, but prefer IPv6 over IPv4.
1902 2211
2212=item C<PERL_ANYEVENT_HOSTS>
2213
2214This variable, if specified, overrides the F</etc/hosts> file used by
2215L<AnyEvent::Socket>C<::resolve_sockaddr>, i.e. hosts aliases will be read
2216from that file instead.
2217
1903=item C<PERL_ANYEVENT_EDNS0> 2218=item C<PERL_ANYEVENT_EDNS0>
1904 2219
1905Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension 2220Used by L<AnyEvent::DNS> to decide whether to use the EDNS0 extension for
1906for DNS. This extension is generally useful to reduce DNS traffic, but 2221DNS. This extension is generally useful to reduce DNS traffic, especially
1907some (broken) firewalls drop such DNS packets, which is why it is off by 2222when DNSSEC is involved, but some (broken) firewalls drop such DNS
1908default. 2223packets, which is why it is off by default.
1909 2224
1910Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce 2225Setting this variable to C<1> will cause L<AnyEvent::DNS> to announce
1911EDNS0 in its DNS requests. 2226EDNS0 in its DNS requests.
1912 2227
1913=item C<PERL_ANYEVENT_MAX_FORKS> 2228=item C<PERL_ANYEVENT_MAX_FORKS>
1919 2234
1920The default value for the C<max_outstanding> parameter for the default DNS 2235The default value for the C<max_outstanding> parameter for the default DNS
1921resolver - this is the maximum number of parallel DNS requests that are 2236resolver - this is the maximum number of parallel DNS requests that are
1922sent to the DNS server. 2237sent to the DNS server.
1923 2238
2239=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2240
2241Perl has inherently racy signal handling (you can basically choose between
2242losing signals and memory corruption) - pure perl event loops (including
2243C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2244have to poll regularly to avoid losing signals.
2245
2246Some event loops are racy, but don't poll regularly, and some event loops
2247are written in C but are still racy. For those event loops, AnyEvent
2248installs a timer that regularly wakes up the event loop.
2249
2250By default, the interval for this timer is C<10> seconds, but you can
2251override this delay with this environment variable (or by setting
2252the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2253watchers).
2254
2255Lower values increase CPU (and energy) usage, higher values can introduce
2256long delays when reaping children or waiting for signals.
2257
2258The L<AnyEvent::Async> module, if available, will be used to avoid this
2259polling (with most event loops).
2260
1924=item C<PERL_ANYEVENT_RESOLV_CONF> 2261=item C<PERL_ANYEVENT_RESOLV_CONF>
1925 2262
1926The file to use instead of F</etc/resolv.conf> (or OS-specific 2263The absolute path to a F<resolv.conf>-style file to use instead of
1927configuration) in the default resolver. When set to the empty string, no 2264F</etc/resolv.conf> (or the OS-specific configuration) in the default
1928default config will be used. 2265resolver, or the empty string to select the default configuration.
1929 2266
1930=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. 2267=item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>.
1931 2268
1932When neither C<ca_file> nor C<ca_path> was specified during 2269When neither C<ca_file> nor C<ca_path> was specified during
1933L<AnyEvent::TLS> context creation, and either of these environment 2270L<AnyEvent::TLS> context creation, and either of these environment
1934variables exist, they will be used to specify CA certificate locations 2271variables are nonempty, they will be used to specify CA certificate
1935instead of a system-dependent default. 2272locations instead of a system-dependent default.
1936 2273
1937=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT> 2274=item C<PERL_ANYEVENT_AVOID_GUARD> and C<PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT>
1938 2275
1939When these are set to C<1>, then the respective modules are not 2276When these are set to C<1>, then the respective modules are not
1940loaded. Mostly good for testing AnyEvent itself. 2277loaded. Mostly good for testing AnyEvent itself.
2272(even when used without AnyEvent), but most event loops have acceptable 2609(even when used without AnyEvent), but most event loops have acceptable
2273performance with or without AnyEvent. 2610performance with or without AnyEvent.
2274 2611
2275=item * The overhead AnyEvent adds is usually much smaller than the overhead of 2612=item * The overhead AnyEvent adds is usually much smaller than the overhead of
2276the actual event loop, only with extremely fast event loops such as EV 2613the actual event loop, only with extremely fast event loops such as EV
2277adds AnyEvent significant overhead. 2614does AnyEvent add significant overhead.
2278 2615
2279=item * You should avoid POE like the plague if you want performance or 2616=item * You should avoid POE like the plague if you want performance or
2280reasonable memory usage. 2617reasonable memory usage.
2281 2618
2282=back 2619=back
2581 2918
2582=item L<Time::HiRes> 2919=item L<Time::HiRes>
2583 2920
2584This module is part of perl since release 5.008. It will be used when the 2921This module is part of perl since release 5.008. It will be used when the
2585chosen event library does not come with a timing source of its own. The 2922chosen event library does not come with a timing source of its own. The
2586pure-perl event loop (L<AnyEvent::Impl::Perl>) will additionally use it to 2923pure-perl event loop (L<AnyEvent::Loop>) will additionally load it to
2587try to use a monotonic clock for timing stability. 2924try to use a monotonic clock for timing stability.
2925
2926=item L<AnyEvent::AIO> (and L<IO::AIO>)
2927
2928The default implementation of L<AnyEvent::IO> is to do I/O synchronously,
2929stopping programs while they access the disk, which is fine for a lot of
2930programs.
2931
2932Installing AnyEvent::AIO (and its IO::AIO dependency) makes it switch to
2933a true asynchronous implementation, so event processing can continue even
2934while waiting for disk I/O.
2588 2935
2589=back 2936=back
2590 2937
2591 2938
2592=head1 FORK 2939=head1 FORK
2657 3004
2658Tutorial/Introduction: L<AnyEvent::Intro>. 3005Tutorial/Introduction: L<AnyEvent::Intro>.
2659 3006
2660FAQ: L<AnyEvent::FAQ>. 3007FAQ: L<AnyEvent::FAQ>.
2661 3008
2662Utility functions: L<AnyEvent::Util>. 3009Utility functions: L<AnyEvent::Util> (misc. grab-bag), L<AnyEvent::Log>
3010(simply logging).
2663 3011
2664Event modules: L<EV>, L<EV::Glib>, L<Glib::EV>, L<Event>, L<Glib::Event>, 3012Development/Debugging: L<AnyEvent::Strict> (stricter checking),
2665L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>. 3013L<AnyEvent::Debug> (interactive shell, watcher tracing).
3014
3015Supported event modules: L<AnyEvent::Loop>, L<EV>, L<EV::Glib>,
3016L<Glib::EV>, L<Event>, L<Glib::Event>, L<Glib>, L<Tk>, L<Event::Lib>,
3017L<Qt>, L<POE>, L<FLTK>.
2666 3018
2667Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>, 3019Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2668L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, 3020L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2669L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>, 3021L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2670L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>. 3022L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>, L<Anyevent::Impl::Irssi>,
3023L<AnyEvent::Impl::FLTK>.
2671 3024
2672Non-blocking file handles, sockets, TCP clients and 3025Non-blocking handles, pipes, stream sockets, TCP clients and
2673servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>. 3026servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
3027
3028Asynchronous File I/O: L<AnyEvent::IO>.
2674 3029
2675Asynchronous DNS: L<AnyEvent::DNS>. 3030Asynchronous DNS: L<AnyEvent::DNS>.
2676 3031
2677Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 3032Thread support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
2678 3033
2681 3036
2682 3037
2683=head1 AUTHOR 3038=head1 AUTHOR
2684 3039
2685 Marc Lehmann <schmorp@schmorp.de> 3040 Marc Lehmann <schmorp@schmorp.de>
2686 http://home.schmorp.de/ 3041 http://anyevent.schmorp.de
2687 3042
2688=cut 3043=cut
2689 3044
26901 30451
2691 3046

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines