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

Comparing EV/EV.pm (file contents):
Revision 1.107 by root, Thu Oct 30 08:10:38 2008 UTC vs.
Revision 1.114 by root, Wed Apr 15 19:35:53 2009 UTC

 no warnings;
 use strict;
 BEGIN {
-   our $VERSION = '3.48';
+   our $VERSION = '3.53';
    use XSLoader;
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 default loop as this is fastest (perl-wise), best supported by other
 modules (e.g. AnyEvent or Coro) and most portable event loop.
 For specific programs you can create additional event loops dynamically.
-If you want to take avdantage of kqueue (which often works properly for
+If you want to take advantage of kqueue (which often works properly for
 sockets only) even though the default loop doesn't enable it, you can
 I<embed> a kqueue loop into the default loop: running the default loop
 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.
 =item $time = EV::now
 =item $time = $loop->now
 Returns the time the last event loop iteration has been started. This
-is the time that (relative) timers are based on, and refering to it is
+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::METHOD_SELECT
+Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
-or EV::METHOD_EPOLL).
+or EV::BACKEND_EPOLL).
 =item EV::loop [$flags]
 =item $loop->loop ([$flags])
 =item $count = EV::loop_count
 =item $count = $loop->loop_count
 Return the number of times the event loop has polled for new
-events. Sometiems useful as a generation counter.
+events. Sometimes useful as a generation counter.
 =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
 =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
 called with at least two arguments: the watcher and a bitmask of received
 events.
 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,
+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
 uses EV::TIMEOUT).
 In the rare case where one wants to create a watcher but not start it at
 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.
-The initial value for keepalive is true (enabled), and you cna change it
+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
 event loop from running just because of that watcher.
       # make the dispatcher handle any new stuff
       ... not shown
    };
 The callbacks of the created watchers will not be called as the watchers
-are destroyed before this cna happen (remember EV::check gets called
+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.
 =back

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.107 by root, Thu Oct 30 08:10:38 2008 UTC vs. Revision 1.114 by root, Wed Apr 15 19:35:53 2009 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.107 by root, Thu Oct 30 08:10:38 2008 UTC vs.
Revision 1.114 by root, Wed Apr 15 19:35:53 2009 UTC