]> 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 1dcdd21a2507721860d38c86722fc8d78ad63c89..f63538f376fab4febbcbee06d9be4d25eb05783d 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="Sat Dec  8 16:30:24 2007" />
+       <meta name="created" content="Sun Dec  9 20:47:27 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>
@@ -187,13 +187,15 @@ you actually want to know.</p>
        <dt>int ev_version_major ()</dt>
        <dt>int ev_version_minor ()</dt>
        <dd>
        <dt>int ev_version_major ()</dt>
        <dt>int ev_version_minor ()</dt>
        <dd>
-               <p>You can find out the major and minor version numbers of the library
+               <p>You can find out the major and minor ABI version numbers of the library
 you linked against by calling the functions <code>ev_version_major</code> and
 <code>ev_version_minor</code>. If you want, you can compare against the global
 symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
 version of the library your program was compiled against.</p>
 you linked against by calling the functions <code>ev_version_major</code> and
 <code>ev_version_minor</code>. If you want, you can compare against the global
 symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
 version of the library your program was compiled against.</p>
+               <p>These version numbers refer to the ABI version of the library, not the
+release version.</p>
                <p>Usually, it's a good idea to terminate if the major versions mismatch,
                <p>Usually, it's a good idea to terminate if the major versions mismatch,
-as this indicates an incompatible change.  Minor versions are usually
+as this indicates an incompatible change. Minor versions are usually
 compatible to older versions, so a larger minor version alone is usually
 not a problem.</p>
                <p>Example: Make sure we haven't accidentally been linked against the wrong
 compatible to older versions, so a larger minor version alone is usually
 not a problem.</p>
                <p>Example: Make sure we haven't accidentally been linked against the wrong
@@ -531,8 +533,9 @@ external event in conjunction with something not expressible using other
 libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is
 usually a better approach for this kind of thing.</p>
                <p>Here are the gory details of what <code>ev_loop</code> does:</p>
 libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is
 usually a better approach for this kind of thing.</p>
                <p>Here are the gory details of what <code>ev_loop</code> does:</p>
-<pre>   * If there are no active watchers (reference count is zero), return.
-   - Queue prepare watchers and then call all outstanding watchers.
+<pre>   - Before the first iteration, call any pending watchers.
+   * If there are no active watchers (reference count is zero), return.
+   - Queue all prepare watchers and then call all outstanding watchers.
    - If we have been forked, recreate the kernel state.
    - Update the kernel state with all outstanding changes.
    - Update the &quot;event loop time&quot;.
    - If we have been forked, recreate the kernel state.
    - Update the kernel state with all outstanding changes.
    - Update the &quot;event loop time&quot;.
@@ -1098,10 +1101,10 @@ to trigger &quot;at&quot; some specific point in time. For example, if you tell
 periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now ()
 + 10.</code>) and then reset your system clock to the last year, then it will
 take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
 periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now ()
 + 10.</code>) and then reset your system clock to the last year, then it will
 take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
-roughly 10 seconds later and of course not if you reset your system time
-again).</p>
+roughly 10 seconds later).</p>
 <p>They can also be used to implement vastly more complex timers, such as
 <p>They can also be used to implement vastly more complex timers, such as
-triggering an event on eahc midnight, local time.</p>
+triggering an event on each midnight, local time or other, complicated,
+rules.</p>
 <p>As with timers, the callback is guarenteed to be invoked only when the
 time (<code>at</code>) has been passed, but if multiple periodic timers become ready
 during the same loop iteration then order of execution is undefined.</p>
 <p>As with timers, the callback is guarenteed to be invoked only when the
 time (<code>at</code>) has been passed, but if multiple periodic timers become ready
 during the same loop iteration then order of execution is undefined.</p>
@@ -1113,18 +1116,18 @@ during the same loop iteration then order of execution is undefined.</p>
 operation, and we will explain them from simplest to complex:</p>
                <p>
                        <dl>
 operation, and we will explain them from simplest to complex:</p>
                <p>
                        <dl>
-                               <dt>* absolute timer (interval = reschedule_cb = 0)</dt>
+                               <dt>* absolute timer (at = time, interval = reschedule_cb = 0)</dt>
                                <dd>
                                        <p>In this configuration the watcher triggers an event at the wallclock time
 <code>at</code> and doesn't repeat. It will not adjust when a time jump occurs,
 that is, if it is to be run at January 1st 2011 then it will run when the
 system time reaches or surpasses this time.</p>
                                </dd>
                                <dd>
                                        <p>In this configuration the watcher triggers an event at the wallclock time
 <code>at</code> and doesn't repeat. It will not adjust when a time jump occurs,
 that is, if it is to be run at January 1st 2011 then it will run when the
 system time reaches or surpasses this time.</p>
                                </dd>
