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.279 by root, Sun Aug 9 16:05:11 2009 UTC vs.
Revision 1.300 by root, Tue Dec 1 17:56:28 2009 UTC

363might affect timers and time-outs. 363might affect timers and time-outs.
364 364
365When this is the case, you can call this method, which will update the 365When this is the case, you can call this method, which will update the
366event loop's idea of "current time". 366event loop's idea of "current time".
367 367
368A typical example would be a script in a web server (e.g. C<mod_perl>) -
369when mod_perl executes the script, then the event loop will have the wrong
370idea about the "current time" (being potentially far in the past, when the
371script ran the last time). In that case you should arrange a call to C<<
372AnyEvent->now_update >> each time the web server process wakes up again
373(e.g. at the start of your script, or in a handler).
374
368Note that updating the time I<might> cause some events to be handled. 375Note that updating the time I<might> cause some events to be handled.
369 376
370=back 377=back
371 378
372=head2 SIGNAL WATCHERS 379=head2 SIGNAL WATCHERS
395correctly. 402correctly.
396 403
397Example: exit on SIGINT 404Example: exit on SIGINT
398 405
399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 406 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
407
408=head3 Restart Behaviour
409
410While restart behaviour is up to the event loop implementation, most will
411not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
412pure perl implementation).
413
414=head3 Safe/Unsafe Signals
415
416Perl signals can be either "safe" (synchronous to opcode handling) or
417"unsafe" (asynchronous) - the former might get delayed indefinitely, the
418latter might corrupt your memory.
419
420AnyEvent signal handlers are, in addition, synchronous to the event loop,
421i.e. they will not interrupt your running perl program but will only be
422called as part of the normal event handling (just like timer, I/O etc.
423callbacks, too).
400 424
401=head3 Signal Races, Delays and Workarounds 425=head3 Signal Races, Delays and Workarounds
402 426
403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 427Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
404callbacks to signals in a generic way, which is a pity, as you cannot 428callbacks to signals in a generic way, which is a pity, as you cannot
592 after => 1, 616 after => 1,
593 cb => sub { $result_ready->send }, 617 cb => sub { $result_ready->send },
594 ); 618 );
595 619
596 # this "blocks" (while handling events) till the callback 620 # this "blocks" (while handling events) till the callback
597 # calls -<send 621 # calls ->send
598 $result_ready->recv; 622 $result_ready->recv;
599 623
600Example: wait for a timer, but take advantage of the fact that condition 624Example: wait for a timer, but take advantage of the fact that condition
601variables are also callable directly. 625variables are also callable directly.
602 626
666one. For example, a function that pings many hosts in parallel might want 690one. For example, a function that pings many hosts in parallel might want
667to use a condition variable for the whole process. 691to use a condition variable for the whole process.
668 692
669Every call to C<< ->begin >> will increment a counter, and every call to 693Every call to C<< ->begin >> will increment a counter, and every call to
670C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 694C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
671>>, the (last) callback passed to C<begin> will be executed. That callback 695>>, the (last) callback passed to C<begin> will be executed, passing the
672is I<supposed> to call C<< ->send >>, but that is not required. If no 696condvar as first argument. That callback is I<supposed> to call C<< ->send
673callback was set, C<send> will be called without any arguments. 697>>, but that is not required. If no group callback was set, C<send> will
698be called without any arguments.
674 699
675You can think of C<< $cv->send >> giving you an OR condition (one call 700You can think of C<< $cv->send >> giving you an OR condition (one call
676sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND 701sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
677condition (all C<begin> calls must be C<end>'ed before the condvar sends). 702condition (all C<begin> calls must be C<end>'ed before the condvar sends).
678 703
705begung can potentially be zero: 730begung can potentially be zero:
706 731
707 my $cv = AnyEvent->condvar; 732 my $cv = AnyEvent->condvar;
708 733
709 my %result; 734 my %result;
710 $cv->begin (sub { $cv->send (\%result) }); 735 $cv->begin (sub { shift->send (\%result) });
711 736
712 for my $host (@list_of_hosts) { 737 for my $host (@list_of_hosts) {
713 $cv->begin; 738 $cv->begin;
714 ping_host_then_call_callback $host, sub { 739 ping_host_then_call_callback $host, sub {
715 $result{$host} = ...; 740 $result{$host} = ...;
1105 1130
1106package AnyEvent; 1131package AnyEvent;
1107 1132
1108# basically a tuned-down version of common::sense 1133# basically a tuned-down version of common::sense
1109sub common_sense { 1134sub common_sense {
1110 # no warnings 1135 # from common:.sense 1.0
1111 ${^WARNING_BITS} ^= ${^WARNING_BITS}; 1136 ${^WARNING_BITS} = "\xfc\x3f\xf3\x00\x0f\xf3\xcf\xc0\xf3\xfc\x33\x03";
1112 # use strict vars subs 1137 # use strict vars subs
1113 $^H |= 0x00000600; 1138 $^H |= 0x00000600;
1114} 1139}
1115 1140
1116BEGIN { AnyEvent::common_sense } 1141BEGIN { AnyEvent::common_sense }
1117 1142
1118use Carp (); 1143use Carp ();
1119 1144
1120our $VERSION = '5.0'; 1145our $VERSION = '5.21';
1121our $MODEL; 1146our $MODEL;
1122 1147
1123our $AUTOLOAD; 1148our $AUTOLOAD;
1124our @ISA; 1149our @ISA;
1125 1150
1126our @REGISTRY; 1151our @REGISTRY;
1127
1128our $WIN32;
1129 1152
1130our $VERBOSE; 1153our $VERBOSE;
1131 1154
1132BEGIN { 1155BEGIN {
1133 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; 1156 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
1342 1365
1343package AnyEvent::Base; 1366package AnyEvent::Base;
1344 1367
1345# default implementations for many methods 1368# default implementations for many methods
1346 1369
1347sub _time { 1370sub _time() {
1348 # probe for availability of Time::HiRes 1371 # probe for availability of Time::HiRes
1349 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { 1372 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1350 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8; 1373 warn "AnyEvent: using Time::HiRes for sub-second timing accuracy.\n" if $VERBOSE >= 8;
1351 *_time = \&Time::HiRes::time; 1374 *_time = \&Time::HiRes::time;
1352 # if (eval "use POSIX (); (POSIX::times())... 1375 # if (eval "use POSIX (); (POSIX::times())...
1372 1395
1373our $HAVE_ASYNC_INTERRUPT; 1396our $HAVE_ASYNC_INTERRUPT;
1374 1397
1375sub _have_async_interrupt() { 1398sub _have_async_interrupt() {
1376 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT} 1399 $HAVE_ASYNC_INTERRUPT = 1*(!$ENV{PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT}
1377 && eval "use Async::Interrupt 1.0 (); 1") 1400 && eval "use Async::Interrupt 1.02 (); 1")
1378 unless defined $HAVE_ASYNC_INTERRUPT; 1401 unless defined $HAVE_ASYNC_INTERRUPT;
1379 1402
1380 $HAVE_ASYNC_INTERRUPT 1403 $HAVE_ASYNC_INTERRUPT
1381} 1404}
1382 1405
1385our ($SIG_COUNT, $SIG_TW); 1408our ($SIG_COUNT, $SIG_TW);
1386 1409
1387sub _signal_exec { 1410sub _signal_exec {
1388 $HAVE_ASYNC_INTERRUPT 1411 $HAVE_ASYNC_INTERRUPT
1389 ? $SIGPIPE_R->drain 1412 ? $SIGPIPE_R->drain
1390 : sysread $SIGPIPE_R, my $dummy, 9; 1413 : sysread $SIGPIPE_R, (my $dummy), 9;
1391 1414
1392 while (%SIG_EV) { 1415 while (%SIG_EV) {
1393 for (keys %SIG_EV) { 1416 for (keys %SIG_EV) {
1394 delete $SIG_EV{$_}; 1417 delete $SIG_EV{$_};
1395 $_->() for values %{ $SIG_CB{$_} || {} }; 1418 $_->() for values %{ $SIG_CB{$_} || {} };
1911 warn "read: $input\n"; # output what has been read 1934 warn "read: $input\n"; # output what has been read
1912 $cv->send if $input =~ /^q/i; # quit program if /^q/i 1935 $cv->send if $input =~ /^q/i; # quit program if /^q/i
1913 }, 1936 },
1914 ); 1937 );
1915 1938
1916 my $time_watcher; # can only be used once
1917
1918 sub new_timer {
1919 $timer = AnyEvent->timer (after => 1, cb => sub { 1939 my $time_watcher = AnyEvent->timer (after => 1, interval => 1, cb => sub {
1920 warn "timeout\n"; # print 'timeout' about every second 1940 warn "timeout\n"; # print 'timeout' at most every second
1921 &new_timer; # and restart the time
1922 }); 1941 });
1923 }
1924
1925 new_timer; # create first timer
1926 1942
1927 $cv->recv; # wait until user enters /^q/i 1943 $cv->recv; # wait until user enters /^q/i
1928 1944
1929=head1 REAL-WORLD EXAMPLE 1945=head1 REAL-WORLD EXAMPLE
1930 1946
2374As you can see, the AnyEvent + EV combination even beats the 2390As you can see, the AnyEvent + EV combination even beats the
2375hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl 2391hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2376backend easily beats IO::Lambda and POE. 2392backend easily beats IO::Lambda and POE.
2377 2393
2378And even the 100% non-blocking version written using the high-level (and 2394And even the 100% non-blocking version written using the high-level (and
2379slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a 2395slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda
2380large margin, even though it does all of DNS, tcp-connect and socket I/O 2396higher level ("unoptimised") abstractions by a large margin, even though
2381in a non-blocking way. 2397it does all of DNS, tcp-connect and socket I/O in a non-blocking way.
2382 2398
2383The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and 2399The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2384F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are 2400F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2385part of the IO::lambda distribution and were used without any changes. 2401part of the IO::Lambda distribution and were used without any changes.
2386 2402
2387 2403
2388=head1 SIGNALS 2404=head1 SIGNALS
2389 2405
2390AnyEvent currently installs handlers for these signals: 2406AnyEvent currently installs handlers for these signals:
2433 2449
2434That does not mean that AnyEvent won't take advantage of some additional 2450That does not mean that AnyEvent won't take advantage of some additional
2435modules if they are installed. 2451modules if they are installed.
2436 2452
2437This section epxlains which additional modules will be used, and how they 2453This section epxlains which additional modules will be used, and how they
2438affect AnyEvent's operetion. 2454affect AnyEvent's operation.
2439 2455
2440=over 4 2456=over 4
2441 2457
2442=item L<Async::Interrupt> 2458=item L<Async::Interrupt>
2443 2459
2448catch the signals) with some delay (default is 10 seconds, look for 2464catch the signals) with some delay (default is 10 seconds, look for
2449C<$AnyEvent::MAX_SIGNAL_LATENCY>). 2465C<$AnyEvent::MAX_SIGNAL_LATENCY>).
2450 2466
2451If this module is available, then it will be used to implement signal 2467If this module is available, then it will be used to implement signal
2452catching, which means that signals will not be delayed, and the event loop 2468catching, which means that signals will not be delayed, and the event loop
2453will not be interrupted regularly, which is more efficient (And good for 2469will not be interrupted regularly, which is more efficient (and good for
2454battery life on laptops). 2470battery life on laptops).
2455 2471
2456This affects not just the pure-perl event loop, but also other event loops 2472This affects not just the pure-perl event loop, but also other event loops
2457that have no signal handling on their own (e.g. Glib, Tk, Qt). 2473that have no signal handling on their own (e.g. Glib, Tk, Qt).
2458 2474
2479lot less memory), but otherwise doesn't affect guard operation much. It is 2495lot less memory), but otherwise doesn't affect guard operation much. It is
2480purely used for performance. 2496purely used for performance.
2481 2497
2482=item L<JSON> and L<JSON::XS> 2498=item L<JSON> and L<JSON::XS>
2483 2499
2484This module is required when you want to read or write JSON data via 2500One of these modules is required when you want to read or write JSON data
2485L<AnyEvent::Handle>. It is also written in pure-perl, but can take 2501via L<AnyEvent::Handle>. It is also written in pure-perl, but can take
2486advantage of the ultra-high-speed L<JSON::XS> module when it is installed. 2502advantage of the ultra-high-speed L<JSON::XS> module when it is installed.
2487 2503
2488In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is 2504In fact, L<AnyEvent::Handle> will use L<JSON::XS> by default if it is
2489installed. 2505installed.
2490 2506

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines