ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.html
(Generate patch)

Comparing libev/ev.html (file contents):
Revision 1.56 by root, Tue Nov 27 20:38:07 2007 UTC vs.
Revision 1.63 by root, Thu Nov 29 20:05:59 2007 UTC

… …
4<head> 4<head>
5 <title>libev</title> 5 <title>libev</title>
6 <meta name="description" content="Pod documentation for libev" /> 6 <meta name="description" content="Pod documentation for libev" />
7 <meta name="inputfile" content="&lt;standard input&gt;" /> 7 <meta name="inputfile" content="&lt;standard input&gt;" />
8 <meta name="outputfile" content="&lt;standard output&gt;" /> 8 <meta name="outputfile" content="&lt;standard output&gt;" />
9 <meta name="created" content="Tue Nov 27 21:38:05 2007" /> 9 <meta name="created" content="Thu Nov 29 21:05:58 2007" />
10 <meta name="generator" content="Pod::Xhtml 1.57" /> 10 <meta name="generator" content="Pod::Xhtml 1.57" />
11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> 11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12<body> 12<body>
13<div class="pod"> 13<div class="pod">
14<!-- INDEX START --> 14<!-- INDEX START -->
… …
133watcher.</p> 133watcher.</p>
134 134
135</div> 135</div>
136<h1 id="FEATURES">FEATURES</h1> 136<h1 id="FEATURES">FEATURES</h1>
137<div id="FEATURES_CONTENT"> 137<div id="FEATURES_CONTENT">
138<p>Libev supports <code>select</code>, <code>poll</code>, the linux-specific <code>epoll</code>, the 138<p>Libev supports <code>select</code>, <code>poll</code>, the Linux-specific <code>epoll</code>, the
139bsd-specific <code>kqueue</code> and the solaris-specific event port mechanisms 139BSD-specific <code>kqueue</code> and the Solaris-specific event port mechanisms
140for file descriptor events (<code>ev_io</code>), relative timers (<code>ev_timer</code>), 140for file descriptor events (<code>ev_io</code>), the Linux <code>inotify</code> interface
141(for <code>ev_stat</code>), relative timers (<code>ev_timer</code>), absolute timers
141absolute timers with customised rescheduling (<code>ev_periodic</code>), synchronous 142with customised rescheduling (<code>ev_periodic</code>), synchronous signals
142signals (<code>ev_signal</code>), process status change events (<code>ev_child</code>), and 143(<code>ev_signal</code>), process status change events (<code>ev_child</code>), and event
143event watchers dealing with the event loop mechanism itself (<code>ev_idle</code>, 144watchers dealing with the event loop mechanism itself (<code>ev_idle</code>,
144<code>ev_embed</code>, <code>ev_prepare</code> and <code>ev_check</code> watchers) as well as 145<code>ev_embed</code>, <code>ev_prepare</code> and <code>ev_check</code> watchers) as well as
145file watchers (<code>ev_stat</code>) and even limited support for fork events 146file watchers (<code>ev_stat</code>) and even limited support for fork events
146(<code>ev_fork</code>).</p> 147(<code>ev_fork</code>).</p>
147<p>It also is quite fast (see this 148<p>It also is quite fast (see this
148<a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent 149<a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent
… …
229might be supported on the current system, you would need to look at 230might be supported on the current system, you would need to look at
230<code>ev_embeddable_backends () &amp; ev_supported_backends ()</code>, likewise for 231<code>ev_embeddable_backends () &amp; ev_supported_backends ()</code>, likewise for
231recommended ones.</p> 232recommended ones.</p>
232 <p>See the description of <code>ev_embed</code> watchers for more info.</p> 233 <p>See the description of <code>ev_embed</code> watchers for more info.</p>
233 </dd> 234 </dd>
234 <dt>ev_set_allocator (void *(*cb)(void *ptr, size_t size))</dt> 235 <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt>
235 <dd> 236 <dd>
236 <p>Sets the allocation function to use (the prototype and semantics are 237 <p>Sets the allocation function to use (the prototype is similar - the
237identical to the realloc C function). It is used to allocate and free 238semantics is identical - to the realloc C function). It is used to
238memory (no surprises here). If it returns zero when memory needs to be 239allocate and free memory (no surprises here). If it returns zero when
239allocated, the library might abort or take some potentially destructive 240memory needs to be allocated, the library might abort or take some
240action. The default is your system realloc function.</p> 241potentially destructive action. The default is your system realloc
242function.</p>
241 <p>You could override this function in high-availability programs to, say, 243 <p>You could override this function in high-availability programs to, say,
242free some memory if it cannot allocate memory, to use a special allocator, 244free some memory if it cannot allocate memory, to use a special allocator,
243or even to sleep a while and retry until some memory is available.</p> 245or even to sleep a while and retry until some memory is available.</p>
244 <p>Example: Replace the libev allocator with one that waits a bit and then 246 <p>Example: Replace the libev allocator with one that waits a bit and then
245retries).</p> 247retries).</p>
… …
323or setgid) then libev will <i>not</i> look at the environment variable 325or setgid) then libev will <i>not</i> look at the environment variable
324<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will 326<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
325override the flags completely if it is found in the environment. This is 327override the flags completely if it is found in the environment. This is
326useful to try out specific backends to test their performance, or to work 328useful to try out specific backends to test their performance, or to work
327around bugs.</p> 329around bugs.</p>
330 </dd>
331 <dt><code>EVFLAG_FORKCHECK</code></dt>
332 <dd>
333 <p>Instead of calling <code>ev_default_fork</code> or <code>ev_loop_fork</code> manually after
334a fork, you can also make libev check for a fork in each iteration by
335enabling this flag.</p>
336 <p>This works by calling <code>getpid ()</code> on every iteration of the loop,
337and thus this might slow down your event loop if you do a lot of loop
338iterations and little real work, but is usually not noticable (on my
339Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence
340without a syscall and thus <i>very</i> fast, but my Linux system also has
341<code>pthread_atfork</code> which is even faster).</p>
342 <p>The big advantage of this flag is that you can forget about fork (and
343forget about forgetting to tell libev about forking) when you use this
344flag.</p>
345 <p>This flag setting cannot be overriden or specified in the <code>LIBEV_FLAGS</code>
346environment variable.</p>
328 </dd> 347 </dd>
329 <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt> 348 <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt>
330 <dd> 349 <dd>
331 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as 350 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as
332libev tries to roll its own fd_set with no limits on the number of fds, 351libev tries to roll its own fd_set with no limits on the number of fds,
… …
950 </dd> 969 </dd>
951 <dt>ev_timer_again (loop)</dt> 970 <dt>ev_timer_again (loop)</dt>
952 <dd> 971 <dd>
953 <p>This will act as if the timer timed out and restart it again if it is 972 <p>This will act as if the timer timed out and restart it again if it is
954repeating. The exact semantics are:</p> 973repeating. The exact semantics are:</p>
974 <p>If the timer is pending, its pending status is cleared.</p>
955 <p>If the timer is started but nonrepeating, stop it.</p> 975 <p>If the timer is started but nonrepeating, stop it (as if it timed out).</p>
956 <p>If the timer is repeating, either start it if necessary (with the repeat 976 <p>If the timer is repeating, either start it if necessary (with the
957value), or reset the running timer to the repeat value.</p> 977<code>repeat</code> value), or reset the running timer to the <code>repeat</code> value.</p>
958 <p>This sounds a bit complicated, but here is a useful and typical 978 <p>This sounds a bit complicated, but here is a useful and typical
959example: Imagine you have a tcp connection and you want a so-called 979example: Imagine you have a tcp connection and you want a so-called idle
960idle timeout, that is, you want to be called when there have been, 980timeout, that is, you want to be called when there have been, say, 60
961say, 60 seconds of inactivity on the socket. The easiest way to do 981seconds of inactivity on the socket. The easiest way to do this is to
962this is to configure an <code>ev_timer</code> with <code>after</code>=<code>repeat</code>=<code>60</code> and calling 982configure an <code>ev_timer</code> with a <code>repeat</code> value of <code>60</code> and then call
963<code>ev_timer_again</code> each time you successfully read or write some data. If 983<code>ev_timer_again</code> each time you successfully read or write some data. If
964you go into an idle state where you do not expect data to travel on the 984you go into an idle state where you do not expect data to travel on the
965socket, you can stop the timer, and again will automatically restart it if 985socket, you can <code>ev_timer_stop</code> the timer, and <code>ev_timer_again</code> will
966need be.</p> 986automatically restart it if need be.</p>
967 <p>You can also ignore the <code>after</code> value and <code>ev_timer_start</code> altogether 987 <p>That means you can ignore the <code>after</code> value and <code>ev_timer_start</code>
968and only ever use the <code>repeat</code> value:</p> 988altogether and only ever use the <code>repeat</code> value and <code>ev_timer_again</code>:</p>
969<pre> ev_timer_init (timer, callback, 0., 5.); 989<pre> ev_timer_init (timer, callback, 0., 5.);
970 ev_timer_again (loop, timer); 990 ev_timer_again (loop, timer);
971 ... 991 ...
972 timer-&gt;again = 17.; 992 timer-&gt;again = 17.;
973 ev_timer_again (loop, timer); 993 ev_timer_again (loop, timer);
974 ... 994 ...
975 timer-&gt;again = 10.; 995 timer-&gt;again = 10.;
976 ev_timer_again (loop, timer); 996 ev_timer_again (loop, timer);
977 997
978</pre> 998</pre>
979 <p>This is more efficient then stopping/starting the timer eahc time you want 999 <p>This is more slightly efficient then stopping/starting the timer each time
980to modify its timeout value.</p> 1000you want to modify its timeout value.</p>
981 </dd> 1001 </dd>
982 <dt>ev_tstamp repeat [read-write]</dt> 1002 <dt>ev_tstamp repeat [read-write]</dt>
983 <dd> 1003 <dd>
984 <p>The current <code>repeat</code> value. Will be used each time the watcher times out 1004 <p>The current <code>repeat</code> value. Will be used each time the watcher times out
985or <code>ev_timer_again</code> is called and determines the next timeout (if any), 1005or <code>ev_timer_again</code> is called and determines the next timeout (if any),
… …
1246<p>The path does not need to exist: changing from &quot;path exists&quot; to &quot;path does 1266<p>The path does not need to exist: changing from &quot;path exists&quot; to &quot;path does
1247not exist&quot; is a status change like any other. The condition &quot;path does 1267not exist&quot; is a status change like any other. The condition &quot;path does
1248not exist&quot; is signified by the <code>st_nlink</code> field being zero (which is 1268not exist&quot; is signified by the <code>st_nlink</code> field being zero (which is
1249otherwise always forced to be at least one) and all the other fields of 1269otherwise always forced to be at least one) and all the other fields of
1250the stat buffer having unspecified contents.</p> 1270the stat buffer having unspecified contents.</p>
1271<p>The path <i>should</i> be absolute and <i>must not</i> end in a slash. If it is
1272relative and your working directory changes, the behaviour is undefined.</p>
1251<p>Since there is no standard to do this, the portable implementation simply 1273<p>Since there is no standard to do this, the portable implementation simply
1252calls <code>stat (2)</code> regulalry on the path to see if it changed somehow. You 1274calls <code>stat (2)</code> regularly on the path to see if it changed somehow. You
1253can specify a recommended polling interval for this case. If you specify 1275can specify a recommended polling interval for this case. If you specify
1254a polling interval of <code>0</code> (highly recommended!) then a <i>suitable, 1276a polling interval of <code>0</code> (highly recommended!) then a <i>suitable,
1255unspecified default</i> value will be used (which you can expect to be around 1277unspecified default</i> value will be used (which you can expect to be around
1256five seconds, although this might change dynamically). Libev will also 1278five seconds, although this might change dynamically). Libev will also
1257impose a minimum interval which is currently around <code>0.1</code>, but thats 1279impose a minimum interval which is currently around <code>0.1</code>, but thats
1258usually overkill.</p> 1280usually overkill.</p>
1259<p>This watcher type is not meant for massive numbers of stat watchers, 1281<p>This watcher type is not meant for massive numbers of stat watchers,
1260as even with OS-supported change notifications, this can be 1282as even with OS-supported change notifications, this can be
1261resource-intensive.</p> 1283resource-intensive.</p>
1262<p>At the time of this writing, no specific OS backends are implemented, but 1284<p>At the time of this writing, only the Linux inotify interface is
1263if demand increases, at least a kqueue and inotify backend will be added.</p> 1285implemented (implementing kqueue support is left as an exercise for the
1286reader). Inotify will be used to give hints only and should not change the
1287semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs
1288to fall back to regular polling again even with inotify, but changes are
1289usually detected immediately, and if the file exists there will be no
1290polling.</p>
1264<dl> 1291<dl>
1265 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt> 1292 <dt>ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)</dt>
1266 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt> 1293 <dt>ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)</dt>
1267 <dd> 1294 <dd>
1268 <p>Configures the watcher to wait for status changes of the given 1295 <p>Configures the watcher to wait for status changes of the given
… …
1812 <dd> 1839 <dd>
1813 <p>Similar to the other two macros, this gives you the value of the default 1840 <p>Similar to the other two macros, this gives you the value of the default
1814loop, if multiple loops are supported (&quot;ev loop default&quot;).</p> 1841loop, if multiple loops are supported (&quot;ev loop default&quot;).</p>
1815 </dd> 1842 </dd>
1816</dl> 1843</dl>
1817<p>Example: Declare and initialise a check watcher, working regardless of 1844<p>Example: Declare and initialise a check watcher, utilising the above
1818wether multiple loops are supported or not.</p> 1845macros so it will work regardless of wether multiple loops are supported
1846or not.</p>
1819<pre> static void 1847<pre> static void
1820 check_cb (EV_P_ ev_timer *w, int revents) 1848 check_cb (EV_P_ ev_timer *w, int revents)
1821 { 1849 {
1822 ev_check_stop (EV_A_ w); 1850 ev_check_stop (EV_A_ w);
1823 } 1851 }
1824 1852
1825 ev_check check; 1853 ev_check check;
1826 ev_check_init (&amp;check, check_cb); 1854 ev_check_init (&amp;check, check_cb);
1827 ev_check_start (EV_DEFAULT_ &amp;check); 1855 ev_check_start (EV_DEFAULT_ &amp;check);
1828 ev_loop (EV_DEFAULT_ 0); 1856 ev_loop (EV_DEFAULT_ 0);
1829
1830
1831
1832 1857
1833</pre> 1858</pre>
1834 1859
1835</div> 1860</div>
1836<h1 id="EMBEDDING">EMBEDDING</h1> 1861<h1 id="EMBEDDING">EMBEDDING</h1>
… …
1878 ev_vars.h 1903 ev_vars.h
1879 ev_wrap.h 1904 ev_wrap.h
1880 1905
1881 ev_win32.c required on win32 platforms only 1906 ev_win32.c required on win32 platforms only
1882 1907
1883 ev_select.c only when select backend is enabled (which is by default) 1908 ev_select.c only when select backend is enabled (which is enabled by default)
1884 ev_poll.c only when poll backend is enabled (disabled by default) 1909 ev_poll.c only when poll backend is enabled (disabled by default)
1885 ev_epoll.c only when the epoll backend is enabled (disabled by default) 1910 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1886 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 1911 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1887 ev_port.c only when the solaris port backend is enabled (disabled by default) 1912 ev_port.c only when the solaris port backend is enabled (disabled by default)
1888 1913
… …
2015 </dd> 2040 </dd>
2016 <dt>EV_USE_DEVPOLL</dt> 2041 <dt>EV_USE_DEVPOLL</dt>
2017 <dd> 2042 <dd>
2018 <p>reserved for future expansion, works like the USE symbols above.</p> 2043 <p>reserved for future expansion, works like the USE symbols above.</p>
2019 </dd> 2044 </dd>
2045 <dt>EV_USE_INOTIFY</dt>
2046 <dd>
2047 <p>If defined to be <code>1</code>, libev will compile in support for the Linux inotify
2048interface to speed up <code>ev_stat</code> watchers. Its actual availability will
2049be detected at runtime.</p>
2050 </dd>
2020 <dt>EV_H</dt> 2051 <dt>EV_H</dt>
2021 <dd> 2052 <dd>
2022 <p>The name of the <cite>ev.h</cite> header file used to include it. The default if 2053 <p>The name of the <cite>ev.h</cite> header file used to include it. The default if
2023undefined is <code>&lt;ev.h&gt;</code> in <cite>event.h</cite> and <code>&quot;ev.h&quot;</code> in <cite>ev.c</cite>. This 2054undefined is <code>&lt;ev.h&gt;</code> in <cite>event.h</cite> and <code>&quot;ev.h&quot;</code> in <cite>ev.c</cite>. This
2024can be used to virtually rename the <cite>ev.h</cite> header file in case of conflicts.</p> 2055can be used to virtually rename the <cite>ev.h</cite> header file in case of conflicts.</p>
… …
2079 <dt>EV_PID_HASHSIZE</dt> 2110 <dt>EV_PID_HASHSIZE</dt>
2080 <dd> 2111 <dd>
2081 <p><code>ev_child</code> watchers use a small hash table to distribute workload by 2112 <p><code>ev_child</code> watchers use a small hash table to distribute workload by
2082pid. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>), usually more 2113pid. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>), usually more
2083than enough. If you need to manage thousands of children you might want to 2114than enough. If you need to manage thousands of children you might want to
2084increase this value.</p> 2115increase this value (<i>must</i> be a power of two).</p>
2116 </dd>
2117 <dt>EV_INOTIFY_HASHSIZE</dt>
2118 <dd>
2119 <p><code>ev_staz</code> watchers use a small hash table to distribute workload by
2120inotify watch id. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>),
2121usually more than enough. If you need to manage thousands of <code>ev_stat</code>
2122watchers you might want to increase this value (<i>must</i> be a power of
2123two).</p>
2085 </dd> 2124 </dd>
2086 <dt>EV_COMMON</dt> 2125 <dt>EV_COMMON</dt>
2087 <dd> 2126 <dd>
2088 <p>By default, all watchers have a <code>void *data</code> member. By redefining 2127 <p>By default, all watchers have a <code>void *data</code> member. By redefining
2089this macro to a something else you can include more and other types of 2128this macro to a something else you can include more and other types of
… …
2116the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public 2155the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public
2117interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file 2156interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file
2118will be compiled. It is pretty complex because it provides its own header 2157will be compiled. It is pretty complex because it provides its own header
2119file.</p> 2158file.</p>
2120 <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file 2159 <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file
2121that everybody includes and which overrides some autoconf choices:</p> 2160that everybody includes and which overrides some configure choices:</p>
2161<pre> #define EV_MINIMAL 1
2122<pre> #define EV_USE_POLL 0 2162 #define EV_USE_POLL 0
2123 #define EV_MULTIPLICITY 0 2163 #define EV_MULTIPLICITY 0
2124 #define EV_PERIODICS 0 2164 #define EV_PERIODIC_ENABLE 0
2165 #define EV_STAT_ENABLE 0
2166 #define EV_FORK_ENABLE 0
2125 #define EV_CONFIG_H &lt;config.h&gt; 2167 #define EV_CONFIG_H &lt;config.h&gt;
2168 #define EV_MINPRI 0
2169 #define EV_MAXPRI 0
2126 2170
2127 #include &quot;ev++.h&quot; 2171 #include &quot;ev++.h&quot;
2128 2172
2129</pre> 2173</pre>
2130 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> 2174 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p>
… …
2146 <dl> 2190 <dl>
2147 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> 2191 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
2148 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> 2192 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
2149 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> 2193 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
2150 <dt>Stopping check/prepare/idle watchers: O(1)</dt> 2194 <dt>Stopping check/prepare/idle watchers: O(1)</dt>
2151 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))</dt> 2195 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
2152 <dt>Finding the next timer per loop iteration: O(1)</dt> 2196 <dt>Finding the next timer per loop iteration: O(1)</dt>
2153 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> 2197 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
2154 <dt>Activating one watcher: O(1)</dt> 2198 <dt>Activating one watcher: O(1)</dt>
2155 </dl> 2199 </dl>
2156 </p> 2200 </p>

Diff Legend

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