… | |
… | |
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-27" "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 "ev_sleep (ev_tstamp interval)" 4 |
|
|
261 | .IX Item "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, |
355 | but if that fails, expect a fairly low limit on the number of fds when |
455 | but if that fails, expect a fairly low limit on the number of fds when |
356 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
456 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
357 | the fastest backend for a low number of fds. |
457 | usually the fastest backend for a low number of (low\-numbered :) fds. |
|
|
458 | .Sp |
|
|
459 | To get good performance out of this backend you need a high amount of |
|
|
460 | parallelity (most of the file descriptors should be busy). If you are |
|
|
461 | writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many |
|
|
462 | connections as possible during one iteration. You might also want to have |
|
|
463 | a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of |
|
|
464 | readyness notifications you get per iteration. |
358 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
465 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
359 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
466 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
360 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
467 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
361 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than |
468 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated |
362 | select, but handles sparse fds better and has no artificial limit on the |
469 | than select, but handles sparse fds better and has no artificial |
363 | number of fds you can use (except it will slow down considerably with a |
470 | limit on the number of fds you can use (except it will slow down |
364 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
471 | considerably with a lot of inactive fds). It scales similarly to select, |
|
|
472 | i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for |
|
|
473 | performance tips. |
365 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
474 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
366 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
475 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
367 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
476 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
368 | For few fds, this backend is a bit little slower than poll and select, |
477 | 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 |
478 | 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 |
479 | like O(total_fds) where n is the total number of fds (or the highest fd), |
371 | either O(1) or O(active_fds). |
480 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
|
|
481 | of shortcomings, such as silently dropping events in some hard-to-detect |
|
|
482 | cases and rewiring a syscall per fd change, no fork support and bad |
|
|
483 | support for dup. |
372 | .Sp |
484 | .Sp |
373 | While stopping and starting an I/O watcher in the same iteration will |
485 | 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 |
486 | 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 |
487 | (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 |
488 | 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. |
489 | very well if you register events for both fds. |
378 | .Sp |
490 | .Sp |
379 | Please note that epoll sometimes generates spurious notifications, so you |
491 | 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 |
492 | need to use non-blocking I/O or other means to avoid blocking when no data |
381 | (or space) is available. |
493 | (or space) is available. |
|
|
494 | .Sp |
|
|
495 | Best performance from this backend is achieved by not unregistering all |
|
|
496 | watchers for a file descriptor until it has been closed, if possible, i.e. |
|
|
497 | keep at least one watcher active per fd at all times. |
|
|
498 | .Sp |
|
|
499 | While nominally embeddeble in other event loops, this feature is broken in |
|
|
500 | all kernel versions tested so far. |
382 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
501 | .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 |
502 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
384 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
503 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
385 | Kqueue deserves special mention, as at the time of this writing, it |
504 | 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 |
505 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
387 | anything but sockets and pipes, except on Darwin, where of course its |
506 | with anything but sockets and pipes, except on Darwin, where of course |
388 | completely useless). For this reason its not being \*(L"autodetected\*(R" |
507 | it's completely useless). For this reason it's not being \*(L"autodetected\*(R" |
389 | unless you explicitly specify it explicitly in the flags (i.e. using |
508 | unless you explicitly specify it explicitly in the flags (i.e. using |
390 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). |
509 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) |
|
|
510 | system like NetBSD. |
|
|
511 | .Sp |
|
|
512 | You still can embed kqueue into a normal poll or select backend and use it |
|
|
513 | only for sockets (after having made sure that sockets work with kqueue on |
|
|
514 | the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
391 | .Sp |
515 | .Sp |
392 | It scales in the same way as the epoll backend, but the interface to the |
516 | 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 |
517 | kernel is more efficient (which says nothing about its actual speed, of |
394 | course). While starting and stopping an I/O watcher does not cause an |
518 | course). While stopping, setting and starting an I/O watcher does never |
395 | extra syscall as with epoll, it still adds up to four event changes per |
519 | cause an extra syscall as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to |
396 | incident, so its best to avoid that. |
520 | two event changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it |
|
|
521 | drops fds silently in similarly hard-to-detect cases. |
|
|
522 | .Sp |
|
|
523 | This backend usually performs well under most conditions. |
|
|
524 | .Sp |
|
|
525 | While nominally embeddable in other event loops, this doesn't work |
|
|
526 | everywhere, so you might need to test for this. And since it is broken |
|
|
527 | almost everywhere, you should only use it when you have a lot of sockets |
|
|
528 | (for which it usually works), by embedding it into another event loop |
|
|
529 | (e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR) and using it only for |
|
|
530 | sockets. |
397 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
531 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
398 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
532 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
399 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
533 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
400 | This is not implemented yet (and might never be). |
534 | This is not implemented yet (and might never be, unless you send me an |
|
|
535 | implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets |
|
|
536 | and is not embeddable, which would limit the usefulness of this backend |
|
|
537 | immensely. |
401 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
538 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
402 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
539 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
403 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
540 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
404 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
541 | 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)). |
542 | it's really slow, but it still scales very well (O(active_fds)). |
406 | .Sp |
543 | .Sp |
407 | Please note that solaris ports can result in a lot of spurious |
544 | 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 |
545 | notifications, so you need to use non-blocking I/O or other means to avoid |
409 | blocking when no data (or space) is available. |
546 | blocking when no data (or space) is available. |
|
|
547 | .Sp |
|
|
548 | While this backend scales well, it requires one system call per active |
|
|
549 | file descriptor per loop iteration. For small and medium numbers of file |
|
|
550 | descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend |
|
|
551 | might perform better. |
410 | .ie n .IP """EVBACKEND_ALL""" 4 |
552 | .ie n .IP """EVBACKEND_ALL""" 4 |
411 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
553 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
412 | .IX Item "EVBACKEND_ALL" |
554 | .IX Item "EVBACKEND_ALL" |
413 | Try all backends (even potentially broken ones that wouldn't be tried |
555 | Try all backends (even potentially broken ones that wouldn't be tried |
414 | with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as |
556 | with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as |
415 | \&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. |
557 | \&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. |
|
|
558 | .Sp |
|
|
559 | It is definitely not recommended to use this flag. |
416 | .RE |
560 | .RE |
417 | .RS 4 |
561 | .RS 4 |
418 | .Sp |
562 | .Sp |
419 | If one or more of these are ored into the flags value, then only these |
563 | If one or more of these are ored into the flags value, then only these |
420 | backends will be tried (in the reverse order as given here). If none are |
564 | backends will be tried (in the reverse order as given here). If none are |
… | |
… | |
448 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
592 | 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 |
593 | 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 |
594 | 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). |
595 | undefined behaviour (or a failed assertion if assertions are enabled). |
452 | .Sp |
596 | .Sp |
453 | Example: try to create a event loop that uses epoll and nothing else. |
597 | Example: Try to create a event loop that uses epoll and nothing else. |
454 | .Sp |
598 | .Sp |
455 | .Vb 3 |
599 | .Vb 3 |
456 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
600 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
457 | \& if (!epoller) |
601 | \& if (!epoller) |
458 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
602 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
… | |
… | |
462 | Destroys the default loop again (frees all memory and kernel state |
606 | 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 |
607 | 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 |
608 | 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 |
609 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
466 | calling this function, or cope with the fact afterwards (which is usually |
610 | 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 |
611 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
468 | for example). |
612 | for example). |
|
|
613 | .Sp |
|
|
614 | Note that certain global state, such as signal state, will not be freed by |
|
|
615 | this function, and related watchers (such as signal and child watchers) |
|
|
616 | would need to be stopped manually. |
|
|
617 | .Sp |
|
|
618 | In general it is not advisable to call this function except in the |
|
|
619 | rare occasion where you really need to free e.g. the signal handling |
|
|
620 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
621 | \&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR). |
469 | .IP "ev_loop_destroy (loop)" 4 |
622 | .IP "ev_loop_destroy (loop)" 4 |
470 | .IX Item "ev_loop_destroy (loop)" |
623 | .IX Item "ev_loop_destroy (loop)" |
471 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
624 | 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. |
625 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
473 | .IP "ev_default_fork ()" 4 |
626 | .IP "ev_default_fork ()" 4 |
… | |
… | |
495 | .IP "ev_loop_fork (loop)" 4 |
648 | .IP "ev_loop_fork (loop)" 4 |
496 | .IX Item "ev_loop_fork (loop)" |
649 | .IX Item "ev_loop_fork (loop)" |
497 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
650 | 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 |
651 | \&\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. |
652 | after fork, and how you do this is entirely your own problem. |
|
|
653 | .IP "unsigned int ev_loop_count (loop)" 4 |
|
|
654 | .IX Item "unsigned int ev_loop_count (loop)" |
|
|
655 | Returns the count of loop iterations for the loop, which is identical to |
|
|
656 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
657 | happily wraps around with enough iterations. |
|
|
658 | .Sp |
|
|
659 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
660 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
|
|
661 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
500 | .IP "unsigned int ev_backend (loop)" 4 |
662 | .IP "unsigned int ev_backend (loop)" 4 |
501 | .IX Item "unsigned int ev_backend (loop)" |
663 | .IX Item "unsigned int ev_backend (loop)" |
502 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
664 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
503 | use. |
665 | use. |
504 | .IP "ev_tstamp ev_now (loop)" 4 |
666 | .IP "ev_tstamp ev_now (loop)" 4 |
505 | .IX Item "ev_tstamp ev_now (loop)" |
667 | .IX Item "ev_tstamp ev_now (loop)" |
506 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
668 | 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 |
669 | 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 |
670 | 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 |
671 | 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). |
672 | event occurring (or more correctly, libev finding out about it). |
511 | .IP "ev_loop (loop, int flags)" 4 |
673 | .IP "ev_loop (loop, int flags)" 4 |
512 | .IX Item "ev_loop (loop, int flags)" |
674 | .IX Item "ev_loop (loop, int flags)" |
513 | Finally, this is it, the event handler. This function usually is called |
675 | 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 |
676 | after you initialised all your watchers and you want to start handling |
515 | events. |
677 | events. |
… | |
… | |
535 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
697 | 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. |
698 | usually a better approach for this kind of thing. |
537 | .Sp |
699 | .Sp |
538 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
700 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
539 | .Sp |
701 | .Sp |
540 | .Vb 18 |
702 | .Vb 19 |
|
|
703 | \& - Before the first iteration, call any pending watchers. |
541 | \& * If there are no active watchers (reference count is zero), return. |
704 | \& * If there are no active watchers (reference count is zero), return. |
542 | \& - Queue prepare watchers and then call all outstanding watchers. |
705 | \& - Queue all prepare watchers and then call all outstanding watchers. |
543 | \& - If we have been forked, recreate the kernel state. |
706 | \& - If we have been forked, recreate the kernel state. |
544 | \& - Update the kernel state with all outstanding changes. |
707 | \& - Update the kernel state with all outstanding changes. |
545 | \& - Update the "event loop time". |
708 | \& - Update the "event loop time". |
546 | \& - Calculate for how long to block. |
709 | \& - Calculate for how long to block. |
547 | \& - Block the process, waiting for any events. |
710 | \& - Block the process, waiting for any events. |
… | |
… | |
556 | \& be handled here by queueing them when their watcher gets executed. |
719 | \& be handled here by queueing them when their watcher gets executed. |
557 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
720 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
558 | \& were used, return, otherwise continue with step *. |
721 | \& were used, return, otherwise continue with step *. |
559 | .Ve |
722 | .Ve |
560 | .Sp |
723 | .Sp |
561 | Example: queue some jobs and then loop until no events are outsanding |
724 | Example: Queue some jobs and then loop until no events are outsanding |
562 | anymore. |
725 | anymore. |
563 | .Sp |
726 | .Sp |
564 | .Vb 4 |
727 | .Vb 4 |
565 | \& ... queue jobs here, make sure they register event watchers as long |
728 | \& ... 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..) |
729 | \& ... 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 |
751 | 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 |
752 | 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 |
753 | 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. |
754 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
592 | .Sp |
755 | .Sp |
593 | Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
756 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
594 | running when nothing else is active. |
757 | running when nothing else is active. |
595 | .Sp |
758 | .Sp |
596 | .Vb 4 |
759 | .Vb 4 |
597 | \& struct dv_signal exitsig; |
760 | \& struct ev_signal exitsig; |
598 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
761 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
599 | \& ev_signal_start (myloop, &exitsig); |
762 | \& ev_signal_start (loop, &exitsig); |
600 | \& evf_unref (myloop); |
763 | \& evf_unref (loop); |
601 | .Ve |
764 | .Ve |
602 | .Sp |
765 | .Sp |
603 | Example: for some weird reason, unregister the above signal handler again. |
766 | Example: For some weird reason, unregister the above signal handler again. |
604 | .Sp |
767 | .Sp |
605 | .Vb 2 |
768 | .Vb 2 |
606 | \& ev_ref (myloop); |
769 | \& ev_ref (loop); |
607 | \& ev_signal_stop (myloop, &exitsig); |
770 | \& ev_signal_stop (loop, &exitsig); |
608 | .Ve |
771 | .Ve |
|
|
772 | .IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4 |
|
|
773 | .IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)" |
|
|
774 | .PD 0 |
|
|
775 | .IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4 |
|
|
776 | .IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" |
|
|
777 | .PD |
|
|
778 | These advanced functions influence the time that libev will spend waiting |
|
|
779 | for events. Both are by default \f(CW0\fR, meaning that libev will try to |
|
|
780 | invoke timer/periodic callbacks and I/O callbacks with minimum latency. |
|
|
781 | .Sp |
|
|
782 | Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR) |
|
|
783 | allows libev to delay invocation of I/O and timer/periodic callbacks to |
|
|
784 | increase efficiency of loop iterations. |
|
|
785 | .Sp |
|
|
786 | The background is that sometimes your program runs just fast enough to |
|
|
787 | handle one (or very few) event(s) per loop iteration. While this makes |
|
|
788 | the program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new |
|
|
789 | events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high |
|
|
790 | overhead for the actual polling but can deliver many events at once. |
|
|
791 | .Sp |
|
|
792 | By setting a higher \fIio collect interval\fR you allow libev to spend more |
|
|
793 | time collecting I/O events, so you can handle more events per iteration, |
|
|
794 | at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and |
|
|
795 | \&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will |
|
|
796 | introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. |
|
|
797 | .Sp |
|
|
798 | Likewise, by setting a higher \fItimeout collect interval\fR you allow libev |
|
|
799 | to spend more time collecting timeouts, at the expense of increased |
|
|
800 | latency (the watcher callback will be called later). \f(CW\*(C`ev_io\*(C'\fR watchers |
|
|
801 | will not be affected. Setting this to a non-null value will not introduce |
|
|
802 | any overhead in libev. |
|
|
803 | .Sp |
|
|
804 | Many (busy) programs can usually benefit by setting the io collect |
|
|
805 | interval to a value near \f(CW0.1\fR or so, which is often enough for |
|
|
806 | interactive servers (of course not for games), likewise for timeouts. It |
|
|
807 | usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, |
|
|
808 | as this approsaches the timing granularity of most systems. |
609 | .SH "ANATOMY OF A WATCHER" |
809 | .SH "ANATOMY OF A WATCHER" |
610 | .IX Header "ANATOMY OF A WATCHER" |
810 | .IX Header "ANATOMY OF A WATCHER" |
611 | A watcher is a structure that you create and register to record your |
811 | 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 |
812 | 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: |
813 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
… | |
… | |
707 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
907 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
708 | received events. Callbacks of both watcher types can start and stop as |
908 | received events. Callbacks of both watcher types can start and stop as |
709 | many watchers as they want, and all of them will be taken into account |
909 | many watchers as they want, and all of them will be taken into account |
710 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
910 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
711 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
911 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
|
|
912 | .ie n .IP """EV_EMBED""" 4 |
|
|
913 | .el .IP "\f(CWEV_EMBED\fR" 4 |
|
|
914 | .IX Item "EV_EMBED" |
|
|
915 | The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. |
|
|
916 | .ie n .IP """EV_FORK""" 4 |
|
|
917 | .el .IP "\f(CWEV_FORK\fR" 4 |
|
|
918 | .IX Item "EV_FORK" |
|
|
919 | The event loop has been resumed in the child process after fork (see |
|
|
920 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
712 | .ie n .IP """EV_ERROR""" 4 |
921 | .ie n .IP """EV_ERROR""" 4 |
713 | .el .IP "\f(CWEV_ERROR\fR" 4 |
922 | .el .IP "\f(CWEV_ERROR\fR" 4 |
714 | .IX Item "EV_ERROR" |
923 | .IX Item "EV_ERROR" |
715 | An unspecified error has occured, the watcher has been stopped. This might |
924 | An unspecified error has occured, the watcher has been stopped. This might |
716 | happen because the watcher could not be properly started because libev |
925 | happen because the watcher could not be properly started because libev |
… | |
… | |
781 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
990 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
782 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
991 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
783 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
992 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
784 | events but its callback has not yet been invoked). As long as a watcher |
993 | events but its callback has not yet been invoked). As long as a watcher |
785 | is pending (but not active) you must not call an init function on it (but |
994 | is pending (but not active) you must not call an init function on it (but |
786 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
995 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
787 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
996 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
997 | it). |
788 | .IP "callback = ev_cb (ev_TYPE *watcher)" 4 |
998 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
789 | .IX Item "callback = ev_cb (ev_TYPE *watcher)" |
999 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
790 | Returns the callback currently set on the watcher. |
1000 | Returns the callback currently set on the watcher. |
791 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
1001 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
792 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
1002 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
793 | Change the callback. You can change the callback at virtually any time |
1003 | Change the callback. You can change the callback at virtually any time |
794 | (modulo threads). |
1004 | (modulo threads). |
|
|
1005 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
1006 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
1007 | .PD 0 |
|
|
1008 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
1009 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
1010 | .PD |
|
|
1011 | Set and query the priority of the watcher. The priority is a small |
|
|
1012 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
1013 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
1014 | before watchers with lower priority, but priority will not keep watchers |
|
|
1015 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
1016 | .Sp |
|
|
1017 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
1018 | invocation after new events have been received. This is useful, for |
|
|
1019 | example, to reduce latency after idling, or more often, to bind two |
|
|
1020 | watchers on the same event and make sure one is called first. |
|
|
1021 | .Sp |
|
|
1022 | If you need to suppress invocation when higher priority events are pending |
|
|
1023 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
1024 | .Sp |
|
|
1025 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
1026 | pending. |
|
|
1027 | .Sp |
|
|
1028 | The default priority used by watchers when no priority has been set is |
|
|
1029 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
1030 | .Sp |
|
|
1031 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
1032 | fine, as long as you do not mind that the priority value you query might |
|
|
1033 | or might not have been adjusted to be within valid range. |
|
|
1034 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
1035 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
1036 | 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 |
|
|
1037 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
1038 | can deal with that fact. |
|
|
1039 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
1040 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
1041 | If the watcher is pending, this function returns clears its pending status |
|
|
1042 | and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
1043 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
795 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
1044 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
796 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
1045 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
797 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
1046 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
798 | and read at any time, libev will completely ignore it. This can be used |
1047 | and read at any time, libev will completely ignore it. This can be used |
799 | to associate arbitrary data with your watcher. If you need more data and |
1048 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
820 | \& struct my_io *w = (struct my_io *)w_; |
1069 | \& struct my_io *w = (struct my_io *)w_; |
821 | \& ... |
1070 | \& ... |
822 | \& } |
1071 | \& } |
823 | .Ve |
1072 | .Ve |
824 | .PP |
1073 | .PP |
825 | More interesting and less C\-conformant ways of catsing your callback type |
1074 | More interesting and less C\-conformant ways of casting your callback type |
826 | have been omitted.... |
1075 | instead have been omitted. |
|
|
1076 | .PP |
|
|
1077 | Another common scenario is having some data structure with multiple |
|
|
1078 | watchers: |
|
|
1079 | .PP |
|
|
1080 | .Vb 6 |
|
|
1081 | \& struct my_biggy |
|
|
1082 | \& { |
|
|
1083 | \& int some_data; |
|
|
1084 | \& ev_timer t1; |
|
|
1085 | \& ev_timer t2; |
|
|
1086 | \& } |
|
|
1087 | .Ve |
|
|
1088 | .PP |
|
|
1089 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
|
|
1090 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
|
|
1091 | .PP |
|
|
1092 | .Vb 1 |
|
|
1093 | \& #include <stddef.h> |
|
|
1094 | .Ve |
|
|
1095 | .PP |
|
|
1096 | .Vb 6 |
|
|
1097 | \& static void |
|
|
1098 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1099 | \& { |
|
|
1100 | \& struct my_biggy big = (struct my_biggy * |
|
|
1101 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
|
|
1102 | \& } |
|
|
1103 | .Ve |
|
|
1104 | .PP |
|
|
1105 | .Vb 6 |
|
|
1106 | \& static void |
|
|
1107 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1108 | \& { |
|
|
1109 | \& struct my_biggy big = (struct my_biggy * |
|
|
1110 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
|
|
1111 | \& } |
|
|
1112 | .Ve |
827 | .SH "WATCHER TYPES" |
1113 | .SH "WATCHER TYPES" |
828 | .IX Header "WATCHER TYPES" |
1114 | .IX Header "WATCHER TYPES" |
829 | This section describes each watcher in detail, but will not repeat |
1115 | This section describes each watcher in detail, but will not repeat |
830 | information given in the last section. Any initialisation/set macros, |
1116 | information given in the last section. Any initialisation/set macros, |
831 | functions and members specific to the watcher type are explained. |
1117 | functions and members specific to the watcher type are explained. |
… | |
… | |
873 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1159 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
874 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1160 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
875 | .PP |
1161 | .PP |
876 | If you cannot run the fd in non-blocking mode (for example you should not |
1162 | If you cannot run the fd in non-blocking mode (for example you should not |
877 | play around with an Xlib connection), then you have to seperately re-test |
1163 | play around with an Xlib connection), then you have to seperately re-test |
878 | wether a file descriptor is really ready with a known-to-be good interface |
1164 | whether a file descriptor is really ready with a known-to-be good interface |
879 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1165 | such as poll (fortunately in our Xlib example, Xlib already does this on |
880 | its own, so its quite safe to use). |
1166 | its own, so its quite safe to use). |
|
|
1167 | .PP |
|
|
1168 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1169 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1170 | .PP |
|
|
1171 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
|
|
1172 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
|
|
1173 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
|
|
1174 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1175 | this interest. If another file descriptor with the same number then is |
|
|
1176 | registered with libev, there is no efficient way to see that this is, in |
|
|
1177 | fact, a different file descriptor. |
|
|
1178 | .PP |
|
|
1179 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1180 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1181 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1182 | it is assumed that the file descriptor stays the same. That means that |
|
|
1183 | 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 |
|
|
1184 | descriptor even if the file descriptor number itself did not change. |
|
|
1185 | .PP |
|
|
1186 | This is how one would do it normally anyway, the important point is that |
|
|
1187 | the libev application should not optimise around libev but should leave |
|
|
1188 | optimisations to libev. |
|
|
1189 | .PP |
|
|
1190 | \fIThe special problem of dup'ed file descriptors\fR |
|
|
1191 | .IX Subsection "The special problem of dup'ed file descriptors" |
|
|
1192 | .PP |
|
|
1193 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1194 | but only events for the underlying file descriptions. That menas when you |
|
|
1195 | have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors and register events for them, only one |
|
|
1196 | file descriptor might actually receive events. |
|
|
1197 | .PP |
|
|
1198 | There is no workaorund possible except not registering events |
|
|
1199 | for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or to resort to |
|
|
1200 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1201 | .PP |
|
|
1202 | \fIThe special problem of fork\fR |
|
|
1203 | .IX Subsection "The special problem of fork" |
|
|
1204 | .PP |
|
|
1205 | Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit |
|
|
1206 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1207 | it in the child. |
|
|
1208 | .PP |
|
|
1209 | To support fork in your programs, you either have to call |
|
|
1210 | \&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, |
|
|
1211 | enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or |
|
|
1212 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1213 | .PP |
|
|
1214 | \fIWatcher-Specific Functions\fR |
|
|
1215 | .IX Subsection "Watcher-Specific Functions" |
881 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1216 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
882 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1217 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
883 | .PD 0 |
1218 | .PD 0 |
884 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1219 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
885 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1220 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
… | |
… | |
892 | The file descriptor being watched. |
1227 | The file descriptor being watched. |
893 | .IP "int events [read\-only]" 4 |
1228 | .IP "int events [read\-only]" 4 |
894 | .IX Item "int events [read-only]" |
1229 | .IX Item "int events [read-only]" |
895 | The events being watched. |
1230 | The events being watched. |
896 | .PP |
1231 | .PP |
897 | Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1232 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
898 | readable, but only once. Since it is likely line\-buffered, you could |
1233 | readable, but only once. Since it is likely line\-buffered, you could |
899 | attempt to read a whole line in the callback: |
1234 | attempt to read a whole line in the callback. |
900 | .PP |
1235 | .PP |
901 | .Vb 6 |
1236 | .Vb 6 |
902 | \& static void |
1237 | \& static void |
903 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1238 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
904 | \& { |
1239 | \& { |
… | |
… | |
938 | .Ve |
1273 | .Ve |
939 | .PP |
1274 | .PP |
940 | The callback is guarenteed to be invoked only when its timeout has passed, |
1275 | The callback is guarenteed to be invoked only when its timeout has passed, |
941 | but if multiple timers become ready during the same loop iteration then |
1276 | but if multiple timers become ready during the same loop iteration then |
942 | order of execution is undefined. |
1277 | order of execution is undefined. |
|
|
1278 | .PP |
|
|
1279 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1280 | .IX Subsection "Watcher-Specific Functions and Data Members" |
943 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1281 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
944 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1282 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
945 | .PD 0 |
1283 | .PD 0 |
946 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1284 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
947 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1285 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
… | |
… | |
959 | .IP "ev_timer_again (loop)" 4 |
1297 | .IP "ev_timer_again (loop)" 4 |
960 | .IX Item "ev_timer_again (loop)" |
1298 | .IX Item "ev_timer_again (loop)" |
961 | This will act as if the timer timed out and restart it again if it is |
1299 | This will act as if the timer timed out and restart it again if it is |
962 | repeating. The exact semantics are: |
1300 | repeating. The exact semantics are: |
963 | .Sp |
1301 | .Sp |
|
|
1302 | If the timer is pending, its pending status is cleared. |
|
|
1303 | .Sp |
964 | If the timer is started but nonrepeating, stop it. |
1304 | If the timer is started but nonrepeating, stop it (as if it timed out). |
965 | .Sp |
1305 | .Sp |
966 | If the timer is repeating, either start it if necessary (with the repeat |
1306 | If the timer is repeating, either start it if necessary (with the |
967 | value), or reset the running timer to the repeat value. |
1307 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
968 | .Sp |
1308 | .Sp |
969 | This sounds a bit complicated, but here is a useful and typical |
1309 | This sounds a bit complicated, but here is a useful and typical |
970 | example: Imagine you have a tcp connection and you want a so-called |
1310 | example: Imagine you have a tcp connection and you want a so-called idle |
971 | idle timeout, that is, you want to be called when there have been, |
1311 | timeout, that is, you want to be called when there have been, say, 60 |
972 | say, 60 seconds of inactivity on the socket. The easiest way to do |
1312 | seconds of inactivity on the socket. The easiest way to do this is to |
973 | this is to configure an \f(CW\*(C`ev_timer\*(C'\fR with \f(CW\*(C`after\*(C'\fR=\f(CW\*(C`repeat\*(C'\fR=\f(CW60\fR and calling |
1313 | 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 |
974 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
1314 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
975 | you go into an idle state where you do not expect data to travel on the |
1315 | you go into an idle state where you do not expect data to travel on the |
976 | socket, you can stop the timer, and again will automatically restart it if |
1316 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
977 | need be. |
1317 | automatically restart it if need be. |
978 | .Sp |
1318 | .Sp |
979 | You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether |
1319 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
980 | and only ever use the \f(CW\*(C`repeat\*(C'\fR value: |
1320 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
981 | .Sp |
1321 | .Sp |
982 | .Vb 8 |
1322 | .Vb 8 |
983 | \& ev_timer_init (timer, callback, 0., 5.); |
1323 | \& ev_timer_init (timer, callback, 0., 5.); |
984 | \& ev_timer_again (loop, timer); |
1324 | \& ev_timer_again (loop, timer); |
985 | \& ... |
1325 | \& ... |
… | |
… | |
988 | \& ... |
1328 | \& ... |
989 | \& timer->again = 10.; |
1329 | \& timer->again = 10.; |
990 | \& ev_timer_again (loop, timer); |
1330 | \& ev_timer_again (loop, timer); |
991 | .Ve |
1331 | .Ve |
992 | .Sp |
1332 | .Sp |
993 | This is more efficient then stopping/starting the timer eahc time you want |
1333 | This is more slightly efficient then stopping/starting the timer each time |
994 | to modify its timeout value. |
1334 | you want to modify its timeout value. |
995 | .IP "ev_tstamp repeat [read\-write]" 4 |
1335 | .IP "ev_tstamp repeat [read\-write]" 4 |
996 | .IX Item "ev_tstamp repeat [read-write]" |
1336 | .IX Item "ev_tstamp repeat [read-write]" |
997 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1337 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
998 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1338 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
999 | which is also when any modifications are taken into account. |
1339 | which is also when any modifications are taken into account. |
1000 | .PP |
1340 | .PP |
1001 | Example: create a timer that fires after 60 seconds. |
1341 | Example: Create a timer that fires after 60 seconds. |
1002 | .PP |
1342 | .PP |
1003 | .Vb 5 |
1343 | .Vb 5 |
1004 | \& static void |
1344 | \& static void |
1005 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1345 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1006 | \& { |
1346 | \& { |
… | |
… | |
1012 | \& struct ev_timer mytimer; |
1352 | \& struct ev_timer mytimer; |
1013 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1353 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1014 | \& ev_timer_start (loop, &mytimer); |
1354 | \& ev_timer_start (loop, &mytimer); |
1015 | .Ve |
1355 | .Ve |
1016 | .PP |
1356 | .PP |
1017 | Example: create a timeout timer that times out after 10 seconds of |
1357 | Example: Create a timeout timer that times out after 10 seconds of |
1018 | inactivity. |
1358 | inactivity. |
1019 | .PP |
1359 | .PP |
1020 | .Vb 5 |
1360 | .Vb 5 |
1021 | \& static void |
1361 | \& static void |
1022 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1362 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
… | |
… | |
1047 | but on wallclock time (absolute time). You can tell a periodic watcher |
1387 | but on wallclock time (absolute time). You can tell a periodic watcher |
1048 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1388 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1049 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1389 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1050 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1390 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1051 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1391 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1052 | roughly 10 seconds later and of course not if you reset your system time |
1392 | roughly 10 seconds later). |
1053 | again). |
|
|
1054 | .PP |
1393 | .PP |
1055 | They can also be used to implement vastly more complex timers, such as |
1394 | They can also be used to implement vastly more complex timers, such as |
1056 | triggering an event on eahc midnight, local time. |
1395 | triggering an event on each midnight, local time or other, complicated, |
|
|
1396 | rules. |
1057 | .PP |
1397 | .PP |
1058 | As with timers, the callback is guarenteed to be invoked only when the |
1398 | As with timers, the callback is guarenteed to be invoked only when the |
1059 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1399 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1060 | during the same loop iteration then order of execution is undefined. |
1400 | during the same loop iteration then order of execution is undefined. |
|
|
1401 | .PP |
|
|
1402 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1403 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1061 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1404 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1062 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1405 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1063 | .PD 0 |
1406 | .PD 0 |
1064 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1407 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1065 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1408 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1066 | .PD |
1409 | .PD |
1067 | Lots of arguments, lets sort it out... There are basically three modes of |
1410 | Lots of arguments, lets sort it out... There are basically three modes of |
1068 | operation, and we will explain them from simplest to complex: |
1411 | operation, and we will explain them from simplest to complex: |
1069 | .RS 4 |
1412 | .RS 4 |
1070 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
1413 | .IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 |
1071 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
1414 | .IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" |
1072 | In this configuration the watcher triggers an event at the wallclock time |
1415 | In this configuration the watcher triggers an event at the wallclock time |
1073 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1416 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1074 | that is, if it is to be run at January 1st 2011 then it will run when the |
1417 | that is, if it is to be run at January 1st 2011 then it will run when the |
1075 | system time reaches or surpasses this time. |
1418 | system time reaches or surpasses this time. |
1076 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
1419 | .IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 |
1077 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
1420 | .IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" |
1078 | In this mode the watcher will always be scheduled to time out at the next |
1421 | In this mode the watcher will always be scheduled to time out at the next |
1079 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
1422 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1080 | of any time jumps. |
1423 | and then repeat, regardless of any time jumps. |
1081 | .Sp |
1424 | .Sp |
1082 | This can be used to create timers that do not drift with respect to system |
1425 | This can be used to create timers that do not drift with respect to system |
1083 | time: |
1426 | time: |
1084 | .Sp |
1427 | .Sp |
1085 | .Vb 1 |
1428 | .Vb 1 |
… | |
… | |
1092 | by 3600. |
1435 | by 3600. |
1093 | .Sp |
1436 | .Sp |
1094 | Another way to think about it (for the mathematically inclined) is that |
1437 | Another way to think about it (for the mathematically inclined) is that |
1095 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1438 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1096 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1439 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
|
|
1440 | .Sp |
|
|
1441 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
|
|
1442 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
1443 | this value. |
1097 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
1444 | .IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 |
1098 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
1445 | .IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" |
1099 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1446 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1100 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1447 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1101 | reschedule callback will be called with the watcher as first, and the |
1448 | reschedule callback will be called with the watcher as first, and the |
1102 | current time as second argument. |
1449 | current time as second argument. |
1103 | .Sp |
1450 | .Sp |
1104 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1451 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1105 | ever, or make any event loop modifications\fR. If you need to stop it, |
1452 | ever, or make any event loop modifications\fR. If you need to stop it, |
1106 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1453 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1107 | starting a prepare watcher). |
1454 | starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). |
1108 | .Sp |
1455 | .Sp |
1109 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1456 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1110 | ev_tstamp now)\*(C'\fR, e.g.: |
1457 | ev_tstamp now)\*(C'\fR, e.g.: |
1111 | .Sp |
1458 | .Sp |
1112 | .Vb 4 |
1459 | .Vb 4 |
… | |
… | |
1136 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1483 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1137 | Simply stops and restarts the periodic watcher again. This is only useful |
1484 | Simply stops and restarts the periodic watcher again. This is only useful |
1138 | when you changed some parameters or the reschedule callback would return |
1485 | when you changed some parameters or the reschedule callback would return |
1139 | a different time than the last time it was called (e.g. in a crond like |
1486 | a different time than the last time it was called (e.g. in a crond like |
1140 | program when the crontabs have changed). |
1487 | program when the crontabs have changed). |
|
|
1488 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
1489 | .IX Item "ev_tstamp offset [read-write]" |
|
|
1490 | When repeating, this contains the offset value, otherwise this is the |
|
|
1491 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
|
|
1492 | .Sp |
|
|
1493 | Can be modified any time, but changes only take effect when the periodic |
|
|
1494 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1141 | .IP "ev_tstamp interval [read\-write]" 4 |
1495 | .IP "ev_tstamp interval [read\-write]" 4 |
1142 | .IX Item "ev_tstamp interval [read-write]" |
1496 | .IX Item "ev_tstamp interval [read-write]" |
1143 | The current interval value. Can be modified any time, but changes only |
1497 | The current interval value. Can be modified any time, but changes only |
1144 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1498 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1145 | called. |
1499 | called. |
1146 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1500 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1147 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1501 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1148 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1502 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1149 | switched off. Can be changed any time, but changes only take effect when |
1503 | switched off. Can be changed any time, but changes only take effect when |
1150 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1504 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
|
|
1505 | .IP "ev_tstamp at [read\-only]" 4 |
|
|
1506 | .IX Item "ev_tstamp at [read-only]" |
|
|
1507 | When active, contains the absolute time that the watcher is supposed to |
|
|
1508 | trigger next. |
1151 | .PP |
1509 | .PP |
1152 | Example: call a callback every hour, or, more precisely, whenever the |
1510 | Example: Call a callback every hour, or, more precisely, whenever the |
1153 | system clock is divisible by 3600. The callback invocation times have |
1511 | system clock is divisible by 3600. The callback invocation times have |
1154 | potentially a lot of jittering, but good long-term stability. |
1512 | potentially a lot of jittering, but good long-term stability. |
1155 | .PP |
1513 | .PP |
1156 | .Vb 5 |
1514 | .Vb 5 |
1157 | \& static void |
1515 | \& static void |
… | |
… | |
1165 | \& struct ev_periodic hourly_tick; |
1523 | \& struct ev_periodic hourly_tick; |
1166 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1524 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1167 | \& ev_periodic_start (loop, &hourly_tick); |
1525 | \& ev_periodic_start (loop, &hourly_tick); |
1168 | .Ve |
1526 | .Ve |
1169 | .PP |
1527 | .PP |
1170 | Example: the same as above, but use a reschedule callback to do it: |
1528 | Example: The same as above, but use a reschedule callback to do it: |
1171 | .PP |
1529 | .PP |
1172 | .Vb 1 |
1530 | .Vb 1 |
1173 | \& #include <math.h> |
1531 | \& #include <math.h> |
1174 | .Ve |
1532 | .Ve |
1175 | .PP |
1533 | .PP |
… | |
… | |
1183 | .PP |
1541 | .PP |
1184 | .Vb 1 |
1542 | .Vb 1 |
1185 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1543 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1186 | .Ve |
1544 | .Ve |
1187 | .PP |
1545 | .PP |
1188 | Example: call a callback every hour, starting now: |
1546 | Example: Call a callback every hour, starting now: |
1189 | .PP |
1547 | .PP |
1190 | .Vb 4 |
1548 | .Vb 4 |
1191 | \& struct ev_periodic hourly_tick; |
1549 | \& struct ev_periodic hourly_tick; |
1192 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1550 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1193 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1551 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
… | |
… | |
1205 | first watcher gets started will libev actually register a signal watcher |
1563 | first watcher gets started will libev actually register a signal watcher |
1206 | with the kernel (thus it coexists with your own signal handlers as long |
1564 | with the kernel (thus it coexists with your own signal handlers as long |
1207 | as you don't register any with libev). Similarly, when the last signal |
1565 | as you don't register any with libev). Similarly, when the last signal |
1208 | watcher for a signal is stopped libev will reset the signal handler to |
1566 | watcher for a signal is stopped libev will reset the signal handler to |
1209 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
1567 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
|
|
1568 | .PP |
|
|
1569 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1570 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1210 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1571 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1211 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1572 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1212 | .PD 0 |
1573 | .PD 0 |
1213 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1574 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1214 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1575 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
… | |
… | |
1221 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1582 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1222 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1583 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1223 | .IX Subsection "ev_child - watch out for process status changes" |
1584 | .IX Subsection "ev_child - watch out for process status changes" |
1224 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1585 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1225 | some child status changes (most typically when a child of yours dies). |
1586 | some child status changes (most typically when a child of yours dies). |
|
|
1587 | .PP |
|
|
1588 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1589 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1226 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1590 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
1227 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1591 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
1228 | .PD 0 |
1592 | .PD 0 |
1229 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1593 | .IP "ev_child_set (ev_child *, int pid)" 4 |
1230 | .IX Item "ev_child_set (ev_child *, int pid)" |
1594 | .IX Item "ev_child_set (ev_child *, int pid)" |
… | |
… | |
1244 | .IP "int rstatus [read\-write]" 4 |
1608 | .IP "int rstatus [read\-write]" 4 |
1245 | .IX Item "int rstatus [read-write]" |
1609 | .IX Item "int rstatus [read-write]" |
1246 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
1610 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
1247 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1611 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1248 | .PP |
1612 | .PP |
1249 | Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1613 | Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1250 | .PP |
1614 | .PP |
1251 | .Vb 5 |
1615 | .Vb 5 |
1252 | \& static void |
1616 | \& static void |
1253 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1617 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1254 | \& { |
1618 | \& { |
… | |
… | |
1272 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1636 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1273 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1637 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1274 | otherwise always forced to be at least one) and all the other fields of |
1638 | otherwise always forced to be at least one) and all the other fields of |
1275 | the stat buffer having unspecified contents. |
1639 | the stat buffer having unspecified contents. |
1276 | .PP |
1640 | .PP |
|
|
1641 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
|
|
1642 | relative and your working directory changes, the behaviour is undefined. |
|
|
1643 | .PP |
1277 | Since there is no standard to do this, the portable implementation simply |
1644 | Since there is no standard to do this, the portable implementation simply |
1278 | calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You |
1645 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
1279 | can specify a recommended polling interval for this case. If you specify |
1646 | can specify a recommended polling interval for this case. If you specify |
1280 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1647 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1281 | unspecified default\fR value will be used (which you can expect to be around |
1648 | unspecified default\fR value will be used (which you can expect to be around |
1282 | five seconds, although this might change dynamically). Libev will also |
1649 | five seconds, although this might change dynamically). Libev will also |
1283 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
1650 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
… | |
… | |
1285 | .PP |
1652 | .PP |
1286 | This watcher type is not meant for massive numbers of stat watchers, |
1653 | This watcher type is not meant for massive numbers of stat watchers, |
1287 | as even with OS-supported change notifications, this can be |
1654 | as even with OS-supported change notifications, this can be |
1288 | resource\-intensive. |
1655 | resource\-intensive. |
1289 | .PP |
1656 | .PP |
1290 | At the time of this writing, no specific \s-1OS\s0 backends are implemented, but |
1657 | At the time of this writing, only the Linux inotify interface is |
1291 | if demand increases, at least a kqueue and inotify backend will be added. |
1658 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1659 | reader). Inotify will be used to give hints only and should not change the |
|
|
1660 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
|
|
1661 | to fall back to regular polling again even with inotify, but changes are |
|
|
1662 | usually detected immediately, and if the file exists there will be no |
|
|
1663 | polling. |
|
|
1664 | .PP |
|
|
1665 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1666 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1292 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1667 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1293 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1668 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1294 | .PD 0 |
1669 | .PD 0 |
1295 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1670 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1296 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
1671 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1357 | \& ev_stat_start (loop, &passwd); |
1732 | \& ev_stat_start (loop, &passwd); |
1358 | .Ve |
1733 | .Ve |
1359 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1734 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1360 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1735 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1361 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1736 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1362 | Idle watchers trigger events when there are no other events are pending |
1737 | Idle watchers trigger events when no other events of the same or higher |
1363 | (prepare, check and other idle watchers do not count). That is, as long |
1738 | priority are pending (prepare, check and other idle watchers do not |
1364 | as your process is busy handling sockets or timeouts (or even signals, |
1739 | count). |
1365 | imagine) it will not be triggered. But when your process is idle all idle |
1740 | .PP |
1366 | watchers are being called again and again, once per event loop iteration \- |
1741 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1742 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1743 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1744 | are pending), the idle watchers are being called once per event loop |
1367 | until stopped, that is, or your process receives more events and becomes |
1745 | iteration \- until stopped, that is, or your process receives more events |
1368 | busy. |
1746 | and becomes busy again with higher priority stuff. |
1369 | .PP |
1747 | .PP |
1370 | The most noteworthy effect is that as long as any idle watchers are |
1748 | The most noteworthy effect is that as long as any idle watchers are |
1371 | active, the process will not block when waiting for new events. |
1749 | active, the process will not block when waiting for new events. |
1372 | .PP |
1750 | .PP |
1373 | Apart from keeping your process non-blocking (which is a useful |
1751 | Apart from keeping your process non-blocking (which is a useful |
1374 | effect on its own sometimes), idle watchers are a good place to do |
1752 | effect on its own sometimes), idle watchers are a good place to do |
1375 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1753 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
1376 | event loop has handled all outstanding events. |
1754 | event loop has handled all outstanding events. |
|
|
1755 | .PP |
|
|
1756 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1757 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1377 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1758 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1378 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1759 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1379 | Initialises and configures the idle watcher \- it has no parameters of any |
1760 | Initialises and configures the idle watcher \- it has no parameters of any |
1380 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1761 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1381 | believe me. |
1762 | believe me. |
1382 | .PP |
1763 | .PP |
1383 | Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the |
1764 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
1384 | callback, free it. Alos, use no error checking, as usual. |
1765 | callback, free it. Also, use no error checking, as usual. |
1385 | .PP |
1766 | .PP |
1386 | .Vb 7 |
1767 | .Vb 7 |
1387 | \& static void |
1768 | \& static void |
1388 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1769 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1389 | \& { |
1770 | \& { |
… | |
… | |
1436 | are ready to run (it's actually more complicated: it only runs coroutines |
1817 | are ready to run (it's actually more complicated: it only runs coroutines |
1437 | with priority higher than or equal to the event loop and one coroutine |
1818 | with priority higher than or equal to the event loop and one coroutine |
1438 | of lower priority, but only once, using idle watchers to keep the event |
1819 | of lower priority, but only once, using idle watchers to keep the event |
1439 | loop from blocking if lower-priority coroutines are active, thus mapping |
1820 | loop from blocking if lower-priority coroutines are active, thus mapping |
1440 | low-priority coroutines to idle/background tasks). |
1821 | low-priority coroutines to idle/background tasks). |
|
|
1822 | .PP |
|
|
1823 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
1824 | priority, to ensure that they are being run before any other watchers |
|
|
1825 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
|
|
1826 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
|
|
1827 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers |
|
|
1828 | did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other |
|
|
1829 | (non\-libev) event loops those other event loops might be in an unusable |
|
|
1830 | state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to |
|
|
1831 | coexist peacefully with others). |
|
|
1832 | .PP |
|
|
1833 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1834 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1441 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1835 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1442 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1836 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1443 | .PD 0 |
1837 | .PD 0 |
1444 | .IP "ev_check_init (ev_check *, callback)" 4 |
1838 | .IP "ev_check_init (ev_check *, callback)" 4 |
1445 | .IX Item "ev_check_init (ev_check *, callback)" |
1839 | .IX Item "ev_check_init (ev_check *, callback)" |
1446 | .PD |
1840 | .PD |
1447 | Initialises and configures the prepare or check watcher \- they have no |
1841 | Initialises and configures the prepare or check watcher \- they have no |
1448 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1842 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1449 | macros, but using them is utterly, utterly and completely pointless. |
1843 | macros, but using them is utterly, utterly and completely pointless. |
1450 | .PP |
1844 | .PP |
1451 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
1845 | There are a number of principal ways to embed other event loops or modules |
1452 | and a timeout watcher in a prepare handler, as required by libadns, and |
1846 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1847 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
1848 | use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR |
|
|
1849 | embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 |
|
|
1850 | into the Glib event loop). |
|
|
1851 | .PP |
|
|
1852 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
1453 | in a check watcher, destroy them and call into libadns. What follows is |
1853 | and in a check watcher, destroy them and call into libadns. What follows |
1454 | pseudo-code only of course: |
1854 | is pseudo-code only of course. This requires you to either use a low |
|
|
1855 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
1856 | the callbacks for the IO/timeout watchers might not have been called yet. |
1455 | .PP |
1857 | .PP |
1456 | .Vb 2 |
1858 | .Vb 2 |
1457 | \& static ev_io iow [nfd]; |
1859 | \& static ev_io iow [nfd]; |
1458 | \& static ev_timer tw; |
1860 | \& static ev_timer tw; |
1459 | .Ve |
1861 | .Ve |
1460 | .PP |
1862 | .PP |
1461 | .Vb 9 |
1863 | .Vb 4 |
1462 | \& static void |
1864 | \& static void |
1463 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1865 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1464 | \& { |
1866 | \& { |
1465 | \& // set the relevant poll flags |
|
|
1466 | \& // could also call adns_processreadable etc. here |
|
|
1467 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1468 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1469 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1470 | \& } |
1867 | \& } |
1471 | .Ve |
1868 | .Ve |
1472 | .PP |
1869 | .PP |
1473 | .Vb 7 |
1870 | .Vb 8 |
1474 | \& // create io watchers for each fd and a timer before blocking |
1871 | \& // create io watchers for each fd and a timer before blocking |
1475 | \& static void |
1872 | \& static void |
1476 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1873 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1477 | \& { |
1874 | \& { |
1478 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
1875 | \& int timeout = 3600000; |
|
|
1876 | \& struct pollfd fds [nfd]; |
1479 | \& // actual code will need to loop here and realloc etc. |
1877 | \& // actual code will need to loop here and realloc etc. |
1480 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1878 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1481 | .Ve |
1879 | .Ve |
1482 | .PP |
1880 | .PP |
1483 | .Vb 3 |
1881 | .Vb 3 |
… | |
… | |
1485 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1883 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1486 | \& ev_timer_start (loop, &tw); |
1884 | \& ev_timer_start (loop, &tw); |
1487 | .Ve |
1885 | .Ve |
1488 | .PP |
1886 | .PP |
1489 | .Vb 6 |
1887 | .Vb 6 |
1490 | \& // create on ev_io per pollfd |
1888 | \& // create one ev_io per pollfd |
1491 | \& for (int i = 0; i < nfd; ++i) |
1889 | \& for (int i = 0; i < nfd; ++i) |
1492 | \& { |
1890 | \& { |
1493 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1891 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1494 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1892 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1495 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1893 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1496 | .Ve |
1894 | .Ve |
1497 | .PP |
1895 | .PP |
1498 | .Vb 5 |
1896 | .Vb 4 |
1499 | \& fds [i].revents = 0; |
1897 | \& fds [i].revents = 0; |
1500 | \& iow [i].data = fds + i; |
|
|
1501 | \& ev_io_start (loop, iow + i); |
1898 | \& ev_io_start (loop, iow + i); |
1502 | \& } |
1899 | \& } |
1503 | \& } |
1900 | \& } |
1504 | .Ve |
1901 | .Ve |
1505 | .PP |
1902 | .PP |
… | |
… | |
1509 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1906 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1510 | \& { |
1907 | \& { |
1511 | \& ev_timer_stop (loop, &tw); |
1908 | \& ev_timer_stop (loop, &tw); |
1512 | .Ve |
1909 | .Ve |
1513 | .PP |
1910 | .PP |
1514 | .Vb 2 |
1911 | .Vb 8 |
1515 | \& for (int i = 0; i < nfd; ++i) |
1912 | \& for (int i = 0; i < nfd; ++i) |
|
|
1913 | \& { |
|
|
1914 | \& // set the relevant poll flags |
|
|
1915 | \& // could also call adns_processreadable etc. here |
|
|
1916 | \& struct pollfd *fd = fds + i; |
|
|
1917 | \& int revents = ev_clear_pending (iow + i); |
|
|
1918 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1919 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1920 | .Ve |
|
|
1921 | .PP |
|
|
1922 | .Vb 3 |
|
|
1923 | \& // now stop the watcher |
1516 | \& ev_io_stop (loop, iow + i); |
1924 | \& ev_io_stop (loop, iow + i); |
|
|
1925 | \& } |
1517 | .Ve |
1926 | .Ve |
1518 | .PP |
1927 | .PP |
1519 | .Vb 2 |
1928 | .Vb 2 |
1520 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1929 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1930 | \& } |
|
|
1931 | .Ve |
|
|
1932 | .PP |
|
|
1933 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
1934 | in the prepare watcher and would dispose of the check watcher. |
|
|
1935 | .PP |
|
|
1936 | Method 3: If the module to be embedded supports explicit event |
|
|
1937 | notification (adns does), you can also make use of the actual watcher |
|
|
1938 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1939 | .PP |
|
|
1940 | .Vb 5 |
|
|
1941 | \& static void |
|
|
1942 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1943 | \& { |
|
|
1944 | \& adns_state ads = (adns_state)w->data; |
|
|
1945 | \& update_now (EV_A); |
|
|
1946 | .Ve |
|
|
1947 | .PP |
|
|
1948 | .Vb 2 |
|
|
1949 | \& adns_processtimeouts (ads, &tv_now); |
|
|
1950 | \& } |
|
|
1951 | .Ve |
|
|
1952 | .PP |
|
|
1953 | .Vb 5 |
|
|
1954 | \& static void |
|
|
1955 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
1956 | \& { |
|
|
1957 | \& adns_state ads = (adns_state)w->data; |
|
|
1958 | \& update_now (EV_A); |
|
|
1959 | .Ve |
|
|
1960 | .PP |
|
|
1961 | .Vb 3 |
|
|
1962 | \& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1963 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1964 | \& } |
|
|
1965 | .Ve |
|
|
1966 | .PP |
|
|
1967 | .Vb 1 |
|
|
1968 | \& // do not ever call adns_afterpoll |
|
|
1969 | .Ve |
|
|
1970 | .PP |
|
|
1971 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1972 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1973 | their poll function. The drawback with this solution is that the main |
|
|
1974 | loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does |
|
|
1975 | this. |
|
|
1976 | .PP |
|
|
1977 | .Vb 4 |
|
|
1978 | \& static gint |
|
|
1979 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1980 | \& { |
|
|
1981 | \& int got_events = 0; |
|
|
1982 | .Ve |
|
|
1983 | .PP |
|
|
1984 | .Vb 2 |
|
|
1985 | \& for (n = 0; n < nfds; ++n) |
|
|
1986 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1987 | .Ve |
|
|
1988 | .PP |
|
|
1989 | .Vb 2 |
|
|
1990 | \& if (timeout >= 0) |
|
|
1991 | \& // create/start timer |
|
|
1992 | .Ve |
|
|
1993 | .PP |
|
|
1994 | .Vb 2 |
|
|
1995 | \& // poll |
|
|
1996 | \& ev_loop (EV_A_ 0); |
|
|
1997 | .Ve |
|
|
1998 | .PP |
|
|
1999 | .Vb 3 |
|
|
2000 | \& // stop timer again |
|
|
2001 | \& if (timeout >= 0) |
|
|
2002 | \& ev_timer_stop (EV_A_ &to); |
|
|
2003 | .Ve |
|
|
2004 | .PP |
|
|
2005 | .Vb 3 |
|
|
2006 | \& // stop io watchers again - their callbacks should have set |
|
|
2007 | \& for (n = 0; n < nfds; ++n) |
|
|
2008 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
2009 | .Ve |
|
|
2010 | .PP |
|
|
2011 | .Vb 2 |
|
|
2012 | \& return got_events; |
1521 | \& } |
2013 | \& } |
1522 | .Ve |
2014 | .Ve |
1523 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
2015 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1524 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
2016 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1525 | .IX Subsection "ev_embed - when one backend isn't enough..." |
2017 | .IX Subsection "ev_embed - when one backend isn't enough..." |
… | |
… | |
1594 | \& ev_embed_start (loop_hi, &embed); |
2086 | \& ev_embed_start (loop_hi, &embed); |
1595 | \& } |
2087 | \& } |
1596 | \& else |
2088 | \& else |
1597 | \& loop_lo = loop_hi; |
2089 | \& loop_lo = loop_hi; |
1598 | .Ve |
2090 | .Ve |
|
|
2091 | .PP |
|
|
2092 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2093 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1599 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2094 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1600 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2095 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1601 | .PD 0 |
2096 | .PD 0 |
1602 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2097 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1603 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2098 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
… | |
… | |
1610 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
2105 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
1611 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
2106 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
1612 | Make a single, non-blocking sweep over the embedded loop. This works |
2107 | Make a single, non-blocking sweep over the embedded loop. This works |
1613 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
2108 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
1614 | apropriate way for embedded loops. |
2109 | apropriate way for embedded loops. |
1615 | .IP "struct ev_loop *loop [read\-only]" 4 |
2110 | .IP "struct ev_loop *other [read\-only]" 4 |
1616 | .IX Item "struct ev_loop *loop [read-only]" |
2111 | .IX Item "struct ev_loop *other [read-only]" |
1617 | The embedded event loop. |
2112 | The embedded event loop. |
|
|
2113 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
|
|
2114 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
|
|
2115 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
|
|
2116 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
|
|
2117 | whoever is a good citizen cared to tell libev about it by calling |
|
|
2118 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
|
|
2119 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
|
|
2120 | and only in the child after the fork. If whoever good citizen calling |
|
|
2121 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
|
|
2122 | handlers will be invoked, too, of course. |
|
|
2123 | .PP |
|
|
2124 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2125 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
2126 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
|
|
2127 | .IX Item "ev_fork_init (ev_signal *, callback)" |
|
|
2128 | Initialises and configures the fork watcher \- it has no parameters of any |
|
|
2129 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
|
|
2130 | believe me. |
1618 | .SH "OTHER FUNCTIONS" |
2131 | .SH "OTHER FUNCTIONS" |
1619 | .IX Header "OTHER FUNCTIONS" |
2132 | .IX Header "OTHER FUNCTIONS" |
1620 | There are some other functions of possible interest. Described. Here. Now. |
2133 | There are some other functions of possible interest. Described. Here. Now. |
1621 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
2134 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
1622 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
2135 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
… | |
… | |
1694 | .PP |
2207 | .PP |
1695 | .Vb 1 |
2208 | .Vb 1 |
1696 | \& #include <ev++.h> |
2209 | \& #include <ev++.h> |
1697 | .Ve |
2210 | .Ve |
1698 | .PP |
2211 | .PP |
1699 | (it is not installed by default). This automatically includes \fIev.h\fR |
2212 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1700 | and puts all of its definitions (many of them macros) into the global |
2213 | of them macros) into the global namespace. All \*(C+ specific things are |
1701 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
2214 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
2215 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1702 | .PP |
2216 | .PP |
1703 | It should support all the same embedding options as \fIev.h\fR, most notably |
2217 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1704 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
2218 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
2219 | that the watcher is associated with (or no additional members at all if |
|
|
2220 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
2221 | .PP |
|
|
2222 | Currently, functions, and static and non-static member functions can be |
|
|
2223 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2224 | need one additional pointer for context. If you need support for other |
|
|
2225 | types of functors please contact the author (preferably after implementing |
|
|
2226 | it). |
1705 | .PP |
2227 | .PP |
1706 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
2228 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1707 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
2229 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
1708 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
2230 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1709 | .IX Item "ev::READ, ev::WRITE etc." |
2231 | .IX Item "ev::READ, ev::WRITE etc." |
… | |
… | |
1721 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
2243 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1722 | defines by many implementations. |
2244 | defines by many implementations. |
1723 | .Sp |
2245 | .Sp |
1724 | All of those classes have these methods: |
2246 | All of those classes have these methods: |
1725 | .RS 4 |
2247 | .RS 4 |
1726 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
2248 | .IP "ev::TYPE::TYPE ()" 4 |
1727 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
2249 | .IX Item "ev::TYPE::TYPE ()" |
1728 | .PD 0 |
2250 | .PD 0 |
1729 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
2251 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
1730 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
2252 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
1731 | .IP "ev::TYPE::~TYPE" 4 |
2253 | .IP "ev::TYPE::~TYPE" 4 |
1732 | .IX Item "ev::TYPE::~TYPE" |
2254 | .IX Item "ev::TYPE::~TYPE" |
1733 | .PD |
2255 | .PD |
1734 | The constructor takes a pointer to an object and a method pointer to |
2256 | The constructor (optionally) takes an event loop to associate the watcher |
1735 | the event handler callback to call in this class. The constructor calls |
2257 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
1736 | \&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method |
2258 | .Sp |
1737 | before starting it. If you do not specify a loop then the constructor |
2259 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
1738 | automatically associates the default loop with this watcher. |
2260 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
2261 | .Sp |
|
|
2262 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
2263 | method to set a callback before you can start the watcher. |
|
|
2264 | .Sp |
|
|
2265 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
2266 | not allow explicit template arguments for constructors). |
1739 | .Sp |
2267 | .Sp |
1740 | The destructor automatically stops the watcher if it is active. |
2268 | The destructor automatically stops the watcher if it is active. |
|
|
2269 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
2270 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
2271 | This method sets the callback method to call. The method has to have a |
|
|
2272 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
2273 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
2274 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
2275 | .Sp |
|
|
2276 | This method synthesizes efficient thunking code to call your method from |
|
|
2277 | the C callback that libev requires. If your compiler can inline your |
|
|
2278 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
2279 | your compiler is good :), then the method will be fully inlined into the |
|
|
2280 | thunking function, making it as fast as a direct C callback. |
|
|
2281 | .Sp |
|
|
2282 | Example: simple class declaration and watcher initialisation |
|
|
2283 | .Sp |
|
|
2284 | .Vb 4 |
|
|
2285 | \& struct myclass |
|
|
2286 | \& { |
|
|
2287 | \& void io_cb (ev::io &w, int revents) { } |
|
|
2288 | \& } |
|
|
2289 | .Ve |
|
|
2290 | .Sp |
|
|
2291 | .Vb 3 |
|
|
2292 | \& myclass obj; |
|
|
2293 | \& ev::io iow; |
|
|
2294 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
2295 | .Ve |
|
|
2296 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
2297 | .IX Item "w->set<function> (void *data = 0)" |
|
|
2298 | Also sets a callback, but uses a static method or plain function as |
|
|
2299 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
2300 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
2301 | .Sp |
|
|
2302 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
2303 | .Sp |
|
|
2304 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
2305 | .Sp |
|
|
2306 | Example: |
|
|
2307 | .Sp |
|
|
2308 | .Vb 2 |
|
|
2309 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
2310 | \& iow.set <io_cb> (); |
|
|
2311 | .Ve |
1741 | .IP "w\->set (struct ev_loop *)" 4 |
2312 | .IP "w\->set (struct ev_loop *)" 4 |
1742 | .IX Item "w->set (struct ev_loop *)" |
2313 | .IX Item "w->set (struct ev_loop *)" |
1743 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
2314 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1744 | do this when the watcher is inactive (and not pending either). |
2315 | do this when the watcher is inactive (and not pending either). |
1745 | .IP "w\->set ([args])" 4 |
2316 | .IP "w\->set ([args])" 4 |
1746 | .IX Item "w->set ([args])" |
2317 | .IX Item "w->set ([args])" |
1747 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
2318 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
1748 | called at least once. Unlike the C counterpart, an active watcher gets |
2319 | called at least once. Unlike the C counterpart, an active watcher gets |
1749 | automatically stopped and restarted. |
2320 | automatically stopped and restarted when reconfiguring it with this |
|
|
2321 | method. |
1750 | .IP "w\->start ()" 4 |
2322 | .IP "w\->start ()" 4 |
1751 | .IX Item "w->start ()" |
2323 | .IX Item "w->start ()" |
1752 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
2324 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
1753 | constructor already takes the loop. |
2325 | constructor already stores the event loop. |
1754 | .IP "w\->stop ()" 4 |
2326 | .IP "w\->stop ()" 4 |
1755 | .IX Item "w->stop ()" |
2327 | .IX Item "w->stop ()" |
1756 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2328 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
1757 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
2329 | .ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 |
1758 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
2330 | .el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 |
1759 | .IX Item "w->again () ev::timer, ev::periodic only" |
2331 | .IX Item "w->again () (ev::timer, ev::periodic only)" |
1760 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
2332 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
1761 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
2333 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
1762 | .ie n .IP "w\->sweep () ""ev::embed"" only" 4 |
2334 | .ie n .IP "w\->sweep () (""ev::embed"" only)" 4 |
1763 | .el .IP "w\->sweep () \f(CWev::embed\fR only" 4 |
2335 | .el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 |
1764 | .IX Item "w->sweep () ev::embed only" |
2336 | .IX Item "w->sweep () (ev::embed only)" |
1765 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
2337 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
|
|
2338 | .ie n .IP "w\->update () (""ev::stat"" only)" 4 |
|
|
2339 | .el .IP "w\->update () (\f(CWev::stat\fR only)" 4 |
|
|
2340 | .IX Item "w->update () (ev::stat only)" |
|
|
2341 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
1766 | .RE |
2342 | .RE |
1767 | .RS 4 |
2343 | .RS 4 |
1768 | .RE |
2344 | .RE |
1769 | .PP |
2345 | .PP |
1770 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
2346 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
… | |
… | |
1780 | .Vb 2 |
2356 | .Vb 2 |
1781 | \& myclass (); |
2357 | \& myclass (); |
1782 | \& } |
2358 | \& } |
1783 | .Ve |
2359 | .Ve |
1784 | .PP |
2360 | .PP |
1785 | .Vb 6 |
2361 | .Vb 4 |
1786 | \& myclass::myclass (int fd) |
2362 | \& myclass::myclass (int fd) |
1787 | \& : io (this, &myclass::io_cb), |
|
|
1788 | \& idle (this, &myclass::idle_cb) |
|
|
1789 | \& { |
2363 | \& { |
|
|
2364 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
2365 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2366 | .Ve |
|
|
2367 | .PP |
|
|
2368 | .Vb 2 |
1790 | \& io.start (fd, ev::READ); |
2369 | \& io.start (fd, ev::READ); |
1791 | \& } |
2370 | \& } |
|
|
2371 | .Ve |
|
|
2372 | .SH "MACRO MAGIC" |
|
|
2373 | .IX Header "MACRO MAGIC" |
|
|
2374 | Libev can be compiled with a variety of options, the most fundamantal |
|
|
2375 | of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) |
|
|
2376 | functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
|
|
2377 | .PP |
|
|
2378 | To make it easier to write programs that cope with either variant, the |
|
|
2379 | following macros are defined: |
|
|
2380 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
|
|
2381 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
|
|
2382 | .IX Item "EV_A, EV_A_" |
|
|
2383 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
|
|
2384 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
|
|
2385 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
|
|
2386 | .Sp |
|
|
2387 | .Vb 3 |
|
|
2388 | \& ev_unref (EV_A); |
|
|
2389 | \& ev_timer_add (EV_A_ watcher); |
|
|
2390 | \& ev_loop (EV_A_ 0); |
|
|
2391 | .Ve |
|
|
2392 | .Sp |
|
|
2393 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
|
|
2394 | which is often provided by the following macro. |
|
|
2395 | .ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 |
|
|
2396 | .el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 |
|
|
2397 | .IX Item "EV_P, EV_P_" |
|
|
2398 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
|
|
2399 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
|
|
2400 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
|
|
2401 | .Sp |
|
|
2402 | .Vb 2 |
|
|
2403 | \& // this is how ev_unref is being declared |
|
|
2404 | \& static void ev_unref (EV_P); |
|
|
2405 | .Ve |
|
|
2406 | .Sp |
|
|
2407 | .Vb 2 |
|
|
2408 | \& // this is how you can declare your typical callback |
|
|
2409 | \& static void cb (EV_P_ ev_timer *w, int revents) |
|
|
2410 | .Ve |
|
|
2411 | .Sp |
|
|
2412 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
|
|
2413 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
|
|
2414 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
|
|
2415 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
|
|
2416 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
|
|
2417 | Similar to the other two macros, this gives you the value of the default |
|
|
2418 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
|
|
2419 | .PP |
|
|
2420 | Example: Declare and initialise a check watcher, utilising the above |
|
|
2421 | macros so it will work regardless of whether multiple loops are supported |
|
|
2422 | or not. |
|
|
2423 | .PP |
|
|
2424 | .Vb 5 |
|
|
2425 | \& static void |
|
|
2426 | \& check_cb (EV_P_ ev_timer *w, int revents) |
|
|
2427 | \& { |
|
|
2428 | \& ev_check_stop (EV_A_ w); |
|
|
2429 | \& } |
|
|
2430 | .Ve |
|
|
2431 | .PP |
|
|
2432 | .Vb 4 |
|
|
2433 | \& ev_check check; |
|
|
2434 | \& ev_check_init (&check, check_cb); |
|
|
2435 | \& ev_check_start (EV_DEFAULT_ &check); |
|
|
2436 | \& ev_loop (EV_DEFAULT_ 0); |
1792 | .Ve |
2437 | .Ve |
1793 | .SH "EMBEDDING" |
2438 | .SH "EMBEDDING" |
1794 | .IX Header "EMBEDDING" |
2439 | .IX Header "EMBEDDING" |
1795 | Libev can (and often is) directly embedded into host |
2440 | Libev can (and often is) directly embedded into host |
1796 | applications. Examples of applications that embed it include the Deliantra |
2441 | applications. Examples of applications that embed it include the Deliantra |
1797 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
2442 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
1798 | and rxvt\-unicode. |
2443 | and rxvt\-unicode. |
1799 | .PP |
2444 | .PP |
1800 | The goal is to enable you to just copy the neecssary files into your |
2445 | The goal is to enable you to just copy the necessary files into your |
1801 | source directory without having to change even a single line in them, so |
2446 | source directory without having to change even a single line in them, so |
1802 | you can easily upgrade by simply copying (or having a checked-out copy of |
2447 | you can easily upgrade by simply copying (or having a checked-out copy of |
1803 | libev somewhere in your source tree). |
2448 | libev somewhere in your source tree). |
1804 | .Sh "\s-1FILESETS\s0" |
2449 | .Sh "\s-1FILESETS\s0" |
1805 | .IX Subsection "FILESETS" |
2450 | .IX Subsection "FILESETS" |
… | |
… | |
1845 | .Vb 1 |
2490 | .Vb 1 |
1846 | \& ev_win32.c required on win32 platforms only |
2491 | \& ev_win32.c required on win32 platforms only |
1847 | .Ve |
2492 | .Ve |
1848 | .PP |
2493 | .PP |
1849 | .Vb 5 |
2494 | .Vb 5 |
1850 | \& ev_select.c only when select backend is enabled (which is by default) |
2495 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
1851 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2496 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
1852 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2497 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1853 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2498 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1854 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2499 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
1855 | .Ve |
2500 | .Ve |
… | |
… | |
1910 | .IX Item "EV_USE_MONOTONIC" |
2555 | .IX Item "EV_USE_MONOTONIC" |
1911 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2556 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
1912 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2557 | monotonic clock option at both compiletime and runtime. Otherwise no use |
1913 | of the monotonic clock option will be attempted. If you enable this, you |
2558 | of the monotonic clock option will be attempted. If you enable this, you |
1914 | usually have to link against librt or something similar. Enabling it when |
2559 | usually have to link against librt or something similar. Enabling it when |
1915 | the functionality isn't available is safe, though, althoguh you have |
2560 | the functionality isn't available is safe, though, although you have |
1916 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
2561 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
1917 | function is hiding in (often \fI\-lrt\fR). |
2562 | function is hiding in (often \fI\-lrt\fR). |
1918 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
2563 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
1919 | .IX Item "EV_USE_REALTIME" |
2564 | .IX Item "EV_USE_REALTIME" |
1920 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2565 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
1921 | realtime clock option at compiletime (and assume its availability at |
2566 | realtime clock option at compiletime (and assume its availability at |
1922 | runtime if successful). Otherwise no use of the realtime clock option will |
2567 | runtime if successful). Otherwise no use of the realtime clock option will |
1923 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
2568 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
1924 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
2569 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the |
1925 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
2570 | note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
|
|
2571 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
|
|
2572 | .IX Item "EV_USE_NANOSLEEP" |
|
|
2573 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
|
|
2574 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
1926 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2575 | .IP "\s-1EV_USE_SELECT\s0" 4 |
1927 | .IX Item "EV_USE_SELECT" |
2576 | .IX Item "EV_USE_SELECT" |
1928 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2577 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
1929 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
2578 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
1930 | other method takes over, select will be it. Otherwise the select backend |
2579 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
1976 | otherwise another method will be used as fallback. This is the preferred |
2625 | otherwise another method will be used as fallback. This is the preferred |
1977 | backend for Solaris 10 systems. |
2626 | backend for Solaris 10 systems. |
1978 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2627 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
1979 | .IX Item "EV_USE_DEVPOLL" |
2628 | .IX Item "EV_USE_DEVPOLL" |
1980 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2629 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
2630 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
|
|
2631 | .IX Item "EV_USE_INOTIFY" |
|
|
2632 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
|
|
2633 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
|
|
2634 | be detected at runtime. |
1981 | .IP "\s-1EV_H\s0" 4 |
2635 | .IP "\s-1EV_H\s0" 4 |
1982 | .IX Item "EV_H" |
2636 | .IX Item "EV_H" |
1983 | The name of the \fIev.h\fR header file used to include it. The default if |
2637 | The name of the \fIev.h\fR header file used to include it. The default if |
1984 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2638 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
1985 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2639 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
… | |
… | |
2003 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2657 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2004 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2658 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2005 | additional independent event loops. Otherwise there will be no support |
2659 | additional independent event loops. Otherwise there will be no support |
2006 | for multiple event loops and there is no first event loop pointer |
2660 | for multiple event loops and there is no first event loop pointer |
2007 | argument. Instead, all functions act on the single default loop. |
2661 | argument. Instead, all functions act on the single default loop. |
|
|
2662 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2663 | .IX Item "EV_MINPRI" |
|
|
2664 | .PD 0 |
|
|
2665 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2666 | .IX Item "EV_MAXPRI" |
|
|
2667 | .PD |
|
|
2668 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2669 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2670 | provide for more priorities by overriding those symbols (usually defined |
|
|
2671 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2672 | .Sp |
|
|
2673 | When doing priority-based operations, libev usually has to linearly search |
|
|
2674 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2675 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2676 | fine. |
|
|
2677 | .Sp |
|
|
2678 | If your embedding app does not need any priorities, defining these both to |
|
|
2679 | \&\f(CW0\fR will save some memory and cpu. |
2008 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2680 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2009 | .IX Item "EV_PERIODIC_ENABLE" |
2681 | .IX Item "EV_PERIODIC_ENABLE" |
2010 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2682 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
|
|
2683 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2684 | code. |
|
|
2685 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2686 | .IX Item "EV_IDLE_ENABLE" |
|
|
2687 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
2011 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2688 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2012 | code. |
2689 | code. |
2013 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2690 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2014 | .IX Item "EV_EMBED_ENABLE" |
2691 | .IX Item "EV_EMBED_ENABLE" |
2015 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2692 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2016 | defined to be \f(CW0\fR, then they are not. |
2693 | defined to be \f(CW0\fR, then they are not. |
2017 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
2694 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
2018 | .IX Item "EV_STAT_ENABLE" |
2695 | .IX Item "EV_STAT_ENABLE" |
2019 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
2696 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
2020 | defined to be \f(CW0\fR, then they are not. |
2697 | defined to be \f(CW0\fR, then they are not. |
|
|
2698 | .IP "\s-1EV_FORK_ENABLE\s0" 4 |
|
|
2699 | .IX Item "EV_FORK_ENABLE" |
|
|
2700 | If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If |
|
|
2701 | defined to be \f(CW0\fR, then they are not. |
2021 | .IP "\s-1EV_MINIMAL\s0" 4 |
2702 | .IP "\s-1EV_MINIMAL\s0" 4 |
2022 | .IX Item "EV_MINIMAL" |
2703 | .IX Item "EV_MINIMAL" |
2023 | If you need to shave off some kilobytes of code at the expense of some |
2704 | If you need to shave off some kilobytes of code at the expense of some |
2024 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
2705 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
2025 | some inlining decisions, saves roughly 30% codesize of amd64. |
2706 | some inlining decisions, saves roughly 30% codesize of amd64. |
|
|
2707 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
|
|
2708 | .IX Item "EV_PID_HASHSIZE" |
|
|
2709 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2710 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
|
|
2711 | than enough. If you need to manage thousands of children you might want to |
|
|
2712 | increase this value (\fImust\fR be a power of two). |
|
|
2713 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
|
|
2714 | .IX Item "EV_INOTIFY_HASHSIZE" |
|
|
2715 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2716 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
|
|
2717 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2718 | watchers you might want to increase this value (\fImust\fR be a power of |
|
|
2719 | two). |
2026 | .IP "\s-1EV_COMMON\s0" 4 |
2720 | .IP "\s-1EV_COMMON\s0" 4 |
2027 | .IX Item "EV_COMMON" |
2721 | .IX Item "EV_COMMON" |
2028 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2722 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2029 | this macro to a something else you can include more and other types of |
2723 | this macro to a something else you can include more and other types of |
2030 | members. You have to define it each time you include one of the files, |
2724 | members. You have to define it each time you include one of the files, |
… | |
… | |
2045 | .IP "ev_set_cb (ev, cb)" 4 |
2739 | .IP "ev_set_cb (ev, cb)" 4 |
2046 | .IX Item "ev_set_cb (ev, cb)" |
2740 | .IX Item "ev_set_cb (ev, cb)" |
2047 | .PD |
2741 | .PD |
2048 | Can be used to change the callback member declaration in each watcher, |
2742 | Can be used to change the callback member declaration in each watcher, |
2049 | and the way callbacks are invoked and set. Must expand to a struct member |
2743 | and the way callbacks are invoked and set. Must expand to a struct member |
2050 | definition and a statement, respectively. See the \fIev.v\fR header file for |
2744 | definition and a statement, respectively. See the \fIev.h\fR header file for |
2051 | their default definitions. One possible use for overriding these is to |
2745 | their default definitions. One possible use for overriding these is to |
2052 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2746 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2053 | method calls instead of plain function calls in \*(C+. |
2747 | method calls instead of plain function calls in \*(C+. |
|
|
2748 | .Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
|
|
2749 | .IX Subsection "EXPORTED API SYMBOLS" |
|
|
2750 | If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of |
|
|
2751 | exported symbols, you can use the provided \fISymbol.*\fR files which list |
|
|
2752 | all public symbols, one per line: |
|
|
2753 | .Sp |
|
|
2754 | .Vb 2 |
|
|
2755 | \& Symbols.ev for libev proper |
|
|
2756 | \& Symbols.event for the libevent emulation |
|
|
2757 | .Ve |
|
|
2758 | .Sp |
|
|
2759 | This can also be used to rename all public symbols to avoid clashes with |
|
|
2760 | multiple versions of libev linked together (which is obviously bad in |
|
|
2761 | itself, but sometimes it is inconvinient to avoid this). |
|
|
2762 | .Sp |
|
|
2763 | A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
|
|
2764 | include before including \fIev.h\fR: |
|
|
2765 | .Sp |
|
|
2766 | .Vb 1 |
|
|
2767 | \& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
2768 | .Ve |
|
|
2769 | .Sp |
|
|
2770 | This would create a file \fIwrap.h\fR which essentially looks like this: |
|
|
2771 | .Sp |
|
|
2772 | .Vb 4 |
|
|
2773 | \& #define ev_backend myprefix_ev_backend |
|
|
2774 | \& #define ev_check_start myprefix_ev_check_start |
|
|
2775 | \& #define ev_check_stop myprefix_ev_check_stop |
|
|
2776 | \& ... |
|
|
2777 | .Ve |
2054 | .Sh "\s-1EXAMPLES\s0" |
2778 | .Sh "\s-1EXAMPLES\s0" |
2055 | .IX Subsection "EXAMPLES" |
2779 | .IX Subsection "EXAMPLES" |
2056 | For a real-world example of a program the includes libev |
2780 | For a real-world example of a program the includes libev |
2057 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2781 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2058 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
2782 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
… | |
… | |
2060 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2784 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2061 | will be compiled. It is pretty complex because it provides its own header |
2785 | will be compiled. It is pretty complex because it provides its own header |
2062 | file. |
2786 | file. |
2063 | .Sp |
2787 | .Sp |
2064 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2788 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2065 | that everybody includes and which overrides some autoconf choices: |
2789 | that everybody includes and which overrides some configure choices: |
2066 | .Sp |
2790 | .Sp |
2067 | .Vb 4 |
2791 | .Vb 9 |
|
|
2792 | \& #define EV_MINIMAL 1 |
2068 | \& #define EV_USE_POLL 0 |
2793 | \& #define EV_USE_POLL 0 |
2069 | \& #define EV_MULTIPLICITY 0 |
2794 | \& #define EV_MULTIPLICITY 0 |
2070 | \& #define EV_PERIODICS 0 |
2795 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2796 | \& #define EV_STAT_ENABLE 0 |
|
|
2797 | \& #define EV_FORK_ENABLE 0 |
2071 | \& #define EV_CONFIG_H <config.h> |
2798 | \& #define EV_CONFIG_H <config.h> |
|
|
2799 | \& #define EV_MINPRI 0 |
|
|
2800 | \& #define EV_MAXPRI 0 |
2072 | .Ve |
2801 | .Ve |
2073 | .Sp |
2802 | .Sp |
2074 | .Vb 1 |
2803 | .Vb 1 |
2075 | \& #include "ev++.h" |
2804 | \& #include "ev++.h" |
2076 | .Ve |
2805 | .Ve |
… | |
… | |
2084 | .SH "COMPLEXITIES" |
2813 | .SH "COMPLEXITIES" |
2085 | .IX Header "COMPLEXITIES" |
2814 | .IX Header "COMPLEXITIES" |
2086 | In this section the complexities of (many of) the algorithms used inside |
2815 | In this section the complexities of (many of) the algorithms used inside |
2087 | libev will be explained. For complexity discussions about backends see the |
2816 | libev will be explained. For complexity discussions about backends see the |
2088 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2817 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
2818 | .Sp |
|
|
2819 | All of the following are about amortised time: If an array needs to be |
|
|
2820 | extended, libev needs to realloc and move the whole array, but this |
|
|
2821 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2822 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2823 | it is much faster and asymptotically approaches constant time. |
2089 | .RS 4 |
2824 | .RS 4 |
2090 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2825 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2091 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2826 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2092 | .PD 0 |
2827 | This means that, when you have a watcher that triggers in one hour and |
|
|
2828 | there are 100 watchers that would trigger before that then inserting will |
|
|
2829 | have to skip those 100 watchers. |
2093 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2830 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2094 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2831 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2832 | That means that for changing a timer costs less than removing/adding them |
|
|
2833 | as only the relative motion in the event queue has to be paid for. |
2095 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2834 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2096 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2835 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2097 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2836 | These just add the watcher into an array or at the head of a list. |
2098 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2837 | =item Stopping check/prepare/idle watchers: O(1) |
2099 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 |
2838 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2100 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" |
2839 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2840 | These watchers are stored in lists then need to be walked to find the |
|
|
2841 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2842 | have many watchers waiting for the same fd or signal). |
2101 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2843 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2102 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2844 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2845 | .PD 0 |
2103 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2846 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2104 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2847 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2848 | .PD |
|
|
2849 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2850 | libev to recalculate its status (and possibly tell the kernel). |
2105 | .IP "Activating one watcher: O(1)" 4 |
2851 | .IP "Activating one watcher: O(1)" 4 |
2106 | .IX Item "Activating one watcher: O(1)" |
2852 | .IX Item "Activating one watcher: O(1)" |
|
|
2853 | .PD 0 |
|
|
2854 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2855 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2856 | .PD |
|
|
2857 | Priorities are implemented by allocating some space for each |
|
|
2858 | priority. When doing priority-based operations, libev usually has to |
|
|
2859 | linearly search all the priorities. |
2107 | .RE |
2860 | .RE |
2108 | .RS 4 |
2861 | .RS 4 |
2109 | .PD |
|
|
2110 | .SH "AUTHOR" |
2862 | .SH "AUTHOR" |
2111 | .IX Header "AUTHOR" |
2863 | .IX Header "AUTHOR" |
2112 | Marc Lehmann <libev@schmorp.de>. |
2864 | Marc Lehmann <libev@schmorp.de>. |