]> 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 6c59bec08be24636d641d47ec68afa693bd834ce..d95bffd12b4ee3310cae207e9b15473ab9bc1da6 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="Wed Nov 28 19:29:25 2007" />
+       <meta name="created" content="Thu Nov 29 21:05:58 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>
@@ -327,6 +327,23 @@ or setgid) then libev will <i>not</i> look at the environment variable
 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.</p>
 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.</p>
+                               </dd>
+                               <dt><code>EVFLAG_FORKCHECK</code></dt>
+                               <dd>
+                                       <p>Instead of calling <code>ev_default_fork</code> or <code>ev_loop_fork</code> manually after
+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
+iterations and little real work, but is usually not noticable (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>
+                                       <p>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.</p>
+                                       <p>This flag setting cannot be overriden or specified in the <code>LIBEV_FLAGS</code>
+environment variable.</p>
                                </dd>
                                <dt><code>EVBACKEND_SELECT</code>  (value 1, portable select backend)</dt>
                                <dd>
                                </dd>
                                <dt><code>EVBACKEND_SELECT</code>  (value 1, portable select backend)</dt>
                                <dd>
@@ -954,20 +971,21 @@ timer will not fire more than once per event loop iteration.</p>
        <dd>
                <p>This will act as if the timer timed out and restart it again if it is
 repeating. The exact semantics are:</p>
        <dd>
                <p>This will act as if the timer timed out and restart it again if it is
 repeating. The exact semantics are:</p>
-               <p>If the timer is started but nonrepeating, stop it.</p>
-               <p>If the timer is repeating, either start it if necessary (with the repeat
-value), or reset the running timer to the repeat value.</p>
+               <p>If the timer is pending, its pending status is cleared.</p>
+               <p>If the timer is started but nonrepeating, stop it (as if it timed out).</p>
+               <p>If the timer is repeating, either start it if necessary (with the
+<code>repeat</code> value), or reset the running timer to the <code>repeat</code> value.</p>
                <p>This sounds a bit complicated, but here is a useful and typical
                <p>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
-idle timeout, that is, you want to be called when there have been,
-say, 60 seconds of inactivity on the socket. The easiest way to do
-this is to configure an <code>ev_timer</code> with <code>after</code>=<code>repeat</code>=<code>60</code> and calling
+example: Imagine you have a tcp connection and you want a so-called idle
+timeout, that is, you want to be called when there have been, say, 60
+seconds of inactivity on the socket. The easiest way to do this is to
+configure an <code>ev_timer</code> with a <code>repeat</code> value of <code>60</code> and then call
 <code>ev_timer_again</code> 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
 <code>ev_timer_again</code> 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
-need be.</p>
-               <p>You can also ignore the <code>after</code> value and <code>ev_timer_start</code> altogether
-and only ever use the <code>repeat</code> value:</p>
+socket, you can <code>ev_timer_stop</code> the timer, and <code>ev_timer_again</code> will
+automatically restart it if need be.</p>
+               <p>That means you can ignore the <code>after</code> value and <code>ev_timer_start</code>
+altogether and only ever use the <code>repeat</code> value and <code>ev_timer_again</code>:</p>
 <pre>   ev_timer_init (timer, callback, 0., 5.);
    ev_timer_again (loop, timer);
    ...
 <pre>   ev_timer_init (timer, callback, 0., 5.);
    ev_timer_again (loop, timer);
    ...
@@ -978,8 +996,8 @@ and only ever use the <code>repeat</code> value:</p>
    ev_timer_again (loop, timer);
 
 </pre>
    ev_timer_again (loop, timer);
 
 </pre>
-               <p>This is more efficient then stopping/starting the timer eahc time you want
-to modify its timeout value.</p>
+               <p>This is more slightly efficient then stopping/starting the timer each time
+you want to modify its timeout value.</p>
        </dd>
        <dt>ev_tstamp repeat [read-write]</dt>
        <dd>
        </dd>
        <dt>ev_tstamp repeat [read-write]</dt>
        <dd>
@@ -1823,8 +1841,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 wether 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)
   {
@@ -1836,9 +1855,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>
@@ -1889,7 +1905,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)
@@ -2141,11 +2157,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;
 
High-performance event loop/event model with lots of features.