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

Comparing EV/README (file contents):
Revision 1.38 by root, Mon Oct 25 11:30:45 2010 UTC vs.
Revision 1.43 by root, Sat Jun 20 11:11:01 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_ONESHOT 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_NONBLOCK 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::unloop [$how] 253 EV::break [$how]
250 $loop->unloop ([$how]) 254 $loop->break ([$how])
251 When called with no arguments or an argument of EV::UNLOOP_ONE, 255 When called with no arguments or an argument of EV::BREAK_ONE, makes
252 makes the innermost call to EV::loop return. 256 the innermost call to EV::loop return.
253 257
254 When called with an argument of EV::UNLOOP_ALL, all calls to 258 When called with an argument of EV::BREAK_ALL, all calls to EV::loop
255 EV::loop will return as fast as possible. 259 will return as fast as possible.
256 260
257 $count = EV::loop_count 261 When called with an argument of EV::BREAK_CANCEL, any pending break
258 $count = $loop->loop_count 262 will be cancelled.
263
264 $count = EV::iteration
265 $count = $loop->iteration
259 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.
260 Sometimes useful as a generation counter. 267 Sometimes useful as a generation counter.
261 268
262 EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 269 EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
263 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 270 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
… …
280 287
281 EV::once doesn't return anything: the watchers stay active till 288 EV::once doesn't return anything: the watchers stay active till
282 either of them triggers, then they will be stopped and freed, and 289 either of them triggers, then they will be stopped and freed, and
283 the callback invoked. 290 the callback invoked.
284 291
285 EV::feed_fd_event ($fd, $revents) 292 EV::feed_fd_event $fd, $revents
286 $loop->feed_fd_event ($fd, $revents) 293 $loop->feed_fd_event ($fd, $revents)
287 Feed an event on a file descriptor into EV. EV will react to this 294 Feed an event on a file descriptor into EV. EV will react to this
288 call as if the readyness notifications specified by $revents (a 295 call as if the readyness notifications specified by $revents (a
289 combination of "EV::READ" and "EV::WRITE") happened on the file 296 combination of "EV::READ" and "EV::WRITE") happened on the file
290 descriptor $fd. 297 descriptor $fd.
291 298
292 EV::feed_signal_event ($signal) 299 EV::feed_signal_event $signal
293 Feed a signal event into EV. EV will react to this call as if the 300 Feed a signal event into the default loop. EV will react to this
294 signal specified by $signal had occured. 301 call as if the signal specified by $signal had occured.
302
303 EV::feed_signal $signal
304 Feed a signal event into EV - unlike "EV::feed_signal_event", this
305 works regardless of which loop has registered the signal, and is
306 mainly useful fro custom signal implementations.
295 307
296 EV::set_io_collect_interval $time 308 EV::set_io_collect_interval $time
297 $loop->set_io_collect_interval ($time) 309 $loop->set_io_collect_interval ($time)
298 EV::set_timeout_collect_interval $time 310 EV::set_timeout_collect_interval $time
299 $loop->set_timeout_collect_interval ($time) 311 $loop->set_timeout_collect_interval ($time)
… …
546 to system time: 558 to system time:
547 559
548 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 560 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
549 561
550 That doesn't mean there will always be 3600 seconds in between 562 That doesn't mean there will always be 3600 seconds in between
551 triggers, but only that the the clalback will be called when the 563 triggers, but only that the the callback will be called when the
552 system time shows a full hour (UTC). 564 system time shows a full hour (UTC).
553 565
554 Another way to think about it (for the mathematically inclined) 566 Another way to think about it (for the mathematically inclined)
555 is that EV::periodic will try to run the callback in this mode 567 is that EV::periodic will try to run the callback in this mode
556 at the next possible time where "$time = $at (mod $interval)", 568 at the next possible time where "$time = $at (mod $interval)",
… …
917 929
918 Please see the libev documentation for further details. 930 Please see the libev documentation for further details.
919 931
920 $w = EV::async $callback 932 $w = EV::async $callback
921 $w = EV::async_ns $callback 933 $w = EV::async_ns $callback
934 $w = $loop->async ($callback)
935 $w = $loop->async_ns ($callback)
922 $w->send 936 $w->send
923 $bool = $w->async_pending 937 $bool = $w->async_pending
938
939 CLEANUP WATCHERS - how to clean up when the event loop goes away
940 Cleanup watchers are not supported on the Perl level, they can only be
941 used via XS currently.
924 942
925PERL SIGNALS 943PERL SIGNALS
926 While Perl signal handling (%SIG) is not affected by EV, the behaviour 944 While Perl signal handling (%SIG) is not affected by EV, the behaviour
927 with EV is as the same as any other C library: Perl-signals will only be 945 with EV is as the same as any other C library: Perl-signals will only be
928 handled when Perl runs, which means your signal handler might be invoked 946 handled when Perl runs, which means your signal handler might be invoked

Diff Legend

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