ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/EV.pm
(Generate patch)

Comparing EV/EV.pm (file contents):
Revision 1.150 by root, Thu Aug 30 21:52:02 2018 UTC vs.
Revision 1.157 by root, Thu Jun 27 07:40:49 2019 UTC

119package EV; 119package EV;
120 120
121use common::sense; 121use common::sense;
122 122
123BEGIN { 123BEGIN {
124 our $VERSION = 4.22; 124 our $VERSION = 4.27;
125 use XSLoader; 125 use XSLoader;
126 local $^W = 0; # avoid spurious warning 126 local $^W = 0; # avoid spurious warning
127 XSLoader::load "EV", $VERSION; 127 XSLoader::load "EV", $VERSION;
128} 128}
129 129
248 248
249=item $loop->now_update 249=item $loop->now_update
250 250
251Establishes the current time by querying the kernel, updating the time 251Establishes the current time by querying the kernel, updating the time
252returned by C<EV::now> in the progress. This is a costly operation and 252returned by C<EV::now> in the progress. This is a costly operation and
253is usually done automatically within C<EV::loop>. 253is usually done automatically within C<EV::run>.
254 254
255This function is rarely useful, but when some event callback runs for a 255This function is rarely useful, but when some event callback runs for a
256very long time without entering the event loop, updating libev's idea of 256very long time without entering the event loop, updating libev's idea of
257the current time is a good idea. 257the current time is a good idea.
258 258
313=item EV::break [$how] 313=item EV::break [$how]
314 314
315=item $loop->break ([$how]) 315=item $loop->break ([$how])
316 316
317When called with no arguments or an argument of EV::BREAK_ONE, makes the 317When called with no arguments or an argument of EV::BREAK_ONE, makes the
318innermost call to EV::loop return. 318innermost call to EV::run return.
319 319
320When called with an argument of EV::BREAK_ALL, all calls to EV::loop will 320When called with an argument of EV::BREAK_ALL, all calls to EV::run will
321return as fast as possible. 321return as fast as possible.
322 322
323When called with an argument of EV::BREAK_CANCEL, any pending break will 323When called with an argument of EV::BREAK_CANCEL, any pending break will
324be cancelled. 324be cancelled.
325 325
342| EV::WRITE>, indicating the type of I/O event you want to wait for. If 342| EV::WRITE>, indicating the type of I/O event you want to wait for. If
343you do not want to wait for some I/O event, specify C<undef> for 343you do not want to wait for some I/O event, specify C<undef> for
344C<$fh_or_undef> and C<0> for C<$events>). 344C<$fh_or_undef> and C<0> for C<$events>).
345 345
346If timeout is C<undef> or negative, then there will be no 346If timeout is C<undef> or negative, then there will be no
347timeout. Otherwise a EV::timer with this value will be started. 347timeout. Otherwise an C<EV::timer> with this value will be started.
348 348
349When an error occurs or either the timeout or I/O watcher triggers, then 349When an error occurs or either the timeout or I/O watcher triggers, then
350the callback will be called with the received event set (in general 350the callback will be called with the received event set (in general
351you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, 351you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
352C<EV::WRITE> and C<EV::TIMER>). 352C<EV::WRITE> and C<EV::TIMER>).
507returns its C<$revents> bitset (as if its callback was invoked). If the 507returns its C<$revents> bitset (as if its callback was invoked). If the
508watcher isn't pending it does nothing and returns C<0>. 508watcher isn't pending it does nothing and returns C<0>.
509 509
510=item $previous_state = $w->keepalive ($bool) 510=item $previous_state = $w->keepalive ($bool)
511 511
512Normally, C<EV::loop> will return when there are no active watchers 512Normally, C<EV::run> will return when there are no active watchers
513(which is a "deadlock" because no progress can be made anymore). This is 513(which is a "deadlock" because no progress can be made anymore). This is
514convenient because it allows you to start your watchers (and your jobs), 514convenient because it allows you to start your watchers (and your jobs),
515call C<EV::loop> once and when it returns you know that all your jobs are 515call C<EV::run> once and when it returns you know that all your jobs are
516finished (or they forgot to register some watchers for their task :). 516finished (or they forgot to register some watchers for their task :).
517 517
518Sometimes, however, this gets in your way, for example when the module 518Sometimes, however, this gets in your way, for example when the module
519that calls C<EV::loop> (usually the main program) is not the same module 519that calls C<EV::run> (usually the main program) is not the same module
520as a long-living watcher (for example a DNS client module written by 520as a long-living watcher (for example a DNS client module written by
521somebody else even). Then you might want any outstanding requests to be 521somebody else even). Then you might want any outstanding requests to be
522handled, but you would not want to keep C<EV::loop> from returning just 522handled, but you would not want to keep C<EV::run> from returning just
523because you happen to have this long-running UDP port watcher. 523because you happen to have this long-running UDP port watcher.
524 524
525In this case you can clear the keepalive status, which means that even 525In this case you can clear the keepalive status, which means that even
526though your watcher is active, it won't keep C<EV::loop> from returning. 526though your watcher is active, it won't keep C<EV::run> from returning.
527 527
528The initial value for keepalive is true (enabled), and you can change it 528The initial value for keepalive is true (enabled), and you can change it
529any time. 529any time.
530 530
531Example: Register an I/O watcher for some UDP socket but do not keep the 531Example: Register an I/O watcher for some UDP socket but do not keep the
682surpasses this time. 682surpasses this time.
683 683
684=item * repeating interval timer ($interval > 0, $reschedule_cb = 0) 684=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
685 685
686In this mode the watcher will always be scheduled to time out at the 686In this mode the watcher will always be scheduled to time out at the
687next C<$at + N * $interval> time (for some integer N) and then repeat, 687next C<$at + N * $interval> time (for the lowest integer N) and then repeat,
688regardless of any time jumps. 688regardless of any time jumps. Note that, since C<N> can be negative, the
689first trigger can happen before C<$at>.
689 690
690This can be used to create timers that do not drift with respect to system 691This can be used to create timers that do not drift with respect to system
691time: 692time:
692 693
693 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 694 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
709time as second argument. 710time as second argument.
710 711
711I<This callback MUST NOT stop or destroy this or any other periodic 712I<This callback MUST NOT stop or destroy this or any other periodic
712watcher, ever, and MUST NOT call any event loop functions or methods>. If 713watcher, ever, and MUST NOT call any event loop functions or methods>. If
713you need to stop it, return 1e30 and stop it afterwards. You may create 714you need to stop it, return 1e30 and stop it afterwards. You may create
714and start a C<EV::prepare> watcher for this task. 715and start an C<EV::prepare> watcher for this task.
715 716
716It must return the next time to trigger, based on the passed time value 717It must return the next time to trigger, based on the passed time value
717(that is, the lowest time value larger than or equal to to the second 718(that is, the lowest time value larger than or equal to to the second
718argument). It will usually be called just before the callback will be 719argument). It will usually be called just before the callback will be
719triggered, but might be called at other times, too. 720triggered, but might be called at other times, too.
720 721
721This can be used to create very complex timers, such as a timer that 722This can be used to create very complex timers, such as a timer that
722triggers on each midnight, local time (actually 24 hours after the last 723triggers on each midnight, local time (actually one day after the last
723midnight, to keep the example simple. If you know a way to do it correctly 724midnight, to keep the example simple):
724in about the same space (without requiring elaborate modules), drop me a
725note :):
726 725
727 my $daily = EV::periodic 0, 0, sub { 726 my $daily = EV::periodic 0, 0, sub {
728 my ($w, $now) = @_; 727 my ($w, $now) = @_;
729 728
730 use Time::Local (); 729 use Time::Local ();
731 my (undef, undef, undef, $d, $m, $y) = localtime $now; 730 my (undef, undef, undef, $d, $m, $y) = localtime $now;
732 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y 731 Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y
733 }, sub { 732 }, sub {
734 print "it's midnight or likely shortly after, now\n"; 733 print "it's midnight or likely shortly after, now\n";
735 }; 734 };
736 735
737=back 736=back

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines