[ViewVC] Diff of: cvs/EV/EV.pm

Comparing EV/EV.pm (file contents):
Revision 1.108 by root, Mon Nov 3 12:13:15 2008 UTC vs.
Revision 1.144 by root, Sat Sep 6 18:42:18 2014 UTC

       my ($w, $revents) = @_;
       warn $w->path, " has changed somehow.\n";
    };
    # MAINLOOP
-   EV::loop;           # loop until EV::unloop is called or all watchers stop
+   EV::run;                # loop until EV::unloop is called or all watchers stop
-   EV::loop EV::LOOP_ONESHOT;  # block until at least one event could be handled
+   EV::run EV::RUN_ONCE;   # block until at least one event could be handled
-   EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
+   EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
+=head1 BEFORE YOU START USING THIS MODULE
+If you only need timer, I/O, signal, child and idle watchers and not the
+advanced functionality of this module, consider using L<AnyEvent> instead,
+specifically the simplified API described in L<AE>.
+When used with EV as backend, the L<AE> API is as fast as the native L<EV>
+API, but your programs/modules will still run with many other event loops.
 =head1 DESCRIPTION
 This module provides an interface to libev
 (L<http://software.schmorp.de/pkg/libev.html>). While the documentation
 can use it through the L<AnyEvent> module, stay portable to other event
 loops (if you don't rely on any watcher types not available through it)
 and still be faster than with any other event loop currently supported in
 Perl.
+=head2 PORTING FROM EV 3.X to 4.X
+EV version 4 introduces a number of incompatible changes summarised
+here. According to the depreciation strategy used by libev, there is a
+compatibility layer in place so programs should continue to run unchanged
+(the XS interface lacks this layer, so programs using that one need to be
+updated).
+This compatibility layer will be switched off in some future release.
+All changes relevant to Perl are renames of symbols, functions and
+methods:
+  EV::loop          => EV::run
+  EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
+  EV::LOOP_ONESHOT  => EV::RUN_ONCE
+  EV::unloop        => EV::break
+  EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
+  EV::UNLOOP_ONE    => EV::BREAK_ONE
+  EV::UNLOOP_ALL    => EV::BREAK_ALL
+  EV::TIMEOUT       => EV::TIMER
+  EV::loop_count    => EV::iteration
+  EV::loop_depth    => EV::depth
+  EV::loop_verify   => EV::verify
+The loop object methods corresponding to the functions above have been
+similarly renamed.
 =head2 MODULE EXPORTS
 This module does not export any symbols.
 =cut
 package EV;
-no warnings;
+use common::sense;
-use strict;
 BEGIN {
-   our $VERSION = '3.48';
+   our $VERSION = '4.18';
    use XSLoader;
+   local $^W = 0; # avoid spurious warning
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 @EV::Timer::ISA    =
 will then also service the kqueue loop to some extent. See the example in
 the section about embed watchers for an example on how to achieve that.
 =over 4
-=item $loop = new EV::loop [$flags]
+=item $loop = new EV::Loop [$flags]
 Create a new event loop as per the specified flags. Please refer to
 the C<ev_loop_new ()> function description in the libev documentation
 (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
 or locally-installed as F<EV::libev> manpage) for more info.
 Must be called after a fork in the child, before entering or continuing
 the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
 this function automatically, at some performance loss (refer to the libev
 documentation).
-=item $loop->loop_verify
+=item $loop->verify
 Calls C<ev_verify> to make internal consistency checks (for debugging
 libev) and abort the program if any data structures were found to be
 corrupted.
 Returns the time the last event loop iteration has been started. This
 is the time that (relative) timers are based on, and referring to it is
 usually faster then calling EV::time.
+=item EV::now_update
+=item $loop->now_update
+Establishes the current time by querying the kernel, updating the time
+returned by C<EV::now> in the progress. This is a costly operation and
+is usually done automatically within C<EV::loop>.
+This function is rarely useful, but when some event callback runs for a
+very long time without entering the event loop, updating libev's idea of
+the current time is a good idea.
+=item EV::suspend
+=item $loop->suspend
+=item EV::resume
+=item $loop->resume
+These two functions suspend and resume a loop, for use when the loop is
+not used for a while and timeouts should not be processed.
+A typical use case would be an interactive program such as a game:  When
+the user presses C<^Z> to suspend the game and resumes it an hour later it
+would be best to handle timeouts as if no time had actually passed while
+the program was suspended. This can be achieved by calling C<suspend>
+in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
+C<resume> directly afterwards to resume timer processing.
+Effectively, all C<timer> watchers will be delayed by the time spend
+between C<suspend> and C<resume>, and all C<periodic> watchers
+will be rescheduled (that is, they will lose any events that would have
+occured while suspended).
+After calling C<suspend> you B<must not> call I<any> function on the given
+loop other than C<resume>, and you B<must not> call C<resume>
+without a previous call to C<suspend>.
+Calling C<suspend>/C<resume> has the side effect of updating the event
+loop time (see C<now_update>).
 =item $backend = EV::backend
 =item $backend = $loop->backend
 Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
 or EV::BACKEND_EPOLL).
-=item EV::loop [$flags]
+=item $active = EV::run [$flags]
-=item $loop->loop ([$flags])
+=item $active = $loop->run ([$flags])
 Begin checking for events and calling callbacks. It returns when a
-callback calls EV::unloop.
+callback calls EV::unloop or the flasg are nonzero (in which case the
+return value is true) or when there are no active watchers which reference
+the loop (keepalive is true), in which case the return value will be
+false. The returnv alue can generally be interpreted as "if true, there is
+more work left to do".
 The $flags argument can be one of the following:
-   0                  as above
+   0               as above
-   EV::LOOP_ONESHOT   block at most once (wait, but do not loop)
+   EV::RUN_ONCE    block at most once (wait, but do not loop)
-   EV::LOOP_NONBLOCK  do not block at all (fetch/handle events but do not wait)
+   EV::RUN_NOWAIT  do not block at all (fetch/handle events but do not wait)
-=item EV::unloop [$how]
+=item EV::break [$how]
-=item $loop->unloop ([$how])
+=item $loop->break ([$how])
-When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
+When called with no arguments or an argument of EV::BREAK_ONE, makes the
 innermost call to EV::loop return.
-When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
+When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
-fast as possible.
+return as fast as possible.
-=item $count = EV::loop_count
+When called with an argument of EV::BREAK_CANCEL, any pending break will
+be cancelled.
+=item $count = EV::iteration
-=item $count = $loop->loop_count
+=item $count = $loop->iteration
 Return the number of times the event loop has polled for new
 events. Sometimes useful as a generation counter.
 =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
 timeout. Otherwise a EV::timer with this value will be started.
 When an error occurs or either the timeout or I/O watcher triggers, then
 the callback will be called with the received event set (in general
 you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
-C<EV::WRITE> and C<EV::TIMEOUT>).
+C<EV::WRITE> and C<EV::TIMER>).
 EV::once doesn't return anything: the watchers stay active till either
 of them triggers, then they will be stopped and freed, and the callback
 invoked.
-=item EV::feed_fd_event ($fd, $revents)
+=item EV::feed_fd_event $fd, $revents
 =item $loop->feed_fd_event ($fd, $revents)
 Feed an event on a file descriptor into EV. EV will react to this call as
 if the readyness notifications specified by C<$revents> (a combination of
 C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
-=item EV::feed_signal_event ($signal)
+=item EV::feed_signal_event $signal
-Feed a signal event into EV. EV will react to this call as if the signal
+Feed a signal event into the default loop. EV will react to this call as
-specified by C<$signal> had occured.
+if the signal specified by C<$signal> had occured.
+=item EV::feed_signal $signal
+Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
+regardless of which loop has registered the signal, and is mainly useful
+fro custom signal implementations.
 =item EV::set_io_collect_interval $time
 =item $loop->set_io_collect_interval ($time)
 These advanced functions set the minimum block interval when polling for I/O events and the minimum
 wait interval for timer events. See the libev documentation at
 L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
 (locally installed as F<EV::libev>) for a more detailed discussion.
+=item $count = EV::pending_count
+=item $count = $loop->pending_count
+Returns the number of currently pending watchers.
+=item EV::invoke_pending
+=item $loop->invoke_pending
+Invoke all currently pending watchers.
 =back
 =head1 WATCHER OBJECTS
 Each watcher type has its associated bit in revents, so you can use the
 same callback for multiple watchers. The event mask is named after the
 type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
-(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
+(which can set both EV::READ and EV::WRITE bits).
-uses EV::TIMEOUT).
 In the rare case where one wants to create a watcher but not start it at
 the same time, each constructor has a variant with a trailing C<_ns> in
 its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
 =item $previous_state = $w->keepalive ($bool)
 Normally, C<EV::loop> will return when there are no active watchers
 (which is a "deadlock" because no progress can be made anymore). This is
-convinient because it allows you to start your watchers (and your jobs),
+convenient because it allows you to start your watchers (and your jobs),
 call C<EV::loop> once and when it returns you know that all your jobs are
 finished (or they forgot to register some watchers for their task :).
 Sometimes, however, this gets in your way, for example when the module
 that calls C<EV::loop> (usually the main program) is not the same module
 time:
    my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
 That doesn't mean there will always be 3600 seconds in between triggers,
-but only that the the clalback will be called when the system time shows a
+but only that the the callback will be called when the system time shows a
 full hour (UTC).
 Another way to think about it (for the mathematically inclined) is that
 EV::periodic will try to run the callback in this mode at the next
 possible time where C<$time = $at (mod $interval)>, regardless of any time
 =item $w = EV::signal $signal, $callback
 =item $w = EV::signal_ns $signal, $callback
+=item $w = $loop->signal ($signal, $callback)
+=item $w = $loop->signal_ns ($signal, $callback)
 Call the callback when $signal is received (the signal can be specified by
 number or by name, just as with C<kill> or C<%SIG>).
+Only one event loop can grab a given signal - attempting to grab the same
+signal from two EV loops will crash the program immediately or cause data
+corruption.
 EV will grab the signal for the process (the kernel only allows one
 component to receive a signal at a time) when you start a signal watcher,
 and removes it again when you stop it. Perl does the same when you
 add/remove callbacks to C<%SIG>, so watch out.
 =item $w = $loop->check_ns ($callback)
 Call the callback just after the process wakes up again (after it has
 gathered events), but before any other callbacks have been invoked.
-This is used to integrate other event-based software into the EV
+This can be used to integrate other event-based software into the EV
 mainloop: You register a prepare callback and in there, you create io and
 timer watchers as required by the other software. Here is a real-world
 example of integrating Net::SNMP (with some details left out):
    our @snmp_watcher;
 The callbacks of the created watchers will not be called as the watchers
 are destroyed before this can happen (remember EV::check gets called
 first).
 The C<check_ns> variant doesn't start (activate) the newly created watcher.
+=item EV::CHECK constant issues
+Like all other watcher types, there is a bitmask constant for use in
+C<$revents> and other places. The C<EV::CHECK> is special as it has
+the same name as the C<CHECK> sub called by Perl. This doesn't cause
+big issues on newer perls (beginning with 5.8.9), but it means thatthe
+constant must be I<inlined>, i.e. runtime calls will not work. That means
+that as long as you always C<use EV> and then C<EV::CHECK> you are on the
+safe side.
 =back
 =head3 FORK WATCHERS - the audacity to resume the event loop after a fork
 =back
 =head3 ASYNC WATCHERS - how to wake up another event loop
-Async watchers are provided by EV, but have little use in perl directly, as perl
+Async watchers are provided by EV, but have little use in perl directly,
-neither supports threads nor direct access to signal handlers or other
+as perl neither supports threads running in parallel nor direct access to
-contexts where they could be of value.
+signal handlers or other contexts where they could be of value.
 It is, however, possible to use them from the XS level.
 Please see the libev documentation for further details.
 =item $w = EV::async $callback
 =item $w = EV::async_ns $callback
+=item $w = $loop->async ($callback)
+=item $w = $loop->async_ns ($callback)
 =item $w->send
 =item $bool = $w->async_pending
 =back
+=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
+Cleanup watchers are not supported on the Perl level, they can only be
+used via XS currently.
 =head1 PERL SIGNALS
 While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
    my $async_check = EV::check sub { };
 This ensures that perl gets into control for a short time to handle any
 pending signals, and also ensures (slightly) slower overall operation.
-=head1 THREADS
+=head1 ITHREADS
-Threads are not supported by this module in any way. Perl pseudo-threads
+Ithreads are not supported by this module in any way. Perl pseudo-threads
-is evil stuff and must die. As soon as Perl gains real threads I will work
+is evil stuff and must die. Real threads as provided by Coro are fully
-on thread support for it.
+supported (and enhanced support is available via L<Coro::EV>).
 =head1 FORK
 Most of the "improved" event delivering mechanisms of modern operating
 systems have quite a few problems with fork(2) (to put it bluntly: it is
 1;
 =head1 SEE ALSO
+L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
-L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
+(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
-event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
+loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
-coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
+integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
 event-loop agnostic and portable event driven programming.
 =head1 AUTHOR
    Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.108 by root, Mon Nov 3 12:13:15 2008 UTC vs. Revision 1.144 by root, Sat Sep 6 18:42:18 2014 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.108 by root, Mon Nov 3 12:13:15 2008 UTC vs.
Revision 1.144 by root, Sat Sep 6 18:42:18 2014 UTC