… | |
… | |
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-26" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH EV 1 "2007-12-22" "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 occurring), 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 |
147 | (or thread) by executing the \fIevent loop\fR handler, and will then |
210 | (or thread) by executing the \fIevent loop\fR handler, and will then |
148 | communicate events via a callback mechanism. |
211 | communicate events via a callback mechanism. |
… | |
… | |
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 |
185 | .IX Item "ev_tstamp ev_time ()" |
256 | .IX Item "ev_tstamp ev_time ()" |
186 | Returns the current time as libev would use it. Please note that the |
257 | Returns the current time as libev would use it. Please note that the |
187 | \&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp |
258 | \&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp |
188 | you actually want to know. |
259 | you actually want to know. |
|
|
260 | .IP "void ev_sleep (ev_tstamp interval)" 4 |
|
|
261 | .IX Item "void ev_sleep (ev_tstamp interval)" |
|
|
262 | Sleep for the given interval: The current thread will be blocked until |
|
|
263 | either it is interrupted or the given time interval has passed. Basically |
|
|
264 | this is a subsecond-resolution \f(CW\*(C`sleep ()\*(C'\fR. |
189 | .IP "int ev_version_major ()" 4 |
265 | .IP "int ev_version_major ()" 4 |
190 | .IX Item "int ev_version_major ()" |
266 | .IX Item "int ev_version_major ()" |
191 | .PD 0 |
267 | .PD 0 |
192 | .IP "int ev_version_minor ()" 4 |
268 | .IP "int ev_version_minor ()" 4 |
193 | .IX Item "int ev_version_minor ()" |
269 | .IX Item "int ev_version_minor ()" |
194 | .PD |
270 | .PD |
195 | You can find out the major and minor version numbers of the library |
271 | 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 |
272 | 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 |
273 | \&\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 |
274 | 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. |
275 | version of the library your program was compiled against. |
200 | .Sp |
276 | .Sp |
|
|
277 | These version numbers refer to the \s-1ABI\s0 version of the library, not the |
|
|
278 | release version. |
|
|
279 | .Sp |
201 | Usually, it's a good idea to terminate if the major versions mismatch, |
280 | Usually, it's a good idea to terminate if the major versions mismatch, |
202 | as this indicates an incompatible change. Minor versions are usually |
281 | as this indicates an incompatible change. Minor versions are usually |
203 | compatible to older versions, so a larger minor version alone is usually |
282 | compatible to older versions, so a larger minor version alone is usually |
204 | not a problem. |
283 | not a problem. |
205 | .Sp |
284 | .Sp |
206 | Example: make sure we haven't accidentally been linked against the wrong |
285 | Example: Make sure we haven't accidentally been linked against the wrong |
207 | version: |
286 | version. |
208 | .Sp |
287 | .Sp |
209 | .Vb 3 |
288 | .Vb 3 |
210 | \& assert (("libev version mismatch", |
289 | \& assert (("libev version mismatch", |
211 | \& ev_version_major () == EV_VERSION_MAJOR |
290 | \& ev_version_major () == EV_VERSION_MAJOR |
212 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
291 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
… | |
… | |
242 | recommended ones. |
321 | recommended ones. |
243 | .Sp |
322 | .Sp |
244 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
323 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
245 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
324 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
246 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
325 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
247 | Sets the allocation function to use (the prototype is similar to the |
326 | Sets the allocation function to use (the prototype is similar \- the |
248 | realloc C function, the semantics are identical). It is used to allocate |
327 | semantics is identical \- to the realloc C function). It is used to |
249 | and free memory (no surprises here). If it returns zero when memory |
328 | allocate and free memory (no surprises here). If it returns zero when |
250 | needs to be allocated, the library might abort or take some potentially |
329 | memory needs to be allocated, the library might abort or take some |
251 | destructive action. The default is your system realloc function. |
330 | potentially destructive action. The default is your system realloc |
|
|
331 | function. |
252 | .Sp |
332 | .Sp |
253 | You could override this function in high-availability programs to, say, |
333 | You could override this function in high-availability programs to, say, |
254 | free some memory if it cannot allocate memory, to use a special allocator, |
334 | free some memory if it cannot allocate memory, to use a special allocator, |
255 | or even to sleep a while and retry until some memory is available. |
335 | or even to sleep a while and retry until some memory is available. |
256 | .Sp |
336 | .Sp |
257 | Example: replace the libev allocator with one that waits a bit and then |
337 | Example: Replace the libev allocator with one that waits a bit and then |
258 | retries: better than mine). |
338 | retries). |
259 | .Sp |
339 | .Sp |
260 | .Vb 6 |
340 | .Vb 6 |
261 | \& static void * |
341 | \& static void * |
262 | \& persistent_realloc (void *ptr, long size) |
342 | \& persistent_realloc (void *ptr, size_t size) |
263 | \& { |
343 | \& { |
264 | \& for (;;) |
344 | \& for (;;) |
265 | \& { |
345 | \& { |
266 | \& void *newptr = realloc (ptr, size); |
346 | \& void *newptr = realloc (ptr, size); |
267 | .Ve |
347 | .Ve |
… | |
… | |
289 | callback is set, then libev will expect it to remedy the sitution, no |
369 | callback is set, then libev will expect it to remedy the sitution, no |
290 | matter what, when it returns. That is, libev will generally retry the |
370 | matter what, when it returns. That is, libev will generally retry the |
291 | requested operation, or, if the condition doesn't go away, do bad stuff |
371 | requested operation, or, if the condition doesn't go away, do bad stuff |
292 | (such as abort). |
372 | (such as abort). |
293 | .Sp |
373 | .Sp |
294 | Example: do the same thing as libev does internally: |
374 | Example: This is basically the same thing that libev does internally, too. |
295 | .Sp |
375 | .Sp |
296 | .Vb 6 |
376 | .Vb 6 |
297 | \& static void |
377 | \& static void |
298 | \& fatal_error (const char *msg) |
378 | \& fatal_error (const char *msg) |
299 | \& { |
379 | \& { |
… | |
… | |
345 | or setgid) then libev will \fInot\fR look at the environment variable |
425 | or setgid) then libev will \fInot\fR look at the environment variable |
346 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
426 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
347 | override the flags completely if it is found in the environment. This is |
427 | override the flags completely if it is found in the environment. This is |
348 | useful to try out specific backends to test their performance, or to work |
428 | useful to try out specific backends to test their performance, or to work |
349 | around bugs. |
429 | around bugs. |
|
|
430 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
|
|
431 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
|
|
432 | .IX Item "EVFLAG_FORKCHECK" |
|
|
433 | Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after |
|
|
434 | a fork, you can also make libev check for a fork in each iteration by |
|
|
435 | enabling this flag. |
|
|
436 | .Sp |
|
|
437 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
|
|
438 | and thus this might slow down your event loop if you do a lot of loop |
|
|
439 | iterations and little real work, but is usually not noticeable (on my |
|
|
440 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
|
|
441 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
|
|
442 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
|
|
443 | .Sp |
|
|
444 | The big advantage of this flag is that you can forget about fork (and |
|
|
445 | forget about forgetting to tell libev about forking) when you use this |
|
|
446 | flag. |
|
|
447 | .Sp |
|
|
448 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
|
|
449 | environment variable. |
350 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
450 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
351 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
451 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
352 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
452 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
353 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
453 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
354 | libev tries to roll its own fd_set with no limits on the number of fds, |
454 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
364 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
464 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
365 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
465 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
366 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
466 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
367 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
467 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
368 | For few fds, this backend is a bit little slower than poll and select, |
468 | For few fds, this backend is a bit little slower than poll and select, |
369 | but it scales phenomenally better. While poll and select usually scale like |
469 | but it scales phenomenally better. While poll and select usually scale |
370 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
470 | like O(total_fds) where n is the total number of fds (or the highest fd), |
371 | either O(1) or O(active_fds). |
471 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
|
|
472 | of shortcomings, such as silently dropping events in some hard-to-detect |
|
|
473 | cases and rewiring a syscall per fd change, no fork support and bad |
|
|
474 | support for dup: |
372 | .Sp |
475 | .Sp |
373 | While stopping and starting an I/O watcher in the same iteration will |
476 | While stopping, setting and starting an I/O watcher in the same iteration |
374 | result in some caching, there is still a syscall per such incident |
477 | will result in some caching, there is still a syscall per such incident |
375 | (because the fd could point to a different file description now), so its |
478 | (because the fd could point to a different file description now), so its |
376 | best to avoid that. Also, \fIdup()\fRed file descriptors might not work very |
479 | best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work |
377 | well if you register events for both fds. |
480 | very well if you register events for both fds. |
378 | .Sp |
481 | .Sp |
379 | Please note that epoll sometimes generates spurious notifications, so you |
482 | Please note that epoll sometimes generates spurious notifications, so you |
380 | need to use non-blocking I/O or other means to avoid blocking when no data |
483 | need to use non-blocking I/O or other means to avoid blocking when no data |
381 | (or space) is available. |
484 | (or space) is available. |
382 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
485 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
383 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
486 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
384 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
487 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
385 | Kqueue deserves special mention, as at the time of this writing, it |
488 | Kqueue deserves special mention, as at the time of this writing, it |
386 | was broken on all BSDs except NetBSD (usually it doesn't work with |
489 | was broken on \fIall\fR BSDs (usually it doesn't work with anything but |
387 | anything but sockets and pipes, except on Darwin, where of course its |
490 | sockets and pipes, except on Darwin, where of course it's completely |
|
|
491 | useless. On NetBSD, it seems to work for all the \s-1FD\s0 types I tested, so it |
388 | completely useless). For this reason its not being \*(L"autodetected\*(R" |
492 | is used by default there). For this reason it's not being \*(L"autodetected\*(R" |
389 | unless you explicitly specify it explicitly in the flags (i.e. using |
493 | unless you explicitly specify it explicitly in the flags (i.e. using |
390 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). |
494 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) |
|
|
495 | system like NetBSD. |
391 | .Sp |
496 | .Sp |
392 | It scales in the same way as the epoll backend, but the interface to the |
497 | It scales in the same way as the epoll backend, but the interface to the |
393 | kernel is more efficient (which says nothing about its actual speed, of |
498 | kernel is more efficient (which says nothing about its actual speed, |
394 | course). While starting and stopping an I/O watcher does not cause an |
499 | of course). While stopping, setting and starting an I/O watcher does |
395 | extra syscall as with epoll, it still adds up to four event changes per |
500 | never cause an extra syscall as with epoll, it still adds up to two event |
396 | incident, so its best to avoid that. |
501 | changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it drops fds |
|
|
502 | silently in similarly hard-to-detetc cases. |
397 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
503 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
398 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
504 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
399 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
505 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
400 | This is not implemented yet (and might never be). |
506 | This is not implemented yet (and might never be). |
401 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
507 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
402 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
508 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
403 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
509 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
404 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
510 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
405 | it's really slow, but it still scales very well (O(active_fds)). |
511 | it's really slow, but it still scales very well (O(active_fds)). |
406 | .Sp |
512 | .Sp |
407 | Please note that solaris ports can result in a lot of spurious |
513 | Please note that solaris event ports can deliver a lot of spurious |
408 | notifications, so you need to use non-blocking I/O or other means to avoid |
514 | notifications, so you need to use non-blocking I/O or other means to avoid |
409 | blocking when no data (or space) is available. |
515 | blocking when no data (or space) is available. |
410 | .ie n .IP """EVBACKEND_ALL""" 4 |
516 | .ie n .IP """EVBACKEND_ALL""" 4 |
411 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
517 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
412 | .IX Item "EVBACKEND_ALL" |
518 | .IX Item "EVBACKEND_ALL" |
… | |
… | |
448 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
554 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
449 | always distinct from the default loop. Unlike the default loop, it cannot |
555 | always distinct from the default loop. Unlike the default loop, it cannot |
450 | handle signal and child watchers, and attempts to do so will be greeted by |
556 | handle signal and child watchers, and attempts to do so will be greeted by |
451 | undefined behaviour (or a failed assertion if assertions are enabled). |
557 | undefined behaviour (or a failed assertion if assertions are enabled). |
452 | .Sp |
558 | .Sp |
453 | Example: try to create a event loop that uses epoll and nothing else. |
559 | Example: Try to create a event loop that uses epoll and nothing else. |
454 | .Sp |
560 | .Sp |
455 | .Vb 3 |
561 | .Vb 3 |
456 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
562 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
457 | \& if (!epoller) |
563 | \& if (!epoller) |
458 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
564 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
… | |
… | |
462 | Destroys the default loop again (frees all memory and kernel state |
568 | Destroys the default loop again (frees all memory and kernel state |
463 | etc.). None of the active event watchers will be stopped in the normal |
569 | etc.). None of the active event watchers will be stopped in the normal |
464 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
570 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
465 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
571 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
466 | calling this function, or cope with the fact afterwards (which is usually |
572 | calling this function, or cope with the fact afterwards (which is usually |
467 | the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
573 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
468 | for example). |
574 | for example). |
|
|
575 | .Sp |
|
|
576 | Note that certain global state, such as signal state, will not be freed by |
|
|
577 | this function, and related watchers (such as signal and child watchers) |
|
|
578 | would need to be stopped manually. |
|
|
579 | .Sp |
|
|
580 | In general it is not advisable to call this function except in the |
|
|
581 | rare occasion where you really need to free e.g. the signal handling |
|
|
582 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
583 | \&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR). |
469 | .IP "ev_loop_destroy (loop)" 4 |
584 | .IP "ev_loop_destroy (loop)" 4 |
470 | .IX Item "ev_loop_destroy (loop)" |
585 | .IX Item "ev_loop_destroy (loop)" |
471 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
586 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
472 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
587 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
473 | .IP "ev_default_fork ()" 4 |
588 | .IP "ev_default_fork ()" 4 |
… | |
… | |
495 | .IP "ev_loop_fork (loop)" 4 |
610 | .IP "ev_loop_fork (loop)" 4 |
496 | .IX Item "ev_loop_fork (loop)" |
611 | .IX Item "ev_loop_fork (loop)" |
497 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
612 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
498 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
613 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
499 | after fork, and how you do this is entirely your own problem. |
614 | after fork, and how you do this is entirely your own problem. |
|
|
615 | .IP "unsigned int ev_loop_count (loop)" 4 |
|
|
616 | .IX Item "unsigned int ev_loop_count (loop)" |
|
|
617 | Returns the count of loop iterations for the loop, which is identical to |
|
|
618 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
619 | happily wraps around with enough iterations. |
|
|
620 | .Sp |
|
|
621 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
622 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
|
|
623 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
500 | .IP "unsigned int ev_backend (loop)" 4 |
624 | .IP "unsigned int ev_backend (loop)" 4 |
501 | .IX Item "unsigned int ev_backend (loop)" |
625 | .IX Item "unsigned int ev_backend (loop)" |
502 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
626 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
503 | use. |
627 | use. |
504 | .IP "ev_tstamp ev_now (loop)" 4 |
628 | .IP "ev_tstamp ev_now (loop)" 4 |
505 | .IX Item "ev_tstamp ev_now (loop)" |
629 | .IX Item "ev_tstamp ev_now (loop)" |
506 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
630 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
507 | received events and started processing them. This timestamp does not |
631 | received events and started processing them. This timestamp does not |
508 | change as long as callbacks are being processed, and this is also the base |
632 | change as long as callbacks are being processed, and this is also the base |
509 | time used for relative timers. You can treat it as the timestamp of the |
633 | time used for relative timers. You can treat it as the timestamp of the |
510 | event occuring (or more correctly, libev finding out about it). |
634 | event occurring (or more correctly, libev finding out about it). |
511 | .IP "ev_loop (loop, int flags)" 4 |
635 | .IP "ev_loop (loop, int flags)" 4 |
512 | .IX Item "ev_loop (loop, int flags)" |
636 | .IX Item "ev_loop (loop, int flags)" |
513 | Finally, this is it, the event handler. This function usually is called |
637 | Finally, this is it, the event handler. This function usually is called |
514 | after you initialised all your watchers and you want to start handling |
638 | after you initialised all your watchers and you want to start handling |
515 | events. |
639 | events. |
… | |
… | |
535 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
659 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
536 | usually a better approach for this kind of thing. |
660 | usually a better approach for this kind of thing. |
537 | .Sp |
661 | .Sp |
538 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
662 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
539 | .Sp |
663 | .Sp |
540 | .Vb 18 |
664 | .Vb 19 |
|
|
665 | \& - Before the first iteration, call any pending watchers. |
541 | \& * If there are no active watchers (reference count is zero), return. |
666 | \& * If there are no active watchers (reference count is zero), return. |
542 | \& - Queue prepare watchers and then call all outstanding watchers. |
667 | \& - Queue all prepare watchers and then call all outstanding watchers. |
543 | \& - If we have been forked, recreate the kernel state. |
668 | \& - If we have been forked, recreate the kernel state. |
544 | \& - Update the kernel state with all outstanding changes. |
669 | \& - Update the kernel state with all outstanding changes. |
545 | \& - Update the "event loop time". |
670 | \& - Update the "event loop time". |
546 | \& - Calculate for how long to block. |
671 | \& - Calculate for how long to block. |
547 | \& - Block the process, waiting for any events. |
672 | \& - Block the process, waiting for any events. |
… | |
… | |
556 | \& be handled here by queueing them when their watcher gets executed. |
681 | \& be handled here by queueing them when their watcher gets executed. |
557 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
682 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
558 | \& were used, return, otherwise continue with step *. |
683 | \& were used, return, otherwise continue with step *. |
559 | .Ve |
684 | .Ve |
560 | .Sp |
685 | .Sp |
561 | Example: queue some jobs and then loop until no events are outsanding |
686 | Example: Queue some jobs and then loop until no events are outsanding |
562 | anymore. |
687 | anymore. |
563 | .Sp |
688 | .Sp |
564 | .Vb 4 |
689 | .Vb 4 |
565 | \& ... queue jobs here, make sure they register event watchers as long |
690 | \& ... queue jobs here, make sure they register event watchers as long |
566 | \& ... as they still have work to do (even an idle watcher will do..) |
691 | \& ... as they still have work to do (even an idle watcher will do..) |
… | |
… | |
588 | visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if |
713 | visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if |
589 | no event watchers registered by it are active. It is also an excellent |
714 | no event watchers registered by it are active. It is also an excellent |
590 | way to do this for generic recurring timers or from within third-party |
715 | way to do this for generic recurring timers or from within third-party |
591 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
716 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
592 | .Sp |
717 | .Sp |
593 | Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
718 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
594 | running when nothing else is active. |
719 | running when nothing else is active. |
595 | .Sp |
720 | .Sp |
596 | .Vb 4 |
721 | .Vb 4 |
597 | \& struct dv_signal exitsig; |
722 | \& struct ev_signal exitsig; |
598 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
723 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
599 | \& ev_signal_start (myloop, &exitsig); |
724 | \& ev_signal_start (loop, &exitsig); |
600 | \& evf_unref (myloop); |
725 | \& evf_unref (loop); |
601 | .Ve |
726 | .Ve |
602 | .Sp |
727 | .Sp |
603 | Example: for some weird reason, unregister the above signal handler again. |
728 | Example: For some weird reason, unregister the above signal handler again. |
604 | .Sp |
729 | .Sp |
605 | .Vb 2 |
730 | .Vb 2 |
606 | \& ev_ref (myloop); |
731 | \& ev_ref (loop); |
607 | \& ev_signal_stop (myloop, &exitsig); |
732 | \& ev_signal_stop (loop, &exitsig); |
608 | .Ve |
733 | .Ve |
|
|
734 | .IP "ev_set_io_collect_interval (ev_tstamp interval)" 4 |
|
|
735 | .IX Item "ev_set_io_collect_interval (ev_tstamp interval)" |
|
|
736 | .PD 0 |
|
|
737 | .IP "ev_set_timeout_collect_interval (ev_tstamp interval)" 4 |
|
|
738 | .IX Item "ev_set_timeout_collect_interval (ev_tstamp interval)" |
|
|
739 | .PD |
|
|
740 | These advanced functions influence the time that libev will spend waiting |
|
|
741 | for events. Both are by default \f(CW0\fR, meaning that libev will try to |
|
|
742 | invoke timer/periodic callbacks and I/O callbacks with minimum latency. |
|
|
743 | .Sp |
|
|
744 | Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR) |
|
|
745 | allows libev to delay invocation of I/O and timer/periodic callbacks to |
|
|
746 | increase efficiency of loop iterations. |
|
|
747 | .Sp |
|
|
748 | The background is that sometimes your program runs just fast enough to |
|
|
749 | handle one (or very few) event(s) per loop iteration. While this makes |
|
|
750 | the program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new |
|
|
751 | events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high |
|
|
752 | overhead for the actual polling but can deliver many events at once. |
|
|
753 | .Sp |
|
|
754 | By setting a higher \fIio collect interval\fR you allow libev to spend more |
|
|
755 | time collecting I/O events, so you can handle more events per iteration, |
|
|
756 | at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and |
|
|
757 | \&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. |
|
|
758 | .Sp |
|
|
759 | Likewise, by setting a higher \fItimeout collect interval\fR you allow libev |
|
|
760 | to spend more time collecting timeouts, at the expense of increased |
|
|
761 | latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers |
|
|
762 | will not be affected. |
|
|
763 | .Sp |
|
|
764 | Many programs can usually benefit by setting the io collect interval to |
|
|
765 | a value near \f(CW0.1\fR or so, which is often enough for interactive servers |
|
|
766 | (of course not for games), likewise for timeouts. It usually doesn't make |
|
|
767 | much sense to set it to a lower value than \f(CW0.01\fR, as this approsaches |
|
|
768 | the timing granularity of most systems. |
609 | .SH "ANATOMY OF A WATCHER" |
769 | .SH "ANATOMY OF A WATCHER" |
610 | .IX Header "ANATOMY OF A WATCHER" |
770 | .IX Header "ANATOMY OF A WATCHER" |
611 | A watcher is a structure that you create and register to record your |
771 | A watcher is a structure that you create and register to record your |
612 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
772 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
613 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
773 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
… | |
… | |
684 | The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. |
844 | The signal specified in the \f(CW\*(C`ev_signal\*(C'\fR watcher has been received by a thread. |
685 | .ie n .IP """EV_CHILD""" 4 |
845 | .ie n .IP """EV_CHILD""" 4 |
686 | .el .IP "\f(CWEV_CHILD\fR" 4 |
846 | .el .IP "\f(CWEV_CHILD\fR" 4 |
687 | .IX Item "EV_CHILD" |
847 | .IX Item "EV_CHILD" |
688 | The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. |
848 | The pid specified in the \f(CW\*(C`ev_child\*(C'\fR watcher has received a status change. |
|
|
849 | .ie n .IP """EV_STAT""" 4 |
|
|
850 | .el .IP "\f(CWEV_STAT\fR" 4 |
|
|
851 | .IX Item "EV_STAT" |
|
|
852 | The path specified in the \f(CW\*(C`ev_stat\*(C'\fR watcher changed its attributes somehow. |
689 | .ie n .IP """EV_IDLE""" 4 |
853 | .ie n .IP """EV_IDLE""" 4 |
690 | .el .IP "\f(CWEV_IDLE\fR" 4 |
854 | .el .IP "\f(CWEV_IDLE\fR" 4 |
691 | .IX Item "EV_IDLE" |
855 | .IX Item "EV_IDLE" |
692 | The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. |
856 | The \f(CW\*(C`ev_idle\*(C'\fR watcher has determined that you have nothing better to do. |
693 | .ie n .IP """EV_PREPARE""" 4 |
857 | .ie n .IP """EV_PREPARE""" 4 |
… | |
… | |
703 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
867 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
704 | received events. Callbacks of both watcher types can start and stop as |
868 | received events. Callbacks of both watcher types can start and stop as |
705 | many watchers as they want, and all of them will be taken into account |
869 | many watchers as they want, and all of them will be taken into account |
706 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
870 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
707 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
871 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
|
|
872 | .ie n .IP """EV_EMBED""" 4 |
|
|
873 | .el .IP "\f(CWEV_EMBED\fR" 4 |
|
|
874 | .IX Item "EV_EMBED" |
|
|
875 | The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. |
|
|
876 | .ie n .IP """EV_FORK""" 4 |
|
|
877 | .el .IP "\f(CWEV_FORK\fR" 4 |
|
|
878 | .IX Item "EV_FORK" |
|
|
879 | The event loop has been resumed in the child process after fork (see |
|
|
880 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
708 | .ie n .IP """EV_ERROR""" 4 |
881 | .ie n .IP """EV_ERROR""" 4 |
709 | .el .IP "\f(CWEV_ERROR\fR" 4 |
882 | .el .IP "\f(CWEV_ERROR\fR" 4 |
710 | .IX Item "EV_ERROR" |
883 | .IX Item "EV_ERROR" |
711 | An unspecified error has occured, the watcher has been stopped. This might |
884 | An unspecified error has occured, the watcher has been stopped. This might |
712 | happen because the watcher could not be properly started because libev |
885 | happen because the watcher could not be properly started because libev |
… | |
… | |
777 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
950 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
778 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
951 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
779 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
952 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
780 | events but its callback has not yet been invoked). As long as a watcher |
953 | events but its callback has not yet been invoked). As long as a watcher |
781 | is pending (but not active) you must not call an init function on it (but |
954 | is pending (but not active) you must not call an init function on it (but |
782 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
955 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
783 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
956 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
957 | it). |
784 | .IP "callback = ev_cb (ev_TYPE *watcher)" 4 |
958 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
785 | .IX Item "callback = ev_cb (ev_TYPE *watcher)" |
959 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
786 | Returns the callback currently set on the watcher. |
960 | Returns the callback currently set on the watcher. |
787 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
961 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
788 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
962 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
789 | Change the callback. You can change the callback at virtually any time |
963 | Change the callback. You can change the callback at virtually any time |
790 | (modulo threads). |
964 | (modulo threads). |
|
|
965 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
966 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
967 | .PD 0 |
|
|
968 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
969 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
970 | .PD |
|
|
971 | Set and query the priority of the watcher. The priority is a small |
|
|
972 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
973 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
974 | before watchers with lower priority, but priority will not keep watchers |
|
|
975 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
976 | .Sp |
|
|
977 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
978 | invocation after new events have been received. This is useful, for |
|
|
979 | example, to reduce latency after idling, or more often, to bind two |
|
|
980 | watchers on the same event and make sure one is called first. |
|
|
981 | .Sp |
|
|
982 | If you need to suppress invocation when higher priority events are pending |
|
|
983 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
984 | .Sp |
|
|
985 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
986 | pending. |
|
|
987 | .Sp |
|
|
988 | The default priority used by watchers when no priority has been set is |
|
|
989 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
990 | .Sp |
|
|
991 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
992 | fine, as long as you do not mind that the priority value you query might |
|
|
993 | or might not have been adjusted to be within valid range. |
|
|
994 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
995 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
996 | 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 |
|
|
997 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
998 | can deal with that fact. |
|
|
999 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
1000 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
1001 | If the watcher is pending, this function returns clears its pending status |
|
|
1002 | and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
1003 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
791 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
1004 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
792 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
1005 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
793 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
1006 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
794 | and read at any time, libev will completely ignore it. This can be used |
1007 | and read at any time, libev will completely ignore it. This can be used |
795 | to associate arbitrary data with your watcher. If you need more data and |
1008 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
816 | \& struct my_io *w = (struct my_io *)w_; |
1029 | \& struct my_io *w = (struct my_io *)w_; |
817 | \& ... |
1030 | \& ... |
818 | \& } |
1031 | \& } |
819 | .Ve |
1032 | .Ve |
820 | .PP |
1033 | .PP |
821 | More interesting and less C\-conformant ways of catsing your callback type |
1034 | More interesting and less C\-conformant ways of casting your callback type |
822 | have been omitted.... |
1035 | instead have been omitted. |
|
|
1036 | .PP |
|
|
1037 | Another common scenario is having some data structure with multiple |
|
|
1038 | watchers: |
|
|
1039 | .PP |
|
|
1040 | .Vb 6 |
|
|
1041 | \& struct my_biggy |
|
|
1042 | \& { |
|
|
1043 | \& int some_data; |
|
|
1044 | \& ev_timer t1; |
|
|
1045 | \& ev_timer t2; |
|
|
1046 | \& } |
|
|
1047 | .Ve |
|
|
1048 | .PP |
|
|
1049 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
|
|
1050 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
|
|
1051 | .PP |
|
|
1052 | .Vb 1 |
|
|
1053 | \& #include <stddef.h> |
|
|
1054 | .Ve |
|
|
1055 | .PP |
|
|
1056 | .Vb 6 |
|
|
1057 | \& static void |
|
|
1058 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1059 | \& { |
|
|
1060 | \& struct my_biggy big = (struct my_biggy * |
|
|
1061 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
|
|
1062 | \& } |
|
|
1063 | .Ve |
|
|
1064 | .PP |
|
|
1065 | .Vb 6 |
|
|
1066 | \& static void |
|
|
1067 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1068 | \& { |
|
|
1069 | \& struct my_biggy big = (struct my_biggy * |
|
|
1070 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
|
|
1071 | \& } |
|
|
1072 | .Ve |
823 | .SH "WATCHER TYPES" |
1073 | .SH "WATCHER TYPES" |
824 | .IX Header "WATCHER TYPES" |
1074 | .IX Header "WATCHER TYPES" |
825 | This section describes each watcher in detail, but will not repeat |
1075 | This section describes each watcher in detail, but will not repeat |
826 | information given in the last section. |
1076 | information given in the last section. Any initialisation/set macros, |
|
|
1077 | functions and members specific to the watcher type are explained. |
|
|
1078 | .PP |
|
|
1079 | Members are additionally marked with either \fI[read\-only]\fR, meaning that, |
|
|
1080 | while the watcher is active, you can look at the member and expect some |
|
|
1081 | sensible content, but you must not modify it (you can modify it while the |
|
|
1082 | watcher is stopped to your hearts content), or \fI[read\-write]\fR, which |
|
|
1083 | means you can expect it to have some sensible content while the watcher |
|
|
1084 | is active, but you can also modify it. Modifying it may not do something |
|
|
1085 | sensible or take immediate effect (or do anything at all), but libev will |
|
|
1086 | not crash or malfunction in any way. |
827 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" |
1087 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" |
828 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" |
1088 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" |
829 | .IX Subsection "ev_io - is this file descriptor readable or writable?" |
1089 | .IX Subsection "ev_io - is this file descriptor readable or writable?" |
830 | I/O watchers check whether a file descriptor is readable or writable |
1090 | I/O watchers check whether a file descriptor is readable or writable |
831 | in each iteration of the event loop, or, more precisely, when reading |
1091 | in each iteration of the event loop, or, more precisely, when reading |
… | |
… | |
859 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1119 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
860 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1120 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
861 | .PP |
1121 | .PP |
862 | If you cannot run the fd in non-blocking mode (for example you should not |
1122 | If you cannot run the fd in non-blocking mode (for example you should not |
863 | play around with an Xlib connection), then you have to seperately re-test |
1123 | play around with an Xlib connection), then you have to seperately re-test |
864 | wether a file descriptor is really ready with a known-to-be good interface |
1124 | whether a file descriptor is really ready with a known-to-be good interface |
865 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1125 | such as poll (fortunately in our Xlib example, Xlib already does this on |
866 | its own, so its quite safe to use). |
1126 | its own, so its quite safe to use). |
|
|
1127 | .PP |
|
|
1128 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1129 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1130 | .PP |
|
|
1131 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
|
|
1132 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
|
|
1133 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
|
|
1134 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1135 | this interest. If another file descriptor with the same number then is |
|
|
1136 | registered with libev, there is no efficient way to see that this is, in |
|
|
1137 | fact, a different file descriptor. |
|
|
1138 | .PP |
|
|
1139 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1140 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1141 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1142 | it is assumed that the file descriptor stays the same. That means that |
|
|
1143 | 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 |
|
|
1144 | descriptor even if the file descriptor number itself did not change. |
|
|
1145 | .PP |
|
|
1146 | This is how one would do it normally anyway, the important point is that |
|
|
1147 | the libev application should not optimise around libev but should leave |
|
|
1148 | optimisations to libev. |
|
|
1149 | .PP |
|
|
1150 | \fIThe special problem of dup'ed file descriptors\fR |
|
|
1151 | .IX Subsection "The special problem of dup'ed file descriptors" |
|
|
1152 | .PP |
|
|
1153 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1154 | but only events for the underlying file descriptions. That menas when you |
|
|
1155 | have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors and register events for them, only one |
|
|
1156 | file descriptor might actually receive events. |
|
|
1157 | .PP |
|
|
1158 | There is no workaorund possible except not registering events |
|
|
1159 | for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or to resort to |
|
|
1160 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1161 | .PP |
|
|
1162 | \fIThe special problem of fork\fR |
|
|
1163 | .IX Subsection "The special problem of fork" |
|
|
1164 | .PP |
|
|
1165 | Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit |
|
|
1166 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1167 | it in the child. |
|
|
1168 | .PP |
|
|
1169 | To support fork in your programs, you either have to call |
|
|
1170 | \&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, |
|
|
1171 | enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or |
|
|
1172 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1173 | .PP |
|
|
1174 | \fIWatcher-Specific Functions\fR |
|
|
1175 | .IX Subsection "Watcher-Specific Functions" |
867 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1176 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
868 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1177 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
869 | .PD 0 |
1178 | .PD 0 |
870 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1179 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
871 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1180 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
872 | .PD |
1181 | .PD |
873 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
1182 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
874 | rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
1183 | rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
875 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. |
1184 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. |
|
|
1185 | .IP "int fd [read\-only]" 4 |
|
|
1186 | .IX Item "int fd [read-only]" |
|
|
1187 | The file descriptor being watched. |
|
|
1188 | .IP "int events [read\-only]" 4 |
|
|
1189 | .IX Item "int events [read-only]" |
|
|
1190 | The events being watched. |
876 | .PP |
1191 | .PP |
877 | Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1192 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
878 | readable, but only once. Since it is likely line\-buffered, you could |
1193 | readable, but only once. Since it is likely line\-buffered, you could |
879 | attempt to read a whole line in the callback: |
1194 | attempt to read a whole line in the callback. |
880 | .PP |
1195 | .PP |
881 | .Vb 6 |
1196 | .Vb 6 |
882 | \& static void |
1197 | \& static void |
883 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1198 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
884 | \& { |
1199 | \& { |
… | |
… | |
918 | .Ve |
1233 | .Ve |
919 | .PP |
1234 | .PP |
920 | The callback is guarenteed to be invoked only when its timeout has passed, |
1235 | The callback is guarenteed to be invoked only when its timeout has passed, |
921 | but if multiple timers become ready during the same loop iteration then |
1236 | but if multiple timers become ready during the same loop iteration then |
922 | order of execution is undefined. |
1237 | order of execution is undefined. |
|
|
1238 | .PP |
|
|
1239 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1240 | .IX Subsection "Watcher-Specific Functions and Data Members" |
923 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1241 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
924 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1242 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
925 | .PD 0 |
1243 | .PD 0 |
926 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1244 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
927 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1245 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
… | |
… | |
939 | .IP "ev_timer_again (loop)" 4 |
1257 | .IP "ev_timer_again (loop)" 4 |
940 | .IX Item "ev_timer_again (loop)" |
1258 | .IX Item "ev_timer_again (loop)" |
941 | This will act as if the timer timed out and restart it again if it is |
1259 | This will act as if the timer timed out and restart it again if it is |
942 | repeating. The exact semantics are: |
1260 | repeating. The exact semantics are: |
943 | .Sp |
1261 | .Sp |
|
|
1262 | If the timer is pending, its pending status is cleared. |
|
|
1263 | .Sp |
944 | If the timer is started but nonrepeating, stop it. |
1264 | If the timer is started but nonrepeating, stop it (as if it timed out). |
945 | .Sp |
1265 | .Sp |
946 | If the timer is repeating, either start it if necessary (with the repeat |
1266 | If the timer is repeating, either start it if necessary (with the |
947 | value), or reset the running timer to the repeat value. |
1267 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
948 | .Sp |
1268 | .Sp |
949 | This sounds a bit complicated, but here is a useful and typical |
1269 | This sounds a bit complicated, but here is a useful and typical |
950 | example: Imagine you have a tcp connection and you want a so-called idle |
1270 | example: Imagine you have a tcp connection and you want a so-called idle |
951 | timeout, that is, you want to be called when there have been, say, 60 |
1271 | timeout, that is, you want to be called when there have been, say, 60 |
952 | seconds of inactivity on the socket. The easiest way to do this is to |
1272 | seconds of inactivity on the socket. The easiest way to do this is to |
953 | configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_timer_again each |
1273 | 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 |
954 | time you successfully read or write some data. If you go into an idle |
1274 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
955 | state where you do not expect data to travel on the socket, you can stop |
1275 | you go into an idle state where you do not expect data to travel on the |
956 | the timer, and again will automatically restart it if need be. |
1276 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
|
|
1277 | automatically restart it if need be. |
|
|
1278 | .Sp |
|
|
1279 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
|
|
1280 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
|
|
1281 | .Sp |
|
|
1282 | .Vb 8 |
|
|
1283 | \& ev_timer_init (timer, callback, 0., 5.); |
|
|
1284 | \& ev_timer_again (loop, timer); |
|
|
1285 | \& ... |
|
|
1286 | \& timer->again = 17.; |
|
|
1287 | \& ev_timer_again (loop, timer); |
|
|
1288 | \& ... |
|
|
1289 | \& timer->again = 10.; |
|
|
1290 | \& ev_timer_again (loop, timer); |
|
|
1291 | .Ve |
|
|
1292 | .Sp |
|
|
1293 | This is more slightly efficient then stopping/starting the timer each time |
|
|
1294 | you want to modify its timeout value. |
|
|
1295 | .IP "ev_tstamp repeat [read\-write]" 4 |
|
|
1296 | .IX Item "ev_tstamp repeat [read-write]" |
|
|
1297 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
|
|
1298 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
|
|
1299 | which is also when any modifications are taken into account. |
957 | .PP |
1300 | .PP |
958 | Example: create a timer that fires after 60 seconds. |
1301 | Example: Create a timer that fires after 60 seconds. |
959 | .PP |
1302 | .PP |
960 | .Vb 5 |
1303 | .Vb 5 |
961 | \& static void |
1304 | \& static void |
962 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1305 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
963 | \& { |
1306 | \& { |
… | |
… | |
969 | \& struct ev_timer mytimer; |
1312 | \& struct ev_timer mytimer; |
970 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1313 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
971 | \& ev_timer_start (loop, &mytimer); |
1314 | \& ev_timer_start (loop, &mytimer); |
972 | .Ve |
1315 | .Ve |
973 | .PP |
1316 | .PP |
974 | Example: create a timeout timer that times out after 10 seconds of |
1317 | Example: Create a timeout timer that times out after 10 seconds of |
975 | inactivity. |
1318 | inactivity. |
976 | .PP |
1319 | .PP |
977 | .Vb 5 |
1320 | .Vb 5 |
978 | \& static void |
1321 | \& static void |
979 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1322 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
… | |
… | |
1004 | but on wallclock time (absolute time). You can tell a periodic watcher |
1347 | but on wallclock time (absolute time). You can tell a periodic watcher |
1005 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1348 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1006 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1349 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1007 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1350 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1008 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1351 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1009 | roughly 10 seconds later and of course not if you reset your system time |
1352 | roughly 10 seconds later). |
1010 | again). |
|
|
1011 | .PP |
1353 | .PP |
1012 | They can also be used to implement vastly more complex timers, such as |
1354 | They can also be used to implement vastly more complex timers, such as |
1013 | triggering an event on eahc midnight, local time. |
1355 | triggering an event on each midnight, local time or other, complicated, |
|
|
1356 | rules. |
1014 | .PP |
1357 | .PP |
1015 | As with timers, the callback is guarenteed to be invoked only when the |
1358 | As with timers, the callback is guarenteed to be invoked only when the |
1016 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1359 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1017 | during the same loop iteration then order of execution is undefined. |
1360 | during the same loop iteration then order of execution is undefined. |
|
|
1361 | .PP |
|
|
1362 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1363 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1018 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1364 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1019 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1365 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1020 | .PD 0 |
1366 | .PD 0 |
1021 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1367 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1022 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1368 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1023 | .PD |
1369 | .PD |
1024 | Lots of arguments, lets sort it out... There are basically three modes of |
1370 | Lots of arguments, lets sort it out... There are basically three modes of |
1025 | operation, and we will explain them from simplest to complex: |
1371 | operation, and we will explain them from simplest to complex: |
1026 | .RS 4 |
1372 | .RS 4 |
1027 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
1373 | .IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 |
1028 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
1374 | .IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" |
1029 | In this configuration the watcher triggers an event at the wallclock time |
1375 | In this configuration the watcher triggers an event at the wallclock time |
1030 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1376 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1031 | that is, if it is to be run at January 1st 2011 then it will run when the |
1377 | that is, if it is to be run at January 1st 2011 then it will run when the |
1032 | system time reaches or surpasses this time. |
1378 | system time reaches or surpasses this time. |
1033 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
1379 | .IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 |
1034 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
1380 | .IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" |
1035 | In this mode the watcher will always be scheduled to time out at the next |
1381 | In this mode the watcher will always be scheduled to time out at the next |
1036 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
1382 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1037 | of any time jumps. |
1383 | and then repeat, regardless of any time jumps. |
1038 | .Sp |
1384 | .Sp |
1039 | This can be used to create timers that do not drift with respect to system |
1385 | This can be used to create timers that do not drift with respect to system |
1040 | time: |
1386 | time: |
1041 | .Sp |
1387 | .Sp |
1042 | .Vb 1 |
1388 | .Vb 1 |
… | |
… | |
1049 | by 3600. |
1395 | by 3600. |
1050 | .Sp |
1396 | .Sp |
1051 | Another way to think about it (for the mathematically inclined) is that |
1397 | Another way to think about it (for the mathematically inclined) is that |
1052 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1398 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1053 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1399 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
|
|
1400 | .Sp |
|
|
1401 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
|
|
1402 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
1403 | this value. |
1054 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
1404 | .IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 |
1055 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
1405 | .IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" |
1056 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1406 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1057 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1407 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1058 | reschedule callback will be called with the watcher as first, and the |
1408 | reschedule callback will be called with the watcher as first, and the |
1059 | current time as second argument. |
1409 | current time as second argument. |
1060 | .Sp |
1410 | .Sp |
1061 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1411 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1062 | ever, or make any event loop modifications\fR. If you need to stop it, |
1412 | ever, or make any event loop modifications\fR. If you need to stop it, |
1063 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1413 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1064 | starting a prepare watcher). |
1414 | starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). |
1065 | .Sp |
1415 | .Sp |
1066 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1416 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1067 | ev_tstamp now)\*(C'\fR, e.g.: |
1417 | ev_tstamp now)\*(C'\fR, e.g.: |
1068 | .Sp |
1418 | .Sp |
1069 | .Vb 4 |
1419 | .Vb 4 |
… | |
… | |
1093 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1443 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1094 | Simply stops and restarts the periodic watcher again. This is only useful |
1444 | Simply stops and restarts the periodic watcher again. This is only useful |
1095 | when you changed some parameters or the reschedule callback would return |
1445 | when you changed some parameters or the reschedule callback would return |
1096 | a different time than the last time it was called (e.g. in a crond like |
1446 | a different time than the last time it was called (e.g. in a crond like |
1097 | program when the crontabs have changed). |
1447 | program when the crontabs have changed). |
|
|
1448 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
1449 | .IX Item "ev_tstamp offset [read-write]" |
|
|
1450 | When repeating, this contains the offset value, otherwise this is the |
|
|
1451 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
|
|
1452 | .Sp |
|
|
1453 | Can be modified any time, but changes only take effect when the periodic |
|
|
1454 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
|
|
1455 | .IP "ev_tstamp interval [read\-write]" 4 |
|
|
1456 | .IX Item "ev_tstamp interval [read-write]" |
|
|
1457 | The current interval value. Can be modified any time, but changes only |
|
|
1458 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
|
|
1459 | called. |
|
|
1460 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
|
|
1461 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
|
|
1462 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
|
|
1463 | switched off. Can be changed any time, but changes only take effect when |
|
|
1464 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
|
|
1465 | .IP "ev_tstamp at [read\-only]" 4 |
|
|
1466 | .IX Item "ev_tstamp at [read-only]" |
|
|
1467 | When active, contains the absolute time that the watcher is supposed to |
|
|
1468 | trigger next. |
1098 | .PP |
1469 | .PP |
1099 | Example: call a callback every hour, or, more precisely, whenever the |
1470 | Example: Call a callback every hour, or, more precisely, whenever the |
1100 | system clock is divisible by 3600. The callback invocation times have |
1471 | system clock is divisible by 3600. The callback invocation times have |
1101 | potentially a lot of jittering, but good long-term stability. |
1472 | potentially a lot of jittering, but good long-term stability. |
1102 | .PP |
1473 | .PP |
1103 | .Vb 5 |
1474 | .Vb 5 |
1104 | \& static void |
1475 | \& static void |
… | |
… | |
1112 | \& struct ev_periodic hourly_tick; |
1483 | \& struct ev_periodic hourly_tick; |
1113 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1484 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1114 | \& ev_periodic_start (loop, &hourly_tick); |
1485 | \& ev_periodic_start (loop, &hourly_tick); |
1115 | .Ve |
1486 | .Ve |
1116 | .PP |
1487 | .PP |
1117 | Example: the same as above, but use a reschedule callback to do it: |
1488 | Example: The same as above, but use a reschedule callback to do it: |
1118 | .PP |
1489 | .PP |
1119 | .Vb 1 |
1490 | .Vb 1 |
1120 | \& #include <math.h> |
1491 | \& #include <math.h> |
1121 | .Ve |
1492 | .Ve |
1122 | .PP |
1493 | .PP |
… | |
… | |
1130 | .PP |
1501 | .PP |
1131 | .Vb 1 |
1502 | .Vb 1 |
1132 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1503 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1133 | .Ve |
1504 | .Ve |
1134 | .PP |
1505 | .PP |
1135 | Example: call a callback every hour, starting now: |
1506 | Example: Call a callback every hour, starting now: |
1136 | .PP |
1507 | .PP |
1137 | .Vb 4 |
1508 | .Vb 4 |
1138 | \& struct ev_periodic hourly_tick; |
1509 | \& struct ev_periodic hourly_tick; |
1139 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1510 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1140 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1511 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
… | |
… | |
1152 | first watcher gets started will libev actually register a signal watcher |
1523 | first watcher gets started will libev actually register a signal watcher |
1153 | with the kernel (thus it coexists with your own signal handlers as long |
1524 | with the kernel (thus it coexists with your own signal handlers as long |
1154 | as you don't register any with libev). Similarly, when the last signal |
1525 | as you don't register any with libev). Similarly, when the last signal |
1155 | watcher for a signal is stopped libev will reset the signal handler to |
1526 | watcher for a signal is stopped libev will reset the signal handler to |
1156 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
1527 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
|
|
1528 | .PP |
|
|
1529 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1530 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1157 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1531 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1158 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1532 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1159 | .PD 0 |
1533 | .PD 0 |
1160 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1534 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1161 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1535 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1162 | .PD |
1536 | .PD |
1163 | Configures the watcher to trigger on the given signal number (usually one |
1537 | Configures the watcher to trigger on the given signal number (usually one |
1164 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
1538 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
|
|
1539 | .IP "int signum [read\-only]" 4 |
|
|
1540 | .IX Item "int signum [read-only]" |
|
|
1541 | The signal the watcher watches out for. |
1165 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1542 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1166 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1543 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1167 | .IX Subsection "ev_child - watch out for process status changes" |
1544 | .IX Subsection "ev_child - watch out for process status changes" |
1168 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1545 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1169 | some child status changes (most typically when a child of yours dies). |
1546 | some child status changes (most typically when a child of yours dies). |
|
|
1547 | .PP |
|
|
1548 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1549 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1170 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1550 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1171 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1551 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1172 | .PD 0 |
1552 | .PD 0 |
1173 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1553 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1174 | .IX Item "ev_child_set (ev_child *, int pid)" |
1554 | .IX Item "ev_child_set (ev_child *, int pid)" |
… | |
… | |
1177 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
1557 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
1178 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
1558 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
1179 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
1559 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
1180 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
1560 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
1181 | process causing the status change. |
1561 | process causing the status change. |
|
|
1562 | .IP "int pid [read\-only]" 4 |
|
|
1563 | .IX Item "int pid [read-only]" |
|
|
1564 | The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. |
|
|
1565 | .IP "int rpid [read\-write]" 4 |
|
|
1566 | .IX Item "int rpid [read-write]" |
|
|
1567 | The process id that detected a status change. |
|
|
1568 | .IP "int rstatus [read\-write]" 4 |
|
|
1569 | .IX Item "int rstatus [read-write]" |
|
|
1570 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
|
|
1571 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1182 | .PP |
1572 | .PP |
1183 | Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1573 | Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1184 | .PP |
1574 | .PP |
1185 | .Vb 5 |
1575 | .Vb 5 |
1186 | \& static void |
1576 | \& static void |
1187 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1577 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1188 | \& { |
1578 | \& { |
… | |
… | |
1193 | .Vb 3 |
1583 | .Vb 3 |
1194 | \& struct ev_signal signal_watcher; |
1584 | \& struct ev_signal signal_watcher; |
1195 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1585 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1196 | \& ev_signal_start (loop, &sigint_cb); |
1586 | \& ev_signal_start (loop, &sigint_cb); |
1197 | .Ve |
1587 | .Ve |
|
|
1588 | .ie n .Sh """ev_stat"" \- did the file attributes just change?" |
|
|
1589 | .el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" |
|
|
1590 | .IX Subsection "ev_stat - did the file attributes just change?" |
|
|
1591 | This watches a filesystem path for attribute changes. That is, it calls |
|
|
1592 | \&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed |
|
|
1593 | compared to the last time, invoking the callback if it did. |
|
|
1594 | .PP |
|
|
1595 | The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does |
|
|
1596 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
|
|
1597 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
|
|
1598 | otherwise always forced to be at least one) and all the other fields of |
|
|
1599 | the stat buffer having unspecified contents. |
|
|
1600 | .PP |
|
|
1601 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
|
|
1602 | relative and your working directory changes, the behaviour is undefined. |
|
|
1603 | .PP |
|
|
1604 | Since there is no standard to do this, the portable implementation simply |
|
|
1605 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
|
|
1606 | can specify a recommended polling interval for this case. If you specify |
|
|
1607 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
|
|
1608 | unspecified default\fR value will be used (which you can expect to be around |
|
|
1609 | five seconds, although this might change dynamically). Libev will also |
|
|
1610 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
|
|
1611 | usually overkill. |
|
|
1612 | .PP |
|
|
1613 | This watcher type is not meant for massive numbers of stat watchers, |
|
|
1614 | as even with OS-supported change notifications, this can be |
|
|
1615 | resource\-intensive. |
|
|
1616 | .PP |
|
|
1617 | At the time of this writing, only the Linux inotify interface is |
|
|
1618 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1619 | reader). Inotify will be used to give hints only and should not change the |
|
|
1620 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
|
|
1621 | to fall back to regular polling again even with inotify, but changes are |
|
|
1622 | usually detected immediately, and if the file exists there will be no |
|
|
1623 | polling. |
|
|
1624 | .PP |
|
|
1625 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1626 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
1627 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
|
|
1628 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
|
|
1629 | .PD 0 |
|
|
1630 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
|
|
1631 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
|
|
1632 | .PD |
|
|
1633 | Configures the watcher to wait for status changes of the given |
|
|
1634 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
|
|
1635 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
|
|
1636 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
|
|
1637 | path for as long as the watcher is active. |
|
|
1638 | .Sp |
|
|
1639 | The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, |
|
|
1640 | relative to the attributes at the time the watcher was started (or the |
|
|
1641 | last change was detected). |
|
|
1642 | .IP "ev_stat_stat (ev_stat *)" 4 |
|
|
1643 | .IX Item "ev_stat_stat (ev_stat *)" |
|
|
1644 | Updates the stat buffer immediately with new values. If you change the |
|
|
1645 | watched path in your callback, you could call this fucntion to avoid |
|
|
1646 | detecting this change (while introducing a race condition). Can also be |
|
|
1647 | useful simply to find out the new values. |
|
|
1648 | .IP "ev_statdata attr [read\-only]" 4 |
|
|
1649 | .IX Item "ev_statdata attr [read-only]" |
|
|
1650 | The most-recently detected attributes of the file. Although the type is of |
|
|
1651 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
|
|
1652 | suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there |
|
|
1653 | was some error while \f(CW\*(C`stat\*(C'\fRing the file. |
|
|
1654 | .IP "ev_statdata prev [read\-only]" 4 |
|
|
1655 | .IX Item "ev_statdata prev [read-only]" |
|
|
1656 | The previous attributes of the file. The callback gets invoked whenever |
|
|
1657 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. |
|
|
1658 | .IP "ev_tstamp interval [read\-only]" 4 |
|
|
1659 | .IX Item "ev_tstamp interval [read-only]" |
|
|
1660 | The specified interval. |
|
|
1661 | .IP "const char *path [read\-only]" 4 |
|
|
1662 | .IX Item "const char *path [read-only]" |
|
|
1663 | The filesystem path that is being watched. |
|
|
1664 | .PP |
|
|
1665 | Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. |
|
|
1666 | .PP |
|
|
1667 | .Vb 15 |
|
|
1668 | \& static void |
|
|
1669 | \& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
|
|
1670 | \& { |
|
|
1671 | \& /* /etc/passwd changed in some way */ |
|
|
1672 | \& if (w->attr.st_nlink) |
|
|
1673 | \& { |
|
|
1674 | \& printf ("passwd current size %ld\en", (long)w->attr.st_size); |
|
|
1675 | \& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); |
|
|
1676 | \& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); |
|
|
1677 | \& } |
|
|
1678 | \& else |
|
|
1679 | \& /* you shalt not abuse printf for puts */ |
|
|
1680 | \& puts ("wow, /etc/passwd is not there, expect problems. " |
|
|
1681 | \& "if this is windows, they already arrived\en"); |
|
|
1682 | \& } |
|
|
1683 | .Ve |
|
|
1684 | .PP |
|
|
1685 | .Vb 2 |
|
|
1686 | \& ... |
|
|
1687 | \& ev_stat passwd; |
|
|
1688 | .Ve |
|
|
1689 | .PP |
|
|
1690 | .Vb 2 |
|
|
1691 | \& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
|
|
1692 | \& ev_stat_start (loop, &passwd); |
|
|
1693 | .Ve |
1198 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1694 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1199 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1695 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1200 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1696 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1201 | Idle watchers trigger events when there are no other events are pending |
1697 | Idle watchers trigger events when no other events of the same or higher |
1202 | (prepare, check and other idle watchers do not count). That is, as long |
1698 | priority are pending (prepare, check and other idle watchers do not |
1203 | as your process is busy handling sockets or timeouts (or even signals, |
1699 | count). |
1204 | imagine) it will not be triggered. But when your process is idle all idle |
1700 | .PP |
1205 | watchers are being called again and again, once per event loop iteration \- |
1701 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1702 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1703 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1704 | are pending), the idle watchers are being called once per event loop |
1206 | until stopped, that is, or your process receives more events and becomes |
1705 | iteration \- until stopped, that is, or your process receives more events |
1207 | busy. |
1706 | and becomes busy again with higher priority stuff. |
1208 | .PP |
1707 | .PP |
1209 | The most noteworthy effect is that as long as any idle watchers are |
1708 | The most noteworthy effect is that as long as any idle watchers are |
1210 | active, the process will not block when waiting for new events. |
1709 | active, the process will not block when waiting for new events. |
1211 | .PP |
1710 | .PP |
1212 | Apart from keeping your process non-blocking (which is a useful |
1711 | Apart from keeping your process non-blocking (which is a useful |
1213 | effect on its own sometimes), idle watchers are a good place to do |
1712 | effect on its own sometimes), idle watchers are a good place to do |
1214 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1713 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1215 | event loop has handled all outstanding events. |
1714 | event loop has handled all outstanding events. |
|
|
1715 | .PP |
|
|
1716 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1717 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1216 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1718 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1217 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1719 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1218 | Initialises and configures the idle watcher \- it has no parameters of any |
1720 | Initialises and configures the idle watcher \- it has no parameters of any |
1219 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1721 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1220 | believe me. |
1722 | believe me. |
1221 | .PP |
1723 | .PP |
1222 | Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the |
1724 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
1223 | callback, free it. Alos, use no error checking, as usual. |
1725 | callback, free it. Also, use no error checking, as usual. |
1224 | .PP |
1726 | .PP |
1225 | .Vb 7 |
1727 | .Vb 7 |
1226 | \& static void |
1728 | \& static void |
1227 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1729 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1228 | \& { |
1730 | \& { |
… | |
… | |
1275 | are ready to run (it's actually more complicated: it only runs coroutines |
1777 | are ready to run (it's actually more complicated: it only runs coroutines |
1276 | with priority higher than or equal to the event loop and one coroutine |
1778 | with priority higher than or equal to the event loop and one coroutine |
1277 | of lower priority, but only once, using idle watchers to keep the event |
1779 | of lower priority, but only once, using idle watchers to keep the event |
1278 | loop from blocking if lower-priority coroutines are active, thus mapping |
1780 | loop from blocking if lower-priority coroutines are active, thus mapping |
1279 | low-priority coroutines to idle/background tasks). |
1781 | low-priority coroutines to idle/background tasks). |
|
|
1782 | .PP |
|
|
1783 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
1784 | priority, to ensure that they are being run before any other watchers |
|
|
1785 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
|
|
1786 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
|
|
1787 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did |
|
|
1788 | their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event |
|
|
1789 | loops those other event loops might be in an unusable state until their |
|
|
1790 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
|
|
1791 | others). |
|
|
1792 | .PP |
|
|
1793 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1794 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1280 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1795 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1281 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1796 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1282 | .PD 0 |
1797 | .PD 0 |
1283 | .IP "ev_check_init (ev_check *, callback)" 4 |
1798 | .IP "ev_check_init (ev_check *, callback)" 4 |
1284 | .IX Item "ev_check_init (ev_check *, callback)" |
1799 | .IX Item "ev_check_init (ev_check *, callback)" |
1285 | .PD |
1800 | .PD |
1286 | Initialises and configures the prepare or check watcher \- they have no |
1801 | Initialises and configures the prepare or check watcher \- they have no |
1287 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1802 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1288 | macros, but using them is utterly, utterly and completely pointless. |
1803 | macros, but using them is utterly, utterly and completely pointless. |
1289 | .PP |
1804 | .PP |
1290 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
1805 | There are a number of principal ways to embed other event loops or modules |
1291 | and a timeout watcher in a prepare handler, as required by libadns, and |
1806 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1807 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
1808 | use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR |
|
|
1809 | embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 |
|
|
1810 | into the Glib event loop). |
|
|
1811 | .PP |
|
|
1812 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
1292 | in a check watcher, destroy them and call into libadns. What follows is |
1813 | and in a check watcher, destroy them and call into libadns. What follows |
1293 | pseudo-code only of course: |
1814 | is pseudo-code only of course. This requires you to either use a low |
|
|
1815 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
1816 | the callbacks for the IO/timeout watchers might not have been called yet. |
1294 | .PP |
1817 | .PP |
1295 | .Vb 2 |
1818 | .Vb 2 |
1296 | \& static ev_io iow [nfd]; |
1819 | \& static ev_io iow [nfd]; |
1297 | \& static ev_timer tw; |
1820 | \& static ev_timer tw; |
1298 | .Ve |
1821 | .Ve |
1299 | .PP |
1822 | .PP |
1300 | .Vb 8 |
1823 | .Vb 4 |
1301 | \& static void |
1824 | \& static void |
1302 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1825 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1303 | \& { |
1826 | \& { |
1304 | \& // set the relevant poll flags |
|
|
1305 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1306 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1307 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1308 | \& } |
1827 | \& } |
1309 | .Ve |
1828 | .Ve |
1310 | .PP |
1829 | .PP |
1311 | .Vb 7 |
1830 | .Vb 8 |
1312 | \& // create io watchers for each fd and a timer before blocking |
1831 | \& // create io watchers for each fd and a timer before blocking |
1313 | \& static void |
1832 | \& static void |
1314 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1833 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1315 | \& { |
1834 | \& { |
1316 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
1835 | \& int timeout = 3600000; |
|
|
1836 | \& struct pollfd fds [nfd]; |
1317 | \& // actual code will need to loop here and realloc etc. |
1837 | \& // actual code will need to loop here and realloc etc. |
1318 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1838 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1319 | .Ve |
1839 | .Ve |
1320 | .PP |
1840 | .PP |
1321 | .Vb 3 |
1841 | .Vb 3 |
… | |
… | |
1323 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1843 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1324 | \& ev_timer_start (loop, &tw); |
1844 | \& ev_timer_start (loop, &tw); |
1325 | .Ve |
1845 | .Ve |
1326 | .PP |
1846 | .PP |
1327 | .Vb 6 |
1847 | .Vb 6 |
1328 | \& // create on ev_io per pollfd |
1848 | \& // create one ev_io per pollfd |
1329 | \& for (int i = 0; i < nfd; ++i) |
1849 | \& for (int i = 0; i < nfd; ++i) |
1330 | \& { |
1850 | \& { |
1331 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1851 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1332 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1852 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1333 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1853 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1334 | .Ve |
1854 | .Ve |
1335 | .PP |
1855 | .PP |
1336 | .Vb 5 |
1856 | .Vb 4 |
1337 | \& fds [i].revents = 0; |
1857 | \& fds [i].revents = 0; |
1338 | \& iow [i].data = fds + i; |
|
|
1339 | \& ev_io_start (loop, iow + i); |
1858 | \& ev_io_start (loop, iow + i); |
1340 | \& } |
1859 | \& } |
1341 | \& } |
1860 | \& } |
1342 | .Ve |
1861 | .Ve |
1343 | .PP |
1862 | .PP |
… | |
… | |
1347 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1866 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1348 | \& { |
1867 | \& { |
1349 | \& ev_timer_stop (loop, &tw); |
1868 | \& ev_timer_stop (loop, &tw); |
1350 | .Ve |
1869 | .Ve |
1351 | .PP |
1870 | .PP |
1352 | .Vb 2 |
1871 | .Vb 8 |
1353 | \& for (int i = 0; i < nfd; ++i) |
1872 | \& for (int i = 0; i < nfd; ++i) |
|
|
1873 | \& { |
|
|
1874 | \& // set the relevant poll flags |
|
|
1875 | \& // could also call adns_processreadable etc. here |
|
|
1876 | \& struct pollfd *fd = fds + i; |
|
|
1877 | \& int revents = ev_clear_pending (iow + i); |
|
|
1878 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1879 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1880 | .Ve |
|
|
1881 | .PP |
|
|
1882 | .Vb 3 |
|
|
1883 | \& // now stop the watcher |
1354 | \& ev_io_stop (loop, iow + i); |
1884 | \& ev_io_stop (loop, iow + i); |
|
|
1885 | \& } |
1355 | .Ve |
1886 | .Ve |
1356 | .PP |
1887 | .PP |
1357 | .Vb 2 |
1888 | .Vb 2 |
1358 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1889 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1890 | \& } |
|
|
1891 | .Ve |
|
|
1892 | .PP |
|
|
1893 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
1894 | in the prepare watcher and would dispose of the check watcher. |
|
|
1895 | .PP |
|
|
1896 | Method 3: If the module to be embedded supports explicit event |
|
|
1897 | notification (adns does), you can also make use of the actual watcher |
|
|
1898 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1899 | .PP |
|
|
1900 | .Vb 5 |
|
|
1901 | \& static void |
|
|
1902 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1903 | \& { |
|
|
1904 | \& adns_state ads = (adns_state)w->data; |
|
|
1905 | \& update_now (EV_A); |
|
|
1906 | .Ve |
|
|
1907 | .PP |
|
|
1908 | .Vb 2 |
|
|
1909 | \& adns_processtimeouts (ads, &tv_now); |
|
|
1910 | \& } |
|
|
1911 | .Ve |
|
|
1912 | .PP |
|
|
1913 | .Vb 5 |
|
|
1914 | \& static void |
|
|
1915 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
1916 | \& { |
|
|
1917 | \& adns_state ads = (adns_state)w->data; |
|
|
1918 | \& update_now (EV_A); |
|
|
1919 | .Ve |
|
|
1920 | .PP |
|
|
1921 | .Vb 3 |
|
|
1922 | \& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1923 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1924 | \& } |
|
|
1925 | .Ve |
|
|
1926 | .PP |
|
|
1927 | .Vb 1 |
|
|
1928 | \& // do not ever call adns_afterpoll |
|
|
1929 | .Ve |
|
|
1930 | .PP |
|
|
1931 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1932 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1933 | their poll function. The drawback with this solution is that the main |
|
|
1934 | loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does |
|
|
1935 | this. |
|
|
1936 | .PP |
|
|
1937 | .Vb 4 |
|
|
1938 | \& static gint |
|
|
1939 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1940 | \& { |
|
|
1941 | \& int got_events = 0; |
|
|
1942 | .Ve |
|
|
1943 | .PP |
|
|
1944 | .Vb 2 |
|
|
1945 | \& for (n = 0; n < nfds; ++n) |
|
|
1946 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1947 | .Ve |
|
|
1948 | .PP |
|
|
1949 | .Vb 2 |
|
|
1950 | \& if (timeout >= 0) |
|
|
1951 | \& // create/start timer |
|
|
1952 | .Ve |
|
|
1953 | .PP |
|
|
1954 | .Vb 2 |
|
|
1955 | \& // poll |
|
|
1956 | \& ev_loop (EV_A_ 0); |
|
|
1957 | .Ve |
|
|
1958 | .PP |
|
|
1959 | .Vb 3 |
|
|
1960 | \& // stop timer again |
|
|
1961 | \& if (timeout >= 0) |
|
|
1962 | \& ev_timer_stop (EV_A_ &to); |
|
|
1963 | .Ve |
|
|
1964 | .PP |
|
|
1965 | .Vb 3 |
|
|
1966 | \& // stop io watchers again - their callbacks should have set |
|
|
1967 | \& for (n = 0; n < nfds; ++n) |
|
|
1968 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
1969 | .Ve |
|
|
1970 | .PP |
|
|
1971 | .Vb 2 |
|
|
1972 | \& return got_events; |
1359 | \& } |
1973 | \& } |
1360 | .Ve |
1974 | .Ve |
1361 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1975 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1362 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1976 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1363 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1977 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1364 | This is a rather advanced watcher type that lets you embed one event loop |
1978 | This is a rather advanced watcher type that lets you embed one event loop |
1365 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
1979 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
1366 | loop, other types of watchers might be handled in a delayed or incorrect |
1980 | loop, other types of watchers might be handled in a delayed or incorrect |
1367 | fashion and must not be used). |
1981 | fashion and must not be used). (See portability notes, below). |
1368 | .PP |
1982 | .PP |
1369 | There are primarily two reasons you would want that: work around bugs and |
1983 | There are primarily two reasons you would want that: work around bugs and |
1370 | prioritise I/O. |
1984 | prioritise I/O. |
1371 | .PP |
1985 | .PP |
1372 | As an example for a bug workaround, the kqueue backend might only support |
1986 | As an example for a bug workaround, the kqueue backend might only support |
… | |
… | |
1432 | \& ev_embed_start (loop_hi, &embed); |
2046 | \& ev_embed_start (loop_hi, &embed); |
1433 | \& } |
2047 | \& } |
1434 | \& else |
2048 | \& else |
1435 | \& loop_lo = loop_hi; |
2049 | \& loop_lo = loop_hi; |
1436 | .Ve |
2050 | .Ve |
|
|
2051 | .Sh "Portability notes" |
|
|
2052 | .IX Subsection "Portability notes" |
|
|
2053 | Kqueue is nominally embeddable, but this is broken on all BSDs that I |
|
|
2054 | tried, in various ways. Usually the embedded event loop will simply never |
|
|
2055 | receive events, sometimes it will only trigger a few times, sometimes in a |
|
|
2056 | loop. Epoll is also nominally embeddable, but many Linux kernel versions |
|
|
2057 | will always eport the epoll fd as ready, even when no events are pending. |
|
|
2058 | .PP |
|
|
2059 | While libev allows embedding these backends (they are contained in |
|
|
2060 | \&\f(CW\*(C`ev_embeddable_backends ()\*(C'\fR), take extreme care that it will actually |
|
|
2061 | work. |
|
|
2062 | .PP |
|
|
2063 | When in doubt, create a dynamic event loop forced to use sockets (this |
|
|
2064 | usually works) and possibly another thread and a pipe or so to report to |
|
|
2065 | your main event loop. |
|
|
2066 | .PP |
|
|
2067 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2068 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1437 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2069 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1438 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2070 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1439 | .PD 0 |
2071 | .PD 0 |
1440 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2072 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1441 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2073 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
… | |
… | |
1448 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
2080 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
1449 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
2081 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
1450 | Make a single, non-blocking sweep over the embedded loop. This works |
2082 | Make a single, non-blocking sweep over the embedded loop. This works |
1451 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
2083 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
1452 | apropriate way for embedded loops. |
2084 | apropriate way for embedded loops. |
|
|
2085 | .IP "struct ev_loop *other [read\-only]" 4 |
|
|
2086 | .IX Item "struct ev_loop *other [read-only]" |
|
|
2087 | The embedded event loop. |
|
|
2088 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
|
|
2089 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
|
|
2090 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
|
|
2091 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
|
|
2092 | whoever is a good citizen cared to tell libev about it by calling |
|
|
2093 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
|
|
2094 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
|
|
2095 | and only in the child after the fork. If whoever good citizen calling |
|
|
2096 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
|
|
2097 | handlers will be invoked, too, of course. |
|
|
2098 | .PP |
|
|
2099 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2100 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
2101 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
|
|
2102 | .IX Item "ev_fork_init (ev_signal *, callback)" |
|
|
2103 | Initialises and configures the fork watcher \- it has no parameters of any |
|
|
2104 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
|
|
2105 | believe me. |
1453 | .SH "OTHER FUNCTIONS" |
2106 | .SH "OTHER FUNCTIONS" |
1454 | .IX Header "OTHER FUNCTIONS" |
2107 | .IX Header "OTHER FUNCTIONS" |
1455 | There are some other functions of possible interest. Described. Here. Now. |
2108 | There are some other functions of possible interest. Described. Here. Now. |
1456 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
2109 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
1457 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
2110 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
… | |
… | |
1529 | .PP |
2182 | .PP |
1530 | .Vb 1 |
2183 | .Vb 1 |
1531 | \& #include <ev++.h> |
2184 | \& #include <ev++.h> |
1532 | .Ve |
2185 | .Ve |
1533 | .PP |
2186 | .PP |
1534 | (it is not installed by default). This automatically includes \fIev.h\fR |
2187 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1535 | and puts all of its definitions (many of them macros) into the global |
2188 | of them macros) into the global namespace. All \*(C+ specific things are |
1536 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
2189 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
2190 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1537 | .PP |
2191 | .PP |
1538 | It should support all the same embedding options as \fIev.h\fR, most notably |
2192 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1539 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
2193 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
2194 | that the watcher is associated with (or no additional members at all if |
|
|
2195 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
2196 | .PP |
|
|
2197 | Currently, functions, and static and non-static member functions can be |
|
|
2198 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2199 | need one additional pointer for context. If you need support for other |
|
|
2200 | types of functors please contact the author (preferably after implementing |
|
|
2201 | it). |
1540 | .PP |
2202 | .PP |
1541 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
2203 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1542 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
2204 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
1543 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
2205 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1544 | .IX Item "ev::READ, ev::WRITE etc." |
2206 | .IX Item "ev::READ, ev::WRITE etc." |
… | |
… | |
1556 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
2218 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1557 | defines by many implementations. |
2219 | defines by many implementations. |
1558 | .Sp |
2220 | .Sp |
1559 | All of those classes have these methods: |
2221 | All of those classes have these methods: |
1560 | .RS 4 |
2222 | .RS 4 |
1561 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
2223 | .IP "ev::TYPE::TYPE ()" 4 |
1562 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
2224 | .IX Item "ev::TYPE::TYPE ()" |
1563 | .PD 0 |
2225 | .PD 0 |
1564 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
2226 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
1565 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
2227 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
1566 | .IP "ev::TYPE::~TYPE" 4 |
2228 | .IP "ev::TYPE::~TYPE" 4 |
1567 | .IX Item "ev::TYPE::~TYPE" |
2229 | .IX Item "ev::TYPE::~TYPE" |
1568 | .PD |
2230 | .PD |
1569 | The constructor takes a pointer to an object and a method pointer to |
2231 | The constructor (optionally) takes an event loop to associate the watcher |
1570 | the event handler callback to call in this class. The constructor calls |
2232 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
1571 | \&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method |
2233 | .Sp |
1572 | before starting it. If you do not specify a loop then the constructor |
2234 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
1573 | automatically associates the default loop with this watcher. |
2235 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
2236 | .Sp |
|
|
2237 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
2238 | method to set a callback before you can start the watcher. |
|
|
2239 | .Sp |
|
|
2240 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
2241 | not allow explicit template arguments for constructors). |
1574 | .Sp |
2242 | .Sp |
1575 | The destructor automatically stops the watcher if it is active. |
2243 | The destructor automatically stops the watcher if it is active. |
|
|
2244 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
2245 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
2246 | This method sets the callback method to call. The method has to have a |
|
|
2247 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
2248 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
2249 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
2250 | .Sp |
|
|
2251 | This method synthesizes efficient thunking code to call your method from |
|
|
2252 | the C callback that libev requires. If your compiler can inline your |
|
|
2253 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
2254 | your compiler is good :), then the method will be fully inlined into the |
|
|
2255 | thunking function, making it as fast as a direct C callback. |
|
|
2256 | .Sp |
|
|
2257 | Example: simple class declaration and watcher initialisation |
|
|
2258 | .Sp |
|
|
2259 | .Vb 4 |
|
|
2260 | \& struct myclass |
|
|
2261 | \& { |
|
|
2262 | \& void io_cb (ev::io &w, int revents) { } |
|
|
2263 | \& } |
|
|
2264 | .Ve |
|
|
2265 | .Sp |
|
|
2266 | .Vb 3 |
|
|
2267 | \& myclass obj; |
|
|
2268 | \& ev::io iow; |
|
|
2269 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
2270 | .Ve |
|
|
2271 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
2272 | .IX Item "w->set<function> (void *data = 0)" |
|
|
2273 | Also sets a callback, but uses a static method or plain function as |
|
|
2274 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
2275 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
2276 | .Sp |
|
|
2277 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
2278 | .Sp |
|
|
2279 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
2280 | .Sp |
|
|
2281 | Example: |
|
|
2282 | .Sp |
|
|
2283 | .Vb 2 |
|
|
2284 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
2285 | \& iow.set <io_cb> (); |
|
|
2286 | .Ve |
1576 | .IP "w\->set (struct ev_loop *)" 4 |
2287 | .IP "w\->set (struct ev_loop *)" 4 |
1577 | .IX Item "w->set (struct ev_loop *)" |
2288 | .IX Item "w->set (struct ev_loop *)" |
1578 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
2289 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1579 | do this when the watcher is inactive (and not pending either). |
2290 | do this when the watcher is inactive (and not pending either). |
1580 | .IP "w\->set ([args])" 4 |
2291 | .IP "w\->set ([args])" 4 |
1581 | .IX Item "w->set ([args])" |
2292 | .IX Item "w->set ([args])" |
1582 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
2293 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
1583 | called at least once. Unlike the C counterpart, an active watcher gets |
2294 | called at least once. Unlike the C counterpart, an active watcher gets |
1584 | automatically stopped and restarted. |
2295 | automatically stopped and restarted when reconfiguring it with this |
|
|
2296 | method. |
1585 | .IP "w\->start ()" 4 |
2297 | .IP "w\->start ()" 4 |
1586 | .IX Item "w->start ()" |
2298 | .IX Item "w->start ()" |
1587 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
2299 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
1588 | constructor already takes the loop. |
2300 | constructor already stores the event loop. |
1589 | .IP "w\->stop ()" 4 |
2301 | .IP "w\->stop ()" 4 |
1590 | .IX Item "w->stop ()" |
2302 | .IX Item "w->stop ()" |
1591 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2303 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
1592 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
2304 | .ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 |
1593 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
2305 | .el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 |
1594 | .IX Item "w->again () ev::timer, ev::periodic only" |
2306 | .IX Item "w->again () (ev::timer, ev::periodic only)" |
1595 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
2307 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
1596 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
2308 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
1597 | .ie n .IP "w\->sweep () ""ev::embed"" only" 4 |
2309 | .ie n .IP "w\->sweep () (""ev::embed"" only)" 4 |
1598 | .el .IP "w\->sweep () \f(CWev::embed\fR only" 4 |
2310 | .el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 |
1599 | .IX Item "w->sweep () ev::embed only" |
2311 | .IX Item "w->sweep () (ev::embed only)" |
1600 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
2312 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
|
|
2313 | .ie n .IP "w\->update () (""ev::stat"" only)" 4 |
|
|
2314 | .el .IP "w\->update () (\f(CWev::stat\fR only)" 4 |
|
|
2315 | .IX Item "w->update () (ev::stat only)" |
|
|
2316 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
1601 | .RE |
2317 | .RE |
1602 | .RS 4 |
2318 | .RS 4 |
1603 | .RE |
2319 | .RE |
1604 | .PP |
2320 | .PP |
1605 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
2321 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
… | |
… | |
1615 | .Vb 2 |
2331 | .Vb 2 |
1616 | \& myclass (); |
2332 | \& myclass (); |
1617 | \& } |
2333 | \& } |
1618 | .Ve |
2334 | .Ve |
1619 | .PP |
2335 | .PP |
1620 | .Vb 6 |
2336 | .Vb 4 |
1621 | \& myclass::myclass (int fd) |
2337 | \& myclass::myclass (int fd) |
1622 | \& : io (this, &myclass::io_cb), |
|
|
1623 | \& idle (this, &myclass::idle_cb) |
|
|
1624 | \& { |
2338 | \& { |
|
|
2339 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
2340 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2341 | .Ve |
|
|
2342 | .PP |
|
|
2343 | .Vb 2 |
1625 | \& io.start (fd, ev::READ); |
2344 | \& io.start (fd, ev::READ); |
1626 | \& } |
2345 | \& } |
|
|
2346 | .Ve |
|
|
2347 | .SH "MACRO MAGIC" |
|
|
2348 | .IX Header "MACRO MAGIC" |
|
|
2349 | Libev can be compiled with a variety of options, the most fundamantal |
|
|
2350 | of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) |
|
|
2351 | functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
|
|
2352 | .PP |
|
|
2353 | To make it easier to write programs that cope with either variant, the |
|
|
2354 | following macros are defined: |
|
|
2355 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
|
|
2356 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
|
|
2357 | .IX Item "EV_A, EV_A_" |
|
|
2358 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
|
|
2359 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
|
|
2360 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
|
|
2361 | .Sp |
|
|
2362 | .Vb 3 |
|
|
2363 | \& ev_unref (EV_A); |
|
|
2364 | \& ev_timer_add (EV_A_ watcher); |
|
|
2365 | \& ev_loop (EV_A_ 0); |
|
|
2366 | .Ve |
|
|
2367 | .Sp |
|
|
2368 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
|
|
2369 | which is often provided by the following macro. |
|
|
2370 | .ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 |
|
|
2371 | .el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 |
|
|
2372 | .IX Item "EV_P, EV_P_" |
|
|
2373 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
|
|
2374 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
|
|
2375 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
|
|
2376 | .Sp |
|
|
2377 | .Vb 2 |
|
|
2378 | \& // this is how ev_unref is being declared |
|
|
2379 | \& static void ev_unref (EV_P); |
|
|
2380 | .Ve |
|
|
2381 | .Sp |
|
|
2382 | .Vb 2 |
|
|
2383 | \& // this is how you can declare your typical callback |
|
|
2384 | \& static void cb (EV_P_ ev_timer *w, int revents) |
|
|
2385 | .Ve |
|
|
2386 | .Sp |
|
|
2387 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
|
|
2388 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
|
|
2389 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
|
|
2390 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
|
|
2391 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
|
|
2392 | Similar to the other two macros, this gives you the value of the default |
|
|
2393 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
|
|
2394 | .PP |
|
|
2395 | Example: Declare and initialise a check watcher, utilising the above |
|
|
2396 | macros so it will work regardless of whether multiple loops are supported |
|
|
2397 | or not. |
|
|
2398 | .PP |
|
|
2399 | .Vb 5 |
|
|
2400 | \& static void |
|
|
2401 | \& check_cb (EV_P_ ev_timer *w, int revents) |
|
|
2402 | \& { |
|
|
2403 | \& ev_check_stop (EV_A_ w); |
|
|
2404 | \& } |
|
|
2405 | .Ve |
|
|
2406 | .PP |
|
|
2407 | .Vb 4 |
|
|
2408 | \& ev_check check; |
|
|
2409 | \& ev_check_init (&check, check_cb); |
|
|
2410 | \& ev_check_start (EV_DEFAULT_ &check); |
|
|
2411 | \& ev_loop (EV_DEFAULT_ 0); |
1627 | .Ve |
2412 | .Ve |
1628 | .SH "EMBEDDING" |
2413 | .SH "EMBEDDING" |
1629 | .IX Header "EMBEDDING" |
2414 | .IX Header "EMBEDDING" |
1630 | Libev can (and often is) directly embedded into host |
2415 | Libev can (and often is) directly embedded into host |
1631 | applications. Examples of applications that embed it include the Deliantra |
2416 | applications. Examples of applications that embed it include the Deliantra |
1632 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
2417 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
1633 | and rxvt\-unicode. |
2418 | and rxvt\-unicode. |
1634 | .PP |
2419 | .PP |
1635 | The goal is to enable you to just copy the neecssary files into your |
2420 | The goal is to enable you to just copy the necessary files into your |
1636 | source directory without having to change even a single line in them, so |
2421 | source directory without having to change even a single line in them, so |
1637 | you can easily upgrade by simply copying (or having a checked-out copy of |
2422 | you can easily upgrade by simply copying (or having a checked-out copy of |
1638 | libev somewhere in your source tree). |
2423 | libev somewhere in your source tree). |
1639 | .Sh "\s-1FILESETS\s0" |
2424 | .Sh "\s-1FILESETS\s0" |
1640 | .IX Subsection "FILESETS" |
2425 | .IX Subsection "FILESETS" |
… | |
… | |
1680 | .Vb 1 |
2465 | .Vb 1 |
1681 | \& ev_win32.c required on win32 platforms only |
2466 | \& ev_win32.c required on win32 platforms only |
1682 | .Ve |
2467 | .Ve |
1683 | .PP |
2468 | .PP |
1684 | .Vb 5 |
2469 | .Vb 5 |
1685 | \& ev_select.c only when select backend is enabled (which is by default) |
2470 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
1686 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2471 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
1687 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2472 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1688 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2473 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1689 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2474 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
1690 | .Ve |
2475 | .Ve |
… | |
… | |
1745 | .IX Item "EV_USE_MONOTONIC" |
2530 | .IX Item "EV_USE_MONOTONIC" |
1746 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2531 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
1747 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2532 | monotonic clock option at both compiletime and runtime. Otherwise no use |
1748 | of the monotonic clock option will be attempted. If you enable this, you |
2533 | of the monotonic clock option will be attempted. If you enable this, you |
1749 | usually have to link against librt or something similar. Enabling it when |
2534 | usually have to link against librt or something similar. Enabling it when |
1750 | the functionality isn't available is safe, though, althoguh you have |
2535 | the functionality isn't available is safe, though, although you have |
1751 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
2536 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
1752 | function is hiding in (often \fI\-lrt\fR). |
2537 | function is hiding in (often \fI\-lrt\fR). |
1753 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
2538 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
1754 | .IX Item "EV_USE_REALTIME" |
2539 | .IX Item "EV_USE_REALTIME" |
1755 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2540 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
1756 | realtime clock option at compiletime (and assume its availability at |
2541 | realtime clock option at compiletime (and assume its availability at |
1757 | runtime if successful). Otherwise no use of the realtime clock option will |
2542 | runtime if successful). Otherwise no use of the realtime clock option will |
1758 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
2543 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
1759 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
2544 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the |
1760 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
2545 | note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
|
|
2546 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
|
|
2547 | .IX Item "EV_USE_NANOSLEEP" |
|
|
2548 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
|
|
2549 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
1761 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2550 | .IP "\s-1EV_USE_SELECT\s0" 4 |
1762 | .IX Item "EV_USE_SELECT" |
2551 | .IX Item "EV_USE_SELECT" |
1763 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2552 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
1764 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
2553 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
1765 | other method takes over, select will be it. Otherwise the select backend |
2554 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
1811 | otherwise another method will be used as fallback. This is the preferred |
2600 | otherwise another method will be used as fallback. This is the preferred |
1812 | backend for Solaris 10 systems. |
2601 | backend for Solaris 10 systems. |
1813 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2602 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
1814 | .IX Item "EV_USE_DEVPOLL" |
2603 | .IX Item "EV_USE_DEVPOLL" |
1815 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2604 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
2605 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
|
|
2606 | .IX Item "EV_USE_INOTIFY" |
|
|
2607 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
|
|
2608 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
|
|
2609 | be detected at runtime. |
1816 | .IP "\s-1EV_H\s0" 4 |
2610 | .IP "\s-1EV_H\s0" 4 |
1817 | .IX Item "EV_H" |
2611 | .IX Item "EV_H" |
1818 | The name of the \fIev.h\fR header file used to include it. The default if |
2612 | The name of the \fIev.h\fR header file used to include it. The default if |
1819 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2613 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
1820 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2614 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
… | |
… | |
1838 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2632 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
1839 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2633 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
1840 | additional independent event loops. Otherwise there will be no support |
2634 | additional independent event loops. Otherwise there will be no support |
1841 | for multiple event loops and there is no first event loop pointer |
2635 | for multiple event loops and there is no first event loop pointer |
1842 | argument. Instead, all functions act on the single default loop. |
2636 | argument. Instead, all functions act on the single default loop. |
|
|
2637 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2638 | .IX Item "EV_MINPRI" |
|
|
2639 | .PD 0 |
|
|
2640 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2641 | .IX Item "EV_MAXPRI" |
|
|
2642 | .PD |
|
|
2643 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2644 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2645 | provide for more priorities by overriding those symbols (usually defined |
|
|
2646 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2647 | .Sp |
|
|
2648 | When doing priority-based operations, libev usually has to linearly search |
|
|
2649 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2650 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2651 | fine. |
|
|
2652 | .Sp |
|
|
2653 | If your embedding app does not need any priorities, defining these both to |
|
|
2654 | \&\f(CW0\fR will save some memory and cpu. |
1843 | .IP "\s-1EV_PERIODICS\s0" 4 |
2655 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
1844 | .IX Item "EV_PERIODICS" |
2656 | .IX Item "EV_PERIODIC_ENABLE" |
1845 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported, |
2657 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
1846 | otherwise not. This saves a few kb of code. |
2658 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2659 | code. |
|
|
2660 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2661 | .IX Item "EV_IDLE_ENABLE" |
|
|
2662 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
|
|
2663 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2664 | code. |
|
|
2665 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
|
|
2666 | .IX Item "EV_EMBED_ENABLE" |
|
|
2667 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
|
|
2668 | defined to be \f(CW0\fR, then they are not. |
|
|
2669 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
|
|
2670 | .IX Item "EV_STAT_ENABLE" |
|
|
2671 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
|
|
2672 | defined to be \f(CW0\fR, then they are not. |
|
|
2673 | .IP "\s-1EV_FORK_ENABLE\s0" 4 |
|
|
2674 | .IX Item "EV_FORK_ENABLE" |
|
|
2675 | If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If |
|
|
2676 | defined to be \f(CW0\fR, then they are not. |
|
|
2677 | .IP "\s-1EV_MINIMAL\s0" 4 |
|
|
2678 | .IX Item "EV_MINIMAL" |
|
|
2679 | If you need to shave off some kilobytes of code at the expense of some |
|
|
2680 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
|
|
2681 | some inlining decisions, saves roughly 30% codesize of amd64. |
|
|
2682 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
|
|
2683 | .IX Item "EV_PID_HASHSIZE" |
|
|
2684 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2685 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
|
|
2686 | than enough. If you need to manage thousands of children you might want to |
|
|
2687 | increase this value (\fImust\fR be a power of two). |
|
|
2688 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
|
|
2689 | .IX Item "EV_INOTIFY_HASHSIZE" |
|
|
2690 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2691 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
|
|
2692 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2693 | watchers you might want to increase this value (\fImust\fR be a power of |
|
|
2694 | two). |
1847 | .IP "\s-1EV_COMMON\s0" 4 |
2695 | .IP "\s-1EV_COMMON\s0" 4 |
1848 | .IX Item "EV_COMMON" |
2696 | .IX Item "EV_COMMON" |
1849 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2697 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
1850 | this macro to a something else you can include more and other types of |
2698 | this macro to a something else you can include more and other types of |
1851 | members. You have to define it each time you include one of the files, |
2699 | members. You have to define it each time you include one of the files, |
… | |
… | |
1866 | .IP "ev_set_cb (ev, cb)" 4 |
2714 | .IP "ev_set_cb (ev, cb)" 4 |
1867 | .IX Item "ev_set_cb (ev, cb)" |
2715 | .IX Item "ev_set_cb (ev, cb)" |
1868 | .PD |
2716 | .PD |
1869 | Can be used to change the callback member declaration in each watcher, |
2717 | Can be used to change the callback member declaration in each watcher, |
1870 | and the way callbacks are invoked and set. Must expand to a struct member |
2718 | and the way callbacks are invoked and set. Must expand to a struct member |
1871 | definition and a statement, respectively. See the \fIev.v\fR header file for |
2719 | definition and a statement, respectively. See the \fIev.h\fR header file for |
1872 | their default definitions. One possible use for overriding these is to |
2720 | their default definitions. One possible use for overriding these is to |
1873 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2721 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
1874 | method calls instead of plain function calls in \*(C+. |
2722 | method calls instead of plain function calls in \*(C+. |
|
|
2723 | .Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
|
|
2724 | .IX Subsection "EXPORTED API SYMBOLS" |
|
|
2725 | If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of |
|
|
2726 | exported symbols, you can use the provided \fISymbol.*\fR files which list |
|
|
2727 | all public symbols, one per line: |
|
|
2728 | .Sp |
|
|
2729 | .Vb 2 |
|
|
2730 | \& Symbols.ev for libev proper |
|
|
2731 | \& Symbols.event for the libevent emulation |
|
|
2732 | .Ve |
|
|
2733 | .Sp |
|
|
2734 | This can also be used to rename all public symbols to avoid clashes with |
|
|
2735 | multiple versions of libev linked together (which is obviously bad in |
|
|
2736 | itself, but sometimes it is inconvinient to avoid this). |
|
|
2737 | .Sp |
|
|
2738 | A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
|
|
2739 | include before including \fIev.h\fR: |
|
|
2740 | .Sp |
|
|
2741 | .Vb 1 |
|
|
2742 | \& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
2743 | .Ve |
|
|
2744 | .Sp |
|
|
2745 | This would create a file \fIwrap.h\fR which essentially looks like this: |
|
|
2746 | .Sp |
|
|
2747 | .Vb 4 |
|
|
2748 | \& #define ev_backend myprefix_ev_backend |
|
|
2749 | \& #define ev_check_start myprefix_ev_check_start |
|
|
2750 | \& #define ev_check_stop myprefix_ev_check_stop |
|
|
2751 | \& ... |
|
|
2752 | .Ve |
1875 | .Sh "\s-1EXAMPLES\s0" |
2753 | .Sh "\s-1EXAMPLES\s0" |
1876 | .IX Subsection "EXAMPLES" |
2754 | .IX Subsection "EXAMPLES" |
1877 | For a real-world example of a program the includes libev |
2755 | For a real-world example of a program the includes libev |
1878 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2756 | verbatim, you can have a look at the \s-1EV\s0 perl module |
1879 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
2757 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
… | |
… | |
1881 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2759 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
1882 | will be compiled. It is pretty complex because it provides its own header |
2760 | will be compiled. It is pretty complex because it provides its own header |
1883 | file. |
2761 | file. |
1884 | .Sp |
2762 | .Sp |
1885 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2763 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
1886 | that everybody includes and which overrides some autoconf choices: |
2764 | that everybody includes and which overrides some configure choices: |
1887 | .Sp |
2765 | .Sp |
1888 | .Vb 4 |
2766 | .Vb 9 |
|
|
2767 | \& #define EV_MINIMAL 1 |
1889 | \& #define EV_USE_POLL 0 |
2768 | \& #define EV_USE_POLL 0 |
1890 | \& #define EV_MULTIPLICITY 0 |
2769 | \& #define EV_MULTIPLICITY 0 |
1891 | \& #define EV_PERIODICS 0 |
2770 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2771 | \& #define EV_STAT_ENABLE 0 |
|
|
2772 | \& #define EV_FORK_ENABLE 0 |
1892 | \& #define EV_CONFIG_H <config.h> |
2773 | \& #define EV_CONFIG_H <config.h> |
|
|
2774 | \& #define EV_MINPRI 0 |
|
|
2775 | \& #define EV_MAXPRI 0 |
1893 | .Ve |
2776 | .Ve |
1894 | .Sp |
2777 | .Sp |
1895 | .Vb 1 |
2778 | .Vb 1 |
1896 | \& #include "ev++.h" |
2779 | \& #include "ev++.h" |
1897 | .Ve |
2780 | .Ve |
… | |
… | |
1900 | .Sp |
2783 | .Sp |
1901 | .Vb 2 |
2784 | .Vb 2 |
1902 | \& #include "ev_cpp.h" |
2785 | \& #include "ev_cpp.h" |
1903 | \& #include "ev.c" |
2786 | \& #include "ev.c" |
1904 | .Ve |
2787 | .Ve |
|
|
2788 | .SH "COMPLEXITIES" |
|
|
2789 | .IX Header "COMPLEXITIES" |
|
|
2790 | In this section the complexities of (many of) the algorithms used inside |
|
|
2791 | libev will be explained. For complexity discussions about backends see the |
|
|
2792 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
2793 | .Sp |
|
|
2794 | All of the following are about amortised time: If an array needs to be |
|
|
2795 | extended, libev needs to realloc and move the whole array, but this |
|
|
2796 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2797 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2798 | it is much faster and asymptotically approaches constant time. |
|
|
2799 | .RS 4 |
|
|
2800 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
|
|
2801 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
|
|
2802 | This means that, when you have a watcher that triggers in one hour and |
|
|
2803 | there are 100 watchers that would trigger before that then inserting will |
|
|
2804 | have to skip those 100 watchers. |
|
|
2805 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
|
|
2806 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2807 | That means that for changing a timer costs less than removing/adding them |
|
|
2808 | as only the relative motion in the event queue has to be paid for. |
|
|
2809 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
|
|
2810 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
|
|
2811 | These just add the watcher into an array or at the head of a list. |
|
|
2812 | =item Stopping check/prepare/idle watchers: O(1) |
|
|
2813 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
|
|
2814 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2815 | These watchers are stored in lists then need to be walked to find the |
|
|
2816 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2817 | have many watchers waiting for the same fd or signal). |
|
|
2818 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
|
|
2819 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2820 | .PD 0 |
|
|
2821 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
|
|
2822 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2823 | .PD |
|
|
2824 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2825 | libev to recalculate its status (and possibly tell the kernel). |
|
|
2826 | .IP "Activating one watcher: O(1)" 4 |
|
|
2827 | .IX Item "Activating one watcher: O(1)" |
|
|
2828 | .PD 0 |
|
|
2829 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2830 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2831 | .PD |
|
|
2832 | Priorities are implemented by allocating some space for each |
|
|
2833 | priority. When doing priority-based operations, libev usually has to |
|
|
2834 | linearly search all the priorities. |
|
|
2835 | .RE |
|
|
2836 | .RS 4 |
1905 | .SH "AUTHOR" |
2837 | .SH "AUTHOR" |
1906 | .IX Header "AUTHOR" |
2838 | .IX Header "AUTHOR" |
1907 | Marc Lehmann <libev@schmorp.de>. |
2839 | Marc Lehmann <libev@schmorp.de>. |