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

Comparing EV/EV.pm (file contents):
Revision 1.67 by root, Sun Dec 9 02:14:23 2007 UTC vs.
Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC

 package EV;
 use strict;
 BEGIN {
-   our $VERSION = '1.72';
+   our $VERSION = '2.0';
    use XSLoader;
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 @EV::Check::ISA    =
 @EV::Embed::ISA    =
 @EV::Fork::ISA     =
    "EV::Watcher";
+@EV::Loop::Default::ISA = "EV::Loop";
+=head1 EVENT LOOPS
+EV supports multiple event loops: There is a single "default event loop"
+that can handle everything including signals and child watchers, and any
+number of "dynamic event loops" that can use different backends (with
+various limitations), but no child and signal watchers.
+You do not have to do anything to create the default event loop: When
+the module is loaded a suitable backend is selected on the premise of
+selecting a working backend (which for example rules out kqueue on most
+BSDs). Modules should, unless they have "special needs" always use the
+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 cna create additional event loops dynamically.
+=over 4
+=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>)
+for more info.
+The loop will automatically be destroyed when it is no longer referenced
+by any watcher and the loop object goes out of scope.
+Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop
+is protected by this module.
+=item $loop->loop_fork
+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 fucntion automatically, at some performance loss (refer to the libev
+documentation).
+=back
 =head1 BASIC INTERFACE
 =over 4
 =item $EV::DIED
 Returns the current time in (fractional) seconds since the epoch.
 =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
 usually faster then calling EV::time.
-=item $method = EV::method
+=item $backend = EV::backend
+=item $backend = $loop->backend
 Returns an integer describing the backend used by libev (EV::METHOD_SELECT
 or EV::METHOD_EPOLL).
 =item EV::loop [$flags]
+=item $loop->loop ([$flags])
 Begin checking for events and calling callbacks. It returns when a
 callback calls EV::unloop.
 The $flags argument can be one of the following:
    EV::LOOP_ONESHOT   block at most once (wait, but do not loop)
    EV::LOOP_NONBLOCK  do not block at all (fetch/handle events but do not wait)
 =item EV::unloop [$how]
+=item $loop->unloop ([$how])
 When called with no arguments or an argument of EV::UNLOOP_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
 fast as possible.
 =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.
 =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
+=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
 This function rolls together an I/O and a timer watcher for a single
 one-shot event without the need for managing a watcher object.
 If C<$fh_or_undef> is a filehandle or file descriptor, then 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.
 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>,
+you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
 C<EV::WRITE> and C<EV::TIMEOUT>).
 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 $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)
 specified by C<$signal> had occured.
 =back
-=head2 WATCHER OBJECTS
+=head1 WATCHER OBJECTS
 A watcher is an object that gets created to record your interest in some
 event. For instance, if you want to wait for STDIN to become readable, you
 would create an EV::io watcher for that:
   my $watcher = EV::io *STDIN, EV::READ, sub {
      my ($watcher, $revents) = @_;
-     warn "yeah, STDIN should not be readable without blocking!\n"
+     warn "yeah, STDIN should now be readable without blocking!\n"
   };
 All watchers can be active (waiting for events) or inactive (paused). Only
 active watchers will have their callbacks invoked. All callbacks will be
 called with at least two arguments: the watcher and a bitmask of received
 Feed some events on this watcher into EV. EV will react to this call as if
 the watcher had received the given C<$revents> mask.
 =item $revents = $w->clear_pending
-If the watcher is pending, this function returns clears its pending status
+If the watcher is pending, this function clears its pending status and
-and returns its C<$revents> bitset (as if its callback was invoked). If the
+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
 (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),
 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 you the module
+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
 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
 because you happen to have this long-running UDP port watcher.
 Example: Register an I/O watcher for some UDP socket but do not keep the
 event loop from running just because of that watcher.
    my $udp_socket = ...
    my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
-   $udp_watcher->keepalive (0);
+   $1000udp_watcher->keepalive (0);
-=back
+=item $loop = $w->loop
+Return the loop that this watcher is attached to.
+=back
-=head2 WATCHER TYPES
+=head1 WATCHER TYPES
 Each of the following subsections describes a single watcher type.
 =head3 I/O WATCHERS - is this file descriptor readable or writable?
 =over 4
 =item $w = EV::io $fileno_or_fh, $eventmask, $callback
 =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
