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.147 by root, Fri May 30 21:43:26 2008 UTC vs.
Revision 1.173 by root, Mon Jul 21 03:47:22 2008 UTC

1=head1 => NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 use AnyEvent; 9 use AnyEvent;
10 10
11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { 11 my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... });
12 ...
13 });
14 12
15 my $w = AnyEvent->timer (after => $seconds, cb => sub { 13 my $w = AnyEvent->timer (after => $seconds, cb => sub { ... });
14 my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ...
15
16 print AnyEvent->now; # prints current event loop time
17 print AnyEvent->time; # think Time::HiRes::time or simply CORE::time.
18
19 my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... });
20
21 my $w = AnyEvent->child (pid => $pid, cb => sub {
22 my ($pid, $status) = @_;
16 ... 23 ...
17 }); 24 });
18 25
19 my $w = AnyEvent->condvar; # stores whether a condition was flagged 26 my $w = AnyEvent->condvar; # stores whether a condition was flagged
20 $w->send; # wake up current and all future recv's 27 $w->send; # wake up current and all future recv's
21 $w->recv; # enters "main loop" till $condvar gets ->send 28 $w->recv; # enters "main loop" till $condvar gets ->send
29 # use a condvar in callback mode:
30 $w->cb (sub { $_[0]->recv });
31
32=head1 INTRODUCTION/TUTORIAL
33
34This manpage is mainly a reference manual. If you are interested
35in a tutorial or some gentle introduction, have a look at the
36L<AnyEvent::Intro> manpage.
22 37
23=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT) 38=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
24 39
25Glib, POE, IO::Async, Event... CPAN offers event models by the dozen 40Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
26nowadays. So what is different about AnyEvent? 41nowadays. So what is different about AnyEvent?
27 42
28Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of 43Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
29policy> and AnyEvent is I<small and efficient>. 44policy> and AnyEvent is I<small and efficient>.
30 45
31First and foremost, I<AnyEvent is not an event model> itself, it only 46First and foremost, I<AnyEvent is not an event model> itself, it only
32interfaces to whatever event model the main program happens to use in a 47interfaces to whatever event model the main program happens to use, in a
33pragmatic way. For event models and certain classes of immortals alike, 48pragmatic way. For event models and certain classes of immortals alike,
34the statement "there can only be one" is a bitter reality: In general, 49the statement "there can only be one" is a bitter reality: In general,
35only one event loop can be active at the same time in a process. AnyEvent 50only one event loop can be active at the same time in a process. AnyEvent
36helps hiding the differences between those event loops. 51cannot change this, but it can hide the differences between those event
52loops.
37 53
38The goal of AnyEvent is to offer module authors the ability to do event 54The goal of AnyEvent is to offer module authors the ability to do event
39programming (waiting for I/O or timer events) without subscribing to a 55programming (waiting for I/O or timer events) without subscribing to a
40religion, a way of living, and most importantly: without forcing your 56religion, a way of living, and most importantly: without forcing your
41module users into the same thing by forcing them to use the same event 57module users into the same thing by forcing them to use the same event
42model you use. 58model you use.
43 59
44For modules like POE or IO::Async (which is a total misnomer as it is 60For modules like POE or IO::Async (which is a total misnomer as it is
45actually doing all I/O I<synchronously>...), using them in your module is 61actually doing all I/O I<synchronously>...), using them in your module is
46like joining a cult: After you joined, you are dependent on them and you 62like joining a cult: After you joined, you are dependent on them and you
47cannot use anything else, as it is simply incompatible to everything that 63cannot use anything else, as they are simply incompatible to everything
48isn't itself. What's worse, all the potential users of your module are 64that isn't them. What's worse, all the potential users of your
49I<also> forced to use the same event loop you use. 65module are I<also> forced to use the same event loop you use.
50 66
51AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works 67AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
52fine. AnyEvent + Tk works fine etc. etc. but none of these work together 68fine. AnyEvent + Tk works fine etc. etc. but none of these work together
53with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if 69with the rest: POE + IO::Async? No go. Tk + Event? No go. Again: if
54your module uses one of those, every user of your module has to use it, 70your module uses one of those, every user of your module has to use it,
55too. But if your module uses AnyEvent, it works transparently with all 71too. But if your module uses AnyEvent, it works transparently with all
56event models it supports (including stuff like POE and IO::Async, as long 72event models it supports (including stuff like IO::Async, as long as those
57as those use one of the supported event loops. It is trivial to add new 73use one of the supported event loops. It is trivial to add new event loops
58event loops to AnyEvent, too, so it is future-proof). 74to AnyEvent, too, so it is future-proof).
59 75
60In addition to being free of having to use I<the one and only true event 76In addition to being free of having to use I<the one and only true event
61model>, AnyEvent also is free of bloat and policy: with POE or similar 77model>, AnyEvent also is free of bloat and policy: with POE or similar
62modules, you get an enormous amount of code and strict rules you have to 78modules, you get an enormous amount of code and strict rules you have to
63follow. AnyEvent, on the other hand, is lean and up to the point, by only 79follow. AnyEvent, on the other hand, is lean and up to the point, by only
132Many watchers either are used with "recursion" (repeating timers for 148Many watchers either are used with "recursion" (repeating timers for
133example), or need to refer to their watcher object in other ways. 149example), or need to refer to their watcher object in other ways.
134 150
135An any way to achieve that is this pattern: 151An any way to achieve that is this pattern:
136 152
137 my $w; $w = AnyEvent->type (arg => value ..., cb => sub { 153 my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
138 # you can use $w here, for example to undef it 154 # you can use $w here, for example to undef it
139 undef $w; 155 undef $w;
140 }); 156 });
141 157
142Note that C<my $w; $w => combination. This is necessary because in Perl, 158Note that C<my $w; $w => combination. This is necessary because in Perl,
143my variables are only visible after the statement in which they are 159my variables are only visible after the statement in which they are
144declared. 160declared.
145 161
146=head2 I/O WATCHERS 162=head2 I/O WATCHERS
147 163
148You can create an I/O watcher by calling the C<< AnyEvent->io >> method 164You can create an I/O watcher by calling the C<< AnyEvent->io >> method
149with the following mandatory key-value pairs as arguments: 165with the following mandatory key-value pairs as arguments:
150 166
151C<fh> the Perl I<file handle> (I<not> file descriptor) to watch 167C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events
152for events. C<poll> must be a string that is either C<r> or C<w>, 168(AnyEvent might or might not keep a reference to this file handle). C<poll>
153which creates a watcher waiting for "r"eadable or "w"ritable events, 169must be a string that is either C<r> or C<w>, which creates a watcher
154respectively. C<cb> is the callback to invoke each time the file handle 170waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the
155becomes ready. 171callback to invoke each time the file handle becomes ready.
156 172
157Although the callback might get passed parameters, their value and 173Although the callback might get passed parameters, their value and
158presence is undefined and you cannot rely on them. Portable AnyEvent 174presence is undefined and you cannot rely on them. Portable AnyEvent
159callbacks cannot use arguments passed to I/O watcher callbacks. 175callbacks cannot use arguments passed to I/O watcher callbacks.
160 176
164 180
165Some event loops issue spurious readyness notifications, so you should 181Some event loops issue spurious readyness notifications, so you should
166always use non-blocking calls when reading/writing from/to your file 182always use non-blocking calls when reading/writing from/to your file
167handles. 183handles.
168 184
169Example:
170
171 # wait for readability of STDIN, then read a line and disable the watcher 185Example: wait for readability of STDIN, then read a line and disable the
186watcher.
187
172 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { 188 my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
173 chomp (my $input = <STDIN>); 189 chomp (my $input = <STDIN>);
174 warn "read: $input\n"; 190 warn "read: $input\n";
175 undef $w; 191 undef $w;
176 }); 192 });
186 202
187Although the callback might get passed parameters, their value and 203Although the callback might get passed parameters, their value and
188presence is undefined and you cannot rely on them. Portable AnyEvent 204presence is undefined and you cannot rely on them. Portable AnyEvent
189callbacks cannot use arguments passed to time watcher callbacks. 205callbacks cannot use arguments passed to time watcher callbacks.
190 206
191The timer callback will be invoked at most once: if you want a repeating 207The callback will normally be invoked once only. If you specify another
192timer you have to create a new watcher (this is a limitation by both Tk 208parameter, C<interval>, as a strictly positive number (> 0), then the
193and Glib). 209callback will be invoked regularly at that interval (in fractional
210seconds) after the first invocation. If C<interval> is specified with a
211false value, then it is treated as if it were missing.
194 212
195Example: 213The callback will be rescheduled before invoking the callback, but no
214attempt is done to avoid timer drift in most backends, so the interval is
215only approximate.
196 216
197 # fire an event after 7.7 seconds 217Example: fire an event after 7.7 seconds.
218
198 my $w = AnyEvent->timer (after => 7.7, cb => sub { 219 my $w = AnyEvent->timer (after => 7.7, cb => sub {
199 warn "timeout\n"; 220 warn "timeout\n";
200 }); 221 });
201 222
202 # to cancel the timer: 223 # to cancel the timer:
203 undef $w; 224 undef $w;
204 225
205Example 2:
206
207 # fire an event after 0.5 seconds, then roughly every second 226Example 2: fire an event after 0.5 seconds, then roughly every second.
208 my $w;
209 227
210 my $cb = sub {
211 # cancel the old timer while creating a new one
212 $w = AnyEvent->timer (after => 1, cb => $cb); 228 my $w = AnyEvent->timer (after => 0.5, interval => 1, cb => sub {
229 warn "timeout\n";
213 }; 230 };
214
215 # start the "loop" by creating the first watcher
216 $w = AnyEvent->timer (after => 0.5, cb => $cb);
217 231
218=head3 TIMING ISSUES 232=head3 TIMING ISSUES
219 233
220There are two ways to handle timers: based on real time (relative, "fire 234There are two ways to handle timers: based on real time (relative, "fire
221in 10 seconds") and based on wallclock time (absolute, "fire at 12 235in 10 seconds") and based on wallclock time (absolute, "fire at 12
299=back 313=back
300 314
301=head2 SIGNAL WATCHERS 315=head2 SIGNAL WATCHERS
302 316
303You can watch for signals using a signal watcher, C<signal> is the signal 317You can watch for signals using a signal watcher, C<signal> is the signal
304I<name> without any C<SIG> prefix, C<cb> is the Perl callback to 318I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
305be invoked whenever a signal occurs. 319callback to be invoked whenever a signal occurs.
306 320
307Although the callback might get passed parameters, their value and 321Although the callback might get passed parameters, their value and
308presence is undefined and you cannot rely on them. Portable AnyEvent 322presence is undefined and you cannot rely on them. Portable AnyEvent
309callbacks cannot use arguments passed to signal watcher callbacks. 323callbacks cannot use arguments passed to signal watcher callbacks.
310 324
346AnyEvent program, you I<have> to create at least one watcher before you 360AnyEvent program, you I<have> to create at least one watcher before you
347C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 361C<fork> the child (alternatively, you can call C<AnyEvent::detect>).
348 362
349Example: fork a process and wait for it 363Example: fork a process and wait for it
350 364
351 my $done = AnyEvent->condvar; 365 my $done = AnyEvent->condvar;
352 366
353 my $pid = fork or exit 5; 367 my $pid = fork or exit 5;
354 368
355 my $w = AnyEvent->child ( 369 my $w = AnyEvent->child (
356 pid => $pid, 370 pid => $pid,
357 cb => sub { 371 cb => sub {
358 my ($pid, $status) = @_; 372 my ($pid, $status) = @_;
359 warn "pid $pid exited with status $status"; 373 warn "pid $pid exited with status $status";
360 $done->send; 374 $done->send;
361 }, 375 },
362 ); 376 );
363 377
364 # do something else, then wait for process exit 378 # do something else, then wait for process exit
365 $done->recv; 379 $done->recv;
366 380
367=head2 CONDITION VARIABLES 381=head2 CONDITION VARIABLES
368 382
369If you are familiar with some event loops you will know that all of them 383If you are familiar with some event loops you will know that all of them
370require you to run some blocking "loop", "run" or similar function that 384require you to run some blocking "loop", "run" or similar function that
375 389
376The instrument to do that is called a "condition variable", so called 390The instrument to do that is called a "condition variable", so called
377because they represent a condition that must become true. 391because they represent a condition that must become true.
378 392
379Condition variables can be created by calling the C<< AnyEvent->condvar 393Condition variables can be created by calling the C<< AnyEvent->condvar
394
380>> method, usually without arguments. The only argument pair allowed is 395>> method, usually without arguments. The only argument pair allowed is
396
381C<cb>, which specifies a callback to be called when the condition variable 397C<cb>, which specifies a callback to be called when the condition variable
382becomes true. 398becomes true, with the condition variable as the first argument (but not
399the results).
383 400
384After creation, the condition variable is "false" until it becomes "true" 401After creation, the condition variable is "false" until it becomes "true"
385by calling the C<send> method (or calling the condition variable as if it 402by calling the C<send> method (or calling the condition variable as if it
386were a callback, read about the caveats in the description for the C<< 403were a callback, read about the caveats in the description for the C<<
387->send >> method). 404->send >> method).
443 460
444 my $done = AnyEvent->condvar; 461 my $done = AnyEvent->condvar;
445 my $delay = AnyEvent->timer (after => 5, cb => $done); 462 my $delay = AnyEvent->timer (after => 5, cb => $done);
446 $done->recv; 463 $done->recv;
447 464
465Example: Imagine an API that returns a condvar and doesn't support
466callbacks. This is how you make a synchronous call, for example from
467the main program:
468
469 use AnyEvent::CouchDB;
470
471 ...
472
473 my @info = $couchdb->info->recv;
474
475And this is how you would just ste a callback to be called whenever the
476results are available:
477
478 $couchdb->info->cb (sub {
479 my @info = $_[0]->recv;
480 });
481
448=head3 METHODS FOR PRODUCERS 482=head3 METHODS FOR PRODUCERS
449 483
450These methods should only be used by the producing side, i.e. the 484These methods should only be used by the producing side, i.e. the
451code/module that eventually sends the signal. Note that it is also 485code/module that eventually sends the signal. Note that it is also
452the producer side which creates the condvar in most cases, but it isn't 486the producer side which creates the condvar in most cases, but it isn't
585=item $bool = $cv->ready 619=item $bool = $cv->ready
586 620
587Returns true when the condition is "true", i.e. whether C<send> or 621Returns true when the condition is "true", i.e. whether C<send> or
588C<croak> have been called. 622C<croak> have been called.
589 623
590=item $cb = $cv->cb ([new callback]) 624=item $cb = $cv->cb ($cb->($cv))
591 625
592This is a mutator function that returns the callback set and optionally 626This is a mutator function that returns the callback set and optionally
593replaces it before doing so. 627replaces it before doing so.
594 628
595The callback will be called when the condition becomes "true", i.e. when 629The callback will be called when the condition becomes "true", i.e. when
596C<send> or C<croak> are called. Calling C<recv> inside the callback 630C<send> or C<croak> are called, with the only argument being the condition
597or at any later time is guaranteed not to block. 631variable itself. Calling C<recv> inside the callback or at any later time
632is guaranteed not to block.
598 633
599=back 634=back
600 635
601=head1 GLOBAL VARIABLES AND FUNCTIONS 636=head1 GLOBAL VARIABLES AND FUNCTIONS
602 637
731=item L<AnyEvent::Util> 766=item L<AnyEvent::Util>
732 767
733Contains various utility functions that replace often-used but blocking 768Contains various utility functions that replace often-used but blocking
734functions such as C<inet_aton> by event-/callback-based versions. 769functions such as C<inet_aton> by event-/callback-based versions.
735 770
736=item L<AnyEvent::Handle>
737
738Provide read and write buffers and manages watchers for reads and writes.
739
740=item L<AnyEvent::Socket> 771=item L<AnyEvent::Socket>
741 772
742Provides various utility functions for (internet protocol) sockets, 773Provides various utility functions for (internet protocol) sockets,
743addresses and name resolution. Also functions to create non-blocking tcp 774addresses and name resolution. Also functions to create non-blocking tcp
744connections or tcp servers, with IPv6 and SRV record support and more. 775connections or tcp servers, with IPv6 and SRV record support and more.
745 776
777=item L<AnyEvent::Handle>
778
779Provide read and write buffers, manages watchers for reads and writes,
780supports raw and formatted I/O, I/O queued and fully transparent and
781non-blocking SSL/TLS.
782
746=item L<AnyEvent::DNS> 783=item L<AnyEvent::DNS>
747 784
748Provides rich asynchronous DNS resolver capabilities. 785Provides rich asynchronous DNS resolver capabilities.
749 786
787=item L<AnyEvent::HTTP>
788
789A simple-to-use HTTP library that is capable of making a lot of concurrent
790HTTP requests.
791
750=item L<AnyEvent::HTTPD> 792=item L<AnyEvent::HTTPD>
751 793
752Provides a simple web application server framework. 794Provides a simple web application server framework.
753 795
754=item L<AnyEvent::FastPing> 796=item L<AnyEvent::FastPing>
755 797
756The fastest ping in the west. 798The fastest ping in the west.
799
800=item L<AnyEvent::DBI>
801
802Executes L<DBI> requests asynchronously in a proxy process.
803
804=item L<AnyEvent::AIO>
805
806Truly asynchronous I/O, should be in the toolbox of every event
807programmer. AnyEvent::AIO transparently fuses L<IO::AIO> and AnyEvent
808together.
809
810=item L<AnyEvent::BDB>
811
812Truly asynchronous Berkeley DB access. AnyEvent::BDB transparently fuses
813L<BDB> and AnyEvent together.
814
815=item L<AnyEvent::GPSD>
816
817A non-blocking interface to gpsd, a daemon delivering GPS information.
818
819=item L<AnyEvent::IGS>
820
821A non-blocking interface to the Internet Go Server protocol (used by
822L<App::IGS>).
757 823
758=item L<Net::IRC3> 824=item L<Net::IRC3>
759 825
760AnyEvent based IRC client module family. 826AnyEvent based IRC client module family.
761 827
774 840
775=item L<Coro> 841=item L<Coro>
776 842
777Has special support for AnyEvent via L<Coro::AnyEvent>. 843Has special support for AnyEvent via L<Coro::AnyEvent>.
778 844
779=item L<AnyEvent::AIO>, L<IO::AIO>
780
781Truly asynchronous I/O, should be in the toolbox of every event
782programmer. AnyEvent::AIO transparently fuses IO::AIO and AnyEvent
783together.
784
785=item L<AnyEvent::BDB>, L<BDB>
786
787Truly asynchronous Berkeley DB access. AnyEvent::AIO transparently fuses
788IO::AIO and AnyEvent together.
789
790=item L<IO::Lambda> 845=item L<IO::Lambda>
791 846
792The lambda approach to I/O - don't ask, look there. Can use AnyEvent. 847The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
793 848
794=back 849=back
800no warnings; 855no warnings;
801use strict; 856use strict;
802 857
803use Carp; 858use Carp;
804 859
805our $VERSION = 4.11; 860our $VERSION = 4.22;
806our $MODEL; 861our $MODEL;
807 862
808our $AUTOLOAD; 863our $AUTOLOAD;
809our @ISA; 864our @ISA;
810 865
913 $MODEL 968 $MODEL
914 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 969 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.";
915 } 970 }
916 } 971 }
917 972
973 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
974
918 unshift @ISA, $MODEL; 975 unshift @ISA, $MODEL;
919 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 976
977 require AnyEvent::Strict if $ENV{PERL_ANYEVENT_STRICT};
920 978
921 (shift @post_detect)->() while @post_detect; 979 (shift @post_detect)->() while @post_detect;
922 } 980 }
923 981
924 $MODEL 982 $MODEL
932 990
933 detect unless $MODEL; 991 detect unless $MODEL;
934 992
935 my $class = shift; 993 my $class = shift;
936 $class->$func (@_); 994 $class->$func (@_);
995}
996
997# utility function to dup a filehandle. this is used by many backends
998# to support binding more than one watcher per filehandle (they usually
999# allow only one watcher per fd, so we dup it to get a different one).
1000sub _dupfh($$$$) {
1001 my ($poll, $fh, $r, $w) = @_;
1002
1003 require Fcntl;
1004
1005 # cygwin requires the fh mode to be matching, unix doesn't
1006 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1007 : $poll eq "w" ? ($w, ">")
1008 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1009
1010 open my $fh2, "$mode&" . fileno $fh
1011 or die "cannot dup() filehandle: $!";
1012
1013 # we assume CLOEXEC is already set by perl in all important cases
1014
1015 ($fh2, $rw)
937} 1016}
938 1017
939package AnyEvent::Base; 1018package AnyEvent::Base;
940 1019
941# default implementation for now and time 1020# default implementation for now and time
972sub AnyEvent::Base::Signal::DESTROY { 1051sub AnyEvent::Base::Signal::DESTROY {
973 my ($signal, $cb) = @{$_[0]}; 1052 my ($signal, $cb) = @{$_[0]};
974 1053
975 delete $SIG_CB{$signal}{$cb}; 1054 delete $SIG_CB{$signal}{$cb};
976 1055
977 $SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} }; 1056 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
978} 1057}
979 1058
980# default implementation for ->child 1059# default implementation for ->child
981 1060
982our %PID_CB; 1061our %PID_CB;
1152C<PERL_ANYEVENT_MODEL>. 1231C<PERL_ANYEVENT_MODEL>.
1153 1232
1154When set to C<2> or higher, cause AnyEvent to report to STDERR which event 1233When set to C<2> or higher, cause AnyEvent to report to STDERR which event
1155model it chooses. 1234model it chooses.
1156 1235
1236=item C<PERL_ANYEVENT_STRICT>
1237
1238AnyEvent does not do much argument checking by default, as thorough
1239argument checking is very costly. Setting this variable to a true value
1240will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1241check the arguments passed to most method calls. If it finds any problems
1242it will croak.
1243
1244In other words, enables "strict" mode.
1245
1246Unlike C<use strict> it is definitely recommended ot keep it off in
1247production.
1248
1157=item C<PERL_ANYEVENT_MODEL> 1249=item C<PERL_ANYEVENT_MODEL>
1158 1250
1159This can be used to specify the event model to be used by AnyEvent, before 1251This can be used to specify the event model to be used by AnyEvent, before
1160auto detection and -probing kicks in. It must be a string consisting 1252auto detection and -probing kicks in. It must be a string consisting
1161entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended 1253entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
1166This functionality might change in future versions. 1258This functionality might change in future versions.
1167 1259
1168For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you 1260For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
1169could start your program like this: 1261could start your program like this:
1170 1262
1171 PERL_ANYEVENT_MODEL=Perl perl ... 1263 PERL_ANYEVENT_MODEL=Perl perl ...
1172 1264
1173=item C<PERL_ANYEVENT_PROTOCOLS> 1265=item C<PERL_ANYEVENT_PROTOCOLS>
1174 1266
1175Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences 1267Used by both L<AnyEvent::DNS> and L<AnyEvent::Socket> to determine preferences
1176for IPv4 or IPv6. The default is unspecified (and might change, or be the result 1268for IPv4 or IPv6. The default is unspecified (and might change, or be the result
1651specified in the variable. 1743specified in the variable.
1652 1744
1653You can make AnyEvent completely ignore this variable by deleting it 1745You can make AnyEvent completely ignore this variable by deleting it
1654before the first watcher gets created, e.g. with a C<BEGIN> block: 1746before the first watcher gets created, e.g. with a C<BEGIN> block:
1655 1747
1656 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} } 1748 BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
1657 1749
1658 use AnyEvent; 1750 use AnyEvent;
1659 1751
1660Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 1752Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1661be used to probe what backend is used and gain other information (which is 1753be used to probe what backend is used and gain other information (which is
1662probably even less useful to an attacker than PERL_ANYEVENT_MODEL). 1754probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1755$ENV{PERL_ANYEGENT_STRICT}.
1756
1757
1758=head1 BUGS
1759
1760Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1761to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1762and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1763mamleaks, such as leaking on C<map> and C<grep> but it is usually not as
1764pronounced).
1663 1765
1664 1766
1665=head1 SEE ALSO 1767=head1 SEE ALSO
1666 1768
1667Utility functions: L<AnyEvent::Util>. 1769Utility functions: L<AnyEvent::Util>.
1684Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>. 1786Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.
1685 1787
1686 1788
1687=head1 AUTHOR 1789=head1 AUTHOR
1688 1790
1689 Marc Lehmann <schmorp@schmorp.de> 1791 Marc Lehmann <schmorp@schmorp.de>
1690 http://home.schmorp.de/ 1792 http://home.schmorp.de/
1691 1793
1692=cut 1794=cut
1693 1795
16941 17961
1695 1797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines