… | |
… | |
126 | . ds Ae AE |
126 | . ds Ae AE |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title ""<STANDARD INPUT>" 1" |
131 | .IX Title "EV 1" |
132 | .TH "<STANDARD INPUT>" 1 "2007-11-23" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH EV 1 "2007-12-18" "perl v5.8.8" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
137 | .Vb 1 |
138 | \& #include <ev.h> |
138 | \& #include <ev.h> |
139 | .Ve |
139 | .Ve |
|
|
140 | .SH "EXAMPLE PROGRAM" |
|
|
141 | .IX Header "EXAMPLE PROGRAM" |
|
|
142 | .Vb 1 |
|
|
143 | \& #include <ev.h> |
|
|
144 | .Ve |
|
|
145 | .PP |
|
|
146 | .Vb 2 |
|
|
147 | \& ev_io stdin_watcher; |
|
|
148 | \& ev_timer timeout_watcher; |
|
|
149 | .Ve |
|
|
150 | .PP |
|
|
151 | .Vb 8 |
|
|
152 | \& /* called when data readable on stdin */ |
|
|
153 | \& static void |
|
|
154 | \& stdin_cb (EV_P_ struct ev_io *w, int revents) |
|
|
155 | \& { |
|
|
156 | \& /* puts ("stdin ready"); */ |
|
|
157 | \& ev_io_stop (EV_A_ w); /* just a syntax example */ |
|
|
158 | \& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ |
|
|
159 | \& } |
|
|
160 | .Ve |
|
|
161 | .PP |
|
|
162 | .Vb 6 |
|
|
163 | \& static void |
|
|
164 | \& timeout_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
165 | \& { |
|
|
166 | \& /* puts ("timeout"); */ |
|
|
167 | \& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ |
|
|
168 | \& } |
|
|
169 | .Ve |
|
|
170 | .PP |
|
|
171 | .Vb 4 |
|
|
172 | \& int |
|
|
173 | \& main (void) |
|
|
174 | \& { |
|
|
175 | \& struct ev_loop *loop = ev_default_loop (0); |
|
|
176 | .Ve |
|
|
177 | .PP |
|
|
178 | .Vb 3 |
|
|
179 | \& /* initialise an io watcher, then start it */ |
|
|
180 | \& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
|
|
181 | \& ev_io_start (loop, &stdin_watcher); |
|
|
182 | .Ve |
|
|
183 | .PP |
|
|
184 | .Vb 3 |
|
|
185 | \& /* simple non-repeating 5.5 second timeout */ |
|
|
186 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
187 | \& ev_timer_start (loop, &timeout_watcher); |
|
|
188 | .Ve |
|
|
189 | .PP |
|
|
190 | .Vb 2 |
|
|
191 | \& /* loop till timeout or data ready */ |
|
|
192 | \& ev_loop (loop, 0); |
|
|
193 | .Ve |
|
|
194 | .PP |
|
|
195 | .Vb 2 |
|
|
196 | \& return 0; |
|
|
197 | \& } |
|
|
198 | .Ve |
140 | .SH "DESCRIPTION" |
199 | .SH "DESCRIPTION" |
141 | .IX Header "DESCRIPTION" |
200 | .IX Header "DESCRIPTION" |
|
|
201 | The newest version of this document is also available as a html-formatted |
|
|
202 | web page you might find easier to navigate when reading it for the first |
|
|
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
|
|
204 | .PP |
142 | Libev is an event loop: you register interest in certain events (such as a |
205 | Libev is an event loop: you register interest in certain events (such as a |
143 | file descriptor being readable or a timeout occuring), and it will manage |
206 | file descriptor being readable or a timeout occuring), and it will manage |
144 | these event sources and provide your program with events. |
207 | these event sources and provide your program with events. |
145 | .PP |
208 | .PP |
146 | To do this, it must take more or less complete control over your process |
209 | To do this, it must take more or less complete control over your process |
… | |
… | |
151 | watchers\fR, which are relatively small C structures you initialise with the |
214 | watchers\fR, which are relatively small C structures you initialise with the |
152 | details of the event, and then hand it over to libev by \fIstarting\fR the |
215 | details of the event, and then hand it over to libev by \fIstarting\fR the |
153 | watcher. |
216 | watcher. |
154 | .SH "FEATURES" |
217 | .SH "FEATURES" |
155 | .IX Header "FEATURES" |
218 | .IX Header "FEATURES" |
156 | Libev supports select, poll, the linux-specific epoll and the bsd-specific |
219 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
157 | kqueue mechanisms for file descriptor events, relative timers, absolute |
220 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
158 | timers with customised rescheduling, signal events, process status change |
221 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
159 | events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event |
222 | (for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers |
160 | loop mechanism itself (idle, prepare and check watchers). It also is quite |
223 | with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals |
161 | fast (see this benchmark comparing |
224 | (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event |
162 | it to libevent for example). |
225 | watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, |
|
|
226 | \&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as |
|
|
227 | file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events |
|
|
228 | (\f(CW\*(C`ev_fork\*(C'\fR). |
|
|
229 | .PP |
|
|
230 | It also is quite fast (see this |
|
|
231 | benchmark comparing it to libevent |
|
|
232 | for example). |
163 | .SH "CONVENTIONS" |
233 | .SH "CONVENTIONS" |
164 | .IX Header "CONVENTIONS" |
234 | .IX Header "CONVENTIONS" |
165 | Libev is very configurable. In this manual the default configuration |
235 | Libev is very configurable. In this manual the default configuration will |
166 | will be described, which supports multiple event loops. For more info |
236 | be described, which supports multiple event loops. For more info about |
167 | about various configuration options please have a look at the file |
237 | various configuration options please have a look at \fB\s-1EMBED\s0\fR section in |
168 | \&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without |
238 | this manual. If libev was configured without support for multiple event |
169 | support for multiple event loops, then all functions taking an initial |
239 | loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR |
170 | argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) |
240 | (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. |
171 | will not have this argument. |
|
|
172 | .SH "TIME REPRESENTATION" |
241 | .SH "TIME REPRESENTATION" |
173 | .IX Header "TIME REPRESENTATION" |
242 | .IX Header "TIME REPRESENTATION" |
174 | Libev represents time as a single floating point number, representing the |
243 | Libev represents time as a single floating point number, representing the |
175 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
244 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
176 | the beginning of 1970, details are complicated, don't ask). This type is |
245 | the beginning of 1970, details are complicated, don't ask). This type is |
177 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
246 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
178 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
247 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
179 | it, you should treat it as such. |
248 | it, you should treat it as some floatingpoint value. Unlike the name |
|
|
249 | component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences |
|
|
250 | throughout libev. |
180 | .SH "GLOBAL FUNCTIONS" |
251 | .SH "GLOBAL FUNCTIONS" |
181 | .IX Header "GLOBAL FUNCTIONS" |
252 | .IX Header "GLOBAL FUNCTIONS" |
182 | These functions can be called anytime, even before initialising the |
253 | These functions can be called anytime, even before initialising the |
183 | library in any way. |
254 | library in any way. |
184 | .IP "ev_tstamp ev_time ()" 4 |
255 | .IP "ev_tstamp ev_time ()" 4 |
… | |
… | |
190 | .IX Item "int ev_version_major ()" |
261 | .IX Item "int ev_version_major ()" |
191 | .PD 0 |
262 | .PD 0 |
192 | .IP "int ev_version_minor ()" 4 |
263 | .IP "int ev_version_minor ()" 4 |
193 | .IX Item "int ev_version_minor ()" |
264 | .IX Item "int ev_version_minor ()" |
194 | .PD |
265 | .PD |
195 | You can find out the major and minor version numbers of the library |
266 | You can find out the major and minor \s-1ABI\s0 version numbers of the library |
196 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
267 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
197 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
268 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
198 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
269 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
199 | version of the library your program was compiled against. |
270 | version of the library your program was compiled against. |
200 | .Sp |
271 | .Sp |
|
|
272 | These version numbers refer to the \s-1ABI\s0 version of the library, not the |
|
|
273 | release version. |
|
|
274 | .Sp |
201 | Usually, it's a good idea to terminate if the major versions mismatch, |
275 | Usually, it's a good idea to terminate if the major versions mismatch, |
202 | as this indicates an incompatible change. Minor versions are usually |
276 | as this indicates an incompatible change. Minor versions are usually |
203 | compatible to older versions, so a larger minor version alone is usually |
277 | compatible to older versions, so a larger minor version alone is usually |
204 | not a problem. |
278 | not a problem. |
205 | .Sp |
279 | .Sp |
206 | Example: make sure we haven't accidentally been linked against the wrong |
280 | Example: Make sure we haven't accidentally been linked against the wrong |
207 | version: |
281 | version. |
208 | .Sp |
282 | .Sp |
209 | .Vb 3 |
283 | .Vb 3 |
210 | \& assert (("libev version mismatch", |
284 | \& assert (("libev version mismatch", |
211 | \& ev_version_major () == EV_VERSION_MAJOR |
285 | \& ev_version_major () == EV_VERSION_MAJOR |
212 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
286 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
… | |
… | |
231 | recommended for this platform. This set is often smaller than the one |
305 | recommended for this platform. This set is often smaller than the one |
232 | returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on |
306 | returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on |
233 | most BSDs and will not be autodetected unless you explicitly request it |
307 | most BSDs and will not be autodetected unless you explicitly request it |
234 | (assuming you know what you are doing). This is the set of backends that |
308 | (assuming you know what you are doing). This is the set of backends that |
235 | libev will probe for if you specify no backends explicitly. |
309 | libev will probe for if you specify no backends explicitly. |
|
|
310 | .IP "unsigned int ev_embeddable_backends ()" 4 |
|
|
311 | .IX Item "unsigned int ev_embeddable_backends ()" |
|
|
312 | Returns the set of backends that are embeddable in other event loops. This |
|
|
313 | is the theoretical, all\-platform, value. To find which backends |
|
|
314 | might be supported on the current system, you would need to look at |
|
|
315 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
|
|
316 | recommended ones. |
|
|
317 | .Sp |
|
|
318 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
236 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
319 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
237 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
320 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
238 | Sets the allocation function to use (the prototype is similar to the |
321 | Sets the allocation function to use (the prototype is similar \- the |
239 | realloc C function, the semantics are identical). It is used to allocate |
322 | semantics is identical \- to the realloc C function). It is used to |
240 | and free memory (no surprises here). If it returns zero when memory |
323 | allocate and free memory (no surprises here). If it returns zero when |
241 | needs to be allocated, the library might abort or take some potentially |
324 | memory needs to be allocated, the library might abort or take some |
242 | destructive action. The default is your system realloc function. |
325 | potentially destructive action. The default is your system realloc |
|
|
326 | function. |
243 | .Sp |
327 | .Sp |
244 | You could override this function in high-availability programs to, say, |
328 | You could override this function in high-availability programs to, say, |
245 | free some memory if it cannot allocate memory, to use a special allocator, |
329 | free some memory if it cannot allocate memory, to use a special allocator, |
246 | or even to sleep a while and retry until some memory is available. |
330 | or even to sleep a while and retry until some memory is available. |
247 | .Sp |
331 | .Sp |
248 | Example: replace the libev allocator with one that waits a bit and then |
332 | Example: Replace the libev allocator with one that waits a bit and then |
249 | retries: better than mine). |
333 | retries). |
250 | .Sp |
334 | .Sp |
251 | .Vb 6 |
335 | .Vb 6 |
252 | \& static void * |
336 | \& static void * |
253 | \& persistent_realloc (void *ptr, long size) |
337 | \& persistent_realloc (void *ptr, size_t size) |
254 | \& { |
338 | \& { |
255 | \& for (;;) |
339 | \& for (;;) |
256 | \& { |
340 | \& { |
257 | \& void *newptr = realloc (ptr, size); |
341 | \& void *newptr = realloc (ptr, size); |
258 | .Ve |
342 | .Ve |
… | |
… | |
280 | callback is set, then libev will expect it to remedy the sitution, no |
364 | callback is set, then libev will expect it to remedy the sitution, no |
281 | matter what, when it returns. That is, libev will generally retry the |
365 | matter what, when it returns. That is, libev will generally retry the |
282 | requested operation, or, if the condition doesn't go away, do bad stuff |
366 | requested operation, or, if the condition doesn't go away, do bad stuff |
283 | (such as abort). |
367 | (such as abort). |
284 | .Sp |
368 | .Sp |
285 | Example: do the same thing as libev does internally: |
369 | Example: This is basically the same thing that libev does internally, too. |
286 | .Sp |
370 | .Sp |
287 | .Vb 6 |
371 | .Vb 6 |
288 | \& static void |
372 | \& static void |
289 | \& fatal_error (const char *msg) |
373 | \& fatal_error (const char *msg) |
290 | \& { |
374 | \& { |
… | |
… | |
336 | or setgid) then libev will \fInot\fR look at the environment variable |
420 | or setgid) then libev will \fInot\fR look at the environment variable |
337 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
421 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
338 | override the flags completely if it is found in the environment. This is |
422 | override the flags completely if it is found in the environment. This is |
339 | useful to try out specific backends to test their performance, or to work |
423 | useful to try out specific backends to test their performance, or to work |
340 | around bugs. |
424 | around bugs. |
|
|
425 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
|
|
426 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
|
|
427 | .IX Item "EVFLAG_FORKCHECK" |
|
|
428 | Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after |
|
|
429 | a fork, you can also make libev check for a fork in each iteration by |
|
|
430 | enabling this flag. |
|
|
431 | .Sp |
|
|
432 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
|
|
433 | and thus this might slow down your event loop if you do a lot of loop |
|
|
434 | iterations and little real work, but is usually not noticeable (on my |
|
|
435 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
|
|
436 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
|
|
437 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
|
|
438 | .Sp |
|
|
439 | The big advantage of this flag is that you can forget about fork (and |
|
|
440 | forget about forgetting to tell libev about forking) when you use this |
|
|
441 | flag. |
|
|
442 | .Sp |
|
|
443 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
|
|
444 | environment variable. |
341 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
445 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
342 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
446 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
343 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
447 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
344 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
448 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
345 | libev tries to roll its own fd_set with no limits on the number of fds, |
449 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
439 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
543 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
440 | always distinct from the default loop. Unlike the default loop, it cannot |
544 | always distinct from the default loop. Unlike the default loop, it cannot |
441 | handle signal and child watchers, and attempts to do so will be greeted by |
545 | handle signal and child watchers, and attempts to do so will be greeted by |
442 | undefined behaviour (or a failed assertion if assertions are enabled). |
546 | undefined behaviour (or a failed assertion if assertions are enabled). |
443 | .Sp |
547 | .Sp |
444 | Example: try to create a event loop that uses epoll and nothing else. |
548 | Example: Try to create a event loop that uses epoll and nothing else. |
445 | .Sp |
549 | .Sp |
446 | .Vb 3 |
550 | .Vb 3 |
447 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
551 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
448 | \& if (!epoller) |
552 | \& if (!epoller) |
449 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
553 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
450 | .Ve |
554 | .Ve |
451 | .IP "ev_default_destroy ()" 4 |
555 | .IP "ev_default_destroy ()" 4 |
452 | .IX Item "ev_default_destroy ()" |
556 | .IX Item "ev_default_destroy ()" |
453 | Destroys the default loop again (frees all memory and kernel state |
557 | Destroys the default loop again (frees all memory and kernel state |
454 | etc.). This stops all registered event watchers (by not touching them in |
558 | etc.). None of the active event watchers will be stopped in the normal |
455 | any way whatsoever, although you cannot rely on this :). |
559 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
|
|
560 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
|
|
561 | calling this function, or cope with the fact afterwards (which is usually |
|
|
562 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
|
|
563 | for example). |
|
|
564 | .Sp |
|
|
565 | Not that certain global state, such as signal state, will not be freed by |
|
|
566 | this function, and related watchers (such as signal and child watchers) |
|
|
567 | would need to be stopped manually. |
|
|
568 | .Sp |
|
|
569 | In general it is not advisable to call this function except in the |
|
|
570 | rare occasion where you really need to free e.g. the signal handling |
|
|
571 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
572 | \&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR). |
456 | .IP "ev_loop_destroy (loop)" 4 |
573 | .IP "ev_loop_destroy (loop)" 4 |
457 | .IX Item "ev_loop_destroy (loop)" |
574 | .IX Item "ev_loop_destroy (loop)" |
458 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
575 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
459 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
576 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
460 | .IP "ev_default_fork ()" 4 |
577 | .IP "ev_default_fork ()" 4 |
… | |
… | |
482 | .IP "ev_loop_fork (loop)" 4 |
599 | .IP "ev_loop_fork (loop)" 4 |
483 | .IX Item "ev_loop_fork (loop)" |
600 | .IX Item "ev_loop_fork (loop)" |
484 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
601 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
485 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
602 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
486 | after fork, and how you do this is entirely your own problem. |
603 | after fork, and how you do this is entirely your own problem. |
|
|
604 | .IP "unsigned int ev_loop_count (loop)" 4 |
|
|
605 | .IX Item "unsigned int ev_loop_count (loop)" |
|
|
606 | Returns the count of loop iterations for the loop, which is identical to |
|
|
607 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
608 | happily wraps around with enough iterations. |
|
|
609 | .Sp |
|
|
610 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
611 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
|
|
612 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
487 | .IP "unsigned int ev_backend (loop)" 4 |
613 | .IP "unsigned int ev_backend (loop)" 4 |
488 | .IX Item "unsigned int ev_backend (loop)" |
614 | .IX Item "unsigned int ev_backend (loop)" |
489 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
615 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
490 | use. |
616 | use. |
491 | .IP "ev_tstamp ev_now (loop)" 4 |
617 | .IP "ev_tstamp ev_now (loop)" 4 |
… | |
… | |
522 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
648 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
523 | usually a better approach for this kind of thing. |
649 | usually a better approach for this kind of thing. |
524 | .Sp |
650 | .Sp |
525 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
651 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
526 | .Sp |
652 | .Sp |
527 | .Vb 18 |
653 | .Vb 19 |
|
|
654 | \& - Before the first iteration, call any pending watchers. |
528 | \& * If there are no active watchers (reference count is zero), return. |
655 | \& * If there are no active watchers (reference count is zero), return. |
529 | \& - Queue prepare watchers and then call all outstanding watchers. |
656 | \& - Queue all prepare watchers and then call all outstanding watchers. |
530 | \& - If we have been forked, recreate the kernel state. |
657 | \& - If we have been forked, recreate the kernel state. |
531 | \& - Update the kernel state with all outstanding changes. |
658 | \& - Update the kernel state with all outstanding changes. |
532 | \& - Update the "event loop time". |
659 | \& - Update the "event loop time". |
533 | \& - Calculate for how long to block. |
660 | \& - Calculate for how long to block. |
534 | \& - Block the process, waiting for any events. |
661 | \& - Block the process, waiting for any events. |
… | |
… | |
543 | \& be handled here by queueing them when their watcher gets executed. |
670 | \& be handled here by queueing them when their watcher gets executed. |
544 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
671 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
545 | \& were used, return, otherwise continue with step *. |
672 | \& were used, return, otherwise continue with step *. |
546 | .Ve |
673 | .Ve |
547 | .Sp |
674 | .Sp |
548 | Example: queue some jobs and then loop until no events are outsanding |
675 | Example: Queue some jobs and then loop until no events are outsanding |
549 | anymore. |
676 | anymore. |
550 | .Sp |
677 | .Sp |
551 | .Vb 4 |
678 | .Vb 4 |
552 | \& ... queue jobs here, make sure they register event watchers as long |
679 | \& ... queue jobs here, make sure they register event watchers as long |
553 | \& ... as they still have work to do (even an idle watcher will do..) |
680 | \& ... as they still have work to do (even an idle watcher will do..) |
… | |
… | |
575 | visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if |
702 | visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if |
576 | no event watchers registered by it are active. It is also an excellent |
703 | no event watchers registered by it are active. It is also an excellent |
577 | way to do this for generic recurring timers or from within third-party |
704 | way to do this for generic recurring timers or from within third-party |
578 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
705 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
579 | .Sp |
706 | .Sp |
580 | Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
707 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
581 | running when nothing else is active. |
708 | running when nothing else is active. |
582 | .Sp |
709 | .Sp |
583 | .Vb 4 |
710 | .Vb 4 |
584 | \& struct dv_signal exitsig; |
711 | \& struct ev_signal exitsig; |
585 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
712 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
586 | \& ev_signal_start (myloop, &exitsig); |
713 | \& ev_signal_start (loop, &exitsig); |
587 | \& evf_unref (myloop); |
714 | \& evf_unref (loop); |
588 | .Ve |
715 | .Ve |
589 | .Sp |
716 | .Sp |
590 | Example: for some weird reason, unregister the above signal handler again. |
717 | Example: For some weird reason, unregister the above signal handler again. |
591 | .Sp |
718 | .Sp |
592 | .Vb 2 |
719 | .Vb 2 |
593 | \& ev_ref (myloop); |
720 | \& ev_ref (loop); |
594 | \& ev_signal_stop (myloop, &exitsig); |
721 | \& ev_signal_stop (loop, &exitsig); |
595 | .Ve |
722 | .Ve |
596 | .SH "ANATOMY OF A WATCHER" |
723 | .SH "ANATOMY OF A WATCHER" |
597 | .IX Header "ANATOMY OF A WATCHER" |
724 | .IX Header "ANATOMY OF A WATCHER" |
598 | A watcher is a structure that you create and register to record your |
725 | A watcher is a structure that you create and register to record your |
599 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
726 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
… | |
… | |
636 | *)\*(C'\fR), and you can stop watching for events at any time by calling the |
763 | *)\*(C'\fR), and you can stop watching for events at any time by calling the |
637 | corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. |
764 | corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. |
638 | .PP |
765 | .PP |
639 | As long as your watcher is active (has been started but not stopped) you |
766 | As long as your watcher is active (has been started but not stopped) you |
640 | must not touch the values stored in it. Most specifically you must never |
767 | must not touch the values stored in it. Most specifically you must never |
641 | reinitialise it or call its set macro. |
768 | reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. |
642 | .PP |
|
|
643 | You can check whether an event is active by calling the \f(CW\*(C`ev_is_active |
|
|
644 | (watcher *)\*(C'\fR macro. To see whether an event is outstanding (but the |
|
|
645 | callback for it has not been called yet) you can use the \f(CW\*(C`ev_is_pending |
|
|
646 | (watcher *)\*(C'\fR macro. |
|
|
647 | .PP |
769 | .PP |
648 | Each and every callback receives the event loop pointer as first, the |
770 | Each and every callback receives the event loop pointer as first, the |
649 | registered watcher structure as second, and a bitset of received events as |
771 | registered watcher structure as second, and a bitset of received events as |
650 | third argument. |
772 | third argument. |
651 | .PP |
773 | .PP |
… | |
… | |
676 | The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. |
798 | The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. |
677 | .ie n .IP """EV_CHILD""" 4 |
799 | .ie n .IP """EV_CHILD""" 4 |
678 | .el .IP "\f(CWEV_CHILD\fR" 4 |
800 | .el .IP "\f(CWEV_CHILD\fR" 4 |
679 | .IX Item "EV_CHILD" |
801 | .IX Item "EV_CHILD" |
680 | The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. |
802 | The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. |
|
|
803 | .ie n .IP """EV_STAT""" 4 |
|
|
804 | .el .IP "\f(CWEV_STAT\fR" 4 |
|
|
805 | .IX Item "EV_STAT" |
|
|
806 | The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow. |
681 | .ie n .IP """EV_IDLE""" 4 |
807 | .ie n .IP """EV_IDLE""" 4 |
682 | .el .IP "\f(CWEV_IDLE\fR" 4 |
808 | .el .IP "\f(CWEV_IDLE\fR" 4 |
683 | .IX Item "EV_IDLE" |
809 | .IX Item "EV_IDLE" |
684 | The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. |
810 | The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. |
685 | .ie n .IP """EV_PREPARE""" 4 |
811 | .ie n .IP """EV_PREPARE""" 4 |
… | |
… | |
695 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
821 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
696 | received events. Callbacks of both watcher types can start and stop as |
822 | received events. Callbacks of both watcher types can start and stop as |
697 | many watchers as they want, and all of them will be taken into account |
823 | many watchers as they want, and all of them will be taken into account |
698 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
824 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
699 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
825 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
|
|
826 | .ie n .IP """EV_EMBED""" 4 |
|
|
827 | .el .IP "\f(CWEV_EMBED\fR" 4 |
|
|
828 | .IX Item "EV_EMBED" |
|
|
829 | The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. |
|
|
830 | .ie n .IP """EV_FORK""" 4 |
|
|
831 | .el .IP "\f(CWEV_FORK\fR" 4 |
|
|
832 | .IX Item "EV_FORK" |
|
|
833 | The event loop has been resumed in the child process after fork (see |
|
|
834 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
700 | .ie n .IP """EV_ERROR""" 4 |
835 | .ie n .IP """EV_ERROR""" 4 |
701 | .el .IP "\f(CWEV_ERROR\fR" 4 |
836 | .el .IP "\f(CWEV_ERROR\fR" 4 |
702 | .IX Item "EV_ERROR" |
837 | .IX Item "EV_ERROR" |
703 | An unspecified error has occured, the watcher has been stopped. This might |
838 | An unspecified error has occured, the watcher has been stopped. This might |
704 | happen because the watcher could not be properly started because libev |
839 | happen because the watcher could not be properly started because libev |
… | |
… | |
709 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, |
844 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, |
710 | for example it might indicate that a fd is readable or writable, and if |
845 | for example it might indicate that a fd is readable or writable, and if |
711 | your callbacks is well-written it can just attempt the operation and cope |
846 | your callbacks is well-written it can just attempt the operation and cope |
712 | with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded |
847 | with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded |
713 | programs, though, so beware. |
848 | programs, though, so beware. |
|
|
849 | .Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
|
|
850 | .IX Subsection "GENERIC WATCHER FUNCTIONS" |
|
|
851 | In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type, |
|
|
852 | e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers. |
|
|
853 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
|
|
854 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
|
|
855 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
|
|
856 | This macro initialises the generic portion of a watcher. The contents |
|
|
857 | of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only |
|
|
858 | the generic parts of the watcher are initialised, you \fIneed\fR to call |
|
|
859 | the type-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR macro afterwards to initialise the |
|
|
860 | type-specific parts. For each type there is also a \f(CW\*(C`ev_TYPE_init\*(C'\fR macro |
|
|
861 | which rolls both calls into one. |
|
|
862 | .Sp |
|
|
863 | You can reinitialise a watcher at any time as long as it has been stopped |
|
|
864 | (or never started) and there are no pending events outstanding. |
|
|
865 | .Sp |
|
|
866 | The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, |
|
|
867 | int revents)\*(C'\fR. |
|
|
868 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 |
|
|
869 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 |
|
|
870 | .IX Item "ev_TYPE_set (ev_TYPE *, [args])" |
|
|
871 | This macro initialises the type-specific parts of a watcher. You need to |
|
|
872 | call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can |
|
|
873 | call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this |
|
|
874 | macro on a watcher that is active (it can be pending, however, which is a |
|
|
875 | difference to the \f(CW\*(C`ev_init\*(C'\fR macro). |
|
|
876 | .Sp |
|
|
877 | Although some watcher types do not have type-specific arguments |
|
|
878 | (e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. |
|
|
879 | .ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 |
|
|
880 | .el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 |
|
|
881 | .IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" |
|
|
882 | This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro |
|
|
883 | calls into a single call. This is the most convinient method to initialise |
|
|
884 | a watcher. The same limitations apply, of course. |
|
|
885 | .ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 |
|
|
886 | .el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 |
|
|
887 | .IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" |
|
|
888 | Starts (activates) the given watcher. Only active watchers will receive |
|
|
889 | events. If the watcher is already active nothing will happen. |
|
|
890 | .ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 |
|
|
891 | .el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 |
|
|
892 | .IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" |
|
|
893 | Stops the given watcher again (if active) and clears the pending |
|
|
894 | status. It is possible that stopped watchers are pending (for example, |
|
|
895 | non-repeating timers are being stopped when they become pending), but |
|
|
896 | \&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If |
|
|
897 | you want to free or reuse the memory used by the watcher it is therefore a |
|
|
898 | good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. |
|
|
899 | .IP "bool ev_is_active (ev_TYPE *watcher)" 4 |
|
|
900 | .IX Item "bool ev_is_active (ev_TYPE *watcher)" |
|
|
901 | Returns a true value iff the watcher is active (i.e. it has been started |
|
|
902 | and not yet been stopped). As long as a watcher is active you must not modify |
|
|
903 | it. |
|
|
904 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
|
|
905 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
|
|
906 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
|
|
907 | events but its callback has not yet been invoked). As long as a watcher |
|
|
908 | is pending (but not active) you must not call an init function on it (but |
|
|
909 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
|
|
910 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
911 | it). |
|
|
912 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
|
|
913 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
|
|
914 | Returns the callback currently set on the watcher. |
|
|
915 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
|
|
916 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
|
|
917 | Change the callback. You can change the callback at virtually any time |
|
|
918 | (modulo threads). |
|
|
919 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
920 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
921 | .PD 0 |
|
|
922 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
923 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
924 | .PD |
|
|
925 | Set and query the priority of the watcher. The priority is a small |
|
|
926 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
927 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
928 | before watchers with lower priority, but priority will not keep watchers |
|
|
929 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
930 | .Sp |
|
|
931 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
932 | invocation after new events have been received. This is useful, for |
|
|
933 | example, to reduce latency after idling, or more often, to bind two |
|
|
934 | watchers on the same event and make sure one is called first. |
|
|
935 | .Sp |
|
|
936 | If you need to suppress invocation when higher priority events are pending |
|
|
937 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
938 | .Sp |
|
|
939 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
940 | pending. |
|
|
941 | .Sp |
|
|
942 | The default priority used by watchers when no priority has been set is |
|
|
943 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
944 | .Sp |
|
|
945 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
946 | fine, as long as you do not mind that the priority value you query might |
|
|
947 | or might not have been adjusted to be within valid range. |
|
|
948 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
949 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
950 | Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither |
|
|
951 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
952 | can deal with that fact. |
|
|
953 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
954 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
955 | If the watcher is pending, this function returns clears its pending status |
|
|
956 | and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
957 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
714 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
958 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
715 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
959 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
716 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
960 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
717 | and read at any time, libev will completely ignore it. This can be used |
961 | and read at any time, libev will completely ignore it. This can be used |
718 | to associate arbitrary data with your watcher. If you need more data and |
962 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
739 | \& struct my_io *w = (struct my_io *)w_; |
983 | \& struct my_io *w = (struct my_io *)w_; |
740 | \& ... |
984 | \& ... |
741 | \& } |
985 | \& } |
742 | .Ve |
986 | .Ve |
743 | .PP |
987 | .PP |
744 | More interesting and less C\-conformant ways of catsing your callback type |
988 | More interesting and less C\-conformant ways of casting your callback type |
745 | have been omitted.... |
989 | instead have been omitted. |
|
|
990 | .PP |
|
|
991 | Another common scenario is having some data structure with multiple |
|
|
992 | watchers: |
|
|
993 | .PP |
|
|
994 | .Vb 6 |
|
|
995 | \& struct my_biggy |
|
|
996 | \& { |
|
|
997 | \& int some_data; |
|
|
998 | \& ev_timer t1; |
|
|
999 | \& ev_timer t2; |
|
|
1000 | \& } |
|
|
1001 | .Ve |
|
|
1002 | .PP |
|
|
1003 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
|
|
1004 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
|
|
1005 | .PP |
|
|
1006 | .Vb 1 |
|
|
1007 | \& #include <stddef.h> |
|
|
1008 | .Ve |
|
|
1009 | .PP |
|
|
1010 | .Vb 6 |
|
|
1011 | \& static void |
|
|
1012 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1013 | \& { |
|
|
1014 | \& struct my_biggy big = (struct my_biggy * |
|
|
1015 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
|
|
1016 | \& } |
|
|
1017 | .Ve |
|
|
1018 | .PP |
|
|
1019 | .Vb 6 |
|
|
1020 | \& static void |
|
|
1021 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1022 | \& { |
|
|
1023 | \& struct my_biggy big = (struct my_biggy * |
|
|
1024 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
|
|
1025 | \& } |
|
|
1026 | .Ve |
746 | .SH "WATCHER TYPES" |
1027 | .SH "WATCHER TYPES" |
747 | .IX Header "WATCHER TYPES" |
1028 | .IX Header "WATCHER TYPES" |
748 | This section describes each watcher in detail, but will not repeat |
1029 | This section describes each watcher in detail, but will not repeat |
749 | information given in the last section. |
1030 | information given in the last section. Any initialisation/set macros, |
|
|
1031 | functions and members specific to the watcher type are explained. |
|
|
1032 | .PP |
|
|
1033 | Members are additionally marked with either \fI[read\-only]\fR, meaning that, |
|
|
1034 | while the watcher is active, you can look at the member and expect some |
|
|
1035 | sensible content, but you must not modify it (you can modify it while the |
|
|
1036 | watcher is stopped to your hearts content), or \fI[read\-write]\fR, which |
|
|
1037 | means you can expect it to have some sensible content while the watcher |
|
|
1038 | is active, but you can also modify it. Modifying it may not do something |
|
|
1039 | sensible or take immediate effect (or do anything at all), but libev will |
|
|
1040 | not crash or malfunction in any way. |
750 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable" |
1041 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" |
751 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable" |
1042 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" |
752 | .IX Subsection "ev_io - is this file descriptor readable or writable" |
1043 | .IX Subsection "ev_io - is this file descriptor readable or writable?" |
753 | I/O watchers check whether a file descriptor is readable or writable |
1044 | I/O watchers check whether a file descriptor is readable or writable |
754 | in each iteration of the event loop (This behaviour is called |
1045 | in each iteration of the event loop, or, more precisely, when reading |
755 | level-triggering because you keep receiving events as long as the |
1046 | would not block the process and writing would at least be able to write |
756 | condition persists. Remember you can stop the watcher if you don't want to |
1047 | some data. This behaviour is called level-triggering because you keep |
757 | act on the event and neither want to receive future events). |
1048 | receiving events as long as the condition persists. Remember you can stop |
|
|
1049 | the watcher if you don't want to act on the event and neither want to |
|
|
1050 | receive future events. |
758 | .PP |
1051 | .PP |
759 | In general you can register as many read and/or write event watchers per |
1052 | In general you can register as many read and/or write event watchers per |
760 | fd as you want (as long as you don't confuse yourself). Setting all file |
1053 | fd as you want (as long as you don't confuse yourself). Setting all file |
761 | descriptors to non-blocking mode is also usually a good idea (but not |
1054 | descriptors to non-blocking mode is also usually a good idea (but not |
762 | required if you know what you are doing). |
1055 | required if you know what you are doing). |
763 | .PP |
1056 | .PP |
764 | You have to be careful with dup'ed file descriptors, though. Some backends |
1057 | You have to be careful with dup'ed file descriptors, though. Some backends |
765 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
1058 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
766 | descriptors correctly if you register interest in two or more fds pointing |
1059 | descriptors correctly if you register interest in two or more fds pointing |
767 | to the same underlying file/socket etc. description (that is, they share |
1060 | to the same underlying file/socket/etc. description (that is, they share |
768 | the same underlying \*(L"file open\*(R"). |
1061 | the same underlying \*(L"file open\*(R"). |
769 | .PP |
1062 | .PP |
770 | If you must do this, then force the use of a known-to-be-good backend |
1063 | If you must do this, then force the use of a known-to-be-good backend |
771 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
1064 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
772 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
1065 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
|
|
1066 | .PP |
|
|
1067 | Another thing you have to watch out for is that it is quite easy to |
|
|
1068 | receive \*(L"spurious\*(R" readyness notifications, that is your callback might |
|
|
1069 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
|
|
1070 | because there is no data. Not only are some backends known to create a |
|
|
1071 | lot of those (for example solaris ports), it is very easy to get into |
|
|
1072 | this situation even with a relatively standard program structure. Thus |
|
|
1073 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
|
|
1074 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
|
|
1075 | .PP |
|
|
1076 | If you cannot run the fd in non-blocking mode (for example you should not |
|
|
1077 | play around with an Xlib connection), then you have to seperately re-test |
|
|
1078 | whether a file descriptor is really ready with a known-to-be good interface |
|
|
1079 | such as poll (fortunately in our Xlib example, Xlib already does this on |
|
|
1080 | its own, so its quite safe to use). |
|
|
1081 | .PP |
|
|
1082 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1083 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1084 | .PP |
|
|
1085 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
|
|
1086 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
|
|
1087 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
|
|
1088 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1089 | this interest. If another file descriptor with the same number then is |
|
|
1090 | registered with libev, there is no efficient way to see that this is, in |
|
|
1091 | fact, a different file descriptor. |
|
|
1092 | .PP |
|
|
1093 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1094 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1095 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1096 | it is assumed that the file descriptor stays the same. That means that |
|
|
1097 | you \fIhave\fR to call \f(CW\*(C`ev_io_set\*(C'\fR (or \f(CW\*(C`ev_io_init\*(C'\fR) when you change the |
|
|
1098 | descriptor even if the file descriptor number itself did not change. |
|
|
1099 | .PP |
|
|
1100 | This is how one would do it normally anyway, the important point is that |
|
|
1101 | the libev application should not optimise around libev but should leave |
|
|
1102 | optimisations to libev. |
|
|
1103 | .PP |
|
|
1104 | \fIWatcher-Specific Functions\fR |
|
|
1105 | .IX Subsection "Watcher-Specific Functions" |
773 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1106 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
774 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1107 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
775 | .PD 0 |
1108 | .PD 0 |
776 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1109 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
777 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1110 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
778 | .PD |
1111 | .PD |
779 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive |
1112 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
780 | events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ | |
1113 | rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
781 | EV_WRITE\*(C'\fR to receive the given events. |
1114 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. |
782 | .Sp |
1115 | .IP "int fd [read\-only]" 4 |
783 | Please note that most of the more scalable backend mechanisms (for example |
1116 | .IX Item "int fd [read-only]" |
784 | epoll and solaris ports) can result in spurious readyness notifications |
1117 | The file descriptor being watched. |
785 | for file descriptors, so you practically need to use non-blocking I/O (and |
1118 | .IP "int events [read\-only]" 4 |
786 | treat callback invocation as hint only), or retest separately with a safe |
1119 | .IX Item "int events [read-only]" |
787 | interface before doing I/O (XLib can do this), or force the use of either |
1120 | The events being watched. |
788 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR, which don't suffer from this |
|
|
789 | problem. Also note that it is quite easy to have your callback invoked |
|
|
790 | when the readyness condition is no longer valid even when employing |
|
|
791 | typical ways of handling events, so its a good idea to use non-blocking |
|
|
792 | I/O unconditionally. |
|
|
793 | .PP |
1121 | .PP |
794 | Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1122 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
795 | readable, but only once. Since it is likely line\-buffered, you could |
1123 | readable, but only once. Since it is likely line\-buffered, you could |
796 | attempt to read a whole line in the callback: |
1124 | attempt to read a whole line in the callback. |
797 | .PP |
1125 | .PP |
798 | .Vb 6 |
1126 | .Vb 6 |
799 | \& static void |
1127 | \& static void |
800 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1128 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
801 | \& { |
1129 | \& { |
… | |
… | |
810 | \& struct ev_io stdin_readable; |
1138 | \& struct ev_io stdin_readable; |
811 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1139 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
812 | \& ev_io_start (loop, &stdin_readable); |
1140 | \& ev_io_start (loop, &stdin_readable); |
813 | \& ev_loop (loop, 0); |
1141 | \& ev_loop (loop, 0); |
814 | .Ve |
1142 | .Ve |
815 | .ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts" |
1143 | .ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" |
816 | .el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts" |
1144 | .el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" |
817 | .IX Subsection "ev_timer - relative and optionally recurring timeouts" |
1145 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
818 | Timer watchers are simple relative timers that generate an event after a |
1146 | Timer watchers are simple relative timers that generate an event after a |
819 | given time, and optionally repeating in regular intervals after that. |
1147 | given time, and optionally repeating in regular intervals after that. |
820 | .PP |
1148 | .PP |
821 | The timers are based on real time, that is, if you register an event that |
1149 | The timers are based on real time, that is, if you register an event that |
822 | times out after an hour and you reset your system clock to last years |
1150 | times out after an hour and you reset your system clock to last years |
… | |
… | |
835 | .Ve |
1163 | .Ve |
836 | .PP |
1164 | .PP |
837 | The callback is guarenteed to be invoked only when its timeout has passed, |
1165 | The callback is guarenteed to be invoked only when its timeout has passed, |
838 | but if multiple timers become ready during the same loop iteration then |
1166 | but if multiple timers become ready during the same loop iteration then |
839 | order of execution is undefined. |
1167 | order of execution is undefined. |
|
|
1168 | .PP |
|
|
1169 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1170 | .IX Subsection "Watcher-Specific Functions and Data Members" |
840 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1171 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
841 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1172 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
842 | .PD 0 |
1173 | .PD 0 |
843 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1174 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
844 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1175 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
… | |
… | |
856 | .IP "ev_timer_again (loop)" 4 |
1187 | .IP "ev_timer_again (loop)" 4 |
857 | .IX Item "ev_timer_again (loop)" |
1188 | .IX Item "ev_timer_again (loop)" |
858 | This will act as if the timer timed out and restart it again if it is |
1189 | This will act as if the timer timed out and restart it again if it is |
859 | repeating. The exact semantics are: |
1190 | repeating. The exact semantics are: |
860 | .Sp |
1191 | .Sp |
|
|
1192 | If the timer is pending, its pending status is cleared. |
|
|
1193 | .Sp |
861 | If the timer is started but nonrepeating, stop it. |
1194 | If the timer is started but nonrepeating, stop it (as if it timed out). |
862 | .Sp |
1195 | .Sp |
863 | If the timer is repeating, either start it if necessary (with the repeat |
1196 | If the timer is repeating, either start it if necessary (with the |
864 | value), or reset the running timer to the repeat value. |
1197 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
865 | .Sp |
1198 | .Sp |
866 | This sounds a bit complicated, but here is a useful and typical |
1199 | This sounds a bit complicated, but here is a useful and typical |
867 | example: Imagine you have a tcp connection and you want a so-called idle |
1200 | example: Imagine you have a tcp connection and you want a so-called idle |
868 | timeout, that is, you want to be called when there have been, say, 60 |
1201 | timeout, that is, you want to be called when there have been, say, 60 |
869 | seconds of inactivity on the socket. The easiest way to do this is to |
1202 | seconds of inactivity on the socket. The easiest way to do this is to |
870 | configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each |
1203 | configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value of \f(CW60\fR and then call |
871 | time you successfully read or write some data. If you go into an idle |
1204 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
872 | state where you do not expect data to travel on the socket, you can stop |
1205 | you go into an idle state where you do not expect data to travel on the |
873 | the timer, and again will automatically restart it if need be. |
1206 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
|
|
1207 | automatically restart it if need be. |
|
|
1208 | .Sp |
|
|
1209 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
|
|
1210 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
|
|
1211 | .Sp |
|
|
1212 | .Vb 8 |
|
|
1213 | \& ev_timer_init (timer, callback, 0., 5.); |
|
|
1214 | \& ev_timer_again (loop, timer); |
|
|
1215 | \& ... |
|
|
1216 | \& timer->again = 17.; |
|
|
1217 | \& ev_timer_again (loop, timer); |
|
|
1218 | \& ... |
|
|
1219 | \& timer->again = 10.; |
|
|
1220 | \& ev_timer_again (loop, timer); |
|
|
1221 | .Ve |
|
|
1222 | .Sp |
|
|
1223 | This is more slightly efficient then stopping/starting the timer each time |
|
|
1224 | you want to modify its timeout value. |
|
|
1225 | .IP "ev_tstamp repeat [read\-write]" 4 |
|
|
1226 | .IX Item "ev_tstamp repeat [read-write]" |
|
|
1227 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
|
|
1228 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
|
|
1229 | which is also when any modifications are taken into account. |
874 | .PP |
1230 | .PP |
875 | Example: create a timer that fires after 60 seconds. |
1231 | Example: Create a timer that fires after 60 seconds. |
876 | .PP |
1232 | .PP |
877 | .Vb 5 |
1233 | .Vb 5 |
878 | \& static void |
1234 | \& static void |
879 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1235 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
880 | \& { |
1236 | \& { |
… | |
… | |
886 | \& struct ev_timer mytimer; |
1242 | \& struct ev_timer mytimer; |
887 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1243 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
888 | \& ev_timer_start (loop, &mytimer); |
1244 | \& ev_timer_start (loop, &mytimer); |
889 | .Ve |
1245 | .Ve |
890 | .PP |
1246 | .PP |
891 | Example: create a timeout timer that times out after 10 seconds of |
1247 | Example: Create a timeout timer that times out after 10 seconds of |
892 | inactivity. |
1248 | inactivity. |
893 | .PP |
1249 | .PP |
894 | .Vb 5 |
1250 | .Vb 5 |
895 | \& static void |
1251 | \& static void |
896 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1252 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
… | |
… | |
909 | .Vb 3 |
1265 | .Vb 3 |
910 | \& // and in some piece of code that gets executed on any "activity": |
1266 | \& // and in some piece of code that gets executed on any "activity": |
911 | \& // reset the timeout to start ticking again at 10 seconds |
1267 | \& // reset the timeout to start ticking again at 10 seconds |
912 | \& ev_timer_again (&mytimer); |
1268 | \& ev_timer_again (&mytimer); |
913 | .Ve |
1269 | .Ve |
914 | .ie n .Sh """ev_periodic"" \- to cron or not to cron" |
1270 | .ie n .Sh """ev_periodic"" \- to cron or not to cron?" |
915 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron" |
1271 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" |
916 | .IX Subsection "ev_periodic - to cron or not to cron" |
1272 | .IX Subsection "ev_periodic - to cron or not to cron?" |
917 | Periodic watchers are also timers of a kind, but they are very versatile |
1273 | Periodic watchers are also timers of a kind, but they are very versatile |
918 | (and unfortunately a bit complex). |
1274 | (and unfortunately a bit complex). |
919 | .PP |
1275 | .PP |
920 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
1276 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
921 | but on wallclock time (absolute time). You can tell a periodic watcher |
1277 | but on wallclock time (absolute time). You can tell a periodic watcher |
922 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1278 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
923 | periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () |
1279 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
924 | + 10.>) and then reset your system clock to the last year, then it will |
1280 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
925 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1281 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
926 | roughly 10 seconds later and of course not if you reset your system time |
1282 | roughly 10 seconds later). |
927 | again). |
|
|
928 | .PP |
1283 | .PP |
929 | They can also be used to implement vastly more complex timers, such as |
1284 | They can also be used to implement vastly more complex timers, such as |
930 | triggering an event on eahc midnight, local time. |
1285 | triggering an event on each midnight, local time or other, complicated, |
|
|
1286 | rules. |
931 | .PP |
1287 | .PP |
932 | As with timers, the callback is guarenteed to be invoked only when the |
1288 | As with timers, the callback is guarenteed to be invoked only when the |
933 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1289 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
934 | during the same loop iteration then order of execution is undefined. |
1290 | during the same loop iteration then order of execution is undefined. |
|
|
1291 | .PP |
|
|
1292 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1293 | .IX Subsection "Watcher-Specific Functions and Data Members" |
935 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1294 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
936 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1295 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
937 | .PD 0 |
1296 | .PD 0 |
938 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1297 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
939 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1298 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
940 | .PD |
1299 | .PD |
941 | Lots of arguments, lets sort it out... There are basically three modes of |
1300 | Lots of arguments, lets sort it out... There are basically three modes of |
942 | operation, and we will explain them from simplest to complex: |
1301 | operation, and we will explain them from simplest to complex: |
943 | .RS 4 |
1302 | .RS 4 |
944 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
1303 | .IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 |
945 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
1304 | .IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" |
946 | In this configuration the watcher triggers an event at the wallclock time |
1305 | In this configuration the watcher triggers an event at the wallclock time |
947 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1306 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
948 | that is, if it is to be run at January 1st 2011 then it will run when the |
1307 | that is, if it is to be run at January 1st 2011 then it will run when the |
949 | system time reaches or surpasses this time. |
1308 | system time reaches or surpasses this time. |
950 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
1309 | .IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 |
951 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
1310 | .IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" |
952 | In this mode the watcher will always be scheduled to time out at the next |
1311 | In this mode the watcher will always be scheduled to time out at the next |
953 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
1312 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
954 | of any time jumps. |
1313 | and then repeat, regardless of any time jumps. |
955 | .Sp |
1314 | .Sp |
956 | This can be used to create timers that do not drift with respect to system |
1315 | This can be used to create timers that do not drift with respect to system |
957 | time: |
1316 | time: |
958 | .Sp |
1317 | .Sp |
959 | .Vb 1 |
1318 | .Vb 1 |
… | |
… | |
966 | by 3600. |
1325 | by 3600. |
967 | .Sp |
1326 | .Sp |
968 | Another way to think about it (for the mathematically inclined) is that |
1327 | Another way to think about it (for the mathematically inclined) is that |
969 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1328 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
970 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1329 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
|
|
1330 | .Sp |
|
|
1331 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
|
|
1332 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
1333 | this value. |
971 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
1334 | .IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 |
972 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
1335 | .IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" |
973 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1336 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
974 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1337 | ignored. Instead, each time the periodic watcher gets scheduled, the |
975 | reschedule callback will be called with the watcher as first, and the |
1338 | reschedule callback will be called with the watcher as first, and the |
976 | current time as second argument. |
1339 | current time as second argument. |
977 | .Sp |
1340 | .Sp |
978 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1341 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
979 | ever, or make any event loop modifications\fR. If you need to stop it, |
1342 | ever, or make any event loop modifications\fR. If you need to stop it, |
980 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1343 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
981 | starting a prepare watcher). |
1344 | starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). |
982 | .Sp |
1345 | .Sp |
983 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1346 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
984 | ev_tstamp now)\*(C'\fR, e.g.: |
1347 | ev_tstamp now)\*(C'\fR, e.g.: |
985 | .Sp |
1348 | .Sp |
986 | .Vb 4 |
1349 | .Vb 4 |
… | |
… | |
1010 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1373 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1011 | Simply stops and restarts the periodic watcher again. This is only useful |
1374 | Simply stops and restarts the periodic watcher again. This is only useful |
1012 | when you changed some parameters or the reschedule callback would return |
1375 | when you changed some parameters or the reschedule callback would return |
1013 | a different time than the last time it was called (e.g. in a crond like |
1376 | a different time than the last time it was called (e.g. in a crond like |
1014 | program when the crontabs have changed). |
1377 | program when the crontabs have changed). |
|
|
1378 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
1379 | .IX Item "ev_tstamp offset [read-write]" |
|
|
1380 | When repeating, this contains the offset value, otherwise this is the |
|
|
1381 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
|
|
1382 | .Sp |
|
|
1383 | Can be modified any time, but changes only take effect when the periodic |
|
|
1384 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
|
|
1385 | .IP "ev_tstamp interval [read\-write]" 4 |
|
|
1386 | .IX Item "ev_tstamp interval [read-write]" |
|
|
1387 | The current interval value. Can be modified any time, but changes only |
|
|
1388 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
|
|
1389 | called. |
|
|
1390 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
|
|
1391 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
|
|
1392 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
|
|
1393 | switched off. Can be changed any time, but changes only take effect when |
|
|
1394 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
|
|
1395 | .IP "ev_tstamp at [read\-only]" 4 |
|
|
1396 | .IX Item "ev_tstamp at [read-only]" |
|
|
1397 | When active, contains the absolute time that the watcher is supposed to |
|
|
1398 | trigger next. |
1015 | .PP |
1399 | .PP |
1016 | Example: call a callback every hour, or, more precisely, whenever the |
1400 | Example: Call a callback every hour, or, more precisely, whenever the |
1017 | system clock is divisible by 3600. The callback invocation times have |
1401 | system clock is divisible by 3600. The callback invocation times have |
1018 | potentially a lot of jittering, but good long-term stability. |
1402 | potentially a lot of jittering, but good long-term stability. |
1019 | .PP |
1403 | .PP |
1020 | .Vb 5 |
1404 | .Vb 5 |
1021 | \& static void |
1405 | \& static void |
… | |
… | |
1029 | \& struct ev_periodic hourly_tick; |
1413 | \& struct ev_periodic hourly_tick; |
1030 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1414 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1031 | \& ev_periodic_start (loop, &hourly_tick); |
1415 | \& ev_periodic_start (loop, &hourly_tick); |
1032 | .Ve |
1416 | .Ve |
1033 | .PP |
1417 | .PP |
1034 | Example: the same as above, but use a reschedule callback to do it: |
1418 | Example: The same as above, but use a reschedule callback to do it: |
1035 | .PP |
1419 | .PP |
1036 | .Vb 1 |
1420 | .Vb 1 |
1037 | \& #include <math.h> |
1421 | \& #include <math.h> |
1038 | .Ve |
1422 | .Ve |
1039 | .PP |
1423 | .PP |
… | |
… | |
1047 | .PP |
1431 | .PP |
1048 | .Vb 1 |
1432 | .Vb 1 |
1049 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1433 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1050 | .Ve |
1434 | .Ve |
1051 | .PP |
1435 | .PP |
1052 | Example: call a callback every hour, starting now: |
1436 | Example: Call a callback every hour, starting now: |
1053 | .PP |
1437 | .PP |
1054 | .Vb 4 |
1438 | .Vb 4 |
1055 | \& struct ev_periodic hourly_tick; |
1439 | \& struct ev_periodic hourly_tick; |
1056 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1440 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1057 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1441 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1058 | \& ev_periodic_start (loop, &hourly_tick); |
1442 | \& ev_periodic_start (loop, &hourly_tick); |
1059 | .Ve |
1443 | .Ve |
1060 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled" |
1444 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" |
1061 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled" |
1445 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" |
1062 | .IX Subsection "ev_signal - signal me when a signal gets signalled" |
1446 | .IX Subsection "ev_signal - signal me when a signal gets signalled!" |
1063 | Signal watchers will trigger an event when the process receives a specific |
1447 | Signal watchers will trigger an event when the process receives a specific |
1064 | signal one or more times. Even though signals are very asynchronous, libev |
1448 | signal one or more times. Even though signals are very asynchronous, libev |
1065 | will try it's best to deliver signals synchronously, i.e. as part of the |
1449 | will try it's best to deliver signals synchronously, i.e. as part of the |
1066 | normal event processing, like any other event. |
1450 | normal event processing, like any other event. |
1067 | .PP |
1451 | .PP |
… | |
… | |
1069 | first watcher gets started will libev actually register a signal watcher |
1453 | first watcher gets started will libev actually register a signal watcher |
1070 | with the kernel (thus it coexists with your own signal handlers as long |
1454 | with the kernel (thus it coexists with your own signal handlers as long |
1071 | as you don't register any with libev). Similarly, when the last signal |
1455 | as you don't register any with libev). Similarly, when the last signal |
1072 | watcher for a signal is stopped libev will reset the signal handler to |
1456 | watcher for a signal is stopped libev will reset the signal handler to |
1073 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
1457 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
|
|
1458 | .PP |
|
|
1459 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1460 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1074 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1461 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1075 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1462 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1076 | .PD 0 |
1463 | .PD 0 |
1077 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1464 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1078 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1465 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1079 | .PD |
1466 | .PD |
1080 | Configures the watcher to trigger on the given signal number (usually one |
1467 | Configures the watcher to trigger on the given signal number (usually one |
1081 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
1468 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
|
|
1469 | .IP "int signum [read\-only]" 4 |
|
|
1470 | .IX Item "int signum [read-only]" |
|
|
1471 | The signal the watcher watches out for. |
1082 | .ie n .Sh """ev_child"" \- wait for pid status changes" |
1472 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1083 | .el .Sh "\f(CWev_child\fP \- wait for pid status changes" |
1473 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1084 | .IX Subsection "ev_child - wait for pid status changes" |
1474 | .IX Subsection "ev_child - watch out for process status changes" |
1085 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1475 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1086 | some child status changes (most typically when a child of yours dies). |
1476 | some child status changes (most typically when a child of yours dies). |
|
|
1477 | .PP |
|
|
1478 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1479 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1087 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1480 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1088 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1481 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1089 | .PD 0 |
1482 | .PD 0 |
1090 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1483 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1091 | .IX Item "ev_child_set (ev_child *, int pid)" |
1484 | .IX Item "ev_child_set (ev_child *, int pid)" |
… | |
… | |
1094 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
1487 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
1095 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
1488 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
1096 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
1489 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
1097 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
1490 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
1098 | process causing the status change. |
1491 | process causing the status change. |
|
|
1492 | .IP "int pid [read\-only]" 4 |
|
|
1493 | .IX Item "int pid [read-only]" |
|
|
1494 | The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. |
|
|
1495 | .IP "int rpid [read\-write]" 4 |
|
|
1496 | .IX Item "int rpid [read-write]" |
|
|
1497 | The process id that detected a status change. |
|
|
1498 | .IP "int rstatus [read\-write]" 4 |
|
|
1499 | .IX Item "int rstatus [read-write]" |
|
|
1500 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
|
|
1501 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1099 | .PP |
1502 | .PP |
1100 | Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1503 | Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1101 | .PP |
1504 | .PP |
1102 | .Vb 5 |
1505 | .Vb 5 |
1103 | \& static void |
1506 | \& static void |
1104 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1507 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1105 | \& { |
1508 | \& { |
… | |
… | |
1110 | .Vb 3 |
1513 | .Vb 3 |
1111 | \& struct ev_signal signal_watcher; |
1514 | \& struct ev_signal signal_watcher; |
1112 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1515 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1113 | \& ev_signal_start (loop, &sigint_cb); |
1516 | \& ev_signal_start (loop, &sigint_cb); |
1114 | .Ve |
1517 | .Ve |
|
|
1518 | .ie n .Sh """ev_stat"" \- did the file attributes just change?" |
|
|
1519 | .el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" |
|
|
1520 | .IX Subsection "ev_stat - did the file attributes just change?" |
|
|
1521 | This watches a filesystem path for attribute changes. That is, it calls |
|
|
1522 | \&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed |
|
|
1523 | compared to the last time, invoking the callback if it did. |
|
|
1524 | .PP |
|
|
1525 | The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does |
|
|
1526 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
|
|
1527 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
|
|
1528 | otherwise always forced to be at least one) and all the other fields of |
|
|
1529 | the stat buffer having unspecified contents. |
|
|
1530 | .PP |
|
|
1531 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
|
|
1532 | relative and your working directory changes, the behaviour is undefined. |
|
|
1533 | .PP |
|
|
1534 | Since there is no standard to do this, the portable implementation simply |
|
|
1535 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
|
|
1536 | can specify a recommended polling interval for this case. If you specify |
|
|
1537 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
|
|
1538 | unspecified default\fR value will be used (which you can expect to be around |
|
|
1539 | five seconds, although this might change dynamically). Libev will also |
|
|
1540 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
|
|
1541 | usually overkill. |
|
|
1542 | .PP |
|
|
1543 | This watcher type is not meant for massive numbers of stat watchers, |
|
|
1544 | as even with OS-supported change notifications, this can be |
|
|
1545 | resource\-intensive. |
|
|
1546 | .PP |
|
|
1547 | At the time of this writing, only the Linux inotify interface is |
|
|
1548 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1549 | reader). Inotify will be used to give hints only and should not change the |
|
|
1550 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
|
|
1551 | to fall back to regular polling again even with inotify, but changes are |
|
|
1552 | usually detected immediately, and if the file exists there will be no |
|
|
1553 | polling. |
|
|
1554 | .PP |
|
|
1555 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1556 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
1557 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
|
|
1558 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
|
|
1559 | .PD 0 |
|
|
1560 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
|
|
1561 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
|
|
1562 | .PD |
|
|
1563 | Configures the watcher to wait for status changes of the given |
|
|
1564 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
|
|
1565 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
|
|
1566 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
|
|
1567 | path for as long as the watcher is active. |
|
|
1568 | .Sp |
|
|
1569 | The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, |
|
|
1570 | relative to the attributes at the time the watcher was started (or the |
|
|
1571 | last change was detected). |
|
|
1572 | .IP "ev_stat_stat (ev_stat *)" 4 |
|
|
1573 | .IX Item "ev_stat_stat (ev_stat *)" |
|
|
1574 | Updates the stat buffer immediately with new values. If you change the |
|
|
1575 | watched path in your callback, you could call this fucntion to avoid |
|
|
1576 | detecting this change (while introducing a race condition). Can also be |
|
|
1577 | useful simply to find out the new values. |
|
|
1578 | .IP "ev_statdata attr [read\-only]" 4 |
|
|
1579 | .IX Item "ev_statdata attr [read-only]" |
|
|
1580 | The most-recently detected attributes of the file. Although the type is of |
|
|
1581 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
|
|
1582 | suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there |
|
|
1583 | was some error while \f(CW\*(C`stat\*(C'\fRing the file. |
|
|
1584 | .IP "ev_statdata prev [read\-only]" 4 |
|
|
1585 | .IX Item "ev_statdata prev [read-only]" |
|
|
1586 | The previous attributes of the file. The callback gets invoked whenever |
|
|
1587 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. |
|
|
1588 | .IP "ev_tstamp interval [read\-only]" 4 |
|
|
1589 | .IX Item "ev_tstamp interval [read-only]" |
|
|
1590 | The specified interval. |
|
|
1591 | .IP "const char *path [read\-only]" 4 |
|
|
1592 | .IX Item "const char *path [read-only]" |
|
|
1593 | The filesystem path that is being watched. |
|
|
1594 | .PP |
|
|
1595 | Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. |
|
|
1596 | .PP |
|
|
1597 | .Vb 15 |
|
|
1598 | \& static void |
|
|
1599 | \& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
|
|
1600 | \& { |
|
|
1601 | \& /* /etc/passwd changed in some way */ |
|
|
1602 | \& if (w->attr.st_nlink) |
|
|
1603 | \& { |
|
|
1604 | \& printf ("passwd current size %ld\en", (long)w->attr.st_size); |
|
|
1605 | \& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); |
|
|
1606 | \& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); |
|
|
1607 | \& } |
|
|
1608 | \& else |
|
|
1609 | \& /* you shalt not abuse printf for puts */ |
|
|
1610 | \& puts ("wow, /etc/passwd is not there, expect problems. " |
|
|
1611 | \& "if this is windows, they already arrived\en"); |
|
|
1612 | \& } |
|
|
1613 | .Ve |
|
|
1614 | .PP |
|
|
1615 | .Vb 2 |
|
|
1616 | \& ... |
|
|
1617 | \& ev_stat passwd; |
|
|
1618 | .Ve |
|
|
1619 | .PP |
|
|
1620 | .Vb 2 |
|
|
1621 | \& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
|
|
1622 | \& ev_stat_start (loop, &passwd); |
|
|
1623 | .Ve |
1115 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do" |
1624 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1116 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do" |
1625 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1117 | .IX Subsection "ev_idle - when you've got nothing better to do" |
1626 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1118 | Idle watchers trigger events when there are no other events are pending |
1627 | Idle watchers trigger events when no other events of the same or higher |
1119 | (prepare, check and other idle watchers do not count). That is, as long |
1628 | priority are pending (prepare, check and other idle watchers do not |
1120 | as your process is busy handling sockets or timeouts (or even signals, |
1629 | count). |
1121 | imagine) it will not be triggered. But when your process is idle all idle |
1630 | .PP |
1122 | watchers are being called again and again, once per event loop iteration \- |
1631 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1632 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1633 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1634 | are pending), the idle watchers are being called once per event loop |
1123 | until stopped, that is, or your process receives more events and becomes |
1635 | iteration \- until stopped, that is, or your process receives more events |
1124 | busy. |
1636 | and becomes busy again with higher priority stuff. |
1125 | .PP |
1637 | .PP |
1126 | The most noteworthy effect is that as long as any idle watchers are |
1638 | The most noteworthy effect is that as long as any idle watchers are |
1127 | active, the process will not block when waiting for new events. |
1639 | active, the process will not block when waiting for new events. |
1128 | .PP |
1640 | .PP |
1129 | Apart from keeping your process non-blocking (which is a useful |
1641 | Apart from keeping your process non-blocking (which is a useful |
1130 | effect on its own sometimes), idle watchers are a good place to do |
1642 | effect on its own sometimes), idle watchers are a good place to do |
1131 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1643 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1132 | event loop has handled all outstanding events. |
1644 | event loop has handled all outstanding events. |
|
|
1645 | .PP |
|
|
1646 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1647 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1133 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1648 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1134 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1649 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1135 | Initialises and configures the idle watcher \- it has no parameters of any |
1650 | Initialises and configures the idle watcher \- it has no parameters of any |
1136 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1651 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1137 | believe me. |
1652 | believe me. |
1138 | .PP |
1653 | .PP |
1139 | Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the |
1654 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
1140 | callback, free it. Alos, use no error checking, as usual. |
1655 | callback, free it. Also, use no error checking, as usual. |
1141 | .PP |
1656 | .PP |
1142 | .Vb 7 |
1657 | .Vb 7 |
1143 | \& static void |
1658 | \& static void |
1144 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1659 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1145 | \& { |
1660 | \& { |
… | |
… | |
1152 | .Vb 3 |
1667 | .Vb 3 |
1153 | \& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1668 | \& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1154 | \& ev_idle_init (idle_watcher, idle_cb); |
1669 | \& ev_idle_init (idle_watcher, idle_cb); |
1155 | \& ev_idle_start (loop, idle_cb); |
1670 | \& ev_idle_start (loop, idle_cb); |
1156 | .Ve |
1671 | .Ve |
1157 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop" |
1672 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" |
1158 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop" |
1673 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" |
1159 | .IX Subsection "ev_prepare and ev_check - customise your event loop" |
1674 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
1160 | Prepare and check watchers are usually (but not always) used in tandem: |
1675 | Prepare and check watchers are usually (but not always) used in tandem: |
1161 | prepare watchers get invoked before the process blocks and check watchers |
1676 | prepare watchers get invoked before the process blocks and check watchers |
1162 | afterwards. |
1677 | afterwards. |
1163 | .PP |
1678 | .PP |
|
|
1679 | You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter |
|
|
1680 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
|
|
1681 | watchers. Other loops than the current one are fine, however. The |
|
|
1682 | rationale behind this is that you do not need to check for recursion in |
|
|
1683 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
|
|
1684 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
|
|
1685 | called in pairs bracketing the blocking call. |
|
|
1686 | .PP |
1164 | Their main purpose is to integrate other event mechanisms into libev. This |
1687 | Their main purpose is to integrate other event mechanisms into libev and |
1165 | could be used, for example, to track variable changes, implement your own |
1688 | their use is somewhat advanced. This could be used, for example, to track |
1166 | watchers, integrate net-snmp or a coroutine library and lots more. |
1689 | variable changes, implement your own watchers, integrate net-snmp or a |
|
|
1690 | coroutine library and lots more. They are also occasionally useful if |
|
|
1691 | you cache some data and want to flush it before blocking (for example, |
|
|
1692 | in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR |
|
|
1693 | watcher). |
1167 | .PP |
1694 | .PP |
1168 | This is done by examining in each prepare call which file descriptors need |
1695 | This is done by examining in each prepare call which file descriptors need |
1169 | to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for |
1696 | to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for |
1170 | them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries |
1697 | them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries |
1171 | provide just this functionality). Then, in the check watcher you check for |
1698 | provide just this functionality). Then, in the check watcher you check for |
… | |
… | |
1180 | are ready to run (it's actually more complicated: it only runs coroutines |
1707 | are ready to run (it's actually more complicated: it only runs coroutines |
1181 | with priority higher than or equal to the event loop and one coroutine |
1708 | with priority higher than or equal to the event loop and one coroutine |
1182 | of lower priority, but only once, using idle watchers to keep the event |
1709 | of lower priority, but only once, using idle watchers to keep the event |
1183 | loop from blocking if lower-priority coroutines are active, thus mapping |
1710 | loop from blocking if lower-priority coroutines are active, thus mapping |
1184 | low-priority coroutines to idle/background tasks). |
1711 | low-priority coroutines to idle/background tasks). |
|
|
1712 | .PP |
|
|
1713 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
1714 | priority, to ensure that they are being run before any other watchers |
|
|
1715 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
|
|
1716 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
|
|
1717 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did |
|
|
1718 | their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event |
|
|
1719 | loops those other event loops might be in an unusable state until their |
|
|
1720 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
|
|
1721 | others). |
|
|
1722 | .PP |
|
|
1723 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1724 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1185 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1725 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1186 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1726 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1187 | .PD 0 |
1727 | .PD 0 |
1188 | .IP "ev_check_init (ev_check *, callback)" 4 |
1728 | .IP "ev_check_init (ev_check *, callback)" 4 |
1189 | .IX Item "ev_check_init (ev_check *, callback)" |
1729 | .IX Item "ev_check_init (ev_check *, callback)" |
1190 | .PD |
1730 | .PD |
1191 | Initialises and configures the prepare or check watcher \- they have no |
1731 | Initialises and configures the prepare or check watcher \- they have no |
1192 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1732 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1193 | macros, but using them is utterly, utterly and completely pointless. |
1733 | macros, but using them is utterly, utterly and completely pointless. |
1194 | .PP |
1734 | .PP |
1195 | Example: *TODO*. |
1735 | There are a number of principal ways to embed other event loops or modules |
|
|
1736 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1737 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
1738 | use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR |
|
|
1739 | embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 |
|
|
1740 | into the Glib event loop). |
|
|
1741 | .PP |
|
|
1742 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
|
|
1743 | and in a check watcher, destroy them and call into libadns. What follows |
|
|
1744 | is pseudo-code only of course. This requires you to either use a low |
|
|
1745 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
1746 | the callbacks for the IO/timeout watchers might not have been called yet. |
|
|
1747 | .PP |
|
|
1748 | .Vb 2 |
|
|
1749 | \& static ev_io iow [nfd]; |
|
|
1750 | \& static ev_timer tw; |
|
|
1751 | .Ve |
|
|
1752 | .PP |
|
|
1753 | .Vb 4 |
|
|
1754 | \& static void |
|
|
1755 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
|
|
1756 | \& { |
|
|
1757 | \& } |
|
|
1758 | .Ve |
|
|
1759 | .PP |
|
|
1760 | .Vb 8 |
|
|
1761 | \& // create io watchers for each fd and a timer before blocking |
|
|
1762 | \& static void |
|
|
1763 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
|
|
1764 | \& { |
|
|
1765 | \& int timeout = 3600000; |
|
|
1766 | \& struct pollfd fds [nfd]; |
|
|
1767 | \& // actual code will need to loop here and realloc etc. |
|
|
1768 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
|
|
1769 | .Ve |
|
|
1770 | .PP |
|
|
1771 | .Vb 3 |
|
|
1772 | \& /* the callback is illegal, but won't be called as we stop during check */ |
|
|
1773 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
|
|
1774 | \& ev_timer_start (loop, &tw); |
|
|
1775 | .Ve |
|
|
1776 | .PP |
|
|
1777 | .Vb 6 |
|
|
1778 | \& // create one ev_io per pollfd |
|
|
1779 | \& for (int i = 0; i < nfd; ++i) |
|
|
1780 | \& { |
|
|
1781 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
|
|
1782 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
|
|
1783 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
|
|
1784 | .Ve |
|
|
1785 | .PP |
|
|
1786 | .Vb 4 |
|
|
1787 | \& fds [i].revents = 0; |
|
|
1788 | \& ev_io_start (loop, iow + i); |
|
|
1789 | \& } |
|
|
1790 | \& } |
|
|
1791 | .Ve |
|
|
1792 | .PP |
|
|
1793 | .Vb 5 |
|
|
1794 | \& // stop all watchers after blocking |
|
|
1795 | \& static void |
|
|
1796 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
|
|
1797 | \& { |
|
|
1798 | \& ev_timer_stop (loop, &tw); |
|
|
1799 | .Ve |
|
|
1800 | .PP |
|
|
1801 | .Vb 8 |
|
|
1802 | \& for (int i = 0; i < nfd; ++i) |
|
|
1803 | \& { |
|
|
1804 | \& // set the relevant poll flags |
|
|
1805 | \& // could also call adns_processreadable etc. here |
|
|
1806 | \& struct pollfd *fd = fds + i; |
|
|
1807 | \& int revents = ev_clear_pending (iow + i); |
|
|
1808 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1809 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1810 | .Ve |
|
|
1811 | .PP |
|
|
1812 | .Vb 3 |
|
|
1813 | \& // now stop the watcher |
|
|
1814 | \& ev_io_stop (loop, iow + i); |
|
|
1815 | \& } |
|
|
1816 | .Ve |
|
|
1817 | .PP |
|
|
1818 | .Vb 2 |
|
|
1819 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1820 | \& } |
|
|
1821 | .Ve |
|
|
1822 | .PP |
|
|
1823 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
1824 | in the prepare watcher and would dispose of the check watcher. |
|
|
1825 | .PP |
|
|
1826 | Method 3: If the module to be embedded supports explicit event |
|
|
1827 | notification (adns does), you can also make use of the actual watcher |
|
|
1828 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1829 | .PP |
|
|
1830 | .Vb 5 |
|
|
1831 | \& static void |
|
|
1832 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1833 | \& { |
|
|
1834 | \& adns_state ads = (adns_state)w->data; |
|
|
1835 | \& update_now (EV_A); |
|
|
1836 | .Ve |
|
|
1837 | .PP |
|
|
1838 | .Vb 2 |
|
|
1839 | \& adns_processtimeouts (ads, &tv_now); |
|
|
1840 | \& } |
|
|
1841 | .Ve |
|
|
1842 | .PP |
|
|
1843 | .Vb 5 |
|
|
1844 | \& static void |
|
|
1845 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
1846 | \& { |
|
|
1847 | \& adns_state ads = (adns_state)w->data; |
|
|
1848 | \& update_now (EV_A); |
|
|
1849 | .Ve |
|
|
1850 | .PP |
|
|
1851 | .Vb 3 |
|
|
1852 | \& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1853 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1854 | \& } |
|
|
1855 | .Ve |
|
|
1856 | .PP |
|
|
1857 | .Vb 1 |
|
|
1858 | \& // do not ever call adns_afterpoll |
|
|
1859 | .Ve |
|
|
1860 | .PP |
|
|
1861 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1862 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1863 | their poll function. The drawback with this solution is that the main |
|
|
1864 | loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does |
|
|
1865 | this. |
|
|
1866 | .PP |
|
|
1867 | .Vb 4 |
|
|
1868 | \& static gint |
|
|
1869 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1870 | \& { |
|
|
1871 | \& int got_events = 0; |
|
|
1872 | .Ve |
|
|
1873 | .PP |
|
|
1874 | .Vb 2 |
|
|
1875 | \& for (n = 0; n < nfds; ++n) |
|
|
1876 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1877 | .Ve |
|
|
1878 | .PP |
|
|
1879 | .Vb 2 |
|
|
1880 | \& if (timeout >= 0) |
|
|
1881 | \& // create/start timer |
|
|
1882 | .Ve |
|
|
1883 | .PP |
|
|
1884 | .Vb 2 |
|
|
1885 | \& // poll |
|
|
1886 | \& ev_loop (EV_A_ 0); |
|
|
1887 | .Ve |
|
|
1888 | .PP |
|
|
1889 | .Vb 3 |
|
|
1890 | \& // stop timer again |
|
|
1891 | \& if (timeout >= 0) |
|
|
1892 | \& ev_timer_stop (EV_A_ &to); |
|
|
1893 | .Ve |
|
|
1894 | .PP |
|
|
1895 | .Vb 3 |
|
|
1896 | \& // stop io watchers again - their callbacks should have set |
|
|
1897 | \& for (n = 0; n < nfds; ++n) |
|
|
1898 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
1899 | .Ve |
|
|
1900 | .PP |
|
|
1901 | .Vb 2 |
|
|
1902 | \& return got_events; |
|
|
1903 | \& } |
|
|
1904 | .Ve |
|
|
1905 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
|
|
1906 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
|
|
1907 | .IX Subsection "ev_embed - when one backend isn't enough..." |
|
|
1908 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
1909 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
|
|
1910 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
1911 | fashion and must not be used). |
|
|
1912 | .PP |
|
|
1913 | There are primarily two reasons you would want that: work around bugs and |
|
|
1914 | prioritise I/O. |
|
|
1915 | .PP |
|
|
1916 | As an example for a bug workaround, the kqueue backend might only support |
|
|
1917 | sockets on some platform, so it is unusable as generic backend, but you |
|
|
1918 | still want to make use of it because you have many sockets and it scales |
|
|
1919 | so nicely. In this case, you would create a kqueue-based loop and embed it |
|
|
1920 | into your default loop (which might use e.g. poll). Overall operation will |
|
|
1921 | be a bit slower because first libev has to poll and then call kevent, but |
|
|
1922 | at least you can use both at what they are best. |
|
|
1923 | .PP |
|
|
1924 | As for prioritising I/O: rarely you have the case where some fds have |
|
|
1925 | to be watched and handled very quickly (with low latency), and even |
|
|
1926 | priorities and idle watchers might have too much overhead. In this case |
|
|
1927 | you would put all the high priority stuff in one loop and all the rest in |
|
|
1928 | a second one, and embed the second one in the first. |
|
|
1929 | .PP |
|
|
1930 | As long as the watcher is active, the callback will be invoked every time |
|
|
1931 | there might be events pending in the embedded loop. The callback must then |
|
|
1932 | call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke |
|
|
1933 | their callbacks (you could also start an idle watcher to give the embedded |
|
|
1934 | loop strictly lower priority for example). You can also set the callback |
|
|
1935 | to \f(CW0\fR, in which case the embed watcher will automatically execute the |
|
|
1936 | embedded loop sweep. |
|
|
1937 | .PP |
|
|
1938 | As long as the watcher is started it will automatically handle events. The |
|
|
1939 | callback will be invoked whenever some events have been handled. You can |
|
|
1940 | set the callback to \f(CW0\fR to avoid having to specify one if you are not |
|
|
1941 | interested in that. |
|
|
1942 | .PP |
|
|
1943 | Also, there have not currently been made special provisions for forking: |
|
|
1944 | when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, |
|
|
1945 | but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers |
|
|
1946 | yourself. |
|
|
1947 | .PP |
|
|
1948 | Unfortunately, not all backends are embeddable, only the ones returned by |
|
|
1949 | \&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any |
|
|
1950 | portable one. |
|
|
1951 | .PP |
|
|
1952 | So when you want to use this feature you will always have to be prepared |
|
|
1953 | that you cannot get an embeddable loop. The recommended way to get around |
|
|
1954 | this is to have a separate variables for your embeddable loop, try to |
|
|
1955 | create it, and if that fails, use the normal loop for everything: |
|
|
1956 | .PP |
|
|
1957 | .Vb 3 |
|
|
1958 | \& struct ev_loop *loop_hi = ev_default_init (0); |
|
|
1959 | \& struct ev_loop *loop_lo = 0; |
|
|
1960 | \& struct ev_embed embed; |
|
|
1961 | .Ve |
|
|
1962 | .PP |
|
|
1963 | .Vb 5 |
|
|
1964 | \& // see if there is a chance of getting one that works |
|
|
1965 | \& // (remember that a flags value of 0 means autodetection) |
|
|
1966 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
|
|
1967 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
|
|
1968 | \& : 0; |
|
|
1969 | .Ve |
|
|
1970 | .PP |
|
|
1971 | .Vb 8 |
|
|
1972 | \& // if we got one, then embed it, otherwise default to loop_hi |
|
|
1973 | \& if (loop_lo) |
|
|
1974 | \& { |
|
|
1975 | \& ev_embed_init (&embed, 0, loop_lo); |
|
|
1976 | \& ev_embed_start (loop_hi, &embed); |
|
|
1977 | \& } |
|
|
1978 | \& else |
|
|
1979 | \& loop_lo = loop_hi; |
|
|
1980 | .Ve |
|
|
1981 | .PP |
|
|
1982 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1983 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
1984 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
|
|
1985 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
|
|
1986 | .PD 0 |
|
|
1987 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
|
|
1988 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
|
|
1989 | .PD |
|
|
1990 | Configures the watcher to embed the given loop, which must be |
|
|
1991 | embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be |
|
|
1992 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1993 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1994 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1995 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
|
|
1996 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
|
|
1997 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1998 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
|
|
1999 | apropriate way for embedded loops. |
|
|
2000 | .IP "struct ev_loop *loop [read\-only]" 4 |
|
|
2001 | .IX Item "struct ev_loop *loop [read-only]" |
|
|
2002 | The embedded event loop. |
|
|
2003 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
|
|
2004 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
|
|
2005 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
|
|
2006 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
|
|
2007 | whoever is a good citizen cared to tell libev about it by calling |
|
|
2008 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
|
|
2009 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
|
|
2010 | and only in the child after the fork. If whoever good citizen calling |
|
|
2011 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
|
|
2012 | handlers will be invoked, too, of course. |
|
|
2013 | .PP |
|
|
2014 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2015 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
2016 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
|
|
2017 | .IX Item "ev_fork_init (ev_signal *, callback)" |
|
|
2018 | Initialises and configures the fork watcher \- it has no parameters of any |
|
|
2019 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
|
|
2020 | believe me. |
1196 | .SH "OTHER FUNCTIONS" |
2021 | .SH "OTHER FUNCTIONS" |
1197 | .IX Header "OTHER FUNCTIONS" |
2022 | .IX Header "OTHER FUNCTIONS" |
1198 | There are some other functions of possible interest. Described. Here. Now. |
2023 | There are some other functions of possible interest. Described. Here. Now. |
1199 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
2024 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
1200 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
2025 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
… | |
… | |
1229 | .Ve |
2054 | .Ve |
1230 | .Sp |
2055 | .Sp |
1231 | .Vb 1 |
2056 | .Vb 1 |
1232 | \& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2057 | \& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
1233 | .Ve |
2058 | .Ve |
1234 | .IP "ev_feed_event (loop, watcher, int events)" 4 |
2059 | .IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 |
1235 | .IX Item "ev_feed_event (loop, watcher, int events)" |
2060 | .IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" |
1236 | Feeds the given event set into the event loop, as if the specified event |
2061 | Feeds the given event set into the event loop, as if the specified event |
1237 | had happened for the specified watcher (which must be a pointer to an |
2062 | had happened for the specified watcher (which must be a pointer to an |
1238 | initialised but not necessarily started event watcher). |
2063 | initialised but not necessarily started event watcher). |
1239 | .IP "ev_feed_fd_event (loop, int fd, int revents)" 4 |
2064 | .IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 |
1240 | .IX Item "ev_feed_fd_event (loop, int fd, int revents)" |
2065 | .IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" |
1241 | Feed an event on the given fd, as if a file descriptor backend detected |
2066 | Feed an event on the given fd, as if a file descriptor backend detected |
1242 | the given events it. |
2067 | the given events it. |
1243 | .IP "ev_feed_signal_event (loop, int signum)" 4 |
2068 | .IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 |
1244 | .IX Item "ev_feed_signal_event (loop, int signum)" |
2069 | .IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" |
1245 | Feed an event as if the given signal occured (loop must be the default loop!). |
2070 | Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default |
|
|
2071 | loop!). |
1246 | .SH "LIBEVENT EMULATION" |
2072 | .SH "LIBEVENT EMULATION" |
1247 | .IX Header "LIBEVENT EMULATION" |
2073 | .IX Header "LIBEVENT EMULATION" |
1248 | Libev offers a compatibility emulation layer for libevent. It cannot |
2074 | Libev offers a compatibility emulation layer for libevent. It cannot |
1249 | emulate the internals of libevent, so here are some usage hints: |
2075 | emulate the internals of libevent, so here are some usage hints: |
1250 | .IP "* Use it by including <event.h>, as usual." 4 |
2076 | .IP "* Use it by including <event.h>, as usual." 4 |
… | |
… | |
1261 | .IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 |
2087 | .IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 |
1262 | .IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." |
2088 | .IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." |
1263 | .PD |
2089 | .PD |
1264 | .SH "\*(C+ SUPPORT" |
2090 | .SH "\*(C+ SUPPORT" |
1265 | .IX Header " SUPPORT" |
2091 | .IX Header " SUPPORT" |
1266 | \&\s-1TBD\s0. |
2092 | Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow |
|
|
2093 | you to use some convinience methods to start/stop watchers and also change |
|
|
2094 | the callback model to a model using method callbacks on objects. |
|
|
2095 | .PP |
|
|
2096 | To use it, |
|
|
2097 | .PP |
|
|
2098 | .Vb 1 |
|
|
2099 | \& #include <ev++.h> |
|
|
2100 | .Ve |
|
|
2101 | .PP |
|
|
2102 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
|
|
2103 | of them macros) into the global namespace. All \*(C+ specific things are |
|
|
2104 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
2105 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
|
|
2106 | .PP |
|
|
2107 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
|
|
2108 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
2109 | that the watcher is associated with (or no additional members at all if |
|
|
2110 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
2111 | .PP |
|
|
2112 | Currently, functions, and static and non-static member functions can be |
|
|
2113 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2114 | need one additional pointer for context. If you need support for other |
|
|
2115 | types of functors please contact the author (preferably after implementing |
|
|
2116 | it). |
|
|
2117 | .PP |
|
|
2118 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
|
|
2119 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
|
|
2120 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
|
|
2121 | .IX Item "ev::READ, ev::WRITE etc." |
|
|
2122 | These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. |
|
|
2123 | macros from \fIev.h\fR. |
|
|
2124 | .ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 |
|
|
2125 | .el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 |
|
|
2126 | .IX Item "ev::tstamp, ev::now" |
|
|
2127 | Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. |
|
|
2128 | .ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4 |
|
|
2129 | .el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 |
|
|
2130 | .IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." |
|
|
2131 | For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of |
|
|
2132 | the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR |
|
|
2133 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
|
|
2134 | defines by many implementations. |
|
|
2135 | .Sp |
|
|
2136 | All of those classes have these methods: |
|
|
2137 | .RS 4 |
|
|
2138 | .IP "ev::TYPE::TYPE ()" 4 |
|
|
2139 | .IX Item "ev::TYPE::TYPE ()" |
|
|
2140 | .PD 0 |
|
|
2141 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
|
|
2142 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
|
|
2143 | .IP "ev::TYPE::~TYPE" 4 |
|
|
2144 | .IX Item "ev::TYPE::~TYPE" |
|
|
2145 | .PD |
|
|
2146 | The constructor (optionally) takes an event loop to associate the watcher |
|
|
2147 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
|
|
2148 | .Sp |
|
|
2149 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
|
|
2150 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
2151 | .Sp |
|
|
2152 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
2153 | method to set a callback before you can start the watcher. |
|
|
2154 | .Sp |
|
|
2155 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
2156 | not allow explicit template arguments for constructors). |
|
|
2157 | .Sp |
|
|
2158 | The destructor automatically stops the watcher if it is active. |
|
|
2159 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
2160 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
2161 | This method sets the callback method to call. The method has to have a |
|
|
2162 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
2163 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
2164 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
2165 | .Sp |
|
|
2166 | This method synthesizes efficient thunking code to call your method from |
|
|
2167 | the C callback that libev requires. If your compiler can inline your |
|
|
2168 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
2169 | your compiler is good :), then the method will be fully inlined into the |
|
|
2170 | thunking function, making it as fast as a direct C callback. |
|
|
2171 | .Sp |
|
|
2172 | Example: simple class declaration and watcher initialisation |
|
|
2173 | .Sp |
|
|
2174 | .Vb 4 |
|
|
2175 | \& struct myclass |
|
|
2176 | \& { |
|
|
2177 | \& void io_cb (ev::io &w, int revents) { } |
|
|
2178 | \& } |
|
|
2179 | .Ve |
|
|
2180 | .Sp |
|
|
2181 | .Vb 3 |
|
|
2182 | \& myclass obj; |
|
|
2183 | \& ev::io iow; |
|
|
2184 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
2185 | .Ve |
|
|
2186 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
2187 | .IX Item "w->set<function> (void *data = 0)" |
|
|
2188 | Also sets a callback, but uses a static method or plain function as |
|
|
2189 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
2190 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
2191 | .Sp |
|
|
2192 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
2193 | .Sp |
|
|
2194 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
2195 | .Sp |
|
|
2196 | Example: |
|
|
2197 | .Sp |
|
|
2198 | .Vb 2 |
|
|
2199 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
2200 | \& iow.set <io_cb> (); |
|
|
2201 | .Ve |
|
|
2202 | .IP "w\->set (struct ev_loop *)" 4 |
|
|
2203 | .IX Item "w->set (struct ev_loop *)" |
|
|
2204 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
|
|
2205 | do this when the watcher is inactive (and not pending either). |
|
|
2206 | .IP "w\->set ([args])" 4 |
|
|
2207 | .IX Item "w->set ([args])" |
|
|
2208 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
|
|
2209 | called at least once. Unlike the C counterpart, an active watcher gets |
|
|
2210 | automatically stopped and restarted when reconfiguring it with this |
|
|
2211 | method. |
|
|
2212 | .IP "w\->start ()" 4 |
|
|
2213 | .IX Item "w->start ()" |
|
|
2214 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
|
|
2215 | constructor already stores the event loop. |
|
|
2216 | .IP "w\->stop ()" 4 |
|
|
2217 | .IX Item "w->stop ()" |
|
|
2218 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
|
|
2219 | .ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 |
|
|
2220 | .el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 |
|
|
2221 | .IX Item "w->again () (ev::timer, ev::periodic only)" |
|
|
2222 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
|
|
2223 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
|
|
2224 | .ie n .IP "w\->sweep () (""ev::embed"" only)" 4 |
|
|
2225 | .el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 |
|
|
2226 | .IX Item "w->sweep () (ev::embed only)" |
|
|
2227 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
|
|
2228 | .ie n .IP "w\->update () (""ev::stat"" only)" 4 |
|
|
2229 | .el .IP "w\->update () (\f(CWev::stat\fR only)" 4 |
|
|
2230 | .IX Item "w->update () (ev::stat only)" |
|
|
2231 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
|
|
2232 | .RE |
|
|
2233 | .RS 4 |
|
|
2234 | .RE |
|
|
2235 | .PP |
|
|
2236 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
|
|
2237 | the constructor. |
|
|
2238 | .PP |
|
|
2239 | .Vb 4 |
|
|
2240 | \& class myclass |
|
|
2241 | \& { |
|
|
2242 | \& ev_io io; void io_cb (ev::io &w, int revents); |
|
|
2243 | \& ev_idle idle void idle_cb (ev::idle &w, int revents); |
|
|
2244 | .Ve |
|
|
2245 | .PP |
|
|
2246 | .Vb 2 |
|
|
2247 | \& myclass (); |
|
|
2248 | \& } |
|
|
2249 | .Ve |
|
|
2250 | .PP |
|
|
2251 | .Vb 4 |
|
|
2252 | \& myclass::myclass (int fd) |
|
|
2253 | \& { |
|
|
2254 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
2255 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2256 | .Ve |
|
|
2257 | .PP |
|
|
2258 | .Vb 2 |
|
|
2259 | \& io.start (fd, ev::READ); |
|
|
2260 | \& } |
|
|
2261 | .Ve |
|
|
2262 | .SH "MACRO MAGIC" |
|
|
2263 | .IX Header "MACRO MAGIC" |
|
|
2264 | Libev can be compiled with a variety of options, the most fundamantal |
|
|
2265 | of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) |
|
|
2266 | functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
|
|
2267 | .PP |
|
|
2268 | To make it easier to write programs that cope with either variant, the |
|
|
2269 | following macros are defined: |
|
|
2270 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
|
|
2271 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
|
|
2272 | .IX Item "EV_A, EV_A_" |
|
|
2273 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
|
|
2274 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
|
|
2275 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
|
|
2276 | .Sp |
|
|
2277 | .Vb 3 |
|
|
2278 | \& ev_unref (EV_A); |
|
|
2279 | \& ev_timer_add (EV_A_ watcher); |
|
|
2280 | \& ev_loop (EV_A_ 0); |
|
|
2281 | .Ve |
|
|
2282 | .Sp |
|
|
2283 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
|
|
2284 | which is often provided by the following macro. |
|
|
2285 | .ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 |
|
|
2286 | .el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 |
|
|
2287 | .IX Item "EV_P, EV_P_" |
|
|
2288 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
|
|
2289 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
|
|
2290 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
|
|
2291 | .Sp |
|
|
2292 | .Vb 2 |
|
|
2293 | \& // this is how ev_unref is being declared |
|
|
2294 | \& static void ev_unref (EV_P); |
|
|
2295 | .Ve |
|
|
2296 | .Sp |
|
|
2297 | .Vb 2 |
|
|
2298 | \& // this is how you can declare your typical callback |
|
|
2299 | \& static void cb (EV_P_ ev_timer *w, int revents) |
|
|
2300 | .Ve |
|
|
2301 | .Sp |
|
|
2302 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
|
|
2303 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
|
|
2304 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
|
|
2305 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
|
|
2306 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
|
|
2307 | Similar to the other two macros, this gives you the value of the default |
|
|
2308 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
|
|
2309 | .PP |
|
|
2310 | Example: Declare and initialise a check watcher, utilising the above |
|
|
2311 | macros so it will work regardless of whether multiple loops are supported |
|
|
2312 | or not. |
|
|
2313 | .PP |
|
|
2314 | .Vb 5 |
|
|
2315 | \& static void |
|
|
2316 | \& check_cb (EV_P_ ev_timer *w, int revents) |
|
|
2317 | \& { |
|
|
2318 | \& ev_check_stop (EV_A_ w); |
|
|
2319 | \& } |
|
|
2320 | .Ve |
|
|
2321 | .PP |
|
|
2322 | .Vb 4 |
|
|
2323 | \& ev_check check; |
|
|
2324 | \& ev_check_init (&check, check_cb); |
|
|
2325 | \& ev_check_start (EV_DEFAULT_ &check); |
|
|
2326 | \& ev_loop (EV_DEFAULT_ 0); |
|
|
2327 | .Ve |
|
|
2328 | .SH "EMBEDDING" |
|
|
2329 | .IX Header "EMBEDDING" |
|
|
2330 | Libev can (and often is) directly embedded into host |
|
|
2331 | applications. Examples of applications that embed it include the Deliantra |
|
|
2332 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
|
|
2333 | and rxvt\-unicode. |
|
|
2334 | .PP |
|
|
2335 | The goal is to enable you to just copy the neecssary files into your |
|
|
2336 | source directory without having to change even a single line in them, so |
|
|
2337 | you can easily upgrade by simply copying (or having a checked-out copy of |
|
|
2338 | libev somewhere in your source tree). |
|
|
2339 | .Sh "\s-1FILESETS\s0" |
|
|
2340 | .IX Subsection "FILESETS" |
|
|
2341 | Depending on what features you need you need to include one or more sets of files |
|
|
2342 | in your app. |
|
|
2343 | .PP |
|
|
2344 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
|
|
2345 | .IX Subsection "CORE EVENT LOOP" |
|
|
2346 | .PP |
|
|
2347 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
|
|
2348 | configuration (no autoconf): |
|
|
2349 | .PP |
|
|
2350 | .Vb 2 |
|
|
2351 | \& #define EV_STANDALONE 1 |
|
|
2352 | \& #include "ev.c" |
|
|
2353 | .Ve |
|
|
2354 | .PP |
|
|
2355 | This will automatically include \fIev.h\fR, too, and should be done in a |
|
|
2356 | single C source file only to provide the function implementations. To use |
|
|
2357 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
|
|
2358 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
|
|
2359 | where you can put other configuration options): |
|
|
2360 | .PP |
|
|
2361 | .Vb 2 |
|
|
2362 | \& #define EV_STANDALONE 1 |
|
|
2363 | \& #include "ev.h" |
|
|
2364 | .Ve |
|
|
2365 | .PP |
|
|
2366 | Both header files and implementation files can be compiled with a \*(C+ |
|
|
2367 | compiler (at least, thats a stated goal, and breakage will be treated |
|
|
2368 | as a bug). |
|
|
2369 | .PP |
|
|
2370 | You need the following files in your source tree, or in a directory |
|
|
2371 | in your include path (e.g. in libev/ when using \-Ilibev): |
|
|
2372 | .PP |
|
|
2373 | .Vb 4 |
|
|
2374 | \& ev.h |
|
|
2375 | \& ev.c |
|
|
2376 | \& ev_vars.h |
|
|
2377 | \& ev_wrap.h |
|
|
2378 | .Ve |
|
|
2379 | .PP |
|
|
2380 | .Vb 1 |
|
|
2381 | \& ev_win32.c required on win32 platforms only |
|
|
2382 | .Ve |
|
|
2383 | .PP |
|
|
2384 | .Vb 5 |
|
|
2385 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
|
|
2386 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
|
|
2387 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
|
|
2388 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
|
|
2389 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
|
|
2390 | .Ve |
|
|
2391 | .PP |
|
|
2392 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
|
|
2393 | to compile this single file. |
|
|
2394 | .PP |
|
|
2395 | \fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR |
|
|
2396 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
|
|
2397 | .PP |
|
|
2398 | To include the libevent compatibility \s-1API\s0, also include: |
|
|
2399 | .PP |
|
|
2400 | .Vb 1 |
|
|
2401 | \& #include "event.c" |
|
|
2402 | .Ve |
|
|
2403 | .PP |
|
|
2404 | in the file including \fIev.c\fR, and: |
|
|
2405 | .PP |
|
|
2406 | .Vb 1 |
|
|
2407 | \& #include "event.h" |
|
|
2408 | .Ve |
|
|
2409 | .PP |
|
|
2410 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
|
|
2411 | .PP |
|
|
2412 | You need the following additional files for this: |
|
|
2413 | .PP |
|
|
2414 | .Vb 2 |
|
|
2415 | \& event.h |
|
|
2416 | \& event.c |
|
|
2417 | .Ve |
|
|
2418 | .PP |
|
|
2419 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
|
|
2420 | .IX Subsection "AUTOCONF SUPPORT" |
|
|
2421 | .PP |
|
|
2422 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in |
|
|
2423 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
|
|
2424 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then |
|
|
2425 | include \fIconfig.h\fR and configure itself accordingly. |
|
|
2426 | .PP |
|
|
2427 | For this of course you need the m4 file: |
|
|
2428 | .PP |
|
|
2429 | .Vb 1 |
|
|
2430 | \& libev.m4 |
|
|
2431 | .Ve |
|
|
2432 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
|
|
2433 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
|
|
2434 | Libev can be configured via a variety of preprocessor symbols you have to define |
|
|
2435 | before including any of its files. The default is not to build for multiplicity |
|
|
2436 | and only include the select backend. |
|
|
2437 | .IP "\s-1EV_STANDALONE\s0" 4 |
|
|
2438 | .IX Item "EV_STANDALONE" |
|
|
2439 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
|
|
2440 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
|
|
2441 | implementations for some libevent functions (such as logging, which is not |
|
|
2442 | supported). It will also not define any of the structs usually found in |
|
|
2443 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
|
|
2444 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
|
|
2445 | .IX Item "EV_USE_MONOTONIC" |
|
|
2446 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
|
|
2447 | monotonic clock option at both compiletime and runtime. Otherwise no use |
|
|
2448 | of the monotonic clock option will be attempted. If you enable this, you |
|
|
2449 | usually have to link against librt or something similar. Enabling it when |
|
|
2450 | the functionality isn't available is safe, though, althoguh you have |
|
|
2451 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
|
|
2452 | function is hiding in (often \fI\-lrt\fR). |
|
|
2453 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
|
|
2454 | .IX Item "EV_USE_REALTIME" |
|
|
2455 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
|
|
2456 | realtime clock option at compiletime (and assume its availability at |
|
|
2457 | runtime if successful). Otherwise no use of the realtime clock option will |
|
|
2458 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
|
|
2459 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
|
|
2460 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
|
|
2461 | .IP "\s-1EV_USE_SELECT\s0" 4 |
|
|
2462 | .IX Item "EV_USE_SELECT" |
|
|
2463 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
|
|
2464 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
|
|
2465 | other method takes over, select will be it. Otherwise the select backend |
|
|
2466 | will not be compiled in. |
|
|
2467 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
|
|
2468 | .IX Item "EV_SELECT_USE_FD_SET" |
|
|
2469 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
|
|
2470 | structure. This is useful if libev doesn't compile due to a missing |
|
|
2471 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on |
|
|
2472 | exotic systems. This usually limits the range of file descriptors to some |
|
|
2473 | low limit such as 1024 or might have other limitations (winsocket only |
|
|
2474 | allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might |
|
|
2475 | influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. |
|
|
2476 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
|
|
2477 | .IX Item "EV_SELECT_IS_WINSOCKET" |
|
|
2478 | When defined to \f(CW1\fR, the select backend will assume that |
|
|
2479 | select/socket/connect etc. don't understand file descriptors but |
|
|
2480 | wants osf handles on win32 (this is the case when the select to |
|
|
2481 | be used is the winsock select). This means that it will call |
|
|
2482 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
|
|
2483 | it is assumed that all these functions actually work on fds, even |
|
|
2484 | on win32. Should not be defined on non\-win32 platforms. |
|
|
2485 | .IP "\s-1EV_USE_POLL\s0" 4 |
|
|
2486 | .IX Item "EV_USE_POLL" |
|
|
2487 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
|
|
2488 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
|
|
2489 | takes precedence over select. |
|
|
2490 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
|
|
2491 | .IX Item "EV_USE_EPOLL" |
|
|
2492 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
|
|
2493 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
|
|
2494 | otherwise another method will be used as fallback. This is the |
|
|
2495 | preferred backend for GNU/Linux systems. |
|
|
2496 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
|
|
2497 | .IX Item "EV_USE_KQUEUE" |
|
|
2498 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
|
|
2499 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
|
|
2500 | otherwise another method will be used as fallback. This is the preferred |
|
|
2501 | backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only |
|
|
2502 | supports some types of fds correctly (the only platform we found that |
|
|
2503 | supports ptys for example was NetBSD), so kqueue might be compiled in, but |
|
|
2504 | not be used unless explicitly requested. The best way to use it is to find |
|
|
2505 | out whether kqueue supports your type of fd properly and use an embedded |
|
|
2506 | kqueue loop. |
|
|
2507 | .IP "\s-1EV_USE_PORT\s0" 4 |
|
|
2508 | .IX Item "EV_USE_PORT" |
|
|
2509 | If defined to be \f(CW1\fR, libev will compile in support for the Solaris |
|
|
2510 | 10 port style backend. Its availability will be detected at runtime, |
|
|
2511 | otherwise another method will be used as fallback. This is the preferred |
|
|
2512 | backend for Solaris 10 systems. |
|
|
2513 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
|
|
2514 | .IX Item "EV_USE_DEVPOLL" |
|
|
2515 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
2516 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
|
|
2517 | .IX Item "EV_USE_INOTIFY" |
|
|
2518 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
|
|
2519 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
|
|
2520 | be detected at runtime. |
|
|
2521 | .IP "\s-1EV_H\s0" 4 |
|
|
2522 | .IX Item "EV_H" |
|
|
2523 | The name of the \fIev.h\fR header file used to include it. The default if |
|
|
2524 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
|
|
2525 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
|
|
2526 | .IP "\s-1EV_CONFIG_H\s0" 4 |
|
|
2527 | .IX Item "EV_CONFIG_H" |
|
|
2528 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
|
|
2529 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
|
|
2530 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
|
|
2531 | .IP "\s-1EV_EVENT_H\s0" 4 |
|
|
2532 | .IX Item "EV_EVENT_H" |
|
|
2533 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
|
|
2534 | of how the \fIevent.h\fR header can be found. |
|
|
2535 | .IP "\s-1EV_PROTOTYPES\s0" 4 |
|
|
2536 | .IX Item "EV_PROTOTYPES" |
|
|
2537 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
|
|
2538 | prototypes, but still define all the structs and other symbols. This is |
|
|
2539 | occasionally useful if you want to provide your own wrapper functions |
|
|
2540 | around libev functions. |
|
|
2541 | .IP "\s-1EV_MULTIPLICITY\s0" 4 |
|
|
2542 | .IX Item "EV_MULTIPLICITY" |
|
|
2543 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
|
|
2544 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
|
|
2545 | additional independent event loops. Otherwise there will be no support |
|
|
2546 | for multiple event loops and there is no first event loop pointer |
|
|
2547 | argument. Instead, all functions act on the single default loop. |
|
|
2548 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2549 | .IX Item "EV_MINPRI" |
|
|
2550 | .PD 0 |
|
|
2551 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2552 | .IX Item "EV_MAXPRI" |
|
|
2553 | .PD |
|
|
2554 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2555 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2556 | provide for more priorities by overriding those symbols (usually defined |
|
|
2557 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2558 | .Sp |
|
|
2559 | When doing priority-based operations, libev usually has to linearly search |
|
|
2560 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2561 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2562 | fine. |
|
|
2563 | .Sp |
|
|
2564 | If your embedding app does not need any priorities, defining these both to |
|
|
2565 | \&\f(CW0\fR will save some memory and cpu. |
|
|
2566 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
|
|
2567 | .IX Item "EV_PERIODIC_ENABLE" |
|
|
2568 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
|
|
2569 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2570 | code. |
|
|
2571 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2572 | .IX Item "EV_IDLE_ENABLE" |
|
|
2573 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
|
|
2574 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2575 | code. |
|
|
2576 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
|
|
2577 | .IX Item "EV_EMBED_ENABLE" |
|
|
2578 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
|
|
2579 | defined to be \f(CW0\fR, then they are not. |
|
|
2580 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
|
|
2581 | .IX Item "EV_STAT_ENABLE" |
|
|
2582 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
|
|
2583 | defined to be \f(CW0\fR, then they are not. |
|
|
2584 | .IP "\s-1EV_FORK_ENABLE\s0" 4 |
|
|
2585 | .IX Item "EV_FORK_ENABLE" |
|
|
2586 | If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If |
|
|
2587 | defined to be \f(CW0\fR, then they are not. |
|
|
2588 | .IP "\s-1EV_MINIMAL\s0" 4 |
|
|
2589 | .IX Item "EV_MINIMAL" |
|
|
2590 | If you need to shave off some kilobytes of code at the expense of some |
|
|
2591 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
|
|
2592 | some inlining decisions, saves roughly 30% codesize of amd64. |
|
|
2593 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
|
|
2594 | .IX Item "EV_PID_HASHSIZE" |
|
|
2595 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2596 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
|
|
2597 | than enough. If you need to manage thousands of children you might want to |
|
|
2598 | increase this value (\fImust\fR be a power of two). |
|
|
2599 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
|
|
2600 | .IX Item "EV_INOTIFY_HASHSIZE" |
|
|
2601 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2602 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
|
|
2603 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2604 | watchers you might want to increase this value (\fImust\fR be a power of |
|
|
2605 | two). |
|
|
2606 | .IP "\s-1EV_COMMON\s0" 4 |
|
|
2607 | .IX Item "EV_COMMON" |
|
|
2608 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
|
|
2609 | this macro to a something else you can include more and other types of |
|
|
2610 | members. You have to define it each time you include one of the files, |
|
|
2611 | though, and it must be identical each time. |
|
|
2612 | .Sp |
|
|
2613 | For example, the perl \s-1EV\s0 module uses something like this: |
|
|
2614 | .Sp |
|
|
2615 | .Vb 3 |
|
|
2616 | \& #define EV_COMMON \e |
|
|
2617 | \& SV *self; /* contains this struct */ \e |
|
|
2618 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
|
|
2619 | .Ve |
|
|
2620 | .IP "\s-1EV_CB_DECLARE\s0 (type)" 4 |
|
|
2621 | .IX Item "EV_CB_DECLARE (type)" |
|
|
2622 | .PD 0 |
|
|
2623 | .IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 |
|
|
2624 | .IX Item "EV_CB_INVOKE (watcher, revents)" |
|
|
2625 | .IP "ev_set_cb (ev, cb)" 4 |
|
|
2626 | .IX Item "ev_set_cb (ev, cb)" |
|
|
2627 | .PD |
|
|
2628 | Can be used to change the callback member declaration in each watcher, |
|
|
2629 | and the way callbacks are invoked and set. Must expand to a struct member |
|
|
2630 | definition and a statement, respectively. See the \fIev.v\fR header file for |
|
|
2631 | their default definitions. One possible use for overriding these is to |
|
|
2632 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
|
|
2633 | method calls instead of plain function calls in \*(C+. |
|
|
2634 | .Sh "\s-1EXAMPLES\s0" |
|
|
2635 | .IX Subsection "EXAMPLES" |
|
|
2636 | For a real-world example of a program the includes libev |
|
|
2637 | verbatim, you can have a look at the \s-1EV\s0 perl module |
|
|
2638 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
|
|
2639 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
|
|
2640 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
|
|
2641 | will be compiled. It is pretty complex because it provides its own header |
|
|
2642 | file. |
|
|
2643 | .Sp |
|
|
2644 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
|
|
2645 | that everybody includes and which overrides some configure choices: |
|
|
2646 | .Sp |
|
|
2647 | .Vb 9 |
|
|
2648 | \& #define EV_MINIMAL 1 |
|
|
2649 | \& #define EV_USE_POLL 0 |
|
|
2650 | \& #define EV_MULTIPLICITY 0 |
|
|
2651 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2652 | \& #define EV_STAT_ENABLE 0 |
|
|
2653 | \& #define EV_FORK_ENABLE 0 |
|
|
2654 | \& #define EV_CONFIG_H <config.h> |
|
|
2655 | \& #define EV_MINPRI 0 |
|
|
2656 | \& #define EV_MAXPRI 0 |
|
|
2657 | .Ve |
|
|
2658 | .Sp |
|
|
2659 | .Vb 1 |
|
|
2660 | \& #include "ev++.h" |
|
|
2661 | .Ve |
|
|
2662 | .Sp |
|
|
2663 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
|
|
2664 | .Sp |
|
|
2665 | .Vb 2 |
|
|
2666 | \& #include "ev_cpp.h" |
|
|
2667 | \& #include "ev.c" |
|
|
2668 | .Ve |
|
|
2669 | .SH "COMPLEXITIES" |
|
|
2670 | .IX Header "COMPLEXITIES" |
|
|
2671 | In this section the complexities of (many of) the algorithms used inside |
|
|
2672 | libev will be explained. For complexity discussions about backends see the |
|
|
2673 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
2674 | .Sp |
|
|
2675 | All of the following are about amortised time: If an array needs to be |
|
|
2676 | extended, libev needs to realloc and move the whole array, but this |
|
|
2677 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2678 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2679 | it is much faster and asymptotically approaches constant time. |
|
|
2680 | .RS 4 |
|
|
2681 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
|
|
2682 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
|
|
2683 | This means that, when you have a watcher that triggers in one hour and |
|
|
2684 | there are 100 watchers that would trigger before that then inserting will |
|
|
2685 | have to skip those 100 watchers. |
|
|
2686 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
|
|
2687 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2688 | That means that for changing a timer costs less than removing/adding them |
|
|
2689 | as only the relative motion in the event queue has to be paid for. |
|
|
2690 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
|
|
2691 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
|
|
2692 | These just add the watcher into an array or at the head of a list. |
|
|
2693 | =item Stopping check/prepare/idle watchers: O(1) |
|
|
2694 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
|
|
2695 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2696 | These watchers are stored in lists then need to be walked to find the |
|
|
2697 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2698 | have many watchers waiting for the same fd or signal). |
|
|
2699 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
|
|
2700 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2701 | .PD 0 |
|
|
2702 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
|
|
2703 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2704 | .PD |
|
|
2705 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2706 | libev to recalculate its status (and possibly tell the kernel). |
|
|
2707 | .IP "Activating one watcher: O(1)" 4 |
|
|
2708 | .IX Item "Activating one watcher: O(1)" |
|
|
2709 | .PD 0 |
|
|
2710 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2711 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2712 | .PD |
|
|
2713 | Priorities are implemented by allocating some space for each |
|
|
2714 | priority. When doing priority-based operations, libev usually has to |
|
|
2715 | linearly search all the priorities. |
|
|
2716 | .RE |
|
|
2717 | .RS 4 |
1267 | .SH "AUTHOR" |
2718 | .SH "AUTHOR" |
1268 | .IX Header "AUTHOR" |
2719 | .IX Header "AUTHOR" |
1269 | Marc Lehmann <libev@schmorp.de>. |
2720 | Marc Lehmann <libev@schmorp.de>. |