[ViewVC] Diff of: cvs/cvsroot/Async-Interrupt/Interrupt.pm

Comparing cvsroot/Async-Interrupt/Interrupt.pm (file contents):
Revision 1.20 by root, Tue Jul 28 13:35:57 2009 UTC vs.
Revision 1.22 by root, Wed Aug 5 11:51:53 2009 UTC

    # the next line forces initialisation of internal
    # signal handling variables, otherwise, PL_sig_pending
    # etc. will be null pointers.
    $SIG{KILL} = sub { };
-   our $VERSION = '1.0';
+   our $VERSION = '1.01';
    require XSLoader;
    XSLoader::load ("Async::Interrupt", $VERSION);
 }
 =item $epipe->drain
 Drain (empty) the pipe.
+=item ($c_func, $c_arg) = $epipe->drain_func
+Returns a function pointer and C<void *> argument that can be called to
+have the effect of C<< $epipe->drain >> on the XS level.
+It has the following prototype and needs to be passed the specified
+C<$c_arg>, which is a C<void *> cast to C<IV>:
+   void (*c_func) (void *c_arg)
+An example call would look like:
+   c_func (c_arg);
 =item $epipe->renew
 Recreates the pipe (useful after a fork). The reading side will not change
 it's file descriptor number, but the writing side might.
+=item $epipe->wait
+This method blocks the process until there are events on the pipe. This is
+not a very event-based or ncie way of usign an event pipe, but it can be
+occasionally useful.
 =back
 =cut
 1;
-=head1 EXAMPLE
-There really should be a complete C/XS example. Bug me about it. Better
-yet, create one.
 =head1 IMPLEMENTATION DETAILS AND LIMITATIONS
 This module works by "hijacking" SIGKILL, which is guaranteed to always
 exist, but also cannot be caught, so is always available.

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