… | |
… | |
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:16:01 2007" /> |
9 | <meta name="created" content="Mon Nov 12 09:29:10 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 --> |
… | |
… | |
107 | <p>You can find out the major and minor version numbers of the library |
107 | <p>You can find out the major and minor version numbers of the library |
108 | you linked against by calling the functions <code>ev_version_major</code> and |
108 | you linked against by calling the functions <code>ev_version_major</code> and |
109 | <code>ev_version_minor</code>. If you want, you can compare against the global |
109 | <code>ev_version_minor</code>. If you want, you can compare against the global |
110 | symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the |
110 | symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the |
111 | version of the library your program was compiled against.</p> |
111 | version of the library your program was compiled against.</p> |
112 | <p>Usually, its a good idea to terminate if the major versions mismatch, |
112 | <p>Usually, it's a good idea to terminate if the major versions mismatch, |
113 | as this indicates an incompatible change. Minor versions are usually |
113 | as this indicates an incompatible change. Minor versions are usually |
114 | compatible to older versions, so a larger minor version alone is usually |
114 | compatible to older versions, so a larger minor version alone is usually |
115 | not a problem.</p> |
115 | not a problem.</p> |
116 | </dd> |
116 | </dd> |
117 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
117 | <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt> |
… | |
… | |
146 | <p>If you use threads, a common model is to run the default event loop |
146 | <p>If you use threads, a common model is to run the default event loop |
147 | in your main thread (or in a separate thrad) and for each thread you |
147 | in your main thread (or in a separate thrad) and for each thread you |
148 | create, you also create another event loop. Libev itself does no locking |
148 | create, you also create another event loop. Libev itself does no locking |
149 | whatsoever, so if you mix calls to the same event loop in different |
149 | whatsoever, so if you mix calls to the same event loop in different |
150 | threads, make sure you lock (this is usually a bad idea, though, even if |
150 | threads, make sure you lock (this is usually a bad idea, though, even if |
151 | done correctly, because its hideous and inefficient).</p> |
151 | done correctly, because it's hideous and inefficient).</p> |
152 | <dl> |
152 | <dl> |
153 | <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
153 | <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt> |
154 | <dd> |
154 | <dd> |
155 | <p>This will initialise the default event loop if it hasn't been initialised |
155 | <p>This will initialise the default event loop if it hasn't been initialised |
156 | yet and return it. If the default loop could not be initialised, returns |
156 | yet and return it. If the default loop could not be initialised, returns |
157 | false. If it already was initialised it simply returns it (and ignores the |
157 | false. If it already was initialised it simply returns it (and ignores the |
158 | flags).</p> |
158 | flags).</p> |
159 | <p>If you don't know what event loop to use, use the one returned from this |
159 | <p>If you don't know what event loop to use, use the one returned from this |
160 | function.</p> |
160 | function.</p> |
161 | <p>The flags argument can be used to specify special behaviour or specific |
161 | <p>The flags argument can be used to specify special behaviour or specific |
162 | backends to use, and is usually specified as 0 (or EVFLAG_AUTO)</p> |
162 | backends to use, and is usually specified as 0 (or EVFLAG_AUTO).</p> |
163 | <p>It supports the following flags:</p> |
163 | <p>It supports the following flags:</p> |
164 | <p> |
164 | <p> |
165 | <dl> |
165 | <dl> |
166 | <dt>EVFLAG_AUTO</dt> |
166 | <dt>EVFLAG_AUTO</dt> |
167 | <dd> |
167 | <dd> |
168 | <p>The default flags value. Use this if you have no clue (its the right |
168 | <p>The default flags value. Use this if you have no clue (it's the right |
169 | thing, believe me).</p> |
169 | thing, believe me).</p> |
170 | </dd> |
170 | </dd> |
171 | <dt>EVFLAG_NOENV</dt> |
171 | <dt>EVFLAG_NOENV</dt> |
172 | <dd> |
172 | <dd> |
173 | <p>If this flag bit is ored into the flag value then libev will <i>not</i> look |
173 | <p>If this flag bit is ored into the flag value (or the program runs setuid |
174 | at the environment variable <code>LIBEV_FLAGS</code>. Otherwise (the default), this |
174 | or setgid) then libev will <i>not</i> look at the environment variable |
175 | environment variable will override the flags completely. This is useful |
175 | <code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will |
|
|
176 | override the flags completely if it is found in the environment. This is |
176 | to try out specific backends to tets their performance, or to work around |
177 | useful to try out specific backends to test their performance, or to work |
177 | bugs.</p> |
178 | around bugs.</p> |
178 | </dd> |
179 | </dd> |
179 | <dt>EVMETHOD_SELECT portable select backend</dt> |
180 | <dt>EVMETHOD_SELECT (portable select backend)</dt> |
180 | <dt>EVMETHOD_POLL poll backend (everywhere except windows)</dt> |
181 | <dt>EVMETHOD_POLL (poll backend, available everywhere except on windows)</dt> |
181 | <dt>EVMETHOD_EPOLL linux only</dt> |
182 | <dt>EVMETHOD_EPOLL (linux only)</dt> |
182 | <dt>EVMETHOD_KQUEUE some bsds only</dt> |
183 | <dt>EVMETHOD_KQUEUE (some bsds only)</dt> |
183 | <dt>EVMETHOD_DEVPOLL solaris 8 only</dt> |
184 | <dt>EVMETHOD_DEVPOLL (solaris 8 only)</dt> |
184 | <dt>EVMETHOD_PORT solaris 10 only</dt> |
185 | <dt>EVMETHOD_PORT (solaris 10 only)</dt> |
185 | <dd> |
186 | <dd> |
186 | <p>If one or more of these are ored into the flags value, then only these |
187 | <p>If one or more of these are ored into the flags value, then only these |
187 | backends will be tried (in the reverse order as given here). If one are |
188 | backends will be tried (in the reverse order as given here). If one are |
188 | specified, any backend will do.</p> |
189 | specified, any backend will do.</p> |
189 | </dd> |
190 | </dd> |
… | |
… | |
199 | </dd> |
200 | </dd> |
200 | <dt>ev_default_destroy ()</dt> |
201 | <dt>ev_default_destroy ()</dt> |
201 | <dd> |
202 | <dd> |
202 | <p>Destroys the default loop again (frees all memory and kernel state |
203 | <p>Destroys the default loop again (frees all memory and kernel state |
203 | etc.). This stops all registered event watchers (by not touching them in |
204 | etc.). This stops all registered event watchers (by not touching them in |
204 | any way whatsoever, although you cnanot rely on this :).</p> |
205 | any way whatsoever, although you cannot rely on this :).</p> |
205 | </dd> |
206 | </dd> |
206 | <dt>ev_loop_destroy (loop)</dt> |
207 | <dt>ev_loop_destroy (loop)</dt> |
207 | <dd> |
208 | <dd> |
208 | <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an |
209 | <p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an |
209 | earlier call to <code>ev_loop_new</code>.</p> |
210 | earlier call to <code>ev_loop_new</code>.</p> |
… | |
… | |
215 | after forking, in either the parent or child process (or both, but that |
216 | after forking, in either the parent or child process (or both, but that |
216 | again makes little sense).</p> |
217 | again makes little sense).</p> |
217 | <p>You <i>must</i> call this function after forking if and only if you want to |
218 | <p>You <i>must</i> call this function after forking if and only if you want to |
218 | use the event library in both processes. If you just fork+exec, you don't |
219 | use the event library in both processes. If you just fork+exec, you don't |
219 | have to call it.</p> |
220 | have to call it.</p> |
220 | <p>The function itself is quite fast and its usually not a problem to call |
221 | <p>The function itself is quite fast and it's usually not a problem to call |
221 | it just in case after a fork. To make this easy, the function will fit in |
222 | it just in case after a fork. To make this easy, the function will fit in |
222 | quite nicely into a call to <code>pthread_atfork</code>:</p> |
223 | quite nicely into a call to <code>pthread_atfork</code>:</p> |
223 | <pre> pthread_atfork (0, 0, ev_default_fork); |
224 | <pre> pthread_atfork (0, 0, ev_default_fork); |
224 | |
225 | |
225 | </pre> |
226 | </pre> |
… | |
… | |
233 | <dt>unsigned int ev_method (loop)</dt> |
234 | <dt>unsigned int ev_method (loop)</dt> |
234 | <dd> |
235 | <dd> |
235 | <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in |
236 | <p>Returns one of the <code>EVMETHOD_*</code> flags indicating the event backend in |
236 | use.</p> |
237 | use.</p> |
237 | </dd> |
238 | </dd> |
238 | <dt>ev_tstamp = ev_now (loop)</dt> |
239 | <dt>ev_tstamp ev_now (loop)</dt> |
239 | <dd> |
240 | <dd> |
240 | <p>Returns the current "event loop time", which is the time the event loop |
241 | <p>Returns the current "event loop time", which is the time the event loop |
241 | got events and started processing them. This timestamp does not change |
242 | got events and started processing them. This timestamp does not change |
242 | as long as callbacks are being processed, and this is also the base time |
243 | as long as callbacks are being processed, and this is also the base time |
243 | used for relative timers. You can treat it as the timestamp of the event |
244 | used for relative timers. You can treat it as the timestamp of the event |
… | |
… | |
250 | events.</p> |
251 | events.</p> |
251 | <p>If the flags argument is specified as 0, it will not return until either |
252 | <p>If the flags argument is specified as 0, it will not return until either |
252 | no event watchers are active anymore or <code>ev_unloop</code> was called.</p> |
253 | no event watchers are active anymore or <code>ev_unloop</code> was called.</p> |
253 | <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle |
254 | <p>A flags value of <code>EVLOOP_NONBLOCK</code> will look for new events, will handle |
254 | those events and any outstanding ones, but will not block your process in |
255 | those events and any outstanding ones, but will not block your process in |
255 | case there are no events.</p> |
256 | case there are no events and will return after one iteration of the loop.</p> |
256 | <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if |
257 | <p>A flags value of <code>EVLOOP_ONESHOT</code> will look for new events (waiting if |
257 | neccessary) and will handle those and any outstanding ones. It will block |
258 | neccessary) and will handle those and any outstanding ones. It will block |
258 | your process until at least one new event arrives.</p> |
259 | your process until at least one new event arrives, and will return after |
|
|
260 | one iteration of the loop.</p> |
259 | <p>This flags value could be used to implement alternative looping |
261 | <p>This flags value could be used to implement alternative looping |
260 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
262 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
261 | more generic mechanism.</p> |
263 | more generic mechanism.</p> |
262 | </dd> |
264 | </dd> |
263 | <dt>ev_unloop (loop, how)</dt> |
265 | <dt>ev_unloop (loop, how)</dt> |
264 | <dd> |
266 | <dd> |
265 | <p>Can be used to make a call to <code>ev_loop</code> return early. The <code>how</code> argument |
267 | <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
|
|
268 | has processed all outstanding events). The <code>how</code> argument must be either |
266 | must be either <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> |
269 | <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or |
267 | call return, or <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> |
270 | <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
268 | calls return.</p> |
|
|
269 | </dd> |
271 | </dd> |
270 | <dt>ev_ref (loop)</dt> |
272 | <dt>ev_ref (loop)</dt> |
271 | <dt>ev_unref (loop)</dt> |
273 | <dt>ev_unref (loop)</dt> |
272 | <dd> |
274 | <dd> |
273 | <p>Ref/unref can be used to add or remove a refcount on the event loop: Every |
275 | <p>Ref/unref can be used to add or remove a reference count on the event |
274 | watcher keeps one reference. If you have a long-runing watcher you never |
276 | loop: Every watcher keeps one reference, and as long as the reference |
275 | unregister that should not keep ev_loop from running, ev_unref() after |
277 | count is nonzero, <code>ev_loop</code> will not return on its own. If you have |
276 | starting, and ev_ref() before stopping it. Libev itself uses this for |
278 | a watcher you never unregister that should not keep <code>ev_loop</code> from |
277 | example for its internal signal pipe: It is not visible to you as a user |
279 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
278 | and should not keep <code>ev_loop</code> from exiting if the work is done. It is |
280 | example, libev itself uses this for its internal signal pipe: It is not |
279 | also an excellent way to do this for generic recurring timers or from |
281 | visible to the libev user and should not keep <code>ev_loop</code> from exiting if |
280 | within third-party libraries. Just remember to unref after start and ref |
282 | no event watchers registered by it are active. It is also an excellent |
281 | before stop.</p> |
283 | way to do this for generic recurring timers or from within third-party |
|
|
284 | libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p> |
282 | </dd> |
285 | </dd> |
283 | </dl> |
286 | </dl> |
284 | |
287 | |
285 | </div> |
288 | </div> |
286 | <h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
289 | <h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p> |
… | |
… | |
430 | <p>I/O watchers check whether a file descriptor is readable or writable |
433 | <p>I/O watchers check whether a file descriptor is readable or writable |
431 | in each iteration of the event loop (This behaviour is called |
434 | in each iteration of the event loop (This behaviour is called |
432 | level-triggering because you keep receiving events as long as the |
435 | level-triggering because you keep receiving events as long as the |
433 | condition persists. Remember you cna stop the watcher if you don't want to |
436 | condition persists. Remember you cna stop the watcher if you don't want to |
434 | act on the event and neither want to receive future events).</p> |
437 | act on the event and neither want to receive future events).</p> |
|
|
438 | <p>In general you can register as many read and/or write event watchers oer |
|
|
439 | fd as you want (as long as you don't confuse yourself). Setting all file |
|
|
440 | descriptors to non-blocking mode is also usually a good idea (but not |
|
|
441 | required if you know what you are doing).</p> |
|
|
442 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
|
|
443 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
|
|
444 | descriptors correctly if you register interest in two or more fds pointing |
|
|
445 | to the same file/socket etc. description.</p> |
|
|
446 | <p>If you must do this, then force the use of a known-to-be-good backend |
|
|
447 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
|
|
448 | EVMETHOD_POLL).</p> |
435 | <dl> |
449 | <dl> |
436 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
450 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
437 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
451 | <dt>ev_io_set (ev_io *, int fd, int events)</dt> |
438 | <dd> |
452 | <dd> |
439 | <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive |
453 | <p>Configures an ev_io watcher. The fd is the file descriptor to rceeive |
… | |
… | |
450 | <p>The timers are based on real time, that is, if you register an event that |
464 | <p>The timers are based on real time, that is, if you register an event that |
451 | times out after an hour and youreset your system clock to last years |
465 | times out after an hour and youreset your system clock to last years |
452 | time, it will still time out after (roughly) and hour. "Roughly" because |
466 | time, it will still time out after (roughly) and hour. "Roughly" because |
453 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
467 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
454 | monotonic clock option helps a lot here).</p> |
468 | monotonic clock option helps a lot here).</p> |
|
|
469 | <p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
|
|
470 | time. This is usually the right thing as this timestamp refers to the time |
|
|
471 | of the event triggering whatever timeout you are modifying/starting. If |
|
|
472 | you suspect event processing to be delayed and you *need* to base the timeout |
|
|
473 | ion the current time, use something like this to adjust for this:</p> |
|
|
474 | <pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
|
|
475 | |
|
|
476 | </pre> |
455 | <dl> |
477 | <dl> |
456 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
478 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
457 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
479 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
458 | <dd> |
480 | <dd> |
459 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
481 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
… | |
… | |
577 | </div> |
599 | </div> |
578 | <h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> |
600 | <h2 id="ev_signal_signal_me_when_a_signal_ge">ev_signal - signal me when a signal gets signalled</h2> |
579 | <div id="ev_signal_signal_me_when_a_signal_ge-2"> |
601 | <div id="ev_signal_signal_me_when_a_signal_ge-2"> |
580 | <p>Signal watchers will trigger an event when the process receives a specific |
602 | <p>Signal watchers will trigger an event when the process receives a specific |
581 | signal one or more times. Even though signals are very asynchronous, libev |
603 | signal one or more times. Even though signals are very asynchronous, libev |
582 | will try its best to deliver signals synchronously, i.e. as part of the |
604 | will try it's best to deliver signals synchronously, i.e. as part of the |
583 | normal event processing, like any other event.</p> |
605 | normal event processing, like any other event.</p> |
584 | <p>You cna configure as many watchers as you like per signal. Only when the |
606 | <p>You cna configure as many watchers as you like per signal. Only when the |
585 | first watcher gets started will libev actually register a signal watcher |
607 | first watcher gets started will libev actually register a signal watcher |
586 | with the kernel (thus it coexists with your own signal handlers as long |
608 | with the kernel (thus it coexists with your own signal handlers as long |
587 | as you don't register any with libev). Similarly, when the last signal |
609 | as you don't register any with libev). Similarly, when the last signal |