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

Comparing EV/README (file contents):
Revision 1.41 by root, Fri Mar 1 11:20:07 2013 UTC vs.
Revision 1.44 by root, Mon Jul 13 19:47:53 2015 UTC

46 my ($w, $revents) = @_; 46 my ($w, $revents) = @_;
47 warn $w->path, " has changed somehow.\n"; 47 warn $w->path, " has changed somehow.\n";
48 }; 48 };
49 49
50 # MAINLOOP 50 # MAINLOOP
51 EV::run; # loop until EV::unloop is called or all watchers stop 51 EV::run; # loop until EV::break is called or all watchers stop
52 EV::run EV::RUN_ONCE; # block until at least one event could be handled 52 EV::run EV::RUN_ONCE; # block until at least one event could be handled
53 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block 53 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
54 54
55BEFORE YOU START USING THIS MODULE 55BEFORE YOU START USING THIS MODULE
56 If you only need timer, I/O, signal, child and idle watchers and not the 56 If you only need timer, I/O, signal, child and idle watchers and not the
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::unloop or the flasg are nonzero (in which case 241 callback calls EV::break or the flasg are nonzero (in which case the
242 the 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 returnv alue 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:
501 the same time. 501 the same time.
502 502
503 The "timer_ns" variant doesn't start (activate) the newly created 503 The "timer_ns" variant doesn't start (activate) the newly created
504 watcher. 504 watcher.
505 505
506 $w->set ($after, $repeat) 506 $w->set ($after, $repeat = 0)
507 Reconfigures the watcher, see the constructor above for details. Can 507 Reconfigures the watcher, see the constructor above for details. Can
508 be called at any time. 508 be called at any time.
509 509
510 $w->again 510 $w->again
511 $w->again ($repeat)
511 Similar to the "start" method, but has special semantics for 512 Similar to the "start" method, but has special semantics for
512 repeating timers: 513 repeating timers:
513 514
514 If the timer is active and non-repeating, it will be stopped. 515 If the timer is active and non-repeating, it will be stopped.
515 516
523 524
524 This behaviour is useful when you have a timeout for some IO 525 This behaviour is useful when you have a timeout for some IO
525 operation. You create a timer object with the same value for $after 526 operation. You create a timer object with the same value for $after
526 and $repeat, and then, in the read/write watcher, run the "again" 527 and $repeat, and then, in the read/write watcher, run the "again"
527 method on the timeout. 528 method on the timeout.
529
530 If called with a $repeat argument, then it uses this a timer repeat
531 value.
532
533 $after = $w->remaining
534 Calculates and returns the remaining time till the timer will fire.
528 535
529 PERIODIC WATCHERS - to cron or not to cron? 536 PERIODIC WATCHERS - to cron or not to cron?
530 $w = EV::periodic $at, $interval, $reschedule_cb, $callback 537 $w = EV::periodic $at, $interval, $reschedule_cb, $callback
531 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 538 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
532 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) 539 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
558 to system time: 565 to system time:
559 566
560 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 567 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
561 568
562 That doesn't mean there will always be 3600 seconds in between 569 That doesn't mean there will always be 3600 seconds in between
563 triggers, but only that the the clalback will be called when the 570 triggers, but only that the the callback will be called when the
564 system time shows a full hour (UTC). 571 system time shows a full hour (UTC).
565 572
566 Another way to think about it (for the mathematically inclined) 573 Another way to think about it (for the mathematically inclined)
567 is that EV::periodic will try to run the callback in this mode 574 is that EV::periodic will try to run the callback in this mode
568 at the next possible time where "$time = $at (mod $interval)", 575 at the next possible time where "$time = $at (mod $interval)",

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines