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

Comparing EV/EV.pm (file contents):
Revision 1.79 by root, Sat Dec 22 16:37:07 2007 UTC vs.
Revision 1.98 by root, Sat May 31 23:17:50 2008 UTC

 EV - perl interface to libev, a high performance full-featured event loop
 =head1 SYNOPSIS
-  use EV;
+   use EV;
+   # TIMERS
+   my $w = EV::timer 2, 0, sub {
+      warn "is called after 2s";
+   };
+   my $w = EV::timer 2, 2, sub {
+      warn "is called roughly every 2s (repeat = 2)";
+   };
+   undef $w; # destroy event watcher again
+   my $w = EV::periodic 0, 60, 0, sub {
+      warn "is called every minute, on the minute, exactly";
+   };
+   # IO
+   my $w = EV::io *STDIN, EV::READ, sub {
+      my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
+      warn "stdin is readable, you entered: ", <STDIN>;
+   };
+   # SIGNALS
+   my $w = EV::signal 'QUIT', sub {
+      warn "sigquit received\n";
+   };
+   # CHILD/PID STATUS CHANGES
-  # TIMERS
+   my $w = EV::child 666, 0, sub {
+      my ($w, $revents) = @_;
+      my $status = $w->rstatus;
+   };
-  my $w = EV::timer 2, 0, sub {
-     warn "is called after 2s";
-  };
-  my $w = EV::timer 2, 2, sub {
-     warn "is called roughly every 2s (repeat = 2)";
-  };
-  undef $w; # destroy event watcher again
-  my $w = EV::periodic 0, 60, 0, sub {
-     warn "is called every minute, on the minute, exactly";
-  };
-  # IO
-  my $w = EV::io *STDIN, EV::READ, sub {
-     my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
-     warn "stdin is readable, you entered: ", <STDIN>;
-  };
-  # SIGNALS
-  my $w = EV::signal 'QUIT', sub {
-     warn "sigquit received\n";
-  };
-  # CHILD/PID STATUS CHANGES
-  my $w = EV::child 666, sub {
-     my ($w, $revents) = @_;
-     my $status = $w->rstatus;
-  };
-  # STAT CHANGES
+   # STAT CHANGES
-  my $w = EV::stat "/etc/passwd", 10, sub {
+   my $w = EV::stat "/etc/passwd", 10, sub {
-     my ($w, $revents) = @_;
+      my ($w, $revents) = @_;
-     warn $w->path, " has changed somehow.\n";
+      warn $w->path, " has changed somehow.\n";
-  };
+   };
-  # MAINLOOP
+   # MAINLOOP
-  EV::loop;           # loop until EV::unloop is called or all watchers stop
+   EV::loop;           # 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::loop EV::LOOP_ONESHOT;  # block until at least one event could be handled
-  EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
+   EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
 =head1 DESCRIPTION
 This module provides an interface to libev
 (L<http://software.schmorp.de/pkg/libev.html>). While the documentation
 below is comprehensive, one might also consult the documentation of libev
-itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on
+itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more
-watcher semantics or some discussion on the available backends, or how to
+subtle details on watcher semantics or some discussion on the available
-force a specific backend with C<LIBEV_FLAGS>, or just about in any case
+backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just
-because it has much more detailed information.
+about in any case because it has much more detailed information.
+This module is very fast and scalable. It is actually so fast that you
+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.
 =cut
 package EV;
 use strict;
 BEGIN {
-   our $VERSION = '2.0';
+   our $VERSION = '3.42';
    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
 =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
+this function automatically, at some performance loss (refer to the libev
 documentation).
+=item $loop->loop_verify
+Calls C<ev_verify> to make internal consistency checks (for debugging
+libev) and abort the program if any data structures wree found to be
+corrupted.
 =item $loop = EV::default_loop [$flags]
-Return the default loop (which is a singleton object).
+Return the default loop (which is a singleton object). Since this module
+already creates the default loop with default flags, specifying flags here
+will not have any effect unless you destroy the default loop.
 =back
 =head1 BASIC INTERFACE
 =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.
 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 = EV::io *STDIN, EV::READ, sub {
-     my ($watcher, $revents) = @_;
+      my ($watcher, $revents) = @_;
-     warn "yeah, STDIN should now 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
 events.
 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 { ... };
-   $1000udp_watcher->keepalive (0);
+   $udp_watcher->keepalive (0);
 =item $loop = $w->loop
 Return the loop that this watcher is attached to.
 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.
 time the periodic watcher gets scheduled, the reschedule callback
 ($reschedule_cb) will be called with the watcher as first, and the current
 time as second argument.
 I<This callback MUST NOT stop or destroy this or any other periodic
-watcher, ever>. If you need to stop it, return 1e30 and stop it
+watcher, ever, and MUST NOT call any event loop functions or methods>. If
-afterwards.
+you need to stop it, return 1e30 and stop it afterwards. You may create
+and start a 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 to the second argument). It
+(that is, the lowest time value larger than or equal to to the second
-will usually be called just before the callback will be triggered, but
+argument). It will usually be called just before the callback will be
-might be called at other times, too.
+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
 midnight, to keep the example simple. If you know a way to do it correctly
 in about the same space (without requiring elaborate modules), drop me a
 =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
 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;
+   my $socket_loop;
-  # check wether we use SELECT or POLL _and_ KQUEUE is supported
+   # check wether we use SELECT or POLL _and_ KQUEUE is supported
-  if (
+   if (
-    (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
+     (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
-    && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
+     && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
-  ) {
+   ) {
-    # use kqueue for sockets
+     # use kqueue for sockets
-    $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
+     $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
-  }
+   }
-  # use the default loop otherwise
+   # use the default loop otherwise
-  $socket_loop ||= EV::default_loop;
+   $socket_loop ||= EV::default_loop;
 =over 4
 =item $w = EV::embed $otherloop, $callback
 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
 =head1 SEE ALSO
 L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
 event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
-coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP).
+coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
+event-loop agnostic and portable event driven programming.
 =head1 AUTHOR
- Marc Lehmann <schmorp@schmorp.de>
+   Marc Lehmann <schmorp@schmorp.de>
- http://home.schmorp.de/
+   http://home.schmorp.de/
 =cut

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.79 by root, Sat Dec 22 16:37:07 2007 UTC vs. Revision 1.98 by root, Sat May 31 23:17:50 2008 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.79 by root, Sat Dec 22 16:37:07 2007 UTC vs.
Revision 1.98 by root, Sat May 31 23:17:50 2008 UTC