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

Comparing EV/README (file contents):
Revision 1.44 by root, Mon Jul 13 19:47:53 2015 UTC vs.
Revision 1.45 by root, Fri Dec 21 07:06:51 2018 UTC

236 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). 236 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL).
237 237
238 $active = EV::run [$flags] 238 $active = EV::run [$flags]
239 $active = $loop->run ([$flags]) 239 $active = $loop->run ([$flags])
240 Begin checking for events and calling callbacks. It returns when a 240 Begin checking for events and calling callbacks. It returns when a
241 callback calls EV::break or the flasg are nonzero (in which case the 241 callback calls EV::break or the flags are nonzero (in which case the
242 return value is true) or when there are no active watchers which 242 return value is true) or when there are no active watchers which
243 reference the loop (keepalive is true), in which case the return 243 reference the loop (keepalive is true), in which case the return
244 value will be false. The returnv alue can generally be interpreted 244 value will be false. The return value can generally be interpreted
245 as "if true, there is more work left to do". 245 as "if true, there is more work left to do".
246 246
247 The $flags argument can be one of the following: 247 The $flags argument can be one of the following:
248 248
249 0 as above 249 0 as above
276 "EV::READ | EV::WRITE", indicating the type of I/O event you want to 276 "EV::READ | EV::WRITE", indicating the type of I/O event you want to
277 wait for. If you do not want to wait for some I/O event, specify 277 wait for. If you do not want to wait for some I/O event, specify
278 "undef" for $fh_or_undef and 0 for $events). 278 "undef" for $fh_or_undef and 0 for $events).
279 279
280 If timeout is "undef" or negative, then there will be no timeout. 280 If timeout is "undef" or negative, then there will be no timeout.
281 Otherwise a EV::timer with this value will be started. 281 Otherwise an "EV::timer" with this value will be started.
282 282
283 When an error occurs or either the timeout or I/O watcher triggers, 283 When an error occurs or either the timeout or I/O watcher triggers,
284 then the callback will be called with the received event set (in 284 then the callback will be called with the received event set (in
285 general you can expect it to be a combination of "EV::ERROR", 285 general you can expect it to be a combination of "EV::ERROR",
286 "EV::READ", "EV::WRITE" and "EV::TIMER"). 286 "EV::READ", "EV::WRITE" and "EV::TIMER").
482 TIMER WATCHERS - relative and optionally repeating timeouts 482 TIMER WATCHERS - relative and optionally repeating timeouts
483 $w = EV::timer $after, $repeat, $callback 483 $w = EV::timer $after, $repeat, $callback
484 $w = EV::timer_ns $after, $repeat, $callback 484 $w = EV::timer_ns $after, $repeat, $callback
485 $w = $loop->timer ($after, $repeat, $callback) 485 $w = $loop->timer ($after, $repeat, $callback)
486 $w = $loop->timer_ns ($after, $repeat, $callback) 486 $w = $loop->timer_ns ($after, $repeat, $callback)
487 Calls the callback after $after seconds (which may be fractional). 487 Calls the callback after $after seconds (which may be fractional or
488 If $repeat is non-zero, the timer will be restarted (with the 488 negative). If $repeat is non-zero, the timer will be restarted (with
489 $repeat value as $after) after the callback returns. 489 the $repeat value as $after) after the callback returns.
490 490
491 This means that the callback would be called roughly after $after 491 This means that the callback would be called roughly after $after
492 seconds, and then every $repeat seconds. The timer does his best not 492 seconds, and then every $repeat seconds. The timer does his best not
493 to drift, but it will not invoke the timer more often then once per 493 to drift, but it will not invoke the timer more often then once per
494 event loop iteration, and might drift in other cases. If that isn't 494 event loop iteration, and might drift in other cases. If that isn't
556 system time reaches or surpasses this time. 556 system time reaches or surpasses this time.
557 557
558 * repeating interval timer ($interval > 0, $reschedule_cb = 0) 558 * repeating interval timer ($interval > 0, $reschedule_cb = 0)
559 559
560 In this mode the watcher will always be scheduled to time out at 560 In this mode the watcher will always be scheduled to time out at
561 the next "$at + N * $interval" time (for some integer N) and 561 the next "$at + N * $interval" time (for the lowest integer N)
562 then repeat, regardless of any time jumps. 562 and then repeat, regardless of any time jumps. Note that, since
563 "N" can be negative, the first trigger can happen before $at.
563 564
564 This can be used to create timers that do not drift with respect 565 This can be used to create timers that do not drift with respect
565 to system time: 566 to system time:
566 567
567 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 568 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
583 first, and the current time as second argument. 584 first, and the current time as second argument.
584 585
585 *This callback MUST NOT stop or destroy this or any other 586 *This callback MUST NOT stop or destroy this or any other
586 periodic watcher, ever, and MUST NOT call any event loop 587 periodic watcher, ever, and MUST NOT call any event loop
587 functions or methods*. If you need to stop it, return 1e30 and 588 functions or methods*. If you need to stop it, return 1e30 and
588 stop it afterwards. You may create and start a "EV::prepare" 589 stop it afterwards. You may create and start an "EV::prepare"
589 watcher for this task. 590 watcher for this task.
590 591
591 It must return the next time to trigger, based on the passed 592 It must return the next time to trigger, based on the passed
592 time value (that is, the lowest time value larger than or equal 593 time value (that is, the lowest time value larger than or equal
593 to to the second argument). It will usually be called just 594 to to the second argument). It will usually be called just
594 before the callback will be triggered, but might be called at 595 before the callback will be triggered, but might be called at
595 other times, too. 596 other times, too.
596 597
597 This can be used to create very complex timers, such as a timer 598 This can be used to create very complex timers, such as a timer
598 that triggers on each midnight, local time (actually 24 hours 599 that triggers on each midnight, local time (actually one day
599 after the last midnight, to keep the example simple. If you know 600 after the last midnight, to keep the example simple):
600 a way to do it correctly in about the same space (without
601 requiring elaborate modules), drop me a note :):
602 601
603 my $daily = EV::periodic 0, 0, sub { 602 my $daily = EV::periodic 0, 0, sub {
604 my ($w, $now) = @_; 603 my ($w, $now) = @_;
605 604
606 use Time::Local (); 605 use Time::Local ();
607 my (undef, undef, undef, $d, $m, $y) = localtime $now; 606 my (undef, undef, undef, $d, $m, $y) = localtime $now;
608 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y 607 Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y
609 }, sub { 608 }, sub {
610 print "it's midnight or likely shortly after, now\n"; 609 print "it's midnight or likely shortly after, now\n";
611 }; 610 };
612 611
613 The "periodic_ns" variant doesn't start (activate) the newly created 612 The "periodic_ns" variant doesn't start (activate) the newly created

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines