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

Comparing EV/EV.pm (file contents):
Revision 1.125 by root, Thu Dec 31 06:59:47 2009 UTC vs.
Revision 1.128 by root, Thu Oct 21 02:46:59 2010 UTC

    # 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
    EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
+=head1 BEFORE YOU START USING THIS MODULE
+If you only need timer, I/O, signal, child and idle watchers and not the
+advanced functionality of this module, consider using L<AnyEvent> instead,
+specifically the simplified API described in L<AE>.
+When used with EV as backend, the L<AE> API is as fast as the native L<EV>
+API, but your programs/modules will still run with many other event loops.
 =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
 package EV;
 use common::sense;
 BEGIN {
-   our $VERSION = '3.9';
+   our $VERSION = '4.00';
    use XSLoader;
    XSLoader::load "EV", $VERSION;
 }
 @EV::IO::ISA       =
 timeout. Otherwise a EV::timer with this value will be started.
 When an error occurs or either the timeout or I/O watcher triggers, then
 the callback will be called with the received event set (in general
 you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
-C<EV::WRITE> and C<EV::TIMEOUT>).
+C<EV::WRITE> and C<EV::TIMER>).
 EV::once doesn't return anything: the watchers stay active till either
 of them triggers, then they will be stopped and freed, and the callback
 invoked.
 Each watcher type has its associated bit in revents, so you can use the
 same callback for multiple watchers. The event mask is named after the
 type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
-(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
+(which can set both EV::READ and EV::WRITE bits).
-uses EV::TIMEOUT).
 In the rare case where one wants to create a watcher but not start it at
 the same time, each constructor has a variant with a trailing C<_ns> in
 its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
 =item $w = $loop->check_ns ($callback)
 Call the callback just after the process wakes up again (after it has
 gathered events), but before any other callbacks have been invoked.
-This is used to integrate other event-based software into the EV
+This can be used to integrate other event-based software into the EV
 mainloop: You register a prepare callback and in there, you create io and
 timer watchers as required by the other software. Here is a real-world
 example of integrating Net::SNMP (with some details left out):
    our @snmp_watcher;
 The callbacks of the created watchers will not be called as the watchers
 are destroyed before this can happen (remember EV::check gets called
 first).
 The C<check_ns> variant doesn't start (activate) the newly created watcher.
+=item EV::CHECK constant issues
+Like all other watcher types, there is a bitmask constant for use in
+C<$revents> and other places. The C<EV::CHECK> is special as it has
+the same name as the C<CHECK> sub called by Perl. This doesn't cause
+big issues on newer perls (beginning with 5.8.9), but it means thatthe
+constant must be I<inlined>, i.e. runtime calls will not work. That means
+that as long as you always C<use EV> and then C<EV::CHECK> you are on the
+safe side.
 =back
 =head3 FORK WATCHERS - the audacity to resume the event loop after a fork

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.125 by root, Thu Dec 31 06:59:47 2009 UTC vs. Revision 1.128 by root, Thu Oct 21 02:46:59 2010 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.125 by root, Thu Dec 31 06:59:47 2009 UTC vs.
Revision 1.128 by root, Thu Oct 21 02:46:59 2010 UTC