+=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
+=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
 As long as the returned watcher object is alive, call the C<$callback>
 when at least one of events specified in C<$eventmask> occurs.
 The $eventmask can be one or more of these constants ORed together:
 =over 4
 =item $w = EV::timer $after, $repeat, $callback
 =item $w = EV::timer_ns $after, $repeat, $callback
+=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
 C<$repeat> is non-zero, the timer will be restarted (with the $repeat
 value as $after) after the callback returns.
 =over 4
 =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
 =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
+=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
+=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
 Similar to EV::timer, but is not based on relative timeouts but on
 absolute times. Apart from creating "simple" timers that trigger "at" the
 specified time, it can also be used for non-drifting absolute timers and
 more complex, cron-like, setups that are not adversely affected by time
 =item $w->again
 Simply stops and starts the watcher again.
+=item $time = $w->at
+Return the time that the watcher is expected to trigger next.
 =back
 =head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
 =item $w = EV::child $pid, $callback
 =item $w = EV::child_ns $pid, $callback
+=item $w = $loop->child ($pid, $callback)
+=item $w = $loop->child_ns ($pid, $callback)
 Call the callback when a status change for pid C<$pid> (or any pid if
 C<$pid> is 0) has been received. More precisely: when the process receives
 a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
 changed/zombie children and call the callback.
 =item $w = EV::stat $path, $interval, $callback
 =item $w = EV::stat_ns $path, $interval, $callback
+=item $w = $loop->stat ($path, $interval, $callback)
+=item $w = $loop->stat_ns ($path, $interval, $callback)
 Call the callback when a file status change has been detected on
 C<$path>. The C<$path> does not need to exist, changing from "path exists"
 to "path does not exist" is a status change like any other.
 The C<$interval> is a recommended polling interval for systems where
 =over 4
 =item $w = EV::idle $callback
 =item $w = EV::idle_ns $callback
+=item $w = $loop->idle ($callback)
+=item $w = $loop->idle_ns ($callback)
 Call the callback when there are no other pending watchers of the same or
 higher priority (excluding check, prepare and other idle watchers of the
 same or lower priority, of course). They are called idle watchers because
 when the watcher is the highest priority pending event in the process, the
 =item $w = EV::prepare $callback
 =item $w = EV::prepare_ns $callback
+=item $w = $loop->prepare ($callback)
+=item $w = $loop->prepare_ns ($callback)
 Call the callback just before the process would block. You can still
 create/modify any watchers at this point.
 See the EV::check watcher, below, for explanations and an example.
 =over 4
 =item $w = EV::check $callback
 =item $w = EV::check_ns $callback
+=item $w = $loop->check ($callback)
+=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
 =item $w = EV::fork $callback
 =item $w = EV::fork_ns $callback
+=item $w = $loop->fork ($callback)
+=item $w = $loop->fork_ns ($callback)
 Call the callback before the event loop is resumed in the child process
 after a fork.
 The C<fork_ns> variant doesn't start (activate) the newly created watcher.
 to be called on every event loop iteration by installing a C<EV::check>
 watcher:
    my $async_check = EV::check sub { };
-This ensures that perl shortly gets into control for a short time, and
+This ensures that perl gets into control for a short time to handle any
-also ensures slower overall operation.
+pending signals, and also ensures (slightly) slower overall operation.
 =head1 THREADS
 Threads 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
 our $DIED = sub {
    warn "EV: error in callback (ignoring): $@";
 };
 default_loop
-   or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
+   or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
 1;
 =head1 SEE ALSO
-L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as
+L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
-event loop), L<Coro::EV> (efficient coroutines with EV).
+event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
+coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP).
 =head1 AUTHOR
  Marc Lehmann <schmorp@schmorp.de>
  http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.67 by root, Sun Dec 9 02:14:23 2007 UTC vs. Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.67 by root, Sun Dec 9 02:14:23 2007 UTC vs.
Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC