]> git.llucax.com Git - software/libev.git/blobdiff - ev.html
projects / software / libev.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
*** empty log message ***
[software/libev.git] / ev.html
diff --git a/ev.html b/ev.html
index 5ca899a0082268c765534da782cac3ade6d99324..63ddf3b8988edf00afd61acd21c248d79d9d8c29 100644 (file)
--- a/ev.html
+++ b/ev.html
@@ -6,7 +6,7 @@
        <meta name="description" content="Pod documentation for libev" />
        <meta name="inputfile" content="&lt;standard input&gt;" />
        <meta name="outputfile" content="&lt;standard output&gt;" />
        <meta name="description" content="Pod documentation for libev" />
        <meta name="inputfile" content="&lt;standard input&gt;" />
        <meta name="outputfile" content="&lt;standard output&gt;" />
-       <meta name="created" content="Thu Nov 29 18:28:02 2007" />
+       <meta name="created" content="Fri Dec  7 20:23:46 2007" />
        <meta name="generator" content="Pod::Xhtml 1.57" />
 <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
 <body>
        <meta name="generator" content="Pod::Xhtml 1.57" />
 <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
 <body>
@@ -121,6 +121,9 @@
 </div>
 <h1 id="DESCRIPTION">DESCRIPTION</h1>
 <div id="DESCRIPTION_CONTENT">
 </div>
 <h1 id="DESCRIPTION">DESCRIPTION</h1>
 <div id="DESCRIPTION_CONTENT">
+<p>The newest version of this document is also available as a html-formatted
+web page you might find easier to navigate when reading it for the first
+time: <a href="http://cvs.schmorp.de/libev/ev.html">http://cvs.schmorp.de/libev/ev.html</a>.</p>
 <p>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
 these event sources and provide your program with events.</p>
 <p>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
 these event sources and provide your program with events.</p>
@@ -335,7 +338,7 @@ a fork, you can also make libev check for a fork in each iteration by
 enabling this flag.</p>
                                        <p>This works by calling <code>getpid ()</code> on every iteration of the loop,
 and thus this might slow down your event loop if you do a lot of loop
 enabling this flag.</p>
                                        <p>This works by calling <code>getpid ()</code> 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 noticable (on my
+iterations and little real work, but is usually not noticeable (on my
 Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence
 without a syscall and thus <i>very</i> fast, but my Linux system also has
 <code>pthread_atfork</code> which is even faster).</p>
 Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence
 without a syscall and thus <i>very</i> fast, but my Linux system also has
 <code>pthread_atfork</code> which is even faster).</p>
@@ -482,6 +485,15 @@ do not need to care.</p>
                <p>Like <code>ev_default_fork</code>, but acts on an event loop created by
 <code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop
 after fork, and how you do this is entirely your own problem.</p>
                <p>Like <code>ev_default_fork</code>, but acts on an event loop created by
 <code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop
 after fork, and how you do this is entirely your own problem.</p>
+       </dd>
+       <dt>unsigned int ev_loop_count (loop)</dt>
+       <dd>
+               <p>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 <code>0</code> and
+happily wraps around with enough iterations.</p>
+               <p>This value can sometimes be useful as a generation counter of sorts (it
+&quot;ticks&quot; the number of loop iterations), as it roughly corresponds with
+<code>ev_prepare</code> and <code>ev_check</code> calls.</p>
        </dd>
        <dt>unsigned int ev_backend (loop)</dt>
        <dd>
        </dd>
        <dt>unsigned int ev_backend (loop)</dt>
        <dd>
@@ -771,6 +783,26 @@ libev (e.g. you cnanot <code>free ()</code> it).</p>
                <p>Change the callback. You can change the callback at virtually any time
 (modulo threads).</p>
        </dd>
                <p>Change the callback. You can change the callback at virtually any time
 (modulo threads).</p>
        </dd>
+       <dt>ev_set_priority (ev_TYPE *watcher, priority)</dt>
+       <dt>int ev_priority (ev_TYPE *watcher)</dt>
+       <dd>
+               <p>Set and query the priority of the watcher. The priority is a small
+integer between <code>EV_MAXPRI</code> (default: <code>2</code>) and <code>EV_MINPRI</code>
+(default: <code>-2</code>). Pending watchers with higher priority will be invoked
+before watchers with lower priority, but priority will not keep watchers
+from being executed (except for <code>ev_idle</code> watchers).</p>
+               <p>This means that priorities are <i>only</i> 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.</p>
+               <p>If you need to suppress invocation when higher priority events are pending
+you need to look at <code>ev_idle</code> watchers, which provide this functionality.</p>
+               <p>The default priority used by watchers when no priority has been set is
+always <code>0</code>, which is supposed to not be too high and not be too low :).</p>
+               <p>Setting a priority outside the range of <code>EV_MINPRI</code> to <code>EV_MAXPRI</code> 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.</p>
+       </dd>
 </dl>
 
 
 </dl>
 
 
@@ -890,7 +922,7 @@ it is best to always use non-blocking I/O: An extra <code>read</code>(2) returni
 <code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p>
 <p>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
 <code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p>
 <p>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).</p>
 <dl>
 such as poll (fortunately in our Xlib example, Xlib already does this on
 its own, so its quite safe to use).</p>
 <dl>
@@ -1360,13 +1392,15 @@ was some error while <code>stat</code>ing the file.</p>
 </div>
 <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2>
 <div id="code_ev_idle_code_when_you_ve_got_no-2">
 </div>
 <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2>
 <div id="code_ev_idle_code_when_you_ve_got_no-2">
-<p>Idle watchers trigger events when there are no other events are pending
-(prepare, check and other idle watchers do not count). That is, as long
-as your process is busy handling sockets or timeouts (or even signals,
-imagine) it will not be triggered. But when your process is idle all idle
-watchers are being called again and again, once per event loop iteration -
-until stopped, that is, or your process receives more events and becomes
-busy.</p>
+<p>Idle watchers trigger events when no other events of the same or higher
+priority are pending (prepare, check and other idle watchers do not
+count).</p>
+<p>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
+iteration - until stopped, that is, or your process receives more events
+and becomes busy again with higher priority stuff.</p>
 <p>The most noteworthy effect is that as long as any idle watchers are
 active, the process will not block when waiting for new events.</p>
 <p>Apart from keeping your process non-blocking (which is a useful
 <p>The most noteworthy effect is that as long as any idle watchers are
 active, the process will not block when waiting for new events.</p>
 <p>Apart from keeping your process non-blocking (which is a useful
@@ -1466,7 +1500,8 @@ pseudo-code only of course:</p>
   static void
   adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
   {
   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, &amp;nfd, &amp;timeout, timeval_from (ev_time ()));
 
     // actual code will need to loop here and realloc etc.
     adns_beforepoll (ads, fds, &amp;nfd, &amp;timeout, timeval_from (ev_time ()));
 
@@ -1802,7 +1837,7 @@ the constructor.</p>
 <h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
 <div id="MACRO_MAGIC_CONTENT">
 <p>Libev can be compiled with a variety of options, the most fundemantal is
 <h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
 <div id="MACRO_MAGIC_CONTENT">
 <p>Libev can be compiled with a variety of options, the most fundemantal is
-<code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and
+<code>EV_MULTIPLICITY</code>. This option determines whether (most) functions and
 callbacks have an initial <code>struct ev_loop *</code> argument.</p>
 <p>To make it easier to write programs that cope with either variant, the
 following macros are defined:</p>
 callbacks have an initial <code>struct ev_loop *</code> argument.</p>
 <p>To make it easier to write programs that cope with either variant, the
 following macros are defined:</p>
@@ -1841,8 +1876,9 @@ suitable for use with <code>EV_A</code>.</p>
 loop, if multiple loops are supported (&quot;ev loop default&quot;).</p>
        </dd>
 </dl>
 loop, if multiple loops are supported (&quot;ev loop default&quot;).</p>
        </dd>
 </dl>
-<p>Example: Declare and initialise a check watcher, working regardless of
-wether multiple loops are supported or not.</p>
+<p>Example: Declare and initialise a check watcher, utilising the above
+macros so it will work regardless of whether multiple loops are supported
+or not.</p>
 <pre>  static void
   check_cb (EV_P_ ev_timer *w, int revents)
   {
 <pre>  static void
   check_cb (EV_P_ ev_timer *w, int revents)
   {
@@ -1854,9 +1890,6 @@ wether multiple loops are supported or not.</p>
   ev_check_start (EV_DEFAULT_ &amp;check);
   ev_loop (EV_DEFAULT_ 0);
 
   ev_check_start (EV_DEFAULT_ &amp;check);
   ev_loop (EV_DEFAULT_ 0);
 
-
-
-
 </pre>
 
 </div>
 </pre>
 
 </div>
@@ -1907,7 +1940,7 @@ in your include path (e.g. in libev/ when using -Ilibev):</p>
 
   ev_win32.c      required on win32 platforms only
 
 
   ev_win32.c      required on win32 platforms only
 
-  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_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)
@@ -2081,11 +2114,31 @@ will have the <code>struct ev_loop *</code> as first argument, and you can creat
 additional independent event loops. Otherwise there will be no support
 for multiple event loops and there is no first event loop pointer
 argument. Instead, all functions act on the single default loop.</p>
 additional independent event loops. Otherwise there will be no support
 for multiple event loops and there is no first event loop pointer
 argument. Instead, all functions act on the single default loop.</p>
+       </dd>
+       <dt>EV_MINPRI</dt>
+       <dt>EV_MAXPRI</dt>
+       <dd>
+               <p>The range of allowed priorities. <code>EV_MINPRI</code> must be smaller or equal to
+<code>EV_MAXPRI</code>, but otherwise there are no non-obvious limitations. You can
+provide for more priorities by overriding those symbols (usually defined
+to be <code>-2</code> and <code>2</code>, respectively).</p>
+               <p>When doing priority-based operations, libev usually has to linearly search
+all the priorities, so having many of them (hundreds) uses a lot of space
+and time, so using the defaults of five priorities (-2 .. +2) is usually
+fine.</p>
+               <p>If your embedding app does not need any priorities, defining these both to
+<code>0</code> will save some memory and cpu.</p>
        </dd>
        <dt>EV_PERIODIC_ENABLE</dt>
        <dd>
                <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If
 defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
        </dd>
        <dt>EV_PERIODIC_ENABLE</dt>
        <dd>
                <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If
 defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
+code.</p>
+       </dd>
+       <dt>EV_IDLE_ENABLE</dt>
+       <dd>
+               <p>If undefined or defined to be <code>1</code>, then idle watchers are supported. If
+defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
 code.</p>
        </dd>
        <dt>EV_EMBED_ENABLE</dt>
 code.</p>
        </dd>
        <dt>EV_EMBED_ENABLE</dt>
@@ -2159,11 +2212,16 @@ interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</
 will be compiled. It is pretty complex because it provides its own header
 file.</p>
                <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file
 will be compiled. It is pretty complex because it provides its own header
 file.</p>
                <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file
-that everybody includes and which overrides some autoconf choices:</p>
-<pre>  #define EV_USE_POLL 0
+that everybody includes and which overrides some configure choices:</p>
+<pre>  #define EV_MINIMAL 1
+  #define EV_USE_POLL 0
   #define EV_MULTIPLICITY 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 &lt;config.h&gt;
   #define EV_CONFIG_H &lt;config.h&gt;
+  #define EV_MINPRI 0
+  #define EV_MAXPRI 0
 
   #include &quot;ev++.h&quot;
 
 
   #include &quot;ev++.h&quot;
 
@@ -2183,16 +2241,48 @@ that everybody includes and which overrides some autoconf choices:</p>
                <p>In this section the complexities of (many of) the algorithms used inside
 libev will be explained. For complexity discussions about backends see the
 documentation for <code>ev_default_init</code>.</p>
                <p>In this section the complexities of (many of) the algorithms used inside
 libev will be explained. For complexity discussions about backends see the
 documentation for <code>ev_default_init</code>.</p>
+               <p>All of the following are about amortised time: If an array needs to be
+extended, libev needs to realloc and move the whole array, but this
+happens asymptotically never with higher number of elements, so O(1) might
+mean it might do a lengthy realloc operation in rare cases, but on average
+it is much faster and asymptotically approaches constant time.</p>
                <p>
                        <dl>
                                <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
                <p>
                        <dl>
                                <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
+                               <dd>
+                                       <p>This means that, when you have a watcher that triggers in one hour and
+there are 100 watchers that would trigger before that then inserting will
+have to skip those 100 watchers.</p>
+                               </dd>
                                <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
                                <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
+                               <dd>
+                                       <p>That means that for changing a timer costs less than removing/adding them
+as only the relative motion in the event queue has to be paid for.</p>
+                               </dd>
                                <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
                                <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
-                               <dt>Stopping check/prepare/idle watchers: O(1)</dt>
+                               <dd>
+                                       <p>These just add the watcher into an array or at the head of a list.
+=item Stopping check/prepare/idle watchers: O(1)</p>
+                               </dd>
                                <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
                                <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
+                               <dd>
+                                       <p>These watchers are stored in lists then need to be walked to find the
+correct watcher to remove. The lists are usually short (you don't usually
+have many watchers waiting for the same fd or signal).</p>
+                               </dd>
                                <dt>Finding the next timer per loop iteration: O(1)</dt>
                                <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
                                <dt>Finding the next timer per loop iteration: O(1)</dt>
                                <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
+                               <dd>
+                                       <p>A change means an I/O watcher gets started or stopped, which requires
+libev to recalculate its status (and possibly tell the kernel).</p>
+                               </dd>
                                <dt>Activating one watcher: O(1)</dt>
                                <dt>Activating one watcher: O(1)</dt>
+                               <dt>Priority handling: O(number_of_priorities)</dt>
+                               <dd>
+                                       <p>Priorities are implemented by allocating some space for each
+priority. When doing priority-based operations, libev usually has to
+linearly search all the priorities.</p>
+                               </dd>
                        </dl>
                </p>
 
                        </dl>
                </p>
 
High-performance event loop/event model with lots of features.