[ViewVC] Diff of: cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.270 by root, Fri Sep 18 21:02:12 2009 UTC vs.
Revision 1.316 by root, Fri Oct 22 09:34:01 2010 UTC

      puts ("stdin ready");
      // for one-shot events, one must manually stop the watcher
      // with its corresponding stop function.
      ev_io_stop (EV_A_ w);
-     // this causes all nested ev_loop's to stop iterating
+     // this causes all nested ev_run's to stop iterating
-     ev_unloop (EV_A_ EVUNLOOP_ALL);
+     ev_break (EV_A_ EVBREAK_ALL);
    }
    // another callback, this time for a time-out
    static void
    timeout_cb (EV_P_ ev_timer *w, int revents)
    {
      puts ("timeout");
-     // this causes the innermost ev_loop to stop iterating
+     // this causes the innermost ev_run to stop iterating
-     ev_unloop (EV_A_ EVUNLOOP_ONE);
+     ev_break (EV_A_ EVBREAK_ONE);
    }
    int
    main (void)
    {
      // simple non-repeating 5.5 second timeout
      ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
      ev_timer_start (loop, &timeout_watcher);
      // now wait for events to arrive
-     ev_loop (loop, 0);
+     ev_run (loop, 0);
      // unloop was called, so exit
      return 0;
    }
 While this document tries to be as complete as possible in documenting
 libev, its usage and the rationale behind its design, it is not a tutorial
 on event-based programming, nor will it introduce event-based programming
 with libev.
-Familarity with event based programming techniques in general is assumed
+Familiarity with event based programming techniques in general is assumed
 throughout this document.
 =head1 ABOUT LIBEV
 Libev is an event loop: you register interest in certain events (such as a
 Libev is very configurable. In this manual the default (and most common)
 configuration will be described, which supports multiple event loops. For
 more info about various configuration options please have a look at
 B<EMBED> section in this manual. If libev was configured without support
 for multiple event loops, then all functions taking an initial argument of
-name C<loop> (which is always of type C<ev_loop *>) will not have
+name C<loop> (which is always of type C<struct ev_loop *>) will not have
 this argument.
 =head2 TIME REPRESENTATION
 Libev represents time as a single floating point number, representing
-the (fractional) number of seconds since the (POSIX) epoch (somewhere
+the (fractional) number of seconds since the (POSIX) epoch (in practise
-near the beginning of 1970, details are complicated, don't ask). This
+somewhere near the beginning of 1970, details are complicated, don't
-type is called C<ev_tstamp>, which is what you should use too. It usually
+ask). This type is called C<ev_tstamp>, which is what you should use
-aliases to the C<double> type in C. When you need to do any calculations
+too. It usually aliases to the C<double> type in C. When you need to do
-on it, you should treat it as some floating point value. Unlike the name
+any calculations on it, you should treat it as some floating point value.
-component C<stamp> might indicate, it is also used for time differences
+Unlike the name component C<stamp> might indicate, it is also used for
-throughout libev.
+time differences (e.g. delays) throughout libev.
 =head1 ERROR HANDLING
 Libev knows three classes of errors: operating system errors, usage errors
 and internal errors (bugs).
 as this indicates an incompatible change. Minor versions are usually
 compatible to older versions, so a larger minor version alone is usually
 not a problem.
 Example: Make sure we haven't accidentally been linked against the wrong
-version.
+version (note, however, that this will not detect ABI mismatches :).
    assert (("libev version mismatch",
             ev_version_major () == EV_VERSION_MAJOR
             && ev_version_minor () >= EV_VERSION_MINOR));
 =back
 =head1 FUNCTIONS CONTROLLING THE EVENT LOOP
-An event loop is described by a C<struct ev_loop *> (the C<struct>
+An event loop is described by a C<struct ev_loop *> (the C<struct> is
-is I<not> optional in this case, as there is also an C<ev_loop>
+I<not> optional in this case unless libev 3 compatibility is disabled, as
-I<function>).
+libev 3 had an C<ev_loop> function colliding with the struct name).
 The library knows two types of such loops, the I<default> loop, which
-supports signals and child events, and dynamically created loops which do
+supports signals and child events, and dynamically created event loops
-not.
+which do not.
 =over 4
 =item struct ev_loop *ev_default_loop (unsigned int flags)
 useful to try out specific backends to test their performance, or to work
 around bugs.
 =item C<EVFLAG_FORKCHECK>
-Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
+Instead of calling C<ev_loop_fork> manually after a fork, you can also
-a fork, you can also make libev check for a fork in each iteration by
+make libev check for a fork in each iteration by enabling this flag.
-enabling this flag.
 This works by calling C<getpid ()> on every iteration of the loop,
 and thus this might slow down your event loop if you do a lot of loop
 iterations and little real work, but is usually not noticeable (on my
 GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
 When this flag is specified, then libev will not attempt to use the
 I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
 testing, this flag can be useful to conserve inotify file descriptors, as
 otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
-=item C<EVFLAG_NOSIGFD>
+=item C<EVFLAG_SIGNALFD>
-When this flag is specified, then libev will not attempt to use the
+When this flag is specified, then libev will attempt to use the
-I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is
+I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API
-probably only useful to work around any bugs in libev. Consequently, this
+delivers signals synchronously, which makes it both faster and might make
-flag might go away once the signalfd functionality is considered stable,
+it possible to get the queued signal data. It can also simplify signal
-so it's useful mostly in environment variables and not in program code.
+handling with threads, as long as you properly block signals in your
+threads that are not interested in handling them.
+Signalfd will not be used by default as this changes your signal mask, and
+there are a lot of shoddy libraries and programs (glib's threadpool for
+example) that can't properly initialise their signal masks.
 =item C<EVBACKEND_SELECT>  (value 1, portable select backend)
 This is your standard select(2) backend. Not I<completely> standard, as
 libev tries to roll its own fd_set with no limits on the number of fds,
 This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
 C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
 =item C<EVBACKEND_EPOLL>   (value 4, Linux)
+Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
+kernels).
 For few fds, this backend is a bit little slower than poll and select,
 but it scales phenomenally better. While poll and select usually scale
 like O(total_fds) where n is the total number of fds (or the highest fd),
 epoll scales either O(1) or O(active_fds).
 of course I<doesn't>, and epoll just loves to report events for totally
 I<different> file descriptors (even already closed ones, so one cannot
 even remove them from the set) than registered in the set (especially
 on SMP systems). Libev tries to counter these spurious notifications by
 employing an additional generation counter and comparing that against the
-events to filter out spurious ones, recreating the set when required.
+events to filter out spurious ones, recreating the set when required. Last
+not least, it also refuses to work with some file descriptors which work
+perfectly fine with C<select> (files, many character devices...).
 While stopping, setting and starting an I/O watcher in the same iteration
 will result in some caching, there is still a system call per such
 incident (because the same I<file descriptor> could point to a different
 I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
    ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
 =item struct ev_loop *ev_loop_new (unsigned int flags)
 Similar to C<ev_default_loop>, but always creates a new event loop that is
-always distinct from the default loop. Unlike the default loop, it cannot
+always distinct from the default loop.
-handle signal and child watchers, and attempts to do so will be greeted by
-undefined behaviour (or a failed assertion if assertions are enabled).
-Note that this function I<is> thread-safe, and the recommended way to use
+Note that this function I<is> thread-safe, and one common way to use
 libev with threads is indeed to create one loop per thread, and using the
 default loop in the "main" or "initial" thread.
 Example: Try to create a event loop that uses epoll and nothing else.
    if (!epoller)
      fatal ("no epoll found here, maybe it hides under your chair");
 =item ev_default_destroy ()
-Destroys the default loop again (frees all memory and kernel state
+Destroys the default loop (frees all memory and kernel state etc.). None
-etc.). None of the active event watchers will be stopped in the normal
+of the active event watchers will be stopped in the normal sense, so
-sense, so e.g. C<ev_is_active> might still return true. It is your
+e.g. C<ev_is_active> might still return true. It is your responsibility to
-responsibility to either stop all watchers cleanly yourself I<before>
+either stop all watchers cleanly yourself I<before> calling this function,
-calling this function, or cope with the fact afterwards (which is usually
+or cope with the fact afterwards (which is usually the easiest thing, you
-the easiest thing, you can just ignore the watchers and/or C<free ()> them
+can just ignore the watchers and/or C<free ()> them for example).
-for example).
 Note that certain global state, such as signal state (and installed signal
 handlers), will not be freed by this function, and related watchers (such
 as signal and child watchers) would need to be stopped manually.
 Like C<ev_default_destroy>, but destroys an event loop created by an
 earlier call to C<ev_loop_new>.
 =item ev_default_fork ()
-This function sets a flag that causes subsequent C<ev_loop> iterations
+This function sets a flag that causes subsequent C<ev_run> iterations
 to reinitialise the kernel state for backends that have one. Despite the
 name, you can call it anytime, but it makes most sense after forking, in
 the child process (or both child and parent, but that again makes little
 sense). You I<must> call it in the child before using any of the libev
-functions, and it will only take effect at the next C<ev_loop> iteration.
+functions, and it will only take effect at the next C<ev_run> iteration.
+Again, you I<have> to call it on I<any> loop that you want to re-use after
+a fork, I<even if you do not plan to use the loop in the parent>. This is
+because some kernel interfaces *cough* I<kqueue> *cough* do funny things
+during fork.
 On the other hand, you only need to call this function in the child
-process if and only if you want to use the event library in the child. If
+process if and only if you want to use the event loop in the child. If
-you just fork+exec, you don't have to call it at all.
+you just fork+exec or create a new loop in the child, you don't have to
+call it at all (in fact, C<epoll> is so badly broken that it makes a
+difference, but libev will usually detect this case on its own and do a
+costly reset of the backend).
 The function itself is quite fast and it's usually not a problem to call
 it just in case after a fork. To make this easy, the function will fit in
 quite nicely into a call to C<pthread_atfork>:
 =item ev_loop_fork (loop)
 Like C<ev_default_fork>, but acts on an event loop created by
 C<ev_loop_new>. Yes, you have to call this on every allocated event loop
-after fork that you want to re-use in the child, and how you do this is
+after fork that you want to re-use in the child, and how you keep track of
-entirely your own problem.
+them is entirely your own problem.
 =item int ev_is_default_loop (loop)
 Returns true when the given loop is, in fact, the default loop, and false
 otherwise.
-=item unsigned int ev_loop_count (loop)
+=item unsigned int ev_iteration (loop)
-Returns the count of loop iterations for the loop, which is identical to
+Returns the current iteration count for the event loop, which is identical
-the number of times libev did poll for new events. It starts at C<0> and
+to the number of times libev did poll for new events. It starts at C<0>
-happily wraps around with enough iterations.
+and happily wraps around with enough iterations.
 This value can sometimes be useful as a generation counter of sorts (it
 "ticks" the number of loop iterations), as it roughly corresponds with
-C<ev_prepare> and C<ev_check> calls.
+C<ev_prepare> and C<ev_check> calls - and is incremented between the
+prepare and check phases.
-=item unsigned int ev_loop_depth (loop)
+=item unsigned int ev_depth (loop)
-Returns the number of times C<ev_loop> was entered minus the number of
+Returns the number of times C<ev_run> was entered minus the number of
-times C<ev_loop> was exited, in other words, the recursion depth.
+times C<ev_run> was exited, in other words, the recursion depth.
-Outside C<ev_loop>, this number is zero. In a callback, this number is
+Outside C<ev_run>, this number is zero. In a callback, this number is
-C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
+C<1>, unless C<ev_run> was invoked recursively (or from another thread),
 in which case it is higher.
-Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
+Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
-etc.), doesn't count as exit.
+etc.), doesn't count as "exit" - consider this as a hint to avoid such
+ungentleman-like behaviour unless it's really convenient.
 =item unsigned int ev_backend (loop)
 Returns one of the C<EVBACKEND_*> flags indicating the event backend in
 use.
 =item ev_now_update (loop)
 Establishes the current time by querying the kernel, updating the time
 returned by C<ev_now ()> in the progress. This is a costly operation and
-is usually done automatically within C<ev_loop ()>.
+is usually done automatically within C<ev_run ()>.
 This function is rarely useful, but when some event callback runs for a
 very long time without entering the event loop, updating libev's idea of
 the current time is a good idea.
 =item ev_suspend (loop)
 =item ev_resume (loop)
-These two functions suspend and resume a loop, for use when the loop is
+These two functions suspend and resume an event loop, for use when the
-not used for a while and timeouts should not be processed.
+loop is not used for a while and timeouts should not be processed.
 A typical use case would be an interactive program such as a game:  When
 the user presses C<^Z> to suspend the game and resumes it an hour later it
 would be best to handle timeouts as if no time had actually passed while
 the program was suspended. This can be achieved by calling C<ev_suspend>
 C<ev_resume> directly afterwards to resume timer processing.
 Effectively, all C<ev_timer> watchers will be delayed by the time spend
 between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
 will be rescheduled (that is, they will lose any events that would have
-occured while suspended).
+occurred while suspended).
 After calling C<ev_suspend> you B<must not> call I<any> function on the
 given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
 without a previous call to C<ev_suspend>.
 Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
 event loop time (see C<ev_now_update>).
