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

Comparing EV/EV.pm (file contents):
Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC vs.
Revision 1.88 by root, Wed Apr 16 17:08:29 2008 UTC

      warn "sigquit received\n";
   };
   # CHILD/PID STATUS CHANGES
-  my $w = EV::child 666, sub {
+  my $w = EV::child 666, 0, sub {
      my ($w, $revents) = @_;
      my $status = $w->rstatus;
   };
   # STAT CHANGES
 package EV;
 use strict;
 BEGIN {
-   our $VERSION = '2.0';
+   our $VERSION = '3.3';
    use XSLoader;
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 @EV::Idle::ISA     =
 @EV::Prepare::ISA  =
 @EV::Check::ISA    =
 @EV::Embed::ISA    =
 @EV::Fork::ISA     =
+@EV::Async::ISA    =
    "EV::Watcher";
 @EV::Loop::Default::ISA = "EV::Loop";
 =head1 EVENT LOOPS
 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.
+For specific programs you can create additional event loops dynamically.
 =over 4
 =item $loop = new EV::loop [$flags]
 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).
+=item $loop = EV::default_loop [$flags]
+Return the default loop (which is a singleton object).
 =back
 =head1 BASIC INTERFACE
 Must contain a reference to a function that is called when a callback
 throws an exception (with $@ containing the error). The default prints an
 informative message and continues.
 If this callback throws an exception it will be silently ignored.
+=item $flags = EV::supported_backends
+=item $flags = EV::recommended_backends
+=item $flags = EV::embeddable_backends
+Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
+instance of EV, the set of recommended backends (supposed to be good) for
+this platform and the set of embeddable backends (see EMBED WATCHERS).
+=item EV::sleep $seconds
+Block the process for the given number of (fractional) seconds.
 =item $time = EV::time
 Returns the current time in (fractional) seconds since the epoch.
 =item EV::feed_signal_event ($signal)
 Feed a signal event into EV. EV will react to this call as if the signal
 specified by C<$signal> had occured.
+=item EV::set_io_collect_interval $time
+=item $loop->set_io_collect_interval ($time)
+=item EV::set_timeout_collect_interval $time
+=item $loop->set_timeout_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> for
+a more detailed discussion.
 =back
 =head1 WATCHER OBJECTS
 This time simply fires at the wallclock time C<$at> and doesn't repeat. It
 will not adjust when a time jump occurs, that is, if it is to be run
 at January 1st 2011 then it will run when the system time reaches or
 surpasses this time.
-=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
+=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,
 regardless of any time jumps.
 =head3 CHILD WATCHERS - watch out for process status changes
 =over 4
-=item $w = EV::child $pid, $callback
+=item $w = EV::child $pid, $trace, $callback
-=item $w = EV::child_ns $pid, $callback
+=item $w = EV::child_ns $pid, $trace, $callback
-=item $w = $loop->child ($pid, $callback)
+=item $w = $loop->child ($pid, $trace, $callback)
-=item $w = $loop->child_ns ($pid, $callback)
+=item $w = $loop->child_ns ($pid, $trace, $callback)
-Call the callback when a status change for pid C<$pid> (or any pid if
+Call the callback when a status change for pid C<$pid> (or any pid
-C<$pid> is 0) has been received. More precisely: when the process receives
+if C<$pid> is 0) has been received (a status change happens when the
+process terminates or is killed, or, when trace is true, additionally when
+it is stopped or continued). 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.
 It is valid (and fully supported) to install a child watcher after a child
 has exited but before the event loop has started its next iteration (for
 You can have as many pid watchers per pid as you want, they will all be
 called.
 The C<child_ns> variant doesn't start (activate) the newly created watcher.
-=item $w->set ($pid)
+=item $w->set ($pid, $trace)
 Reconfigures the watcher, see the constructor above for details. Can be called at
 any time.
 =item $current_pid = $w->pid
-=item $old_pid = $w->pid ($new_pid)
 Returns the previously set process id and optionally set a new one.
 =item $exit_status = $w->rstatus
 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.
+=back
+=head3 EMBED WATCHERS - when one backend isn't enough...
+This is a rather advanced watcher type that lets you embed one event loop
+into another (currently only IO events are supported in the embedded
+loop, other types of watchers might be handled in a delayed or incorrect
+fashion and must not be used).
+See the libev documentation at
+L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
+for more details.
+In short, this watcher is most useful on BSD systems without working
+kqueue to still be able to handle a large number of sockets:
+  my $socket_loop;
+  # check wether we use SELECT or POLL _and_ KQUEUE is supported
+  if (
+    (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
+    && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
+  ) {
+    # use kqueue for sockets
+    $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
+  }
+  # use the default loop otherwise
+  $socket_loop ||= EV::default_loop;
+=over 4
+=item $w = EV::embed $otherloop, $callback
+=item $w = EV::embed_ns $otherloop, $callback
+=item $w = $loop->embed ($otherloop, $callback)
+=item $w = $loop->embed_ns ($otherloop, $callback)
+Call the callback when the embedded event loop (C<$otherloop>) has any
+I/O activity. The C<$callback> should alwas be specified as C<undef> in
+this version of EV, which means the embedded event loop will be managed
+automatically.
+The C<embed_ns> variant doesn't start (activate) the newly created watcher.
+=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
+neither supports threads nor direct access to 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.
+=over 4
+=item $w = EV::async $callback
+=item $w = EV::async_ns $callback
+=item $w->send
+=item $bool = $w->async_pending
 =back
 =head1 PERL SIGNALS

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC vs. Revision 1.88 by root, Wed Apr 16 17:08:29 2008 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC vs.
Revision 1.88 by root, Wed Apr 16 17:08:29 2008 UTC