*** empty log message ***

[software/libev.git] / ev.pod

diff --git a/ev.pod b/ev.pod
index ee162ca1e6306e410cabc900a99392cccee8bb37..d1d83489e6b0ef315c676d4e0ad178047a0c7a11 100644 (file)
--- a/ev.pod
+++ b/ev.pod
@@ -55,7 +55,7 @@ web page you might find easier to navigate when reading it for the first
 time: L<http://cvs.schmorp.de/libev/ev.html>.
 
 Libev is an event loop: you register interest in certain events (such as a
 time: L<http://cvs.schmorp.de/libev/ev.html>.
 
 Libev is an event loop: you register interest in certain events (such as a

-file descriptor being readable or a timeout occuring), and it will manage
+file descriptor being readable or a timeout occurring), and it will manage

 these event sources and provide your program with events.
 
 To do this, it must take more or less complete control over your process
 these event sources and provide your program with events.
 
 To do this, it must take more or less complete control over your process


@@ -100,7 +100,9 @@ Libev represents time as a single floating point number, representing the
 the beginning of 1970, details are complicated, don't ask). This type is
 called C<ev_tstamp>, which is what you should use too. It usually aliases
 to the C<double> type in C, and when you need to do any calculations on
 the beginning of 1970, details are complicated, don't ask). This type is
 called C<ev_tstamp>, which is what you should use too. It usually aliases
 to the C<double> type in C, and when you need to do any calculations on

-it, you should treat it as such.
+it, you should treat it as some floatingpoint value. Unlike the name
+component C<stamp> might indicate, it is also used for time differences
+throughout libev.

 
 =head1 GLOBAL FUNCTIONS
 
 
 =head1 GLOBAL FUNCTIONS
 


@@ -115,6 +117,12 @@ Returns the current time as libev would use it. Please note that the
 C<ev_now> function is usually faster and also often returns the timestamp
 you actually want to know.
 
 C<ev_now> function is usually faster and also often returns the timestamp
 you actually want to know.
 

+=item ev_sleep (ev_tstamp interval)
+
+Sleep for the given interval: The current thread will be blocked until
+either it is interrupted or the given time interval has passed. Basically
+this is a subsecond-resolution C<sleep ()>.
+

 =item int ev_version_major ()
 
 =item int ev_version_minor ()
 =item int ev_version_major ()
 
 =item int ev_version_minor ()


@@ -313,15 +321,18 @@ lot of inactive fds). It scales similarly to select, i.e. O(total_fds).
 =item C<EVBACKEND_EPOLL>   (value 4, Linux)
 
 For few fds, this backend is a bit little slower than poll and select,
 =item C<EVBACKEND_EPOLL>   (value 4, Linux)
 
 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).
-
-While stopping and starting an I/O watcher in the same iteration will
-result in some caching, there is still a syscall per such incident
+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). The epoll design has a number
+of shortcomings, such as silently dropping events in some hard-to-detect
+cases and rewiring a syscall per fd change, no fork support and bad
+support for dup:
+
+While stopping, setting and starting an I/O watcher in the same iteration
+will result in some caching, there is still a syscall per such incident

 (because the fd could point to a different file description now), so its
 (because the fd could point to a different file description now), so its

-best to avoid that. Also, dup()ed file descriptors might not work very
-well if you register events for both fds.
+best to avoid that. Also, C<dup ()>'ed file descriptors might not work
+very well if you register events for both fds.

 
 Please note that epoll sometimes generates spurious notifications, so you
 need to use non-blocking I/O or other means to avoid blocking when no data
 
 Please note that epoll sometimes generates spurious notifications, so you
 need to use non-blocking I/O or other means to avoid blocking when no data


@@ -330,17 +341,20 @@ need to use non-blocking I/O or other means to avoid blocking when no data
 =item C<EVBACKEND_KQUEUE>  (value 8, most BSD clones)
 
 Kqueue deserves special mention, as at the time of this writing, it
 =item C<EVBACKEND_KQUEUE>  (value 8, most BSD clones)
 
 Kqueue deserves special mention, as at the time of this writing, it

