… | |
… | |
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="Mon Nov 12 09:57:02 2007" /> |
9 | <meta name="created" content="Fri Nov 23 09:26:40 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 --> |
… | |
… | |
35 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li> |
35 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li> |
36 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li> |
36 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li> |
37 | </ul> |
37 | </ul> |
38 | </li> |
38 | </li> |
39 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
39 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
|
|
40 | <li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> |
|
|
41 | <li><a href="#C_SUPPORT">C++ SUPPORT</a></li> |
40 | <li><a href="#AUTHOR">AUTHOR</a> |
42 | <li><a href="#AUTHOR">AUTHOR</a> |
41 | </li> |
43 | </li> |
42 | </ul><hr /> |
44 | </ul><hr /> |
43 | <!-- INDEX END --> |
45 | <!-- INDEX END --> |
44 | |
46 | |
… | |
… | |
99 | to the double type in C.</p> |
101 | to the double type in C.</p> |
100 | |
102 | |
101 | </div> |
103 | </div> |
102 | <h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
104 | <h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
103 | <div id="GLOBAL_FUNCTIONS_CONTENT"> |
105 | <div id="GLOBAL_FUNCTIONS_CONTENT"> |
|
|
106 | <p>These functions can be called anytime, even before initialising the |
|
|
107 | library in any way.</p> |
104 | <dl> |
108 | <dl> |
105 | <dt>ev_tstamp ev_time ()</dt> |
109 | <dt>ev_tstamp ev_time ()</dt> |
106 | <dd> |
110 | <dd> |
107 | <p>Returns the current time as libev would use it.</p> |
111 | <p>Returns the current time as libev would use it. Please note that the |
|
|
112 | <code>ev_now</code> function is usually faster and also often returns the timestamp |
|
|
113 | you actually want to know.</p> |
108 | </dd> |
114 | </dd> |
109 | <dt>int ev_version_major ()</dt> |
115 | <dt>int ev_version_major ()</dt> |
110 | <dt>int ev_version_minor ()</dt> |
116 | <dt>int ev_version_minor ()</dt> |
111 | <dd> |
117 | <dd> |
112 | <p>You can find out the major and minor version numbers of the library |
118 | <p>You can find out the major and minor version numbers of the library |
… | |
… | |
116 | version of the library your program was compiled against.</p> |
122 | version of the library your program was compiled against.</p> |
117 | <p>Usually, it's a good idea to terminate if the major versions mismatch, |
123 | <p>Usually, it's a good idea to terminate if the major versions mismatch, |
118 | as this indicates an incompatible change. Minor versions are usually |
124 | as this indicates an incompatible change. Minor versions are usually |
119 | compatible to older versions, so a larger minor version alone is usually |
125 | compatible to older versions, so a larger minor version alone is usually |
120 | not a problem.</p> |
126 | not a problem.</p> |
|
|
127 | </dd> |
|
|
128 | <dt>unsigned int ev_supported_backends ()</dt> |
|
|
129 | <dd> |
|
|
130 | <p>Return the set of all backends (i.e. their corresponding <code>EV_BACKEND_*</code> |
|
|
131 | value) compiled into this binary of libev (independent of their |
|
|
132 | availability on the system you are running on). See <code>ev_default_loop</code> for |
|
|
133 | a description of the set values.</p> |
|
|
134 | </dd> |
|
|
135 | <dt>unsigned int ev_recommended_backends ()</dt> |
|
|
136 | <dd> |
|
|
137 | <p>Return the set of all backends compiled into this binary of libev and also |
|
|
138 | recommended for this platform. This set is often smaller than the one |
|
|
139 | returned by <code>ev_supported_backends</code>, as for example kqueue is broken on |
|
|
140 | most BSDs and will not be autodetected unless you explicitly request it |
|
|
141 | (assuming you know what you are doing). This is the set of backends that |
|
|
142 | <code>EVFLAG_AUTO</code> will probe for.</p> |
121 | </dd> |
143 | </dd> |
122 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
144 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
123 | <dd> |
145 | <dd> |
124 | <p>Sets the allocation function to use (the prototype is similar to the |
146 | <p>Sets the allocation function to use (the prototype is similar to the |
125 | realloc C function, the semantics are identical). It is used to allocate |
147 | realloc C function, the semantics are identical). It is used to allocate |
… | |
… | |
158 | <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
180 | <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
159 | <dd> |
181 | <dd> |
160 | <p>This will initialise the default event loop if it hasn't been initialised |
182 | <p>This will initialise the default event loop if it hasn't been initialised |
161 | yet and return it. If the default loop could not be initialised, returns |
183 | yet and return it. If the default loop could not be initialised, returns |
162 | false. If it already was initialised it simply returns it (and ignores the |
184 | false. If it already was initialised it simply returns it (and ignores the |
163 | flags).</p> |
185 | flags. If that is troubling you, check <code>ev_backend ()</code> afterwards).</p> |
164 | <p>If you don't know what event loop to use, use the one returned from this |
186 | <p>If you don't know what event loop to use, use the one returned from this |
165 | function.</p> |
187 | function.</p> |
166 | <p>The flags argument can be used to specify special behaviour or specific |
188 | <p>The flags argument can be used to specify special behaviour or specific |
167 | backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p> |
189 | backends to use, and is usually specified as <code>0</code> (or EVFLAG_AUTO).</p> |
168 | <p>It supports the following flags:</p> |
190 | <p>It supports the following flags:</p> |
169 | <p> |
191 | <p> |
170 | <dl> |
192 | <dl> |
171 | <dt><code>EVFLAG_AUTO</code></dt> |
193 | <dt><code>EVFLAG_AUTO</code></dt> |
172 | <dd> |
194 | <dd> |
… | |
… | |
180 | <code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
202 | <code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
181 | override the flags completely if it is found in the environment. This is |
203 | override the flags completely if it is found in the environment. This is |
182 | useful to try out specific backends to test their performance, or to work |
204 | useful to try out specific backends to test their performance, or to work |
183 | around bugs.</p> |
205 | around bugs.</p> |
184 | </dd> |
206 | </dd> |
185 | <dt><code>EVMETHOD_SELECT</code> (portable select backend)</dt> |
207 | <dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt> |
186 | <dt><code>EVMETHOD_POLL</code> (poll backend, available everywhere except on windows)</dt> |
208 | <dd> |
187 | <dt><code>EVMETHOD_EPOLL</code> (linux only)</dt> |
209 | <p>This is your standard select(2) backend. Not <i>completely</i> standard, as |
188 | <dt><code>EVMETHOD_KQUEUE</code> (some bsds only)</dt> |
210 | libev tries to roll its own fd_set with no limits on the number of fds, |
189 | <dt><code>EVMETHOD_DEVPOLL</code> (solaris 8 only)</dt> |
211 | but if that fails, expect a fairly low limit on the number of fds when |
190 | <dt><code>EVMETHOD_PORT</code> (solaris 10 only)</dt> |
212 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
|
|
213 | the fastest backend for a low number of fds.</p> |
191 | <dd> |
214 | </dd> |
192 | <p>If one or more of these are ored into the flags value, then only these |
215 | <dt><code>EVBACKEND_POLL</code> (value 2, poll backend, available everywhere except on windows)</dt> |
193 | backends will be tried (in the reverse order as given here). If one are |
216 | <dd> |
194 | specified, any backend will do.</p> |
217 | <p>And this is your standard poll(2) backend. It's more complicated than |
|
|
218 | select, but handles sparse fds better and has no artificial limit on the |
|
|
219 | number of fds you can use (except it will slow down considerably with a |
|
|
220 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds).</p> |
|
|
221 | </dd> |
|
|
222 | <dt><code>EVBACKEND_EPOLL</code> (value 4, Linux)</dt> |
|
|
223 | <dd> |
|
|
224 | <p>For few fds, this backend is a bit little slower than poll and select, |
|
|
225 | but it scales phenomenally better. While poll and select usually scale like |
|
|
226 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
|
|
227 | either O(1) or O(active_fds).</p> |
|
|
228 | <p>While stopping and starting an I/O watcher in the same iteration will |
|
|
229 | result in some caching, there is still a syscall per such incident |
|
|
230 | (because the fd could point to a different file description now), so its |
|
|
231 | best to avoid that. Also, dup()ed file descriptors might not work very |
|
|
232 | well if you register events for both fds.</p> |
|
|
233 | <p>Please note that epoll sometimes generates spurious notifications, so you |
|
|
234 | need to use non-blocking I/O or other means to avoid blocking when no data |
|
|
235 | (or space) is available.</p> |
|
|
236 | </dd> |
|
|
237 | <dt><code>EVBACKEND_KQUEUE</code> (value 8, most BSD clones)</dt> |
|
|
238 | <dd> |
|
|
239 | <p>Kqueue deserves special mention, as at the time of this writing, it |
|
|
240 | was broken on all BSDs except NetBSD (usually it doesn't work with |
|
|
241 | anything but sockets and pipes, except on Darwin, where of course its |
|
|
242 | completely useless). For this reason its not being "autodetected" unless |
|
|
243 | you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO).</p> |
|
|
244 | <p>It scales in the same way as the epoll backend, but the interface to the |
|
|
245 | kernel is more efficient (which says nothing about its actual speed, of |
|
|
246 | course). While starting and stopping an I/O watcher does not cause an |
|
|
247 | extra syscall as with epoll, it still adds up to four event changes per |
|
|
248 | incident, so its best to avoid that.</p> |
|
|
249 | </dd> |
|
|
250 | <dt><code>EVBACKEND_DEVPOLL</code> (value 16, Solaris 8)</dt> |
|
|
251 | <dd> |
|
|
252 | <p>This is not implemented yet (and might never be).</p> |
|
|
253 | </dd> |
|
|
254 | <dt><code>EVBACKEND_PORT</code> (value 32, Solaris 10)</dt> |
|
|
255 | <dd> |
|
|
256 | <p>This uses the Solaris 10 port mechanism. As with everything on Solaris, |
|
|
257 | it's really slow, but it still scales very well (O(active_fds)).</p> |
|
|
258 | <p>Please note that solaris ports can result in a lot of spurious |
|
|
259 | notifications, so you need to use non-blocking I/O or other means to avoid |
|
|
260 | blocking when no data (or space) is available.</p> |
|
|
261 | </dd> |
|
|
262 | <dt><code>EVBACKEND_ALL</code></dt> |
|
|
263 | <dd> |
|
|
264 | <p>Try all backends (even potentially broken ones that wouldn't be tried |
|
|
265 | with <code>EVFLAG_AUTO</code>). Since this is a mask, you can do stuff such as |
|
|
266 | <code>EVBACKEND_ALL & ~EVBACKEND_KQUEUE</code>.</p> |
195 | </dd> |
267 | </dd> |
196 | </dl> |
268 | </dl> |
197 | </p> |
269 | </p> |
|
|
270 | <p>If one or more of these are ored into the flags value, then only these |
|
|
271 | backends will be tried (in the reverse order as given here). If none are |
|
|
272 | specified, most compiled-in backend will be tried, usually in reverse |
|
|
273 | order of their flag values :)</p> |
198 | </dd> |
274 | </dd> |
199 | <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> |
275 | <dt>struct ev_loop *ev_loop_new (unsigned int flags)</dt> |
200 | <dd> |
276 | <dd> |
201 | <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is |
277 | <p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is |
202 | always distinct from the default loop. Unlike the default loop, it cannot |
278 | always distinct from the default loop. Unlike the default loop, it cannot |
… | |
… | |
218 | <dd> |
294 | <dd> |
219 | <p>This function reinitialises the kernel state for backends that have |
295 | <p>This function reinitialises the kernel state for backends that have |
220 | one. Despite the name, you can call it anytime, but it makes most sense |
296 | one. Despite the name, you can call it anytime, but it makes most sense |
221 | after forking, in either the parent or child process (or both, but that |
297 | after forking, in either the parent or child process (or both, but that |
222 | again makes little sense).</p> |
298 | again makes little sense).</p> |
223 | <p>You <i>must</i> call this function after forking if and only if you want to |
299 | <p>You <i>must</i> call this function in the child process after forking if and |
224 | use the event library in both processes. If you just fork+exec, you don't |
300 | only if you want to use the event library in both processes. If you just |
225 | have to call it.</p> |
301 | fork+exec, you don't have to call it.</p> |
226 | <p>The function itself is quite fast and it's usually not a problem to call |
302 | <p>The function itself is quite fast and it's usually not a problem to call |
227 | it just in case after a fork. To make this easy, the function will fit in |
303 | it just in case after a fork. To make this easy, the function will fit in |
228 | quite nicely into a call to <code>pthread_atfork</code>:</p> |
304 | quite nicely into a call to <code>pthread_atfork</code>:</p> |
229 | <pre> pthread_atfork (0, 0, ev_default_fork); |
305 | <pre> pthread_atfork (0, 0, ev_default_fork); |
230 | |
306 | |
231 | </pre> |
307 | </pre> |
|
|
308 | <p>At the moment, <code>EVBACKEND_SELECT</code> and <code>EVBACKEND_POLL</code> are safe to use |
|
|
309 | without calling this function, so if you force one of those backends you |
|
|
310 | do not need to care.</p> |
232 | </dd> |
311 | </dd> |
233 | <dt>ev_loop_fork (loop)</dt> |
312 | <dt>ev_loop_fork (loop)</dt> |
234 | <dd> |
313 | <dd> |
235 | <p>Like <code>ev_default_fork</code>, but acts on an event loop created by |
314 | <p>Like <code>ev_default_fork</code>, but acts on an event loop created by |
236 | <code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop |
315 | <code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop |
237 | after fork, and how you do this is entirely your own problem.</p> |
316 | after fork, and how you do this is entirely your own problem.</p> |
238 | </dd> |
317 | </dd> |
239 | <dt>unsigned int ev_method (loop)</dt> |
318 | <dt>unsigned int ev_backend (loop)</dt> |
240 | <dd> |
319 | <dd> |
241 | <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in |
320 | <p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in |
242 | use.</p> |
321 | use.</p> |
243 | </dd> |
322 | </dd> |
244 | <dt>ev_tstamp ev_now (loop)</dt> |
323 | <dt>ev_tstamp ev_now (loop)</dt> |
245 | <dd> |
324 | <dd> |
246 | <p>Returns the current "event loop time", which is the time the event loop |
325 | <p>Returns the current "event loop time", which is the time the event loop |
… | |
… | |
264 | your process until at least one new event arrives, and will return after |
343 | your process until at least one new event arrives, and will return after |
265 | one iteration of the loop.</p> |
344 | one iteration of the loop.</p> |
266 | <p>This flags value could be used to implement alternative looping |
345 | <p>This flags value could be used to implement alternative looping |
267 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
346 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
268 | more generic mechanism.</p> |
347 | more generic mechanism.</p> |
|
|
348 | <p>Here are the gory details of what ev_loop does:</p> |
|
|
349 | <pre> 1. If there are no active watchers (reference count is zero), return. |
|
|
350 | 2. Queue and immediately call all prepare watchers. |
|
|
351 | 3. If we have been forked, recreate the kernel state. |
|
|
352 | 4. Update the kernel state with all outstanding changes. |
|
|
353 | 5. Update the "event loop time". |
|
|
354 | 6. Calculate for how long to block. |
|
|
355 | 7. Block the process, waiting for events. |
|
|
356 | 8. Update the "event loop time" and do time jump handling. |
|
|
357 | 9. Queue all outstanding timers. |
|
|
358 | 10. Queue all outstanding periodics. |
|
|
359 | 11. If no events are pending now, queue all idle watchers. |
|
|
360 | 12. Queue all check watchers. |
|
|
361 | 13. Call all queued watchers in reverse order (i.e. check watchers first). |
|
|
362 | 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
|
|
363 | was used, return, otherwise continue with step #1. |
|
|
364 | |
|
|
365 | </pre> |
269 | </dd> |
366 | </dd> |
270 | <dt>ev_unloop (loop, how)</dt> |
367 | <dt>ev_unloop (loop, how)</dt> |
271 | <dd> |
368 | <dd> |
272 | <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
369 | <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
273 | has processed all outstanding events). The <code>how</code> argument must be either |
370 | has processed all outstanding events). The <code>how</code> argument must be either |
274 | <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or |
371 | <code>EVUNLOOP_ONE</code>, which will make the innermost <code>ev_loop</code> call return, or |
275 | <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
372 | <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
276 | </dd> |
373 | </dd> |
277 | <dt>ev_ref (loop)</dt> |
374 | <dt>ev_ref (loop)</dt> |
278 | <dt>ev_unref (loop)</dt> |
375 | <dt>ev_unref (loop)</dt> |
279 | <dd> |
376 | <dd> |
… | |
… | |
326 | with a watcher-specific start function (<code>ev_<type>_start (loop, watcher |
423 | with a watcher-specific start function (<code>ev_<type>_start (loop, watcher |
327 | *)</code>), and you can stop watching for events at any time by calling the |
424 | *)</code>), and you can stop watching for events at any time by calling the |
328 | corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p> |
425 | corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p> |
329 | <p>As long as your watcher is active (has been started but not stopped) you |
426 | <p>As long as your watcher is active (has been started but not stopped) you |
330 | must not touch the values stored in it. Most specifically you must never |
427 | must not touch the values stored in it. Most specifically you must never |
331 | reinitialise it or call its set method.</p> |
428 | reinitialise it or call its set macro.</p> |
332 | <p>You can check whether an event is active by calling the <code>ev_is_active |
429 | <p>You can check whether an event is active by calling the <code>ev_is_active |
333 | (watcher *)</code> macro. To see whether an event is outstanding (but the |
430 | (watcher *)</code> macro. To see whether an event is outstanding (but the |
334 | callback for it has not been called yet) you can use the <code>ev_is_pending |
431 | callback for it has not been called yet) you can use the <code>ev_is_pending |
335 | (watcher *)</code> macro.</p> |
432 | (watcher *)</code> macro.</p> |
336 | <p>Each and every callback receives the event loop pointer as first, the |
433 | <p>Each and every callback receives the event loop pointer as first, the |
… | |
… | |
438 | <p>I/O watchers check whether a file descriptor is readable or writable |
535 | <p>I/O watchers check whether a file descriptor is readable or writable |
439 | in each iteration of the event loop (This behaviour is called |
536 | in each iteration of the event loop (This behaviour is called |
440 | level-triggering because you keep receiving events as long as the |
537 | level-triggering because you keep receiving events as long as the |
441 | condition persists. Remember you can stop the watcher if you don't want to |
538 | condition persists. Remember you can stop the watcher if you don't want to |
442 | act on the event and neither want to receive future events).</p> |
539 | act on the event and neither want to receive future events).</p> |
443 | <p>In general you can register as many read and/or write event watchers oer |
540 | <p>In general you can register as many read and/or write event watchers per |
444 | fd as you want (as long as you don't confuse yourself). Setting all file |
541 | fd as you want (as long as you don't confuse yourself). Setting all file |
445 | descriptors to non-blocking mode is also usually a good idea (but not |
542 | descriptors to non-blocking mode is also usually a good idea (but not |
446 | required if you know what you are doing).</p> |
543 | required if you know what you are doing).</p> |
447 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
544 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
448 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
545 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
449 | descriptors correctly if you register interest in two or more fds pointing |
546 | descriptors correctly if you register interest in two or more fds pointing |
450 | to the same file/socket etc. description.</p> |
547 | to the same underlying file/socket etc. description (that is, they share |
|
|
548 | the same underlying "file open").</p> |
451 | <p>If you must do this, then force the use of a known-to-be-good backend |
549 | <p>If you must do this, then force the use of a known-to-be-good backend |
452 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
550 | (at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and |
453 | EVMETHOD_POLL).</p> |
551 | <code>EVBACKEND_POLL</code>).</p> |
454 | <dl> |
552 | <dl> |
455 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
553 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
456 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
554 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
457 | <dd> |
555 | <dd> |
458 | <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive |
556 | <p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive |
459 | events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | |
557 | events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ | |
460 | EV_WRITE</code> to receive the given events.</p> |
558 | EV_WRITE</code> to receive the given events.</p> |
|
|
559 | <p>Please note that most of the more scalable backend mechanisms (for example |
|
|
560 | epoll and solaris ports) can result in spurious readyness notifications |
|
|
561 | for file descriptors, so you practically need to use non-blocking I/O (and |
|
|
562 | treat callback invocation as hint only), or retest separately with a safe |
|
|
563 | interface before doing I/O (XLib can do this), or force the use of either |
|
|
564 | <code>EVBACKEND_SELECT</code> or <code>EVBACKEND_POLL</code>, which don't suffer from this |
|
|
565 | problem. Also note that it is quite easy to have your callback invoked |
|
|
566 | when the readyness condition is no longer valid even when employing |
|
|
567 | typical ways of handling events, so its a good idea to use non-blocking |
|
|
568 | I/O unconditionally.</p> |
461 | </dd> |
569 | </dd> |
462 | </dl> |
570 | </dl> |
463 | |
571 | |
464 | </div> |
572 | </div> |
465 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
573 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
466 | <div id="code_ev_timer_code_relative_and_opti-2"> |
574 | <div id="code_ev_timer_code_relative_and_opti-2"> |
467 | <p>Timer watchers are simple relative timers that generate an event after a |
575 | <p>Timer watchers are simple relative timers that generate an event after a |
468 | given time, and optionally repeating in regular intervals after that.</p> |
576 | given time, and optionally repeating in regular intervals after that.</p> |
469 | <p>The timers are based on real time, that is, if you register an event that |
577 | <p>The timers are based on real time, that is, if you register an event that |
470 | times out after an hour and youreset your system clock to last years |
578 | times out after an hour and you reset your system clock to last years |
471 | time, it will still time out after (roughly) and hour. "Roughly" because |
579 | time, it will still time out after (roughly) and hour. "Roughly" because |
472 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
580 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
473 | monotonic clock option helps a lot here).</p> |
581 | monotonic clock option helps a lot here).</p> |
474 | <p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
582 | <p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
475 | time. This is usually the right thing as this timestamp refers to the time |
583 | time. This is usually the right thing as this timestamp refers to the time |
476 | of the event triggering whatever timeout you are modifying/starting. If |
584 | of the event triggering whatever timeout you are modifying/starting. If |
477 | you suspect event processing to be delayed and you *need* to base the timeout |
585 | you suspect event processing to be delayed and you <i>need</i> to base the timeout |
478 | ion the current time, use something like this to adjust for this:</p> |
586 | on the current time, use something like this to adjust for this:</p> |
479 | <pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
587 | <pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
480 | |
588 | |
481 | </pre> |
589 | </pre> |
|
|
590 | <p>The callback is guarenteed to be invoked only when its timeout has passed, |
|
|
591 | but if multiple timers become ready during the same loop iteration then |
|
|
592 | order of execution is undefined.</p> |
482 | <dl> |
593 | <dl> |
483 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
594 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
484 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
595 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
485 | <dd> |
596 | <dd> |
486 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
597 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
… | |
… | |
488 | timer will automatically be configured to trigger again <code>repeat</code> seconds |
599 | timer will automatically be configured to trigger again <code>repeat</code> seconds |
489 | later, again, and again, until stopped manually.</p> |
600 | later, again, and again, until stopped manually.</p> |
490 | <p>The timer itself will do a best-effort at avoiding drift, that is, if you |
601 | <p>The timer itself will do a best-effort at avoiding drift, that is, if you |
491 | configure a timer to trigger every 10 seconds, then it will trigger at |
602 | configure a timer to trigger every 10 seconds, then it will trigger at |
492 | exactly 10 second intervals. If, however, your program cannot keep up with |
603 | exactly 10 second intervals. If, however, your program cannot keep up with |
493 | the timer (ecause it takes longer than those 10 seconds to do stuff) the |
604 | the timer (because it takes longer than those 10 seconds to do stuff) the |
494 | timer will not fire more than once per event loop iteration.</p> |
605 | timer will not fire more than once per event loop iteration.</p> |
495 | </dd> |
606 | </dd> |
496 | <dt>ev_timer_again (loop)</dt> |
607 | <dt>ev_timer_again (loop)</dt> |
497 | <dd> |
608 | <dd> |
498 | <p>This will act as if the timer timed out and restart it again if it is |
609 | <p>This will act as if the timer timed out and restart it again if it is |
… | |
… | |
524 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
635 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
525 | roughly 10 seconds later and of course not if you reset your system time |
636 | roughly 10 seconds later and of course not if you reset your system time |
526 | again).</p> |
637 | again).</p> |
527 | <p>They can also be used to implement vastly more complex timers, such as |
638 | <p>They can also be used to implement vastly more complex timers, such as |
528 | triggering an event on eahc midnight, local time.</p> |
639 | triggering an event on eahc midnight, local time.</p> |
|
|
640 | <p>As with timers, the callback is guarenteed to be invoked only when the |
|
|
641 | time (<code>at</code>) has been passed, but if multiple periodic timers become ready |
|
|
642 | during the same loop iteration then order of execution is undefined.</p> |
529 | <dl> |
643 | <dl> |
530 | <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
644 | <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
531 | <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> |
645 | <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> |
532 | <dd> |
646 | <dd> |
533 | <p>Lots of arguments, lets sort it out... There are basically three modes of |
647 | <p>Lots of arguments, lets sort it out... There are basically three modes of |
534 | operation, and we will explain them from simplest to complex:</p> |
648 | operation, and we will explain them from simplest to complex:</p> |
535 | |
|
|
536 | |
|
|
537 | |
|
|
538 | |
|
|
539 | <p> |
649 | <p> |
540 | <dl> |
650 | <dl> |
541 | <dt>* absolute timer (interval = reschedule_cb = 0)</dt> |
651 | <dt>* absolute timer (interval = reschedule_cb = 0)</dt> |
542 | <dd> |
652 | <dd> |
543 | <p>In this configuration the watcher triggers an event at the wallclock time |
653 | <p>In this configuration the watcher triggers an event at the wallclock time |
… | |
… | |
567 | <dd> |
677 | <dd> |
568 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
678 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
569 | ignored. Instead, each time the periodic watcher gets scheduled, the |
679 | ignored. Instead, each time the periodic watcher gets scheduled, the |
570 | reschedule callback will be called with the watcher as first, and the |
680 | reschedule callback will be called with the watcher as first, and the |
571 | current time as second argument.</p> |
681 | current time as second argument.</p> |
572 | <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other |
682 | <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher, |
573 | periodic watcher, ever, or make any event loop modifications</i>. If you need |
683 | ever, or make any event loop modifications</i>. If you need to stop it, |
574 | to stop it, return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards.</p> |
684 | return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by |
575 | <p>Also, <i>this callback must always return a time that is later than the |
685 | starting a prepare watcher).</p> |
576 | passed <code>now</code> value</i>. Not even <code>now</code> itself will be ok.</p> |
|
|
577 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
686 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
578 | ev_tstamp now)</code>, e.g.:</p> |
687 | ev_tstamp now)</code>, e.g.:</p> |
579 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
688 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
580 | { |
689 | { |
581 | return now + 60.; |
690 | return now + 60.; |
… | |
… | |
584 | </pre> |
693 | </pre> |
585 | <p>It must return the next time to trigger, based on the passed time value |
694 | <p>It must return the next time to trigger, based on the passed time value |
586 | (that is, the lowest time value larger than to the second argument). It |
695 | (that is, the lowest time value larger than to the second argument). It |
587 | will usually be called just before the callback will be triggered, but |
696 | will usually be called just before the callback will be triggered, but |
588 | might be called at other times, too.</p> |
697 | might be called at other times, too.</p> |
|
|
698 | <p>NOTE: <i>This callback must always return a time that is later than the |
|
|
699 | passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p> |
589 | <p>This can be used to create very complex timers, such as a timer that |
700 | <p>This can be used to create very complex timers, such as a timer that |
590 | triggers on each midnight, local time. To do this, you would calculate the |
701 | triggers on each midnight, local time. To do this, you would calculate the |
591 | next midnight after <code>now</code> and return the timestamp value for this. How you do this |
702 | next midnight after <code>now</code> and return the timestamp value for this. How |
592 | is, again, up to you (but it is not trivial).</p> |
703 | you do this is, again, up to you (but it is not trivial, which is the main |
|
|
704 | reason I omitted it as an example).</p> |
593 | </dd> |
705 | </dd> |
594 | </dl> |
706 | </dl> |
595 | </p> |
707 | </p> |
596 | </dd> |
708 | </dd> |
597 | <dt>ev_periodic_again (loop, ev_periodic *)</dt> |
709 | <dt>ev_periodic_again (loop, ev_periodic *)</dt> |
… | |
… | |
670 | |
782 | |
671 | </div> |
783 | </div> |
672 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
784 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
673 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
785 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
674 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
786 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
675 | Prepare watchers get invoked before the process blocks and check watchers |
787 | prepare watchers get invoked before the process blocks and check watchers |
676 | afterwards.</p> |
788 | afterwards.</p> |
677 | <p>Their main purpose is to integrate other event mechanisms into libev. This |
789 | <p>Their main purpose is to integrate other event mechanisms into libev. This |
678 | could be used, for example, to track variable changes, implement your own |
790 | could be used, for example, to track variable changes, implement your own |
679 | watchers, integrate net-snmp or a coroutine library and lots more.</p> |
791 | watchers, integrate net-snmp or a coroutine library and lots more.</p> |
680 | <p>This is done by examining in each prepare call which file descriptors need |
792 | <p>This is done by examining in each prepare call which file descriptors need |
681 | to be watched by the other library, registering <code>ev_io</code> watchers for |
793 | to be watched by the other library, registering <code>ev_io</code> watchers for |
682 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
794 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
683 | provide just this functionality). Then, in the check watcher you check for |
795 | provide just this functionality). Then, in the check watcher you check for |
684 | any events that occured (by checking the pending status of all watchers |
796 | any events that occured (by checking the pending status of all watchers |
685 | and stopping them) and call back into the library. The I/O and timer |
797 | and stopping them) and call back into the library. The I/O and timer |
686 | callbacks will never actually be called (but must be valid neverthelles, |
798 | callbacks will never actually be called (but must be valid nevertheless, |
687 | because you never know, you know?).</p> |
799 | because you never know, you know?).</p> |
688 | <p>As another example, the Perl Coro module uses these hooks to integrate |
800 | <p>As another example, the Perl Coro module uses these hooks to integrate |
689 | coroutines into libev programs, by yielding to other active coroutines |
801 | coroutines into libev programs, by yielding to other active coroutines |
690 | during each prepare and only letting the process block if no coroutines |
802 | during each prepare and only letting the process block if no coroutines |
691 | are ready to run (its actually more complicated, it only runs coroutines |
803 | are ready to run (it's actually more complicated: it only runs coroutines |
692 | with priority higher than the event loop and one lower priority once, |
804 | with priority higher than or equal to the event loop and one coroutine |
693 | using idle watchers to keep the event loop from blocking if lower-priority |
805 | of lower priority, but only once, using idle watchers to keep the event |
694 | coroutines exist, thus mapping low-priority coroutines to idle/background |
806 | loop from blocking if lower-priority coroutines are active, thus mapping |
695 | tasks).</p> |
807 | low-priority coroutines to idle/background tasks).</p> |
696 | <dl> |
808 | <dl> |
697 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
809 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
698 | <dt>ev_check_init (ev_check *, callback)</dt> |
810 | <dt>ev_check_init (ev_check *, callback)</dt> |
699 | <dd> |
811 | <dd> |
700 | <p>Initialises and configures the prepare or check watcher - they have no |
812 | <p>Initialises and configures the prepare or check watcher - they have no |
… | |
… | |
711 | <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
823 | <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
712 | <dd> |
824 | <dd> |
713 | <p>This function combines a simple timer and an I/O watcher, calls your |
825 | <p>This function combines a simple timer and an I/O watcher, calls your |
714 | callback on whichever event happens first and automatically stop both |
826 | callback on whichever event happens first and automatically stop both |
715 | watchers. This is useful if you want to wait for a single event on an fd |
827 | watchers. This is useful if you want to wait for a single event on an fd |
716 | or timeout without havign to allocate/configure/start/stop/free one or |
828 | or timeout without having to allocate/configure/start/stop/free one or |
717 | more watchers yourself.</p> |
829 | more watchers yourself.</p> |
718 | <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events |
830 | <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events |
719 | is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and |
831 | is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and |
720 | <code>events</code> set will be craeted and started.</p> |
832 | <code>events</code> set will be craeted and started.</p> |
721 | <p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
833 | <p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
722 | started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and |
834 | started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and |
723 | repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of |
835 | repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of |
724 | dubious value.</p> |
836 | dubious value.</p> |
725 | <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets |
837 | <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets |
726 | passed an events set like normal event callbacks (with a combination of |
838 | passed an <code>revents</code> set like normal event callbacks (a combination of |
727 | <code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> |
839 | <code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> |
728 | value passed to <code>ev_once</code>:</p> |
840 | value passed to <code>ev_once</code>:</p> |
729 | <pre> static void stdin_ready (int revents, void *arg) |
841 | <pre> static void stdin_ready (int revents, void *arg) |
730 | { |
842 | { |
731 | if (revents & EV_TIMEOUT) |
843 | if (revents & EV_TIMEOUT) |
… | |
… | |
754 | <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
866 | <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
755 | </dd> |
867 | </dd> |
756 | </dl> |
868 | </dl> |
757 | |
869 | |
758 | </div> |
870 | </div> |
|
|
871 | <h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
872 | <div id="LIBEVENT_EMULATION_CONTENT"> |
|
|
873 | <p>Libev offers a compatibility emulation layer for libevent. It cannot |
|
|
874 | emulate the internals of libevent, so here are some usage hints:</p> |
|
|
875 | <dl> |
|
|
876 | <dt>* Use it by including <event.h>, as usual.</dt> |
|
|
877 | <dt>* The following members are fully supported: ev_base, ev_callback, |
|
|
878 | ev_arg, ev_fd, ev_res, ev_events.</dt> |
|
|
879 | <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is |
|
|
880 | maintained by libev, it does not work exactly the same way as in libevent (consider |
|
|
881 | it a private API).</dt> |
|
|
882 | <dt>* Priorities are not currently supported. Initialising priorities |
|
|
883 | will fail and all watchers will have the same priority, even though there |
|
|
884 | is an ev_pri field.</dt> |
|
|
885 | <dt>* Other members are not supported.</dt> |
|
|
886 | <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need |
|
|
887 | to use the libev header file and library.</dt> |
|
|
888 | </dl> |
|
|
889 | |
|
|
890 | </div> |
|
|
891 | <h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
892 | <div id="C_SUPPORT_CONTENT"> |
|
|
893 | <p>TBD.</p> |
|
|
894 | |
|
|
895 | </div> |
759 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
896 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
760 | <div id="AUTHOR_CONTENT"> |
897 | <div id="AUTHOR_CONTENT"> |
761 | <p>Marc Lehmann <libev@schmorp.de>.</p> |
898 | <p>Marc Lehmann <libev@schmorp.de>.</p> |
762 | |
899 | |
763 | </div> |
900 | </div> |