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

Comparing EV/EV.pm (file contents):
Revision 1.53 by root, Sat Nov 24 16:57:30 2007 UTC vs.
Revision 1.54 by root, Tue Nov 27 07:27:10 2007 UTC

   # CHILD/PID STATUS CHANGES
   my $w = EV::child 666, sub {
      my ($w, $revents) = @_;
      my $status = $w->rstatus;
+  };
+  # STAT CHANGES
+  my $w = EV::stat "/etc/passwd", 10, sub {
+     my ($w, $revents) = @_;
+     warn $w->path, " has changed somehow.\n";
   };
   # MAINLOOP
   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
 package EV;
 use strict;
 BEGIN {
-   our $VERSION = '1.3';
+   our $VERSION = '1.4';
    use XSLoader;
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 @EV::Periodic::ISA =
 @EV::Signal::ISA   =
 @EV::Idle::ISA     =
 @EV::Prepare::ISA  =
 @EV::Check::ISA    =
+@EV::Child::ISA    =
+@EV::Embed::ISA    =
-@EV::Child::ISA    = "EV::Watcher";
+@EV::Stat::ISA     = "EV::Watcher";
 =head1 BASIC INTERFACE
 =over 4
 of them triggers, then they will be stopped and freed, and the callback
 invoked.
 =back
-=head2 WATCHER
+=head2 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:
 Also, all methods changing some aspect of a watcher (->set, ->priority,
 ->fh and so on) automatically stop and start it again if it is active,
 which means pending events get lost.
-=head2 WATCHER TYPES
+=head2 COMMON WATCHER METHODS
-Now lets move to the existing watcher types and asociated methods.
+This section lists methods common to all watchers.
-The following methods are available for all watchers. Then followes a
-description of each watcher constructor (EV::io, EV::timer, EV::periodic,
-EV::signal, EV::child, EV::idle, EV::prepare and EV::check), followed by
-any type-specific methods (if any).
 =over 4
 =item $w->start
    my $udp_socket = ...
    my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
    $udp_watcher->keepalive (0);
+=back
+=head2 WATCHER TYPES
+Each of the following subsections describes a single watcher type.
+=head3 IO 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
 As long as the returned watcher object is alive, call the C<$callback>
-when the events specified in C<$eventmask>.
+when at least one of events specified in C<$eventmask> occurs.
 The $eventmask can be one or more of these constants ORed together:
   EV::READ     wait until read() wouldn't block anymore
   EV::WRITE    wait until write() wouldn't block anymore
 =item $old_eventmask = $w->events ($new_eventmask)
 Returns the previously set event mask and optionally set a new one.
+=back
+=head3 TIMER WATCHERS - relative and optionally repeating timeouts
+=over 4
 =item $w = EV::timer $after, $repeat, $callback
 =item $w = EV::timer_ns $after, $repeat, $callback
 The C<timer_ns> variant doesn't start (activate) the newly created watcher.
 =item $w->set ($after, $repeat)
-Reconfigures the watcher, see the constructor above for details. Can be at
+Reconfigures the watcher, see the constructor above for details. Can be called at
 any time.
 =item $w->again
 Similar to the C<start> method, but has special semantics for repeating timers:
 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.
+=back
+=head3 PERIODIC WATCHERS - to cron or not to cron?
+=over 4
 =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
 =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
 The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
 =item $w->set ($at, $interval, $reschedule_cb)
-Reconfigures the watcher, see the constructor above for details. Can be at
+Reconfigures the watcher, see the constructor above for details. Can be called at
 any time.
 =item $w->again
 Simply stops and starts the watcher again.
+=back
+=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
+=over 4
 =item $w = EV::signal $signal, $callback
 =item $w = EV::signal_ns $signal, $callback
-Call the callback when $signal is received (the signal can be specified
+Call the callback when $signal is received (the signal can be specified by
-by number or by name, just as with kill or %SIG).
+number or by name, just as with C<kill> or C<%SIG>).
 EV will grab the signal for the process (the kernel only allows one
 component to receive a signal at a time) when you start a signal watcher,
 and removes it again when you stop it. Perl does the same when you
-add/remove callbacks to %SIG, so watch out.
+add/remove callbacks to C<%SIG>, so watch out.
 You can have as many signal watchers per signal as you want.
 The C<signal_ns> variant doesn't start (activate) the newly created watcher.
 =item $w->set ($signal)
-Reconfigures the watcher, see the constructor above for details. Can be at
+Reconfigures the watcher, see the constructor above for details. Can be
-any time.
+called at any time.
 =item $current_signum = $w->signal
 =item $old_signum = $w->signal ($new_signal)
 Returns the previously set signal (always as a number not name) and
 optionally set a new one.
+=back
+=head3 CHILD WATCHERS - watch out for process status changes
+=over 4
 =item $w = EV::child $pid, $callback
 =item $w = EV::child_ns $pid, $callback
-Call the callback when a status change for pid C<$pid> (or any pid
+Call the callback when a status change for pid C<$pid> (or any pid if
-if C<$pid> is 0) has been received. More precisely: when the process
+C<$pid> is 0) has been received. More precisely: when the process receives
-receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all
+a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
 changed/zombie children and call the callback.
-You can access both status and pid by using the C<rstatus> and C<rpid>
+It is valid (and fully supported) to install a child watcher after a child
-methods on the watcher object.
+has exited but before the event loop has started its next iteration (for
+example, first you C<fork>, then the new child process might exit, and
+only then do you install a child watcher in the parent for the new pid).
+You can access both exit (or tracing) status and pid by using the
+C<rstatus> and C<rpid> methods on the watcher object.
-You can have as many pid watchers per pid as you want.
+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)
-Reconfigures the watcher, see the constructor above for details. Can be at
+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)
 =item $pid = $w->rpid
 Return the pid of the awaited child (useful when you have installed a
 watcher for all pids).