-was broken on all BSDs except NetBSD (usually it doesn't work with
-anything but sockets and pipes, except on Darwin, where of course its
-completely useless). For this reason its not being "autodetected"
+was broken on I<all> BSDs (usually it doesn't work with anything but
+sockets and pipes, except on Darwin, where of course it's completely
+useless. On NetBSD, it seems to work for all the FD types I tested, so it
+is used by default there). For this reason it's not being "autodetected"

 unless you explicitly specify it explicitly in the flags (i.e. using
 unless you explicitly specify it explicitly in the flags (i.e. using

-C<EVBACKEND_KQUEUE>).
+C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
+system like NetBSD.

 
 It scales in the same way as the epoll backend, but the interface to the
 
 It scales in the same way as the epoll backend, but the interface to the

-kernel is more efficient (which says nothing about its actual speed, of
-course). While starting and stopping an I/O watcher does not cause an
-extra syscall as with epoll, it still adds up to four event changes per
-incident, so its best to avoid that.
+kernel is more efficient (which says nothing about its actual speed,
+of course). While stopping, setting and starting an I/O watcher does
+never cause an extra syscall as with epoll, it still adds up to two event
+changes per incident, support for C<fork ()> is very bad and it drops fds
+silently in similarly hard-to-detetc cases.

 
 =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
 
 
 =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
 


@@ -348,10 +362,10 @@ This is not implemented yet (and might never be).
 
 =item C<EVBACKEND_PORT>    (value 32, Solaris 10)
 
 
 =item C<EVBACKEND_PORT>    (value 32, Solaris 10)
 

-This uses the Solaris 10 port mechanism. As with everything on Solaris,
+This uses the Solaris 10 event port mechanism. As with everything on Solaris,

 it's really slow, but it still scales very well (O(active_fds)).
 
 it's really slow, but it still scales very well (O(active_fds)).
 

-Please note that solaris ports can result in a lot of spurious
+Please note that solaris event ports can deliver a lot of spurious

 notifications, so you need to use non-blocking I/O or other means to avoid
 blocking when no data (or space) is available.
 
 notifications, so you need to use non-blocking I/O or other means to avoid
 blocking when no data (or space) is available.
 


@@ -404,9 +418,18 @@ etc.). None of the active event watchers will be stopped in the normal
 sense, so e.g. C<ev_is_active> might still return true. It is your
 responsibility to either stop all watchers cleanly yoursef I<before>
 calling this function, or cope with the fact afterwards (which is usually
 sense, so e.g. C<ev_is_active> might still return true. It is your
 responsibility to either stop all watchers cleanly yoursef I<before>
 calling this function, or cope with the fact afterwards (which is usually

-the easiest thing, youc na just ignore the watchers and/or C<free ()> them
+the easiest thing, you can just ignore the watchers and/or C<free ()> them

 for example).
 
 for example).
 

+Note that certain global state, such as signal state, will not be freed by
+this function, and related watchers (such as signal and child watchers)
+would need to be stopped manually.
+
+In general it is not advisable to call this function except in the
+rare occasion where you really need to free e.g. the signal handling
+pipe fds. If you need dynamically allocated loops it is better to use
+C<ev_loop_new> and C<ev_loop_destroy>).
+

 =item ev_loop_destroy (loop)
 
 Like C<ev_default_destroy>, but destroys an event loop created by an
 =item ev_loop_destroy (loop)
 
 Like C<ev_default_destroy>, but destroys an event loop created by an


@@ -460,7 +483,7 @@ Returns the current "event loop time", which is the time the event loop
 received events and started processing them. This timestamp does not
 change as long as callbacks are being processed, and this is also the base
 time used for relative timers. You can treat it as the timestamp of the
 received events and started processing them. This timestamp does not
 change as long as callbacks are being processed, and this is also the base
 time used for relative timers. You can treat it as the timestamp of the

-event occuring (or more correctly, libev finding out about it).
+event occurring (or more correctly, libev finding out about it).

 
 =item ev_loop (loop, int flags)
 
 
 =item ev_loop (loop, int flags)
 


