… | |
… | |
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 ""<STANDARD INPUT>" 1" |
132 | .TH "<STANDARD INPUT>" 1 "2007-11-27" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-12" "perl v5.8.8" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
137 | .Vb 1 |
138 | \& #include <ev.h> |
138 | \& #include <ev.h> |
139 | .Ve |
139 | .Ve |
|
|
140 | .SH "EXAMPLE PROGRAM" |
|
|
141 | .IX Header "EXAMPLE PROGRAM" |
|
|
142 | .Vb 1 |
|
|
143 | \& #include <ev.h> |
|
|
144 | .Ve |
|
|
145 | .PP |
|
|
146 | .Vb 2 |
|
|
147 | \& ev_io stdin_watcher; |
|
|
148 | \& ev_timer timeout_watcher; |
|
|
149 | .Ve |
|
|
150 | .PP |
|
|
151 | .Vb 8 |
|
|
152 | \& /* called when data readable on stdin */ |
|
|
153 | \& static void |
|
|
154 | \& stdin_cb (EV_P_ struct ev_io *w, int revents) |
|
|
155 | \& { |
|
|
156 | \& /* puts ("stdin ready"); */ |
|
|
157 | \& ev_io_stop (EV_A_ w); /* just a syntax example */ |
|
|
158 | \& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ |
|
|
159 | \& } |
|
|
160 | .Ve |
|
|
161 | .PP |
|
|
162 | .Vb 6 |
|
|
163 | \& static void |
|
|
164 | \& timeout_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
165 | \& { |
|
|
166 | \& /* puts ("timeout"); */ |
|
|
167 | \& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ |
|
|
168 | \& } |
|
|
169 | .Ve |
|
|
170 | .PP |
|
|
171 | .Vb 4 |
|
|
172 | \& int |
|
|
173 | \& main (void) |
|
|
174 | \& { |
|
|
175 | \& struct ev_loop *loop = ev_default_loop (0); |
|
|
176 | .Ve |
|
|
177 | .PP |
|
|
178 | .Vb 3 |
|
|
179 | \& /* initialise an io watcher, then start it */ |
|
|
180 | \& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
|
|
181 | \& ev_io_start (loop, &stdin_watcher); |
|
|
182 | .Ve |
|
|
183 | .PP |
|
|
184 | .Vb 3 |
|
|
185 | \& /* simple non-repeating 5.5 second timeout */ |
|
|
186 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
187 | \& ev_timer_start (loop, &timeout_watcher); |
|
|
188 | .Ve |
|
|
189 | .PP |
|
|
190 | .Vb 2 |
|
|
191 | \& /* loop till timeout or data ready */ |
|
|
192 | \& ev_loop (loop, 0); |
|
|
193 | .Ve |
|
|
194 | .PP |
|
|
195 | .Vb 2 |
|
|
196 | \& return 0; |
|
|
197 | \& } |
|
|
198 | .Ve |
140 | .SH "DESCRIPTION" |
199 | .SH "DESCRIPTION" |
141 | .IX Header "DESCRIPTION" |
200 | .IX Header "DESCRIPTION" |
|
|
201 | The newest version of this document is also available as a html-formatted |
|
|
202 | web page you might find easier to navigate when reading it for the first |
|
|
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
|
|
204 | .PP |
142 | Libev is an event loop: you register interest in certain events (such as a |
205 | Libev is an event loop: you register interest in certain events (such as a |
143 | file descriptor being readable or a timeout occuring), and it will manage |
206 | file descriptor being readable or a timeout occuring), and it will manage |
144 | these event sources and provide your program with events. |
207 | these event sources and provide your program with events. |
145 | .PP |
208 | .PP |
146 | To do this, it must take more or less complete control over your process |
209 | To do this, it must take more or less complete control over your process |
… | |
… | |
151 | watchers\fR, which are relatively small C structures you initialise with the |
214 | watchers\fR, which are relatively small C structures you initialise with the |
152 | details of the event, and then hand it over to libev by \fIstarting\fR the |
215 | details of the event, and then hand it over to libev by \fIstarting\fR the |
153 | watcher. |
216 | watcher. |
154 | .SH "FEATURES" |
217 | .SH "FEATURES" |
155 | .IX Header "FEATURES" |
218 | .IX Header "FEATURES" |
156 | Libev supports select, poll, the linux-specific epoll and the bsd-specific |
219 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
157 | kqueue mechanisms for file descriptor events, relative timers, absolute |
220 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
158 | timers with customised rescheduling, signal events, process status change |
221 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
159 | events (related to \s-1SIGCHLD\s0), and event watchers dealing with the event |
222 | (for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers |
160 | loop mechanism itself (idle, prepare and check watchers). It also is quite |
223 | with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals |
161 | fast (see this benchmark comparing |
224 | (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event |
162 | it to libevent for example). |
225 | watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, |
|
|
226 | \&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as |
|
|
227 | file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events |
|
|
228 | (\f(CW\*(C`ev_fork\*(C'\fR). |
|
|
229 | .PP |
|
|
230 | It also is quite fast (see this |
|
|
231 | benchmark comparing it to libevent |
|
|
232 | for example). |
163 | .SH "CONVENTIONS" |
233 | .SH "CONVENTIONS" |
164 | .IX Header "CONVENTIONS" |
234 | .IX Header "CONVENTIONS" |
165 | Libev is very configurable. In this manual the default configuration |
235 | Libev is very configurable. In this manual the default configuration will |
166 | will be described, which supports multiple event loops. For more info |
236 | be described, which supports multiple event loops. For more info about |
167 | about various configuration options please have a look at the file |
237 | various configuration options please have a look at \fB\s-1EMBED\s0\fR section in |
168 | \&\fI\s-1README\s0.embed\fR in the libev distribution. If libev was configured without |
238 | this manual. If libev was configured without support for multiple event |
169 | support for multiple event loops, then all functions taking an initial |
239 | loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR |
170 | argument of name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) |
240 | (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. |
171 | will not have this argument. |
|
|
172 | .SH "TIME REPRESENTATION" |
241 | .SH "TIME REPRESENTATION" |
173 | .IX Header "TIME REPRESENTATION" |
242 | .IX Header "TIME REPRESENTATION" |
174 | Libev represents time as a single floating point number, representing the |
243 | Libev represents time as a single floating point number, representing the |
175 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
244 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
176 | the beginning of 1970, details are complicated, don't ask). This type is |
245 | the beginning of 1970, details are complicated, don't ask). This type is |
… | |
… | |
190 | .IX Item "int ev_version_major ()" |
259 | .IX Item "int ev_version_major ()" |
191 | .PD 0 |
260 | .PD 0 |
192 | .IP "int ev_version_minor ()" 4 |
261 | .IP "int ev_version_minor ()" 4 |
193 | .IX Item "int ev_version_minor ()" |
262 | .IX Item "int ev_version_minor ()" |
194 | .PD |
263 | .PD |
195 | You can find out the major and minor version numbers of the library |
264 | 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 |
265 | 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 |
266 | \&\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 |
267 | 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. |
268 | version of the library your program was compiled against. |
200 | .Sp |
269 | .Sp |
|
|
270 | These version numbers refer to the \s-1ABI\s0 version of the library, not the |
|
|
271 | release version. |
|
|
272 | .Sp |
201 | Usually, it's a good idea to terminate if the major versions mismatch, |
273 | Usually, it's a good idea to terminate if the major versions mismatch, |
202 | as this indicates an incompatible change. Minor versions are usually |
274 | as this indicates an incompatible change. Minor versions are usually |
203 | compatible to older versions, so a larger minor version alone is usually |
275 | compatible to older versions, so a larger minor version alone is usually |
204 | not a problem. |
276 | not a problem. |
205 | .Sp |
277 | .Sp |
206 | Example: make sure we haven't accidentally been linked against the wrong |
278 | Example: Make sure we haven't accidentally been linked against the wrong |
207 | version: |
279 | version. |
208 | .Sp |
280 | .Sp |
209 | .Vb 3 |
281 | .Vb 3 |
210 | \& assert (("libev version mismatch", |
282 | \& assert (("libev version mismatch", |
211 | \& ev_version_major () == EV_VERSION_MAJOR |
283 | \& ev_version_major () == EV_VERSION_MAJOR |
212 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
284 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
… | |
… | |
242 | recommended ones. |
314 | recommended ones. |
243 | .Sp |
315 | .Sp |
244 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
316 | 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 |
317 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
246 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
318 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
247 | Sets the allocation function to use (the prototype is similar to the |
319 | Sets the allocation function to use (the prototype is similar \- the |
248 | realloc C function, the semantics are identical). It is used to allocate |
320 | 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 |
321 | 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 |
322 | memory needs to be allocated, the library might abort or take some |
251 | destructive action. The default is your system realloc function. |
323 | potentially destructive action. The default is your system realloc |
|
|
324 | function. |
252 | .Sp |
325 | .Sp |
253 | You could override this function in high-availability programs to, say, |
326 | 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, |
327 | 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. |
328 | or even to sleep a while and retry until some memory is available. |
256 | .Sp |
329 | .Sp |
257 | Example: replace the libev allocator with one that waits a bit and then |
330 | Example: Replace the libev allocator with one that waits a bit and then |
258 | retries: better than mine). |
331 | retries). |
259 | .Sp |
332 | .Sp |
260 | .Vb 6 |
333 | .Vb 6 |
261 | \& static void * |
334 | \& static void * |
262 | \& persistent_realloc (void *ptr, long size) |
335 | \& persistent_realloc (void *ptr, size_t size) |
263 | \& { |
336 | \& { |
264 | \& for (;;) |
337 | \& for (;;) |
265 | \& { |
338 | \& { |
266 | \& void *newptr = realloc (ptr, size); |
339 | \& void *newptr = realloc (ptr, size); |
267 | .Ve |
340 | .Ve |
… | |
… | |
289 | callback is set, then libev will expect it to remedy the sitution, no |
362 | 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 |
363 | 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 |
364 | requested operation, or, if the condition doesn't go away, do bad stuff |
292 | (such as abort). |
365 | (such as abort). |
293 | .Sp |
366 | .Sp |
294 | Example: do the same thing as libev does internally: |
367 | Example: This is basically the same thing that libev does internally, too. |
295 | .Sp |
368 | .Sp |
296 | .Vb 6 |
369 | .Vb 6 |
297 | \& static void |
370 | \& static void |
298 | \& fatal_error (const char *msg) |
371 | \& fatal_error (const char *msg) |
299 | \& { |
372 | \& { |
… | |
… | |
345 | or setgid) then libev will \fInot\fR look at the environment variable |
418 | 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 |
419 | \&\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 |
420 | 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 |
421 | useful to try out specific backends to test their performance, or to work |
349 | around bugs. |
422 | around bugs. |
|
|
423 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
|
|
424 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
|
|
425 | .IX Item "EVFLAG_FORKCHECK" |
|
|
426 | Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after |
|
|
427 | a fork, you can also make libev check for a fork in each iteration by |
|
|
428 | enabling this flag. |
|
|
429 | .Sp |
|
|
430 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
|
|
431 | and thus this might slow down your event loop if you do a lot of loop |
|
|
432 | iterations and little real work, but is usually not noticeable (on my |
|
|
433 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
|
|
434 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
|
|
435 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
|
|
436 | .Sp |
|
|
437 | The big advantage of this flag is that you can forget about fork (and |
|
|
438 | forget about forgetting to tell libev about forking) when you use this |
|
|
439 | flag. |
|
|
440 | .Sp |
|
|
441 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
|
|
442 | environment variable. |
350 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
443 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
351 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
444 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
352 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
445 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
353 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
446 | 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, |
447 | libev tries to roll its own fd_set with no limits on the number of fds, |
… | |
… | |
448 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
541 | 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 |
542 | 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 |
543 | 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). |
544 | undefined behaviour (or a failed assertion if assertions are enabled). |
452 | .Sp |
545 | .Sp |
453 | Example: try to create a event loop that uses epoll and nothing else. |
546 | Example: Try to create a event loop that uses epoll and nothing else. |
454 | .Sp |
547 | .Sp |
455 | .Vb 3 |
548 | .Vb 3 |
456 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
549 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
457 | \& if (!epoller) |
550 | \& if (!epoller) |
458 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
551 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
… | |
… | |
495 | .IP "ev_loop_fork (loop)" 4 |
588 | .IP "ev_loop_fork (loop)" 4 |
496 | .IX Item "ev_loop_fork (loop)" |
589 | .IX Item "ev_loop_fork (loop)" |
497 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
590 | 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 |
591 | \&\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. |
592 | after fork, and how you do this is entirely your own problem. |
|
|
593 | .IP "unsigned int ev_loop_count (loop)" 4 |
|
|
594 | .IX Item "unsigned int ev_loop_count (loop)" |
|
|
595 | Returns the count of loop iterations for the loop, which is identical to |
|
|
596 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
|
|
597 | happily wraps around with enough iterations. |
|
|
598 | .Sp |
|
|
599 | This value can sometimes be useful as a generation counter of sorts (it |
|
|
600 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
|
|
601 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
500 | .IP "unsigned int ev_backend (loop)" 4 |
602 | .IP "unsigned int ev_backend (loop)" 4 |
501 | .IX Item "unsigned int ev_backend (loop)" |
603 | .IX Item "unsigned int ev_backend (loop)" |
502 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
604 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
503 | use. |
605 | use. |
504 | .IP "ev_tstamp ev_now (loop)" 4 |
606 | .IP "ev_tstamp ev_now (loop)" 4 |
… | |
… | |
535 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
637 | 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. |
638 | usually a better approach for this kind of thing. |
537 | .Sp |
639 | .Sp |
538 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
640 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
539 | .Sp |
641 | .Sp |
540 | .Vb 18 |
642 | .Vb 19 |
|
|
643 | \& - Before the first iteration, call any pending watchers. |
541 | \& * If there are no active watchers (reference count is zero), return. |
644 | \& * If there are no active watchers (reference count is zero), return. |
542 | \& - Queue prepare watchers and then call all outstanding watchers. |
645 | \& - Queue all prepare watchers and then call all outstanding watchers. |
543 | \& - If we have been forked, recreate the kernel state. |
646 | \& - If we have been forked, recreate the kernel state. |
544 | \& - Update the kernel state with all outstanding changes. |
647 | \& - Update the kernel state with all outstanding changes. |
545 | \& - Update the "event loop time". |
648 | \& - Update the "event loop time". |
546 | \& - Calculate for how long to block. |
649 | \& - Calculate for how long to block. |
547 | \& - Block the process, waiting for any events. |
650 | \& - Block the process, waiting for any events. |
… | |
… | |
556 | \& be handled here by queueing them when their watcher gets executed. |
659 | \& be handled here by queueing them when their watcher gets executed. |
557 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
660 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
558 | \& were used, return, otherwise continue with step *. |
661 | \& were used, return, otherwise continue with step *. |
559 | .Ve |
662 | .Ve |
560 | .Sp |
663 | .Sp |
561 | Example: queue some jobs and then loop until no events are outsanding |
664 | Example: Queue some jobs and then loop until no events are outsanding |
562 | anymore. |
665 | anymore. |
563 | .Sp |
666 | .Sp |
564 | .Vb 4 |
667 | .Vb 4 |
565 | \& ... queue jobs here, make sure they register event watchers as long |
668 | \& ... 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..) |
669 | \& ... 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 |
691 | 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 |
692 | 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 |
693 | 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. |
694 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
592 | .Sp |
695 | .Sp |
593 | Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
696 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
594 | running when nothing else is active. |
697 | running when nothing else is active. |
595 | .Sp |
698 | .Sp |
596 | .Vb 4 |
699 | .Vb 4 |
597 | \& struct dv_signal exitsig; |
700 | \& struct ev_signal exitsig; |
598 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
701 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
599 | \& ev_signal_start (myloop, &exitsig); |
702 | \& ev_signal_start (loop, &exitsig); |
600 | \& evf_unref (myloop); |
703 | \& evf_unref (loop); |
601 | .Ve |
704 | .Ve |
602 | .Sp |
705 | .Sp |
603 | Example: for some weird reason, unregister the above signal handler again. |
706 | Example: For some weird reason, unregister the above signal handler again. |
604 | .Sp |
707 | .Sp |
605 | .Vb 2 |
708 | .Vb 2 |
606 | \& ev_ref (myloop); |
709 | \& ev_ref (loop); |
607 | \& ev_signal_stop (myloop, &exitsig); |
710 | \& ev_signal_stop (loop, &exitsig); |
608 | .Ve |
711 | .Ve |
609 | .SH "ANATOMY OF A WATCHER" |
712 | .SH "ANATOMY OF A WATCHER" |
610 | .IX Header "ANATOMY OF A WATCHER" |
713 | .IX Header "ANATOMY OF A WATCHER" |
611 | A watcher is a structure that you create and register to record your |
714 | 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 |
715 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
… | |
… | |
790 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
893 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
791 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
894 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
792 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
895 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
793 | events but its callback has not yet been invoked). As long as a watcher |
896 | events but its callback has not yet been invoked). As long as a watcher |
794 | is pending (but not active) you must not call an init function on it (but |
897 | is pending (but not active) you must not call an init function on it (but |
795 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
898 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
796 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
899 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
900 | it). |
797 | .IP "callback = ev_cb (ev_TYPE *watcher)" 4 |
901 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
798 | .IX Item "callback = ev_cb (ev_TYPE *watcher)" |
902 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
799 | Returns the callback currently set on the watcher. |
903 | Returns the callback currently set on the watcher. |
800 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
904 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
801 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
905 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
802 | Change the callback. You can change the callback at virtually any time |
906 | Change the callback. You can change the callback at virtually any time |
803 | (modulo threads). |
907 | (modulo threads). |
|
|
908 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
|
|
909 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
|
|
910 | .PD 0 |
|
|
911 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
|
|
912 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
|
|
913 | .PD |
|
|
914 | Set and query the priority of the watcher. The priority is a small |
|
|
915 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
|
|
916 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
|
|
917 | before watchers with lower priority, but priority will not keep watchers |
|
|
918 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
|
|
919 | .Sp |
|
|
920 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
921 | invocation after new events have been received. This is useful, for |
|
|
922 | example, to reduce latency after idling, or more often, to bind two |
|
|
923 | watchers on the same event and make sure one is called first. |
|
|
924 | .Sp |
|
|
925 | If you need to suppress invocation when higher priority events are pending |
|
|
926 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
|
|
927 | .Sp |
|
|
928 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
929 | pending. |
|
|
930 | .Sp |
|
|
931 | The default priority used by watchers when no priority has been set is |
|
|
932 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
|
|
933 | .Sp |
|
|
934 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
935 | fine, as long as you do not mind that the priority value you query might |
|
|
936 | or might not have been adjusted to be within valid range. |
|
|
937 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
938 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
939 | 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 |
|
|
940 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
941 | can deal with that fact. |
|
|
942 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
943 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
944 | If the watcher is pending, this function returns clears its pending status |
|
|
945 | and returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
946 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
804 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
947 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
805 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
948 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
806 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
949 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
807 | and read at any time, libev will completely ignore it. This can be used |
950 | and read at any time, libev will completely ignore it. This can be used |
808 | to associate arbitrary data with your watcher. If you need more data and |
951 | to associate arbitrary data with your watcher. If you need more data and |
… | |
… | |
829 | \& struct my_io *w = (struct my_io *)w_; |
972 | \& struct my_io *w = (struct my_io *)w_; |
830 | \& ... |
973 | \& ... |
831 | \& } |
974 | \& } |
832 | .Ve |
975 | .Ve |
833 | .PP |
976 | .PP |
834 | More interesting and less C\-conformant ways of catsing your callback type |
977 | More interesting and less C\-conformant ways of casting your callback type |
835 | have been omitted.... |
978 | instead have been omitted. |
|
|
979 | .PP |
|
|
980 | Another common scenario is having some data structure with multiple |
|
|
981 | watchers: |
|
|
982 | .PP |
|
|
983 | .Vb 6 |
|
|
984 | \& struct my_biggy |
|
|
985 | \& { |
|
|
986 | \& int some_data; |
|
|
987 | \& ev_timer t1; |
|
|
988 | \& ev_timer t2; |
|
|
989 | \& } |
|
|
990 | .Ve |
|
|
991 | .PP |
|
|
992 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
|
|
993 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
|
|
994 | .PP |
|
|
995 | .Vb 1 |
|
|
996 | \& #include <stddef.h> |
|
|
997 | .Ve |
|
|
998 | .PP |
|
|
999 | .Vb 6 |
|
|
1000 | \& static void |
|
|
1001 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1002 | \& { |
|
|
1003 | \& struct my_biggy big = (struct my_biggy * |
|
|
1004 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
|
|
1005 | \& } |
|
|
1006 | .Ve |
|
|
1007 | .PP |
|
|
1008 | .Vb 6 |
|
|
1009 | \& static void |
|
|
1010 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
|
|
1011 | \& { |
|
|
1012 | \& struct my_biggy big = (struct my_biggy * |
|
|
1013 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
|
|
1014 | \& } |
|
|
1015 | .Ve |
836 | .SH "WATCHER TYPES" |
1016 | .SH "WATCHER TYPES" |
837 | .IX Header "WATCHER TYPES" |
1017 | .IX Header "WATCHER TYPES" |
838 | This section describes each watcher in detail, but will not repeat |
1018 | This section describes each watcher in detail, but will not repeat |
839 | information given in the last section. Any initialisation/set macros, |
1019 | information given in the last section. Any initialisation/set macros, |
840 | functions and members specific to the watcher type are explained. |
1020 | functions and members specific to the watcher type are explained. |
… | |
… | |
882 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1062 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
883 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1063 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
884 | .PP |
1064 | .PP |
885 | If you cannot run the fd in non-blocking mode (for example you should not |
1065 | If you cannot run the fd in non-blocking mode (for example you should not |
886 | play around with an Xlib connection), then you have to seperately re-test |
1066 | play around with an Xlib connection), then you have to seperately re-test |
887 | wether a file descriptor is really ready with a known-to-be good interface |
1067 | whether a file descriptor is really ready with a known-to-be good interface |
888 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1068 | such as poll (fortunately in our Xlib example, Xlib already does this on |
889 | its own, so its quite safe to use). |
1069 | its own, so its quite safe to use). |
|
|
1070 | .PP |
|
|
1071 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1072 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1073 | .PP |
|
|
1074 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
|
|
1075 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
|
|
1076 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
|
|
1077 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1078 | this interest. If another file descriptor with the same number then is |
|
|
1079 | registered with libev, there is no efficient way to see that this is, in |
|
|
1080 | fact, a different file descriptor. |
|
|
1081 | .PP |
|
|
1082 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1083 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1084 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1085 | it is assumed that the file descriptor stays the same. That means that |
|
|
1086 | 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 |
|
|
1087 | descriptor even if the file descriptor number itself did not change. |
|
|
1088 | .PP |
|
|
1089 | This is how one would do it normally anyway, the important point is that |
|
|
1090 | the libev application should not optimise around libev but should leave |
|
|
1091 | optimisations to libev. |
890 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1092 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
891 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1093 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
892 | .PD 0 |
1094 | .PD 0 |
893 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1095 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
894 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1096 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
… | |
… | |
901 | The file descriptor being watched. |
1103 | The file descriptor being watched. |
902 | .IP "int events [read\-only]" 4 |
1104 | .IP "int events [read\-only]" 4 |
903 | .IX Item "int events [read-only]" |
1105 | .IX Item "int events [read-only]" |
904 | The events being watched. |
1106 | The events being watched. |
905 | .PP |
1107 | .PP |
906 | Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1108 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
907 | readable, but only once. Since it is likely line\-buffered, you could |
1109 | readable, but only once. Since it is likely line\-buffered, you could |
908 | attempt to read a whole line in the callback: |
1110 | attempt to read a whole line in the callback. |
909 | .PP |
1111 | .PP |
910 | .Vb 6 |
1112 | .Vb 6 |
911 | \& static void |
1113 | \& static void |
912 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1114 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
913 | \& { |
1115 | \& { |
… | |
… | |
968 | .IP "ev_timer_again (loop)" 4 |
1170 | .IP "ev_timer_again (loop)" 4 |
969 | .IX Item "ev_timer_again (loop)" |
1171 | .IX Item "ev_timer_again (loop)" |
970 | This will act as if the timer timed out and restart it again if it is |
1172 | This will act as if the timer timed out and restart it again if it is |
971 | repeating. The exact semantics are: |
1173 | repeating. The exact semantics are: |
972 | .Sp |
1174 | .Sp |
|
|
1175 | If the timer is pending, its pending status is cleared. |
|
|
1176 | .Sp |
973 | If the timer is started but nonrepeating, stop it. |
1177 | If the timer is started but nonrepeating, stop it (as if it timed out). |
974 | .Sp |
1178 | .Sp |
975 | If the timer is repeating, either start it if necessary (with the repeat |
1179 | If the timer is repeating, either start it if necessary (with the |
976 | value), or reset the running timer to the repeat value. |
1180 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
977 | .Sp |
1181 | .Sp |
978 | This sounds a bit complicated, but here is a useful and typical |
1182 | This sounds a bit complicated, but here is a useful and typical |
979 | example: Imagine you have a tcp connection and you want a so-called |
1183 | example: Imagine you have a tcp connection and you want a so-called idle |
980 | idle timeout, that is, you want to be called when there have been, |
1184 | timeout, that is, you want to be called when there have been, say, 60 |
981 | say, 60 seconds of inactivity on the socket. The easiest way to do |
1185 | seconds of inactivity on the socket. The easiest way to do this is to |
982 | 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 |
1186 | 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 |
983 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
1187 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
984 | you go into an idle state where you do not expect data to travel on the |
1188 | you go into an idle state where you do not expect data to travel on the |
985 | socket, you can stop the timer, and again will automatically restart it if |
1189 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
986 | need be. |
1190 | automatically restart it if need be. |
987 | .Sp |
1191 | .Sp |
988 | You can also ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR altogether |
1192 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
989 | and only ever use the \f(CW\*(C`repeat\*(C'\fR value: |
1193 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
990 | .Sp |
1194 | .Sp |
991 | .Vb 8 |
1195 | .Vb 8 |
992 | \& ev_timer_init (timer, callback, 0., 5.); |
1196 | \& ev_timer_init (timer, callback, 0., 5.); |
993 | \& ev_timer_again (loop, timer); |
1197 | \& ev_timer_again (loop, timer); |
994 | \& ... |
1198 | \& ... |
… | |
… | |
997 | \& ... |
1201 | \& ... |
998 | \& timer->again = 10.; |
1202 | \& timer->again = 10.; |
999 | \& ev_timer_again (loop, timer); |
1203 | \& ev_timer_again (loop, timer); |
1000 | .Ve |
1204 | .Ve |
1001 | .Sp |
1205 | .Sp |
1002 | This is more efficient then stopping/starting the timer eahc time you want |
1206 | This is more slightly efficient then stopping/starting the timer each time |
1003 | to modify its timeout value. |
1207 | you want to modify its timeout value. |
1004 | .IP "ev_tstamp repeat [read\-write]" 4 |
1208 | .IP "ev_tstamp repeat [read\-write]" 4 |
1005 | .IX Item "ev_tstamp repeat [read-write]" |
1209 | .IX Item "ev_tstamp repeat [read-write]" |
1006 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1210 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1007 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1211 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1008 | which is also when any modifications are taken into account. |
1212 | which is also when any modifications are taken into account. |
1009 | .PP |
1213 | .PP |
1010 | Example: create a timer that fires after 60 seconds. |
1214 | Example: Create a timer that fires after 60 seconds. |
1011 | .PP |
1215 | .PP |
1012 | .Vb 5 |
1216 | .Vb 5 |
1013 | \& static void |
1217 | \& static void |
1014 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1218 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1015 | \& { |
1219 | \& { |
… | |
… | |
1021 | \& struct ev_timer mytimer; |
1225 | \& struct ev_timer mytimer; |
1022 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1226 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1023 | \& ev_timer_start (loop, &mytimer); |
1227 | \& ev_timer_start (loop, &mytimer); |
1024 | .Ve |
1228 | .Ve |
1025 | .PP |
1229 | .PP |
1026 | Example: create a timeout timer that times out after 10 seconds of |
1230 | Example: Create a timeout timer that times out after 10 seconds of |
1027 | inactivity. |
1231 | inactivity. |
1028 | .PP |
1232 | .PP |
1029 | .Vb 5 |
1233 | .Vb 5 |
1030 | \& static void |
1234 | \& static void |
1031 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1235 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
… | |
… | |
1056 | but on wallclock time (absolute time). You can tell a periodic watcher |
1260 | but on wallclock time (absolute time). You can tell a periodic watcher |
1057 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1261 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1058 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1262 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1059 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1263 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1060 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1264 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1061 | roughly 10 seconds later and of course not if you reset your system time |
1265 | roughly 10 seconds later). |
1062 | again). |
|
|
1063 | .PP |
1266 | .PP |
1064 | They can also be used to implement vastly more complex timers, such as |
1267 | They can also be used to implement vastly more complex timers, such as |
1065 | triggering an event on eahc midnight, local time. |
1268 | triggering an event on each midnight, local time or other, complicated, |
|
|
1269 | rules. |
1066 | .PP |
1270 | .PP |
1067 | As with timers, the callback is guarenteed to be invoked only when the |
1271 | As with timers, the callback is guarenteed to be invoked only when the |
1068 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1272 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1069 | during the same loop iteration then order of execution is undefined. |
1273 | during the same loop iteration then order of execution is undefined. |
1070 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1274 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
… | |
… | |
1074 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1278 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1075 | .PD |
1279 | .PD |
1076 | Lots of arguments, lets sort it out... There are basically three modes of |
1280 | Lots of arguments, lets sort it out... There are basically three modes of |
1077 | operation, and we will explain them from simplest to complex: |
1281 | operation, and we will explain them from simplest to complex: |
1078 | .RS 4 |
1282 | .RS 4 |
1079 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
1283 | .IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 |
1080 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
1284 | .IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" |
1081 | In this configuration the watcher triggers an event at the wallclock time |
1285 | In this configuration the watcher triggers an event at the wallclock time |
1082 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1286 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1083 | that is, if it is to be run at January 1st 2011 then it will run when the |
1287 | that is, if it is to be run at January 1st 2011 then it will run when the |
1084 | system time reaches or surpasses this time. |
1288 | system time reaches or surpasses this time. |
1085 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
1289 | .IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 |
1086 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
1290 | .IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" |
1087 | In this mode the watcher will always be scheduled to time out at the next |
1291 | In this mode the watcher will always be scheduled to time out at the next |
1088 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
1292 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1089 | of any time jumps. |
1293 | and then repeat, regardless of any time jumps. |
1090 | .Sp |
1294 | .Sp |
1091 | This can be used to create timers that do not drift with respect to system |
1295 | This can be used to create timers that do not drift with respect to system |
1092 | time: |
1296 | time: |
1093 | .Sp |
1297 | .Sp |
1094 | .Vb 1 |
1298 | .Vb 1 |
… | |
… | |
1101 | by 3600. |
1305 | by 3600. |
1102 | .Sp |
1306 | .Sp |
1103 | Another way to think about it (for the mathematically inclined) is that |
1307 | Another way to think about it (for the mathematically inclined) is that |
1104 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1308 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1105 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1309 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
|
|
1310 | .Sp |
|
|
1311 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
|
|
1312 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
1313 | this value. |
1106 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
1314 | .IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 |
1107 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
1315 | .IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" |
1108 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1316 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1109 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1317 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1110 | reschedule callback will be called with the watcher as first, and the |
1318 | reschedule callback will be called with the watcher as first, and the |
1111 | current time as second argument. |
1319 | current time as second argument. |
1112 | .Sp |
1320 | .Sp |
1113 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1321 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1114 | ever, or make any event loop modifications\fR. If you need to stop it, |
1322 | ever, or make any event loop modifications\fR. If you need to stop it, |
1115 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1323 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
1116 | starting a prepare watcher). |
1324 | starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is legal). |
1117 | .Sp |
1325 | .Sp |
1118 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1326 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1119 | ev_tstamp now)\*(C'\fR, e.g.: |
1327 | ev_tstamp now)\*(C'\fR, e.g.: |
1120 | .Sp |
1328 | .Sp |
1121 | .Vb 4 |
1329 | .Vb 4 |
… | |
… | |
1145 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1353 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1146 | Simply stops and restarts the periodic watcher again. This is only useful |
1354 | Simply stops and restarts the periodic watcher again. This is only useful |
1147 | when you changed some parameters or the reschedule callback would return |
1355 | when you changed some parameters or the reschedule callback would return |
1148 | a different time than the last time it was called (e.g. in a crond like |
1356 | a different time than the last time it was called (e.g. in a crond like |
1149 | program when the crontabs have changed). |
1357 | program when the crontabs have changed). |
|
|
1358 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
1359 | .IX Item "ev_tstamp offset [read-write]" |
|
|
1360 | When repeating, this contains the offset value, otherwise this is the |
|
|
1361 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
|
|
1362 | .Sp |
|
|
1363 | Can be modified any time, but changes only take effect when the periodic |
|
|
1364 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1150 | .IP "ev_tstamp interval [read\-write]" 4 |
1365 | .IP "ev_tstamp interval [read\-write]" 4 |
1151 | .IX Item "ev_tstamp interval [read-write]" |
1366 | .IX Item "ev_tstamp interval [read-write]" |
1152 | The current interval value. Can be modified any time, but changes only |
1367 | The current interval value. Can be modified any time, but changes only |
1153 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1368 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1154 | called. |
1369 | called. |
… | |
… | |
1156 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1371 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1157 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1372 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1158 | switched off. Can be changed any time, but changes only take effect when |
1373 | switched off. Can be changed any time, but changes only take effect when |
1159 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1374 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1160 | .PP |
1375 | .PP |
1161 | Example: call a callback every hour, or, more precisely, whenever the |
1376 | Example: Call a callback every hour, or, more precisely, whenever the |
1162 | system clock is divisible by 3600. The callback invocation times have |
1377 | system clock is divisible by 3600. The callback invocation times have |
1163 | potentially a lot of jittering, but good long-term stability. |
1378 | potentially a lot of jittering, but good long-term stability. |
1164 | .PP |
1379 | .PP |
1165 | .Vb 5 |
1380 | .Vb 5 |
1166 | \& static void |
1381 | \& static void |
… | |
… | |
1174 | \& struct ev_periodic hourly_tick; |
1389 | \& struct ev_periodic hourly_tick; |
1175 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1390 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1176 | \& ev_periodic_start (loop, &hourly_tick); |
1391 | \& ev_periodic_start (loop, &hourly_tick); |
1177 | .Ve |
1392 | .Ve |
1178 | .PP |
1393 | .PP |
1179 | Example: the same as above, but use a reschedule callback to do it: |
1394 | Example: The same as above, but use a reschedule callback to do it: |
1180 | .PP |
1395 | .PP |
1181 | .Vb 1 |
1396 | .Vb 1 |
1182 | \& #include <math.h> |
1397 | \& #include <math.h> |
1183 | .Ve |
1398 | .Ve |
1184 | .PP |
1399 | .PP |
… | |
… | |
1192 | .PP |
1407 | .PP |
1193 | .Vb 1 |
1408 | .Vb 1 |
1194 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1409 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1195 | .Ve |
1410 | .Ve |
1196 | .PP |
1411 | .PP |
1197 | Example: call a callback every hour, starting now: |
1412 | Example: Call a callback every hour, starting now: |
1198 | .PP |
1413 | .PP |
1199 | .Vb 4 |
1414 | .Vb 4 |
1200 | \& struct ev_periodic hourly_tick; |
1415 | \& struct ev_periodic hourly_tick; |
1201 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1416 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1202 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1417 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
… | |
… | |
1253 | .IP "int rstatus [read\-write]" 4 |
1468 | .IP "int rstatus [read\-write]" 4 |
1254 | .IX Item "int rstatus [read-write]" |
1469 | .IX Item "int rstatus [read-write]" |
1255 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
1470 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
1256 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1471 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1257 | .PP |
1472 | .PP |
1258 | Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1473 | Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
1259 | .PP |
1474 | .PP |
1260 | .Vb 5 |
1475 | .Vb 5 |
1261 | \& static void |
1476 | \& static void |
1262 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1477 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1263 | \& { |
1478 | \& { |
… | |
… | |
1281 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1496 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
1282 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1497 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
1283 | otherwise always forced to be at least one) and all the other fields of |
1498 | otherwise always forced to be at least one) and all the other fields of |
1284 | the stat buffer having unspecified contents. |
1499 | the stat buffer having unspecified contents. |
1285 | .PP |
1500 | .PP |
|
|
1501 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
|
|
1502 | relative and your working directory changes, the behaviour is undefined. |
|
|
1503 | .PP |
1286 | Since there is no standard to do this, the portable implementation simply |
1504 | Since there is no standard to do this, the portable implementation simply |
1287 | calls \f(CW\*(C`stat (2)\*(C'\fR regulalry on the path to see if it changed somehow. You |
1505 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
1288 | can specify a recommended polling interval for this case. If you specify |
1506 | can specify a recommended polling interval for this case. If you specify |
1289 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1507 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
1290 | unspecified default\fR value will be used (which you can expect to be around |
1508 | unspecified default\fR value will be used (which you can expect to be around |
1291 | five seconds, although this might change dynamically). Libev will also |
1509 | five seconds, although this might change dynamically). Libev will also |
1292 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
1510 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
… | |
… | |
1294 | .PP |
1512 | .PP |
1295 | This watcher type is not meant for massive numbers of stat watchers, |
1513 | This watcher type is not meant for massive numbers of stat watchers, |
1296 | as even with OS-supported change notifications, this can be |
1514 | as even with OS-supported change notifications, this can be |
1297 | resource\-intensive. |
1515 | resource\-intensive. |
1298 | .PP |
1516 | .PP |
1299 | At the time of this writing, no specific \s-1OS\s0 backends are implemented, but |
1517 | At the time of this writing, only the Linux inotify interface is |
1300 | if demand increases, at least a kqueue and inotify backend will be added. |
1518 | implemented (implementing kqueue support is left as an exercise for the |
|
|
1519 | reader). Inotify will be used to give hints only and should not change the |
|
|
1520 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
|
|
1521 | to fall back to regular polling again even with inotify, but changes are |
|
|
1522 | usually detected immediately, and if the file exists there will be no |
|
|
1523 | polling. |
1301 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1524 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1302 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1525 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1303 | .PD 0 |
1526 | .PD 0 |
1304 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1527 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1305 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
1528 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1366 | \& ev_stat_start (loop, &passwd); |
1589 | \& ev_stat_start (loop, &passwd); |
1367 | .Ve |
1590 | .Ve |
1368 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1591 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1369 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1592 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1370 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1593 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1371 | Idle watchers trigger events when there are no other events are pending |
1594 | Idle watchers trigger events when no other events of the same or higher |
1372 | (prepare, check and other idle watchers do not count). That is, as long |
1595 | priority are pending (prepare, check and other idle watchers do not |
1373 | as your process is busy handling sockets or timeouts (or even signals, |
1596 | count). |
1374 | imagine) it will not be triggered. But when your process is idle all idle |
1597 | .PP |
1375 | watchers are being called again and again, once per event loop iteration \- |
1598 | That is, as long as your process is busy handling sockets or timeouts |
|
|
1599 | (or even signals, imagine) of the same or higher priority it will not be |
|
|
1600 | triggered. But when your process is idle (or only lower-priority watchers |
|
|
1601 | are pending), the idle watchers are being called once per event loop |
1376 | until stopped, that is, or your process receives more events and becomes |
1602 | iteration \- until stopped, that is, or your process receives more events |
1377 | busy. |
1603 | and becomes busy again with higher priority stuff. |
1378 | .PP |
1604 | .PP |
1379 | The most noteworthy effect is that as long as any idle watchers are |
1605 | The most noteworthy effect is that as long as any idle watchers are |
1380 | active, the process will not block when waiting for new events. |
1606 | active, the process will not block when waiting for new events. |
1381 | .PP |
1607 | .PP |
1382 | Apart from keeping your process non-blocking (which is a useful |
1608 | Apart from keeping your process non-blocking (which is a useful |
… | |
… | |
1387 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1613 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1388 | Initialises and configures the idle watcher \- it has no parameters of any |
1614 | Initialises and configures the idle watcher \- it has no parameters of any |
1389 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1615 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1390 | believe me. |
1616 | believe me. |
1391 | .PP |
1617 | .PP |
1392 | Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the |
1618 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
1393 | callback, free it. Alos, use no error checking, as usual. |
1619 | callback, free it. Also, use no error checking, as usual. |
1394 | .PP |
1620 | .PP |
1395 | .Vb 7 |
1621 | .Vb 7 |
1396 | \& static void |
1622 | \& static void |
1397 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1623 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1398 | \& { |
1624 | \& { |
… | |
… | |
1445 | are ready to run (it's actually more complicated: it only runs coroutines |
1671 | are ready to run (it's actually more complicated: it only runs coroutines |
1446 | with priority higher than or equal to the event loop and one coroutine |
1672 | with priority higher than or equal to the event loop and one coroutine |
1447 | of lower priority, but only once, using idle watchers to keep the event |
1673 | of lower priority, but only once, using idle watchers to keep the event |
1448 | loop from blocking if lower-priority coroutines are active, thus mapping |
1674 | loop from blocking if lower-priority coroutines are active, thus mapping |
1449 | low-priority coroutines to idle/background tasks). |
1675 | low-priority coroutines to idle/background tasks). |
|
|
1676 | .PP |
|
|
1677 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
1678 | priority, to ensure that they are being run before any other watchers |
|
|
1679 | after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, |
|
|
1680 | too) should not activate (\*(L"feed\*(R") events into libev. While libev fully |
|
|
1681 | supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers did |
|
|
1682 | their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other event |
|
|
1683 | loops those other event loops might be in an unusable state until their |
|
|
1684 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
|
|
1685 | others). |
1450 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1686 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1451 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1687 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1452 | .PD 0 |
1688 | .PD 0 |
1453 | .IP "ev_check_init (ev_check *, callback)" 4 |
1689 | .IP "ev_check_init (ev_check *, callback)" 4 |
1454 | .IX Item "ev_check_init (ev_check *, callback)" |
1690 | .IX Item "ev_check_init (ev_check *, callback)" |
1455 | .PD |
1691 | .PD |
1456 | Initialises and configures the prepare or check watcher \- they have no |
1692 | Initialises and configures the prepare or check watcher \- they have no |
1457 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1693 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1458 | macros, but using them is utterly, utterly and completely pointless. |
1694 | macros, but using them is utterly, utterly and completely pointless. |
1459 | .PP |
1695 | .PP |
1460 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
1696 | There are a number of principal ways to embed other event loops or modules |
1461 | and a timeout watcher in a prepare handler, as required by libadns, and |
1697 | into libev. Here are some ideas on how to include libadns into libev |
|
|
1698 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
1699 | use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR |
|
|
1700 | embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 |
|
|
1701 | into the Glib event loop). |
|
|
1702 | .PP |
|
|
1703 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
1462 | in a check watcher, destroy them and call into libadns. What follows is |
1704 | and in a check watcher, destroy them and call into libadns. What follows |
1463 | pseudo-code only of course: |
1705 | is pseudo-code only of course. This requires you to either use a low |
|
|
1706 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
1707 | the callbacks for the IO/timeout watchers might not have been called yet. |
1464 | .PP |
1708 | .PP |
1465 | .Vb 2 |
1709 | .Vb 2 |
1466 | \& static ev_io iow [nfd]; |
1710 | \& static ev_io iow [nfd]; |
1467 | \& static ev_timer tw; |
1711 | \& static ev_timer tw; |
1468 | .Ve |
1712 | .Ve |
1469 | .PP |
1713 | .PP |
1470 | .Vb 9 |
1714 | .Vb 4 |
1471 | \& static void |
1715 | \& static void |
1472 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1716 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
1473 | \& { |
1717 | \& { |
1474 | \& // set the relevant poll flags |
|
|
1475 | \& // could also call adns_processreadable etc. here |
|
|
1476 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1477 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1478 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1479 | \& } |
1718 | \& } |
1480 | .Ve |
1719 | .Ve |
1481 | .PP |
1720 | .PP |
1482 | .Vb 7 |
1721 | .Vb 8 |
1483 | \& // create io watchers for each fd and a timer before blocking |
1722 | \& // create io watchers for each fd and a timer before blocking |
1484 | \& static void |
1723 | \& static void |
1485 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1724 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
1486 | \& { |
1725 | \& { |
1487 | \& int timeout = 3600000;truct pollfd fds [nfd]; |
1726 | \& int timeout = 3600000; |
|
|
1727 | \& struct pollfd fds [nfd]; |
1488 | \& // actual code will need to loop here and realloc etc. |
1728 | \& // actual code will need to loop here and realloc etc. |
1489 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1729 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1490 | .Ve |
1730 | .Ve |
1491 | .PP |
1731 | .PP |
1492 | .Vb 3 |
1732 | .Vb 3 |
… | |
… | |
1494 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1734 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
1495 | \& ev_timer_start (loop, &tw); |
1735 | \& ev_timer_start (loop, &tw); |
1496 | .Ve |
1736 | .Ve |
1497 | .PP |
1737 | .PP |
1498 | .Vb 6 |
1738 | .Vb 6 |
1499 | \& // create on ev_io per pollfd |
1739 | \& // create one ev_io per pollfd |
1500 | \& for (int i = 0; i < nfd; ++i) |
1740 | \& for (int i = 0; i < nfd; ++i) |
1501 | \& { |
1741 | \& { |
1502 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1742 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1503 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1743 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1504 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1744 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
1505 | .Ve |
1745 | .Ve |
1506 | .PP |
1746 | .PP |
1507 | .Vb 5 |
1747 | .Vb 4 |
1508 | \& fds [i].revents = 0; |
1748 | \& fds [i].revents = 0; |
1509 | \& iow [i].data = fds + i; |
|
|
1510 | \& ev_io_start (loop, iow + i); |
1749 | \& ev_io_start (loop, iow + i); |
1511 | \& } |
1750 | \& } |
1512 | \& } |
1751 | \& } |
1513 | .Ve |
1752 | .Ve |
1514 | .PP |
1753 | .PP |
… | |
… | |
1518 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1757 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
1519 | \& { |
1758 | \& { |
1520 | \& ev_timer_stop (loop, &tw); |
1759 | \& ev_timer_stop (loop, &tw); |
1521 | .Ve |
1760 | .Ve |
1522 | .PP |
1761 | .PP |
1523 | .Vb 2 |
1762 | .Vb 8 |
1524 | \& for (int i = 0; i < nfd; ++i) |
1763 | \& for (int i = 0; i < nfd; ++i) |
|
|
1764 | \& { |
|
|
1765 | \& // set the relevant poll flags |
|
|
1766 | \& // could also call adns_processreadable etc. here |
|
|
1767 | \& struct pollfd *fd = fds + i; |
|
|
1768 | \& int revents = ev_clear_pending (iow + i); |
|
|
1769 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1770 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1771 | .Ve |
|
|
1772 | .PP |
|
|
1773 | .Vb 3 |
|
|
1774 | \& // now stop the watcher |
1525 | \& ev_io_stop (loop, iow + i); |
1775 | \& ev_io_stop (loop, iow + i); |
|
|
1776 | \& } |
1526 | .Ve |
1777 | .Ve |
1527 | .PP |
1778 | .PP |
1528 | .Vb 2 |
1779 | .Vb 2 |
1529 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
1780 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1781 | \& } |
|
|
1782 | .Ve |
|
|
1783 | .PP |
|
|
1784 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
1785 | in the prepare watcher and would dispose of the check watcher. |
|
|
1786 | .PP |
|
|
1787 | Method 3: If the module to be embedded supports explicit event |
|
|
1788 | notification (adns does), you can also make use of the actual watcher |
|
|
1789 | callbacks, and only destroy/create the watchers in the prepare watcher. |
|
|
1790 | .PP |
|
|
1791 | .Vb 5 |
|
|
1792 | \& static void |
|
|
1793 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1794 | \& { |
|
|
1795 | \& adns_state ads = (adns_state)w->data; |
|
|
1796 | \& update_now (EV_A); |
|
|
1797 | .Ve |
|
|
1798 | .PP |
|
|
1799 | .Vb 2 |
|
|
1800 | \& adns_processtimeouts (ads, &tv_now); |
|
|
1801 | \& } |
|
|
1802 | .Ve |
|
|
1803 | .PP |
|
|
1804 | .Vb 5 |
|
|
1805 | \& static void |
|
|
1806 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
1807 | \& { |
|
|
1808 | \& adns_state ads = (adns_state)w->data; |
|
|
1809 | \& update_now (EV_A); |
|
|
1810 | .Ve |
|
|
1811 | .PP |
|
|
1812 | .Vb 3 |
|
|
1813 | \& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); |
|
|
1814 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); |
|
|
1815 | \& } |
|
|
1816 | .Ve |
|
|
1817 | .PP |
|
|
1818 | .Vb 1 |
|
|
1819 | \& // do not ever call adns_afterpoll |
|
|
1820 | .Ve |
|
|
1821 | .PP |
|
|
1822 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
1823 | want to embed is too inflexible to support it. Instead, youc na override |
|
|
1824 | their poll function. The drawback with this solution is that the main |
|
|
1825 | loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module does |
|
|
1826 | this. |
|
|
1827 | .PP |
|
|
1828 | .Vb 4 |
|
|
1829 | \& static gint |
|
|
1830 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
1831 | \& { |
|
|
1832 | \& int got_events = 0; |
|
|
1833 | .Ve |
|
|
1834 | .PP |
|
|
1835 | .Vb 2 |
|
|
1836 | \& for (n = 0; n < nfds; ++n) |
|
|
1837 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
1838 | .Ve |
|
|
1839 | .PP |
|
|
1840 | .Vb 2 |
|
|
1841 | \& if (timeout >= 0) |
|
|
1842 | \& // create/start timer |
|
|
1843 | .Ve |
|
|
1844 | .PP |
|
|
1845 | .Vb 2 |
|
|
1846 | \& // poll |
|
|
1847 | \& ev_loop (EV_A_ 0); |
|
|
1848 | .Ve |
|
|
1849 | .PP |
|
|
1850 | .Vb 3 |
|
|
1851 | \& // stop timer again |
|
|
1852 | \& if (timeout >= 0) |
|
|
1853 | \& ev_timer_stop (EV_A_ &to); |
|
|
1854 | .Ve |
|
|
1855 | .PP |
|
|
1856 | .Vb 3 |
|
|
1857 | \& // stop io watchers again - their callbacks should have set |
|
|
1858 | \& for (n = 0; n < nfds; ++n) |
|
|
1859 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
1860 | .Ve |
|
|
1861 | .PP |
|
|
1862 | .Vb 2 |
|
|
1863 | \& return got_events; |
1530 | \& } |
1864 | \& } |
1531 | .Ve |
1865 | .Ve |
1532 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1866 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1533 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1867 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1534 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1868 | .IX Subsection "ev_embed - when one backend isn't enough..." |
… | |
… | |
1718 | .PP |
2052 | .PP |
1719 | .Vb 1 |
2053 | .Vb 1 |
1720 | \& #include <ev++.h> |
2054 | \& #include <ev++.h> |
1721 | .Ve |
2055 | .Ve |
1722 | .PP |
2056 | .PP |
1723 | (it is not installed by default). This automatically includes \fIev.h\fR |
2057 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1724 | and puts all of its definitions (many of them macros) into the global |
2058 | of them macros) into the global namespace. All \*(C+ specific things are |
1725 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
2059 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
2060 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1726 | .PP |
2061 | .PP |
1727 | It should support all the same embedding options as \fIev.h\fR, most notably |
2062 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1728 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
2063 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
2064 | that the watcher is associated with (or no additional members at all if |
|
|
2065 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
2066 | .PP |
|
|
2067 | Currently, functions, and static and non-static member functions can be |
|
|
2068 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2069 | need one additional pointer for context. If you need support for other |
|
|
2070 | types of functors please contact the author (preferably after implementing |
|
|
2071 | it). |
1729 | .PP |
2072 | .PP |
1730 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
2073 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1731 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
2074 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
1732 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
2075 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1733 | .IX Item "ev::READ, ev::WRITE etc." |
2076 | .IX Item "ev::READ, ev::WRITE etc." |
… | |
… | |
1745 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
2088 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1746 | defines by many implementations. |
2089 | defines by many implementations. |
1747 | .Sp |
2090 | .Sp |
1748 | All of those classes have these methods: |
2091 | All of those classes have these methods: |
1749 | .RS 4 |
2092 | .RS 4 |
1750 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
2093 | .IP "ev::TYPE::TYPE ()" 4 |
1751 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
2094 | .IX Item "ev::TYPE::TYPE ()" |
1752 | .PD 0 |
2095 | .PD 0 |
1753 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
2096 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
1754 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
2097 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
1755 | .IP "ev::TYPE::~TYPE" 4 |
2098 | .IP "ev::TYPE::~TYPE" 4 |
1756 | .IX Item "ev::TYPE::~TYPE" |
2099 | .IX Item "ev::TYPE::~TYPE" |
1757 | .PD |
2100 | .PD |
1758 | The constructor takes a pointer to an object and a method pointer to |
2101 | The constructor (optionally) takes an event loop to associate the watcher |
1759 | the event handler callback to call in this class. The constructor calls |
2102 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
1760 | \&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method |
2103 | .Sp |
1761 | before starting it. If you do not specify a loop then the constructor |
2104 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
1762 | automatically associates the default loop with this watcher. |
2105 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
2106 | .Sp |
|
|
2107 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
2108 | method to set a callback before you can start the watcher. |
|
|
2109 | .Sp |
|
|
2110 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
2111 | not allow explicit template arguments for constructors). |
1763 | .Sp |
2112 | .Sp |
1764 | The destructor automatically stops the watcher if it is active. |
2113 | The destructor automatically stops the watcher if it is active. |
|
|
2114 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
2115 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
2116 | This method sets the callback method to call. The method has to have a |
|
|
2117 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
2118 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
2119 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
2120 | .Sp |
|
|
2121 | This method synthesizes efficient thunking code to call your method from |
|
|
2122 | the C callback that libev requires. If your compiler can inline your |
|
|
2123 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
2124 | your compiler is good :), then the method will be fully inlined into the |
|
|
2125 | thunking function, making it as fast as a direct C callback. |
|
|
2126 | .Sp |
|
|
2127 | Example: simple class declaration and watcher initialisation |
|
|
2128 | .Sp |
|
|
2129 | .Vb 4 |
|
|
2130 | \& struct myclass |
|
|
2131 | \& { |
|
|
2132 | \& void io_cb (ev::io &w, int revents) { } |
|
|
2133 | \& } |
|
|
2134 | .Ve |
|
|
2135 | .Sp |
|
|
2136 | .Vb 3 |
|
|
2137 | \& myclass obj; |
|
|
2138 | \& ev::io iow; |
|
|
2139 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
2140 | .Ve |
|
|
2141 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
2142 | .IX Item "w->set<function> (void *data = 0)" |
|
|
2143 | Also sets a callback, but uses a static method or plain function as |
|
|
2144 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
2145 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
2146 | .Sp |
|
|
2147 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
2148 | .Sp |
|
|
2149 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
2150 | .Sp |
|
|
2151 | Example: |
|
|
2152 | .Sp |
|
|
2153 | .Vb 2 |
|
|
2154 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
2155 | \& iow.set <io_cb> (); |
|
|
2156 | .Ve |
1765 | .IP "w\->set (struct ev_loop *)" 4 |
2157 | .IP "w\->set (struct ev_loop *)" 4 |
1766 | .IX Item "w->set (struct ev_loop *)" |
2158 | .IX Item "w->set (struct ev_loop *)" |
1767 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
2159 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1768 | do this when the watcher is inactive (and not pending either). |
2160 | do this when the watcher is inactive (and not pending either). |
1769 | .IP "w\->set ([args])" 4 |
2161 | .IP "w\->set ([args])" 4 |
1770 | .IX Item "w->set ([args])" |
2162 | .IX Item "w->set ([args])" |
1771 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
2163 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
1772 | called at least once. Unlike the C counterpart, an active watcher gets |
2164 | called at least once. Unlike the C counterpart, an active watcher gets |
1773 | automatically stopped and restarted. |
2165 | automatically stopped and restarted when reconfiguring it with this |
|
|
2166 | method. |
1774 | .IP "w\->start ()" 4 |
2167 | .IP "w\->start ()" 4 |
1775 | .IX Item "w->start ()" |
2168 | .IX Item "w->start ()" |
1776 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
2169 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
1777 | constructor already takes the loop. |
2170 | constructor already stores the event loop. |
1778 | .IP "w\->stop ()" 4 |
2171 | .IP "w\->stop ()" 4 |
1779 | .IX Item "w->stop ()" |
2172 | .IX Item "w->stop ()" |
1780 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2173 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
1781 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
2174 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
1782 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
2175 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
… | |
… | |
1808 | .Vb 2 |
2201 | .Vb 2 |
1809 | \& myclass (); |
2202 | \& myclass (); |
1810 | \& } |
2203 | \& } |
1811 | .Ve |
2204 | .Ve |
1812 | .PP |
2205 | .PP |
1813 | .Vb 6 |
2206 | .Vb 4 |
1814 | \& myclass::myclass (int fd) |
2207 | \& myclass::myclass (int fd) |
1815 | \& : io (this, &myclass::io_cb), |
|
|
1816 | \& idle (this, &myclass::idle_cb) |
|
|
1817 | \& { |
2208 | \& { |
|
|
2209 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
2210 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
2211 | .Ve |
|
|
2212 | .PP |
|
|
2213 | .Vb 2 |
1818 | \& io.start (fd, ev::READ); |
2214 | \& io.start (fd, ev::READ); |
1819 | \& } |
2215 | \& } |
1820 | .Ve |
2216 | .Ve |
1821 | .SH "MACRO MAGIC" |
2217 | .SH "MACRO MAGIC" |
1822 | .IX Header "MACRO MAGIC" |
2218 | .IX Header "MACRO MAGIC" |
1823 | Libev can be compiled with a variety of options, the most fundemantal is |
2219 | Libev can be compiled with a variety of options, the most fundemantal is |
1824 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines wether (most) functions and |
2220 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and |
1825 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
2221 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
1826 | .PP |
2222 | .PP |
1827 | To make it easier to write programs that cope with either variant, the |
2223 | To make it easier to write programs that cope with either variant, the |
1828 | following macros are defined: |
2224 | following macros are defined: |
1829 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
2225 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
… | |
… | |
1864 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2260 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
1865 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2261 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
1866 | Similar to the other two macros, this gives you the value of the default |
2262 | Similar to the other two macros, this gives you the value of the default |
1867 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
2263 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
1868 | .PP |
2264 | .PP |
1869 | Example: Declare and initialise a check watcher, working regardless of |
2265 | Example: Declare and initialise a check watcher, utilising the above |
1870 | wether multiple loops are supported or not. |
2266 | macros so it will work regardless of whether multiple loops are supported |
|
|
2267 | or not. |
1871 | .PP |
2268 | .PP |
1872 | .Vb 5 |
2269 | .Vb 5 |
1873 | \& static void |
2270 | \& static void |
1874 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2271 | \& check_cb (EV_P_ ev_timer *w, int revents) |
1875 | \& { |
2272 | \& { |
… | |
… | |
1938 | .Vb 1 |
2335 | .Vb 1 |
1939 | \& ev_win32.c required on win32 platforms only |
2336 | \& ev_win32.c required on win32 platforms only |
1940 | .Ve |
2337 | .Ve |
1941 | .PP |
2338 | .PP |
1942 | .Vb 5 |
2339 | .Vb 5 |
1943 | \& ev_select.c only when select backend is enabled (which is by default) |
2340 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
1944 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2341 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
1945 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2342 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
1946 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2343 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
1947 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2344 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
1948 | .Ve |
2345 | .Ve |
… | |
… | |
2069 | otherwise another method will be used as fallback. This is the preferred |
2466 | otherwise another method will be used as fallback. This is the preferred |
2070 | backend for Solaris 10 systems. |
2467 | backend for Solaris 10 systems. |
2071 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2468 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2072 | .IX Item "EV_USE_DEVPOLL" |
2469 | .IX Item "EV_USE_DEVPOLL" |
2073 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2470 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
|
|
2471 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
|
|
2472 | .IX Item "EV_USE_INOTIFY" |
|
|
2473 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
|
|
2474 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
|
|
2475 | be detected at runtime. |
2074 | .IP "\s-1EV_H\s0" 4 |
2476 | .IP "\s-1EV_H\s0" 4 |
2075 | .IX Item "EV_H" |
2477 | .IX Item "EV_H" |
2076 | The name of the \fIev.h\fR header file used to include it. The default if |
2478 | The name of the \fIev.h\fR header file used to include it. The default if |
2077 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2479 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
2078 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2480 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
… | |
… | |
2096 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2498 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2097 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2499 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2098 | additional independent event loops. Otherwise there will be no support |
2500 | additional independent event loops. Otherwise there will be no support |
2099 | for multiple event loops and there is no first event loop pointer |
2501 | for multiple event loops and there is no first event loop pointer |
2100 | argument. Instead, all functions act on the single default loop. |
2502 | argument. Instead, all functions act on the single default loop. |
|
|
2503 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
2504 | .IX Item "EV_MINPRI" |
|
|
2505 | .PD 0 |
|
|
2506 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
2507 | .IX Item "EV_MAXPRI" |
|
|
2508 | .PD |
|
|
2509 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
2510 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
2511 | provide for more priorities by overriding those symbols (usually defined |
|
|
2512 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
2513 | .Sp |
|
|
2514 | When doing priority-based operations, libev usually has to linearly search |
|
|
2515 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
2516 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
2517 | fine. |
|
|
2518 | .Sp |
|
|
2519 | If your embedding app does not need any priorities, defining these both to |
|
|
2520 | \&\f(CW0\fR will save some memory and cpu. |
2101 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2521 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2102 | .IX Item "EV_PERIODIC_ENABLE" |
2522 | .IX Item "EV_PERIODIC_ENABLE" |
2103 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2523 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
|
|
2524 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2525 | code. |
|
|
2526 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2527 | .IX Item "EV_IDLE_ENABLE" |
|
|
2528 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
2104 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2529 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2105 | code. |
2530 | code. |
2106 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2531 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2107 | .IX Item "EV_EMBED_ENABLE" |
2532 | .IX Item "EV_EMBED_ENABLE" |
2108 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2533 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
… | |
… | |
2123 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2548 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2124 | .IX Item "EV_PID_HASHSIZE" |
2549 | .IX Item "EV_PID_HASHSIZE" |
2125 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2550 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2126 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2551 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2127 | than enough. If you need to manage thousands of children you might want to |
2552 | than enough. If you need to manage thousands of children you might want to |
2128 | increase this value. |
2553 | increase this value (\fImust\fR be a power of two). |
|
|
2554 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
|
|
2555 | .IX Item "EV_INOTIFY_HASHSIZE" |
|
|
2556 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
|
|
2557 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
|
|
2558 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2559 | watchers you might want to increase this value (\fImust\fR be a power of |
|
|
2560 | two). |
2129 | .IP "\s-1EV_COMMON\s0" 4 |
2561 | .IP "\s-1EV_COMMON\s0" 4 |
2130 | .IX Item "EV_COMMON" |
2562 | .IX Item "EV_COMMON" |
2131 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2563 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2132 | this macro to a something else you can include more and other types of |
2564 | this macro to a something else you can include more and other types of |
2133 | members. You have to define it each time you include one of the files, |
2565 | members. You have to define it each time you include one of the files, |
… | |
… | |
2163 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2595 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2164 | will be compiled. It is pretty complex because it provides its own header |
2596 | will be compiled. It is pretty complex because it provides its own header |
2165 | file. |
2597 | file. |
2166 | .Sp |
2598 | .Sp |
2167 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2599 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2168 | that everybody includes and which overrides some autoconf choices: |
2600 | that everybody includes and which overrides some configure choices: |
2169 | .Sp |
2601 | .Sp |
2170 | .Vb 4 |
2602 | .Vb 9 |
|
|
2603 | \& #define EV_MINIMAL 1 |
2171 | \& #define EV_USE_POLL 0 |
2604 | \& #define EV_USE_POLL 0 |
2172 | \& #define EV_MULTIPLICITY 0 |
2605 | \& #define EV_MULTIPLICITY 0 |
2173 | \& #define EV_PERIODICS 0 |
2606 | \& #define EV_PERIODIC_ENABLE 0 |
|
|
2607 | \& #define EV_STAT_ENABLE 0 |
|
|
2608 | \& #define EV_FORK_ENABLE 0 |
2174 | \& #define EV_CONFIG_H <config.h> |
2609 | \& #define EV_CONFIG_H <config.h> |
|
|
2610 | \& #define EV_MINPRI 0 |
|
|
2611 | \& #define EV_MAXPRI 0 |
2175 | .Ve |
2612 | .Ve |
2176 | .Sp |
2613 | .Sp |
2177 | .Vb 1 |
2614 | .Vb 1 |
2178 | \& #include "ev++.h" |
2615 | \& #include "ev++.h" |
2179 | .Ve |
2616 | .Ve |
… | |
… | |
2187 | .SH "COMPLEXITIES" |
2624 | .SH "COMPLEXITIES" |
2188 | .IX Header "COMPLEXITIES" |
2625 | .IX Header "COMPLEXITIES" |
2189 | In this section the complexities of (many of) the algorithms used inside |
2626 | In this section the complexities of (many of) the algorithms used inside |
2190 | libev will be explained. For complexity discussions about backends see the |
2627 | libev will be explained. For complexity discussions about backends see the |
2191 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2628 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
2629 | .Sp |
|
|
2630 | All of the following are about amortised time: If an array needs to be |
|
|
2631 | extended, libev needs to realloc and move the whole array, but this |
|
|
2632 | happens asymptotically never with higher number of elements, so O(1) might |
|
|
2633 | mean it might do a lengthy realloc operation in rare cases, but on average |
|
|
2634 | it is much faster and asymptotically approaches constant time. |
2192 | .RS 4 |
2635 | .RS 4 |
2193 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2636 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2194 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2637 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2195 | .PD 0 |
2638 | This means that, when you have a watcher that triggers in one hour and |
|
|
2639 | there are 100 watchers that would trigger before that then inserting will |
|
|
2640 | have to skip those 100 watchers. |
2196 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2641 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
2197 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
2642 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2643 | That means that for changing a timer costs less than removing/adding them |
|
|
2644 | as only the relative motion in the event queue has to be paid for. |
2198 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2645 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
2199 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2646 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
2200 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
2647 | These just add the watcher into an array or at the head of a list. |
2201 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
2648 | =item Stopping check/prepare/idle watchers: O(1) |
2202 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" 4 |
2649 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2203 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))" |
2650 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
2651 | These watchers are stored in lists then need to be walked to find the |
|
|
2652 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
2653 | have many watchers waiting for the same fd or signal). |
2204 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2654 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
2205 | .IX Item "Finding the next timer per loop iteration: O(1)" |
2655 | .IX Item "Finding the next timer per loop iteration: O(1)" |
|
|
2656 | .PD 0 |
2206 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2657 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2207 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2658 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
|
|
2659 | .PD |
|
|
2660 | A change means an I/O watcher gets started or stopped, which requires |
|
|
2661 | libev to recalculate its status (and possibly tell the kernel). |
2208 | .IP "Activating one watcher: O(1)" 4 |
2662 | .IP "Activating one watcher: O(1)" 4 |
2209 | .IX Item "Activating one watcher: O(1)" |
2663 | .IX Item "Activating one watcher: O(1)" |
|
|
2664 | .PD 0 |
|
|
2665 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
2666 | .IX Item "Priority handling: O(number_of_priorities)" |
|
|
2667 | .PD |
|
|
2668 | Priorities are implemented by allocating some space for each |
|
|
2669 | priority. When doing priority-based operations, libev usually has to |
|
|
2670 | linearly search all the priorities. |
2210 | .RE |
2671 | .RE |
2211 | .RS 4 |
2672 | .RS 4 |
2212 | .PD |
|
|
2213 | .SH "AUTHOR" |
2673 | .SH "AUTHOR" |
2214 | .IX Header "AUTHOR" |
2674 | .IX Header "AUTHOR" |
2215 | Marc Lehmann <libev@schmorp.de>. |
2675 | Marc Lehmann <libev@schmorp.de>. |