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

Comparing EV/EV.pm (file contents):
Revision 1.127 by root, Sun Mar 28 15:48:21 2010 UTC vs.
Revision 1.164 by root, Fri Jan 24 13:22:22 2020 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::break 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,
 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;
 use common::sense;
 BEGIN {
-   our $VERSION = '4.00';
+   our $VERSION = '4.32';
    use XSLoader;
+   local $^W = 0; # avoid spurious warning
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 @EV::Timer::ISA    =
 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.
 =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>.
+is usually done automatically within C<EV::run>.
 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 $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::break or the flags 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 return value 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.
+innermost call to EV::run 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::run 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)
 | EV::WRITE>, indicating the type of I/O event you want to wait for. If
 you do not want to wait for some I/O event, specify C<undef> for
 C<$fh_or_undef> and C<0> for C<$events>).
 If timeout is C<undef> or negative, then there will be no
-timeout. Otherwise a EV::timer with this value will be started.
+timeout. Otherwise an C<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::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
+for custom signal implementations.
 =item EV::set_io_collect_interval $time
 =item $loop->set_io_collect_interval ($time)
 returns its C<$revents> bitset (as if its callback was invoked). If the
 watcher isn't pending it does nothing and returns C<0>.
 =item $previous_state = $w->keepalive ($bool)
-Normally, C<EV::loop> will return when there are no active watchers
+Normally, C<EV::run> will return when there are no active watchers
 (which is a "deadlock" because no progress can be made anymore). This is
 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
+call C<EV::run> 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
+that calls C<EV::run> (usually the main program) is not the same module
 as a long-living watcher (for example a DNS client module written by
 somebody else even). Then you might want any outstanding requests to be
-handled, but you would not want to keep C<EV::loop> from returning just
+handled, but you would not want to keep C<EV::run> from returning just
 because you happen to have this long-running UDP port watcher.
 In this case you can clear the keepalive status, which means that even
-though your watcher is active, it won't keep C<EV::loop> from returning.
+though your watcher is active, it won't keep C<EV::run> from returning.
 The initial value for keepalive is true (enabled), and you can change it
 any time.
 Example: Register an I/O watcher for some UDP socket but do not keep the
 =item $w = $loop->timer ($after, $repeat, $callback)
 =item $w = $loop->timer_ns ($after, $repeat, $callback)
-Calls the callback after C<$after> seconds (which may be fractional). If
+Calls the callback after C<$after> seconds (which may be fractional or
-C<$repeat> is non-zero, the timer will be restarted (with the $repeat
+negative). If C<$repeat> is non-zero, the timer will be restarted (with
-value as $after) after the callback returns.
+the $repeat value as $after) after the callback returns.
 This means that the callback would be called roughly after C<$after>
 seconds, and then every C<$repeat> seconds. The timer does his best not
 to drift, but it will not invoke the timer more often then once per event
 loop iteration, and might drift in other cases. If that isn't acceptable,
 in front of the machine while the timer is running and changes the system
 clock, the timer will nevertheless run (roughly) the same time.
 The C<timer_ns> variant doesn't start (activate) the newly created watcher.
-=item $w->set ($after, $repeat)
+=item $w->set ($after, $repeat = 0)
 Reconfigures the watcher, see the constructor above for details. Can be called at
 any time.
 =item $w->again
+=item $w->again ($repeat)
 Similar to the C<start> method, but has special semantics for repeating timers:
 If the timer is active and non-repeating, it will be stopped.
 This behaviour is useful when you have a timeout for some IO
 operation. You create a timer object with the same value for C<$after> and
 C<$repeat>, and then, in the read/write watcher, run the C<again> method
 on the timeout.
+If called with a C<$repeat> argument, then it uses this a timer repeat
+value.
+=item $after = $w->remaining
+Calculates and returns the remaining time till the timer will fire.
+=item $repeat = $w->repeat
+=item $old_repeat = $w->repeat ($new_repeat)
+Returns the current value of the repeat attribute and optionally sets a
+new one. Setting the new one will not restart the watcher - if the watcher
+is active, the new repeat value is used whenever it expires next.
 =back
 =head3 PERIODIC WATCHERS - to cron or not to cron?
 surpasses this time.
 =item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
 In this mode the watcher will always be scheduled to time out at the
-next C<$at + N * $interval> time (for some integer N) and then repeat,
+next C<$at + N * $interval> time (for the lowest integer N) and then repeat,
-regardless of any time jumps.
+regardless of any time jumps. Note that, since C<N> can be negative, the
+first trigger can happen before C<$at>.
 This can be used to create timers that do not drift with respect to system
 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
 time as second argument.
 I<This callback MUST NOT stop or destroy this or any other periodic
 watcher, ever, and MUST NOT call any event loop functions or methods>. If
 you need to stop it, return 1e30 and stop it afterwards. You may create
-and start a C<EV::prepare> watcher for this task.
+and start an C<EV::prepare> watcher for this task.
 It must return the next time to trigger, based on the passed time value
 (that is, the lowest time value larger than or equal to to the second
 argument). It will usually be called just before the callback will be
 triggered, but might be called at other times, too.
 This can be used to create very complex timers, such as a timer that
-triggers on each midnight, local time (actually 24 hours after the last
+triggers on each midnight, local time (actually one day after the last
-midnight, to keep the example simple. If you know a way to do it correctly
+midnight, to keep the example simple):
-in about the same space (without requiring elaborate modules), drop me a
-note :):
    my $daily = EV::periodic 0, 0, sub {
       my ($w, $now) = @_;
       use Time::Local ();
       my (undef, undef, undef, $d, $m, $y) = localtime $now;
-      86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
+      Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y
    }, sub {
       print "it's midnight or likely shortly after, now\n";
    };
 =back
 Simply stops and starts the watcher again.
 =item $time = $w->at
 Return the time that the watcher is expected to trigger next.
+=item $offset = $w->offset
+=item $old_offset = $w->offset ($new_offset)
+Returns the current value of the offset attribute and optionally sets a
+new one. Setting the new one will not restart the watcher - if the watcher
+is active, the new offset value is used whenever it expires next.
+=item $interval = $w->interval
+=item $old_interval = $w->interval ($new_interval)
+See above, for the interval attribute.
+=item $reschedule_cb = $w->reschedule_cb
+=item $old_reschedule_cb = $w->reschedule_cb ($new_reschedule_cb)
+See above, for the reschedule callback.
 =back
 =head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
 =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
 =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
 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.127 by root, Sun Mar 28 15:48:21 2010 UTC vs. Revision 1.164 by root, Fri Jan 24 13:22:22 2020 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.127 by root, Sun Mar 28 15:48:21 2010 UTC vs.
Revision 1.164 by root, Fri Jan 24 13:22:22 2020 UTC