@@ -554,6 +577,40 @@ Example: For some weird reason, unregister the above signal handler again.
   ev_ref (loop);
   ev_signal_stop (loop, &exitsig);
 
   ev_ref (loop);
   ev_signal_stop (loop, &exitsig);
 

+=item ev_set_io_collect_interval (loop, ev_tstamp interval)
+
+=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
+
+These advanced functions influence the time that libev will spend waiting
+for events. Both are by default C<0>, meaning that libev will try to
+invoke timer/periodic callbacks and I/O callbacks with minimum latency.
+
+Setting these to a higher value (the C<interval> I<must> be >= C<0>)
+allows libev to delay invocation of I/O and timer/periodic callbacks to
+increase efficiency of loop iterations.
+
+The background is that sometimes your program runs just fast enough to
+handle one (or very few) event(s) per loop iteration. While this makes
+the program responsive, it also wastes a lot of CPU time to poll for new
+events, especially with backends like C<select ()> which have a high
+overhead for the actual polling but can deliver many events at once.
+
+By setting a higher I<io collect interval> you allow libev to spend more
+time collecting I/O events, so you can handle more events per iteration,
+at the cost of increasing latency. Timeouts (both C<ev_periodic> and
+C<ev_timer>) will be not affected.
+
+Likewise, by setting a higher I<timeout collect interval> you allow libev
+to spend more time collecting timeouts, at the expense of increased
+latency (the watcher callback will be called later). C<ev_io> watchers
+will not be affected.
+
+Many programs can usually benefit by setting the io collect interval to
+a value near C<0.1> or so, which is often enough for interactive servers
+(of course not for games), likewise for timeouts. It usually doesn't make
+much sense to set it to a lower value than C<0.01>, as this approsaches
+the timing granularity of most systems.
+

 =back
 
 
 =back
 
 


@@ -915,7 +972,7 @@ its own, so its quite safe to use).
 
 =head3 The special problem of disappearing file descriptors
 
 
 =head3 The special problem of disappearing file descriptors
 

-Some backends (e.g kqueue, epoll) need to be told about closing a file
+Some backends (e.g. kqueue, epoll) need to be told about closing a file

 descriptor (either by calling C<close> explicitly or by any other means,
 such as C<dup>). The reason is that you register interest in some file
 descriptor, but when it goes away, the operating system will silently drop
 descriptor (either by calling C<close> explicitly or by any other means,
 such as C<dup>). The reason is that you register interest in some file
 descriptor, but when it goes away, the operating system will silently drop


@@ -934,6 +991,28 @@ This is how one would do it normally anyway, the important point is that
 the libev application should not optimise around libev but should leave
 optimisations to libev.
 
 the libev application should not optimise around libev but should leave
 optimisations to libev.
 

+=head3 The special problem of dup'ed file descriptors
+
+Some backends (e.g. epoll), cannot register events for file descriptors,
+but only events for the underlying file descriptions. That menas when you
+have C<dup ()>'ed file descriptors and register events for them, only one
+file descriptor might actually receive events.
+
+There is no workaorund possible except not registering events
+for potentially C<dup ()>'ed file descriptors or to resort to
+C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
+
+=head3 The special problem of fork
+
+Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
+useless behaviour. Libev fully supports fork, but needs to be told about
+it in the child.
+
+To support fork in your programs, you either have to call
+C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
+enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
+C<EVBACKEND_POLL>.
+

 
 =head3 Watcher-Specific Functions
 
 
 =head3 Watcher-Specific Functions
 


@@ -1222,6 +1301,11 @@ The current reschedule callback, or C<0>, if this functionality is
 switched off. Can be changed any time, but changes only take effect when
 the periodic timer fires or C<ev_periodic_again> is being called.
 
 switched off. Can be changed any time, but changes only take effect when
 the periodic timer fires or C<ev_periodic_again> is being called.
 

+=item ev_tstamp at [read-only]
+
+When active, contains the absolute time that the watcher is supposed to
+trigger next.
+

 =back
 
 Example: Call a callback every hour, or, more precisely, whenever the
 =back
 
 Example: Call a callback every hour, or, more precisely, whenever the


