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

Comparing EV/EV.pm (file contents):
Revision 1.128 by root, Thu Oct 21 02:46:59 2010 UTC vs.
Revision 1.135 by root, Mon Dec 12 16:32:24 2011 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.03';
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 EV::run [$flags]
265 296
266=item $loop->loop ([$flags]) 297=item $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.
270 301
271The $flags argument can be one of the following: 302The $flags argument can be one of the following:
272 303
273 0 as above 304 0 as above
274 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 305 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) 306 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
276 307
277=item EV::unloop [$how] 308=item EV::break [$how]
278 309
279=item $loop->unloop ([$how]) 310=item $loop->break ([$how])
280 311
281When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 312When called with no arguments or an argument of EV::BREAK_ONE, makes the
282innermost call to EV::loop return. 313innermost call to EV::loop return.
283 314
284When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 315When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
285fast as possible. 316return as fast as possible.
286 317
287=item $count = EV::loop_count 318When called with an argument of EV::BREAK_CANCEL, any pending break will
319be cancelled.
288 320
321=item $count = EV::iteration
322
289=item $count = $loop->loop_count 323=item $count = $loop->iteration
290 324
291Return the number of times the event loop has polled for new 325Return the number of times the event loop has polled for new
292events. Sometimes useful as a generation counter. 326events. Sometimes useful as a generation counter.
293 327
294=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 328=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
… …
314 348
315EV::once doesn't return anything: the watchers stay active till either 349EV::once doesn't return anything: the watchers stay active till either
316of them triggers, then they will be stopped and freed, and the callback 350of them triggers, then they will be stopped and freed, and the callback
317invoked. 351invoked.
318 352
319=item EV::feed_fd_event ($fd, $revents) 353=item EV::feed_fd_event $fd, $revents
320 354
321=item $loop->feed_fd_event ($fd, $revents) 355=item $loop->feed_fd_event ($fd, $revents)
322 356
323Feed an event on a file descriptor into EV. EV will react to this call as 357Feed 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 358if the readyness notifications specified by C<$revents> (a combination of
325C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. 359C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
326 360
327=item EV::feed_signal_event ($signal) 361=item EV::feed_signal_event $signal
328 362
329Feed a signal event into EV. EV will react to this call as if the signal 363Feed a signal event into the default loop. EV will react to this call as
330specified by C<$signal> had occured. 364if the signal specified by C<$signal> had occured.
365
366=item EV::feed_signal $signal
367
368Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
369regardless of which loop has registered the signal, and is mainly useful
370fro custom signal implementations.
331 371
332=item EV::set_io_collect_interval $time 372=item EV::set_io_collect_interval $time
333 373
334=item $loop->set_io_collect_interval ($time) 374=item $loop->set_io_collect_interval ($time)
335 375
… …
1157 1197
11581; 11981;
1159 1199
1160=head1 SEE ALSO 1200=head1 SEE ALSO
1161 1201
1202L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1162L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1203(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
1163event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1204loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1164coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1205integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1165event-loop agnostic and portable event driven programming. 1206event-loop agnostic and portable event driven programming.
1166 1207
1167=head1 AUTHOR 1208=head1 AUTHOR
1168 1209
1169 Marc Lehmann <schmorp@schmorp.de> 1210 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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