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

Comparing EV/EV.pm (file contents):
Revision 1.127 by root, Sun Mar 28 15:48:21 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,
… …
77can use it through the L<AnyEvent> module, stay portable to other event 77can use it through the L<AnyEvent> module, stay portable to other event
78loops (if you don't rely on any watcher types not available through it) 78loops (if you don't rely on any watcher types not available through it)
79and still be faster than with any other event loop currently supported in 79and still be faster than with any other event loop currently supported in
80Perl. 80Perl.
81 81
82=head2 PORTING FROM EV 3.X to 4.X
83
84EV version 4 introduces a number of incompatible changes summarised
85here. According to the depreciation strategy used by libev, there is a
86compatibility layer in place so programs should continue to run unchanged
87(the XS interface lacks this layer, so programs using that one need to be
88updated).
89
90This compatibility layer will be switched off in some future release.
91
92All changes relevant to Perl are renames of symbols, functions and
93methods:
94
95 EV::loop => EV::run
96 EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
97 EV::LOOP_ONESHOT => EV::RUN_ONCE
98
99 EV::unloop => EV::break
100 EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
101 EV::UNLOOP_ONE => EV::BREAK_ONE
102 EV::UNLOOP_ALL => EV::BREAK_ALL
103
104 EV::TIMEOUT => EV::TIMER
105
106 EV::loop_count => EV::iteration
107 EV::loop_depth => EV::depth
108 EV::loop_verify => EV::verify
109
110The loop object methods corresponding to the functions above have been
111similarly renamed.
112
82=head2 MODULE EXPORTS 113=head2 MODULE EXPORTS
83 114
84This module does not export any symbols. 115This module does not export any symbols.
85 116
86=cut 117=cut
… …
88package EV; 119package EV;
89 120
90use common::sense; 121use common::sense;
91 122
92BEGIN { 123BEGIN {
93 our $VERSION = '4.00'; 124 our $VERSION = '4.16';
94 use XSLoader; 125 use XSLoader;
126 local $^W = 0; # avoid spurious warning
95 XSLoader::load "EV", $VERSION; 127 XSLoader::load "EV", $VERSION;
96} 128}
97 129
98@EV::IO::ISA = 130@EV::IO::ISA =
99@EV::Timer::ISA = 131@EV::Timer::ISA =
… …
155Must 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
156the 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
157this function automatically, at some performance loss (refer to the libev 189this function automatically, at some performance loss (refer to the libev
158documentation). 190documentation).
159 191
160=item $loop->loop_verify 192=item $loop->verify
161 193
162Calls C<ev_verify> to make internal consistency checks (for debugging 194Calls C<ev_verify> to make internal consistency checks (for debugging
163libev) 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
164corrupted. 196corrupted.
165 197
… …
259=item $backend = $loop->backend 291=item $backend = $loop->backend
260 292
261Returns an integer describing the backend used by libev (EV::BACKEND_SELECT 293Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
262or EV::BACKEND_EPOLL). 294or EV::BACKEND_EPOLL).
263 295
264=item EV::loop [$flags] 296=item $active = EV::run [$flags]
265 297
266=item $loop->loop ([$flags]) 298=item $active = $loop->run ([$flags])
267 299
268Begin checking for events and calling callbacks. It returns when a 300Begin checking for events and calling callbacks. It returns when a
269callback 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".
270 306
271The $flags argument can be one of the following: 307The $flags argument can be one of the following:
272 308
273 0 as above 309 0 as above
274 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)
275 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)
276 312
277=item EV::unloop [$how] 313=item EV::break [$how]
278 314
279=item $loop->unloop ([$how]) 315=item $loop->break ([$how])
280 316
281When 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
282innermost call to EV::loop return. 318innermost call to EV::loop return.
283 319
284When 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
285fast as possible. 321return as fast as possible.
286 322
287=item $count = EV::loop_count 323When called with an argument of EV::BREAK_CANCEL, any pending break will
324be cancelled.
288 325
326=item $count = EV::iteration
327
289=item $count = $loop->loop_count 328=item $count = $loop->iteration
290 329
291Return the number of times the event loop has polled for new 330Return the number of times the event loop has polled for new
292events. Sometimes useful as a generation counter. 331events. Sometimes useful as a generation counter.
293 332
294=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 333=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
… …
314 353
315EV::once doesn't return anything: the watchers stay active till either 354EV::once doesn't return anything: the watchers stay active till either
316of 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
317invoked. 356invoked.
318 357
319=item EV::feed_fd_event ($fd, $revents) 358=item EV::feed_fd_event $fd, $revents
320 359
321=item $loop->feed_fd_event ($fd, $revents) 360=item $loop->feed_fd_event ($fd, $revents)
322 361
323Feed 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
324if the readyness notifications specified by C<$revents> (a combination of 363if the readyness notifications specified by C<$revents> (a combination of
325C<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>.
326 365
327=item EV::feed_signal_event ($signal) 366=item EV::feed_signal_event $signal
328 367
329Feed 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
330specified 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.
331 376
332=item EV::set_io_collect_interval $time 377=item EV::set_io_collect_interval $time
333 378
334=item $loop->set_io_collect_interval ($time) 379=item $loop->set_io_collect_interval ($time)
335 380
… …
637time: 682time:
638 683
639 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" };
640 685
641That 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,
642but 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
643full hour (UTC). 688full hour (UTC).
644 689
645Another way to think about it (for the mathematically inclined) is that 690Another way to think about it (for the mathematically inclined) is that
646EV::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
647possible time where C<$time = $at (mod $interval)>, regardless of any time 692possible time where C<$time = $at (mod $interval)>, regardless of any time
… …
950=item $w = $loop->check_ns ($callback) 995=item $w = $loop->check_ns ($callback)
951 996
952Call the callback just after the process wakes up again (after it has 997Call the callback just after the process wakes up again (after it has
953gathered events), but before any other callbacks have been invoked. 998gathered events), but before any other callbacks have been invoked.
954 999
955This is used to integrate other event-based software into the EV 1000This can be used to integrate other event-based software into the EV
956mainloop: You register a prepare callback and in there, you create io and 1001mainloop: You register a prepare callback and in there, you create io and
957timer watchers as required by the other software. Here is a real-world 1002timer watchers as required by the other software. Here is a real-world
958example of integrating Net::SNMP (with some details left out): 1003example of integrating Net::SNMP (with some details left out):
959 1004
960 our @snmp_watcher; 1005 our @snmp_watcher;
… …
994The callbacks of the created watchers will not be called as the watchers 1039The callbacks of the created watchers will not be called as the watchers
995are destroyed before this can happen (remember EV::check gets called 1040are destroyed before this can happen (remember EV::check gets called
996first). 1041first).
997 1042
998The C<check_ns> variant doesn't start (activate) the newly created watcher. 1043The C<check_ns> variant doesn't start (activate) the newly created watcher.
1044
1045=item EV::CHECK constant issues
1046
1047Like all other watcher types, there is a bitmask constant for use in
1048C<$revents> and other places. The C<EV::CHECK> is special as it has
1049the same name as the C<CHECK> sub called by Perl. This doesn't cause
1050big issues on newer perls (beginning with 5.8.9), but it means thatthe
1051constant must be I<inlined>, i.e. runtime calls will not work. That means
1052that as long as you always C<use EV> and then C<EV::CHECK> you are on the
1053safe side.
999 1054
1000=back 1055=back
1001 1056
1002 1057
1003=head3 FORK WATCHERS - the audacity to resume the event loop after a fork 1058=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
… …
1085 1140
1086=item $w = EV::async $callback 1141=item $w = EV::async $callback
1087 1142
1088=item $w = EV::async_ns $callback 1143=item $w = EV::async_ns $callback
1089 1144
1145=item $w = $loop->async ($callback)
1146
1147=item $w = $loop->async_ns ($callback)
1148
1090=item $w->send 1149=item $w->send
1091 1150
1092=item $bool = $w->async_pending 1151=item $bool = $w->async_pending
1093 1152
1094=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.
1095 1159
1096 1160
1097=head1 PERL SIGNALS 1161=head1 PERL SIGNALS
1098 1162
1099While 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
… …
1147 1211
11481; 12121;
1149 1213
1150=head1 SEE ALSO 1214=head1 SEE ALSO
1151 1215
1216L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1152L<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
1153event 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
1154coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1219integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1155event-loop agnostic and portable event driven programming. 1220event-loop agnostic and portable event driven programming.
1156 1221
1157=head1 AUTHOR 1222=head1 AUTHOR
1158 1223
1159 Marc Lehmann <schmorp@schmorp.de> 1224 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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