@@ -1692,7 +1776,7 @@ this.
 This is a rather advanced watcher type that lets you embed one event loop
 into another (currently only C<ev_io> events are supported in the embedded
 loop, other types of watchers might be handled in a delayed or incorrect
 This is a rather advanced watcher type that lets you embed one event loop
 into another (currently only C<ev_io> events are supported in the embedded
 loop, other types of watchers might be handled in a delayed or incorrect

-fashion and must not be used).
+fashion and must not be used). (See portability notes, below).

 
 There are primarily two reasons you would want that: work around bugs and
 prioritise I/O.
 
 There are primarily two reasons you would want that: work around bugs and
 prioritise I/O.


@@ -1757,6 +1841,22 @@ create it, and if that fails, use the normal loop for everything:
   else
     loop_lo = loop_hi;
 
   else
     loop_lo = loop_hi;
 

+=head2 Portability notes
+
+Kqueue is nominally embeddable, but this is broken on all BSDs that I
+tried, in various ways. Usually the embedded event loop will simply never
+receive events, sometimes it will only trigger a few times, sometimes in a
+loop. Epoll is also nominally embeddable, but many Linux kernel versions
+will always eport the epoll fd as ready, even when no events are pending.
+
+While libev allows embedding these backends (they are contained in
+C<ev_embeddable_backends ()>), take extreme care that it will actually
+work.
+
+When in doubt, create a dynamic event loop forced to use sockets (this
+usually works) and possibly another thread and a pipe or so to report to
+your main event loop.
+

 =head3 Watcher-Specific Functions and Data Members
 
 =over 4
 =head3 Watcher-Specific Functions and Data Members
 
 =over 4


@@ -1777,7 +1877,7 @@ 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
 apropriate way for embedded loops.
 
 similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
 apropriate way for embedded loops.
 

-=item struct ev_loop *loop [read-only]
+=item struct ev_loop *other [read-only]

 
 The embedded event loop.
 
 
 The embedded event loop.
 


@@ -1794,6 +1894,8 @@ and only in the child after the fork. If whoever good citizen calling
 C<ev_default_fork> cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.
 
 C<ev_default_fork> cheats and calls it in the wrong process, the fork
 handlers will be invoked, too, of course.
 

+=head3 Watcher-Specific Functions and Data Members
+

 =over 4
 
 =item ev_fork_init (ev_signal *, callback)
 =over 4
 
 =item ev_fork_init (ev_signal *, callback)


@@ -2019,16 +2121,16 @@ constructor already stores the event loop.
 
 Stops the watcher if it is active. Again, no C<loop> argument.
 
 
 Stops the watcher if it is active. Again, no C<loop> argument.
 

-=item w->again ()       C<ev::timer>, C<ev::periodic> only
+=item w->again () (C<ev::timer>, C<ev::periodic> only)

 
 For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
 C<ev_TYPE_again> function.
 
 
 For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
 C<ev_TYPE_again> function.
 

-=item w->sweep ()       C<ev::embed> only
+=item w->sweep () (C<ev::embed> only)

 
 Invokes C<ev_embed_sweep>.
 
 
 Invokes C<ev_embed_sweep>.
 

-=item w->update ()      C<ev::stat> only
+=item w->update () (C<ev::stat> only)

 
 Invokes C<ev_stat_stat>.
 
 
 Invokes C<ev_stat_stat>.
 


@@ -2058,9 +2160,9 @@ the constructor.
 
 =head1 MACRO MAGIC
 
 
 =head1 MACRO MAGIC
 

-Libev can be compiled with a variety of options, the most fundemantal is
-C<EV_MULTIPLICITY>. This option determines whether (most) functions and
-callbacks have an initial C<struct ev_loop *> argument.
+Libev can be compiled with a variety of options, the most fundamantal
+of which is C<EV_MULTIPLICITY>. This option determines whether (most)
+functions and callbacks have an initial C<struct ev_loop *> argument.

 
 To make it easier to write programs that cope with either variant, the
 following macros are defined:
 
 To make it easier to write programs that cope with either variant, the
 following macros are defined:


@@ -2124,7 +2226,7 @@ applications. Examples of applications that embed it include the Deliantra
 Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
 and rxvt-unicode.
 
 Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
 and rxvt-unicode.
 

-The goal is to enable you to just copy the neecssary files into your
+The goal is to enable you to just copy the necessary files into your

 source directory without having to change even a single line in them, so
 you can easily upgrade by simply copying (or having a checked-out copy of
 libev somewhere in your source tree).
 source directory without having to change even a single line in them, so
 you can easily upgrade by simply copying (or having a checked-out copy of
 libev somewhere in your source tree).


@@ -2224,7 +2326,7 @@ If defined to be C<1>, libev will try to detect the availability of the
 monotonic clock option at both compiletime and runtime. Otherwise no use
 of the monotonic clock option will be attempted. If you enable this, you
 usually have to link against librt or something similar. Enabling it when
 monotonic clock option at both compiletime and runtime. Otherwise no use
 of the monotonic clock option will be attempted. If you enable this, you
 usually have to link against librt or something similar. Enabling it when

-the functionality isn't available is safe, though, althoguh you have
+the functionality isn't available is safe, though, although you have

 to make sure you link against any libraries where the C<clock_gettime>
 function is hiding in (often F<-lrt>).
 
 to make sure you link against any libraries where the C<clock_gettime>
 function is hiding in (often F<-lrt>).
 


@@ -2234,8 +2336,13 @@ If defined to be C<1>, libev will try to detect the availability of the
 realtime clock option at compiletime (and assume its availability at
 runtime if successful). Otherwise no use of the realtime clock option will
 be attempted. This effectively replaces C<gettimeofday> by C<clock_get
 realtime clock option at compiletime (and assume its availability at
 runtime if successful). Otherwise no use of the realtime clock option will
 be attempted. This effectively replaces C<gettimeofday> by C<clock_get

-(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries
-in the description of C<EV_USE_MONOTONIC>, though.
+(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
+note about libraries in the description of C<EV_USE_MONOTONIC>, though.
+
+=item EV_USE_NANOSLEEP
+
+If defined to be C<1>, libev will assume that C<nanosleep ()> is available
+and will use it for delays. Otherwise it will use C<select ()>.

 
 =item EV_USE_SELECT
 
 
 =item EV_USE_SELECT
 


@@ -2424,11 +2531,36 @@ For example, the perl EV module uses something like this:
 
 Can be used to change the callback member declaration in each watcher,
 and the way callbacks are invoked and set. Must expand to a struct member
 
 Can be used to change the callback member declaration in each watcher,
 and the way callbacks are invoked and set. Must expand to a struct member

-definition and a statement, respectively. See the F<ev.v> header file for
+definition and a statement, respectively. See the F<ev.h> header file for

 their default definitions. One possible use for overriding these is to
 avoid the C<struct ev_loop *> as first argument in all cases, or to use
 method calls instead of plain function calls in C++.
 
 their default definitions. One possible use for overriding these is to
 avoid the C<struct ev_loop *> as first argument in all cases, or to use
 method calls instead of plain function calls in C++.
 

+=head2 EXPORTED API SYMBOLS
+
+If you need to re-export the API (e.g. via a dll) and you need a list of
+exported symbols, you can use the provided F<Symbol.*> files which list
+all public symbols, one per line:
+
+  Symbols.ev      for libev proper
+  Symbols.event   for the libevent emulation
+
+This can also be used to rename all public symbols to avoid clashes with
+multiple versions of libev linked together (which is obviously bad in
+itself, but sometimes it is inconvinient to avoid this).
+
+A sed command like this will create wrapper C<#define>'s that you need to
+include before including F<ev.h>:
+
+   <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
+
+This would create a file F<wrap.h> which essentially looks like this:
+
+   #define ev_backend     myprefix_ev_backend
+   #define ev_check_start myprefix_ev_check_start
+   #define ev_check_stop  myprefix_ev_check_stop
+   ...
+

 =head2 EXAMPLES
 
 For a real-world example of a program the includes libev
 =head2 EXAMPLES
 
 For a real-world example of a program the includes libev