+=back
+=head3 IDLE WATCHERS - when you've got nothing better to do...
+=over 4
 =item $w = EV::idle $callback
 =item $w = EV::idle_ns $callback
 The process will not block as long as any idle watchers are active, and
 they will be called repeatedly until stopped.
 The C<idle_ns> variant doesn't start (activate) the newly created watcher.
+=back
+=head3 PREPARE WATCHERS - customise your event loop!
+=over 4
 =item $w = EV::prepare $callback
 =item $w = EV::prepare_ns $callback
 See the EV::check watcher, below, for explanations and an example.
 The C<prepare_ns> variant doesn't start (activate) the newly created watcher.
+=back
+=head3 CHECK WATCHERS - customise your event loop even more!
+=over 4
 =item $w = EV::check $callback
 =item $w = EV::check_ns $callback
 first).
 The C<check_ns> variant doesn't start (activate) the newly created watcher.
 =back
+=head3 STAT WATCHERS - did the file stats just change?
+=over 4
+=item $w = EV::stat $path, $interval, $callback
+=item $w = EV::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
+OS-supported change notifications don't exist or are not supported. If
+you use C<0> then an unspecified default is used (which is highly
+recommended!), which is to be expected to be around five seconds usually.
+This watcher type is not meant for massive numbers of stat watchers,
+as even with OS-supported change notifications, this can be
+resource-intensive.
+The C<stat_ns> variant doesn't start (activate) the newly created watcher.
+=item $w->set ($path, $interval)
+Reconfigures the watcher, see the constructor above for details. Can be
+called at any time.
+=item $current_path = $w->path
+=item $old_path = $w->path ($new_path)
+Returns the previously set path and optionally set a new one.
+=item $current_interval = $w->interval
+=item $old_interval = $w->interval ($new_interval)
+Returns the previously set interval and optionally set a new one. Can be
+used to query the actual interval used.
+=back
 =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
 1;
 =head1 SEE ALSO
-  L<EV::DNS>.
+L<EV::DNS>.
 =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.53 by root, Sat Nov 24 16:57:30 2007 UTC vs. Revision 1.54 by root, Tue Nov 27 07:27:10 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.53 by root, Sat Nov 24 16:57:30 2007 UTC vs.
Revision 1.54 by root, Tue Nov 27 07:27:10 2007 UTC