--- EV/EV.pm 2007/11/24 16:57:30 1.53 +++ EV/EV.pm 2007/11/27 07:27:10 1.54 @@ -41,6 +41,12 @@ 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 @@ -63,7 +69,7 @@ use strict; BEGIN { - our $VERSION = '1.3'; + our $VERSION = '1.4'; use XSLoader; XSLoader::load "EV", $VERSION; } @@ -75,7 +81,9 @@ @EV::Idle::ISA = @EV::Prepare::ISA = @EV::Check::ISA = -@EV::Child::ISA = "EV::Watcher"; +@EV::Child::ISA = +@EV::Embed::ISA = +@EV::Stat::ISA = "EV::Watcher"; =head1 BASIC INTERFACE @@ -148,7 +156,7 @@ =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 @@ -183,14 +191,9 @@ ->fh and so on) automatically stop and start it again if it is active, which means pending events get lost. -=head2 WATCHER TYPES - -Now lets move to the existing watcher types and asociated methods. +=head2 COMMON WATCHER METHODS -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). +This section lists methods common to all watchers. =over 4 @@ -276,12 +279,23 @@ 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: @@ -307,6 +321,12 @@ 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 @@ -330,7 +350,7 @@ =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 @@ -351,6 +371,12 @@ C<$repeat>, and then, in the read/write watcher, run the C 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 @@ -432,25 +458,31 @@ =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 -by number or by name, just as with kill or %SIG). +Call the callback when $signal is received (the signal can be specified by +number or by name, just as with C 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. @@ -458,8 +490,8 @@ =item $w->set ($signal) -Reconfigures the watcher, see the constructor above for details. Can be at -any time. +Reconfigures the watcher, see the constructor above for details. Can be +called at any time. =item $current_signum = $w->signal @@ -468,26 +500,38 @@ 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 -if C<$pid> is 0) has been received. More precisely: when the process -receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all +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, 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 and C -methods on the watcher object. +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 +example, first you C, 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 and C 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 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 @@ -506,6 +550,12 @@ 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 @@ -519,6 +569,12 @@ The C variant doesn't start (activate) the newly created watcher. +=back + + +=head3 PREPARE WATCHERS - customise your event loop! + +=over 4 =item $w = EV::prepare $callback @@ -531,6 +587,12 @@ The C 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 @@ -586,6 +648,50 @@ =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 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 @@ -622,7 +728,7 @@ =head1 SEE ALSO - L. +L. =head1 AUTHOR