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.148 by root, Sun Dec 20 01:35:46 2015 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::break 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.22;
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::break 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
… …
569in front of the machine while the timer is running and changes the system 614in front of the machine while the timer is running and changes the system
570clock, the timer will nevertheless run (roughly) the same time. 615clock, the timer will nevertheless run (roughly) the same time.
571 616
572The C<timer_ns> variant doesn't start (activate) the newly created watcher. 617The C<timer_ns> variant doesn't start (activate) the newly created watcher.
573 618
574=item $w->set ($after, $repeat) 619=item $w->set ($after, $repeat = 0)
575 620
576Reconfigures the watcher, see the constructor above for details. Can be called at 621Reconfigures the watcher, see the constructor above for details. Can be called at
577any time. 622any time.
578 623
579=item $w->again 624=item $w->again
625
626=item $w->again ($repeat)
580 627
581Similar to the C<start> method, but has special semantics for repeating timers: 628Similar to the C<start> method, but has special semantics for repeating timers:
582 629
583If the timer is active and non-repeating, it will be stopped. 630If the timer is active and non-repeating, it will be stopped.
584 631
… …
591 638
592This behaviour is useful when you have a timeout for some IO 639This behaviour is useful when you have a timeout for some IO
593operation. You create a timer object with the same value for C<$after> and 640operation. You create a timer object with the same value for C<$after> and
594C<$repeat>, and then, in the read/write watcher, run the C<again> method 641C<$repeat>, and then, in the read/write watcher, run the C<again> method
595on the timeout. 642on the timeout.
643
644If called with a C<$repeat> argument, then it uses this a timer repeat
645value.
646
647=item $after = $w->remaining
648
649Calculates and returns the remaining time till the timer will fire.
596 650
597=back 651=back
598 652
599 653
600=head3 PERIODIC WATCHERS - to cron or not to cron? 654=head3 PERIODIC WATCHERS - to cron or not to cron?
… …
637time: 691time:
638 692
639 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 693 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
640 694
641That doesn't mean there will always be 3600 seconds in between triggers, 695That 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 696but only that the the callback will be called when the system time shows a
643full hour (UTC). 697full hour (UTC).
644 698
645Another way to think about it (for the mathematically inclined) is that 699Another 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 700EV::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 701possible time where C<$time = $at (mod $interval)>, regardless of any time
… …
1095 1149
1096=item $w = EV::async $callback 1150=item $w = EV::async $callback
1097 1151
1098=item $w = EV::async_ns $callback 1152=item $w = EV::async_ns $callback
1099 1153
1154=item $w = $loop->async ($callback)
1155
1156=item $w = $loop->async_ns ($callback)
1157
1100=item $w->send 1158=item $w->send
1101 1159
1102=item $bool = $w->async_pending 1160=item $bool = $w->async_pending
1103 1161
1104=back 1162=back
1163
1164=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
1165
1166Cleanup watchers are not supported on the Perl level, they can only be
1167used via XS currently.
1105 1168
1106 1169
1107=head1 PERL SIGNALS 1170=head1 PERL SIGNALS
1108 1171
1109While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 1172While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
… …
1157 1220
11581; 12211;
1159 1222
1160=head1 SEE ALSO 1223=head1 SEE ALSO
1161 1224
1225L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1162L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1226(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 1227loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1164coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1228integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1165event-loop agnostic and portable event driven programming. 1229event-loop agnostic and portable event driven programming.
1166 1230
1167=head1 AUTHOR 1231=head1 AUTHOR
1168 1232
1169 Marc Lehmann <schmorp@schmorp.de> 1233 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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