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

Comparing libev/ev.html (file contents):
Revision 1.61 by root, Thu Nov 29 12:21:21 2007 UTC vs.
Revision 1.66 by root, Fri Dec 7 19:15:39 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="Thu Nov 29 13:21:20 2007" /> 9 <meta name="created" content="Fri Dec 7 20:07:44 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 -->
… …
119</pre> 119</pre>
120 120
121</div> 121</div>
122<h1 id="DESCRIPTION">DESCRIPTION</h1> 122<h1 id="DESCRIPTION">DESCRIPTION</h1>
123<div id="DESCRIPTION_CONTENT"> 123<div id="DESCRIPTION_CONTENT">
124<p>The newest version of this document is also available as a html-formatted
125web page you might find easier to navigate when reading it for the first
126time: <a href="http://cvs.schmorp.de/libev/ev.html">http://cvs.schmorp.de/libev/ev.html</a>.</p>
124<p>Libev is an event loop: you register interest in certain events (such as a 127<p>Libev is an event loop: you register interest in certain events (such as a
125file descriptor being readable or a timeout occuring), and it will manage 128file descriptor being readable or a timeout occuring), and it will manage
126these event sources and provide your program with events.</p> 129these event sources and provide your program with events.</p>
127<p>To do this, it must take more or less complete control over your process 130<p>To do this, it must take more or less complete control over your process
128(or thread) by executing the <i>event loop</i> handler, and will then 131(or thread) by executing the <i>event loop</i> handler, and will then
… …
326<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will 329<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
327override the flags completely if it is found in the environment. This is 330override the flags completely if it is found in the environment. This is
328useful to try out specific backends to test their performance, or to work 331useful to try out specific backends to test their performance, or to work
329around bugs.</p> 332around bugs.</p>
330 </dd> 333 </dd>
334 <dt><code>EVFLAG_FORKCHECK</code></dt>
335 <dd>
336 <p>Instead of calling <code>ev_default_fork</code> or <code>ev_loop_fork</code> manually after
337a fork, you can also make libev check for a fork in each iteration by
338enabling this flag.</p>
339 <p>This works by calling <code>getpid ()</code> on every iteration of the loop,
340and thus this might slow down your event loop if you do a lot of loop
341iterations and little real work, but is usually not noticeable (on my
342Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence
343without a syscall and thus <i>very</i> fast, but my Linux system also has
344<code>pthread_atfork</code> which is even faster).</p>
345 <p>The big advantage of this flag is that you can forget about fork (and
346forget about forgetting to tell libev about forking) when you use this
347flag.</p>
348 <p>This flag setting cannot be overriden or specified in the <code>LIBEV_FLAGS</code>
349environment variable.</p>
350 </dd>
331 <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt> 351 <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt>
332 <dd> 352 <dd>
333 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as 353 <p>This is your standard select(2) backend. Not <i>completely</i> standard, as
334libev tries to roll its own fd_set with no limits on the number of fds, 354libev tries to roll its own fd_set with no limits on the number of fds,
335but if that fails, expect a fairly low limit on the number of fds when 355but if that fails, expect a fairly low limit on the number of fds when
… …
463 <dt>ev_loop_fork (loop)</dt> 483 <dt>ev_loop_fork (loop)</dt>
464 <dd> 484 <dd>
465 <p>Like <code>ev_default_fork</code>, but acts on an event loop created by 485 <p>Like <code>ev_default_fork</code>, but acts on an event loop created by
466<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop 486<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop
467after fork, and how you do this is entirely your own problem.</p> 487after fork, and how you do this is entirely your own problem.</p>
488 </dd>
489 <dt>unsigned int ev_loop_count (loop)</dt>
490 <dd>
491 <p>Returns the count of loop iterations for the loop, which is identical to
492the number of times libev did poll for new events. It starts at <code>0</code> and
493happily wraps around with enough iterations.</p>
494 <p>This value can sometimes be useful as a generation counter of sorts (it
495&quot;ticks&quot; the number of loop iterations), as it roughly corresponds with
496<code>ev_prepare</code> and <code>ev_check</code> calls.</p>
468 </dd> 497 </dd>
469 <dt>unsigned int ev_backend (loop)</dt> 498 <dt>unsigned int ev_backend (loop)</dt>
470 <dd> 499 <dd>
471 <p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in 500 <p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in
472use.</p> 501use.</p>
… …
752 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt> 781 <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt>
753 <dd> 782 <dd>
754 <p>Change the callback. You can change the callback at virtually any time 783 <p>Change the callback. You can change the callback at virtually any time
755(modulo threads).</p> 784(modulo threads).</p>
756 </dd> 785 </dd>
786 <dt>ev_set_priority (ev_TYPE *watcher, priority)</dt>
787 <dt>int ev_priority (ev_TYPE *watcher)</dt>
788 <dd>
789 <p>Set and query the priority of the watcher. The priority is a small
790integer between <code>EV_MAXPRI</code> (default: <code>2</code>) and <code>EV_MINPRI</code>
791(default: <code>-2</code>). Pending watchers with higher priority will be invoked
792before watchers with lower priority, but priority will not keep watchers
793from being executed (except for <code>ev_idle</code> watchers).</p>
794 <p>This means that priorities are <i>only</i> used for ordering callback
795invocation after new events have been received. This is useful, for
796example, to reduce latency after idling, or more often, to bind two
797watchers on the same event and make sure one is called first.</p>
798 <p>If you need to suppress invocation when higher priority events are pending
799you need to look at <code>ev_idle</code> watchers, which provide this functionality.</p>
800 <p>The default priority used by watchers when no priority has been set is
801always <code>0</code>, which is supposed to not be too high and not be too low :).</p>
802 <p>Setting a priority outside the range of <code>EV_MINPRI</code> to <code>EV_MAXPRI</code> is
803fine, as long as you do not mind that the priority value you query might
804or might not have been adjusted to be within valid range.</p>
805 </dd>
757</dl> 806</dl>
758 807
759 808
760 809
761 810
… …
871this situation even with a relatively standard program structure. Thus 920this situation even with a relatively standard program structure. Thus
872it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning 921it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning
873<code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p> 922<code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p>
874<p>If you cannot run the fd in non-blocking mode (for example you should not 923<p>If you cannot run the fd in non-blocking mode (for example you should not
875play around with an Xlib connection), then you have to seperately re-test 924play around with an Xlib connection), then you have to seperately re-test
876wether a file descriptor is really ready with a known-to-be good interface 925whether a file descriptor is really ready with a known-to-be good interface
877such as poll (fortunately in our Xlib example, Xlib already does this on 926such as poll (fortunately in our Xlib example, Xlib already does this on
878its own, so its quite safe to use).</p> 927its own, so its quite safe to use).</p>
879<dl> 928<dl>
880 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> 929 <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
881 <dt>ev_io_set (ev_io *, int fd, int events)</dt> 930 <dt>ev_io_set (ev_io *, int fd, int events)</dt>
… …
1341</pre> 1390</pre>
1342 1391
1343</div> 1392</div>
1344<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2> 1393<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2>
1345<div id="code_ev_idle_code_when_you_ve_got_no-2"> 1394<div id="code_ev_idle_code_when_you_ve_got_no-2">
1346<p>Idle watchers trigger events when there are no other events are pending 1395<p>Idle watchers trigger events when no other events of the same or higher
1347(prepare, check and other idle watchers do not count). That is, as long 1396priority are pending (prepare, check and other idle watchers do not
1348as your process is busy handling sockets or timeouts (or even signals, 1397count).</p>
1349imagine) it will not be triggered. But when your process is idle all idle 1398<p>That is, as long as your process is busy handling sockets or timeouts
1350watchers are being called again and again, once per event loop iteration - 1399(or even signals, imagine) of the same or higher priority it will not be
1400triggered. But when your process is idle (or only lower-priority watchers
1401are pending), the idle watchers are being called once per event loop
1351until stopped, that is, or your process receives more events and becomes 1402iteration - until stopped, that is, or your process receives more events
1352busy.</p> 1403and becomes busy again with higher priority stuff.</p>
1353<p>The most noteworthy effect is that as long as any idle watchers are 1404<p>The most noteworthy effect is that as long as any idle watchers are
1354active, the process will not block when waiting for new events.</p> 1405active, the process will not block when waiting for new events.</p>
1355<p>Apart from keeping your process non-blocking (which is a useful 1406<p>Apart from keeping your process non-blocking (which is a useful
1356effect on its own sometimes), idle watchers are a good place to do 1407effect on its own sometimes), idle watchers are a good place to do
1357&quot;pseudo-background processing&quot;, or delay processing stuff to after the 1408&quot;pseudo-background processing&quot;, or delay processing stuff to after the
… …
1447 1498
1448 // create io watchers for each fd and a timer before blocking 1499 // create io watchers for each fd and a timer before blocking
1449 static void 1500 static void
1450 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 1501 adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1451 { 1502 {
1452 int timeout = 3600000;truct pollfd fds [nfd]; 1503 int timeout = 3600000;
1504 struct pollfd fds [nfd];
1453 // actual code will need to loop here and realloc etc. 1505 // actual code will need to loop here and realloc etc.
1454 adns_beforepoll (ads, fds, &amp;nfd, &amp;timeout, timeval_from (ev_time ())); 1506 adns_beforepoll (ads, fds, &amp;nfd, &amp;timeout, timeval_from (ev_time ()));
1455 1507
1456 /* the callback is illegal, but won't be called as we stop during check */ 1508 /* the callback is illegal, but won't be called as we stop during check */
1457 ev_timer_init (&amp;tw, 0, timeout * 1e-3); 1509 ev_timer_init (&amp;tw, 0, timeout * 1e-3);
… …
1783 1835
1784</div> 1836</div>
1785<h1 id="MACRO_MAGIC">MACRO MAGIC</h1> 1837<h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
1786<div id="MACRO_MAGIC_CONTENT"> 1838<div id="MACRO_MAGIC_CONTENT">
1787<p>Libev can be compiled with a variety of options, the most fundemantal is 1839<p>Libev can be compiled with a variety of options, the most fundemantal is
1788<code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and 1840<code>EV_MULTIPLICITY</code>. This option determines whether (most) functions and
1789callbacks have an initial <code>struct ev_loop *</code> argument.</p> 1841callbacks have an initial <code>struct ev_loop *</code> argument.</p>
1790<p>To make it easier to write programs that cope with either variant, the 1842<p>To make it easier to write programs that cope with either variant, the
1791following macros are defined:</p> 1843following macros are defined:</p>
1792<dl> 1844<dl>
1793 <dt><code>EV_A</code>, <code>EV_A_</code></dt> 1845 <dt><code>EV_A</code>, <code>EV_A_</code></dt>
… …
1822 <dd> 1874 <dd>
1823 <p>Similar to the other two macros, this gives you the value of the default 1875 <p>Similar to the other two macros, this gives you the value of the default
1824loop, if multiple loops are supported (&quot;ev loop default&quot;).</p> 1876loop, if multiple loops are supported (&quot;ev loop default&quot;).</p>
1825 </dd> 1877 </dd>
1826</dl> 1878</dl>
1827<p>Example: Declare and initialise a check watcher, working regardless of 1879<p>Example: Declare and initialise a check watcher, utilising the above
1828wether multiple loops are supported or not.</p> 1880macros so it will work regardless of whether multiple loops are supported
1881or not.</p>
1829<pre> static void 1882<pre> static void
1830 check_cb (EV_P_ ev_timer *w, int revents) 1883 check_cb (EV_P_ ev_timer *w, int revents)
1831 { 1884 {
1832 ev_check_stop (EV_A_ w); 1885 ev_check_stop (EV_A_ w);
1833 } 1886 }
1834 1887
1835 ev_check check; 1888 ev_check check;
1836 ev_check_init (&amp;check, check_cb); 1889 ev_check_init (&amp;check, check_cb);
1837 ev_check_start (EV_DEFAULT_ &amp;check); 1890 ev_check_start (EV_DEFAULT_ &amp;check);
1838 ev_loop (EV_DEFAULT_ 0); 1891 ev_loop (EV_DEFAULT_ 0);
1839
1840
1841
1842 1892
1843</pre> 1893</pre>
1844 1894
1845</div> 1895</div>
1846<h1 id="EMBEDDING">EMBEDDING</h1> 1896<h1 id="EMBEDDING">EMBEDDING</h1>
… …
1888 ev_vars.h 1938 ev_vars.h
1889 ev_wrap.h 1939 ev_wrap.h
1890 1940
1891 ev_win32.c required on win32 platforms only 1941 ev_win32.c required on win32 platforms only
1892 1942
1893 ev_select.c only when select backend is enabled (which is by default) 1943 ev_select.c only when select backend is enabled (which is enabled by default)
1894 ev_poll.c only when poll backend is enabled (disabled by default) 1944 ev_poll.c only when poll backend is enabled (disabled by default)
1895 ev_epoll.c only when the epoll backend is enabled (disabled by default) 1945 ev_epoll.c only when the epoll backend is enabled (disabled by default)
1896 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 1946 ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1897 ev_port.c only when the solaris port backend is enabled (disabled by default) 1947 ev_port.c only when the solaris port backend is enabled (disabled by default)
1898 1948
… …
2063will have the <code>struct ev_loop *</code> as first argument, and you can create 2113will have the <code>struct ev_loop *</code> as first argument, and you can create
2064additional independent event loops. Otherwise there will be no support 2114additional independent event loops. Otherwise there will be no support
2065for multiple event loops and there is no first event loop pointer 2115for multiple event loops and there is no first event loop pointer
2066argument. Instead, all functions act on the single default loop.</p> 2116argument. Instead, all functions act on the single default loop.</p>
2067 </dd> 2117 </dd>
2118 <dt>EV_MINPRI</dt>
2119 <dt>EV_MAXPRI</dt>
2120 <dd>
2121 <p>The range of allowed priorities. <code>EV_MINPRI</code> must be smaller or equal to
2122<code>EV_MAXPRI</code>, but otherwise there are no non-obvious limitations. You can
2123provide for more priorities by overriding those symbols (usually defined
2124to be <code>-2</code> and <code>2</code>, respectively).</p>
2125 <p>When doing priority-based operations, libev usually has to linearly search
2126all the priorities, so having many of them (hundreds) uses a lot of space
2127and time, so using the defaults of five priorities (-2 .. +2) is usually
2128fine.</p>
2129 <p>If your embedding app does not need any priorities, defining these both to
2130<code>0</code> will save some memory and cpu.</p>
2131 </dd>
2068 <dt>EV_PERIODIC_ENABLE</dt> 2132 <dt>EV_PERIODIC_ENABLE</dt>
2069 <dd> 2133 <dd>
2070 <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If 2134 <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If
2135defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
2136code.</p>
2137 </dd>
2138 <dt>EV_IDLE_ENABLE</dt>
2139 <dd>
2140 <p>If undefined or defined to be <code>1</code>, then idle watchers are supported. If
2071defined to be <code>0</code>, then they are not. Disabling them saves a few kB of 2141defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
2072code.</p> 2142code.</p>
2073 </dd> 2143 </dd>
2074 <dt>EV_EMBED_ENABLE</dt> 2144 <dt>EV_EMBED_ENABLE</dt>
2075 <dd> 2145 <dd>
… …
2140the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public 2210the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public
2141interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file 2211interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file
2142will be compiled. It is pretty complex because it provides its own header 2212will be compiled. It is pretty complex because it provides its own header
2143file.</p> 2213file.</p>
2144 <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file 2214 <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file
2145that everybody includes and which overrides some autoconf choices:</p> 2215that everybody includes and which overrides some configure choices:</p>
2216<pre> #define EV_MINIMAL 1
2146<pre> #define EV_USE_POLL 0 2217 #define EV_USE_POLL 0
2147 #define EV_MULTIPLICITY 0 2218 #define EV_MULTIPLICITY 0
2148 #define EV_PERIODICS 0 2219 #define EV_PERIODIC_ENABLE 0
2220 #define EV_STAT_ENABLE 0
2221 #define EV_FORK_ENABLE 0
2149 #define EV_CONFIG_H &lt;config.h&gt; 2222 #define EV_CONFIG_H &lt;config.h&gt;
2223 #define EV_MINPRI 0
2224 #define EV_MAXPRI 0
2150 2225
2151 #include &quot;ev++.h&quot; 2226 #include &quot;ev++.h&quot;
2152 2227
2153</pre> 2228</pre>
2154 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> 2229 <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p>
… …
2167libev will be explained. For complexity discussions about backends see the 2242libev will be explained. For complexity discussions about backends see the
2168documentation for <code>ev_default_init</code>.</p> 2243documentation for <code>ev_default_init</code>.</p>
2169 <p> 2244 <p>
2170 <dl> 2245 <dl>
2171 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> 2246 <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
2247 <dd>
2248 <p>This means that, when you have a watcher that triggers in one hour and
2249there are 100 watchers that would trigger before that then inserting will
2250have to skip those 100 watchers.</p>
2251 </dd>
2172 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> 2252 <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
2253 <dd>
2254 <p>That means that for changing a timer costs less than removing/adding them
2255as only the relative motion in the event queue has to be paid for.</p>
2256 </dd>
2173 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> 2257 <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
2258 <dd>
2259 <p>These just add the watcher into an array or at the head of a list. If
2260the array needs to be extended libev needs to realloc and move the whole
2261array, but this happen asymptotically less and less with more watchers,
2262thus amortised O(1).</p>
2263 </dd>
2174 <dt>Stopping check/prepare/idle watchers: O(1)</dt> 2264 <dt>Stopping check/prepare/idle watchers: O(1)</dt>
2175 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt> 2265 <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
2266 <dd>
2267 <p>These watchers are stored in lists then need to be walked to find the
2268correct watcher to remove. The lists are usually short (you don't usually
2269have many watchers waiting for the same fd or signal).</p>
2270 </dd>
2176 <dt>Finding the next timer per loop iteration: O(1)</dt> 2271 <dt>Finding the next timer per loop iteration: O(1)</dt>
2177 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> 2272 <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
2273 <dd>
2274 <p>A change means an I/O watcher gets started or stopped, which requires
2275libev to recalculate its status (and possibly tell the kernel).</p>
2276 </dd>
2178 <dt>Activating one watcher: O(1)</dt> 2277 <dt>Activating one watcher: O(1)</dt>
2278 <dt>Priority handling: O(number_of_priorities)</dt>
2279 <dd>
2280 <p>Priorities are implemented by allocating some space for each
2281priority. When doing priority-based operations, libev usually has to
2282linearly search all the priorities.</p>
2283 </dd>
2179 </dl> 2284 </dl>
2180 </p> 2285 </p>
2181 2286
2182 2287
2183 2288

Diff Legend

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