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

Comparing EV/README (file contents):
Revision 1.39 by root, Tue Jan 11 13:45:28 2011 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::loop; # 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::loop EV::LOOP_ONESHOT; # 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::loop EV::LOOP_NONBLOCK; # 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
57 advanced functionality of this module, consider using AnyEvent instead, 57 advanced functionality of this module, consider using AnyEvent instead,
58 specifically the simplified API described in AE. 58 specifically the simplified API described in AE.
… …
151 Must be called after a fork in the child, before entering or 151 Must be called after a fork in the child, before entering or
152 continuing the event loop. An alternative is to use 152 continuing the event loop. An alternative is to use
153 "EV::FLAG_FORKCHECK" which calls this function automatically, at 153 "EV::FLAG_FORKCHECK" which calls this function automatically, at
154 some performance loss (refer to the libev documentation). 154 some performance loss (refer to the libev documentation).
155 155
156 $loop->loop_verify 156 $loop->verify
157 Calls "ev_verify" to make internal consistency checks (for debugging 157 Calls "ev_verify" to make internal consistency checks (for debugging
158 libev) and abort the program if any data structures were found to be 158 libev) and abort the program if any data structures were found to be
159 corrupted. 159 corrupted.
160 160
161 $loop = EV::default_loop [$flags] 161 $loop = EV::default_loop [$flags]
… …
233 $backend = EV::backend 233 $backend = EV::backend
234 $backend = $loop->backend 234 $backend = $loop->backend
235 Returns an integer describing the backend used by libev 235 Returns an integer describing the backend used by libev
236 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). 236 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL).
237 237
238 EV::loop [$flags] 238 $active = EV::run [$flags]
239 $loop->loop ([$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. 241 callback calls EV::break or the flasg are nonzero (in which case the
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
244 value will be false. The returnv alue can generally be interpreted
245 as "if true, there is more work left to do".
242 246
243 The $flags argument can be one of the following: 247 The $flags argument can be one of the following:
244 248
245 0 as above 249 0 as above
246 EV::LOOP_ONCE block at most once (wait, but do not loop) 250 EV::RUN_ONCE block at most once (wait, but do not loop)
247 EV::LOOP_NOWAIT do not block at all (fetch/handle events but do not wait) 251 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
248 252
249 EV::break [$how] 253 EV::break [$how]
250 $loop->break ([$how]) 254 $loop->break ([$how])
251 When called with no arguments or an argument of EV::BREAK_ONE, makes 255 When called with no arguments or an argument of EV::BREAK_ONE, makes
252 the innermost call to EV::loop return. 256 the innermost call to EV::loop return.
… …
255 will return as fast as possible. 259 will return as fast as possible.
256 260
257 When called with an argument of EV::BREAK_CANCEL, any pending break 261 When called with an argument of EV::BREAK_CANCEL, any pending break
258 will be cancelled. 262 will be cancelled.
259 263
260 $count = EV::loop_count 264 $count = EV::iteration
261 $count = $loop->loop_count 265 $count = $loop->iteration
262 Return the number of times the event loop has polled for new events. 266 Return the number of times the event loop has polled for new events.
263 Sometimes useful as a generation counter. 267 Sometimes useful as a generation counter.
264 268
265 EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 269 EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
266 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 270 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
… …
497 the same time. 501 the same time.
498 502
499 The "timer_ns" variant doesn't start (activate) the newly created 503 The "timer_ns" variant doesn't start (activate) the newly created
500 watcher. 504 watcher.
501 505
502 $w->set ($after, $repeat) 506 $w->set ($after, $repeat = 0)
503 Reconfigures the watcher, see the constructor above for details. Can 507 Reconfigures the watcher, see the constructor above for details. Can
504 be called at any time. 508 be called at any time.
505 509
506 $w->again 510 $w->again
511 $w->again ($repeat)
507 Similar to the "start" method, but has special semantics for 512 Similar to the "start" method, but has special semantics for
508 repeating timers: 513 repeating timers:
509 514
510 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.
511 516
… …
519 524
520 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
521 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
522 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"
523 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.
524 535
525 PERIODIC WATCHERS - to cron or not to cron? 536 PERIODIC WATCHERS - to cron or not to cron?
526 $w = EV::periodic $at, $interval, $reschedule_cb, $callback 537 $w = EV::periodic $at, $interval, $reschedule_cb, $callback
527 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 538 $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
528 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) 539 $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
… …
554 to system time: 565 to system time:
555 566
556 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" };
557 568
558 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
559 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
560 system time shows a full hour (UTC). 571 system time shows a full hour (UTC).
561 572
562 Another way to think about it (for the mathematically inclined) 573 Another way to think about it (for the mathematically inclined)
563 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
564 at the next possible time where "$time = $at (mod $interval)", 575 at the next possible time where "$time = $at (mod $interval)",
… …
925 936
926 Please see the libev documentation for further details. 937 Please see the libev documentation for further details.
927 938
928 $w = EV::async $callback 939 $w = EV::async $callback
929 $w = EV::async_ns $callback 940 $w = EV::async_ns $callback
941 $w = $loop->async ($callback)
942 $w = $loop->async_ns ($callback)
930 $w->send 943 $w->send
931 $bool = $w->async_pending 944 $bool = $w->async_pending
945
946 CLEANUP WATCHERS - how to clean up when the event loop goes away
947 Cleanup watchers are not supported on the Perl level, they can only be
948 used via XS currently.
932 949
933PERL SIGNALS 950PERL SIGNALS
934 While Perl signal handling (%SIG) is not affected by EV, the behaviour 951 While Perl signal handling (%SIG) is not affected by EV, the behaviour
935 with EV is as the same as any other C library: Perl-signals will only be 952 with EV is as the same as any other C library: Perl-signals will only be
936 handled when Perl runs, which means your signal handler might be invoked 953 handled when Perl runs, which means your signal handler might be invoked

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines