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

Comparing EV/EV.pm (file contents):
Revision 1.129 by root, Thu Oct 21 15:13:42 2010 UTC vs.
Revision 1.142 by root, Sat Mar 8 15:51:23 2014 UTC

… …
47 my ($w, $revents) = @_; 47 my ($w, $revents) = @_;
48 warn $w->path, " has changed somehow.\n"; 48 warn $w->path, " has changed somehow.\n";
49 }; 49 };
50 50
51 # MAINLOOP 51 # MAINLOOP
52 EV::loop; # loop until EV::unloop is called or all watchers stop 52 EV::run; # loop until EV::unloop is called or all watchers stop
53 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 53 EV::run EV::RUN_ONCE; # block until at least one event could be handled
54 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 54 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
55 55
56=head1 BEFORE YOU START USING THIS MODULE 56=head1 BEFORE YOU START USING THIS MODULE
57 57
58If you only need timer, I/O, signal, child and idle watchers and not the 58If you only need timer, I/O, signal, child and idle watchers and not the
59advanced functionality of this module, consider using L<AnyEvent> instead, 59advanced functionality of this module, consider using L<AnyEvent> instead,
… …
119package EV; 119package EV;
120 120
121use common::sense; 121use common::sense;
122 122
123BEGIN { 123BEGIN {
124 our $VERSION = '4.00'; 124 our $VERSION = '4.16';
125 use XSLoader; 125 use XSLoader;
126 local $^W = 0; # avoid spurious warning
126 XSLoader::load "EV", $VERSION; 127 XSLoader::load "EV", $VERSION;
127} 128}
128 129
129@EV::IO::ISA = 130@EV::IO::ISA =
130@EV::Timer::ISA = 131@EV::Timer::ISA =
… …
186Must be called after a fork in the child, before entering or continuing 187Must be called after a fork in the child, before entering or continuing
187the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls 188the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
188this function automatically, at some performance loss (refer to the libev 189this function automatically, at some performance loss (refer to the libev
189documentation). 190documentation).
190 191
191=item $loop->loop_verify 192=item $loop->verify
192 193
193Calls C<ev_verify> to make internal consistency checks (for debugging 194Calls C<ev_verify> to make internal consistency checks (for debugging
194libev) and abort the program if any data structures were found to be 195libev) and abort the program if any data structures were found to be
195corrupted. 196corrupted.
196 197
… …
290=item $backend = $loop->backend 291=item $backend = $loop->backend
291 292
292Returns an integer describing the backend used by libev (EV::BACKEND_SELECT 293Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
293or EV::BACKEND_EPOLL). 294or EV::BACKEND_EPOLL).
294 295
295=item EV::loop [$flags] 296=item $active = EV::run [$flags]
296 297
297=item $loop->loop ([$flags]) 298=item $active = $loop->run ([$flags])
298 299
299Begin checking for events and calling callbacks. It returns when a 300Begin checking for events and calling callbacks. It returns when a
300callback calls EV::unloop. 301callback calls EV::unloop or the flasg are nonzero (in which case the
302return value is true) or when there are no active watchers which reference
303the loop (keepalive is true), in which case the return value will be
304false. The returnv alue can generally be interpreted as "if true, there is
305more work left to do".
301 306
302The $flags argument can be one of the following: 307The $flags argument can be one of the following:
303 308
304 0 as above 309 0 as above
305 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 310 EV::RUN_ONCE block at most once (wait, but do not loop)
306 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 311 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
307 312
308=item EV::unloop [$how] 313=item EV::break [$how]
309 314
310=item $loop->unloop ([$how]) 315=item $loop->break ([$how])
311 316
312When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 317When called with no arguments or an argument of EV::BREAK_ONE, makes the
313innermost call to EV::loop return. 318innermost call to EV::loop return.
314 319
315When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 320When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
316fast as possible. 321return as fast as possible.
317 322
318=item $count = EV::loop_count 323When called with an argument of EV::BREAK_CANCEL, any pending break will
324be cancelled.
319 325
326=item $count = EV::iteration
327
320=item $count = $loop->loop_count 328=item $count = $loop->iteration
321 329
322Return the number of times the event loop has polled for new 330Return the number of times the event loop has polled for new
323events. Sometimes useful as a generation counter. 331events. Sometimes useful as a generation counter.
324 332
325=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 333=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
… …
345 353
346EV::once doesn't return anything: the watchers stay active till either 354EV::once doesn't return anything: the watchers stay active till either
347of them triggers, then they will be stopped and freed, and the callback 355of them triggers, then they will be stopped and freed, and the callback
348invoked. 356invoked.
349 357
350=item EV::feed_fd_event ($fd, $revents) 358=item EV::feed_fd_event $fd, $revents
351 359
352=item $loop->feed_fd_event ($fd, $revents) 360=item $loop->feed_fd_event ($fd, $revents)
353 361
354Feed an event on a file descriptor into EV. EV will react to this call as 362Feed an event on a file descriptor into EV. EV will react to this call as
355if the readyness notifications specified by C<$revents> (a combination of 363if the readyness notifications specified by C<$revents> (a combination of
356C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. 364C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
357 365
358=item EV::feed_signal_event ($signal) 366=item EV::feed_signal_event $signal
359 367
360Feed a signal event into EV. EV will react to this call as if the signal 368Feed a signal event into the default loop. EV will react to this call as
361specified by C<$signal> had occured. 369if the signal specified by C<$signal> had occured.
370
371=item EV::feed_signal $signal
372
373Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
374regardless of which loop has registered the signal, and is mainly useful
375fro custom signal implementations.
362 376
363=item EV::set_io_collect_interval $time 377=item EV::set_io_collect_interval $time
364 378
365=item $loop->set_io_collect_interval ($time) 379=item $loop->set_io_collect_interval ($time)
366 380
… …
668time: 682time:
669 683
670 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 684 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
671 685
672That doesn't mean there will always be 3600 seconds in between triggers, 686That doesn't mean there will always be 3600 seconds in between triggers,
673but only that the the clalback will be called when the system time shows a 687but only that the the callback will be called when the system time shows a
674full hour (UTC). 688full hour (UTC).
675 689
676Another way to think about it (for the mathematically inclined) is that 690Another way to think about it (for the mathematically inclined) is that
677EV::periodic will try to run the callback in this mode at the next 691EV::periodic will try to run the callback in this mode at the next
678possible time where C<$time = $at (mod $interval)>, regardless of any time 692possible time where C<$time = $at (mod $interval)>, regardless of any time
… …
1126 1140
1127=item $w = EV::async $callback 1141=item $w = EV::async $callback
1128 1142
1129=item $w = EV::async_ns $callback 1143=item $w = EV::async_ns $callback
1130 1144
1145=item $w = $loop->async ($callback)
1146
1147=item $w = $loop->async_ns ($callback)
1148
1131=item $w->send 1149=item $w->send
1132 1150
1133=item $bool = $w->async_pending 1151=item $bool = $w->async_pending
1134 1152
1135=back 1153=back
1154
1155=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
1156
1157Cleanup watchers are not supported on the Perl level, they can only be
1158used via XS currently.
1136 1159
1137 1160
1138=head1 PERL SIGNALS 1161=head1 PERL SIGNALS
1139 1162
1140While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 1163While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
… …
1188 1211
11891; 12121;
1190 1213
1191=head1 SEE ALSO 1214=head1 SEE ALSO
1192 1215
1216L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1193L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1217(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
1194event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1218loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1195coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1219integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1196event-loop agnostic and portable event driven programming. 1220event-loop agnostic and portable event driven programming.
1197 1221
1198=head1 AUTHOR 1222=head1 AUTHOR
1199 1223
1200 Marc Lehmann <schmorp@schmorp.de> 1224 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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