*** empty log message ***

[software/libev.git] / ev.pod

diff --git a/ev.pod b/ev.pod
index 1b797df5dd8f96b547b1b7c2dc9a90836328ce2e..8b57eb449d6ca81e84facd66284cedbd73251dcd 100644 (file)
--- a/ev.pod
+++ b/ev.pod
@@ -705,7 +705,7 @@ is pending (but not active) you must not call an init function on it (but
 C<ev_TYPE_set> is safe) and you must make sure the watcher is available to
 libev (e.g. you cnanot C<free ()> it).
 
 C<ev_TYPE_set> is safe) and you must make sure the watcher is available to
 libev (e.g. you cnanot C<free ()> it).
 

-=item callback = ev_cb (ev_TYPE *watcher)
+=item callback ev_cb (ev_TYPE *watcher)

 
 Returns the callback currently set on the watcher.
 
 
 Returns the callback currently set on the watcher.
 


@@ -743,8 +743,37 @@ can cast it back to your own type:
     ...
   }
 
     ...
   }
 

-More interesting and less C-conformant ways of catsing your callback type
-have been omitted....
+More interesting and less C-conformant ways of casting your callback type
+instead have been omitted.
+
+Another common scenario is having some data structure with multiple
+watchers:
+
+  struct my_biggy
+  {
+    int some_data;
+    ev_timer t1;
+    ev_timer t2;
+  }
+
+In this case getting the pointer to C<my_biggy> is a bit more complicated,
+you need to use C<offsetof>:
+
+  #include <stddef.h>
+
+  static void
+  t1_cb (EV_P_ struct ev_timer *w, int revents)
+  {
+    struct my_biggy big = (struct my_biggy *
+      (((char *)w) - offsetof (struct my_biggy, t1));
+  }
+
+  static void
+  t2_cb (EV_P_ struct ev_timer *w, int revents)
+  {
+    struct my_biggy big = (struct my_biggy *
+      (((char *)w) - offsetof (struct my_biggy, t2));
+  }

 
 
 =head1 WATCHER TYPES
 
 
 =head1 WATCHER TYPES


@@ -1195,7 +1224,7 @@ otherwise always forced to be at least one) and all the other fields of
 the stat buffer having unspecified contents.
 
 Since there is no standard to do this, the portable implementation simply
 the stat buffer having unspecified contents.
 
 Since there is no standard to do this, the portable implementation simply

-calls C<stat (2)> regulalry on the path to see if it changed somehow. You
+calls C<stat (2)> 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 C<0> (highly recommended!) then a I<suitable,
 unspecified default> value will be used (which you can expect to be around
 can specify a recommended polling interval for this case. If you specify
 a polling interval of C<0> (highly recommended!) then a I<suitable,
 unspecified default> value will be used (which you can expect to be around


@@ -1207,8 +1236,13 @@ This watcher type is not meant for massive numbers of stat watchers,
 as even with OS-supported change notifications, this can be
 resource-intensive.
 
 as even with OS-supported change notifications, this can be
 resource-intensive.
 

-At the time of this writing, no specific OS backends are implemented, but
-if demand increases, at least a kqueue and inotify backend will be added.
+At the time of this writing, only the Linux inotify interface is
+implemented (implementing kqueue support is left as an exercise for the
+reader). Inotify will be used to give hints only and should not change the
+semantics of C<ev_stat> watchers, which means that libev sometimes needs
+to fall back to regular polling again even with inotify, but changes are
+usually detected immediately, and if the file exists there will be no
+polling.

 
 =over 4
 
 
 =over 4
 


@@ -1987,6 +2021,12 @@ backend for Solaris 10 systems.
 
 reserved for future expansion, works like the USE symbols above.
 
 
 reserved for future expansion, works like the USE symbols above.
 

+=item EV_USE_INOTIFY
+
+If defined to be C<1>, libev will compile in support for the Linux inotify
+interface to speed up C<ev_stat> watchers. Its actual availability will
+be detected at runtime.
+

 =item EV_H
 
 The name of the F<ev.h> header file used to include it. The default if
 =item EV_H
 
 The name of the F<ev.h> header file used to include it. The default if


@@ -2051,7 +2091,15 @@ some inlining decisions, saves roughly 30% codesize of amd64.
 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
 than enough. If you need to manage thousands of children you might want to
 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
 than enough. If you need to manage thousands of children you might want to

-increase this value.
+increase this value (I<must> be a power of two).
+
+=item EV_INOTIFY_HASHSIZE
+
+C<ev_staz> 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>),
+usually more than enough. If you need to manage thousands of C<ev_stat>
+watchers you might want to increase this value (I<must> be a power of
+two).

 
 =item EV_COMMON
 
 
 =item EV_COMMON
 


@@ -2121,7 +2169,7 @@ documentation for C<ev_default_init>.
 
 =item Stopping check/prepare/idle watchers: O(1)
 
 
 =item Stopping check/prepare/idle watchers: O(1)
 

-=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))
+=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))

 
 =item Finding the next timer per loop iteration: O(1)
 
 
 =item Finding the next timer per loop iteration: O(1)