-=item ev_loop (loop, int flags)
+=item ev_run (loop, int flags)
 Finally, this is it, the event handler. This function usually is called
 after you have initialised all your watchers and you want to start
-handling events.
+handling events. It will ask the operating system for any new events, call
+the watcher callbacks, an then repeat the whole process indefinitely: This
+is why event loops are called I<loops>.
-If the flags argument is specified as C<0>, it will not return until
+If the flags argument is specified as C<0>, it will keep handling events
-either no event watchers are active anymore or C<ev_unloop> was called.
+until either no event watchers are active anymore or C<ev_break> was
+called.
-Please note that an explicit C<ev_unloop> is usually better than
+Please note that an explicit C<ev_break> is usually better than
 relying on all watchers to be stopped when deciding when a program has
 finished (especially in interactive programs), but having a program
 that automatically loops as long as it has to and no longer by virtue
 of relying on its watchers stopping correctly, that is truly a thing of
 beauty.
-A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
+A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
-those events and any already outstanding ones, but will not block your
+those events and any already outstanding ones, but will not wait and
-process in case there are no events and will return after one iteration of
+block your process in case there are no events and will return after one
-the loop.
+iteration of the loop. This is sometimes useful to poll and handle new
+events while doing lengthy calculations, to keep the program responsive.
-A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
+A flags value of C<EVRUN_ONCE> will look for new events (waiting if
 necessary) and will handle those and any already outstanding ones. It
 will block your process until at least one new event arrives (which could
 be an event internal to libev itself, so there is no guarantee that a
 user-registered callback will be called), and will return after one
 iteration of the loop.
 This is useful if you are waiting for some external event in conjunction
 with something not expressible using other libev watchers (i.e. "roll your
-own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
+own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
 usually a better approach for this kind of thing.
-Here are the gory details of what C<ev_loop> does:
+Here are the gory details of what C<ev_run> does:
+   - Increment loop depth.
+   - Reset the ev_break status.
    - Before the first iteration, call any pending watchers.
+   LOOP:
-   * If EVFLAG_FORKCHECK was used, check for a fork.
+   - If EVFLAG_FORKCHECK was used, check for a fork.
    - If a fork was detected (by any means), queue and call all fork watchers.
    - Queue and call all prepare watchers.
+   - If ev_break was called, goto FINISH.
    - If we have been forked, detach and recreate the kernel state
      as to not disturb the other process.
    - Update the kernel state with all outstanding changes.
    - Update the "event loop time" (ev_now ()).
    - Calculate for how long to sleep or block, if at all
-     (active idle watchers, EVLOOP_NONBLOCK or not having
+     (active idle watchers, EVRUN_NOWAIT or not having
      any active watchers at all will result in not sleeping).
    - Sleep if the I/O and timer collect interval say so.
+   - Increment loop iteration counter.
    - Block the process, waiting for any events.
    - Queue all outstanding I/O (fd) events.
    - Update the "event loop time" (ev_now ()), and do time jump adjustments.
    - Queue all expired timers.
    - Queue all expired periodics.
-   - Unless any events are pending now, queue all idle watchers.
+   - Queue all idle watchers with priority higher than that of pending events.
    - Queue all check watchers.
    - Call all queued watchers in reverse order (i.e. check watchers first).
      Signals and child watchers are implemented as I/O watchers, and will
      be handled here by queueing them when their watcher gets executed.
-   - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
+   - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
-     were used, or there are no active watchers, return, otherwise
+     were used, or there are no active watchers, goto FINISH, otherwise
-     continue with step *.
+     continue with step LOOP.
+   FINISH:
+   - Reset the ev_break status iff it was EVBREAK_ONE.
+   - Decrement the loop depth.
+   - Return.
 Example: Queue some jobs and then loop until no events are outstanding
 anymore.
    ... queue jobs here, make sure they register event watchers as long
    ... as they still have work to do (even an idle watcher will do..)
-   ev_loop (my_loop, 0);
+   ev_run (my_loop, 0);
    ... jobs done or somebody called unloop. yeah!
-=item ev_unloop (loop, how)
+=item ev_break (loop, how)
-Can be used to make a call to C<ev_loop> return early (but only after it
+Can be used to make a call to C<ev_run> return early (but only after it
 has processed all outstanding events). The C<how> argument must be either
-C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
+C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
-C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
+C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
-This "unloop state" will be cleared when entering C<ev_loop> again.
+This "unloop state" will be cleared when entering C<ev_run> again.
-It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
+It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##
 =item ev_ref (loop)
 =item ev_unref (loop)
 Ref/unref can be used to add or remove a reference count on the event
 loop: Every watcher keeps one reference, and as long as the reference
-count is nonzero, C<ev_loop> will not return on its own.
+count is nonzero, C<ev_run> will not return on its own.
-If you have a watcher you never unregister that should not keep C<ev_loop>
+This is useful when you have a watcher that you never intend to
-from returning, call ev_unref() after starting, and ev_ref() before
+unregister, but that nevertheless should not keep C<ev_run> from
+returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
-stopping it.
+before stopping it.
 As an example, libev itself uses this for its internal signal pipe: It
-is not visible to the libev user and should not keep C<ev_loop> from
+is not visible to the libev user and should not keep C<ev_run> from
 exiting if no event watchers registered by it are active. It is also an
 excellent way to do this for generic recurring timers or from within
 third-party libraries. Just remember to I<unref after start> and I<ref
 before stop> (but only if the watcher wasn't active before, or was active
 before, respectively. Note also that libev might stop watchers itself
 (e.g. non-repeating timers) in which case you have to C<ev_ref>
 in the callback).
-Example: Create a signal watcher, but keep it from keeping C<ev_loop>
+Example: Create a signal watcher, but keep it from keeping C<ev_run>
 running when nothing else is active.
    ev_signal exitsig;
    ev_signal_init (&exitsig, sig_cb, SIGINT);
    ev_signal_start (loop, &exitsig);
 usually doesn't make much sense to set it to a lower value than C<0.01>,
 as this approaches the timing granularity of most systems. Note that if
 you do transactions with the outside world and you can't increase the
 parallelity, then this setting will limit your transaction rate (if you
 need to poll once per transaction and the I/O collect interval is 0.01,
-then you can't do more than 100 transations per second).
+then you can't do more than 100 transactions per second).
 Setting the I<timeout collect interval> can improve the opportunity for
 saving power, as the program will "bundle" timer callback invocations that
 are "near" in time together, by delaying some, thus reducing the number of
 times the process sleeps and wakes up again. Another useful technique to
    ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
 =item ev_invoke_pending (loop)
 This call will simply invoke all pending watchers while resetting their
-pending state. Normally, C<ev_loop> does this automatically when required,
+pending state. Normally, C<ev_run> does this automatically when required,
-but when overriding the invoke callback this call comes handy.
+but when overriding the invoke callback this call comes handy. This
+function can be invoked from a watcher - this can be useful for example
+when you want to do some lengthy calculation and want to pass further
+event handling to another thread (you still have to make sure only one
+thread executes within C<ev_invoke_pending> or C<ev_run> of course).
 =item int ev_pending_count (loop)
 Returns the number of pending watchers - zero indicates that no watchers
 are pending.
 =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
 This overrides the invoke pending functionality of the loop: Instead of
-invoking all pending watchers when there are any, C<ev_loop> will call
+invoking all pending watchers when there are any, C<ev_run> will call
 this callback instead. This is useful, for example, when you want to
 invoke the actual watchers inside another context (another thread etc.).
 If you want to reset the callback, use C<ev_invoke_pending> as new
 callback.
 Sometimes you want to share the same loop between multiple threads. This
 can be done relatively simply by putting mutex_lock/unlock calls around
 each call to a libev function.
-However, C<ev_loop> can run an indefinite time, so it is not feasible to
+However, C<ev_run> can run an indefinite time, so it is not feasible
-wait for it to return. One way around this is to wake up the loop via
+to wait for it to return. One way around this is to wake up the event
-C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
+loop via C<ev_break> and C<av_async_send>, another way is to set these
-and I<acquire> callbacks on the loop.
+I<release> and I<acquire> callbacks on the loop.
 When set, then C<release> will be called just before the thread is
 suspended waiting for new events, and C<acquire> is called just
 afterwards.
 While event loop modifications are allowed between invocations of
 C<release> and C<acquire> (that's their only purpose after all), no
 modifications done will affect the event loop, i.e. adding watchers will
 have no effect on the set of file descriptors being watched, or the time
-waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it
+waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
 to take note of any changes you made.
-In theory, threads executing C<ev_loop> will be async-cancel safe between
+In theory, threads executing C<ev_run> will be async-cancel safe between
 invocations of C<release> and C<acquire>.
 See also the locking example in the C<THREADS> section later in this
 document.
 These two functions can be used to associate arbitrary data with a loop,
 and are intended solely for the C<invoke_pending_cb>, C<release> and
 C<acquire> callbacks described above, but of course can be (ab-)used for
 any other purpose as well.
-=item ev_loop_verify (loop)
+=item ev_verify (loop)
 This function only does something when C<EV_VERIFY> support has been
 compiled in, which is the default for non-minimal builds. It tries to go
 through all internal structures and checks them for validity. If anything
 is found to be inconsistent, it will print an error message to standard
 In the following description, uppercase C<TYPE> in names stands for the
 watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
 watchers and C<ev_io_start> for I/O watchers.
-A watcher is a structure that you create and register to record your
+A watcher is an opaque structure that you allocate and register to record
-interest in some event. For instance, if you want to wait for STDIN to
+your interest in some event. To make a concrete example, imagine you want
-become readable, you would create an C<ev_io> watcher for that:
+to wait for STDIN to become readable, you would create an C<ev_io> watcher
+for that:
    static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
    {
      ev_io_stop (w);
-     ev_unloop (loop, EVUNLOOP_ALL);
+     ev_break (loop, EVBREAK_ALL);
    }
    struct ev_loop *loop = ev_default_loop (0);
    ev_io stdin_watcher;
    ev_init (&stdin_watcher, my_cb);
    ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
    ev_io_start (loop, &stdin_watcher);
-   ev_loop (loop, 0);
+   ev_run (loop, 0);
 As you can see, you are responsible for allocating the memory for your
 watcher structures (and it is I<usually> a bad idea to do this on the
 stack).
 Each watcher has an associated watcher structure (called C<struct ev_TYPE>
 or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
-Each watcher structure must be initialised by a call to C<ev_init
+Each watcher structure must be initialised by a call to C<ev_init (watcher
-(watcher *, callback)>, which expects a callback to be provided. This
+*, callback)>, which expects a callback to be provided. This callback is
-callback gets invoked each time the event occurs (or, in the case of I/O
+invoked each time the event occurs (or, in the case of I/O watchers, each
-watchers, each time the event loop detects that the file descriptor given
+time the event loop detects that the file descriptor given is readable
-is readable and/or writable).
+and/or writable).
 Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
 macro to configure it, with arguments specific to the watcher type. There
 is also a macro to combine initialisation and setting in one call: C<<
 ev_TYPE_init (watcher *, callback, ...) >>.
 =item C<EV_WRITE>
 The file descriptor in the C<ev_io> watcher has become readable and/or
 writable.
-=item C<EV_TIMEOUT>
+=item C<EV_TIMER>
 The C<ev_timer> watcher has timed out.
 =item C<EV_PERIODIC>
 =item C<EV_PREPARE>
 =item C<EV_CHECK>
-All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts
+All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
 to gather new events, and all C<ev_check> watchers are invoked just after
-C<ev_loop> has gathered them, but before it invokes any callbacks for any
+C<ev_run> has gathered them, but before it invokes any callbacks for any
 received events. Callbacks of both watcher types can start and stop as
 many watchers as they want, and all of them will be taken into account
 (for example, a C<ev_prepare> watcher might start an idle watcher to keep
-C<ev_loop> from blocking).
+C<ev_run> from blocking).
 =item C<EV_EMBED>
 The embedded event loop specified in the C<ev_embed> watcher needs attention.
 programs, though, as the fd could already be closed and reused for another
 thing, so beware.
 =back
+=head2 WATCHER STATES
+There are various watcher states mentioned throughout this manual -
+active, pending and so on. In this section these states and the rules to
+transition between them will be described in more detail - and while these
+rules might look complicated, they usually do "the right thing".
+=over 4
+=item initialiased
+Before a watcher can be registered with the event looop it has to be
+initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
+C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
+In this state it is simply some block of memory that is suitable for use
+in an event loop. It can be moved around, freed, reused etc. at will.
+=item started/running/active
+Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
+property of the event loop, and is actively waiting for events. While in
+this state it cannot be accessed (except in a few documented ways), moved,
+freed or anything else - the only legal thing is to keep a pointer to it,
+and call libev functions on it that are documented to work on active watchers.
+=item pending
+If a watcher is active and libev determines that an event it is interested
+in has occurred (such as a timer expiring), it will become pending. It will
+stay in this pending state until either it is stopped or its callback is
+about to be invoked, so it is not normally pending inside the watcher
+callback.
+The watcher might or might not be active while it is pending (for example,
+an expired non-repeating timer can be pending but no longer active). If it
+is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
+but it is still property of the event loop at this time, so cannot be
+moved, freed or reused. And if it is active the rules described in the
+previous item still apply.
+It is also possible to feed an event on a watcher that is not active (e.g.
+via C<ev_feed_event>), in which case it becomes pending without being
+active.
+=item stopped
+A watcher can be stopped implicitly by libev (in which case it might still
+be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
+latter will clear any pending state the watcher might be in, regardless
+of whether it was active or not, so stopping a watcher explicitly before
+freeing it is often a good idea.
+While stopped (and not pending) the watcher is essentially in the
+initialised state, that is it can be reused, moved, modified in any way
+you wish.
+=back
 =head2 GENERIC WATCHER FUNCTIONS
 =over 4
 =item C<ev_init> (ev_TYPE *watcher, callback)
    ev_io w;
    ev_init (&w, my_cb);
    ev_io_set (&w, STDIN_FILENO, EV_READ);
-=item C<ev_TYPE_set> (ev_TYPE *, [args])
+=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
 This macro initialises the type-specific parts of a watcher. You need to
 call C<ev_init> at least once before you call this macro, but you can
 call C<ev_TYPE_set> any number of times. You must not, however, call this
 macro on a watcher that is active (it can be pending, however, which is a
 Example: Initialise and set an C<ev_io> watcher in one step.
    ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
-=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
+=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
 Starts (activates) the given watcher. Only active watchers will receive
 events. If the watcher is already active nothing will happen.
 Example: Start the C<ev_io> watcher that is being abused as example in this
 whole section.
    ev_io_start (EV_DEFAULT_UC, &w);
-=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
+=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
 Stops the given watcher if active, and clears the pending status (whether
 the watcher was active or not).
 It is possible that stopped watchers are pending - for example,
 =item ev_cb_set (ev_TYPE *watcher, callback)
 Change the callback. You can change the callback at virtually any time
 (modulo threads).
-=item ev_set_priority (ev_TYPE *watcher, priority)
+=item ev_set_priority (ev_TYPE *watcher, int priority)
 =item int ev_priority (ev_TYPE *watcher)
 Set and query the priority of the watcher. The priority is a small
 integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
 returns its C<revents> bitset (as if its callback was invoked). If the
 watcher isn't pending it does nothing and returns C<0>.
 Sometimes it can be useful to "poll" a watcher instead of waiting for its
 callback to be invoked, which can be accomplished with this function.
+=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
+Feeds the given event set into the event loop, as if the specified event
+had happened for the specified watcher (which must be a pointer to an
+initialised but not necessarily started event watcher). Obviously you must
+not free the watcher as long as it has pending events.
+Stopping the watcher, letting libev invoke it, or calling
+C<ev_clear_pending> will clear the pending event, even if the watcher was
+not started in the first place.
+See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
+functions that do not need a watcher.
 =back
 =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
 For example, to emulate how many other event libraries handle priorities,
 you can associate an C<ev_idle> watcher to each such watcher, and in
 the normal watcher callback, you just start the idle watcher. The real
 processing is done in the idle watcher callback. This causes libev to
-continously poll and process kernel event data for the watcher, but when
+continuously poll and process kernel event data for the watcher, but when
 the lock-out case is known to be rare (which in turn is rare :), this is
 workable.
 Usually, however, the lock-out model implemented that way will perform
 miserably under the type of load it was designed to handle. In that case,
    {
      // stop the I/O watcher, we received the event, but
      // are not yet ready to handle it.
      ev_io_stop (EV_A_ w);
-     // start the idle watcher to ahndle the actual event.
+     // start the idle watcher to handle the actual event.
      // it will not be executed as long as other watchers
      // with the default priority are receiving events.
      ev_idle_start (EV_A_ &idle);
    }
 If you cannot use non-blocking mode, then force the use of a
 known-to-be-good backend (at the time of this writing, this includes only
 C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
 descriptors for which non-blocking operation makes no sense (such as
-files) - libev doesn't guarentee any specific behaviour in that case.
+files) - libev doesn't guarantee any specific behaviour in that case.
 Another thing you have to watch out for is that it is quite easy to
 receive "spurious" readiness notifications, that is your callback might
 be called with C<EV_READ> but a subsequent C<read>(2) will actually block
 because there is no data. Not only are some backends known to create a
 So when you encounter spurious, unexplained daemon exits, make sure you
 ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
 somewhere, as that would have given you a big clue).
+=head3 The special problem of accept()ing when you can't
+Many implementations of the POSIX C<accept> function (for example,
+found in post-2004 Linux) have the peculiar behaviour of not removing a
+connection from the pending queue in all error cases.
+For example, larger servers often run out of file descriptors (because
+of resource limits), causing C<accept> to fail with C<ENFILE> but not
+rejecting the connection, leading to libev signalling readiness on
+the next iteration again (the connection still exists after all), and
+typically causing the program to loop at 100% CPU usage.
+Unfortunately, the set of errors that cause this issue differs between
+operating systems, there is usually little the app can do to remedy the
+situation, and no known thread-safe method of removing the connection to
+cope with overload is known (to me).
+One of the easiest ways to handle this situation is to just ignore it
+- when the program encounters an overload, it will just loop until the
+situation is over. While this is a form of busy waiting, no OS offers an
+event-based way to handle this situation, so it's the best one can do.
+A better way to handle the situation is to log any errors other than
+C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
+messages, and continue as usual, which at least gives the user an idea of
+what could be wrong ("raise the ulimit!"). For extra points one could stop
+the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
+usage.
+If your program is single-threaded, then you could also keep a dummy file
+descriptor for overload situations (e.g. by opening F</dev/null>), and
+when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
+close that fd, and create a new dummy fd. This will gracefully refuse
+clients under typical overload conditions.
+The last way to handle it is to simply log the error and C<exit>, as
+is often done with C<malloc> failures, but this results in an easy
+opportunity for a DoS attack.
 =head3 Watcher-Specific Functions
 =over 4
    ...
    struct ev_loop *loop = ev_default_init (0);
    ev_io stdin_readable;
    ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
    ev_io_start (loop, &stdin_readable);
-   ev_loop (loop, 0);
+   ev_run (loop, 0);
 =head2 C<ev_timer> - relative and optionally repeating timeouts
 Timer watchers are simple relative timers that generate an event after a
 The callback is guaranteed to be invoked only I<after> its timeout has
 passed (not I<at>, so on systems with very low-resolution clocks this
 might introduce a small delay). If multiple timers become ready during the
 same loop iteration then the ones with earlier time-out values are invoked
 before ones of the same priority with later time-out values (but this is
-no longer true when a callback calls C<ev_loop> recursively).
+no longer true when a callback calls C<ev_run> recursively).
 =head3 Be smart about timeouts
 Many real-world problems involve some kind of timeout, usually for error
 recovery. A typical example is an HTTP request - if the other side hangs,
      ev_tstamp timeout = last_activity + 60.;
      // if last_activity + 60. is older than now, we did time out
      if (timeout < now)
        {
-         // timeout occured, take action
+         // timeout occurred, take action
        }
      else
        {
          // callback was invoked, but there was some activity, re-arm
          // the watcher to fire in last_activity + 60, which is
 to the current time (meaning we just have some activity :), then call the
 callback, which will "do the right thing" and start the timer:
    ev_init (timer, callback);
    last_activity = ev_now (loop);
-   callback (loop, timer, EV_TIMEOUT);
+   callback (loop, timer, EV_TIMER);
 And when there is some activity, simply store the current time in
 C<last_activity>, no libev calls at all:
-   last_actiivty = ev_now (loop);
+   last_activity = ev_now (loop);
 This technique is slightly more complex, but in most cases where the
 time-out is unlikely to be triggered, much more efficient.
 Changing the timeout is trivial as well (if it isn't hard-coded in the
 =head3 The special problem of time updates
 Establishing the current time is a costly operation (it usually takes at
 least two system calls): EV therefore updates its idea of the current
-time only before and after C<ev_loop> collects new events, which causes a
+time only before and after C<ev_run> collects new events, which causes a
 growing difference between C<ev_now ()> and C<ev_time ()> when handling
 lots of events in one iteration.
 The relative timeouts are calculated relative to the C<ev_now ()>
 time. This is usually the right thing as this timestamp refers to the time
 C<repeat> value), or reset the running timer to the C<repeat> value.
 This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
 usage example.
-=item ev_timer_remaining (loop, ev_timer *)
+=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
 Returns the remaining time until a timer fires. If the timer is active,
 then this time is relative to the current event loop time, otherwise it's
 the timeout value currently configured.
 That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
-C<5>. When the timer is started and one second passes, C<ev_timer_remain>
+C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
 will return C<4>. When the timer expires and is restarted, it will return
 roughly C<7> (likely slightly less as callback invocation takes some time,
 too), and so on.
 =item ev_tstamp repeat [read-write]
    }
    ev_timer mytimer;
    ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
    ev_timer_again (&mytimer); /* start timer */
-   ev_loop (loop, 0);
+   ev_run (loop, 0);
    // and in some piece of code that gets executed on any "activity":
    // reset the timeout to start ticking again at 10 seconds
    ev_timer_again (&mytimer);
 As with timers, the callback is guaranteed to be invoked only when the
 point in time where it is supposed to trigger has passed. If multiple
 timers become ready during the same loop iteration then the ones with
 earlier time-out values are invoked before ones with later time-out values
-(but this is no longer true when a callback calls C<ev_loop> recursively).
+(but this is no longer true when a callback calls C<ev_run> recursively).
 =head3 Watcher-Specific Functions and Data Members
 =over 4
 Example: Call a callback every hour, or, more precisely, whenever the
 system time is divisible by 3600. The callback invocation times have
 potentially a lot of jitter, but good long-term stability.
    static void
-   clock_cb (struct ev_loop *loop, ev_io *w, int revents)
+   clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
    {
      ... its now a full hour (UTC, or TAI or whatever your clock follows)
    }
    ev_periodic hourly_tick;
 C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
 not be unduly interrupted. If you have a problem with system calls getting
 interrupted by signals you can block all signals in an C<ev_check> watcher
 and unblock them in an C<ev_prepare> watcher.
-=head3 The special problem of inheritance over execve
+=head3 The special problem of inheritance over fork/execve/pthread_create
 Both the signal mask (C<sigprocmask>) and the signal disposition
 (C<sigaction>) are unspecified after starting a signal watcher (and after
 stopping it again), that is, libev might or might not block the signal,
 and might or might not set or restore the installed signal handler.
 The simplest way to ensure that the signal mask is reset in the child is
 to install a fork handler with C<pthread_atfork> that resets it. That will
 catch fork calls done by libraries (such as the libc) as well.
-In current versions of libev, you can also ensure that the signal mask is
+In current versions of libev, the signal will not be blocked indefinitely
-not blocking any signals (except temporarily, so thread users watch out)
+unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
-by specifying the C<EVFLAG_NOSIGNALFD> when creating the event loop. This
+the window of opportunity for problems, it will not go away, as libev
-is not guaranteed for future versions, however.
+I<has> to modify the signal mask, at least temporarily.
+So I can't stress this enough: I<If you do not reset your signal mask when
+you expect it to be empty, you have a race condition in your code>. This
+is not a libev-specific thing, this is true for most event libraries.
 =head3 Watcher-Specific Functions and Data Members
 =over 4
 Example: Try to exit cleanly on SIGINT.
    static void
    sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
    {
-     ev_unloop (loop, EVUNLOOP_ALL);
+     ev_break (loop, EVBREAK_ALL);
    }
    ev_signal signal_watcher;
    ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
    ev_signal_start (loop, &signal_watcher);
 Prepare and check watchers are usually (but not always) used in pairs:
 prepare watchers get invoked before the process blocks and check watchers
 afterwards.
-You I<must not> call C<ev_loop> or similar functions that enter
+You I<must not> call C<ev_run> or similar functions that enter
 the current event loop from either C<ev_prepare> or C<ev_check>
 watchers. Other loops than the current one are fine, however. The
 rationale behind this is that you do not need to check for recursion in
 those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
 C<ev_check> so if you have one watcher of each kind they will always be
      if (timeout >= 0)
        // create/start timer
      // poll
-     ev_loop (EV_A_ 0);
+     ev_run (EV_A_ 0);
      // stop timer again
      if (timeout >= 0)
        ev_timer_stop (EV_A_ &to);
 if you do not want that, you need to temporarily stop the embed watcher).
 =item ev_embed_sweep (loop, ev_embed *)
 Make a single, non-blocking sweep over the embedded loop. This works
-similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
+similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
 appropriate way for embedded loops.
 =item struct ev_loop *other [read-only]
 The embedded event loop.
 C<ev_default_fork> cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.
 =head3 The special problem of life after fork - how is it possible?
-Most uses of C<fork()> consist of forking, then some simple calls to ste
+Most uses of C<fork()> consist of forking, then some simple calls to set
 up/change the process environment, followed by a call to C<exec()>. This
 sequence should be handled by libev without any problems.
 This changes when the application actually wants to do event handling
 in the child, or both parent in child, in effect "continuing" after the
 believe me.
 =back
-=head2 C<ev_async> - how to wake up another event loop
+=head2 C<ev_async> - how to wake up an event loop
-In general, you cannot use an C<ev_loop> from multiple threads or other
+In general, you cannot use an C<ev_run> from multiple threads or other
 asynchronous sources such as signal handlers (as opposed to multiple event
 loops - those are of course safe to use in different threads).
-Sometimes, however, you need to wake up another event loop you do not
+Sometimes, however, you need to wake up an event loop you do not control,
-control, for example because it belongs to another thread. This is what
+for example because it belongs to another thread. This is what C<ev_async>
-C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
+watchers do: as long as the C<ev_async> watcher is active, you can signal
-can signal it by calling C<ev_async_send>, which is thread- and signal
+it by calling C<ev_async_send>, which is thread- and signal safe.
-safe.
 This functionality is very similar to C<ev_signal> watchers, as signals,
 too, are asynchronous in nature, and signals, too, will be compressed
 (i.e. the number of callback invocations may be less than the number of
 C<ev_async_sent> calls).
 =head3 Queueing
 C<ev_async> does not support queueing of data in any way. The reason
 is that the author does not know of a simple (or any) algorithm for a
 multiple-writer-single-reader queue that works in all cases and doesn't
-need elaborate support such as pthreads.
+need elaborate support such as pthreads or unportable memory access
+semantics.
 That means that if you want to queue data, you have to provide your own
 queue. But at least I can tell you how to implement locking around your
 queue:
 If C<timeout> is less than 0, then no timeout watcher will be
 started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
 repeat = 0) will be started. C<0> is a valid timeout.
-The callback has the type C<void (*cb)(int revents, void *arg)> and gets
+The callback has the type C<void (*cb)(int revents, void *arg)> and is
 passed an C<revents> set like normal event callbacks (a combination of
-C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
+C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
 value passed to C<ev_once>. Note that it is possible to receive I<both>
 a timeout and an io event at the same time - you probably should give io
 events precedence.
 Example: wait up to ten seconds for data to appear on STDIN_FILENO.
    static void stdin_ready (int revents, void *arg)
    {
      if (revents & EV_READ)
        /* stdin might have data for us, joy! */;
-     else if (revents & EV_TIMEOUT)
+     else if (revents & EV_TIMER)
        /* doh, nothing entered */;
    }
    ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
-=item ev_feed_event (struct ev_loop *, watcher *, int revents)
-Feeds the given event set into the event loop, as if the specified event
-had happened for the specified watcher (which must be a pointer to an
-initialised but not necessarily started event watcher).
-=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
+=item ev_feed_fd_event (loop, int fd, int revents)
 Feed an event on the given fd, as if a file descriptor backend detected
 the given events it.
-=item ev_feed_signal_event (struct ev_loop *loop, int signum)
+=item ev_feed_signal_event (loop, int signum)
 Feed an event as if the given signal occurred (C<loop> must be the default
 loop!).
 =back
 =over 4
 =item ev::TYPE::TYPE ()
-=item ev::TYPE::TYPE (struct ev_loop *)
+=item ev::TYPE::TYPE (loop)
 =item ev::TYPE::~TYPE
 The constructor (optionally) takes an event loop to associate the watcher
 with. If it is omitted, it will use C<EV_DEFAULT>.
    myclass obj;
    ev::io iow;
    iow.set <myclass, &myclass::io_cb> (&obj);
 =item w->set (object *)
-This is an B<experimental> feature that might go away in a future version.
 This is a variation of a method callback - leaving out the method to call
 will default the method to C<operator ()>, which makes it possible to use
 functor objects without having to manually specify the C<operator ()> all
 the time. Incidentally, you can then also leave out the template argument
 Example: Use a plain function as callback.
    static void io_cb (ev::io &w, int revents) { }
    iow.set <io_cb> ();
-=item w->set (struct ev_loop *)
+=item w->set (loop)
 Associates a different C<struct ev_loop> with this watcher. You can only
 do this when the watcher is inactive (and not pending either).
 =item w->set ([arguments])
-Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
+Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
-called at least once. Unlike the C counterpart, an active watcher gets
+method or a suitable start method must be called at least once. Unlike the
-automatically stopped and restarted when reconfiguring it with this
+C counterpart, an active watcher gets automatically stopped and restarted
-method.
+when reconfiguring it with this method.
 =item w->start ()
 Starts the watcher. Note that there is no C<loop> argument, as the
 constructor already stores the event loop.
+=item w->start ([arguments])
+Instead of calling C<set> and C<start> methods separately, it is often
+convenient to wrap them in one call. Uses the same type of arguments as
+the configure C<set> method of the watcher.
 =item w->stop ()
 Stops the watcher if it is active. Again, no C<loop> argument.
 =item w->again () (C<ev::timer>, C<ev::periodic> only)
 =back
 =back
-Example: Define a class with an IO and idle watcher, start one of them in
+Example: Define a class with two I/O and idle watchers, start the I/O
-the constructor.
+watchers in the constructor.
    class myclass
    {
      ev::io   io  ; void io_cb   (ev::io   &w, int revents);
+     ev::io2  io2 ; void io2_cb  (ev::io   &w, int revents);
      ev::idle idle; void idle_cb (ev::idle &w, int revents);
      myclass (int fd)
      {
        io  .set <myclass, &myclass::io_cb  > (this);
+       io2 .set <myclass, &myclass::io2_cb > (this);
        idle.set <myclass, &myclass::idle_cb> (this);
-       io.start (fd, ev::READ);
+       io.set (fd, ev::WRITE); // configure the watcher
+       io.start ();            // start it whenever convenient
+       io2.start (fd, ev::READ); // set + start in one call
      }
    };
 =head1 OTHER LANGUAGE BINDINGS
 Erkki Seppala has written Ocaml bindings for libev, to be found at
 L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
 =item Lua
-Brian Maher has written a partial interface to libev
+Brian Maher has written a partial interface to libev for lua (at the
-for lua (only C<ev_io> and C<ev_timer>), to be found at
+time of this writing, only C<ev_io> and C<ev_timer>), to be found at
 L<http://github.com/brimworks/lua-ev>.
 =back
 loop argument"). The C<EV_A> form is used when this is the sole argument,
 C<EV_A_> is used when other arguments are following. Example:
    ev_unref (EV_A);
    ev_timer_add (EV_A_ watcher);
-   ev_loop (EV_A_ 0);
+   ev_run (EV_A_ 0);
 It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
 which is often provided by the following macro.
 =item C<EV_P>, C<EV_P_>
    }
    ev_check check;
    ev_check_init (&check, check_cb);
    ev_check_start (EV_DEFAULT_ &check);
-   ev_loop (EV_DEFAULT_ 0);
+   ev_run (EV_DEFAULT_ 0);
 =head1 EMBEDDING
 Libev can (and often is) directly embedded into host
 applications. Examples of applications that embed it include the Deliantra
    libev.m4
 =head2 PREPROCESSOR SYMBOLS/MACROS
 Libev can be configured via a variety of preprocessor symbols you have to
-define before including any of its files. The default in the absence of
+define before including (or compiling) any of its files. The default in
-autoconf is documented for every option.
+the absence of autoconf is documented for every option.
+Symbols marked with "(h)" do not change the ABI, and can have different
+values when compiling libev vs. including F<ev.h>, so it is permissible
+to redefine them before including F<ev.h> without breaking compatibility
+to a compiled library. All other symbols change the ABI, which means all
+users of libev and the libev code itself must be compiled with compatible
+settings.
 =over 4
+=item EV_COMPAT3 (h)
+Backwards compatibility is a major concern for libev. This is why this
+release of libev comes with wrappers for the functions and symbols that
+have been renamed between libev version 3 and 4.
+You can disable these wrappers (to test compatibility with future
+versions) by defining C<EV_COMPAT3> to C<0> when compiling your
+sources. This has the additional advantage that you can drop the C<struct>
+from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
+typedef in that case.
+In some future version, the default for C<EV_COMPAT3> will become C<0>,
+and in some even more future version the compatibility code will be
+removed completely.
-=item EV_STANDALONE
+=item EV_STANDALONE (h)
 Must always be C<1> if you do not use autoconf configuration, which
 keeps libev from including F<config.h>, and it also defines dummy
 implementations for some libevent functions (such as logging, which is not
 supported). It will also not define any of the structs usually found in
 as well as for signal and thread safety in C<ev_async> watchers.
 In the absence of this define, libev will use C<sig_atomic_t volatile>
 (from F<signal.h>), which is usually good enough on most platforms.
-=item EV_H
+=item EV_H (h)
 The name of the F<ev.h> header file used to include it. The default if
 undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
 used to virtually rename the F<ev.h> header file in case of conflicts.
-=item EV_CONFIG_H
+=item EV_CONFIG_H (h)
 If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
 F<ev.c>'s idea of where to find the F<config.h> file, similarly to
 C<EV_H>, above.
-=item EV_EVENT_H
+=item EV_EVENT_H (h)
 Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
 of how the F<event.h> header can be found, the default is C<"event.h">.
-=item EV_PROTOTYPES
+=item EV_PROTOTYPES (h)
 If defined to be C<0>, then F<ev.h> will not define any function
 prototypes, but still define all the structs and other symbols. This is
 occasionally useful if you want to provide your own wrapper functions
 around libev functions.
 fine.
 If your embedding application does not need any priorities, defining these
 both to C<0> will save some memory and CPU.
-=item EV_PERIODIC_ENABLE
+=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
+EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
+EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
-If undefined or defined to be C<1>, then periodic timers are supported. If
+If undefined or defined to be C<1> (and the platform supports it), then
-defined to be C<0>, then they are not. Disabling them saves a few kB of
+the respective watcher type is supported. If defined to be C<0>, then it
-code.
+is not. Disabling watcher types mainly saves code size.
-=item EV_IDLE_ENABLE
+=item EV_FEATURES
-If undefined or defined to be C<1>, then idle watchers are supported. If
-defined to be C<0>, then they are not. Disabling them saves a few kB of
-code.
-=item EV_EMBED_ENABLE
-If undefined or defined to be C<1>, then embed watchers are supported. If
-defined to be C<0>, then they are not. Embed watchers rely on most other
-watcher types, which therefore must not be disabled.
-=item EV_STAT_ENABLE
-If undefined or defined to be C<1>, then stat watchers are supported. If
-defined to be C<0>, then they are not.
-=item EV_FORK_ENABLE
-If undefined or defined to be C<1>, then fork watchers are supported. If
-defined to be C<0>, then they are not.
-=item EV_ASYNC_ENABLE
-If undefined or defined to be C<1>, then async watchers are supported. If
-defined to be C<0>, then they are not.
-=item EV_MINIMAL
 If you need to shave off some kilobytes of code at the expense of some
-speed (but with the full API), define this symbol to C<1>. Currently this
+speed (but with the full API), you can define this symbol to request
-is used to override some inlining decisions, saves roughly 30% code size
+certain subsets of functionality. The default is to enable all features
-on amd64. It also selects a much smaller 2-heap for timer management over
+that can be enabled on the platform.
-the default 4-heap.
-You can save even more by disabling watcher types you do not need
+A typical way to use this symbol is to define it to C<0> (or to a bitset
-and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
+with some broad features you want) and then selectively re-enable
-(C<-DNDEBUG>) will usually reduce code size a lot.
+additional parts you want, for example if you want everything minimal,
+but multiple event loop support, async and child watchers and the poll
+backend, use this:
-Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
+   #define EV_FEATURES 0
-provide a bare-bones event library. See C<ev.h> for details on what parts
+   #define EV_MULTIPLICITY 1
-of the API are still available, and do not complain if this subset changes
+   #define EV_USE_POLL 1
-over time.
+   #define EV_CHILD_ENABLE 1
+   #define EV_ASYNC_ENABLE 1
+The actual value is a bitset, it can be a combination of the following
+values:
+=over 4
+=item C<1> - faster/larger code
+Use larger code to speed up some operations.
+Currently this is used to override some inlining decisions (enlarging the
+code size by roughly 30% on amd64).
+When optimising for size, use of compiler flags such as C<-Os> with
+gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
+assertions.
+=item C<2> - faster/larger data structures
+Replaces the small 2-heap for timer management by a faster 4-heap, larger
+hash table sizes and so on. This will usually further increase code size
+and can additionally have an effect on the size of data structures at
+runtime.
+=item C<4> - full API configuration
+This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
+enables multiplicity (C<EV_MULTIPLICITY>=1).
+=item C<8> - full API
+This enables a lot of the "lesser used" API functions. See C<ev.h> for
+details on which parts of the API are still available without this
+feature, and do not complain if this subset changes over time.
+=item C<16> - enable all optional watcher types
+Enables all optional watcher types.  If you want to selectively enable
+only some watcher types other than I/O and timers (e.g. prepare,
+embed, async, child...) you can enable them manually by defining
+C<EV_watchertype_ENABLE> to C<1> instead.
+=item C<32> - enable all backends
+This enables all backends - without this feature, you need to enable at
+least one backend manually (C<EV_USE_SELECT> is a good choice).
+=item C<64> - enable OS-specific "helper" APIs
+Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
+default.
+=back
+Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
+reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
+code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
+watchers, timers and monotonic clock support.
+With an intelligent-enough linker (gcc+binutils are intelligent enough
+when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
+your program might be left out as well - a binary starting a timer and an
+I/O watcher then might come out at only 5Kb.
+=item EV_AVOID_STDIO
+If this is set to C<1> at compiletime, then libev will avoid using stdio
+functions (printf, scanf, perror etc.). This will increase the code size
+somewhat, but if your program doesn't otherwise depend on stdio and your
+libc allows it, this avoids linking in the stdio library which is quite
+big.
+Note that error messages might become less precise when this option is
+enabled.
 =item EV_NSIG
 The highest supported signal number, +1 (or, the number of
 signals): Normally, libev tries to deduce the maximum number of signals
 automatically, but sometimes this fails, in which case it can be
 specified. Also, using a lower number than detected (C<32> should be
-good for about any system in existance) can save some memory, as libev
+good for about any system in existence) can save some memory, as libev
 statically allocates some 12-24 bytes per signal number.
 =item EV_PID_HASHSIZE
 C<ev_child> watchers use a small hash table to distribute workload by
-pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
+pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
-than enough. If you need to manage thousands of children you might want to
+usually more than enough. If you need to manage thousands of children you
-increase this value (I<must> be a power of two).
+might want to increase this value (I<must> be a power of two).
 =item EV_INOTIFY_HASHSIZE
 C<ev_stat> watchers use a small hash table to distribute workload by
-inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
+inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
-usually more than enough. If you need to manage thousands of C<ev_stat>
+disabled), usually more than enough. If you need to manage thousands of
-watchers you might want to increase this value (I<must> be a power of
+C<ev_stat> watchers you might want to increase this value (I<must> be a
-two).
+power of two).
 =item EV_USE_4HEAP
 Heaps are not very cache-efficient. To improve the cache-efficiency of the
 timer and periodics heaps, libev uses a 4-heap when this symbol is defined
 to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
 faster performance with many (thousands) of watchers.
-The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
+The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
-(disabled).
+will be C<0>.
 =item EV_HEAP_CACHE_AT
 Heaps are not very cache-efficient. To improve the cache-efficiency of the
 timer and periodics heaps, libev can cache the timestamp (I<at>) within
 the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
 which uses 8-12 bytes more per watcher and a few hundred bytes more code,
 but avoids random read accesses on heap changes. This improves performance
 noticeably with many (hundreds) of watchers.
-The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
+The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
-(disabled).
+will be C<0>.
 =item EV_VERIFY
-Controls how much internal verification (see C<ev_loop_verify ()>) will
+Controls how much internal verification (see C<ev_verify ()>) will
 be done: If set to C<0>, no internal verification code will be compiled
 in. If set to C<1>, then verification code will be compiled in, but not
 called. If set to C<2>, then the internal verification code will be
 called once per loop, which can slow down libev. If set to C<3>, then the
 verification code will be called very frequently, which will slow down
 libev considerably.
-The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
+The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
-C<0>.
+will be C<0>.
 =item EV_COMMON
 By default, all watchers have a C<void *data> member. By redefining
-this macro to a something else you can include more and other types of
+this macro to something else you can include more and other types of
 members. You have to define it each time you include one of the files,
 though, and it must be identical each time.
 For example, the perl EV module uses something like this:
 file.
 The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
 that everybody includes and which overrides some configure choices:
-   #define EV_MINIMAL 1
+   #define EV_FEATURES 8
-   #define EV_USE_POLL 0
+   #define EV_USE_SELECT 1
-   #define EV_MULTIPLICITY 0
-   #define EV_PERIODIC_ENABLE 0
+   #define EV_PREPARE_ENABLE 1
+   #define EV_IDLE_ENABLE 1
-   #define EV_STAT_ENABLE 0
+   #define EV_SIGNAL_ENABLE 1
-   #define EV_FORK_ENABLE 0
+   #define EV_CHILD_ENABLE 1
+   #define EV_USE_STDEXCEPT 0
    #define EV_CONFIG_H <config.h>
-   #define EV_MINPRI 0
-   #define EV_MAXPRI 0
    #include "ev++.h"
 And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
      userdata *u = ev_userdata (EV_A);
      pthread_mutex_lock (&u->lock);
    }
 The event loop thread first acquires the mutex, and then jumps straight
-into C<ev_loop>:
+into C<ev_run>:
    void *
    l_run (void *thr_arg)
    {
      struct ev_loop *loop = (struct ev_loop *)thr_arg;
      l_acquire (EV_A);
      pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
-     ev_loop (EV_A_ 0);
+     ev_run (EV_A_ 0);
      l_release (EV_A);
      return 0;
    }
 =head3 COROUTINES
 Libev is very accommodating to coroutines ("cooperative threads"):
 libev fully supports nesting calls to its functions from different
-coroutines (e.g. you can call C<ev_loop> on the same loop from two
+coroutines (e.g. you can call C<ev_run> on the same loop from two
 different coroutines, and switch freely between both coroutines running
 the loop, as long as you don't confuse yourself). The only exception is
 that you must not do this from C<ev_periodic> reschedule callbacks.
 Care has been taken to ensure that libev does not keep local state inside
-C<ev_loop>, and other calls do not usually allow for coroutine switches as
+C<ev_run>, and other calls do not usually allow for coroutine switches as
 they do not call any callbacks.
 =head2 COMPILER WARNINGS
 Depending on your compiler and compiler settings, you might get no or a
 maintainable.
 And of course, some compiler warnings are just plain stupid, or simply
 wrong (because they don't actually warn about the condition their message
 seems to warn about). For example, certain older gcc versions had some
-warnings that resulted an extreme number of false positives. These have
+warnings that resulted in an extreme number of false positives. These have
 been fixed, but some people still insist on making code warn-free with
 such buggy versions.
 While libev is written to generate as few warnings as possible,
 "warn-free" code is not a goal, and it is recommended not to build libev
 I suggest using suppression lists.
 =head1 PORTABILITY NOTES
+=head2 GNU/LINUX 32 BIT LIMITATIONS
+GNU/Linux is the only common platform that supports 64 bit file/large file
+interfaces but I<disables> them by default.
+That means that libev compiled in the default environment doesn't support
+files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
+Unfortunately, many programs try to work around this GNU/Linux issue
+by enabling the large file API, which makes them incompatible with the
+standard libev compiled for their system.
+Likewise, libev cannot enable the large file API itself as this would
+suddenly make it incompatible to the default compile time environment,
+i.e. all programs not using special compile switches.
+=head2 OS/X AND DARWIN BUGS
+The whole thing is a bug if you ask me - basically any system interface
+you touch is broken, whether it is locales, poll, kqueue or even the
+OpenGL drivers.
+=head3 C<kqueue> is buggy
+The kqueue syscall is broken in all known versions - most versions support
+only sockets, many support pipes.
+Libev tries to work around this by not using C<kqueue> by default on this
+rotten platform, but of course you can still ask for it when creating a
+loop - embedding a socket-only kqueue loop into a select-based one is
+probably going to work well.
+=head3 C<poll> is buggy
+Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
+implementation by something calling C<kqueue> internally around the 10.5.6
+release, so now C<kqueue> I<and> C<poll> are broken.
+Libev tries to work around this by not using C<poll> by default on
+this rotten platform, but of course you can still ask for it when creating
+a loop.
+=head3 C<select> is buggy
+All that's left is C<select>, and of course Apple found a way to fuck this
+one up as well: On OS/X, C<select> actively limits the number of file
+descriptors you can pass in to 1024 - your program suddenly crashes when
+you use more.
+There is an undocumented "workaround" for this - defining
+C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
+work on OS/X.
+=head2 SOLARIS PROBLEMS AND WORKAROUNDS
+=head3 C<errno> reentrancy
+The default compile environment on Solaris is unfortunately so
+thread-unsafe that you can't even use components/libraries compiled
+without C<-D_REENTRANT> in a threaded program, which, of course, isn't
+defined by default. A valid, if stupid, implementation choice.
+If you want to use libev in threaded environments you have to make sure
+it's compiled with C<_REENTRANT> defined.
+=head3 Event port backend
+The scalable event interface for Solaris is called "event
+ports". Unfortunately, this mechanism is very buggy in all major
+releases. If you run into high CPU usage, your program freezes or you get
+a large number of spurious wakeups, make sure you have all the relevant
+and latest kernel patches applied. No, I don't know which ones, but there
+are multiple ones to apply, and afterwards, event ports actually work
+great.
+If you can't get it to work, you can try running the program by setting
+the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
+C<select> backends.
+=head2 AIX POLL BUG
+AIX unfortunately has a broken C<poll.h> header. Libev works around
+this by trying to avoid the poll backend altogether (i.e. it's not even
+compiled in), which normally isn't a big problem as C<select> works fine
+with large bitsets on AIX, and AIX is dead anyway.
 =head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
+=head3 General issues
 Win32 doesn't support any of the standards (e.g. POSIX) that libev
 requires, and its I/O model is fundamentally incompatible with the POSIX
 model. Libev still offers limited functionality on this platform in
 the form of the C<EVBACKEND_SELECT> backend, and only supports socket
 descriptors. This only applies when using Win32 natively, not when using
-e.g. cygwin.
+e.g. cygwin. Actually, it only applies to the microsofts own compilers,
+as every compielr comes with a slightly differently broken/incompatible
+environment.
 Lifting these limitations would basically require the full
-re-implementation of the I/O system. If you are into these kinds of
+re-implementation of the I/O system. If you are into this kind of thing,
-things, then note that glib does exactly that for you in a very portable
+then note that glib does exactly that for you in a very portable way (note
-way (note also that glib is the slowest event library known to man).
+also that glib is the slowest event library known to man).
 There is no supported compilation method available on windows except
 embedding it into other applications.
 Sensible signal handling is officially unsupported by Microsoft - libev
 you do I<not> compile the F<ev.c> or any other embedded source files!):
    #include "evwrap.h"
    #include "ev.c"
-=over 4
-=item The winsocket select function
+=head3 The winsocket C<select> function
 The winsocket C<select> function doesn't follow POSIX in that it
 requires socket I<handles> and not socket I<file descriptors> (it is
 also extremely buggy). This makes select very inefficient, and also
 requires a mapping from file descriptors to socket handles (the Microsoft
    #define EV_SELECT_IS_WINSOCKET 1   /* forces EV_SELECT_USE_FD_SET, too */
 Note that winsockets handling of fd sets is O(n), so you can easily get a
 complexity in the O(n²) range when using win32.
-=item Limited number of file descriptors
+=head3 Limited number of file descriptors
 Windows has numerous arbitrary (and low) limits on things.
 Early versions of winsocket's select only supported waiting for a maximum
 of C<64> handles (probably owning to the fact that all windows kernels
 runtime libraries. This might get you to about C<512> or C<2048> sockets
 (depending on windows version and/or the phase of the moon). To get more,
 you need to wrap all I/O functions and provide your own fd management, but
 the cost of calling select (O(n²)) will likely make this unworkable.
-=back
 =head2 PORTABILITY REQUIREMENTS
 In addition to a working ISO-C implementation and of course the
 backend-specific APIs, libev relies on a few additional extensions:
 watchers.
 =item C<double> must hold a time value in seconds with enough accuracy
 The type C<double> is used to represent timestamps. It is required to
-have at least 51 bits of mantissa (and 9 bits of exponent), which is good
+have at least 51 bits of mantissa (and 9 bits of exponent), which is
-enough for at least into the year 4000. This requirement is fulfilled by
+good enough for at least into the year 4000 with millisecond accuracy
+(the design goal for libev). This requirement is overfulfilled by
-implementations implementing IEEE 754, which is basically all existing
+implementations using IEEE 754, which is basically all existing ones. With
-ones. With IEEE 754 doubles, you get microsecond accuracy until at least
+IEEE 754 doubles, you get microsecond accuracy until at least 2200.
-2200.
 =back
 If you know of other additional requirements drop me a note.
 involves iterating over all running async watchers or all signal numbers.
 =back
+=head1 PORTING FROM LIBEV 3.X TO 4.X
+The major version 4 introduced some minor incompatible changes to the API.
+At the moment, the C<ev.h> header file tries to implement superficial
+compatibility, so most programs should still compile. Those might be
+removed in later versions of libev, so better update early than late.
+=over 4
+=item function/symbol renames
+A number of functions and symbols have been renamed:
+  ev_loop         => ev_run
+  EVLOOP_NONBLOCK => EVRUN_NOWAIT
+  EVLOOP_ONESHOT  => EVRUN_ONCE
+  ev_unloop       => ev_break
+  EVUNLOOP_CANCEL => EVBREAK_CANCEL
+  EVUNLOOP_ONE    => EVBREAK_ONE
+  EVUNLOOP_ALL    => EVBREAK_ALL
+  EV_TIMEOUT      => EV_TIMER
+  ev_loop_count   => ev_iteration
+  ev_loop_depth   => ev_depth
+  ev_loop_verify  => ev_verify
+Most functions working on C<struct ev_loop> objects don't have an
+C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
+associated constants have been renamed to not collide with the C<struct
+ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
+as all other watcher types. Note that C<ev_loop_fork> is still called
+C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
+typedef.
+=item C<EV_COMPAT3> backwards compatibility mechanism
+The backward compatibility mechanism can be controlled by
+C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
+section.
+=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
+The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
+mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
+and work, but the library code will of course be larger.
+=back
 =head1 GLOSSARY
 =over 4
 =item active
-A watcher is active as long as it has been started (has been attached to
+A watcher is active as long as it has been started and not yet stopped.
-an event loop) but not yet stopped (disassociated from the event loop).
+See L<WATCHER STATES> for details.
 =item application
 In this document, an application is whatever is using libev.
+=item backend
+The part of the code dealing with the operating system interfaces.
 =item callback
 The address of a function that is called when some event has been
 detected. Callbacks are being passed the event loop, the watcher that
 received the event, and the actual event bitset.
-=item callback invocation
+=item callback/watcher invocation
 The act of calling the callback associated with a watcher.
 =item event
 A change of state of some external event, such as data now being available
 for reading on a file descriptor, time having passed or simply not having
 any other events happening anymore.
 In libev, events are represented as single bits (such as C<EV_READ> or
-C<EV_TIMEOUT>).
+C<EV_TIMER>).
 =item event library
 A software package implementing an event model and loop.
 The model used to describe how an event loop handles and processes
 watchers and events.
 =item pending
-A watcher is pending as soon as the corresponding event has been detected,
+A watcher is pending as soon as the corresponding event has been
-and stops being pending as soon as the watcher will be invoked or its
+detected. See L<WATCHER STATES> for details.
-pending status is explicitly cleared by the application.
-A watcher can be pending, but not active. Stopping a watcher also clears
-its pending status.
 =item real time
 The physical time that is observed. It is apparently strictly monotonic :)
 =item watcher
 A data structure that describes interest in certain events. Watchers need
 to be started (attached to an event loop) before they can receive events.
-=item watcher invocation
-The act of calling the callback associated with a watcher.
 =back
 =head1 AUTHOR
 Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.270 by root, Fri Sep 18 21:02:12 2009 UTC vs. Revision 1.316 by root, Fri Oct 22 09:34:01 2010 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.270 by root, Fri Sep 18 21:02:12 2009 UTC vs.
Revision 1.316 by root, Fri Oct 22 09:34:01 2010 UTC