… | |
… | |
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="<standard input>" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
9 | <meta name="created" content="Wed Nov 28 12:27:27 2007" /> |
9 | <meta name="created" content="Sun Dec 9 20:30:11 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 |
|
|
125 | web page you might find easier to navigate when reading it for the first |
|
|
126 | time: <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 |
125 | file descriptor being readable or a timeout occuring), and it will manage |
128 | file descriptor being readable or a timeout occuring), and it will manage |
126 | these event sources and provide your program with events.</p> |
129 | these 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 |
… | |
… | |
133 | watcher.</p> |
136 | watcher.</p> |
134 | |
137 | |
135 | </div> |
138 | </div> |
136 | <h1 id="FEATURES">FEATURES</h1> |
139 | <h1 id="FEATURES">FEATURES</h1> |
137 | <div id="FEATURES_CONTENT"> |
140 | <div id="FEATURES_CONTENT"> |
138 | <p>Libev supports <code>select</code>, <code>poll</code>, the linux-specific <code>epoll</code>, the |
141 | <p>Libev supports <code>select</code>, <code>poll</code>, the Linux-specific <code>epoll</code>, the |
139 | bsd-specific <code>kqueue</code> and the solaris-specific event port mechanisms |
142 | BSD-specific <code>kqueue</code> and the Solaris-specific event port mechanisms |
140 | for file descriptor events (<code>ev_io</code>), relative timers (<code>ev_timer</code>), |
143 | for file descriptor events (<code>ev_io</code>), the Linux <code>inotify</code> interface |
|
|
144 | (for <code>ev_stat</code>), relative timers (<code>ev_timer</code>), absolute timers |
141 | absolute timers with customised rescheduling (<code>ev_periodic</code>), synchronous |
145 | with customised rescheduling (<code>ev_periodic</code>), synchronous signals |
142 | signals (<code>ev_signal</code>), process status change events (<code>ev_child</code>), and |
146 | (<code>ev_signal</code>), process status change events (<code>ev_child</code>), and event |
143 | event watchers dealing with the event loop mechanism itself (<code>ev_idle</code>, |
147 | watchers 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 |
148 | <code>ev_embed</code>, <code>ev_prepare</code> and <code>ev_check</code> watchers) as well as |
145 | file watchers (<code>ev_stat</code>) and even limited support for fork events |
149 | file watchers (<code>ev_stat</code>) and even limited support for fork events |
146 | (<code>ev_fork</code>).</p> |
150 | (<code>ev_fork</code>).</p> |
147 | <p>It also is quite fast (see this |
151 | <p>It also is quite fast (see this |
148 | <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent |
152 | <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent |
… | |
… | |
229 | might be supported on the current system, you would need to look at |
233 | might be supported on the current system, you would need to look at |
230 | <code>ev_embeddable_backends () & ev_supported_backends ()</code>, likewise for |
234 | <code>ev_embeddable_backends () & ev_supported_backends ()</code>, likewise for |
231 | recommended ones.</p> |
235 | recommended ones.</p> |
232 | <p>See the description of <code>ev_embed</code> watchers for more info.</p> |
236 | <p>See the description of <code>ev_embed</code> watchers for more info.</p> |
233 | </dd> |
237 | </dd> |
234 | <dt>ev_set_allocator (void *(*cb)(void *ptr, size_t size))</dt> |
238 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
235 | <dd> |
239 | <dd> |
236 | <p>Sets the allocation function to use (the prototype and semantics are |
240 | <p>Sets the allocation function to use (the prototype is similar - the |
237 | identical to the realloc C function). It is used to allocate and free |
241 | semantics is identical - to the realloc C function). It is used to |
238 | memory (no surprises here). If it returns zero when memory needs to be |
242 | allocate and free memory (no surprises here). If it returns zero when |
239 | allocated, the library might abort or take some potentially destructive |
243 | memory needs to be allocated, the library might abort or take some |
240 | action. The default is your system realloc function.</p> |
244 | potentially destructive action. The default is your system realloc |
|
|
245 | function.</p> |
241 | <p>You could override this function in high-availability programs to, say, |
246 | <p>You could override this function in high-availability programs to, say, |
242 | free some memory if it cannot allocate memory, to use a special allocator, |
247 | free some memory if it cannot allocate memory, to use a special allocator, |
243 | or even to sleep a while and retry until some memory is available.</p> |
248 | or 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 |
249 | <p>Example: Replace the libev allocator with one that waits a bit and then |
245 | retries).</p> |
250 | retries).</p> |
… | |
… | |
324 | <code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
329 | <code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
325 | override the flags completely if it is found in the environment. This is |
330 | override the flags completely if it is found in the environment. This is |
326 | useful to try out specific backends to test their performance, or to work |
331 | useful to try out specific backends to test their performance, or to work |
327 | around bugs.</p> |
332 | around bugs.</p> |
328 | </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 |
|
|
337 | a fork, you can also make libev check for a fork in each iteration by |
|
|
338 | enabling this flag.</p> |
|
|
339 | <p>This works by calling <code>getpid ()</code> on every iteration of the loop, |
|
|
340 | and thus this might slow down your event loop if you do a lot of loop |
|
|
341 | iterations and little real work, but is usually not noticeable (on my |
|
|
342 | Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence |
|
|
343 | without 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 |
|
|
346 | forget about forgetting to tell libev about forking) when you use this |
|
|
347 | flag.</p> |
|
|
348 | <p>This flag setting cannot be overriden or specified in the <code>LIBEV_FLAGS</code> |
|
|
349 | environment variable.</p> |
|
|
350 | </dd> |
329 | <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt> |
351 | <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt> |
330 | <dd> |
352 | <dd> |
331 | <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 |
332 | libev tries to roll its own fd_set with no limits on the number of fds, |
354 | libev tries to roll its own fd_set with no limits on the number of fds, |
333 | but if that fails, expect a fairly low limit on the number of fds when |
355 | but if that fails, expect a fairly low limit on the number of fds when |
… | |
… | |
461 | <dt>ev_loop_fork (loop)</dt> |
483 | <dt>ev_loop_fork (loop)</dt> |
462 | <dd> |
484 | <dd> |
463 | <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 |
464 | <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 |
465 | after fork, and how you do this is entirely your own problem.</p> |
487 | after 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 |
|
|
492 | the number of times libev did poll for new events. It starts at <code>0</code> and |
|
|
493 | happily wraps around with enough iterations.</p> |
|
|
494 | <p>This value can sometimes be useful as a generation counter of sorts (it |
|
|
495 | "ticks" the number of loop iterations), as it roughly corresponds with |
|
|
496 | <code>ev_prepare</code> and <code>ev_check</code> calls.</p> |
466 | </dd> |
497 | </dd> |
467 | <dt>unsigned int ev_backend (loop)</dt> |
498 | <dt>unsigned int ev_backend (loop)</dt> |
468 | <dd> |
499 | <dd> |
469 | <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 |
470 | use.</p> |
501 | use.</p> |
… | |
… | |
498 | one iteration of the loop. This is useful if you are waiting for some |
529 | one iteration of the loop. This is useful if you are waiting for some |
499 | external event in conjunction with something not expressible using other |
530 | external event in conjunction with something not expressible using other |
500 | libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is |
531 | libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is |
501 | usually a better approach for this kind of thing.</p> |
532 | usually a better approach for this kind of thing.</p> |
502 | <p>Here are the gory details of what <code>ev_loop</code> does:</p> |
533 | <p>Here are the gory details of what <code>ev_loop</code> does:</p> |
|
|
534 | <pre> - Before the first iteration, call any pending watchers. |
503 | <pre> * If there are no active watchers (reference count is zero), return. |
535 | * If there are no active watchers (reference count is zero), return. |
504 | - Queue prepare watchers and then call all outstanding watchers. |
536 | - Queue all prepare watchers and then call all outstanding watchers. |
505 | - If we have been forked, recreate the kernel state. |
537 | - If we have been forked, recreate the kernel state. |
506 | - Update the kernel state with all outstanding changes. |
538 | - Update the kernel state with all outstanding changes. |
507 | - Update the "event loop time". |
539 | - Update the "event loop time". |
508 | - Calculate for how long to block. |
540 | - Calculate for how long to block. |
509 | - Block the process, waiting for any events. |
541 | - Block the process, waiting for any events. |
… | |
… | |
738 | <dt>bool ev_is_pending (ev_TYPE *watcher)</dt> |
770 | <dt>bool ev_is_pending (ev_TYPE *watcher)</dt> |
739 | <dd> |
771 | <dd> |
740 | <p>Returns a true value iff the watcher is pending, (i.e. it has outstanding |
772 | <p>Returns a true value iff the watcher is pending, (i.e. it has outstanding |
741 | events but its callback has not yet been invoked). As long as a watcher |
773 | events but its callback has not yet been invoked). As long as a watcher |
742 | is pending (but not active) you must not call an init function on it (but |
774 | is pending (but not active) you must not call an init function on it (but |
743 | <code>ev_TYPE_set</code> is safe) and you must make sure the watcher is available to |
775 | <code>ev_TYPE_set</code> is safe), you must not change its priority, and you must |
744 | libev (e.g. you cnanot <code>free ()</code> it).</p> |
776 | make sure the watcher is available to libev (e.g. you cannot <code>free ()</code> |
|
|
777 | it).</p> |
745 | </dd> |
778 | </dd> |
746 | <dt>callback ev_cb (ev_TYPE *watcher)</dt> |
779 | <dt>callback ev_cb (ev_TYPE *watcher)</dt> |
747 | <dd> |
780 | <dd> |
748 | <p>Returns the callback currently set on the watcher.</p> |
781 | <p>Returns the callback currently set on the watcher.</p> |
749 | </dd> |
782 | </dd> |
750 | <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt> |
783 | <dt>ev_cb_set (ev_TYPE *watcher, callback)</dt> |
751 | <dd> |
784 | <dd> |
752 | <p>Change the callback. You can change the callback at virtually any time |
785 | <p>Change the callback. You can change the callback at virtually any time |
753 | (modulo threads).</p> |
786 | (modulo threads).</p> |
|
|
787 | </dd> |
|
|
788 | <dt>ev_set_priority (ev_TYPE *watcher, priority)</dt> |
|
|
789 | <dt>int ev_priority (ev_TYPE *watcher)</dt> |
|
|
790 | <dd> |
|
|
791 | <p>Set and query the priority of the watcher. The priority is a small |
|
|
792 | integer between <code>EV_MAXPRI</code> (default: <code>2</code>) and <code>EV_MINPRI</code> |
|
|
793 | (default: <code>-2</code>). Pending watchers with higher priority will be invoked |
|
|
794 | before watchers with lower priority, but priority will not keep watchers |
|
|
795 | from being executed (except for <code>ev_idle</code> watchers).</p> |
|
|
796 | <p>This means that priorities are <i>only</i> used for ordering callback |
|
|
797 | invocation after new events have been received. This is useful, for |
|
|
798 | example, to reduce latency after idling, or more often, to bind two |
|
|
799 | watchers on the same event and make sure one is called first.</p> |
|
|
800 | <p>If you need to suppress invocation when higher priority events are pending |
|
|
801 | you need to look at <code>ev_idle</code> watchers, which provide this functionality.</p> |
|
|
802 | <p>You <i>must not</i> change the priority of a watcher as long as it is active or |
|
|
803 | pending.</p> |
|
|
804 | <p>The default priority used by watchers when no priority has been set is |
|
|
805 | always <code>0</code>, which is supposed to not be too high and not be too low :).</p> |
|
|
806 | <p>Setting a priority outside the range of <code>EV_MINPRI</code> to <code>EV_MAXPRI</code> is |
|
|
807 | fine, as long as you do not mind that the priority value you query might |
|
|
808 | or might not have been adjusted to be within valid range.</p> |
|
|
809 | </dd> |
|
|
810 | <dt>ev_invoke (loop, ev_TYPE *watcher, int revents)</dt> |
|
|
811 | <dd> |
|
|
812 | <p>Invoke the <code>watcher</code> with the given <code>loop</code> and <code>revents</code>. Neither |
|
|
813 | <code>loop</code> nor <code>revents</code> need to be valid as long as the watcher callback |
|
|
814 | can deal with that fact.</p> |
|
|
815 | </dd> |
|
|
816 | <dt>int ev_clear_pending (loop, ev_TYPE *watcher)</dt> |
|
|
817 | <dd> |
|
|
818 | <p>If the watcher is pending, this function returns clears its pending status |
|
|
819 | and returns its <code>revents</code> bitset (as if its callback was invoked). If the |
|
|
820 | watcher isn't pending it does nothing and returns <code>0</code>.</p> |
754 | </dd> |
821 | </dd> |
755 | </dl> |
822 | </dl> |
756 | |
823 | |
757 | |
824 | |
758 | |
825 | |
… | |
… | |
869 | this situation even with a relatively standard program structure. Thus |
936 | this situation even with a relatively standard program structure. Thus |
870 | it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning |
937 | it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning |
871 | <code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p> |
938 | <code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p> |
872 | <p>If you cannot run the fd in non-blocking mode (for example you should not |
939 | <p>If you cannot run the fd in non-blocking mode (for example you should not |
873 | play around with an Xlib connection), then you have to seperately re-test |
940 | play around with an Xlib connection), then you have to seperately re-test |
874 | wether a file descriptor is really ready with a known-to-be good interface |
941 | whether a file descriptor is really ready with a known-to-be good interface |
875 | such as poll (fortunately in our Xlib example, Xlib already does this on |
942 | such as poll (fortunately in our Xlib example, Xlib already does this on |
876 | its own, so its quite safe to use).</p> |
943 | its own, so its quite safe to use).</p> |
877 | <dl> |
944 | <dl> |
878 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
945 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
879 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
946 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
… | |
… | |
950 | </dd> |
1017 | </dd> |
951 | <dt>ev_timer_again (loop)</dt> |
1018 | <dt>ev_timer_again (loop)</dt> |
952 | <dd> |
1019 | <dd> |
953 | <p>This will act as if the timer timed out and restart it again if it is |
1020 | <p>This will act as if the timer timed out and restart it again if it is |
954 | repeating. The exact semantics are:</p> |
1021 | repeating. The exact semantics are:</p> |
|
|
1022 | <p>If the timer is pending, its pending status is cleared.</p> |
955 | <p>If the timer is started but nonrepeating, stop it.</p> |
1023 | <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 |
1024 | <p>If the timer is repeating, either start it if necessary (with the |
957 | value), or reset the running timer to the repeat value.</p> |
1025 | <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 |
1026 | <p>This sounds a bit complicated, but here is a useful and typical |
959 | example: Imagine you have a tcp connection and you want a so-called |
1027 | example: Imagine you have a tcp connection and you want a so-called idle |
960 | idle timeout, that is, you want to be called when there have been, |
1028 | timeout, that is, you want to be called when there have been, say, 60 |
961 | say, 60 seconds of inactivity on the socket. The easiest way to do |
1029 | seconds of inactivity on the socket. The easiest way to do this is to |
962 | this is to configure an <code>ev_timer</code> with <code>after</code>=<code>repeat</code>=<code>60</code> and calling |
1030 | configure 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 |
1031 | <code>ev_timer_again</code> each time you successfully read or write some data. If |
964 | you go into an idle state where you do not expect data to travel on the |
1032 | you go into an idle state where you do not expect data to travel on the |
965 | socket, you can stop the timer, and again will automatically restart it if |
1033 | socket, you can <code>ev_timer_stop</code> the timer, and <code>ev_timer_again</code> will |
966 | need be.</p> |
1034 | automatically restart it if need be.</p> |
967 | <p>You can also ignore the <code>after</code> value and <code>ev_timer_start</code> altogether |
1035 | <p>That means you can ignore the <code>after</code> value and <code>ev_timer_start</code> |
968 | and only ever use the <code>repeat</code> value:</p> |
1036 | altogether 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.); |
1037 | <pre> ev_timer_init (timer, callback, 0., 5.); |
970 | ev_timer_again (loop, timer); |
1038 | ev_timer_again (loop, timer); |
971 | ... |
1039 | ... |
972 | timer->again = 17.; |
1040 | timer->again = 17.; |
973 | ev_timer_again (loop, timer); |
1041 | ev_timer_again (loop, timer); |
974 | ... |
1042 | ... |
975 | timer->again = 10.; |
1043 | timer->again = 10.; |
976 | ev_timer_again (loop, timer); |
1044 | ev_timer_again (loop, timer); |
977 | |
1045 | |
978 | </pre> |
1046 | </pre> |
979 | <p>This is more efficient then stopping/starting the timer eahc time you want |
1047 | <p>This is more slightly efficient then stopping/starting the timer each time |
980 | to modify its timeout value.</p> |
1048 | you want to modify its timeout value.</p> |
981 | </dd> |
1049 | </dd> |
982 | <dt>ev_tstamp repeat [read-write]</dt> |
1050 | <dt>ev_tstamp repeat [read-write]</dt> |
983 | <dd> |
1051 | <dd> |
984 | <p>The current <code>repeat</code> value. Will be used each time the watcher times out |
1052 | <p>The current <code>repeat</code> value. Will be used each time the watcher times out |
985 | or <code>ev_timer_again</code> is called and determines the next timeout (if any), |
1053 | or <code>ev_timer_again</code> is called and determines the next timeout (if any), |
… | |
… | |
1029 | but on wallclock time (absolute time). You can tell a periodic watcher |
1097 | but on wallclock time (absolute time). You can tell a periodic watcher |
1030 | to trigger "at" some specific point in time. For example, if you tell a |
1098 | to trigger "at" some specific point in time. For example, if you tell a |
1031 | periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now () |
1099 | periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now () |
1032 | + 10.</code>) and then reset your system clock to the last year, then it will |
1100 | + 10.</code>) and then reset your system clock to the last year, then it will |
1033 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
1101 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
1034 | roughly 10 seconds later and of course not if you reset your system time |
1102 | roughly 10 seconds later).</p> |
1035 | again).</p> |
|
|
1036 | <p>They can also be used to implement vastly more complex timers, such as |
1103 | <p>They can also be used to implement vastly more complex timers, such as |
1037 | triggering an event on eahc midnight, local time.</p> |
1104 | triggering an event on each midnight, local time or other, complicated, |
|
|
1105 | rules.</p> |
1038 | <p>As with timers, the callback is guarenteed to be invoked only when the |
1106 | <p>As with timers, the callback is guarenteed to be invoked only when the |
1039 | time (<code>at</code>) has been passed, but if multiple periodic timers become ready |
1107 | time (<code>at</code>) has been passed, but if multiple periodic timers become ready |
1040 | during the same loop iteration then order of execution is undefined.</p> |
1108 | during the same loop iteration then order of execution is undefined.</p> |
1041 | <dl> |
1109 | <dl> |
1042 | <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
1110 | <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
… | |
… | |
1044 | <dd> |
1112 | <dd> |
1045 | <p>Lots of arguments, lets sort it out... There are basically three modes of |
1113 | <p>Lots of arguments, lets sort it out... There are basically three modes of |
1046 | operation, and we will explain them from simplest to complex:</p> |
1114 | operation, and we will explain them from simplest to complex:</p> |
1047 | <p> |
1115 | <p> |
1048 | <dl> |
1116 | <dl> |
1049 | <dt>* absolute timer (interval = reschedule_cb = 0)</dt> |
1117 | <dt>* absolute timer (at = time, interval = reschedule_cb = 0)</dt> |
1050 | <dd> |
1118 | <dd> |
1051 | <p>In this configuration the watcher triggers an event at the wallclock time |
1119 | <p>In this configuration the watcher triggers an event at the wallclock time |
1052 | <code>at</code> and doesn't repeat. It will not adjust when a time jump occurs, |
1120 | <code>at</code> and doesn't repeat. It will not adjust when a time jump occurs, |
1053 | that is, if it is to be run at January 1st 2011 then it will run when the |
1121 | that is, if it is to be run at January 1st 2011 then it will run when the |
1054 | system time reaches or surpasses this time.</p> |
1122 | system time reaches or surpasses this time.</p> |
1055 | </dd> |
1123 | </dd> |
1056 | <dt>* non-repeating interval timer (interval > 0, reschedule_cb = 0)</dt> |
1124 | <dt>* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)</dt> |
1057 | <dd> |
1125 | <dd> |
1058 | <p>In this mode the watcher will always be scheduled to time out at the next |
1126 | <p>In this mode the watcher will always be scheduled to time out at the next |
1059 | <code>at + N * interval</code> time (for some integer N) and then repeat, regardless |
1127 | <code>at + N * interval</code> time (for some integer N, which can also be negative) |
1060 | of any time jumps.</p> |
1128 | and then repeat, regardless of any time jumps.</p> |
1061 | <p>This can be used to create timers that do not drift with respect to system |
1129 | <p>This can be used to create timers that do not drift with respect to system |
1062 | time:</p> |
1130 | time:</p> |
1063 | <pre> ev_periodic_set (&periodic, 0., 3600., 0); |
1131 | <pre> ev_periodic_set (&periodic, 0., 3600., 0); |
1064 | |
1132 | |
1065 | </pre> |
1133 | </pre> |
… | |
… | |
1068 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1136 | full hour (UTC), or more correctly, when the system time is evenly divisible |
1069 | by 3600.</p> |
1137 | by 3600.</p> |
1070 | <p>Another way to think about it (for the mathematically inclined) is that |
1138 | <p>Another way to think about it (for the mathematically inclined) is that |
1071 | <code>ev_periodic</code> will try to run the callback in this mode at the next possible |
1139 | <code>ev_periodic</code> will try to run the callback in this mode at the next possible |
1072 | time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> |
1140 | time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p> |
|
|
1141 | <p>For numerical stability it is preferable that the <code>at</code> value is near |
|
|
1142 | <code>ev_now ()</code> (the current time), but there is no range requirement for |
|
|
1143 | this value.</p> |
1073 | </dd> |
1144 | </dd> |
1074 | <dt>* manual reschedule mode (reschedule_cb = callback)</dt> |
1145 | <dt>* manual reschedule mode (at and interval ignored, reschedule_cb = callback)</dt> |
1075 | <dd> |
1146 | <dd> |
1076 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
1147 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
1077 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1148 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1078 | reschedule callback will be called with the watcher as first, and the |
1149 | reschedule callback will be called with the watcher as first, and the |
1079 | current time as second argument.</p> |
1150 | current time as second argument.</p> |
1080 | <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher, |
1151 | <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher, |
1081 | ever, or make any event loop modifications</i>. If you need to stop it, |
1152 | ever, or make any event loop modifications</i>. If you need to stop it, |
1082 | return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by |
1153 | return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by |
1083 | starting a prepare watcher).</p> |
1154 | starting an <code>ev_prepare</code> watcher, which is legal).</p> |
1084 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1155 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1085 | ev_tstamp now)</code>, e.g.:</p> |
1156 | ev_tstamp now)</code>, e.g.:</p> |
1086 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1157 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1087 | { |
1158 | { |
1088 | return now + 60.; |
1159 | return now + 60.; |
… | |
… | |
1108 | <dd> |
1179 | <dd> |
1109 | <p>Simply stops and restarts the periodic watcher again. This is only useful |
1180 | <p>Simply stops and restarts the periodic watcher again. This is only useful |
1110 | when you changed some parameters or the reschedule callback would return |
1181 | when you changed some parameters or the reschedule callback would return |
1111 | a different time than the last time it was called (e.g. in a crond like |
1182 | a different time than the last time it was called (e.g. in a crond like |
1112 | program when the crontabs have changed).</p> |
1183 | program when the crontabs have changed).</p> |
|
|
1184 | </dd> |
|
|
1185 | <dt>ev_tstamp offset [read-write]</dt> |
|
|
1186 | <dd> |
|
|
1187 | <p>When repeating, this contains the offset value, otherwise this is the |
|
|
1188 | absolute point in time (the <code>at</code> value passed to <code>ev_periodic_set</code>).</p> |
|
|
1189 | <p>Can be modified any time, but changes only take effect when the periodic |
|
|
1190 | timer fires or <code>ev_periodic_again</code> is being called.</p> |
1113 | </dd> |
1191 | </dd> |
1114 | <dt>ev_tstamp interval [read-write]</dt> |
1192 | <dt>ev_tstamp interval [read-write]</dt> |
1115 | <dd> |
1193 | <dd> |
1116 | <p>The current interval value. Can be modified any time, but changes only |
1194 | <p>The current interval value. Can be modified any time, but changes only |
1117 | take effect when the periodic timer fires or <code>ev_periodic_again</code> is being |
1195 | take effect when the periodic timer fires or <code>ev_periodic_again</code> is being |
… | |
… | |
1246 | <p>The path does not need to exist: changing from "path exists" to "path does |
1324 | <p>The path does not need to exist: changing from "path exists" to "path does |
1247 | not exist" is a status change like any other. The condition "path does |
1325 | not exist" is a status change like any other. The condition "path does |
1248 | not exist" is signified by the <code>st_nlink</code> field being zero (which is |
1326 | not exist" is signified by the <code>st_nlink</code> field being zero (which is |
1249 | otherwise always forced to be at least one) and all the other fields of |
1327 | otherwise always forced to be at least one) and all the other fields of |
1250 | the stat buffer having unspecified contents.</p> |
1328 | the stat buffer having unspecified contents.</p> |
|
|
1329 | <p>The path <i>should</i> be absolute and <i>must not</i> end in a slash. If it is |
|
|
1330 | relative and your working directory changes, the behaviour is undefined.</p> |
1251 | <p>Since there is no standard to do this, the portable implementation simply |
1331 | <p>Since there is no standard to do this, the portable implementation simply |
1252 | calls <code>stat (2)</code> regularly on the path to see if it changed somehow. You |
1332 | calls <code>stat (2)</code> regularly on the path to see if it changed somehow. You |
1253 | can specify a recommended polling interval for this case. If you specify |
1333 | can specify a recommended polling interval for this case. If you specify |
1254 | a polling interval of <code>0</code> (highly recommended!) then a <i>suitable, |
1334 | a polling interval of <code>0</code> (highly recommended!) then a <i>suitable, |
1255 | unspecified default</i> value will be used (which you can expect to be around |
1335 | unspecified default</i> value will be used (which you can expect to be around |
… | |
… | |
1336 | </pre> |
1416 | </pre> |
1337 | |
1417 | |
1338 | </div> |
1418 | </div> |
1339 | <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2> |
1419 | <h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2> |
1340 | <div id="code_ev_idle_code_when_you_ve_got_no-2"> |
1420 | <div id="code_ev_idle_code_when_you_ve_got_no-2"> |
1341 | <p>Idle watchers trigger events when there are no other events are pending |
1421 | <p>Idle watchers trigger events when no other events of the same or higher |
1342 | (prepare, check and other idle watchers do not count). That is, as long |
1422 | priority are pending (prepare, check and other idle watchers do not |
1343 | as your process is busy handling sockets or timeouts (or even signals, |
1423 | count).</p> |
1344 | imagine) it will not be triggered. But when your process is idle all idle |
1424 | <p>That is, as long as your process is busy handling sockets or timeouts |
1345 | watchers are being called again and again, once per event loop iteration - |
1425 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1426 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1427 | are pending), the idle watchers are being called once per event loop |
1346 | until stopped, that is, or your process receives more events and becomes |
1428 | iteration - until stopped, that is, or your process receives more events |
1347 | busy.</p> |
1429 | and becomes busy again with higher priority stuff.</p> |
1348 | <p>The most noteworthy effect is that as long as any idle watchers are |
1430 | <p>The most noteworthy effect is that as long as any idle watchers are |
1349 | active, the process will not block when waiting for new events.</p> |
1431 | active, the process will not block when waiting for new events.</p> |
1350 | <p>Apart from keeping your process non-blocking (which is a useful |
1432 | <p>Apart from keeping your process non-blocking (which is a useful |
1351 | effect on its own sometimes), idle watchers are a good place to do |
1433 | effect on its own sometimes), idle watchers are a good place to do |
1352 | "pseudo-background processing", or delay processing stuff to after the |
1434 | "pseudo-background processing", or delay processing stuff to after the |
… | |
… | |
1412 | are ready to run (it's actually more complicated: it only runs coroutines |
1494 | are ready to run (it's actually more complicated: it only runs coroutines |
1413 | with priority higher than or equal to the event loop and one coroutine |
1495 | with priority higher than or equal to the event loop and one coroutine |
1414 | of lower priority, but only once, using idle watchers to keep the event |
1496 | of lower priority, but only once, using idle watchers to keep the event |
1415 | loop from blocking if lower-priority coroutines are active, thus mapping |
1497 | loop from blocking if lower-priority coroutines are active, thus mapping |
1416 | low-priority coroutines to idle/background tasks).</p> |
1498 | low-priority coroutines to idle/background tasks).</p> |
|
|
1499 | <p>It is recommended to give <code>ev_check</code> watchers highest (<code>EV_MAXPRI</code>) |
|
|
1500 | priority, to ensure that they are being run before any other watchers |
|
|
1501 | after the poll. Also, <code>ev_check</code> watchers (and <code>ev_prepare</code> watchers, |
|
|
1502 | too) should not activate ("feed") events into libev. While libev fully |
|
|
1503 | supports this, they will be called before other <code>ev_check</code> watchers did |
|
|
1504 | their job. As <code>ev_check</code> watchers are often used to embed other event |
|
|
1505 | loops those other event loops might be in an unusable state until their |
|
|
1506 | <code>ev_check</code> watcher ran (always remind yourself to coexist peacefully with |
|
|
1507 | others).</p> |
1417 | <dl> |
1508 | <dl> |
1418 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
1509 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
1419 | <dt>ev_check_init (ev_check *, callback)</dt> |
1510 | <dt>ev_check_init (ev_check *, callback)</dt> |
1420 | <dd> |
1511 | <dd> |
1421 | <p>Initialises and configures the prepare or check watcher - they have no |
1512 | <p>Initialises and configures the prepare or check watcher - they have no |
1422 | parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
1513 | parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code> |
1423 | macros, but using them is utterly, utterly and completely pointless.</p> |
1514 | macros, but using them is utterly, utterly and completely pointless.</p> |
1424 | </dd> |
1515 | </dd> |
1425 | </dl> |
1516 | </dl> |
1426 | <p>Example: To include a library such as adns, you would add IO watchers |
1517 | <p>There are a number of principal ways to embed other event loops or modules |
1427 | and a timeout watcher in a prepare handler, as required by libadns, and |
1518 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1519 | (there is a Perl module named <code>EV::ADNS</code> that does this, which you could |
|
|
1520 | use for an actually working example. Another Perl module named <code>EV::Glib</code> |
|
|
1521 | embeds a Glib main context into libev, and finally, <code>Glib::EV</code> embeds EV |
|
|
1522 | into the Glib event loop).</p> |
|
|
1523 | <p>Method 1: Add IO watchers and a timeout watcher in a prepare handler, |
1428 | in a check watcher, destroy them and call into libadns. What follows is |
1524 | and in a check watcher, destroy them and call into libadns. What follows |
1429 | pseudo-code only of course:</p> |
1525 | is pseudo-code only of course. This requires you to either use a low |
|
|
1526 | priority for the check watcher or use <code>ev_clear_pending</code> explicitly, as |
|
|
1527 | the callbacks for the IO/timeout watchers might not have been called yet.</p> |
1430 | <pre> static ev_io iow [nfd]; |
1528 | <pre> static ev_io iow [nfd]; |
1431 | static ev_timer tw; |
1529 | static ev_timer tw; |
1432 | |
1530 | |
1433 | static void |
1531 | static void |
1434 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1532 | io_cb (ev_loop *loop, ev_io *w, int revents) |
1435 | { |
1533 | { |
1436 | // set the relevant poll flags |
|
|
1437 | // could also call adns_processreadable etc. here |
|
|
1438 | struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1439 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1440 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1441 | } |
1534 | } |
1442 | |
1535 | |
1443 | // create io watchers for each fd and a timer before blocking |
1536 | // create io watchers for each fd and a timer before blocking |
1444 | static void |
1537 | static void |
1445 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1538 | adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1446 | { |
1539 | { |
1447 | int timeout = 3600000;truct pollfd fds [nfd]; |
1540 | int timeout = 3600000; |
|
|
1541 | struct pollfd fds [nfd]; |
1448 | // actual code will need to loop here and realloc etc. |
1542 | // actual code will need to loop here and realloc etc. |
1449 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1543 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1450 | |
1544 | |
1451 | /* the callback is illegal, but won't be called as we stop during check */ |
1545 | /* the callback is illegal, but won't be called as we stop during check */ |
1452 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1546 | ev_timer_init (&tw, 0, timeout * 1e-3); |
1453 | ev_timer_start (loop, &tw); |
1547 | ev_timer_start (loop, &tw); |
1454 | |
1548 | |
1455 | // create on ev_io per pollfd |
1549 | // create one ev_io per pollfd |
1456 | for (int i = 0; i < nfd; ++i) |
1550 | for (int i = 0; i < nfd; ++i) |
1457 | { |
1551 | { |
1458 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1552 | ev_io_init (iow + i, io_cb, fds [i].fd, |
1459 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1553 | ((fds [i].events & POLLIN ? EV_READ : 0) |
1460 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1554 | | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1461 | |
1555 | |
1462 | fds [i].revents = 0; |
1556 | fds [i].revents = 0; |
1463 | iow [i].data = fds + i; |
|
|
1464 | ev_io_start (loop, iow + i); |
1557 | ev_io_start (loop, iow + i); |
1465 | } |
1558 | } |
1466 | } |
1559 | } |
1467 | |
1560 | |
1468 | // stop all watchers after blocking |
1561 | // stop all watchers after blocking |
… | |
… | |
1470 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1563 | adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1471 | { |
1564 | { |
1472 | ev_timer_stop (loop, &tw); |
1565 | ev_timer_stop (loop, &tw); |
1473 | |
1566 | |
1474 | for (int i = 0; i < nfd; ++i) |
1567 | for (int i = 0; i < nfd; ++i) |
|
|
1568 | { |
|
|
1569 | // set the relevant poll flags |
|
|
1570 | // could also call adns_processreadable etc. here |
|
|
1571 | struct pollfd *fd = fds + i; |
|
|
1572 | int revents = ev_clear_pending (iow + i); |
|
|
1573 | if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1574 | if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1575 | |
|
|
1576 | // now stop the watcher |
1475 | ev_io_stop (loop, iow + i); |
1577 | ev_io_stop (loop, iow + i); |
|
|
1578 | } |
1476 | |
1579 | |
1477 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1580 | adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1581 | } |
|
|
1582 | |
|
|
1583 | </pre> |
|
|
1584 | <p>Method 2: This would be just like method 1, but you run <code>adns_afterpoll</code> |
|
|
1585 | in the prepare watcher and would dispose of the check watcher.</p> |
|
|
1586 | <p>Method 3: If the module to be embedded supports explicit event |
|
|
1587 | notification (adns does), you can also make use of the actual watcher |
|
|
1588 | callbacks, and only destroy/create the watchers in the prepare watcher.</p> |
|
|
1589 | <pre> static void |
|
|
1590 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1591 | { |
|
|
1592 | adns_state ads = (adns_state)w->data; |
|
|
1593 | update_now (EV_A); |
|
|
1594 | |
|
|
1595 | adns_processtimeouts (ads, &tv_now); |
|
|
1596 | } |
|
|
1597 | |
|
|
1598 | static void |
|
|
1599 | io_cb (EV_P_ ev_io *w, int revents) |
|
|
1600 | { |
|
|
1601 | adns_state ads = (adns_state)w->data; |
|
|
1602 | update_now (EV_A); |
|
|
1603 | |
|
|
1604 | if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1605 | if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1606 | } |
|
|
1607 | |
|
|
1608 | // do not ever call adns_afterpoll |
|
|
1609 | |
|
|
1610 | </pre> |
|
|
1611 | <p>Method 4: Do not use a prepare or check watcher because the module you |
|
|
1612 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1613 | their poll function. The drawback with this solution is that the main |
|
|
1614 | loop is now no longer controllable by EV. The <code>Glib::EV</code> module does |
|
|
1615 | this.</p> |
|
|
1616 | <pre> static gint |
|
|
1617 | event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1618 | { |
|
|
1619 | int got_events = 0; |
|
|
1620 | |
|
|
1621 | for (n = 0; n < nfds; ++n) |
|
|
1622 | // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1623 | |
|
|
1624 | if (timeout >= 0) |
|
|
1625 | // create/start timer |
|
|
1626 | |
|
|
1627 | // poll |
|
|
1628 | ev_loop (EV_A_ 0); |
|
|
1629 | |
|
|
1630 | // stop timer again |
|
|
1631 | if (timeout >= 0) |
|
|
1632 | ev_timer_stop (EV_A_ &to); |
|
|
1633 | |
|
|
1634 | // stop io watchers again - their callbacks should have set |
|
|
1635 | for (n = 0; n < nfds; ++n) |
|
|
1636 | ev_io_stop (EV_A_ iow [n]); |
|
|
1637 | |
|
|
1638 | return got_events; |
1478 | } |
1639 | } |
1479 | |
1640 | |
1480 | |
1641 | |
1481 | |
1642 | |
1482 | |
1643 | |
… | |
… | |
1679 | the callback model to a model using method callbacks on objects.</p> |
1840 | the callback model to a model using method callbacks on objects.</p> |
1680 | <p>To use it,</p> |
1841 | <p>To use it,</p> |
1681 | <pre> #include <ev++.h> |
1842 | <pre> #include <ev++.h> |
1682 | |
1843 | |
1683 | </pre> |
1844 | </pre> |
1684 | <p>(it is not installed by default). This automatically includes <cite>ev.h</cite> |
1845 | <p>This automatically includes <cite>ev.h</cite> and puts all of its definitions (many |
1685 | and puts all of its definitions (many of them macros) into the global |
1846 | of them macros) into the global namespace. All C++ specific things are |
1686 | namespace. All C++ specific things are put into the <code>ev</code> namespace.</p> |
1847 | put into the <code>ev</code> namespace. It should support all the same embedding |
1687 | <p>It should support all the same embedding options as <cite>ev.h</cite>, most notably |
1848 | options as <cite>ev.h</cite>, most notably <code>EV_MULTIPLICITY</code>.</p> |
1688 | <code>EV_MULTIPLICITY</code>.</p> |
1849 | <p>Care has been taken to keep the overhead low. The only data member the C++ |
|
|
1850 | classes add (compared to plain C-style watchers) is the event loop pointer |
|
|
1851 | that the watcher is associated with (or no additional members at all if |
|
|
1852 | you disable <code>EV_MULTIPLICITY</code> when embedding libev).</p> |
|
|
1853 | <p>Currently, functions, and static and non-static member functions can be |
|
|
1854 | used as callbacks. Other types should be easy to add as long as they only |
|
|
1855 | need one additional pointer for context. If you need support for other |
|
|
1856 | types of functors please contact the author (preferably after implementing |
|
|
1857 | it).</p> |
1689 | <p>Here is a list of things available in the <code>ev</code> namespace:</p> |
1858 | <p>Here is a list of things available in the <code>ev</code> namespace:</p> |
1690 | <dl> |
1859 | <dl> |
1691 | <dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt> |
1860 | <dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt> |
1692 | <dd> |
1861 | <dd> |
1693 | <p>These are just enum values with the same values as the <code>EV_READ</code> etc. |
1862 | <p>These are just enum values with the same values as the <code>EV_READ</code> etc. |
… | |
… | |
1704 | which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro |
1873 | which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro |
1705 | defines by many implementations.</p> |
1874 | defines by many implementations.</p> |
1706 | <p>All of those classes have these methods:</p> |
1875 | <p>All of those classes have these methods:</p> |
1707 | <p> |
1876 | <p> |
1708 | <dl> |
1877 | <dl> |
1709 | <dt>ev::TYPE::TYPE (object *, object::method *)</dt> |
1878 | <dt>ev::TYPE::TYPE ()</dt> |
1710 | <dt>ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)</dt> |
1879 | <dt>ev::TYPE::TYPE (struct ev_loop *)</dt> |
1711 | <dt>ev::TYPE::~TYPE</dt> |
1880 | <dt>ev::TYPE::~TYPE</dt> |
1712 | <dd> |
1881 | <dd> |
1713 | <p>The constructor takes a pointer to an object and a method pointer to |
1882 | <p>The constructor (optionally) takes an event loop to associate the watcher |
1714 | the event handler callback to call in this class. The constructor calls |
1883 | with. If it is omitted, it will use <code>EV_DEFAULT</code>.</p> |
1715 | <code>ev_init</code> for you, which means you have to call the <code>set</code> method |
1884 | <p>The constructor calls <code>ev_init</code> for you, which means you have to call the |
1716 | before starting it. If you do not specify a loop then the constructor |
1885 | <code>set</code> method before starting it.</p> |
1717 | automatically associates the default loop with this watcher.</p> |
1886 | <p>It will not set a callback, however: You have to call the templated <code>set</code> |
|
|
1887 | method to set a callback before you can start the watcher.</p> |
|
|
1888 | <p>(The reason why you have to use a method is a limitation in C++ which does |
|
|
1889 | not allow explicit template arguments for constructors).</p> |
1718 | <p>The destructor automatically stops the watcher if it is active.</p> |
1890 | <p>The destructor automatically stops the watcher if it is active.</p> |
|
|
1891 | </dd> |
|
|
1892 | <dt>w->set<class, &class::method> (object *)</dt> |
|
|
1893 | <dd> |
|
|
1894 | <p>This method sets the callback method to call. The method has to have a |
|
|
1895 | signature of <code>void (*)(ev_TYPE &, int)</code>, it receives the watcher as |
|
|
1896 | first argument and the <code>revents</code> as second. The object must be given as |
|
|
1897 | parameter and is stored in the <code>data</code> member of the watcher.</p> |
|
|
1898 | <p>This method synthesizes efficient thunking code to call your method from |
|
|
1899 | the C callback that libev requires. If your compiler can inline your |
|
|
1900 | callback (i.e. it is visible to it at the place of the <code>set</code> call and |
|
|
1901 | your compiler is good :), then the method will be fully inlined into the |
|
|
1902 | thunking function, making it as fast as a direct C callback.</p> |
|
|
1903 | <p>Example: simple class declaration and watcher initialisation</p> |
|
|
1904 | <pre> struct myclass |
|
|
1905 | { |
|
|
1906 | void io_cb (ev::io &w, int revents) { } |
|
|
1907 | } |
|
|
1908 | |
|
|
1909 | myclass obj; |
|
|
1910 | ev::io iow; |
|
|
1911 | iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
1912 | |
|
|
1913 | </pre> |
|
|
1914 | </dd> |
|
|
1915 | <dt>w->set<function> (void *data = 0)</dt> |
|
|
1916 | <dd> |
|
|
1917 | <p>Also sets a callback, but uses a static method or plain function as |
|
|
1918 | callback. The optional <code>data</code> argument will be stored in the watcher's |
|
|
1919 | <code>data</code> member and is free for you to use.</p> |
|
|
1920 | <p>The prototype of the <code>function</code> must be <code>void (*)(ev::TYPE &w, int)</code>.</p> |
|
|
1921 | <p>See the method-<code>set</code> above for more details.</p> |
|
|
1922 | <p>Example:</p> |
|
|
1923 | <pre> static void io_cb (ev::io &w, int revents) { } |
|
|
1924 | iow.set <io_cb> (); |
|
|
1925 | |
|
|
1926 | </pre> |
1719 | </dd> |
1927 | </dd> |
1720 | <dt>w->set (struct ev_loop *)</dt> |
1928 | <dt>w->set (struct ev_loop *)</dt> |
1721 | <dd> |
1929 | <dd> |
1722 | <p>Associates a different <code>struct ev_loop</code> with this watcher. You can only |
1930 | <p>Associates a different <code>struct ev_loop</code> with this watcher. You can only |
1723 | do this when the watcher is inactive (and not pending either).</p> |
1931 | do this when the watcher is inactive (and not pending either).</p> |
1724 | </dd> |
1932 | </dd> |
1725 | <dt>w->set ([args])</dt> |
1933 | <dt>w->set ([args])</dt> |
1726 | <dd> |
1934 | <dd> |
1727 | <p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be |
1935 | <p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be |
1728 | called at least once. Unlike the C counterpart, an active watcher gets |
1936 | called at least once. Unlike the C counterpart, an active watcher gets |
1729 | automatically stopped and restarted.</p> |
1937 | automatically stopped and restarted when reconfiguring it with this |
|
|
1938 | method.</p> |
1730 | </dd> |
1939 | </dd> |
1731 | <dt>w->start ()</dt> |
1940 | <dt>w->start ()</dt> |
1732 | <dd> |
1941 | <dd> |
1733 | <p>Starts the watcher. Note that there is no <code>loop</code> argument as the |
1942 | <p>Starts the watcher. Note that there is no <code>loop</code> argument, as the |
1734 | constructor already takes the loop.</p> |
1943 | constructor already stores the event loop.</p> |
1735 | </dd> |
1944 | </dd> |
1736 | <dt>w->stop ()</dt> |
1945 | <dt>w->stop ()</dt> |
1737 | <dd> |
1946 | <dd> |
1738 | <p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p> |
1947 | <p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p> |
1739 | </dd> |
1948 | </dd> |
… | |
… | |
1763 | |
1972 | |
1764 | myclass (); |
1973 | myclass (); |
1765 | } |
1974 | } |
1766 | |
1975 | |
1767 | myclass::myclass (int fd) |
1976 | myclass::myclass (int fd) |
1768 | : io (this, &myclass::io_cb), |
|
|
1769 | idle (this, &myclass::idle_cb) |
|
|
1770 | { |
1977 | { |
|
|
1978 | io .set <myclass, &myclass::io_cb > (this); |
|
|
1979 | idle.set <myclass, &myclass::idle_cb> (this); |
|
|
1980 | |
1771 | io.start (fd, ev::READ); |
1981 | io.start (fd, ev::READ); |
1772 | } |
1982 | } |
1773 | |
1983 | |
1774 | |
1984 | |
1775 | |
1985 | |
… | |
… | |
1778 | |
1988 | |
1779 | </div> |
1989 | </div> |
1780 | <h1 id="MACRO_MAGIC">MACRO MAGIC</h1> |
1990 | <h1 id="MACRO_MAGIC">MACRO MAGIC</h1> |
1781 | <div id="MACRO_MAGIC_CONTENT"> |
1991 | <div id="MACRO_MAGIC_CONTENT"> |
1782 | <p>Libev can be compiled with a variety of options, the most fundemantal is |
1992 | <p>Libev can be compiled with a variety of options, the most fundemantal is |
1783 | <code>EV_MULTIPLICITY</code>. This option determines wether (most) functions and |
1993 | <code>EV_MULTIPLICITY</code>. This option determines whether (most) functions and |
1784 | callbacks have an initial <code>struct ev_loop *</code> argument.</p> |
1994 | callbacks have an initial <code>struct ev_loop *</code> argument.</p> |
1785 | <p>To make it easier to write programs that cope with either variant, the |
1995 | <p>To make it easier to write programs that cope with either variant, the |
1786 | following macros are defined:</p> |
1996 | following macros are defined:</p> |
1787 | <dl> |
1997 | <dl> |
1788 | <dt><code>EV_A</code>, <code>EV_A_</code></dt> |
1998 | <dt><code>EV_A</code>, <code>EV_A_</code></dt> |
… | |
… | |
1817 | <dd> |
2027 | <dd> |
1818 | <p>Similar to the other two macros, this gives you the value of the default |
2028 | <p>Similar to the other two macros, this gives you the value of the default |
1819 | loop, if multiple loops are supported ("ev loop default").</p> |
2029 | loop, if multiple loops are supported ("ev loop default").</p> |
1820 | </dd> |
2030 | </dd> |
1821 | </dl> |
2031 | </dl> |
1822 | <p>Example: Declare and initialise a check watcher, working regardless of |
2032 | <p>Example: Declare and initialise a check watcher, utilising the above |
1823 | wether multiple loops are supported or not.</p> |
2033 | macros so it will work regardless of whether multiple loops are supported |
|
|
2034 | or not.</p> |
1824 | <pre> static void |
2035 | <pre> static void |
1825 | check_cb (EV_P_ ev_timer *w, int revents) |
2036 | check_cb (EV_P_ ev_timer *w, int revents) |
1826 | { |
2037 | { |
1827 | ev_check_stop (EV_A_ w); |
2038 | ev_check_stop (EV_A_ w); |
1828 | } |
2039 | } |
1829 | |
2040 | |
1830 | ev_check check; |
2041 | ev_check check; |
1831 | ev_check_init (&check, check_cb); |
2042 | ev_check_init (&check, check_cb); |
1832 | ev_check_start (EV_DEFAULT_ &check); |
2043 | ev_check_start (EV_DEFAULT_ &check); |
1833 | ev_loop (EV_DEFAULT_ 0); |
2044 | ev_loop (EV_DEFAULT_ 0); |
1834 | |
|
|
1835 | |
|
|
1836 | |
|
|
1837 | |
2045 | |
1838 | </pre> |
2046 | </pre> |
1839 | |
2047 | |
1840 | </div> |
2048 | </div> |
1841 | <h1 id="EMBEDDING">EMBEDDING</h1> |
2049 | <h1 id="EMBEDDING">EMBEDDING</h1> |
… | |
… | |
1883 | ev_vars.h |
2091 | ev_vars.h |
1884 | ev_wrap.h |
2092 | ev_wrap.h |
1885 | |
2093 | |
1886 | ev_win32.c required on win32 platforms only |
2094 | ev_win32.c required on win32 platforms only |
1887 | |
2095 | |
1888 | ev_select.c only when select backend is enabled (which is by default) |
2096 | ev_select.c only when select backend is enabled (which is enabled by default) |
1889 | ev_poll.c only when poll backend is enabled (disabled by default) |
2097 | ev_poll.c only when poll backend is enabled (disabled by default) |
1890 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2098 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1891 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2099 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1892 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
2100 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
1893 | |
2101 | |
… | |
… | |
2058 | will have the <code>struct ev_loop *</code> as first argument, and you can create |
2266 | will have the <code>struct ev_loop *</code> as first argument, and you can create |
2059 | additional independent event loops. Otherwise there will be no support |
2267 | additional independent event loops. Otherwise there will be no support |
2060 | for multiple event loops and there is no first event loop pointer |
2268 | for multiple event loops and there is no first event loop pointer |
2061 | argument. Instead, all functions act on the single default loop.</p> |
2269 | argument. Instead, all functions act on the single default loop.</p> |
2062 | </dd> |
2270 | </dd> |
|
|
2271 | <dt>EV_MINPRI</dt> |
|
|
2272 | <dt>EV_MAXPRI</dt> |
|
|
2273 | <dd> |
|
|
2274 | <p>The range of allowed priorities. <code>EV_MINPRI</code> must be smaller or equal to |
|
|
2275 | <code>EV_MAXPRI</code>, but otherwise there are no non-obvious limitations. You can |
|
|
2276 | provide for more priorities by overriding those symbols (usually defined |
|
|
2277 | to be <code>-2</code> and <code>2</code>, respectively).</p> |
|
|
2278 | <p>When doing priority-based operations, libev usually has to linearly search |
|
|
2279 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2280 | and time, so using the defaults of five priorities (-2 .. +2) is usually |
|
|
2281 | fine.</p> |
|
|
2282 | <p>If your embedding app does not need any priorities, defining these both to |
|
|
2283 | <code>0</code> will save some memory and cpu.</p> |
|
|
2284 | </dd> |
2063 | <dt>EV_PERIODIC_ENABLE</dt> |
2285 | <dt>EV_PERIODIC_ENABLE</dt> |
2064 | <dd> |
2286 | <dd> |
2065 | <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If |
2287 | <p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If |
|
|
2288 | defined to be <code>0</code>, then they are not. Disabling them saves a few kB of |
|
|
2289 | code.</p> |
|
|
2290 | </dd> |
|
|
2291 | <dt>EV_IDLE_ENABLE</dt> |
|
|
2292 | <dd> |
|
|
2293 | <p>If undefined or defined to be <code>1</code>, then idle watchers are supported. If |
2066 | defined to be <code>0</code>, then they are not. Disabling them saves a few kB of |
2294 | defined to be <code>0</code>, then they are not. Disabling them saves a few kB of |
2067 | code.</p> |
2295 | code.</p> |
2068 | </dd> |
2296 | </dd> |
2069 | <dt>EV_EMBED_ENABLE</dt> |
2297 | <dt>EV_EMBED_ENABLE</dt> |
2070 | <dd> |
2298 | <dd> |
… | |
… | |
2135 | the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public |
2363 | the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public |
2136 | interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file |
2364 | interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file |
2137 | will be compiled. It is pretty complex because it provides its own header |
2365 | will be compiled. It is pretty complex because it provides its own header |
2138 | file.</p> |
2366 | file.</p> |
2139 | <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file |
2367 | <p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file |
2140 | that everybody includes and which overrides some autoconf choices:</p> |
2368 | that everybody includes and which overrides some configure choices:</p> |
|
|
2369 | <pre> #define EV_MINIMAL 1 |
2141 | <pre> #define EV_USE_POLL 0 |
2370 | #define EV_USE_POLL 0 |
2142 | #define EV_MULTIPLICITY 0 |
2371 | #define EV_MULTIPLICITY 0 |
2143 | #define EV_PERIODICS 0 |
2372 | #define EV_PERIODIC_ENABLE 0 |
|
|
2373 | #define EV_STAT_ENABLE 0 |
|
|
2374 | #define EV_FORK_ENABLE 0 |
2144 | #define EV_CONFIG_H <config.h> |
2375 | #define EV_CONFIG_H <config.h> |
|
|
2376 | #define EV_MINPRI 0 |
|
|
2377 | #define EV_MAXPRI 0 |
2145 | |
2378 | |
2146 | #include "ev++.h" |
2379 | #include "ev++.h" |
2147 | |
2380 | |
2148 | </pre> |
2381 | </pre> |
2149 | <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> |
2382 | <p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p> |
… | |
… | |
2159 | <h1 id="COMPLEXITIES">COMPLEXITIES</h1> |
2392 | <h1 id="COMPLEXITIES">COMPLEXITIES</h1> |
2160 | <div id="COMPLEXITIES_CONTENT"> |
2393 | <div id="COMPLEXITIES_CONTENT"> |
2161 | <p>In this section the complexities of (many of) the algorithms used inside |
2394 | <p>In this section the complexities of (many of) the algorithms used inside |
2162 | libev will be explained. For complexity discussions about backends see the |
2395 | libev will be explained. For complexity discussions about backends see the |
2163 | documentation for <code>ev_default_init</code>.</p> |
2396 | documentation for <code>ev_default_init</code>.</p> |
|
|
2397 | <p>All of the following are about amortised time: If an array needs to be |
|
|
2398 | extended, libev needs to realloc and move the whole array, but this |
|
|
2399 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2400 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2401 | it is much faster and asymptotically approaches constant time.</p> |
2164 | <p> |
2402 | <p> |
2165 | <dl> |
2403 | <dl> |
2166 | <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> |
2404 | <dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt> |
|
|
2405 | <dd> |
|
|
2406 | <p>This means that, when you have a watcher that triggers in one hour and |
|
|
2407 | there are 100 watchers that would trigger before that then inserting will |
|
|
2408 | have to skip those 100 watchers.</p> |
|
|
2409 | </dd> |
2167 | <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> |
2410 | <dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt> |
|
|
2411 | <dd> |
|
|
2412 | <p>That means that for changing a timer costs less than removing/adding them |
|
|
2413 | as only the relative motion in the event queue has to be paid for.</p> |
|
|
2414 | </dd> |
2168 | <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> |
2415 | <dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt> |
|
|
2416 | <dd> |
|
|
2417 | <p>These just add the watcher into an array or at the head of a list. |
2169 | <dt>Stopping check/prepare/idle watchers: O(1)</dt> |
2418 | =item Stopping check/prepare/idle watchers: O(1)</p> |
|
|
2419 | </dd> |
2170 | <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt> |
2420 | <dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt> |
|
|
2421 | <dd> |
|
|
2422 | <p>These watchers are stored in lists then need to be walked to find the |
|
|
2423 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2424 | have many watchers waiting for the same fd or signal).</p> |
|
|
2425 | </dd> |
2171 | <dt>Finding the next timer per loop iteration: O(1)</dt> |
2426 | <dt>Finding the next timer per loop iteration: O(1)</dt> |
2172 | <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> |
2427 | <dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt> |
|
|
2428 | <dd> |
|
|
2429 | <p>A change means an I/O watcher gets started or stopped, which requires |
|
|
2430 | libev to recalculate its status (and possibly tell the kernel).</p> |
|
|
2431 | </dd> |
2173 | <dt>Activating one watcher: O(1)</dt> |
2432 | <dt>Activating one watcher: O(1)</dt> |
|
|
2433 | <dt>Priority handling: O(number_of_priorities)</dt> |
|
|
2434 | <dd> |
|
|
2435 | <p>Priorities are implemented by allocating some space for each |
|
|
2436 | priority. When doing priority-based operations, libev usually has to |
|
|
2437 | linearly search all the priorities.</p> |
|
|
2438 | </dd> |
2174 | </dl> |
2439 | </dl> |
2175 | </p> |
2440 | </p> |
2176 | |
2441 | |
2177 | |
2442 | |
2178 | |
2443 | |