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

Comparing libev/ev.3 (file contents):
Revision 1.30 by root, Wed Nov 28 11:27:29 2007 UTC vs.
Revision 1.38 by root, Fri Dec 7 18:09:38 2007 UTC

 .\}
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
 .IX Title ""<STANDARD INPUT>" 1"
-.TH "<STANDARD INPUT>" 1 "2007-11-28" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation"
 .SH "NAME"
 libev \- a high performance full\-featured event loop written in C
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 watchers\fR, which are relatively small C structures you initialise with the
 details of the event, and then hand it over to libev by \fIstarting\fR the
 watcher.
 .SH "FEATURES"
 .IX Header "FEATURES"
-Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the linux-specific \f(CW\*(C`epoll\*(C'\fR, the
+Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
-bsd-specific \f(CW\*(C`kqueue\*(C'\fR and the solaris-specific event port mechanisms
+BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
-for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR),
+for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
+(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
-absolute timers with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous
+with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
-signals (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and
+(\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event
-event watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
+watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR,
 \&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as
 file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events
 (\f(CW\*(C`ev_fork\*(C'\fR).
 .PP
 It also is quite fast (see this
 might be supported on the current system, you would need to look at
 \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
 recommended ones.
 .Sp
 See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
-.IP "ev_set_allocator (void *(*cb)(void *ptr, size_t size))" 4
+.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
-.IX Item "ev_set_allocator (void *(*cb)(void *ptr, size_t size))"
+.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
-Sets the allocation function to use (the prototype and semantics are
+Sets the allocation function to use (the prototype is similar \- the
-identical to the realloc C function). It is used to allocate and free
+semantics is identical \- to the realloc C function). It is used to
-memory (no surprises here). If it returns zero when memory needs to be
+allocate and free memory (no surprises here). If it returns zero when
-allocated, the library might abort or take some potentially destructive
+memory needs to be allocated, the library might abort or take some
-action. The default is your system realloc function.
+potentially destructive action. The default is your system realloc
+function.
 .Sp
 You could override this function in high-availability programs to, say,
 free some memory if it cannot allocate memory, to use a special allocator,
 or even to sleep a while and retry until some memory is available.
 .Sp
 or setgid) then libev will \fInot\fR look at the environment variable
 \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
 override the flags completely if it is found in the environment. This is
 useful to try out specific backends to test their performance, or to work
 around bugs.
+.ie n .IP """EVFLAG_FORKCHECK""" 4
+.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
+.IX Item "EVFLAG_FORKCHECK"
+Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after
+a fork, you can also make libev check for a fork in each iteration by
+enabling this flag.
+.Sp
+This works by calling \f(CW\*(C`getpid ()\*(C'\fR 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
+Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
+without a syscall and thus \fIvery\fR fast, but my Linux system also has
+\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
+.Sp
+The big advantage of this flag is that you can forget about fork (and
+forget about forgetting to tell libev about forking) when you use this
+flag.
+.Sp
+This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
+environment variable.
 .ie n .IP """EVBACKEND_SELECT""  (value 1, portable select backend)" 4
 .el .IP "\f(CWEVBACKEND_SELECT\fR  (value 1, portable select backend)" 4
 .IX Item "EVBACKEND_SELECT  (value 1, portable select backend)"
 This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
 libev tries to roll its own fd_set with no limits on the number of fds,
 .IP "ev_loop_fork (loop)" 4
 .IX Item "ev_loop_fork (loop)"
 Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
 \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
 after fork, and how you do this is entirely your own problem.
+.IP "unsigned int ev_loop_count (loop)" 4
+.IX Item "unsigned int ev_loop_count (loop)"
+Returns the count of loop iterations for the loop, which is identical to
+the number of times libev did poll for new events. It starts at \f(CW0\fR and
+happily wraps around with enough iterations.
+.Sp
+This value can sometimes be useful as a generation counter of sorts (it
+\&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with
+\&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls.
 .IP "unsigned int ev_backend (loop)" 4
 .IX Item "unsigned int ev_backend (loop)"
 Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in
 use.
 .IP "ev_tstamp ev_now (loop)" 4
 Returns the callback currently set on the watcher.
 .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
 .IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
 Change the callback. You can change the callback at virtually any time
 (modulo threads).
+.IP "ev_set_priority (ev_TYPE *watcher, priority)" 4
+.IX Item "ev_set_priority (ev_TYPE *watcher, priority)"
+.PD 0
+.IP "int ev_priority (ev_TYPE *watcher)" 4
+.IX Item "int ev_priority (ev_TYPE *watcher)"
+.PD
+Set and query the priority of the watcher. The priority is a small
+integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR
+(default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked
+before watchers with lower priority, but priority will not keep watchers
+from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
+.Sp
+This means that priorities are \fIonly\fR used for ordering callback
+invocation after new events have been received. This is useful, for
+example, to reduce latency after idling, or more often, to bind two
+watchers on the same event and make sure one is called first.
+.Sp
+If you need to suppress invocation when higher priority events are pending
+you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
+.Sp
+The default priority used by watchers when no priority has been set is
+always \f(CW0\fR, which is supposed to not be too high and not be too low :).
+.Sp
+Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
+fine, as long as you do not mind that the priority value you query might
+or might not have been adjusted to be within valid range.
 .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
 .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
 Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
 and read at any time, libev will completely ignore it. This can be used
 to associate arbitrary data with your watcher. If you need more data and
 it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning
 \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives.
 .PP
 If you cannot run the fd in non-blocking mode (for example you should not
 play around with an Xlib connection), then you have to seperately re-test
-wether a file descriptor is really ready with a known-to-be good interface
+whether a file descriptor is really ready with a known-to-be good interface
 such as poll (fortunately in our Xlib example, Xlib already does this on
 its own, so its quite safe to use).
 .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
 .IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
 .PD 0
 .IP "ev_timer_again (loop)" 4
 .IX Item "ev_timer_again (loop)"
 This will act as if the timer timed out and restart it again if it is
 repeating. The exact semantics are:
 .Sp
+If the timer is pending, its pending status is cleared.
+.Sp
-If the timer is started but nonrepeating, stop it.
+If the timer is started but nonrepeating, stop it (as if it timed out).
 .Sp
-If the timer is repeating, either start it if necessary (with the repeat
+If the timer is repeating, either start it if necessary (with the
-value), or reset the running timer to the repeat value.
+\&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value.
 .Sp
 This sounds a bit complicated, but here is a useful and typical
-example: Imagine you have a tcp connection and you want a so-called
+example: Imagine you have a tcp connection and you want a so-called idle
-idle timeout, that is, you want to be called when there have been,
+timeout, that is, you want to be called when there have been, say, 60
-say, 60 seconds of inactivity on the socket. The easiest way to do
+seconds of inactivity on the socket. The easiest way to do this is to
-this is to configure an \f(CW\*(C`ev_timer\*(C'\fR with \f(CW\*(C`after\*(C'\fR=\f(CW\*(C`repeat\*(C'\fR=\f(CW60\fR and calling
+configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call
 \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If
 you go into an idle state where you do not expect data to travel on the
-socket, you can stop the timer, and again will automatically restart it if
+socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will
-need be.
+automatically restart it if need be.
 .Sp
-You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether
+That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR
-and only ever use the \f(CW\*(C`repeat\*(C'\fR value:
+altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR:
 .Sp
 .Vb 8
 \&   ev_timer_init (timer, callback, 0., 5.);
 \&   ev_timer_again (loop, timer);
 \&   ...
 \&   ...
 \&   timer->again = 10.;
 \&   ev_timer_again (loop, timer);
 .Ve
 .Sp
-This is more efficient then stopping/starting the timer eahc time you want
+This is more slightly efficient then stopping/starting the timer each time
-to modify its timeout value.
+you want to modify its timeout value.
 .IP "ev_tstamp repeat [read\-write]" 4
 .IX Item "ev_tstamp repeat [read-write]"
 The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
 or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
 which is also when any modifications are taken into account.
 not exist\*(R" is a status change like any other. The condition \*(L"path does
 not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is
 otherwise always forced to be at least one) and all the other fields of
 the stat buffer having unspecified contents.
 .PP
+The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is
+relative and your working directory changes, the behaviour is undefined.
+.PP
 Since there is no standard to do this, the portable implementation simply
 calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You
 can specify a recommended polling interval for this case. If you specify
 a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable,
 unspecified default\fR value will be used (which you can expect to be around
 \&  ev_stat_start (loop, &passwd);
 .Ve
 .ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
 .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
 .IX Subsection "ev_idle - when you've got nothing better to do..."
-Idle watchers trigger events when there are no other events are pending
+Idle watchers trigger events when no other events of the same or higher
-(prepare, check and other idle watchers do not count). That is, as long
+priority are pending (prepare, check and other idle watchers do not
-as your process is busy handling sockets or timeouts (or even signals,
+count).
-imagine) it will not be triggered. But when your process is idle all idle
+.PP
-watchers are being called again and again, once per event loop iteration \-
+That is, as long as your process is busy handling sockets or timeouts
+(or even signals, imagine) of the same or higher priority it will not be
+triggered. But when your process is idle (or only lower-priority watchers
+are pending), the idle watchers are being called once per event loop
-until stopped, that is, or your process receives more events and becomes
+iteration \- until stopped, that is, or your process receives more events
-busy.
+and becomes busy again with higher priority stuff.
 .PP
 The most noteworthy effect is that as long as any idle watchers are
 active, the process will not block when waiting for new events.
 .PP
 Apart from keeping your process non-blocking (which is a useful
 \&    if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
 \&    if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
 \&  }
 .Ve
 .PP
-.Vb 7
+.Vb 8
 \&  // create io watchers for each fd and a timer before blocking
 \&  static void
 \&  adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
 \&  {
-\&    int timeout = 3600000;truct pollfd fds [nfd];
+\&    int timeout = 3600000;
+\&    struct pollfd fds [nfd];
 \&    // actual code will need to loop here and realloc etc.
 \&    adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
 .Ve
 .PP
 .Vb 3
 \&  }
 .Ve
 .SH "MACRO MAGIC"
 .IX Header "MACRO MAGIC"
 Libev can be compiled with a variety of options, the most fundemantal is
-\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and
+\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and
 callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
 .PP
 To make it easier to write programs that cope with either variant, the
 following macros are defined:
 .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4
 .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
 .IX Item "EV_DEFAULT, EV_DEFAULT_"
 Similar to the other two macros, this gives you the value of the default
 loop, if multiple loops are supported (\*(L"ev loop default\*(R").
 .PP
-Example: Declare and initialise a check watcher, working regardless of
+Example: Declare and initialise a check watcher, utilising the above
-wether multiple loops are supported or not.
+macros so it will work regardless of whether multiple loops are supported
+or not.
 .PP
 .Vb 5
 \&  static void
 \&  check_cb (EV_P_ ev_timer *w, int revents)
 \&  {
 .Vb 1
 \&  ev_win32.c      required on win32 platforms only
 .Ve
 .PP
 .Vb 5
-\&  ev_select.c     only when select backend is enabled (which is by default)
+\&  ev_select.c     only when select backend is enabled (which is enabled by default)
 \&  ev_poll.c       only when poll backend is enabled (disabled by default)
 \&  ev_epoll.c      only when the epoll backend is enabled (disabled by default)
 \&  ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)
 \&  ev_port.c       only when the solaris port backend is enabled (disabled by default)
 .Ve
 .IP "\s-1EV_PERIODIC_ENABLE\s0" 4
 .IX Item "EV_PERIODIC_ENABLE"
 If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If
 defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
 code.
+.IP "\s-1EV_IDLE_ENABLE\s0" 4
+.IX Item "EV_IDLE_ENABLE"
+If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If
+defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of
+code.
 .IP "\s-1EV_EMBED_ENABLE\s0" 4
 .IX Item "EV_EMBED_ENABLE"
 If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If
 defined to be \f(CW0\fR, then they are not.
 .IP "\s-1EV_STAT_ENABLE\s0" 4
 interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
 will be compiled. It is pretty complex because it provides its own header
 file.
 .Sp
 The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
-that everybody includes and which overrides some autoconf choices:
+that everybody includes and which overrides some configure choices:
 .Sp
-.Vb 4
+.Vb 9
+\&  #define EV_MINIMAL 1
 \&  #define EV_USE_POLL 0
 \&  #define EV_MULTIPLICITY 0
-\&  #define EV_PERIODICS 0
+\&  #define EV_PERIODIC_ENABLE 0
+\&  #define EV_STAT_ENABLE 0
+\&  #define EV_FORK_ENABLE 0
 \&  #define EV_CONFIG_H <config.h>
+\&  #define EV_MINPRI 0
+\&  #define EV_MAXPRI 0
 .Ve
 .Sp
 .Vb 1
 \&  #include "ev++.h"
 .Ve

Diff Legend

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

Comparing libev/ev.3 (file contents): Revision 1.30 by root, Wed Nov 28 11:27:29 2007 UTC vs. Revision 1.38 by root, Fri Dec 7 18:09:38 2007 UTC

Diff Legend

Comparing libev/ev.3 (file contents):
Revision 1.30 by root, Wed Nov 28 11:27:29 2007 UTC vs.
Revision 1.38 by root, Fri Dec 7 18:09:38 2007 UTC