-                               <dt>* non-repeating interval timer (interval &gt; 0, reschedule_cb = 0)</dt>
+                               <dt>* non-repeating interval timer (at = offset, interval &gt; 0, reschedule_cb = 0)</dt>
                                <dd>
                                        <p>In this mode the watcher will always be scheduled to time out at the next
                                <dd>
                                        <p>In this mode the watcher will always be scheduled to time out at the next
-<code>at + N * interval</code> time (for some integer N) and then repeat, regardless
-of any time jumps.</p>
+<code>at + N * interval</code> time (for some integer N, which can also be negative)
+and then repeat, regardless of any time jumps.</p>
                                        <p>This can be used to create timers that do not drift with respect to system
 time:</p>
 <pre>   ev_periodic_set (&amp;periodic, 0., 3600., 0);
                                        <p>This can be used to create timers that do not drift with respect to system
 time:</p>
 <pre>   ev_periodic_set (&amp;periodic, 0., 3600., 0);
@@ -1137,8 +1140,11 @@ by 3600.</p>
                                        <p>Another way to think about it (for the mathematically inclined) is that
 <code>ev_periodic</code> will try to run the callback in this mode at the next possible
 time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
                                        <p>Another way to think about it (for the mathematically inclined) is that
 <code>ev_periodic</code> will try to run the callback in this mode at the next possible
 time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
+                                       <p>For numerical stability it is preferable that the <code>at</code> value is near
+<code>ev_now ()</code> (the current time), but there is no range requirement for
+this value.</p>
                                </dd>
                                </dd>
-                               <dt>* manual reschedule mode (reschedule_cb = callback)</dt>
+                               <dt>* manual reschedule mode (at and interval ignored, reschedule_cb = callback)</dt>
                                <dd>
                                        <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
 ignored. Instead, each time the periodic watcher gets scheduled, the
                                <dd>
                                        <p>In this mode the values for <code>interval</code> and <code>at</code> are both being
 ignored. Instead, each time the periodic watcher gets scheduled, the
@@ -1147,7 +1153,7 @@ current time as second argument.</p>
                                        <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
 ever, or make any event loop modifications</i>. If you need to stop it,
 return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
                                        <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
 ever, or make any event loop modifications</i>. If you need to stop it,
 return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
-starting a prepare watcher).</p>
+starting an <code>ev_prepare</code> watcher, which is legal).</p>
                                        <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)</code>, e.g.:</p>
 <pre>   static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
                                        <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
 ev_tstamp now)</code>, e.g.:</p>
 <pre>   static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
@@ -1177,6 +1183,13 @@ reason I omitted it as an example).</p>
 when you changed some parameters or the reschedule callback would return
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).</p>
 when you changed some parameters or the reschedule callback would return
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).</p>
+       </dd>
+       <dt>ev_tstamp offset [read-write]</dt>
+       <dd>
+               <p>When repeating, this contains the offset value, otherwise this is the
+absolute point in time (the <code>at</code> value passed to <code>ev_periodic_set</code>).</p>
+               <p>Can be modified any time, but changes only take effect when the periodic
+timer fires or <code>ev_periodic_again</code> is being called.</p>
        </dd>
        <dt>ev_tstamp interval [read-write]</dt>
        <dd>
        </dd>
        <dt>ev_tstamp interval [read-write]</dt>
        <dd>
@@ -1485,6 +1498,15 @@ with priority higher than or equal to the event loop and one coroutine
 of lower priority, but only once, using idle watchers to keep the event
 loop from blocking if lower-priority coroutines are active, thus mapping
 low-priority coroutines to idle/background tasks).</p>
 of lower priority, but only once, using idle watchers to keep the event
 loop from blocking if lower-priority coroutines are active, thus mapping
 low-priority coroutines to idle/background tasks).</p>
+<p>It is recommended to give <code>ev_check</code> watchers highest (<code>EV_MAXPRI</code>)
+priority, to ensure that they are being run before any other watchers
+after the poll. Also, <code>ev_check</code> watchers (and <code>ev_prepare</code> watchers,
+too) should not activate (&quot;feed&quot;) events into libev. While libev fully
+supports this, they will be called before other <code>ev_check</code> watchers did
+their job. As <code>ev_check</code> watchers are often used to embed other event
+loops those other event loops might be in an unusable state until their
+<code>ev_check</code> watcher ran (always remind yourself to coexist peacefully with
+others).</p>
 <dl>
        <dt>ev_prepare_init (ev_prepare *, callback)</dt>
        <dt>ev_check_init (ev_check *, callback)</dt>
 <dl>
        <dt>ev_prepare_init (ev_prepare *, callback)</dt>
        <dt>ev_check_init (ev_check *, callback)</dt>
High-performance event loop/event model with lots of features.