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.138 by root, Sun May 6 16:30:27 2012 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.11';
94 use XSLoader; 125 use XSLoader;
95 XSLoader::load "EV", $VERSION; 126 XSLoader::load "EV", $VERSION;
96} 127}
97 128
98@EV::IO::ISA = 129@EV::IO::ISA =
… …
155Must be called after a fork in the child, before entering or continuing 186Must 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 187the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
157this function automatically, at some performance loss (refer to the libev 188this function automatically, at some performance loss (refer to the libev
158documentation). 189documentation).
159 190
160=item $loop->loop_verify 191=item $loop->verify
161 192
162Calls C<ev_verify> to make internal consistency checks (for debugging 193Calls C<ev_verify> to make internal consistency checks (for debugging
163libev) and abort the program if any data structures were found to be 194libev) and abort the program if any data structures were found to be
164corrupted. 195corrupted.
165 196
… …
259=item $backend = $loop->backend 290=item $backend = $loop->backend
260 291
261Returns an integer describing the backend used by libev (EV::BACKEND_SELECT 292Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
262or EV::BACKEND_EPOLL). 293or EV::BACKEND_EPOLL).
263 294
264=item EV::loop [$flags] 295=item $active = EV::run [$flags]
265 296
266=item $loop->loop ([$flags]) 297=item $active = $loop->run ([$flags])
267 298
268Begin checking for events and calling callbacks. It returns when a 299Begin checking for events and calling callbacks. It returns when a
269callback calls EV::unloop. 300callback calls EV::unloop or the flasg are nonzero (in which case the
301return value is true) or when there are no active watchers which reference
302the loop (keepalive is true), in which case the return value will be
303false. The returnv alue can generally be interpreted as "if true, there is
304more work left to do".
270 305
271The $flags argument can be one of the following: 306The $flags argument can be one of the following:
272 307
273 0 as above 308 0 as above
274 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 309 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) 310 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
276 311
277=item EV::unloop [$how] 312=item EV::break [$how]
278 313
279=item $loop->unloop ([$how]) 314=item $loop->break ([$how])
280 315
281When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 316When called with no arguments or an argument of EV::BREAK_ONE, makes the
282innermost call to EV::loop return. 317innermost call to EV::loop return.
283 318
284When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 319When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
285fast as possible. 320return as fast as possible.
286 321
287=item $count = EV::loop_count 322When called with an argument of EV::BREAK_CANCEL, any pending break will
323be cancelled.
288 324
325=item $count = EV::iteration
326
289=item $count = $loop->loop_count 327=item $count = $loop->iteration
290 328
291Return the number of times the event loop has polled for new 329Return the number of times the event loop has polled for new
292events. Sometimes useful as a generation counter. 330events. Sometimes useful as a generation counter.
293 331
294=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 332=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
… …
314 352
315EV::once doesn't return anything: the watchers stay active till either 353EV::once doesn't return anything: the watchers stay active till either
316of them triggers, then they will be stopped and freed, and the callback 354of them triggers, then they will be stopped and freed, and the callback
317invoked. 355invoked.
318 356
319=item EV::feed_fd_event ($fd, $revents) 357=item EV::feed_fd_event $fd, $revents
320 358
321=item $loop->feed_fd_event ($fd, $revents) 359=item $loop->feed_fd_event ($fd, $revents)
322 360
323Feed an event on a file descriptor into EV. EV will react to this call as 361Feed 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 362if the readyness notifications specified by C<$revents> (a combination of
325C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. 363C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
326 364
327=item EV::feed_signal_event ($signal) 365=item EV::feed_signal_event $signal
328 366
329Feed a signal event into EV. EV will react to this call as if the signal 367Feed a signal event into the default loop. EV will react to this call as
330specified by C<$signal> had occured. 368if the signal specified by C<$signal> had occured.
369
370=item EV::feed_signal $signal
371
372Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
373regardless of which loop has registered the signal, and is mainly useful
374fro custom signal implementations.
331 375
332=item EV::set_io_collect_interval $time 376=item EV::set_io_collect_interval $time
333 377
334=item $loop->set_io_collect_interval ($time) 378=item $loop->set_io_collect_interval ($time)
335 379
… …
950=item $w = $loop->check_ns ($callback) 994=item $w = $loop->check_ns ($callback)
951 995
952Call the callback just after the process wakes up again (after it has 996Call the callback just after the process wakes up again (after it has
953gathered events), but before any other callbacks have been invoked. 997gathered events), but before any other callbacks have been invoked.
954 998
955This is used to integrate other event-based software into the EV 999This 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 1000mainloop: 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 1001timer watchers as required by the other software. Here is a real-world
958example of integrating Net::SNMP (with some details left out): 1002example of integrating Net::SNMP (with some details left out):
959 1003
960 our @snmp_watcher; 1004 our @snmp_watcher;
… …
994The callbacks of the created watchers will not be called as the watchers 1038The callbacks of the created watchers will not be called as the watchers
995are destroyed before this can happen (remember EV::check gets called 1039are destroyed before this can happen (remember EV::check gets called
996first). 1040first).
997 1041
998The C<check_ns> variant doesn't start (activate) the newly created watcher. 1042The C<check_ns> variant doesn't start (activate) the newly created watcher.
1043
1044=item EV::CHECK constant issues
1045
1046Like all other watcher types, there is a bitmask constant for use in
1047C<$revents> and other places. The C<EV::CHECK> is special as it has
1048the same name as the C<CHECK> sub called by Perl. This doesn't cause
1049big issues on newer perls (beginning with 5.8.9), but it means thatthe
1050constant must be I<inlined>, i.e. runtime calls will not work. That means
1051that as long as you always C<use EV> and then C<EV::CHECK> you are on the
1052safe side.
999 1053
1000=back 1054=back
1001 1055
1002 1056
1003=head3 FORK WATCHERS - the audacity to resume the event loop after a fork 1057=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
… …
1085 1139
1086=item $w = EV::async $callback 1140=item $w = EV::async $callback
1087 1141
1088=item $w = EV::async_ns $callback 1142=item $w = EV::async_ns $callback
1089 1143
1144=item $w = $loop->async ($callback)
1145
1146=item $w = $loop->async_ns ($callback)
1147
1090=item $w->send 1148=item $w->send
1091 1149
1092=item $bool = $w->async_pending 1150=item $bool = $w->async_pending
1093 1151
1094=back 1152=back
1153
1154=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
1155
1156Cleanup watchers are not supported on the Perl level, they can only be
1157used via XS currently.
1095 1158
1096 1159
1097=head1 PERL SIGNALS 1160=head1 PERL SIGNALS
1098 1161
1099While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 1162While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
… …
1147 1210
11481; 12111;
1149 1212
1150=head1 SEE ALSO 1213=head1 SEE ALSO
1151 1214
1215L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1152L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1216(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 1217loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1154coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1218integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1155event-loop agnostic and portable event driven programming. 1219event-loop agnostic and portable event driven programming.
1156 1220
1157=head1 AUTHOR 1221=head1 AUTHOR
1158 1222
1159 Marc Lehmann <schmorp@schmorp.de> 1223 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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