1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 |
1 | .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
23 | .ft R |
23 | .ft R |
24 | .fi |
24 | .fi |
25 | .. |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
28 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
29 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
31 | .\" nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
32 | .tr \(*W- |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
35 | . ds -- \(*W- |
36 | . ds PI pi |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
… | |
… | |
46 | . ds PI \(*p |
46 | . ds PI \(*p |
47 | . ds L" `` |
47 | . ds L" `` |
48 | . ds R" '' |
48 | . ds R" '' |
49 | 'br\} |
49 | 'br\} |
50 | .\" |
50 | .\" |
|
|
51 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
|
|
52 | .ie \n(.g .ds Aq \(aq |
|
|
53 | .el .ds Aq ' |
|
|
54 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
55 | .\" If the F register is turned on, we'll generate index entries on stderr for |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
56 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
57 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
58 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
59 | .ie \nF \{\ |
56 | . de IX |
60 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
61 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
62 | .. |
59 | . nr % 0 |
63 | . nr % 0 |
60 | . rr F |
64 | . rr F |
61 | .\} |
65 | .\} |
62 | .\" |
66 | .el \{\ |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
67 | . de IX |
64 | .\" way too many mistakes in technical documents. |
68 | .. |
65 | .hy 0 |
69 | .\} |
66 | .if n .na |
|
|
67 | .\" |
70 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
71 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
72 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
73 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
74 | .if n \{\ |
… | |
… | |
126 | . ds Ae AE |
129 | . ds Ae AE |
127 | .\} |
130 | .\} |
128 | .rm #[ #] #H #V #F C |
131 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
132 | .\" ======================================================================== |
130 | .\" |
133 | .\" |
131 | .IX Title ""<STANDARD INPUT>" 1" |
134 | .IX Title "LIBEV 3" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation" |
135 | .TH LIBEV 3 "2008-12-14" "libev-3.51" "libev - high performance full featured event loop" |
|
|
136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
137 | .\" way too many mistakes in technical documents. |
|
|
138 | .if n .ad l |
|
|
139 | .nh |
133 | .SH "NAME" |
140 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
141 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
142 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
143 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
144 | .Vb 1 |
138 | \& #include <ev.h> |
145 | \& #include <ev.h> |
139 | .Ve |
146 | .Ve |
140 | .SH "EXAMPLE PROGRAM" |
147 | .Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" |
141 | .IX Header "EXAMPLE PROGRAM" |
148 | .IX Subsection "EXAMPLE PROGRAM" |
142 | .Vb 1 |
|
|
143 | \& #include <ev.h> |
|
|
144 | .Ve |
|
|
145 | .PP |
|
|
146 | .Vb 2 |
149 | .Vb 2 |
|
|
150 | \& // a single header file is required |
|
|
151 | \& #include <ev.h> |
|
|
152 | \& |
|
|
153 | \& #include <stdio.h> // for puts |
|
|
154 | \& |
|
|
155 | \& // every watcher type has its own typedef\*(Aqd struct |
|
|
156 | \& // with the name ev_TYPE |
147 | \& ev_io stdin_watcher; |
157 | \& ev_io stdin_watcher; |
148 | \& ev_timer timeout_watcher; |
158 | \& ev_timer timeout_watcher; |
149 | .Ve |
159 | \& |
150 | .PP |
160 | \& // all watcher callbacks have a similar signature |
151 | .Vb 8 |
|
|
152 | \& /* called when data readable on stdin */ |
161 | \& // this callback is called when data is readable on stdin |
153 | \& static void |
162 | \& static void |
154 | \& stdin_cb (EV_P_ struct ev_io *w, int revents) |
163 | \& stdin_cb (EV_P_ ev_io *w, int revents) |
155 | \& { |
164 | \& { |
156 | \& /* puts ("stdin ready"); */ |
165 | \& puts ("stdin ready"); |
157 | \& ev_io_stop (EV_A_ w); /* just a syntax example */ |
166 | \& // for one\-shot events, one must manually stop the watcher |
158 | \& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ |
167 | \& // with its corresponding stop function. |
|
|
168 | \& ev_io_stop (EV_A_ w); |
|
|
169 | \& |
|
|
170 | \& // this causes all nested ev_loop\*(Aqs to stop iterating |
|
|
171 | \& ev_unloop (EV_A_ EVUNLOOP_ALL); |
159 | \& } |
172 | \& } |
160 | .Ve |
173 | \& |
161 | .PP |
174 | \& // another callback, this time for a time\-out |
162 | .Vb 6 |
|
|
163 | \& static void |
175 | \& static void |
164 | \& timeout_cb (EV_P_ struct ev_timer *w, int revents) |
176 | \& timeout_cb (EV_P_ ev_timer *w, int revents) |
165 | \& { |
177 | \& { |
166 | \& /* puts ("timeout"); */ |
178 | \& puts ("timeout"); |
167 | \& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ |
179 | \& // this causes the innermost ev_loop to stop iterating |
|
|
180 | \& ev_unloop (EV_A_ EVUNLOOP_ONE); |
168 | \& } |
181 | \& } |
169 | .Ve |
182 | \& |
170 | .PP |
|
|
171 | .Vb 4 |
|
|
172 | \& int |
183 | \& int |
173 | \& main (void) |
184 | \& main (void) |
174 | \& { |
185 | \& { |
|
|
186 | \& // use the default event loop unless you have special needs |
175 | \& struct ev_loop *loop = ev_default_loop (0); |
187 | \& struct ev_loop *loop = ev_default_loop (0); |
176 | .Ve |
188 | \& |
177 | .PP |
|
|
178 | .Vb 3 |
|
|
179 | \& /* initialise an io watcher, then start it */ |
189 | \& // initialise an io watcher, then start it |
|
|
190 | \& // this one will watch for stdin to become readable |
180 | \& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
191 | \& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
181 | \& ev_io_start (loop, &stdin_watcher); |
192 | \& ev_io_start (loop, &stdin_watcher); |
182 | .Ve |
193 | \& |
183 | .PP |
194 | \& // initialise a timer watcher, then start it |
184 | .Vb 3 |
|
|
185 | \& /* simple non-repeating 5.5 second timeout */ |
195 | \& // simple non\-repeating 5.5 second timeout |
186 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
196 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
187 | \& ev_timer_start (loop, &timeout_watcher); |
197 | \& ev_timer_start (loop, &timeout_watcher); |
188 | .Ve |
198 | \& |
189 | .PP |
199 | \& // now wait for events to arrive |
190 | .Vb 2 |
|
|
191 | \& /* loop till timeout or data ready */ |
|
|
192 | \& ev_loop (loop, 0); |
200 | \& ev_loop (loop, 0); |
193 | .Ve |
201 | \& |
194 | .PP |
202 | \& // unloop was called, so exit |
195 | .Vb 2 |
|
|
196 | \& return 0; |
203 | \& return 0; |
197 | \& } |
204 | \& } |
198 | .Ve |
205 | .Ve |
199 | .SH "DESCRIPTION" |
206 | .SH "DESCRIPTION" |
200 | .IX Header "DESCRIPTION" |
207 | .IX Header "DESCRIPTION" |
|
|
208 | The newest version of this document is also available as an html-formatted |
|
|
209 | web page you might find easier to navigate when reading it for the first |
|
|
210 | time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
|
|
211 | .PP |
201 | Libev is an event loop: you register interest in certain events (such as a |
212 | Libev is an event loop: you register interest in certain events (such as a |
202 | file descriptor being readable or a timeout occuring), and it will manage |
213 | file descriptor being readable or a timeout occurring), and it will manage |
203 | these event sources and provide your program with events. |
214 | these event sources and provide your program with events. |
204 | .PP |
215 | .PP |
205 | To do this, it must take more or less complete control over your process |
216 | To do this, it must take more or less complete control over your process |
206 | (or thread) by executing the \fIevent loop\fR handler, and will then |
217 | (or thread) by executing the \fIevent loop\fR handler, and will then |
207 | communicate events via a callback mechanism. |
218 | communicate events via a callback mechanism. |
208 | .PP |
219 | .PP |
209 | You register interest in certain events by registering so-called \fIevent |
220 | You register interest in certain events by registering so-called \fIevent |
210 | watchers\fR, which are relatively small C structures you initialise with the |
221 | watchers\fR, which are relatively small C structures you initialise with the |
211 | details of the event, and then hand it over to libev by \fIstarting\fR the |
222 | details of the event, and then hand it over to libev by \fIstarting\fR the |
212 | watcher. |
223 | watcher. |
213 | .SH "FEATURES" |
224 | .Sh "\s-1FEATURES\s0" |
214 | .IX Header "FEATURES" |
225 | .IX Subsection "FEATURES" |
215 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
226 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
216 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
227 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
217 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
228 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
218 | (for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers |
229 | (for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers |
219 | with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals |
230 | with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals |
… | |
… | |
224 | (\f(CW\*(C`ev_fork\*(C'\fR). |
235 | (\f(CW\*(C`ev_fork\*(C'\fR). |
225 | .PP |
236 | .PP |
226 | It also is quite fast (see this |
237 | It also is quite fast (see this |
227 | benchmark comparing it to libevent |
238 | benchmark comparing it to libevent |
228 | for example). |
239 | for example). |
229 | .SH "CONVENTIONS" |
240 | .Sh "\s-1CONVENTIONS\s0" |
230 | .IX Header "CONVENTIONS" |
241 | .IX Subsection "CONVENTIONS" |
231 | Libev is very configurable. In this manual the default configuration will |
242 | Libev is very configurable. In this manual the default (and most common) |
232 | be described, which supports multiple event loops. For more info about |
243 | configuration will be described, which supports multiple event loops. For |
233 | various configuration options please have a look at \fB\s-1EMBED\s0\fR section in |
244 | more info about various configuration options please have a look at |
234 | this manual. If libev was configured without support for multiple event |
245 | \&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support |
235 | loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR |
246 | for multiple event loops, then all functions taking an initial argument of |
236 | (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. |
247 | name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`ev_loop *\*(C'\fR) will not have |
237 | .SH "TIME REPRESENTATION" |
248 | this argument. |
|
|
249 | .Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0" |
238 | .IX Header "TIME REPRESENTATION" |
250 | .IX Subsection "TIME REPRESENTATION" |
239 | Libev represents time as a single floating point number, representing the |
251 | Libev represents time as a single floating point number, representing the |
240 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
252 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
241 | the beginning of 1970, details are complicated, don't ask). This type is |
253 | the beginning of 1970, details are complicated, don't ask). This type is |
242 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
254 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
243 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
255 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
244 | it, you should treat it as such. |
256 | it, you should treat it as some floating point value. Unlike the name |
|
|
257 | component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for time differences |
|
|
258 | throughout libev. |
|
|
259 | .SH "ERROR HANDLING" |
|
|
260 | .IX Header "ERROR HANDLING" |
|
|
261 | Libev knows three classes of errors: operating system errors, usage errors |
|
|
262 | and internal errors (bugs). |
|
|
263 | .PP |
|
|
264 | When libev catches an operating system error it cannot handle (for example |
|
|
265 | a system call indicating a condition libev cannot fix), it calls the callback |
|
|
266 | set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or |
|
|
267 | abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort |
|
|
268 | ()\*(C'\fR. |
|
|
269 | .PP |
|
|
270 | When libev detects a usage error such as a negative timer interval, then |
|
|
271 | it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, |
|
|
272 | so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in |
|
|
273 | the libev caller and need to be fixed there. |
|
|
274 | .PP |
|
|
275 | Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has |
|
|
276 | extensive consistency checking code. These do not trigger under normal |
|
|
277 | circumstances, as they indicate either a bug in libev or worse. |
245 | .SH "GLOBAL FUNCTIONS" |
278 | .SH "GLOBAL FUNCTIONS" |
246 | .IX Header "GLOBAL FUNCTIONS" |
279 | .IX Header "GLOBAL FUNCTIONS" |
247 | These functions can be called anytime, even before initialising the |
280 | These functions can be called anytime, even before initialising the |
248 | library in any way. |
281 | library in any way. |
249 | .IP "ev_tstamp ev_time ()" 4 |
282 | .IP "ev_tstamp ev_time ()" 4 |
250 | .IX Item "ev_tstamp ev_time ()" |
283 | .IX Item "ev_tstamp ev_time ()" |
251 | Returns the current time as libev would use it. Please note that the |
284 | Returns the current time as libev would use it. Please note that the |
252 | \&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp |
285 | \&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp |
253 | you actually want to know. |
286 | you actually want to know. |
|
|
287 | .IP "ev_sleep (ev_tstamp interval)" 4 |
|
|
288 | .IX Item "ev_sleep (ev_tstamp interval)" |
|
|
289 | Sleep for the given interval: The current thread will be blocked until |
|
|
290 | either it is interrupted or the given time interval has passed. Basically |
|
|
291 | this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. |
254 | .IP "int ev_version_major ()" 4 |
292 | .IP "int ev_version_major ()" 4 |
255 | .IX Item "int ev_version_major ()" |
293 | .IX Item "int ev_version_major ()" |
256 | .PD 0 |
294 | .PD 0 |
257 | .IP "int ev_version_minor ()" 4 |
295 | .IP "int ev_version_minor ()" 4 |
258 | .IX Item "int ev_version_minor ()" |
296 | .IX Item "int ev_version_minor ()" |
259 | .PD |
297 | .PD |
260 | You can find out the major and minor version numbers of the library |
298 | You can find out the major and minor \s-1ABI\s0 version numbers of the library |
261 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
299 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
262 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
300 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
263 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
301 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
264 | version of the library your program was compiled against. |
302 | version of the library your program was compiled against. |
265 | .Sp |
303 | .Sp |
|
|
304 | These version numbers refer to the \s-1ABI\s0 version of the library, not the |
|
|
305 | release version. |
|
|
306 | .Sp |
266 | Usually, it's a good idea to terminate if the major versions mismatch, |
307 | Usually, it's a good idea to terminate if the major versions mismatch, |
267 | as this indicates an incompatible change. Minor versions are usually |
308 | as this indicates an incompatible change. Minor versions are usually |
268 | compatible to older versions, so a larger minor version alone is usually |
309 | compatible to older versions, so a larger minor version alone is usually |
269 | not a problem. |
310 | not a problem. |
270 | .Sp |
311 | .Sp |
271 | Example: Make sure we haven't accidentally been linked against the wrong |
312 | Example: Make sure we haven't accidentally been linked against the wrong |
272 | version. |
313 | version. |
273 | .Sp |
314 | .Sp |
274 | .Vb 3 |
315 | .Vb 3 |
275 | \& assert (("libev version mismatch", |
316 | \& assert (("libev version mismatch", |
276 | \& ev_version_major () == EV_VERSION_MAJOR |
317 | \& ev_version_major () == EV_VERSION_MAJOR |
277 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
318 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
278 | .Ve |
319 | .Ve |
279 | .IP "unsigned int ev_supported_backends ()" 4 |
320 | .IP "unsigned int ev_supported_backends ()" 4 |
280 | .IX Item "unsigned int ev_supported_backends ()" |
321 | .IX Item "unsigned int ev_supported_backends ()" |
281 | Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR |
322 | Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR |
282 | value) compiled into this binary of libev (independent of their |
323 | value) compiled into this binary of libev (independent of their |
… | |
… | |
285 | .Sp |
326 | .Sp |
286 | Example: make sure we have the epoll method, because yeah this is cool and |
327 | Example: make sure we have the epoll method, because yeah this is cool and |
287 | a must have and can we have a torrent of it please!!!11 |
328 | a must have and can we have a torrent of it please!!!11 |
288 | .Sp |
329 | .Sp |
289 | .Vb 2 |
330 | .Vb 2 |
290 | \& assert (("sorry, no epoll, no sex", |
331 | \& assert (("sorry, no epoll, no sex", |
291 | \& ev_supported_backends () & EVBACKEND_EPOLL)); |
332 | \& ev_supported_backends () & EVBACKEND_EPOLL)); |
292 | .Ve |
333 | .Ve |
293 | .IP "unsigned int ev_recommended_backends ()" 4 |
334 | .IP "unsigned int ev_recommended_backends ()" 4 |
294 | .IX Item "unsigned int ev_recommended_backends ()" |
335 | .IX Item "unsigned int ev_recommended_backends ()" |
295 | Return the set of all backends compiled into this binary of libev and also |
336 | Return the set of all backends compiled into this binary of libev and also |
296 | recommended for this platform. This set is often smaller than the one |
337 | recommended for this platform. This set is often smaller than the one |
297 | returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on |
338 | returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on |
298 | most BSDs and will not be autodetected unless you explicitly request it |
339 | most BSDs and will not be auto-detected unless you explicitly request it |
299 | (assuming you know what you are doing). This is the set of backends that |
340 | (assuming you know what you are doing). This is the set of backends that |
300 | libev will probe for if you specify no backends explicitly. |
341 | libev will probe for if you specify no backends explicitly. |
301 | .IP "unsigned int ev_embeddable_backends ()" 4 |
342 | .IP "unsigned int ev_embeddable_backends ()" 4 |
302 | .IX Item "unsigned int ev_embeddable_backends ()" |
343 | .IX Item "unsigned int ev_embeddable_backends ()" |
303 | Returns the set of backends that are embeddable in other event loops. This |
344 | Returns the set of backends that are embeddable in other event loops. This |
304 | is the theoretical, all\-platform, value. To find which backends |
345 | is the theoretical, all-platform, value. To find which backends |
305 | might be supported on the current system, you would need to look at |
346 | might be supported on the current system, you would need to look at |
306 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
347 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
307 | recommended ones. |
348 | recommended ones. |
308 | .Sp |
349 | .Sp |
309 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
350 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
310 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
351 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size)) [\s-1NOT\s0 \s-1REENTRANT\s0]" 4 |
311 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
352 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]" |
312 | Sets the allocation function to use (the prototype is similar \- the |
353 | Sets the allocation function to use (the prototype is similar \- the |
313 | semantics is identical \- to the realloc C function). It is used to |
354 | semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is |
314 | allocate and free memory (no surprises here). If it returns zero when |
355 | used to allocate and free memory (no surprises here). If it returns zero |
315 | memory needs to be allocated, the library might abort or take some |
356 | when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort |
316 | potentially destructive action. The default is your system realloc |
357 | or take some potentially destructive action. |
317 | function. |
358 | .Sp |
|
|
359 | Since some systems (at least OpenBSD and Darwin) fail to implement |
|
|
360 | correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system |
|
|
361 | \&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default. |
318 | .Sp |
362 | .Sp |
319 | You could override this function in high-availability programs to, say, |
363 | You could override this function in high-availability programs to, say, |
320 | free some memory if it cannot allocate memory, to use a special allocator, |
364 | free some memory if it cannot allocate memory, to use a special allocator, |
321 | or even to sleep a while and retry until some memory is available. |
365 | or even to sleep a while and retry until some memory is available. |
322 | .Sp |
366 | .Sp |
323 | Example: Replace the libev allocator with one that waits a bit and then |
367 | Example: Replace the libev allocator with one that waits a bit and then |
324 | retries). |
368 | retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). |
325 | .Sp |
369 | .Sp |
326 | .Vb 6 |
370 | .Vb 6 |
327 | \& static void * |
371 | \& static void * |
328 | \& persistent_realloc (void *ptr, size_t size) |
372 | \& persistent_realloc (void *ptr, size_t size) |
329 | \& { |
373 | \& { |
330 | \& for (;;) |
374 | \& for (;;) |
331 | \& { |
375 | \& { |
332 | \& void *newptr = realloc (ptr, size); |
376 | \& void *newptr = realloc (ptr, size); |
333 | .Ve |
377 | \& |
334 | .Sp |
|
|
335 | .Vb 2 |
|
|
336 | \& if (newptr) |
378 | \& if (newptr) |
337 | \& return newptr; |
379 | \& return newptr; |
338 | .Ve |
380 | \& |
339 | .Sp |
|
|
340 | .Vb 3 |
|
|
341 | \& sleep (60); |
381 | \& sleep (60); |
342 | \& } |
382 | \& } |
343 | \& } |
383 | \& } |
344 | .Ve |
384 | \& |
345 | .Sp |
|
|
346 | .Vb 2 |
|
|
347 | \& ... |
385 | \& ... |
348 | \& ev_set_allocator (persistent_realloc); |
386 | \& ev_set_allocator (persistent_realloc); |
349 | .Ve |
387 | .Ve |
350 | .IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 |
388 | .IP "ev_set_syserr_cb (void (*cb)(const char *msg)); [\s-1NOT\s0 \s-1REENTRANT\s0]" 4 |
351 | .IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" |
389 | .IX Item "ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]" |
352 | Set the callback function to call on a retryable syscall error (such |
390 | Set the callback function to call on a retryable system call error (such |
353 | as failed select, poll, epoll_wait). The message is a printable string |
391 | as failed select, poll, epoll_wait). The message is a printable string |
354 | indicating the system call or subsystem causing the problem. If this |
392 | indicating the system call or subsystem causing the problem. If this |
355 | callback is set, then libev will expect it to remedy the sitution, no |
393 | callback is set, then libev will expect it to remedy the situation, no |
356 | matter what, when it returns. That is, libev will generally retry the |
394 | matter what, when it returns. That is, libev will generally retry the |
357 | requested operation, or, if the condition doesn't go away, do bad stuff |
395 | requested operation, or, if the condition doesn't go away, do bad stuff |
358 | (such as abort). |
396 | (such as abort). |
359 | .Sp |
397 | .Sp |
360 | Example: This is basically the same thing that libev does internally, too. |
398 | Example: This is basically the same thing that libev does internally, too. |
… | |
… | |
364 | \& fatal_error (const char *msg) |
402 | \& fatal_error (const char *msg) |
365 | \& { |
403 | \& { |
366 | \& perror (msg); |
404 | \& perror (msg); |
367 | \& abort (); |
405 | \& abort (); |
368 | \& } |
406 | \& } |
369 | .Ve |
407 | \& |
370 | .Sp |
|
|
371 | .Vb 2 |
|
|
372 | \& ... |
408 | \& ... |
373 | \& ev_set_syserr_cb (fatal_error); |
409 | \& ev_set_syserr_cb (fatal_error); |
374 | .Ve |
410 | .Ve |
375 | .SH "FUNCTIONS CONTROLLING THE EVENT LOOP" |
411 | .SH "FUNCTIONS CONTROLLING THE EVENT LOOP" |
376 | .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" |
412 | .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" |
377 | An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two |
413 | An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR |
378 | types of such loops, the \fIdefault\fR loop, which supports signals and child |
414 | is \fInot\fR optional in this case, as there is also an \f(CW\*(C`ev_loop\*(C'\fR |
379 | events, and dynamically created loops which do not. |
415 | \&\fIfunction\fR). |
380 | .PP |
416 | .PP |
381 | If you use threads, a common model is to run the default event loop |
417 | The library knows two types of such loops, the \fIdefault\fR loop, which |
382 | in your main thread (or in a separate thread) and for each thread you |
418 | supports signals and child events, and dynamically created loops which do |
383 | create, you also create another event loop. Libev itself does no locking |
419 | not. |
384 | whatsoever, so if you mix calls to the same event loop in different |
|
|
385 | threads, make sure you lock (this is usually a bad idea, though, even if |
|
|
386 | done correctly, because it's hideous and inefficient). |
|
|
387 | .IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 |
420 | .IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 |
388 | .IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" |
421 | .IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" |
389 | This will initialise the default event loop if it hasn't been initialised |
422 | This will initialise the default event loop if it hasn't been initialised |
390 | yet and return it. If the default loop could not be initialised, returns |
423 | yet and return it. If the default loop could not be initialised, returns |
391 | false. If it already was initialised it simply returns it (and ignores the |
424 | false. If it already was initialised it simply returns it (and ignores the |
392 | flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). |
425 | flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). |
393 | .Sp |
426 | .Sp |
394 | If you don't know what event loop to use, use the one returned from this |
427 | If you don't know what event loop to use, use the one returned from this |
395 | function. |
428 | function. |
|
|
429 | .Sp |
|
|
430 | Note that this function is \fInot\fR thread-safe, so if you want to use it |
|
|
431 | from multiple threads, you have to lock (note also that this is unlikely, |
|
|
432 | as loops cannot be shared easily between threads anyway). |
|
|
433 | .Sp |
|
|
434 | The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and |
|
|
435 | \&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler |
|
|
436 | for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your application you can either |
|
|
437 | create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you |
|
|
438 | can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling |
|
|
439 | \&\f(CW\*(C`ev_default_init\*(C'\fR. |
396 | .Sp |
440 | .Sp |
397 | The flags argument can be used to specify special behaviour or specific |
441 | The flags argument can be used to specify special behaviour or specific |
398 | backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). |
442 | backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). |
399 | .Sp |
443 | .Sp |
400 | The following flags are supported: |
444 | The following flags are supported: |
… | |
… | |
405 | The default flags value. Use this if you have no clue (it's the right |
449 | The default flags value. Use this if you have no clue (it's the right |
406 | thing, believe me). |
450 | thing, believe me). |
407 | .ie n .IP """EVFLAG_NOENV""" 4 |
451 | .ie n .IP """EVFLAG_NOENV""" 4 |
408 | .el .IP "\f(CWEVFLAG_NOENV\fR" 4 |
452 | .el .IP "\f(CWEVFLAG_NOENV\fR" 4 |
409 | .IX Item "EVFLAG_NOENV" |
453 | .IX Item "EVFLAG_NOENV" |
410 | If this flag bit is ored into the flag value (or the program runs setuid |
454 | If this flag bit is or'ed into the flag value (or the program runs setuid |
411 | or setgid) then libev will \fInot\fR look at the environment variable |
455 | or setgid) then libev will \fInot\fR look at the environment variable |
412 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
456 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
413 | override the flags completely if it is found in the environment. This is |
457 | override the flags completely if it is found in the environment. This is |
414 | useful to try out specific backends to test their performance, or to work |
458 | useful to try out specific backends to test their performance, or to work |
415 | around bugs. |
459 | around bugs. |
… | |
… | |
421 | enabling this flag. |
465 | enabling this flag. |
422 | .Sp |
466 | .Sp |
423 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
467 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
424 | and thus this might slow down your event loop if you do a lot of loop |
468 | and thus this might slow down your event loop if you do a lot of loop |
425 | iterations and little real work, but is usually not noticeable (on my |
469 | iterations and little real work, but is usually not noticeable (on my |
426 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
470 | GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
427 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
471 | without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has |
428 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
472 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
429 | .Sp |
473 | .Sp |
430 | The big advantage of this flag is that you can forget about fork (and |
474 | The big advantage of this flag is that you can forget about fork (and |
431 | forget about forgetting to tell libev about forking) when you use this |
475 | forget about forgetting to tell libev about forking) when you use this |
432 | flag. |
476 | flag. |
433 | .Sp |
477 | .Sp |
434 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
478 | This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
435 | environment variable. |
479 | environment variable. |
436 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
480 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
437 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
481 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
438 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
482 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
439 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
483 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
440 | libev tries to roll its own fd_set with no limits on the number of fds, |
484 | libev tries to roll its own fd_set with no limits on the number of fds, |
441 | but if that fails, expect a fairly low limit on the number of fds when |
485 | but if that fails, expect a fairly low limit on the number of fds when |
442 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
486 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
443 | the fastest backend for a low number of fds. |
487 | usually the fastest backend for a low number of (low-numbered :) fds. |
|
|
488 | .Sp |
|
|
489 | To get good performance out of this backend you need a high amount of |
|
|
490 | parallelism (most of the file descriptors should be busy). If you are |
|
|
491 | writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many |
|
|
492 | connections as possible during one iteration. You might also want to have |
|
|
493 | a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of |
|
|
494 | readiness notifications you get per iteration. |
|
|
495 | .Sp |
|
|
496 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR to the \f(CW\*(C`readfds\*(C'\fR set and \f(CW\*(C`EV_WRITE\*(C'\fR to the |
|
|
497 | \&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the |
|
|
498 | \&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). |
444 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
499 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
445 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
500 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
446 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
501 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
447 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than |
502 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated |
448 | select, but handles sparse fds better and has no artificial limit on the |
503 | than select, but handles sparse fds better and has no artificial |
449 | number of fds you can use (except it will slow down considerably with a |
504 | limit on the number of fds you can use (except it will slow down |
450 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
505 | considerably with a lot of inactive fds). It scales similarly to select, |
|
|
506 | i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for |
|
|
507 | performance tips. |
|
|
508 | .Sp |
|
|
509 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and |
|
|
510 | \&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. |
451 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
511 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
452 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
512 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
453 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
513 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
454 | For few fds, this backend is a bit little slower than poll and select, |
514 | For few fds, this backend is a bit little slower than poll and select, |
455 | but it scales phenomenally better. While poll and select usually scale like |
515 | but it scales phenomenally better. While poll and select usually scale |
456 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
516 | like O(total_fds) where n is the total number of fds (or the highest fd), |
457 | either O(1) or O(active_fds). |
517 | epoll scales either O(1) or O(active_fds). |
458 | .Sp |
518 | .Sp |
|
|
519 | The epoll mechanism deserves honorable mention as the most misdesigned |
|
|
520 | of the more advanced event mechanisms: mere annoyances include silently |
|
|
521 | dropping file descriptors, requiring a system call per change per file |
|
|
522 | descriptor (and unnecessary guessing of parameters), problems with dup and |
|
|
523 | so on. The biggest issue is fork races, however \- if a program forks then |
|
|
524 | \&\fIboth\fR parent and child process have to recreate the epoll set, which can |
|
|
525 | take considerable time (one syscall per file descriptor) and is of course |
|
|
526 | hard to detect. |
|
|
527 | .Sp |
|
|
528 | Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but |
|
|
529 | of course \fIdoesn't\fR, and epoll just loves to report events for totally |
|
|
530 | \&\fIdifferent\fR file descriptors (even already closed ones, so one cannot |
|
|
531 | even remove them from the set) than registered in the set (especially |
|
|
532 | on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by |
|
|
533 | employing an additional generation counter and comparing that against the |
|
|
534 | events to filter out spurious ones, recreating the set when required. |
|
|
535 | .Sp |
459 | While stopping and starting an I/O watcher in the same iteration will |
536 | While stopping, setting and starting an I/O watcher in the same iteration |
460 | result in some caching, there is still a syscall per such incident |
537 | will result in some caching, there is still a system call per such |
461 | (because the fd could point to a different file description now), so its |
538 | incident (because the same \fIfile descriptor\fR could point to a different |
462 | best to avoid that. Also, \fIdup()\fRed file descriptors might not work very |
539 | \&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed |
463 | well if you register events for both fds. |
540 | file descriptors might not work very well if you register events for both |
|
|
541 | file descriptors. |
464 | .Sp |
542 | .Sp |
465 | Please note that epoll sometimes generates spurious notifications, so you |
543 | Best performance from this backend is achieved by not unregistering all |
466 | need to use non-blocking I/O or other means to avoid blocking when no data |
544 | watchers for a file descriptor until it has been closed, if possible, |
467 | (or space) is available. |
545 | i.e. keep at least one watcher active per fd at all times. Stopping and |
|
|
546 | starting a watcher (without re-setting it) also usually doesn't cause |
|
|
547 | extra overhead. A fork can both result in spurious notifications as well |
|
|
548 | as in libev having to destroy and recreate the epoll object, which can |
|
|
549 | take considerable time and thus should be avoided. |
|
|
550 | .Sp |
|
|
551 | All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or |
|
|
552 | faster than epoll for maybe up to a hundred file descriptors, depending on |
|
|
553 | the usage. So sad. |
|
|
554 | .Sp |
|
|
555 | While nominally embeddable in other event loops, this feature is broken in |
|
|
556 | all kernel versions tested so far. |
|
|
557 | .Sp |
|
|
558 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as |
|
|
559 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
468 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
560 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
469 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
561 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
470 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
562 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
471 | Kqueue deserves special mention, as at the time of this writing, it |
563 | Kqueue deserves special mention, as at the time of this writing, it |
472 | was broken on all BSDs except NetBSD (usually it doesn't work with |
564 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
473 | anything but sockets and pipes, except on Darwin, where of course its |
565 | with anything but sockets and pipes, except on Darwin, where of course |
474 | completely useless). For this reason its not being \*(L"autodetected\*(R" |
566 | it's completely useless). Unlike epoll, however, whose brokenness |
|
|
567 | is by design, these kqueue bugs can (and eventually will) be fixed |
|
|
568 | without \s-1API\s0 changes to existing programs. For this reason it's not being |
475 | unless you explicitly specify it explicitly in the flags (i.e. using |
569 | \&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using |
476 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). |
570 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) |
|
|
571 | system like NetBSD. |
|
|
572 | .Sp |
|
|
573 | You still can embed kqueue into a normal poll or select backend and use it |
|
|
574 | only for sockets (after having made sure that sockets work with kqueue on |
|
|
575 | the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
477 | .Sp |
576 | .Sp |
478 | It scales in the same way as the epoll backend, but the interface to the |
577 | It scales in the same way as the epoll backend, but the interface to the |
479 | kernel is more efficient (which says nothing about its actual speed, of |
578 | kernel is more efficient (which says nothing about its actual speed, of |
480 | course). While starting and stopping an I/O watcher does not cause an |
579 | course). While stopping, setting and starting an I/O watcher does never |
481 | extra syscall as with epoll, it still adds up to four event changes per |
580 | cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to |
482 | incident, so its best to avoid that. |
581 | two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but |
|
|
582 | sane, unlike epoll) and it drops fds silently in similarly hard-to-detect |
|
|
583 | cases |
|
|
584 | .Sp |
|
|
585 | This backend usually performs well under most conditions. |
|
|
586 | .Sp |
|
|
587 | While nominally embeddable in other event loops, this doesn't work |
|
|
588 | everywhere, so you might need to test for this. And since it is broken |
|
|
589 | almost everywhere, you should only use it when you have a lot of sockets |
|
|
590 | (for which it usually works), by embedding it into another event loop |
|
|
591 | (e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course |
|
|
592 | also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. |
|
|
593 | .Sp |
|
|
594 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with |
|
|
595 | \&\f(CW\*(C`NOTE_EOF\*(C'\fR, and \f(CW\*(C`EV_WRITE\*(C'\fR into an \f(CW\*(C`EVFILT_WRITE\*(C'\fR kevent with |
|
|
596 | \&\f(CW\*(C`NOTE_EOF\*(C'\fR. |
483 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
597 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
484 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
598 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
485 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
599 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
486 | This is not implemented yet (and might never be). |
600 | This is not implemented yet (and might never be, unless you send me an |
|
|
601 | implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets |
|
|
602 | and is not embeddable, which would limit the usefulness of this backend |
|
|
603 | immensely. |
487 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
604 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
488 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
605 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
489 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
606 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
490 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
607 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
491 | it's really slow, but it still scales very well (O(active_fds)). |
608 | it's really slow, but it still scales very well (O(active_fds)). |
492 | .Sp |
609 | .Sp |
493 | Please note that solaris ports can result in a lot of spurious |
610 | Please note that Solaris event ports can deliver a lot of spurious |
494 | notifications, so you need to use non-blocking I/O or other means to avoid |
611 | notifications, so you need to use non-blocking I/O or other means to avoid |
495 | blocking when no data (or space) is available. |
612 | blocking when no data (or space) is available. |
|
|
613 | .Sp |
|
|
614 | While this backend scales well, it requires one system call per active |
|
|
615 | file descriptor per loop iteration. For small and medium numbers of file |
|
|
616 | descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend |
|
|
617 | might perform better. |
|
|
618 | .Sp |
|
|
619 | On the positive side, with the exception of the spurious readiness |
|
|
620 | notifications, this backend actually performed fully to specification |
|
|
621 | in all tests and is fully embeddable, which is a rare feat among the |
|
|
622 | OS-specific backends (I vastly prefer correctness over speed hacks). |
|
|
623 | .Sp |
|
|
624 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as |
|
|
625 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
496 | .ie n .IP """EVBACKEND_ALL""" 4 |
626 | .ie n .IP """EVBACKEND_ALL""" 4 |
497 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
627 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
498 | .IX Item "EVBACKEND_ALL" |
628 | .IX Item "EVBACKEND_ALL" |
499 | Try all backends (even potentially broken ones that wouldn't be tried |
629 | Try all backends (even potentially broken ones that wouldn't be tried |
500 | with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as |
630 | with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as |
501 | \&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. |
631 | \&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. |
|
|
632 | .Sp |
|
|
633 | It is definitely not recommended to use this flag. |
502 | .RE |
634 | .RE |
503 | .RS 4 |
635 | .RS 4 |
504 | .Sp |
636 | .Sp |
505 | If one or more of these are ored into the flags value, then only these |
637 | If one or more of these are or'ed into the flags value, then only these |
506 | backends will be tried (in the reverse order as given here). If none are |
638 | backends will be tried (in the reverse order as listed here). If none are |
507 | specified, most compiled-in backend will be tried, usually in reverse |
639 | specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried. |
508 | order of their flag values :) |
|
|
509 | .Sp |
640 | .Sp |
510 | The most typical usage is like this: |
641 | Example: This is the most typical usage. |
511 | .Sp |
642 | .Sp |
512 | .Vb 2 |
643 | .Vb 2 |
513 | \& if (!ev_default_loop (0)) |
644 | \& if (!ev_default_loop (0)) |
514 | \& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
645 | \& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
515 | .Ve |
646 | .Ve |
516 | .Sp |
647 | .Sp |
517 | Restrict libev to the select and poll backends, and do not allow |
648 | Example: Restrict libev to the select and poll backends, and do not allow |
518 | environment settings to be taken into account: |
649 | environment settings to be taken into account: |
519 | .Sp |
650 | .Sp |
520 | .Vb 1 |
651 | .Vb 1 |
521 | \& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
652 | \& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
522 | .Ve |
653 | .Ve |
523 | .Sp |
654 | .Sp |
524 | Use whatever libev has to offer, but make sure that kqueue is used if |
655 | Example: Use whatever libev has to offer, but make sure that kqueue is |
525 | available (warning, breaks stuff, best use only with your own private |
656 | used if available (warning, breaks stuff, best use only with your own |
526 | event loop and only if you know the \s-1OS\s0 supports your types of fds): |
657 | private event loop and only if you know the \s-1OS\s0 supports your types of |
|
|
658 | fds): |
527 | .Sp |
659 | .Sp |
528 | .Vb 1 |
660 | .Vb 1 |
529 | \& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
661 | \& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
530 | .Ve |
662 | .Ve |
531 | .RE |
663 | .RE |
532 | .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 |
664 | .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 |
533 | .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" |
665 | .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" |
534 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
666 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
535 | always distinct from the default loop. Unlike the default loop, it cannot |
667 | always distinct from the default loop. Unlike the default loop, it cannot |
536 | handle signal and child watchers, and attempts to do so will be greeted by |
668 | handle signal and child watchers, and attempts to do so will be greeted by |
537 | undefined behaviour (or a failed assertion if assertions are enabled). |
669 | undefined behaviour (or a failed assertion if assertions are enabled). |
538 | .Sp |
670 | .Sp |
|
|
671 | Note that this function \fIis\fR thread-safe, and the recommended way to use |
|
|
672 | libev with threads is indeed to create one loop per thread, and using the |
|
|
673 | default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread. |
|
|
674 | .Sp |
539 | Example: Try to create a event loop that uses epoll and nothing else. |
675 | Example: Try to create a event loop that uses epoll and nothing else. |
540 | .Sp |
676 | .Sp |
541 | .Vb 3 |
677 | .Vb 3 |
542 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
678 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
543 | \& if (!epoller) |
679 | \& if (!epoller) |
544 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
680 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
545 | .Ve |
681 | .Ve |
546 | .IP "ev_default_destroy ()" 4 |
682 | .IP "ev_default_destroy ()" 4 |
547 | .IX Item "ev_default_destroy ()" |
683 | .IX Item "ev_default_destroy ()" |
548 | Destroys the default loop again (frees all memory and kernel state |
684 | Destroys the default loop again (frees all memory and kernel state |
549 | etc.). None of the active event watchers will be stopped in the normal |
685 | etc.). None of the active event watchers will be stopped in the normal |
550 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
686 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
551 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
687 | responsibility to either stop all watchers cleanly yourself \fIbefore\fR |
552 | calling this function, or cope with the fact afterwards (which is usually |
688 | calling this function, or cope with the fact afterwards (which is usually |
553 | the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
689 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
554 | for example). |
690 | for example). |
|
|
691 | .Sp |
|
|
692 | Note that certain global state, such as signal state (and installed signal |
|
|
693 | handlers), will not be freed by this function, and related watchers (such |
|
|
694 | as signal and child watchers) would need to be stopped manually. |
|
|
695 | .Sp |
|
|
696 | In general it is not advisable to call this function except in the |
|
|
697 | rare occasion where you really need to free e.g. the signal handling |
|
|
698 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
699 | \&\f(CW\*(C`ev_loop_new\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR). |
555 | .IP "ev_loop_destroy (loop)" 4 |
700 | .IP "ev_loop_destroy (loop)" 4 |
556 | .IX Item "ev_loop_destroy (loop)" |
701 | .IX Item "ev_loop_destroy (loop)" |
557 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
702 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
558 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
703 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
559 | .IP "ev_default_fork ()" 4 |
704 | .IP "ev_default_fork ()" 4 |
560 | .IX Item "ev_default_fork ()" |
705 | .IX Item "ev_default_fork ()" |
|
|
706 | This function sets a flag that causes subsequent \f(CW\*(C`ev_loop\*(C'\fR iterations |
561 | This function reinitialises the kernel state for backends that have |
707 | to reinitialise the kernel state for backends that have one. Despite the |
562 | one. Despite the name, you can call it anytime, but it makes most sense |
708 | name, you can call it anytime, but it makes most sense after forking, in |
563 | after forking, in either the parent or child process (or both, but that |
709 | the child process (or both child and parent, but that again makes little |
564 | again makes little sense). |
710 | sense). You \fImust\fR call it in the child before using any of the libev |
|
|
711 | functions, and it will only take effect at the next \f(CW\*(C`ev_loop\*(C'\fR iteration. |
565 | .Sp |
712 | .Sp |
566 | You \fImust\fR call this function in the child process after forking if and |
713 | On the other hand, you only need to call this function in the child |
567 | only if you want to use the event library in both processes. If you just |
714 | process if and only if you want to use the event library in the child. If |
568 | fork+exec, you don't have to call it. |
715 | you just fork+exec, you don't have to call it at all. |
569 | .Sp |
716 | .Sp |
570 | The function itself is quite fast and it's usually not a problem to call |
717 | The function itself is quite fast and it's usually not a problem to call |
571 | it just in case after a fork. To make this easy, the function will fit in |
718 | it just in case after a fork. To make this easy, the function will fit in |
572 | quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR: |
719 | quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR: |
573 | .Sp |
720 | .Sp |
574 | .Vb 1 |
721 | .Vb 1 |
575 | \& pthread_atfork (0, 0, ev_default_fork); |
722 | \& pthread_atfork (0, 0, ev_default_fork); |
576 | .Ve |
723 | .Ve |
577 | .Sp |
|
|
578 | At the moment, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR are safe to use |
|
|
579 | without calling this function, so if you force one of those backends you |
|
|
580 | do not need to care. |
|
|
581 | .IP "ev_loop_fork (loop)" 4 |
724 | .IP "ev_loop_fork (loop)" 4 |
582 | .IX Item "ev_loop_fork (loop)" |
725 | .IX Item "ev_loop_fork (loop)" |
583 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
726 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
584 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
727 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
585 | after fork, and how you do this is entirely your own problem. |
728 | after fork that you want to re-use in the child, and how you do this is |
|
|
729 | entirely your own problem. |
|
|
730 | .IP "int ev_is_default_loop (loop)" 4 |
|
|
731 | .IX Item "int ev_is_default_loop (loop)" |
|
|
732 | Returns true when the given loop is, in fact, the default loop, and false |
|
|
733 | otherwise. |
586 | .IP "unsigned int ev_loop_count (loop)" 4 |
734 | .IP "unsigned int ev_loop_count (loop)" 4 |
587 | .IX Item "unsigned int ev_loop_count (loop)" |
735 | .IX Item "unsigned int ev_loop_count (loop)" |
588 | Returns the count of loop iterations for the loop, which is identical to |
736 | Returns the count of loop iterations for the loop, which is identical to |
589 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
737 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
590 | happily wraps around with enough iterations. |
738 | happily wraps around with enough iterations. |
… | |
… | |
600 | .IX Item "ev_tstamp ev_now (loop)" |
748 | .IX Item "ev_tstamp ev_now (loop)" |
601 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
749 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
602 | received events and started processing them. This timestamp does not |
750 | received events and started processing them. This timestamp does not |
603 | change as long as callbacks are being processed, and this is also the base |
751 | change as long as callbacks are being processed, and this is also the base |
604 | time used for relative timers. You can treat it as the timestamp of the |
752 | time used for relative timers. You can treat it as the timestamp of the |
605 | event occuring (or more correctly, libev finding out about it). |
753 | event occurring (or more correctly, libev finding out about it). |
|
|
754 | .IP "ev_now_update (loop)" 4 |
|
|
755 | .IX Item "ev_now_update (loop)" |
|
|
756 | Establishes the current time by querying the kernel, updating the time |
|
|
757 | returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and |
|
|
758 | is usually done automatically within \f(CW\*(C`ev_loop ()\*(C'\fR. |
|
|
759 | .Sp |
|
|
760 | This function is rarely useful, but when some event callback runs for a |
|
|
761 | very long time without entering the event loop, updating libev's idea of |
|
|
762 | the current time is a good idea. |
|
|
763 | .Sp |
|
|
764 | See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section. |
606 | .IP "ev_loop (loop, int flags)" 4 |
765 | .IP "ev_loop (loop, int flags)" 4 |
607 | .IX Item "ev_loop (loop, int flags)" |
766 | .IX Item "ev_loop (loop, int flags)" |
608 | Finally, this is it, the event handler. This function usually is called |
767 | Finally, this is it, the event handler. This function usually is called |
609 | after you initialised all your watchers and you want to start handling |
768 | after you initialised all your watchers and you want to start handling |
610 | events. |
769 | events. |
… | |
… | |
612 | If the flags argument is specified as \f(CW0\fR, it will not return until |
771 | If the flags argument is specified as \f(CW0\fR, it will not return until |
613 | either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. |
772 | either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. |
614 | .Sp |
773 | .Sp |
615 | Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than |
774 | Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than |
616 | relying on all watchers to be stopped when deciding when a program has |
775 | relying on all watchers to be stopped when deciding when a program has |
617 | finished (especially in interactive programs), but having a program that |
776 | finished (especially in interactive programs), but having a program |
618 | automatically loops as long as it has to and no longer by virtue of |
777 | that automatically loops as long as it has to and no longer by virtue |
619 | relying on its watchers stopping correctly is a thing of beauty. |
778 | of relying on its watchers stopping correctly, that is truly a thing of |
|
|
779 | beauty. |
620 | .Sp |
780 | .Sp |
621 | A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle |
781 | A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle |
622 | those events and any outstanding ones, but will not block your process in |
782 | those events and any already outstanding ones, but will not block your |
623 | case there are no events and will return after one iteration of the loop. |
783 | process in case there are no events and will return after one iteration of |
|
|
784 | the loop. |
624 | .Sp |
785 | .Sp |
625 | A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if |
786 | A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if |
626 | neccessary) and will handle those and any outstanding ones. It will block |
787 | necessary) and will handle those and any already outstanding ones. It |
627 | your process until at least one new event arrives, and will return after |
788 | will block your process until at least one new event arrives (which could |
628 | one iteration of the loop. This is useful if you are waiting for some |
789 | be an event internal to libev itself, so there is no guarantee that a |
629 | external event in conjunction with something not expressible using other |
790 | user-registered callback will be called), and will return after one |
|
|
791 | iteration of the loop. |
|
|
792 | .Sp |
|
|
793 | This is useful if you are waiting for some external event in conjunction |
|
|
794 | with something not expressible using other libev watchers (i.e. "roll your |
630 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
795 | own \f(CW\*(C`ev_loop\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
631 | usually a better approach for this kind of thing. |
796 | usually a better approach for this kind of thing. |
632 | .Sp |
797 | .Sp |
633 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
798 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
634 | .Sp |
799 | .Sp |
635 | .Vb 18 |
800 | .Vb 10 |
636 | \& * If there are no active watchers (reference count is zero), return. |
801 | \& \- Before the first iteration, call any pending watchers. |
637 | \& - Queue prepare watchers and then call all outstanding watchers. |
802 | \& * If EVFLAG_FORKCHECK was used, check for a fork. |
|
|
803 | \& \- If a fork was detected (by any means), queue and call all fork watchers. |
|
|
804 | \& \- Queue and call all prepare watchers. |
638 | \& - If we have been forked, recreate the kernel state. |
805 | \& \- If we have been forked, detach and recreate the kernel state |
|
|
806 | \& as to not disturb the other process. |
639 | \& - Update the kernel state with all outstanding changes. |
807 | \& \- Update the kernel state with all outstanding changes. |
640 | \& - Update the "event loop time". |
808 | \& \- Update the "event loop time" (ev_now ()). |
641 | \& - Calculate for how long to block. |
809 | \& \- Calculate for how long to sleep or block, if at all |
|
|
810 | \& (active idle watchers, EVLOOP_NONBLOCK or not having |
|
|
811 | \& any active watchers at all will result in not sleeping). |
|
|
812 | \& \- Sleep if the I/O and timer collect interval say so. |
642 | \& - Block the process, waiting for any events. |
813 | \& \- Block the process, waiting for any events. |
643 | \& - Queue all outstanding I/O (fd) events. |
814 | \& \- Queue all outstanding I/O (fd) events. |
644 | \& - Update the "event loop time" and do time jump handling. |
815 | \& \- Update the "event loop time" (ev_now ()), and do time jump adjustments. |
645 | \& - Queue all outstanding timers. |
816 | \& \- Queue all expired timers. |
646 | \& - Queue all outstanding periodics. |
817 | \& \- Queue all expired periodics. |
647 | \& - If no events are pending now, queue all idle watchers. |
818 | \& \- Unless any events are pending now, queue all idle watchers. |
648 | \& - Queue all check watchers. |
819 | \& \- Queue all check watchers. |
649 | \& - Call all queued watchers in reverse order (i.e. check watchers first). |
820 | \& \- Call all queued watchers in reverse order (i.e. check watchers first). |
650 | \& Signals and child watchers are implemented as I/O watchers, and will |
821 | \& Signals and child watchers are implemented as I/O watchers, and will |
651 | \& be handled here by queueing them when their watcher gets executed. |
822 | \& be handled here by queueing them when their watcher gets executed. |
652 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
823 | \& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
653 | \& were used, return, otherwise continue with step *. |
824 | \& were used, or there are no active watchers, return, otherwise |
|
|
825 | \& continue with step *. |
654 | .Ve |
826 | .Ve |
655 | .Sp |
827 | .Sp |
656 | Example: Queue some jobs and then loop until no events are outsanding |
828 | Example: Queue some jobs and then loop until no events are outstanding |
657 | anymore. |
829 | anymore. |
658 | .Sp |
830 | .Sp |
659 | .Vb 4 |
831 | .Vb 4 |
660 | \& ... queue jobs here, make sure they register event watchers as long |
832 | \& ... queue jobs here, make sure they register event watchers as long |
661 | \& ... as they still have work to do (even an idle watcher will do..) |
833 | \& ... as they still have work to do (even an idle watcher will do..) |
662 | \& ev_loop (my_loop, 0); |
834 | \& ev_loop (my_loop, 0); |
663 | \& ... jobs done. yeah! |
835 | \& ... jobs done or somebody called unloop. yeah! |
664 | .Ve |
836 | .Ve |
665 | .IP "ev_unloop (loop, how)" 4 |
837 | .IP "ev_unloop (loop, how)" 4 |
666 | .IX Item "ev_unloop (loop, how)" |
838 | .IX Item "ev_unloop (loop, how)" |
667 | Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it |
839 | Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it |
668 | has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either |
840 | has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either |
669 | \&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or |
841 | \&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or |
670 | \&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. |
842 | \&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. |
|
|
843 | .Sp |
|
|
844 | This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again. |
|
|
845 | .Sp |
|
|
846 | It is safe to call \f(CW\*(C`ev_unloop\*(C'\fR from otuside any \f(CW\*(C`ev_loop\*(C'\fR calls. |
671 | .IP "ev_ref (loop)" 4 |
847 | .IP "ev_ref (loop)" 4 |
672 | .IX Item "ev_ref (loop)" |
848 | .IX Item "ev_ref (loop)" |
673 | .PD 0 |
849 | .PD 0 |
674 | .IP "ev_unref (loop)" 4 |
850 | .IP "ev_unref (loop)" 4 |
675 | .IX Item "ev_unref (loop)" |
851 | .IX Item "ev_unref (loop)" |
676 | .PD |
852 | .PD |
677 | Ref/unref can be used to add or remove a reference count on the event |
853 | Ref/unref can be used to add or remove a reference count on the event |
678 | loop: Every watcher keeps one reference, and as long as the reference |
854 | loop: Every watcher keeps one reference, and as long as the reference |
679 | count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. If you have |
855 | count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. |
|
|
856 | .Sp |
680 | a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR from |
857 | If you have a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR |
681 | returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For |
858 | from returning, call \fIev_unref()\fR after starting, and \fIev_ref()\fR before |
|
|
859 | stopping it. |
|
|
860 | .Sp |
682 | example, libev itself uses this for its internal signal pipe: It is not |
861 | As an example, libev itself uses this for its internal signal pipe: It is |
683 | visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if |
862 | not visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting |
684 | no event watchers registered by it are active. It is also an excellent |
863 | if no event watchers registered by it are active. It is also an excellent |
685 | way to do this for generic recurring timers or from within third-party |
864 | way to do this for generic recurring timers or from within third-party |
686 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
865 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR |
|
|
866 | (but only if the watcher wasn't active before, or was active before, |
|
|
867 | respectively). |
687 | .Sp |
868 | .Sp |
688 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
869 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
689 | running when nothing else is active. |
870 | running when nothing else is active. |
690 | .Sp |
871 | .Sp |
691 | .Vb 4 |
872 | .Vb 4 |
692 | \& struct ev_signal exitsig; |
873 | \& ev_signal exitsig; |
693 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
874 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
694 | \& ev_signal_start (loop, &exitsig); |
875 | \& ev_signal_start (loop, &exitsig); |
695 | \& evf_unref (loop); |
876 | \& evf_unref (loop); |
696 | .Ve |
877 | .Ve |
697 | .Sp |
878 | .Sp |
698 | Example: For some weird reason, unregister the above signal handler again. |
879 | Example: For some weird reason, unregister the above signal handler again. |
699 | .Sp |
880 | .Sp |
700 | .Vb 2 |
881 | .Vb 2 |
701 | \& ev_ref (loop); |
882 | \& ev_ref (loop); |
702 | \& ev_signal_stop (loop, &exitsig); |
883 | \& ev_signal_stop (loop, &exitsig); |
703 | .Ve |
884 | .Ve |
|
|
885 | .IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4 |
|
|
886 | .IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)" |
|
|
887 | .PD 0 |
|
|
888 | .IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4 |
|
|
889 | .IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" |
|
|
890 | .PD |
|
|
891 | These advanced functions influence the time that libev will spend waiting |
|
|
892 | for events. Both time intervals are by default \f(CW0\fR, meaning that libev |
|
|
893 | will try to invoke timer/periodic callbacks and I/O callbacks with minimum |
|
|
894 | latency. |
|
|
895 | .Sp |
|
|
896 | Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR) |
|
|
897 | allows libev to delay invocation of I/O and timer/periodic callbacks |
|
|
898 | to increase efficiency of loop iterations (or to increase power-saving |
|
|
899 | opportunities). |
|
|
900 | .Sp |
|
|
901 | The idea is that sometimes your program runs just fast enough to handle |
|
|
902 | one (or very few) event(s) per loop iteration. While this makes the |
|
|
903 | program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new |
|
|
904 | events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high |
|
|
905 | overhead for the actual polling but can deliver many events at once. |
|
|
906 | .Sp |
|
|
907 | By setting a higher \fIio collect interval\fR you allow libev to spend more |
|
|
908 | time collecting I/O events, so you can handle more events per iteration, |
|
|
909 | at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and |
|
|
910 | \&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will |
|
|
911 | introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. |
|
|
912 | .Sp |
|
|
913 | Likewise, by setting a higher \fItimeout collect interval\fR you allow libev |
|
|
914 | to spend more time collecting timeouts, at the expense of increased |
|
|
915 | latency/jitter/inexactness (the watcher callback will be called |
|
|
916 | later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null |
|
|
917 | value will not introduce any overhead in libev. |
|
|
918 | .Sp |
|
|
919 | Many (busy) programs can usually benefit by setting the I/O collect |
|
|
920 | interval to a value near \f(CW0.1\fR or so, which is often enough for |
|
|
921 | interactive servers (of course not for games), likewise for timeouts. It |
|
|
922 | usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, |
|
|
923 | as this approaches the timing granularity of most systems. |
|
|
924 | .Sp |
|
|
925 | Setting the \fItimeout collect interval\fR can improve the opportunity for |
|
|
926 | saving power, as the program will \*(L"bundle\*(R" timer callback invocations that |
|
|
927 | are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of |
|
|
928 | times the process sleeps and wakes up again. Another useful technique to |
|
|
929 | reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure |
|
|
930 | they fire on, say, one-second boundaries only. |
|
|
931 | .IP "ev_loop_verify (loop)" 4 |
|
|
932 | .IX Item "ev_loop_verify (loop)" |
|
|
933 | This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been |
|
|
934 | compiled in, which is the default for non-minimal builds. It tries to go |
|
|
935 | through all internal structures and checks them for validity. If anything |
|
|
936 | is found to be inconsistent, it will print an error message to standard |
|
|
937 | error and call \f(CW\*(C`abort ()\*(C'\fR. |
|
|
938 | .Sp |
|
|
939 | This can be used to catch bugs inside libev itself: under normal |
|
|
940 | circumstances, this function will never abort as of course libev keeps its |
|
|
941 | data structures consistent. |
704 | .SH "ANATOMY OF A WATCHER" |
942 | .SH "ANATOMY OF A WATCHER" |
705 | .IX Header "ANATOMY OF A WATCHER" |
943 | .IX Header "ANATOMY OF A WATCHER" |
|
|
944 | In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the |
|
|
945 | watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer |
|
|
946 | watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers. |
|
|
947 | .PP |
706 | A watcher is a structure that you create and register to record your |
948 | A watcher is a structure that you create and register to record your |
707 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
949 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
708 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
950 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
709 | .PP |
951 | .PP |
710 | .Vb 5 |
952 | .Vb 5 |
711 | \& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
953 | \& static void my_cb (struct ev_loop *loop, ev_io *w, int revents) |
712 | \& { |
954 | \& { |
713 | \& ev_io_stop (w); |
955 | \& ev_io_stop (w); |
714 | \& ev_unloop (loop, EVUNLOOP_ALL); |
956 | \& ev_unloop (loop, EVUNLOOP_ALL); |
715 | \& } |
957 | \& } |
716 | .Ve |
958 | \& |
717 | .PP |
|
|
718 | .Vb 6 |
|
|
719 | \& struct ev_loop *loop = ev_default_loop (0); |
959 | \& struct ev_loop *loop = ev_default_loop (0); |
|
|
960 | \& |
720 | \& struct ev_io stdin_watcher; |
961 | \& ev_io stdin_watcher; |
|
|
962 | \& |
721 | \& ev_init (&stdin_watcher, my_cb); |
963 | \& ev_init (&stdin_watcher, my_cb); |
722 | \& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
964 | \& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
723 | \& ev_io_start (loop, &stdin_watcher); |
965 | \& ev_io_start (loop, &stdin_watcher); |
|
|
966 | \& |
724 | \& ev_loop (loop, 0); |
967 | \& ev_loop (loop, 0); |
725 | .Ve |
968 | .Ve |
726 | .PP |
969 | .PP |
727 | As you can see, you are responsible for allocating the memory for your |
970 | As you can see, you are responsible for allocating the memory for your |
728 | watcher structures (and it is usually a bad idea to do this on the stack, |
971 | watcher structures (and it is \fIusually\fR a bad idea to do this on the |
729 | although this can sometimes be quite valid). |
972 | stack). |
|
|
973 | .PP |
|
|
974 | Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR |
|
|
975 | or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs). |
730 | .PP |
976 | .PP |
731 | Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init |
977 | Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init |
732 | (watcher *, callback)\*(C'\fR, which expects a callback to be provided. This |
978 | (watcher *, callback)\*(C'\fR, which expects a callback to be provided. This |
733 | callback gets invoked each time the event occurs (or, in the case of io |
979 | callback gets invoked each time the event occurs (or, in the case of I/O |
734 | watchers, each time the event loop detects that the file descriptor given |
980 | watchers, each time the event loop detects that the file descriptor given |
735 | is readable and/or writable). |
981 | is readable and/or writable). |
736 | .PP |
982 | .PP |
737 | Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro |
983 | Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR |
738 | with arguments specific to this watcher type. There is also a macro |
984 | macro to configure it, with arguments specific to the watcher type. There |
739 | to combine initialisation and setting in one call: \f(CW\*(C`ev_<type>_init |
985 | is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR. |
740 | (watcher *, callback, ...)\*(C'\fR. |
|
|
741 | .PP |
986 | .PP |
742 | To make the watcher actually watch out for events, you have to start it |
987 | To make the watcher actually watch out for events, you have to start it |
743 | with a watcher-specific start function (\f(CW\*(C`ev_<type>_start (loop, watcher |
988 | with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher |
744 | *)\*(C'\fR), and you can stop watching for events at any time by calling the |
989 | *)\*(C'\fR), and you can stop watching for events at any time by calling the |
745 | corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. |
990 | corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR. |
746 | .PP |
991 | .PP |
747 | As long as your watcher is active (has been started but not stopped) you |
992 | As long as your watcher is active (has been started but not stopped) you |
748 | must not touch the values stored in it. Most specifically you must never |
993 | must not touch the values stored in it. Most specifically you must never |
749 | reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. |
994 | reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro. |
750 | .PP |
995 | .PP |
751 | Each and every callback receives the event loop pointer as first, the |
996 | Each and every callback receives the event loop pointer as first, the |
752 | registered watcher structure as second, and a bitset of received events as |
997 | registered watcher structure as second, and a bitset of received events as |
753 | third argument. |
998 | third argument. |
754 | .PP |
999 | .PP |
… | |
… | |
811 | .ie n .IP """EV_FORK""" 4 |
1056 | .ie n .IP """EV_FORK""" 4 |
812 | .el .IP "\f(CWEV_FORK\fR" 4 |
1057 | .el .IP "\f(CWEV_FORK\fR" 4 |
813 | .IX Item "EV_FORK" |
1058 | .IX Item "EV_FORK" |
814 | The event loop has been resumed in the child process after fork (see |
1059 | The event loop has been resumed in the child process after fork (see |
815 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
1060 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
|
|
1061 | .ie n .IP """EV_ASYNC""" 4 |
|
|
1062 | .el .IP "\f(CWEV_ASYNC\fR" 4 |
|
|
1063 | .IX Item "EV_ASYNC" |
|
|
1064 | The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). |
816 | .ie n .IP """EV_ERROR""" 4 |
1065 | .ie n .IP """EV_ERROR""" 4 |
817 | .el .IP "\f(CWEV_ERROR\fR" 4 |
1066 | .el .IP "\f(CWEV_ERROR\fR" 4 |
818 | .IX Item "EV_ERROR" |
1067 | .IX Item "EV_ERROR" |
819 | An unspecified error has occured, the watcher has been stopped. This might |
1068 | An unspecified error has occurred, the watcher has been stopped. This might |
820 | happen because the watcher could not be properly started because libev |
1069 | happen because the watcher could not be properly started because libev |
821 | ran out of memory, a file descriptor was found to be closed or any other |
1070 | ran out of memory, a file descriptor was found to be closed or any other |
|
|
1071 | problem. Libev considers these application bugs. |
|
|
1072 | .Sp |
822 | problem. You best act on it by reporting the problem and somehow coping |
1073 | You best act on it by reporting the problem and somehow coping with the |
823 | with the watcher being stopped. |
1074 | watcher being stopped. Note that well-written programs should not receive |
|
|
1075 | an error ever, so when your watcher receives it, this usually indicates a |
|
|
1076 | bug in your program. |
824 | .Sp |
1077 | .Sp |
825 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, |
1078 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for |
826 | for example it might indicate that a fd is readable or writable, and if |
1079 | example it might indicate that a fd is readable or writable, and if your |
827 | your callbacks is well-written it can just attempt the operation and cope |
1080 | callbacks is well-written it can just attempt the operation and cope with |
828 | with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded |
1081 | the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded |
829 | programs, though, so beware. |
1082 | programs, though, as the fd could already be closed and reused for another |
|
|
1083 | thing, so beware. |
830 | .Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
1084 | .Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
831 | .IX Subsection "GENERIC WATCHER FUNCTIONS" |
1085 | .IX Subsection "GENERIC WATCHER FUNCTIONS" |
832 | In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type, |
|
|
833 | e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers. |
|
|
834 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
1086 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
835 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
1087 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
836 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
1088 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
837 | This macro initialises the generic portion of a watcher. The contents |
1089 | This macro initialises the generic portion of a watcher. The contents |
838 | of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only |
1090 | of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only |
… | |
… | |
842 | which rolls both calls into one. |
1094 | which rolls both calls into one. |
843 | .Sp |
1095 | .Sp |
844 | You can reinitialise a watcher at any time as long as it has been stopped |
1096 | You can reinitialise a watcher at any time as long as it has been stopped |
845 | (or never started) and there are no pending events outstanding. |
1097 | (or never started) and there are no pending events outstanding. |
846 | .Sp |
1098 | .Sp |
847 | The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, |
1099 | The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher, |
848 | int revents)\*(C'\fR. |
1100 | int revents)\*(C'\fR. |
|
|
1101 | .Sp |
|
|
1102 | Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps. |
|
|
1103 | .Sp |
|
|
1104 | .Vb 3 |
|
|
1105 | \& ev_io w; |
|
|
1106 | \& ev_init (&w, my_cb); |
|
|
1107 | \& ev_io_set (&w, STDIN_FILENO, EV_READ); |
|
|
1108 | .Ve |
849 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 |
1109 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 |
850 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 |
1110 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 |
851 | .IX Item "ev_TYPE_set (ev_TYPE *, [args])" |
1111 | .IX Item "ev_TYPE_set (ev_TYPE *, [args])" |
852 | This macro initialises the type-specific parts of a watcher. You need to |
1112 | This macro initialises the type-specific parts of a watcher. You need to |
853 | call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can |
1113 | call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can |
… | |
… | |
855 | macro on a watcher that is active (it can be pending, however, which is a |
1115 | macro on a watcher that is active (it can be pending, however, which is a |
856 | difference to the \f(CW\*(C`ev_init\*(C'\fR macro). |
1116 | difference to the \f(CW\*(C`ev_init\*(C'\fR macro). |
857 | .Sp |
1117 | .Sp |
858 | Although some watcher types do not have type-specific arguments |
1118 | Although some watcher types do not have type-specific arguments |
859 | (e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. |
1119 | (e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. |
|
|
1120 | .Sp |
|
|
1121 | See \f(CW\*(C`ev_init\*(C'\fR, above, for an example. |
860 | .ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 |
1122 | .ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 |
861 | .el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 |
1123 | .el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 |
862 | .IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" |
1124 | .IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" |
863 | This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro |
1125 | This convenience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro |
864 | calls into a single call. This is the most convinient method to initialise |
1126 | calls into a single call. This is the most convenient method to initialise |
865 | a watcher. The same limitations apply, of course. |
1127 | a watcher. The same limitations apply, of course. |
|
|
1128 | .Sp |
|
|
1129 | Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step. |
|
|
1130 | .Sp |
|
|
1131 | .Vb 1 |
|
|
1132 | \& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
|
|
1133 | .Ve |
866 | .ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 |
1134 | .ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 |
867 | .el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 |
1135 | .el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 |
868 | .IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" |
1136 | .IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" |
869 | Starts (activates) the given watcher. Only active watchers will receive |
1137 | Starts (activates) the given watcher. Only active watchers will receive |
870 | events. If the watcher is already active nothing will happen. |
1138 | events. If the watcher is already active nothing will happen. |
|
|
1139 | .Sp |
|
|
1140 | Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this |
|
|
1141 | whole section. |
|
|
1142 | .Sp |
|
|
1143 | .Vb 1 |
|
|
1144 | \& ev_io_start (EV_DEFAULT_UC, &w); |
|
|
1145 | .Ve |
871 | .ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 |
1146 | .ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 |
872 | .el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 |
1147 | .el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 |
873 | .IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" |
1148 | .IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" |
874 | Stops the given watcher again (if active) and clears the pending |
1149 | Stops the given watcher if active, and clears the pending status (whether |
|
|
1150 | the watcher was active or not). |
|
|
1151 | .Sp |
875 | status. It is possible that stopped watchers are pending (for example, |
1152 | It is possible that stopped watchers are pending \- for example, |
876 | non-repeating timers are being stopped when they become pending), but |
1153 | non-repeating timers are being stopped when they become pending \- but |
877 | \&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If |
1154 | calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor |
878 | you want to free or reuse the memory used by the watcher it is therefore a |
1155 | pending. If you want to free or reuse the memory used by the watcher it is |
879 | good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. |
1156 | therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. |
880 | .IP "bool ev_is_active (ev_TYPE *watcher)" 4 |
1157 | .IP "bool ev_is_active (ev_TYPE *watcher)" 4 |
881 | .IX Item "bool ev_is_active (ev_TYPE *watcher)" |
1158 | .IX Item "bool ev_is_active (ev_TYPE *watcher)" |
882 | Returns a true value iff the watcher is active (i.e. it has been started |
1159 | Returns a true value iff the watcher is active (i.e. it has been started |
883 | and not yet been stopped). As long as a watcher is active you must not modify |
1160 | and not yet been stopped). As long as a watcher is active you must not modify |
884 | it. |
1161 | it. |
885 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
1162 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
886 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
1163 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
887 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
1164 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
888 | events but its callback has not yet been invoked). As long as a watcher |
1165 | events but its callback has not yet been invoked). As long as a watcher |
889 | is pending (but not active) you must not call an init function on it (but |
1166 | is pending (but not active) you must not call an init function on it (but |
890 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
1167 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
891 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
1168 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
1169 | it). |
892 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
1170 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
893 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
1171 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
894 | Returns the callback currently set on the watcher. |
1172 | Returns the callback currently set on the watcher. |
895 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
1173 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
896 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
1174 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
… | |
… | |
914 | watchers on the same event and make sure one is called first. |
1192 | watchers on the same event and make sure one is called first. |
915 | .Sp |
1193 | .Sp |
916 | If you need to suppress invocation when higher priority events are pending |
1194 | If you need to suppress invocation when higher priority events are pending |
917 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
1195 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
918 | .Sp |
1196 | .Sp |
|
|
1197 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
1198 | pending. |
|
|
1199 | .Sp |
919 | The default priority used by watchers when no priority has been set is |
1200 | The default priority used by watchers when no priority has been set is |
920 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
1201 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
921 | .Sp |
1202 | .Sp |
922 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
1203 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
923 | fine, as long as you do not mind that the priority value you query might |
1204 | fine, as long as you do not mind that the priority value you query might |
924 | or might not have been adjusted to be within valid range. |
1205 | or might not have been clamped to the valid range. |
|
|
1206 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
1207 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
1208 | 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 |
|
|
1209 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
1210 | can deal with that fact, as both are simply passed through to the |
|
|
1211 | callback. |
|
|
1212 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
1213 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
1214 | If the watcher is pending, this function clears its pending status and |
|
|
1215 | returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
1216 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
|
|
1217 | .Sp |
|
|
1218 | Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its |
|
|
1219 | callback to be invoked, which can be accomplished with this function. |
925 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
1220 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
926 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
1221 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
927 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
1222 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
928 | and read at any time, libev will completely ignore it. This can be used |
1223 | and read at any time: libev will completely ignore it. This can be used |
929 | to associate arbitrary data with your watcher. If you need more data and |
1224 | to associate arbitrary data with your watcher. If you need more data and |
930 | don't want to allocate memory and store a pointer to it in that data |
1225 | don't want to allocate memory and store a pointer to it in that data |
931 | member, you can also \*(L"subclass\*(R" the watcher type and provide your own |
1226 | member, you can also \*(L"subclass\*(R" the watcher type and provide your own |
932 | data: |
1227 | data: |
933 | .PP |
1228 | .PP |
934 | .Vb 7 |
1229 | .Vb 7 |
935 | \& struct my_io |
1230 | \& struct my_io |
936 | \& { |
1231 | \& { |
937 | \& struct ev_io io; |
1232 | \& ev_io io; |
938 | \& int otherfd; |
1233 | \& int otherfd; |
939 | \& void *somedata; |
1234 | \& void *somedata; |
940 | \& struct whatever *mostinteresting; |
1235 | \& struct whatever *mostinteresting; |
941 | \& } |
1236 | \& }; |
|
|
1237 | \& |
|
|
1238 | \& ... |
|
|
1239 | \& struct my_io w; |
|
|
1240 | \& ev_io_init (&w.io, my_cb, fd, EV_READ); |
942 | .Ve |
1241 | .Ve |
943 | .PP |
1242 | .PP |
944 | And since your callback will be called with a pointer to the watcher, you |
1243 | And since your callback will be called with a pointer to the watcher, you |
945 | can cast it back to your own type: |
1244 | can cast it back to your own type: |
946 | .PP |
1245 | .PP |
947 | .Vb 5 |
1246 | .Vb 5 |
948 | \& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) |
1247 | \& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents) |
949 | \& { |
1248 | \& { |
950 | \& struct my_io *w = (struct my_io *)w_; |
1249 | \& struct my_io *w = (struct my_io *)w_; |
951 | \& ... |
1250 | \& ... |
952 | \& } |
1251 | \& } |
953 | .Ve |
1252 | .Ve |
954 | .PP |
1253 | .PP |
955 | More interesting and less C\-conformant ways of casting your callback type |
1254 | More interesting and less C\-conformant ways of casting your callback type |
956 | instead have been omitted. |
1255 | instead have been omitted. |
957 | .PP |
1256 | .PP |
958 | Another common scenario is having some data structure with multiple |
1257 | Another common scenario is to use some data structure with multiple |
959 | watchers: |
1258 | embedded watchers: |
960 | .PP |
1259 | .PP |
961 | .Vb 6 |
1260 | .Vb 6 |
962 | \& struct my_biggy |
1261 | \& struct my_biggy |
963 | \& { |
1262 | \& { |
964 | \& int some_data; |
1263 | \& int some_data; |
965 | \& ev_timer t1; |
1264 | \& ev_timer t1; |
966 | \& ev_timer t2; |
1265 | \& ev_timer t2; |
967 | \& } |
1266 | \& } |
968 | .Ve |
1267 | .Ve |
969 | .PP |
1268 | .PP |
970 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
1269 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more |
971 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
1270 | complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct |
|
|
1271 | in the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies), or you need to use |
|
|
1272 | some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for real |
|
|
1273 | programmers): |
972 | .PP |
1274 | .PP |
973 | .Vb 1 |
1275 | .Vb 1 |
974 | \& #include <stddef.h> |
1276 | \& #include <stddef.h> |
975 | .Ve |
1277 | \& |
976 | .PP |
|
|
977 | .Vb 6 |
|
|
978 | \& static void |
1278 | \& static void |
979 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
1279 | \& t1_cb (EV_P_ ev_timer *w, int revents) |
980 | \& { |
1280 | \& { |
981 | \& struct my_biggy big = (struct my_biggy * |
1281 | \& struct my_biggy big = (struct my_biggy * |
982 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
1282 | \& (((char *)w) \- offsetof (struct my_biggy, t1)); |
983 | \& } |
1283 | \& } |
984 | .Ve |
1284 | \& |
985 | .PP |
|
|
986 | .Vb 6 |
|
|
987 | \& static void |
1285 | \& static void |
988 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
1286 | \& t2_cb (EV_P_ ev_timer *w, int revents) |
989 | \& { |
1287 | \& { |
990 | \& struct my_biggy big = (struct my_biggy * |
1288 | \& struct my_biggy big = (struct my_biggy * |
991 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
1289 | \& (((char *)w) \- offsetof (struct my_biggy, t2)); |
992 | \& } |
1290 | \& } |
993 | .Ve |
1291 | .Ve |
994 | .SH "WATCHER TYPES" |
1292 | .SH "WATCHER TYPES" |
995 | .IX Header "WATCHER TYPES" |
1293 | .IX Header "WATCHER TYPES" |
996 | This section describes each watcher in detail, but will not repeat |
1294 | This section describes each watcher in detail, but will not repeat |
997 | information given in the last section. Any initialisation/set macros, |
1295 | information given in the last section. Any initialisation/set macros, |
… | |
… | |
1019 | In general you can register as many read and/or write event watchers per |
1317 | In general you can register as many read and/or write event watchers per |
1020 | fd as you want (as long as you don't confuse yourself). Setting all file |
1318 | fd as you want (as long as you don't confuse yourself). Setting all file |
1021 | descriptors to non-blocking mode is also usually a good idea (but not |
1319 | descriptors to non-blocking mode is also usually a good idea (but not |
1022 | required if you know what you are doing). |
1320 | required if you know what you are doing). |
1023 | .PP |
1321 | .PP |
1024 | You have to be careful with dup'ed file descriptors, though. Some backends |
1322 | If you cannot use non-blocking mode, then force the use of a |
1025 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
1323 | known-to-be-good backend (at the time of this writing, this includes only |
1026 | descriptors correctly if you register interest in two or more fds pointing |
1324 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
1027 | to the same underlying file/socket/etc. description (that is, they share |
|
|
1028 | the same underlying \*(L"file open\*(R"). |
|
|
1029 | .PP |
|
|
1030 | If you must do this, then force the use of a known-to-be-good backend |
|
|
1031 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
|
|
1032 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
|
|
1033 | .PP |
1325 | .PP |
1034 | Another thing you have to watch out for is that it is quite easy to |
1326 | Another thing you have to watch out for is that it is quite easy to |
1035 | receive \*(L"spurious\*(R" readyness notifications, that is your callback might |
1327 | receive \*(L"spurious\*(R" readiness notifications, that is your callback might |
1036 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
1328 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
1037 | because there is no data. Not only are some backends known to create a |
1329 | because there is no data. Not only are some backends known to create a |
1038 | lot of those (for example solaris ports), it is very easy to get into |
1330 | lot of those (for example Solaris ports), it is very easy to get into |
1039 | this situation even with a relatively standard program structure. Thus |
1331 | this situation even with a relatively standard program structure. Thus |
1040 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1332 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1041 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1333 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1042 | .PP |
1334 | .PP |
1043 | If you cannot run the fd in non-blocking mode (for example you should not |
1335 | If you cannot run the fd in non-blocking mode (for example you should |
1044 | play around with an Xlib connection), then you have to seperately re-test |
1336 | not play around with an Xlib connection), then you have to separately |
1045 | whether a file descriptor is really ready with a known-to-be good interface |
1337 | re-test whether a file descriptor is really ready with a known-to-be good |
1046 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1338 | interface such as poll (fortunately in our Xlib example, Xlib already |
1047 | its own, so its quite safe to use). |
1339 | does this on its own, so its quite safe to use). Some people additionally |
|
|
1340 | use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block |
|
|
1341 | indefinitely. |
|
|
1342 | .PP |
|
|
1343 | But really, best use non-blocking mode. |
|
|
1344 | .PP |
|
|
1345 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1346 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1347 | .PP |
|
|
1348 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
|
|
1349 | descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, |
|
|
1350 | such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file |
|
|
1351 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1352 | this interest. If another file descriptor with the same number then is |
|
|
1353 | registered with libev, there is no efficient way to see that this is, in |
|
|
1354 | fact, a different file descriptor. |
|
|
1355 | .PP |
|
|
1356 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1357 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1358 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1359 | it is assumed that the file descriptor stays the same. That means that |
|
|
1360 | 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 |
|
|
1361 | descriptor even if the file descriptor number itself did not change. |
|
|
1362 | .PP |
|
|
1363 | This is how one would do it normally anyway, the important point is that |
|
|
1364 | the libev application should not optimise around libev but should leave |
|
|
1365 | optimisations to libev. |
|
|
1366 | .PP |
|
|
1367 | \fIThe special problem of dup'ed file descriptors\fR |
|
|
1368 | .IX Subsection "The special problem of dup'ed file descriptors" |
|
|
1369 | .PP |
|
|
1370 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1371 | but only events for the underlying file descriptions. That means when you |
|
|
1372 | have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register |
|
|
1373 | events for them, only one file descriptor might actually receive events. |
|
|
1374 | .PP |
|
|
1375 | There is no workaround possible except not registering events |
|
|
1376 | for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to |
|
|
1377 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1378 | .PP |
|
|
1379 | \fIThe special problem of fork\fR |
|
|
1380 | .IX Subsection "The special problem of fork" |
|
|
1381 | .PP |
|
|
1382 | Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit |
|
|
1383 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1384 | it in the child. |
|
|
1385 | .PP |
|
|
1386 | To support fork in your programs, you either have to call |
|
|
1387 | \&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, |
|
|
1388 | enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or |
|
|
1389 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1390 | .PP |
|
|
1391 | \fIThe special problem of \s-1SIGPIPE\s0\fR |
|
|
1392 | .IX Subsection "The special problem of SIGPIPE" |
|
|
1393 | .PP |
|
|
1394 | While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: |
|
|
1395 | when writing to a pipe whose other end has been closed, your program gets |
|
|
1396 | sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs |
|
|
1397 | this is sensible behaviour, for daemons, this is usually undesirable. |
|
|
1398 | .PP |
|
|
1399 | So when you encounter spurious, unexplained daemon exits, make sure you |
|
|
1400 | ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon |
|
|
1401 | somewhere, as that would have given you a big clue). |
|
|
1402 | .PP |
|
|
1403 | \fIWatcher-Specific Functions\fR |
|
|
1404 | .IX Subsection "Watcher-Specific Functions" |
1048 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1405 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1049 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1406 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1050 | .PD 0 |
1407 | .PD 0 |
1051 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1408 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1052 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1409 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1053 | .PD |
1410 | .PD |
1054 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
1411 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
1055 | rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
1412 | receive events for and \f(CW\*(C`events\*(C'\fR is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
1056 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. |
1413 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events. |
1057 | .IP "int fd [read\-only]" 4 |
1414 | .IP "int fd [read\-only]" 4 |
1058 | .IX Item "int fd [read-only]" |
1415 | .IX Item "int fd [read-only]" |
1059 | The file descriptor being watched. |
1416 | The file descriptor being watched. |
1060 | .IP "int events [read\-only]" 4 |
1417 | .IP "int events [read\-only]" 4 |
1061 | .IX Item "int events [read-only]" |
1418 | .IX Item "int events [read-only]" |
1062 | The events being watched. |
1419 | The events being watched. |
1063 | .PP |
1420 | .PP |
|
|
1421 | \fIExamples\fR |
|
|
1422 | .IX Subsection "Examples" |
|
|
1423 | .PP |
1064 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1424 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1065 | readable, but only once. Since it is likely line\-buffered, you could |
1425 | readable, but only once. Since it is likely line-buffered, you could |
1066 | attempt to read a whole line in the callback. |
1426 | attempt to read a whole line in the callback. |
1067 | .PP |
1427 | .PP |
1068 | .Vb 6 |
1428 | .Vb 6 |
1069 | \& static void |
1429 | \& static void |
1070 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1430 | \& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents) |
1071 | \& { |
1431 | \& { |
1072 | \& ev_io_stop (loop, w); |
1432 | \& ev_io_stop (loop, w); |
1073 | \& .. read from stdin here (or from w->fd) and haqndle any I/O errors |
1433 | \& .. read from stdin here (or from w\->fd) and handle any I/O errors |
1074 | \& } |
1434 | \& } |
1075 | .Ve |
1435 | \& |
1076 | .PP |
|
|
1077 | .Vb 6 |
|
|
1078 | \& ... |
1436 | \& ... |
1079 | \& struct ev_loop *loop = ev_default_init (0); |
1437 | \& struct ev_loop *loop = ev_default_init (0); |
1080 | \& struct ev_io stdin_readable; |
1438 | \& ev_io stdin_readable; |
1081 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1439 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1082 | \& ev_io_start (loop, &stdin_readable); |
1440 | \& ev_io_start (loop, &stdin_readable); |
1083 | \& ev_loop (loop, 0); |
1441 | \& ev_loop (loop, 0); |
1084 | .Ve |
1442 | .Ve |
1085 | .ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" |
1443 | .ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" |
1086 | .el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" |
1444 | .el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" |
1087 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
1445 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
1088 | Timer watchers are simple relative timers that generate an event after a |
1446 | Timer watchers are simple relative timers that generate an event after a |
1089 | given time, and optionally repeating in regular intervals after that. |
1447 | given time, and optionally repeating in regular intervals after that. |
1090 | .PP |
1448 | .PP |
1091 | The timers are based on real time, that is, if you register an event that |
1449 | The timers are based on real time, that is, if you register an event that |
1092 | times out after an hour and you reset your system clock to last years |
1450 | times out after an hour and you reset your system clock to January last |
1093 | time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because |
1451 | year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because |
1094 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1452 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1095 | monotonic clock option helps a lot here). |
1453 | monotonic clock option helps a lot here). |
|
|
1454 | .PP |
|
|
1455 | The callback is guaranteed to be invoked only \fIafter\fR its timeout has |
|
|
1456 | passed, but if multiple timers become ready during the same loop iteration |
|
|
1457 | then order of execution is undefined. |
|
|
1458 | .PP |
|
|
1459 | \fIBe smart about timeouts\fR |
|
|
1460 | .IX Subsection "Be smart about timeouts" |
|
|
1461 | .PP |
|
|
1462 | Many real-world problems involve some kind of timeout, usually for error |
|
|
1463 | recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs, |
|
|
1464 | you want to raise some error after a while. |
|
|
1465 | .PP |
|
|
1466 | What follows are some ways to handle this problem, from obvious and |
|
|
1467 | inefficient to smart and efficient. |
|
|
1468 | .PP |
|
|
1469 | In the following, a 60 second activity timeout is assumed \- a timeout that |
|
|
1470 | gets reset to 60 seconds each time there is activity (e.g. each time some |
|
|
1471 | data or other life sign was received). |
|
|
1472 | .IP "1. Use a timer and stop, reinitialise and start it on activity." 4 |
|
|
1473 | .IX Item "1. Use a timer and stop, reinitialise and start it on activity." |
|
|
1474 | This is the most obvious, but not the most simple way: In the beginning, |
|
|
1475 | start the watcher: |
|
|
1476 | .Sp |
|
|
1477 | .Vb 2 |
|
|
1478 | \& ev_timer_init (timer, callback, 60., 0.); |
|
|
1479 | \& ev_timer_start (loop, timer); |
|
|
1480 | .Ve |
|
|
1481 | .Sp |
|
|
1482 | Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it |
|
|
1483 | and start it again: |
|
|
1484 | .Sp |
|
|
1485 | .Vb 3 |
|
|
1486 | \& ev_timer_stop (loop, timer); |
|
|
1487 | \& ev_timer_set (timer, 60., 0.); |
|
|
1488 | \& ev_timer_start (loop, timer); |
|
|
1489 | .Ve |
|
|
1490 | .Sp |
|
|
1491 | This is relatively simple to implement, but means that each time there is |
|
|
1492 | some activity, libev will first have to remove the timer from its internal |
|
|
1493 | data structure and then add it again. Libev tries to be fast, but it's |
|
|
1494 | still not a constant-time operation. |
|
|
1495 | .ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4 |
|
|
1496 | .el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4 |
|
|
1497 | .IX Item "2. Use a timer and re-start it with ev_timer_again inactivity." |
|
|
1498 | This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of |
|
|
1499 | \&\f(CW\*(C`ev_timer_start\*(C'\fR. |
|
|
1500 | .Sp |
|
|
1501 | To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value |
|
|
1502 | of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you |
|
|
1503 | successfully read or write some data. If you go into an idle state where |
|
|
1504 | you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR |
|
|
1505 | the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be. |
|
|
1506 | .Sp |
|
|
1507 | That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the |
|
|
1508 | \&\f(CW\*(C`after\*(C'\fR argument to \f(CW\*(C`ev_timer_set\*(C'\fR, and only ever use the \f(CW\*(C`repeat\*(C'\fR |
|
|
1509 | member and \f(CW\*(C`ev_timer_again\*(C'\fR. |
|
|
1510 | .Sp |
|
|
1511 | At start: |
|
|
1512 | .Sp |
|
|
1513 | .Vb 3 |
|
|
1514 | \& ev_timer_init (timer, callback); |
|
|
1515 | \& timer\->repeat = 60.; |
|
|
1516 | \& ev_timer_again (loop, timer); |
|
|
1517 | .Ve |
|
|
1518 | .Sp |
|
|
1519 | Each time there is some activity: |
|
|
1520 | .Sp |
|
|
1521 | .Vb 1 |
|
|
1522 | \& ev_timer_again (loop, timer); |
|
|
1523 | .Ve |
|
|
1524 | .Sp |
|
|
1525 | It is even possible to change the time-out on the fly, regardless of |
|
|
1526 | whether the watcher is active or not: |
|
|
1527 | .Sp |
|
|
1528 | .Vb 2 |
|
|
1529 | \& timer\->repeat = 30.; |
|
|
1530 | \& ev_timer_again (loop, timer); |
|
|
1531 | .Ve |
|
|
1532 | .Sp |
|
|
1533 | This is slightly more efficient then stopping/starting the timer each time |
|
|
1534 | you want to modify its timeout value, as libev does not have to completely |
|
|
1535 | remove and re-insert the timer from/into its internal data structure. |
|
|
1536 | .Sp |
|
|
1537 | It is, however, even simpler than the \*(L"obvious\*(R" way to do it. |
|
|
1538 | .IP "3. Let the timer time out, but then re-arm it as required." 4 |
|
|
1539 | .IX Item "3. Let the timer time out, but then re-arm it as required." |
|
|
1540 | This method is more tricky, but usually most efficient: Most timeouts are |
|
|
1541 | relatively long compared to the intervals between other activity \- in |
|
|
1542 | our example, within 60 seconds, there are usually many I/O events with |
|
|
1543 | associated activity resets. |
|
|
1544 | .Sp |
|
|
1545 | In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, |
|
|
1546 | but remember the time of last activity, and check for a real timeout only |
|
|
1547 | within the callback: |
|
|
1548 | .Sp |
|
|
1549 | .Vb 1 |
|
|
1550 | \& ev_tstamp last_activity; // time of last activity |
|
|
1551 | \& |
|
|
1552 | \& static void |
|
|
1553 | \& callback (EV_P_ ev_timer *w, int revents) |
|
|
1554 | \& { |
|
|
1555 | \& ev_tstamp now = ev_now (EV_A); |
|
|
1556 | \& ev_tstamp timeout = last_activity + 60.; |
|
|
1557 | \& |
|
|
1558 | \& // if last_activity + 60. is older than now, we did time out |
|
|
1559 | \& if (timeout < now) |
|
|
1560 | \& { |
|
|
1561 | \& // timeout occured, take action |
|
|
1562 | \& } |
|
|
1563 | \& else |
|
|
1564 | \& { |
|
|
1565 | \& // callback was invoked, but there was some activity, re\-arm |
|
|
1566 | \& // the watcher to fire in last_activity + 60, which is |
|
|
1567 | \& // guaranteed to be in the future, so "again" is positive: |
|
|
1568 | \& w\->repeat = timeout \- now; |
|
|
1569 | \& ev_timer_again (EV_A_ w); |
|
|
1570 | \& } |
|
|
1571 | \& } |
|
|
1572 | .Ve |
|
|
1573 | .Sp |
|
|
1574 | To summarise the callback: first calculate the real timeout (defined |
|
|
1575 | as \*(L"60 seconds after the last activity\*(R"), then check if that time has |
|
|
1576 | been reached, which means something \fIdid\fR, in fact, time out. Otherwise |
|
|
1577 | the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so |
|
|
1578 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1579 | a timeout then. |
|
|
1580 | .Sp |
|
|
1581 | Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the |
|
|
1582 | \&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running. |
|
|
1583 | .Sp |
|
|
1584 | This scheme causes more callback invocations (about one every 60 seconds |
|
|
1585 | minus half the average time between activity), but virtually no calls to |
|
|
1586 | libev to change the timeout. |
|
|
1587 | .Sp |
|
|
1588 | To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR |
|
|
1589 | to the current time (meaning we just have some activity :), then call the |
|
|
1590 | callback, which will \*(L"do the right thing\*(R" and start the timer: |
|
|
1591 | .Sp |
|
|
1592 | .Vb 3 |
|
|
1593 | \& ev_timer_init (timer, callback); |
|
|
1594 | \& last_activity = ev_now (loop); |
|
|
1595 | \& callback (loop, timer, EV_TIMEOUT); |
|
|
1596 | .Ve |
|
|
1597 | .Sp |
|
|
1598 | And when there is some activity, simply store the current time in |
|
|
1599 | \&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: |
|
|
1600 | .Sp |
|
|
1601 | .Vb 1 |
|
|
1602 | \& last_actiivty = ev_now (loop); |
|
|
1603 | .Ve |
|
|
1604 | .Sp |
|
|
1605 | This technique is slightly more complex, but in most cases where the |
|
|
1606 | time-out is unlikely to be triggered, much more efficient. |
|
|
1607 | .Sp |
|
|
1608 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
1609 | callback :) \- just change the timeout and invoke the callback, which will |
|
|
1610 | fix things for you. |
|
|
1611 | .IP "4. Wee, just use a double-linked list for your timeouts." 4 |
|
|
1612 | .IX Item "4. Wee, just use a double-linked list for your timeouts." |
|
|
1613 | If there is not one request, but many thousands (millions...), all |
|
|
1614 | employing some kind of timeout with the same timeout value, then one can |
|
|
1615 | do even better: |
|
|
1616 | .Sp |
|
|
1617 | When starting the timeout, calculate the timeout value and put the timeout |
|
|
1618 | at the \fIend\fR of the list. |
|
|
1619 | .Sp |
|
|
1620 | Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of |
|
|
1621 | the list is expected to fire (for example, using the technique #3). |
|
|
1622 | .Sp |
|
|
1623 | When there is some activity, remove the timer from the list, recalculate |
|
|
1624 | the timeout, append it to the end of the list again, and make sure to |
|
|
1625 | update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list. |
|
|
1626 | .Sp |
|
|
1627 | This way, one can manage an unlimited number of timeouts in O(1) time for |
|
|
1628 | starting, stopping and updating the timers, at the expense of a major |
|
|
1629 | complication, and having to use a constant timeout. The constant timeout |
|
|
1630 | ensures that the list stays sorted. |
|
|
1631 | .PP |
|
|
1632 | So which method the best? |
|
|
1633 | .PP |
|
|
1634 | Method #2 is a simple no-brain-required solution that is adequate in most |
|
|
1635 | situations. Method #3 requires a bit more thinking, but handles many cases |
|
|
1636 | better, and isn't very complicated either. In most case, choosing either |
|
|
1637 | one is fine, with #3 being better in typical situations. |
|
|
1638 | .PP |
|
|
1639 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
|
|
1640 | rather complicated, but extremely efficient, something that really pays |
|
|
1641 | off after the first million or so of active timers, i.e. it's usually |
|
|
1642 | overkill :) |
|
|
1643 | .PP |
|
|
1644 | \fIThe special problem of time updates\fR |
|
|
1645 | .IX Subsection "The special problem of time updates" |
|
|
1646 | .PP |
|
|
1647 | Establishing the current time is a costly operation (it usually takes at |
|
|
1648 | least two system calls): \s-1EV\s0 therefore updates its idea of the current |
|
|
1649 | time only before and after \f(CW\*(C`ev_loop\*(C'\fR collects new events, which causes a |
|
|
1650 | growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling |
|
|
1651 | lots of events in one iteration. |
1096 | .PP |
1652 | .PP |
1097 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
1653 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
1098 | time. This is usually the right thing as this timestamp refers to the time |
1654 | time. This is usually the right thing as this timestamp refers to the time |
1099 | of the event triggering whatever timeout you are modifying/starting. If |
1655 | of the event triggering whatever timeout you are modifying/starting. If |
1100 | you suspect event processing to be delayed and you \fIneed\fR to base the timeout |
1656 | you suspect event processing to be delayed and you \fIneed\fR to base the |
1101 | on the current time, use something like this to adjust for this: |
1657 | timeout on the current time, use something like this to adjust for this: |
1102 | .PP |
1658 | .PP |
1103 | .Vb 1 |
1659 | .Vb 1 |
1104 | \& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
1660 | \& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); |
1105 | .Ve |
1661 | .Ve |
1106 | .PP |
1662 | .PP |
1107 | The callback is guarenteed to be invoked only when its timeout has passed, |
1663 | If the event loop is suspended for a long time, you can also force an |
1108 | but if multiple timers become ready during the same loop iteration then |
1664 | update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update |
1109 | order of execution is undefined. |
1665 | ()\*(C'\fR. |
|
|
1666 | .PP |
|
|
1667 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1668 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1110 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1669 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1111 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1670 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1112 | .PD 0 |
1671 | .PD 0 |
1113 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1672 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1114 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1673 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1115 | .PD |
1674 | .PD |
1116 | Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is |
1675 | Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR |
1117 | \&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the |
1676 | is \f(CW0.\fR, then it will automatically be stopped once the timeout is |
1118 | timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds |
1677 | reached. If it is positive, then the timer will automatically be |
1119 | later, again, and again, until stopped manually. |
1678 | configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, |
|
|
1679 | until stopped manually. |
1120 | .Sp |
1680 | .Sp |
1121 | The timer itself will do a best-effort at avoiding drift, that is, if you |
1681 | The timer itself will do a best-effort at avoiding drift, that is, if |
1122 | configure a timer to trigger every 10 seconds, then it will trigger at |
1682 | you configure a timer to trigger every 10 seconds, then it will normally |
1123 | exactly 10 second intervals. If, however, your program cannot keep up with |
1683 | trigger at exactly 10 second intervals. If, however, your program cannot |
1124 | the timer (because it takes longer than those 10 seconds to do stuff) the |
1684 | keep up with the timer (because it takes longer than those 10 seconds to |
1125 | timer will not fire more than once per event loop iteration. |
1685 | do stuff) the timer will not fire more than once per event loop iteration. |
1126 | .IP "ev_timer_again (loop)" 4 |
1686 | .IP "ev_timer_again (loop, ev_timer *)" 4 |
1127 | .IX Item "ev_timer_again (loop)" |
1687 | .IX Item "ev_timer_again (loop, ev_timer *)" |
1128 | This will act as if the timer timed out and restart it again if it is |
1688 | This will act as if the timer timed out and restart it again if it is |
1129 | repeating. The exact semantics are: |
1689 | repeating. The exact semantics are: |
1130 | .Sp |
1690 | .Sp |
1131 | If the timer is pending, its pending status is cleared. |
1691 | If the timer is pending, its pending status is cleared. |
1132 | .Sp |
1692 | .Sp |
1133 | If the timer is started but nonrepeating, stop it (as if it timed out). |
1693 | If the timer is started but non-repeating, stop it (as if it timed out). |
1134 | .Sp |
1694 | .Sp |
1135 | If the timer is repeating, either start it if necessary (with the |
1695 | If the timer is repeating, either start it if necessary (with the |
1136 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
1696 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
1137 | .Sp |
1697 | .Sp |
1138 | This sounds a bit complicated, but here is a useful and typical |
1698 | This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a |
1139 | example: Imagine you have a tcp connection and you want a so-called idle |
1699 | usage example. |
1140 | timeout, that is, you want to be called when there have been, say, 60 |
|
|
1141 | seconds of inactivity on the socket. The easiest way to do this is to |
|
|
1142 | 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 |
|
|
1143 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
|
|
1144 | you go into an idle state where you do not expect data to travel on the |
|
|
1145 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
|
|
1146 | automatically restart it if need be. |
|
|
1147 | .Sp |
|
|
1148 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
|
|
1149 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
|
|
1150 | .Sp |
|
|
1151 | .Vb 8 |
|
|
1152 | \& ev_timer_init (timer, callback, 0., 5.); |
|
|
1153 | \& ev_timer_again (loop, timer); |
|
|
1154 | \& ... |
|
|
1155 | \& timer->again = 17.; |
|
|
1156 | \& ev_timer_again (loop, timer); |
|
|
1157 | \& ... |
|
|
1158 | \& timer->again = 10.; |
|
|
1159 | \& ev_timer_again (loop, timer); |
|
|
1160 | .Ve |
|
|
1161 | .Sp |
|
|
1162 | This is more slightly efficient then stopping/starting the timer each time |
|
|
1163 | you want to modify its timeout value. |
|
|
1164 | .IP "ev_tstamp repeat [read\-write]" 4 |
1700 | .IP "ev_tstamp repeat [read\-write]" 4 |
1165 | .IX Item "ev_tstamp repeat [read-write]" |
1701 | .IX Item "ev_tstamp repeat [read-write]" |
1166 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1702 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1167 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
1703 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any), |
1168 | which is also when any modifications are taken into account. |
1704 | which is also when any modifications are taken into account. |
1169 | .PP |
1705 | .PP |
|
|
1706 | \fIExamples\fR |
|
|
1707 | .IX Subsection "Examples" |
|
|
1708 | .PP |
1170 | Example: Create a timer that fires after 60 seconds. |
1709 | Example: Create a timer that fires after 60 seconds. |
1171 | .PP |
1710 | .PP |
1172 | .Vb 5 |
1711 | .Vb 5 |
1173 | \& static void |
1712 | \& static void |
1174 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1713 | \& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents) |
1175 | \& { |
1714 | \& { |
1176 | \& .. one minute over, w is actually stopped right here |
1715 | \& .. one minute over, w is actually stopped right here |
1177 | \& } |
1716 | \& } |
1178 | .Ve |
1717 | \& |
1179 | .PP |
|
|
1180 | .Vb 3 |
|
|
1181 | \& struct ev_timer mytimer; |
1718 | \& ev_timer mytimer; |
1182 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1719 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1183 | \& ev_timer_start (loop, &mytimer); |
1720 | \& ev_timer_start (loop, &mytimer); |
1184 | .Ve |
1721 | .Ve |
1185 | .PP |
1722 | .PP |
1186 | Example: Create a timeout timer that times out after 10 seconds of |
1723 | Example: Create a timeout timer that times out after 10 seconds of |
1187 | inactivity. |
1724 | inactivity. |
1188 | .PP |
1725 | .PP |
1189 | .Vb 5 |
1726 | .Vb 5 |
1190 | \& static void |
1727 | \& static void |
1191 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1728 | \& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents) |
1192 | \& { |
1729 | \& { |
1193 | \& .. ten seconds without any activity |
1730 | \& .. ten seconds without any activity |
1194 | \& } |
1731 | \& } |
1195 | .Ve |
1732 | \& |
1196 | .PP |
|
|
1197 | .Vb 4 |
|
|
1198 | \& struct ev_timer mytimer; |
1733 | \& ev_timer mytimer; |
1199 | \& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1734 | \& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1200 | \& ev_timer_again (&mytimer); /* start timer */ |
1735 | \& ev_timer_again (&mytimer); /* start timer */ |
1201 | \& ev_loop (loop, 0); |
1736 | \& ev_loop (loop, 0); |
1202 | .Ve |
1737 | \& |
1203 | .PP |
|
|
1204 | .Vb 3 |
|
|
1205 | \& // and in some piece of code that gets executed on any "activity": |
1738 | \& // and in some piece of code that gets executed on any "activity": |
1206 | \& // reset the timeout to start ticking again at 10 seconds |
1739 | \& // reset the timeout to start ticking again at 10 seconds |
1207 | \& ev_timer_again (&mytimer); |
1740 | \& ev_timer_again (&mytimer); |
1208 | .Ve |
1741 | .Ve |
1209 | .ie n .Sh """ev_periodic"" \- to cron or not to cron?" |
1742 | .ie n .Sh """ev_periodic"" \- to cron or not to cron?" |
1210 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" |
1743 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" |
1211 | .IX Subsection "ev_periodic - to cron or not to cron?" |
1744 | .IX Subsection "ev_periodic - to cron or not to cron?" |
1212 | Periodic watchers are also timers of a kind, but they are very versatile |
1745 | Periodic watchers are also timers of a kind, but they are very versatile |
1213 | (and unfortunately a bit complex). |
1746 | (and unfortunately a bit complex). |
1214 | .PP |
1747 | .PP |
1215 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
1748 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
1216 | but on wallclock time (absolute time). You can tell a periodic watcher |
1749 | but on wall clock time (absolute time). You can tell a periodic watcher |
1217 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
1750 | to trigger after some specific point in time. For example, if you tell a |
1218 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
1751 | periodic watcher to trigger in 10 seconds (by specifying e.g. \f(CW\*(C`ev_now () |
1219 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
1752 | + 10.\*(C'\fR, that is, an absolute time not a delay) and then reset your system |
|
|
1753 | clock to January of the previous year, then it will take more than year |
1220 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
1754 | to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would still trigger |
1221 | roughly 10 seconds later and of course not if you reset your system time |
1755 | roughly 10 seconds later as it uses a relative timeout). |
1222 | again). |
|
|
1223 | .PP |
1756 | .PP |
1224 | They can also be used to implement vastly more complex timers, such as |
1757 | \&\f(CW\*(C`ev_periodic\*(C'\fRs can also be used to implement vastly more complex timers, |
1225 | triggering an event on eahc midnight, local time. |
1758 | such as triggering an event on each \*(L"midnight, local time\*(R", or other |
|
|
1759 | complicated rules. |
1226 | .PP |
1760 | .PP |
1227 | As with timers, the callback is guarenteed to be invoked only when the |
1761 | As with timers, the callback is guaranteed to be invoked only when the |
1228 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
1762 | time (\f(CW\*(C`at\*(C'\fR) has passed, but if multiple periodic timers become ready |
1229 | during the same loop iteration then order of execution is undefined. |
1763 | during the same loop iteration, then order of execution is undefined. |
|
|
1764 | .PP |
|
|
1765 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1766 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1230 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1767 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
1231 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1768 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
1232 | .PD 0 |
1769 | .PD 0 |
1233 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1770 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
1234 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1771 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
1235 | .PD |
1772 | .PD |
1236 | Lots of arguments, lets sort it out... There are basically three modes of |
1773 | Lots of arguments, lets sort it out... There are basically three modes of |
1237 | operation, and we will explain them from simplest to complex: |
1774 | operation, and we will explain them from simplest to most complex: |
1238 | .RS 4 |
1775 | .RS 4 |
|
|
1776 | .IP "\(bu" 4 |
1239 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
1777 | absolute timer (at = time, interval = reschedule_cb = 0) |
1240 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
1778 | .Sp |
1241 | In this configuration the watcher triggers an event at the wallclock time |
1779 | In this configuration the watcher triggers an event after the wall clock |
1242 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
1780 | time \f(CW\*(C`at\*(C'\fR has passed. It will not repeat and will not adjust when a time |
1243 | that is, if it is to be run at January 1st 2011 then it will run when the |
1781 | jump occurs, that is, if it is to be run at January 1st 2011 then it will |
1244 | system time reaches or surpasses this time. |
1782 | only run when the system clock reaches or surpasses this time. |
|
|
1783 | .IP "\(bu" 4 |
1245 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
1784 | repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) |
1246 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
1785 | .Sp |
1247 | In this mode the watcher will always be scheduled to time out at the next |
1786 | In this mode the watcher will always be scheduled to time out at the next |
1248 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
1787 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) |
1249 | of any time jumps. |
1788 | and then repeat, regardless of any time jumps. |
1250 | .Sp |
1789 | .Sp |
1251 | This can be used to create timers that do not drift with respect to system |
1790 | This can be used to create timers that do not drift with respect to the |
1252 | time: |
1791 | system clock, for example, here is a \f(CW\*(C`ev_periodic\*(C'\fR that triggers each |
|
|
1792 | hour, on the hour: |
1253 | .Sp |
1793 | .Sp |
1254 | .Vb 1 |
1794 | .Vb 1 |
1255 | \& ev_periodic_set (&periodic, 0., 3600., 0); |
1795 | \& ev_periodic_set (&periodic, 0., 3600., 0); |
1256 | .Ve |
1796 | .Ve |
1257 | .Sp |
1797 | .Sp |
1258 | This doesn't mean there will always be 3600 seconds in between triggers, |
1798 | This doesn't mean there will always be 3600 seconds in between triggers, |
1259 | but only that the the callback will be called when the system time shows a |
1799 | but only that the callback will be called when the system time shows a |
1260 | full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible |
1800 | full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible |
1261 | by 3600. |
1801 | by 3600. |
1262 | .Sp |
1802 | .Sp |
1263 | Another way to think about it (for the mathematically inclined) is that |
1803 | Another way to think about it (for the mathematically inclined) is that |
1264 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1804 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1265 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1805 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
1266 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
1806 | .Sp |
1267 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
1807 | For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near |
|
|
1808 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
1809 | this value, and in fact is often specified as zero. |
|
|
1810 | .Sp |
|
|
1811 | Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 |
|
|
1812 | speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability |
|
|
1813 | will of course deteriorate. Libev itself tries to be exact to be about one |
|
|
1814 | millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). |
|
|
1815 | .IP "\(bu" 4 |
|
|
1816 | manual reschedule mode (at and interval ignored, reschedule_cb = callback) |
|
|
1817 | .Sp |
1268 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1818 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
1269 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1819 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1270 | reschedule callback will be called with the watcher as first, and the |
1820 | reschedule callback will be called with the watcher as first, and the |
1271 | current time as second argument. |
1821 | current time as second argument. |
1272 | .Sp |
1822 | .Sp |
1273 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1823 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
1274 | ever, or make any event loop modifications\fR. If you need to stop it, |
1824 | ever, or make \s-1ANY\s0 event loop modifications whatsoever\fR. |
1275 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
|
|
1276 | starting a prepare watcher). |
|
|
1277 | .Sp |
1825 | .Sp |
|
|
1826 | If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop |
|
|
1827 | it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the |
|
|
1828 | only event loop modification you are allowed to do). |
|
|
1829 | .Sp |
1278 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
1830 | The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic |
1279 | ev_tstamp now)\*(C'\fR, e.g.: |
1831 | *w, ev_tstamp now)\*(C'\fR, e.g.: |
1280 | .Sp |
1832 | .Sp |
1281 | .Vb 4 |
1833 | .Vb 5 |
|
|
1834 | \& static ev_tstamp |
1282 | \& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
1835 | \& my_rescheduler (ev_periodic *w, ev_tstamp now) |
1283 | \& { |
1836 | \& { |
1284 | \& return now + 60.; |
1837 | \& return now + 60.; |
1285 | \& } |
1838 | \& } |
1286 | .Ve |
1839 | .Ve |
1287 | .Sp |
1840 | .Sp |
1288 | It must return the next time to trigger, based on the passed time value |
1841 | It must return the next time to trigger, based on the passed time value |
1289 | (that is, the lowest time value larger than to the second argument). It |
1842 | (that is, the lowest time value larger than to the second argument). It |
1290 | will usually be called just before the callback will be triggered, but |
1843 | will usually be called just before the callback will be triggered, but |
1291 | might be called at other times, too. |
1844 | might be called at other times, too. |
1292 | .Sp |
1845 | .Sp |
1293 | \&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the |
1846 | \&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or |
1294 | passed \f(CI\*(C`now\*(C'\fI value\fR. Not even \f(CW\*(C`now\*(C'\fR itself will do, it \fImust\fR be larger. |
1847 | equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. |
1295 | .Sp |
1848 | .Sp |
1296 | This can be used to create very complex timers, such as a timer that |
1849 | This can be used to create very complex timers, such as a timer that |
1297 | triggers on each midnight, local time. To do this, you would calculate the |
1850 | triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the |
1298 | next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How |
1851 | next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How |
1299 | you do this is, again, up to you (but it is not trivial, which is the main |
1852 | you do this is, again, up to you (but it is not trivial, which is the main |
1300 | reason I omitted it as an example). |
1853 | reason I omitted it as an example). |
1301 | .RE |
1854 | .RE |
1302 | .RS 4 |
1855 | .RS 4 |
… | |
… | |
1305 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1858 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1306 | Simply stops and restarts the periodic watcher again. This is only useful |
1859 | Simply stops and restarts the periodic watcher again. This is only useful |
1307 | when you changed some parameters or the reschedule callback would return |
1860 | when you changed some parameters or the reschedule callback would return |
1308 | a different time than the last time it was called (e.g. in a crond like |
1861 | a different time than the last time it was called (e.g. in a crond like |
1309 | program when the crontabs have changed). |
1862 | program when the crontabs have changed). |
|
|
1863 | .IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4 |
|
|
1864 | .IX Item "ev_tstamp ev_periodic_at (ev_periodic *)" |
|
|
1865 | When active, returns the absolute time that the watcher is supposed to |
|
|
1866 | trigger next. |
|
|
1867 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
1868 | .IX Item "ev_tstamp offset [read-write]" |
|
|
1869 | When repeating, this contains the offset value, otherwise this is the |
|
|
1870 | absolute point in time (the \f(CW\*(C`at\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR). |
|
|
1871 | .Sp |
|
|
1872 | Can be modified any time, but changes only take effect when the periodic |
|
|
1873 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1310 | .IP "ev_tstamp interval [read\-write]" 4 |
1874 | .IP "ev_tstamp interval [read\-write]" 4 |
1311 | .IX Item "ev_tstamp interval [read-write]" |
1875 | .IX Item "ev_tstamp interval [read-write]" |
1312 | The current interval value. Can be modified any time, but changes only |
1876 | The current interval value. Can be modified any time, but changes only |
1313 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1877 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1314 | called. |
1878 | called. |
1315 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1879 | .IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1316 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
1880 | .IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]" |
1317 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1881 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1318 | switched off. Can be changed any time, but changes only take effect when |
1882 | switched off. Can be changed any time, but changes only take effect when |
1319 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1883 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1320 | .PP |
1884 | .PP |
|
|
1885 | \fIExamples\fR |
|
|
1886 | .IX Subsection "Examples" |
|
|
1887 | .PP |
1321 | Example: Call a callback every hour, or, more precisely, whenever the |
1888 | Example: Call a callback every hour, or, more precisely, whenever the |
1322 | system clock is divisible by 3600. The callback invocation times have |
1889 | system time is divisible by 3600. The callback invocation times have |
1323 | potentially a lot of jittering, but good long-term stability. |
1890 | potentially a lot of jitter, but good long-term stability. |
1324 | .PP |
1891 | .PP |
1325 | .Vb 5 |
1892 | .Vb 5 |
1326 | \& static void |
1893 | \& static void |
1327 | \& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1894 | \& clock_cb (struct ev_loop *loop, ev_io *w, int revents) |
1328 | \& { |
1895 | \& { |
1329 | \& ... its now a full hour (UTC, or TAI or whatever your clock follows) |
1896 | \& ... its now a full hour (UTC, or TAI or whatever your clock follows) |
1330 | \& } |
1897 | \& } |
1331 | .Ve |
1898 | \& |
1332 | .PP |
|
|
1333 | .Vb 3 |
|
|
1334 | \& struct ev_periodic hourly_tick; |
1899 | \& ev_periodic hourly_tick; |
1335 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1900 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1336 | \& ev_periodic_start (loop, &hourly_tick); |
1901 | \& ev_periodic_start (loop, &hourly_tick); |
1337 | .Ve |
1902 | .Ve |
1338 | .PP |
1903 | .PP |
1339 | Example: The same as above, but use a reschedule callback to do it: |
1904 | Example: The same as above, but use a reschedule callback to do it: |
1340 | .PP |
1905 | .PP |
1341 | .Vb 1 |
1906 | .Vb 1 |
1342 | \& #include <math.h> |
1907 | \& #include <math.h> |
1343 | .Ve |
1908 | \& |
1344 | .PP |
|
|
1345 | .Vb 5 |
|
|
1346 | \& static ev_tstamp |
1909 | \& static ev_tstamp |
1347 | \& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
1910 | \& my_scheduler_cb (ev_periodic *w, ev_tstamp now) |
1348 | \& { |
1911 | \& { |
1349 | \& return fmod (now, 3600.) + 3600.; |
1912 | \& return now + (3600. \- fmod (now, 3600.)); |
1350 | \& } |
1913 | \& } |
1351 | .Ve |
1914 | \& |
1352 | .PP |
|
|
1353 | .Vb 1 |
|
|
1354 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1915 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1355 | .Ve |
1916 | .Ve |
1356 | .PP |
1917 | .PP |
1357 | Example: Call a callback every hour, starting now: |
1918 | Example: Call a callback every hour, starting now: |
1358 | .PP |
1919 | .PP |
1359 | .Vb 4 |
1920 | .Vb 4 |
1360 | \& struct ev_periodic hourly_tick; |
1921 | \& ev_periodic hourly_tick; |
1361 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1922 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1362 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1923 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1363 | \& ev_periodic_start (loop, &hourly_tick); |
1924 | \& ev_periodic_start (loop, &hourly_tick); |
1364 | .Ve |
1925 | .Ve |
1365 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" |
1926 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" |
1366 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" |
1927 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" |
1367 | .IX Subsection "ev_signal - signal me when a signal gets signalled!" |
1928 | .IX Subsection "ev_signal - signal me when a signal gets signalled!" |
1368 | Signal watchers will trigger an event when the process receives a specific |
1929 | Signal watchers will trigger an event when the process receives a specific |
1369 | signal one or more times. Even though signals are very asynchronous, libev |
1930 | signal one or more times. Even though signals are very asynchronous, libev |
1370 | will try it's best to deliver signals synchronously, i.e. as part of the |
1931 | will try it's best to deliver signals synchronously, i.e. as part of the |
1371 | normal event processing, like any other event. |
1932 | normal event processing, like any other event. |
1372 | .PP |
1933 | .PP |
|
|
1934 | If you want signals asynchronously, just use \f(CW\*(C`sigaction\*(C'\fR as you would |
|
|
1935 | do without libev and forget about sharing the signal. You can even use |
|
|
1936 | \&\f(CW\*(C`ev_async\*(C'\fR from a signal handler to synchronously wake up an event loop. |
|
|
1937 | .PP |
1373 | You can configure as many watchers as you like per signal. Only when the |
1938 | You can configure as many watchers as you like per signal. Only when the |
1374 | first watcher gets started will libev actually register a signal watcher |
1939 | first watcher gets started will libev actually register a signal handler |
1375 | with the kernel (thus it coexists with your own signal handlers as long |
1940 | with the kernel (thus it coexists with your own signal handlers as long as |
1376 | as you don't register any with libev). Similarly, when the last signal |
1941 | you don't register any with libev for the same signal). Similarly, when |
1377 | watcher for a signal is stopped libev will reset the signal handler to |
1942 | the last signal watcher for a signal is stopped, libev will reset the |
1378 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
1943 | signal handler to \s-1SIG_DFL\s0 (regardless of what it was set to before). |
|
|
1944 | .PP |
|
|
1945 | If possible and supported, libev will install its handlers with |
|
|
1946 | \&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so system calls should not be unduly |
|
|
1947 | interrupted. If you have a problem with system calls getting interrupted by |
|
|
1948 | signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock |
|
|
1949 | them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher. |
|
|
1950 | .PP |
|
|
1951 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
1952 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1379 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1953 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1380 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1954 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1381 | .PD 0 |
1955 | .PD 0 |
1382 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1956 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1383 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
1957 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
… | |
… | |
1385 | Configures the watcher to trigger on the given signal number (usually one |
1959 | Configures the watcher to trigger on the given signal number (usually one |
1386 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
1960 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
1387 | .IP "int signum [read\-only]" 4 |
1961 | .IP "int signum [read\-only]" 4 |
1388 | .IX Item "int signum [read-only]" |
1962 | .IX Item "int signum [read-only]" |
1389 | The signal the watcher watches out for. |
1963 | The signal the watcher watches out for. |
|
|
1964 | .PP |
|
|
1965 | \fIExamples\fR |
|
|
1966 | .IX Subsection "Examples" |
|
|
1967 | .PP |
|
|
1968 | Example: Try to exit cleanly on \s-1SIGINT\s0. |
|
|
1969 | .PP |
|
|
1970 | .Vb 5 |
|
|
1971 | \& static void |
|
|
1972 | \& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) |
|
|
1973 | \& { |
|
|
1974 | \& ev_unloop (loop, EVUNLOOP_ALL); |
|
|
1975 | \& } |
|
|
1976 | \& |
|
|
1977 | \& ev_signal signal_watcher; |
|
|
1978 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
|
|
1979 | \& ev_signal_start (loop, &signal_watcher); |
|
|
1980 | .Ve |
1390 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1981 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
1391 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1982 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
1392 | .IX Subsection "ev_child - watch out for process status changes" |
1983 | .IX Subsection "ev_child - watch out for process status changes" |
1393 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1984 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1394 | some child status changes (most typically when a child of yours dies). |
1985 | some child status changes (most typically when a child of yours dies or |
|
|
1986 | exits). It is permissible to install a child watcher \fIafter\fR the child |
|
|
1987 | has been forked (which implies it might have already exited), as long |
|
|
1988 | as the event loop isn't entered (or is continued from a watcher), i.e., |
|
|
1989 | forking and then immediately registering a watcher for the child is fine, |
|
|
1990 | but forking and registering a watcher a few event loop iterations later is |
|
|
1991 | not. |
|
|
1992 | .PP |
|
|
1993 | Only the default event loop is capable of handling signals, and therefore |
|
|
1994 | you can only register child watchers in the default event loop. |
|
|
1995 | .PP |
|
|
1996 | \fIProcess Interaction\fR |
|
|
1997 | .IX Subsection "Process Interaction" |
|
|
1998 | .PP |
|
|
1999 | Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is |
|
|
2000 | initialised. This is necessary to guarantee proper behaviour even if |
|
|
2001 | the first child watcher is started after the child exits. The occurrence |
|
|
2002 | of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done |
|
|
2003 | synchronously as part of the event loop processing. Libev always reaps all |
|
|
2004 | children, even ones not watched. |
|
|
2005 | .PP |
|
|
2006 | \fIOverriding the Built-In Processing\fR |
|
|
2007 | .IX Subsection "Overriding the Built-In Processing" |
|
|
2008 | .PP |
|
|
2009 | Libev offers no special support for overriding the built-in child |
|
|
2010 | processing, but if your application collides with libev's default child |
|
|
2011 | handler, you can override it easily by installing your own handler for |
|
|
2012 | \&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the |
|
|
2013 | default loop never gets destroyed. You are encouraged, however, to use an |
|
|
2014 | event-based approach to child reaping and thus use libev's support for |
|
|
2015 | that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely. |
|
|
2016 | .PP |
|
|
2017 | \fIStopping the Child Watcher\fR |
|
|
2018 | .IX Subsection "Stopping the Child Watcher" |
|
|
2019 | .PP |
|
|
2020 | Currently, the child watcher never gets stopped, even when the |
|
|
2021 | child terminates, so normally one needs to stop the watcher in the |
|
|
2022 | callback. Future versions of libev might stop the watcher automatically |
|
|
2023 | when a child exit is detected. |
|
|
2024 | .PP |
|
|
2025 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2026 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1395 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
2027 | .IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4 |
1396 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
2028 | .IX Item "ev_child_init (ev_child *, callback, int pid, int trace)" |
1397 | .PD 0 |
2029 | .PD 0 |
1398 | .IP "ev_child_set (ev_child *, int pid)" 4 |
2030 | .IP "ev_child_set (ev_child *, int pid, int trace)" 4 |
1399 | .IX Item "ev_child_set (ev_child *, int pid)" |
2031 | .IX Item "ev_child_set (ev_child *, int pid, int trace)" |
1400 | .PD |
2032 | .PD |
1401 | Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or |
2033 | Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or |
1402 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
2034 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
1403 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
2035 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
1404 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
2036 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
1405 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
2037 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
1406 | process causing the status change. |
2038 | process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only |
|
|
2039 | activate the watcher when the process terminates) or \f(CW1\fR (additionally |
|
|
2040 | activate the watcher when the process is stopped or continued). |
1407 | .IP "int pid [read\-only]" 4 |
2041 | .IP "int pid [read\-only]" 4 |
1408 | .IX Item "int pid [read-only]" |
2042 | .IX Item "int pid [read-only]" |
1409 | The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. |
2043 | The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. |
1410 | .IP "int rpid [read\-write]" 4 |
2044 | .IP "int rpid [read\-write]" 4 |
1411 | .IX Item "int rpid [read-write]" |
2045 | .IX Item "int rpid [read-write]" |
… | |
… | |
1413 | .IP "int rstatus [read\-write]" 4 |
2047 | .IP "int rstatus [read\-write]" 4 |
1414 | .IX Item "int rstatus [read-write]" |
2048 | .IX Item "int rstatus [read-write]" |
1415 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
2049 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
1416 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
2050 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1417 | .PP |
2051 | .PP |
1418 | Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
2052 | \fIExamples\fR |
|
|
2053 | .IX Subsection "Examples" |
1419 | .PP |
2054 | .PP |
|
|
2055 | Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for |
|
|
2056 | its completion. |
|
|
2057 | .PP |
1420 | .Vb 5 |
2058 | .Vb 1 |
|
|
2059 | \& ev_child cw; |
|
|
2060 | \& |
1421 | \& static void |
2061 | \& static void |
1422 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
2062 | \& child_cb (EV_P_ ev_child *w, int revents) |
1423 | \& { |
2063 | \& { |
1424 | \& ev_unloop (loop, EVUNLOOP_ALL); |
2064 | \& ev_child_stop (EV_A_ w); |
|
|
2065 | \& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus); |
1425 | \& } |
2066 | \& } |
1426 | .Ve |
2067 | \& |
1427 | .PP |
2068 | \& pid_t pid = fork (); |
1428 | .Vb 3 |
2069 | \& |
1429 | \& struct ev_signal signal_watcher; |
2070 | \& if (pid < 0) |
1430 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
2071 | \& // error |
1431 | \& ev_signal_start (loop, &sigint_cb); |
2072 | \& else if (pid == 0) |
|
|
2073 | \& { |
|
|
2074 | \& // the forked child executes here |
|
|
2075 | \& exit (1); |
|
|
2076 | \& } |
|
|
2077 | \& else |
|
|
2078 | \& { |
|
|
2079 | \& ev_child_init (&cw, child_cb, pid, 0); |
|
|
2080 | \& ev_child_start (EV_DEFAULT_ &cw); |
|
|
2081 | \& } |
1432 | .Ve |
2082 | .Ve |
1433 | .ie n .Sh """ev_stat"" \- did the file attributes just change?" |
2083 | .ie n .Sh """ev_stat"" \- did the file attributes just change?" |
1434 | .el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" |
2084 | .el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" |
1435 | .IX Subsection "ev_stat - did the file attributes just change?" |
2085 | .IX Subsection "ev_stat - did the file attributes just change?" |
1436 | This watches a filesystem path for attribute changes. That is, it calls |
2086 | This watches a file system path for attribute changes. That is, it calls |
1437 | \&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed |
2087 | \&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) |
1438 | compared to the last time, invoking the callback if it did. |
2088 | and sees if it changed compared to the last time, invoking the callback if |
|
|
2089 | it did. |
1439 | .PP |
2090 | .PP |
1440 | The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does |
2091 | The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does |
1441 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
2092 | not exist\*(R" is a status change like any other. The condition \*(L"path does not |
1442 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
2093 | exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the |
1443 | otherwise always forced to be at least one) and all the other fields of |
2094 | \&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at |
1444 | the stat buffer having unspecified contents. |
2095 | least one) and all the other fields of the stat buffer having unspecified |
|
|
2096 | contents. |
1445 | .PP |
2097 | .PP |
1446 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
2098 | The path \fImust not\fR end in a slash or contain special components such as |
|
|
2099 | \&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and |
1447 | relative and your working directory changes, the behaviour is undefined. |
2100 | your working directory changes, then the behaviour is undefined. |
1448 | .PP |
2101 | .PP |
1449 | Since there is no standard to do this, the portable implementation simply |
2102 | Since there is no portable change notification interface available, the |
1450 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
2103 | portable implementation simply calls \f(CWstat(2)\fR regularly on the path |
1451 | can specify a recommended polling interval for this case. If you specify |
2104 | to see if it changed somehow. You can specify a recommended polling |
1452 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
2105 | interval for this case. If you specify a polling interval of \f(CW0\fR (highly |
1453 | unspecified default\fR value will be used (which you can expect to be around |
2106 | recommended!) then a \fIsuitable, unspecified default\fR value will be used |
1454 | five seconds, although this might change dynamically). Libev will also |
2107 | (which you can expect to be around five seconds, although this might |
1455 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
2108 | change dynamically). Libev will also impose a minimum interval which is |
1456 | usually overkill. |
2109 | currently around \f(CW0.1\fR, but that's usually overkill. |
1457 | .PP |
2110 | .PP |
1458 | This watcher type is not meant for massive numbers of stat watchers, |
2111 | This watcher type is not meant for massive numbers of stat watchers, |
1459 | as even with OS-supported change notifications, this can be |
2112 | as even with OS-supported change notifications, this can be |
1460 | resource\-intensive. |
2113 | resource-intensive. |
1461 | .PP |
2114 | .PP |
1462 | At the time of this writing, only the Linux inotify interface is |
2115 | At the time of this writing, the only OS-specific interface implemented |
1463 | implemented (implementing kqueue support is left as an exercise for the |
2116 | is the Linux inotify interface (implementing kqueue support is left as an |
1464 | reader). Inotify will be used to give hints only and should not change the |
2117 | exercise for the reader. Note, however, that the author sees no way of |
1465 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
2118 | implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue, except as a hint). |
1466 | to fall back to regular polling again even with inotify, but changes are |
2119 | .PP |
1467 | usually detected immediately, and if the file exists there will be no |
2120 | \fI\s-1ABI\s0 Issues (Largefile Support)\fR |
1468 | polling. |
2121 | .IX Subsection "ABI Issues (Largefile Support)" |
|
|
2122 | .PP |
|
|
2123 | Libev by default (unless the user overrides this) uses the default |
|
|
2124 | compilation environment, which means that on systems with large file |
|
|
2125 | support disabled by default, you get the 32 bit version of the stat |
|
|
2126 | structure. When using the library from programs that change the \s-1ABI\s0 to |
|
|
2127 | use 64 bit file offsets the programs will fail. In that case you have to |
|
|
2128 | compile libev with the same flags to get binary compatibility. This is |
|
|
2129 | obviously the case with any flags that change the \s-1ABI\s0, but the problem is |
|
|
2130 | most noticeably displayed with ev_stat and large file support. |
|
|
2131 | .PP |
|
|
2132 | The solution for this is to lobby your distribution maker to make large |
|
|
2133 | file interfaces available by default (as e.g. FreeBSD does) and not |
|
|
2134 | optional. Libev cannot simply switch on large file support because it has |
|
|
2135 | to exchange stat structures with application programs compiled using the |
|
|
2136 | default compilation environment. |
|
|
2137 | .PP |
|
|
2138 | \fIInotify and Kqueue\fR |
|
|
2139 | .IX Subsection "Inotify and Kqueue" |
|
|
2140 | .PP |
|
|
2141 | When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev and present at |
|
|
2142 | runtime, it will be used to speed up change detection where possible. The |
|
|
2143 | inotify descriptor will be created lazily when the first \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2144 | watcher is being started. |
|
|
2145 | .PP |
|
|
2146 | Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers |
|
|
2147 | except that changes might be detected earlier, and in some cases, to avoid |
|
|
2148 | making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support |
|
|
2149 | there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling, |
|
|
2150 | but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too |
|
|
2151 | many bugs), the path exists (i.e. stat succeeds), and the path resides on |
|
|
2152 | a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and |
|
|
2153 | xfs are fully working) libev usually gets away without polling. |
|
|
2154 | .PP |
|
|
2155 | There is no support for kqueue, as apparently it cannot be used to |
|
|
2156 | implement this functionality, due to the requirement of having a file |
|
|
2157 | descriptor open on the object at all times, and detecting renames, unlinks |
|
|
2158 | etc. is difficult. |
|
|
2159 | .PP |
|
|
2160 | \fI\f(CI\*(C`stat ()\*(C'\fI is a synchronous operation\fR |
|
|
2161 | .IX Subsection "stat () is a synchronous operation" |
|
|
2162 | .PP |
|
|
2163 | Libev doesn't normally do any kind of I/O itself, and so is not blocking |
|
|
2164 | the process. The exception are \f(CW\*(C`ev_stat\*(C'\fR watchers \- those call \f(CW\*(C`stat |
|
|
2165 | ()\*(C'\fR, which is a synchronous operation. |
|
|
2166 | .PP |
|
|
2167 | For local paths, this usually doesn't matter: unless the system is very |
|
|
2168 | busy or the intervals between stat's are large, a stat call will be fast, |
|
|
2169 | as the path data is usually in memory already (except when starting the |
|
|
2170 | watcher). |
|
|
2171 | .PP |
|
|
2172 | For networked file systems, calling \f(CW\*(C`stat ()\*(C'\fR can block an indefinite |
|
|
2173 | time due to network issues, and even under good conditions, a stat call |
|
|
2174 | often takes multiple milliseconds. |
|
|
2175 | .PP |
|
|
2176 | Therefore, it is best to avoid using \f(CW\*(C`ev_stat\*(C'\fR watchers on networked |
|
|
2177 | paths, although this is fully supported by libev. |
|
|
2178 | .PP |
|
|
2179 | \fIThe special problem of stat time resolution\fR |
|
|
2180 | .IX Subsection "The special problem of stat time resolution" |
|
|
2181 | .PP |
|
|
2182 | The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably, |
|
|
2183 | and even on systems where the resolution is higher, most file systems |
|
|
2184 | still only support whole seconds. |
|
|
2185 | .PP |
|
|
2186 | That means that, if the time is the only thing that changes, you can |
|
|
2187 | easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and |
|
|
2188 | calls your callback, which does something. When there is another update |
|
|
2189 | within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the |
|
|
2190 | stat data does change in other ways (e.g. file size). |
|
|
2191 | .PP |
|
|
2192 | The solution to this is to delay acting on a change for slightly more |
|
|
2193 | than a second (or till slightly after the next full second boundary), using |
|
|
2194 | a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02); |
|
|
2195 | ev_timer_again (loop, w)\*(C'\fR). |
|
|
2196 | .PP |
|
|
2197 | The \f(CW.02\fR offset is added to work around small timing inconsistencies |
|
|
2198 | of some operating systems (where the second counter of the current time |
|
|
2199 | might be be delayed. One such system is the Linux kernel, where a call to |
|
|
2200 | \&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than |
|
|
2201 | a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to |
|
|
2202 | update file times then there will be a small window where the kernel uses |
|
|
2203 | the previous second to update file times but libev might already execute |
|
|
2204 | the timer callback). |
|
|
2205 | .PP |
|
|
2206 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2207 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1469 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
2208 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1470 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
2209 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1471 | .PD 0 |
2210 | .PD 0 |
1472 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
2211 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1473 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
2212 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1476 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
2215 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
1477 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
2216 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
1478 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
2217 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
1479 | path for as long as the watcher is active. |
2218 | path for as long as the watcher is active. |
1480 | .Sp |
2219 | .Sp |
1481 | The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, |
2220 | The callback will receive an \f(CW\*(C`EV_STAT\*(C'\fR event when a change was detected, |
1482 | relative to the attributes at the time the watcher was started (or the |
2221 | relative to the attributes at the time the watcher was started (or the |
1483 | last change was detected). |
2222 | last change was detected). |
1484 | .IP "ev_stat_stat (ev_stat *)" 4 |
2223 | .IP "ev_stat_stat (loop, ev_stat *)" 4 |
1485 | .IX Item "ev_stat_stat (ev_stat *)" |
2224 | .IX Item "ev_stat_stat (loop, ev_stat *)" |
1486 | Updates the stat buffer immediately with new values. If you change the |
2225 | Updates the stat buffer immediately with new values. If you change the |
1487 | watched path in your callback, you could call this fucntion to avoid |
2226 | watched path in your callback, you could call this function to avoid |
1488 | detecting this change (while introducing a race condition). Can also be |
2227 | detecting this change (while introducing a race condition if you are not |
1489 | useful simply to find out the new values. |
2228 | the only one changing the path). Can also be useful simply to find out the |
|
|
2229 | new values. |
1490 | .IP "ev_statdata attr [read\-only]" 4 |
2230 | .IP "ev_statdata attr [read\-only]" 4 |
1491 | .IX Item "ev_statdata attr [read-only]" |
2231 | .IX Item "ev_statdata attr [read-only]" |
1492 | The most-recently detected attributes of the file. Although the type is of |
2232 | The most-recently detected attributes of the file. Although the type is |
1493 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
2233 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
|
|
2234 | suitable for your system, but you can only rely on the POSIX-standardised |
1494 | suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there |
2235 | members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was |
1495 | was some error while \f(CW\*(C`stat\*(C'\fRing the file. |
2236 | some error while \f(CW\*(C`stat\*(C'\fRing the file. |
1496 | .IP "ev_statdata prev [read\-only]" 4 |
2237 | .IP "ev_statdata prev [read\-only]" 4 |
1497 | .IX Item "ev_statdata prev [read-only]" |
2238 | .IX Item "ev_statdata prev [read-only]" |
1498 | The previous attributes of the file. The callback gets invoked whenever |
2239 | The previous attributes of the file. The callback gets invoked whenever |
1499 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. |
2240 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members |
|
|
2241 | differ: \f(CW\*(C`st_dev\*(C'\fR, \f(CW\*(C`st_ino\*(C'\fR, \f(CW\*(C`st_mode\*(C'\fR, \f(CW\*(C`st_nlink\*(C'\fR, \f(CW\*(C`st_uid\*(C'\fR, |
|
|
2242 | \&\f(CW\*(C`st_gid\*(C'\fR, \f(CW\*(C`st_rdev\*(C'\fR, \f(CW\*(C`st_size\*(C'\fR, \f(CW\*(C`st_atime\*(C'\fR, \f(CW\*(C`st_mtime\*(C'\fR, \f(CW\*(C`st_ctime\*(C'\fR. |
1500 | .IP "ev_tstamp interval [read\-only]" 4 |
2243 | .IP "ev_tstamp interval [read\-only]" 4 |
1501 | .IX Item "ev_tstamp interval [read-only]" |
2244 | .IX Item "ev_tstamp interval [read-only]" |
1502 | The specified interval. |
2245 | The specified interval. |
1503 | .IP "const char *path [read\-only]" 4 |
2246 | .IP "const char *path [read\-only]" 4 |
1504 | .IX Item "const char *path [read-only]" |
2247 | .IX Item "const char *path [read-only]" |
1505 | The filesystem path that is being watched. |
2248 | The file system path that is being watched. |
|
|
2249 | .PP |
|
|
2250 | \fIExamples\fR |
|
|
2251 | .IX Subsection "Examples" |
1506 | .PP |
2252 | .PP |
1507 | Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. |
2253 | Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. |
1508 | .PP |
2254 | .PP |
1509 | .Vb 15 |
2255 | .Vb 10 |
1510 | \& static void |
2256 | \& static void |
1511 | \& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
2257 | \& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1512 | \& { |
2258 | \& { |
1513 | \& /* /etc/passwd changed in some way */ |
2259 | \& /* /etc/passwd changed in some way */ |
1514 | \& if (w->attr.st_nlink) |
2260 | \& if (w\->attr.st_nlink) |
1515 | \& { |
2261 | \& { |
1516 | \& printf ("passwd current size %ld\en", (long)w->attr.st_size); |
2262 | \& printf ("passwd current size %ld\en", (long)w\->attr.st_size); |
1517 | \& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); |
2263 | \& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime); |
1518 | \& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); |
2264 | \& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime); |
1519 | \& } |
2265 | \& } |
1520 | \& else |
2266 | \& else |
1521 | \& /* you shalt not abuse printf for puts */ |
2267 | \& /* you shalt not abuse printf for puts */ |
1522 | \& puts ("wow, /etc/passwd is not there, expect problems. " |
2268 | \& puts ("wow, /etc/passwd is not there, expect problems. " |
1523 | \& "if this is windows, they already arrived\en"); |
2269 | \& "if this is windows, they already arrived\en"); |
1524 | \& } |
2270 | \& } |
|
|
2271 | \& |
|
|
2272 | \& ... |
|
|
2273 | \& ev_stat passwd; |
|
|
2274 | \& |
|
|
2275 | \& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
|
|
2276 | \& ev_stat_start (loop, &passwd); |
1525 | .Ve |
2277 | .Ve |
|
|
2278 | .PP |
|
|
2279 | Example: Like above, but additionally use a one-second delay so we do not |
|
|
2280 | miss updates (however, frequent updates will delay processing, too, so |
|
|
2281 | one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on |
|
|
2282 | \&\f(CW\*(C`ev_timer\*(C'\fR callback invocation). |
1526 | .PP |
2283 | .PP |
1527 | .Vb 2 |
2284 | .Vb 2 |
|
|
2285 | \& static ev_stat passwd; |
|
|
2286 | \& static ev_timer timer; |
|
|
2287 | \& |
|
|
2288 | \& static void |
|
|
2289 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
2290 | \& { |
|
|
2291 | \& ev_timer_stop (EV_A_ w); |
|
|
2292 | \& |
|
|
2293 | \& /* now it\*(Aqs one second after the most recent passwd change */ |
|
|
2294 | \& } |
|
|
2295 | \& |
|
|
2296 | \& static void |
|
|
2297 | \& stat_cb (EV_P_ ev_stat *w, int revents) |
|
|
2298 | \& { |
|
|
2299 | \& /* reset the one\-second timer */ |
|
|
2300 | \& ev_timer_again (EV_A_ &timer); |
|
|
2301 | \& } |
|
|
2302 | \& |
1528 | \& ... |
2303 | \& ... |
1529 | \& ev_stat passwd; |
|
|
1530 | .Ve |
|
|
1531 | .PP |
|
|
1532 | .Vb 2 |
|
|
1533 | \& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
2304 | \& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
1534 | \& ev_stat_start (loop, &passwd); |
2305 | \& ev_stat_start (loop, &passwd); |
|
|
2306 | \& ev_timer_init (&timer, timer_cb, 0., 1.02); |
1535 | .Ve |
2307 | .Ve |
1536 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
2308 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
1537 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
2309 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1538 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
2310 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1539 | Idle watchers trigger events when no other events of the same or higher |
2311 | Idle watchers trigger events when no other events of the same or higher |
1540 | priority are pending (prepare, check and other idle watchers do not |
2312 | priority are pending (prepare, check and other idle watchers do not count |
1541 | count). |
2313 | as receiving \*(L"events\*(R"). |
1542 | .PP |
2314 | .PP |
1543 | That is, as long as your process is busy handling sockets or timeouts |
2315 | That is, as long as your process is busy handling sockets or timeouts |
1544 | (or even signals, imagine) of the same or higher priority it will not be |
2316 | (or even signals, imagine) of the same or higher priority it will not be |
1545 | triggered. But when your process is idle (or only lower-priority watchers |
2317 | triggered. But when your process is idle (or only lower-priority watchers |
1546 | are pending), the idle watchers are being called once per event loop |
2318 | are pending), the idle watchers are being called once per event loop |
… | |
… | |
1550 | The most noteworthy effect is that as long as any idle watchers are |
2322 | The most noteworthy effect is that as long as any idle watchers are |
1551 | active, the process will not block when waiting for new events. |
2323 | active, the process will not block when waiting for new events. |
1552 | .PP |
2324 | .PP |
1553 | Apart from keeping your process non-blocking (which is a useful |
2325 | Apart from keeping your process non-blocking (which is a useful |
1554 | effect on its own sometimes), idle watchers are a good place to do |
2326 | effect on its own sometimes), idle watchers are a good place to do |
1555 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
2327 | \&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the |
1556 | event loop has handled all outstanding events. |
2328 | event loop has handled all outstanding events. |
|
|
2329 | .PP |
|
|
2330 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2331 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1557 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
2332 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
1558 | .IX Item "ev_idle_init (ev_signal *, callback)" |
2333 | .IX Item "ev_idle_init (ev_signal *, callback)" |
1559 | Initialises and configures the idle watcher \- it has no parameters of any |
2334 | Initialises and configures the idle watcher \- it has no parameters of any |
1560 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
2335 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1561 | believe me. |
2336 | believe me. |
1562 | .PP |
2337 | .PP |
|
|
2338 | \fIExamples\fR |
|
|
2339 | .IX Subsection "Examples" |
|
|
2340 | .PP |
1563 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
2341 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
1564 | callback, free it. Also, use no error checking, as usual. |
2342 | callback, free it. Also, use no error checking, as usual. |
1565 | .PP |
2343 | .PP |
1566 | .Vb 7 |
2344 | .Vb 7 |
1567 | \& static void |
2345 | \& static void |
1568 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
2346 | \& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
1569 | \& { |
2347 | \& { |
1570 | \& free (w); |
2348 | \& free (w); |
1571 | \& // now do something you wanted to do when the program has |
2349 | \& // now do something you wanted to do when the program has |
1572 | \& // no longer asnything immediate to do. |
2350 | \& // no longer anything immediate to do. |
1573 | \& } |
2351 | \& } |
1574 | .Ve |
2352 | \& |
1575 | .PP |
|
|
1576 | .Vb 3 |
|
|
1577 | \& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
2353 | \& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
1578 | \& ev_idle_init (idle_watcher, idle_cb); |
2354 | \& ev_idle_init (idle_watcher, idle_cb); |
1579 | \& ev_idle_start (loop, idle_cb); |
2355 | \& ev_idle_start (loop, idle_cb); |
1580 | .Ve |
2356 | .Ve |
1581 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" |
2357 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" |
1582 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" |
2358 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" |
1583 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
2359 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
1584 | Prepare and check watchers are usually (but not always) used in tandem: |
2360 | Prepare and check watchers are usually (but not always) used in pairs: |
1585 | prepare watchers get invoked before the process blocks and check watchers |
2361 | prepare watchers get invoked before the process blocks and check watchers |
1586 | afterwards. |
2362 | afterwards. |
1587 | .PP |
2363 | .PP |
1588 | You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter |
2364 | You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter |
1589 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
2365 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
… | |
… | |
1592 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
2368 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
1593 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
2369 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
1594 | called in pairs bracketing the blocking call. |
2370 | called in pairs bracketing the blocking call. |
1595 | .PP |
2371 | .PP |
1596 | Their main purpose is to integrate other event mechanisms into libev and |
2372 | Their main purpose is to integrate other event mechanisms into libev and |
1597 | their use is somewhat advanced. This could be used, for example, to track |
2373 | their use is somewhat advanced. They could be used, for example, to track |
1598 | variable changes, implement your own watchers, integrate net-snmp or a |
2374 | variable changes, implement your own watchers, integrate net-snmp or a |
1599 | coroutine library and lots more. They are also occasionally useful if |
2375 | coroutine library and lots more. They are also occasionally useful if |
1600 | you cache some data and want to flush it before blocking (for example, |
2376 | you cache some data and want to flush it before blocking (for example, |
1601 | in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR |
2377 | in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR |
1602 | watcher). |
2378 | watcher). |
1603 | .PP |
2379 | .PP |
1604 | This is done by examining in each prepare call which file descriptors need |
2380 | This is done by examining in each prepare call which file descriptors |
1605 | to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for |
2381 | need to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers |
1606 | them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries |
2382 | for them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many |
1607 | provide just this functionality). Then, in the check watcher you check for |
2383 | libraries provide exactly this functionality). Then, in the check watcher, |
1608 | any events that occured (by checking the pending status of all watchers |
2384 | you check for any events that occurred (by checking the pending status |
1609 | and stopping them) and call back into the library. The I/O and timer |
2385 | of all watchers and stopping them) and call back into the library. The |
1610 | callbacks will never actually be called (but must be valid nevertheless, |
2386 | I/O and timer callbacks will never actually be called (but must be valid |
1611 | because you never know, you know?). |
2387 | nevertheless, because you never know, you know?). |
1612 | .PP |
2388 | .PP |
1613 | As another example, the Perl Coro module uses these hooks to integrate |
2389 | As another example, the Perl Coro module uses these hooks to integrate |
1614 | coroutines into libev programs, by yielding to other active coroutines |
2390 | coroutines into libev programs, by yielding to other active coroutines |
1615 | during each prepare and only letting the process block if no coroutines |
2391 | during each prepare and only letting the process block if no coroutines |
1616 | are ready to run (it's actually more complicated: it only runs coroutines |
2392 | are ready to run (it's actually more complicated: it only runs coroutines |
1617 | with priority higher than or equal to the event loop and one coroutine |
2393 | with priority higher than or equal to the event loop and one coroutine |
1618 | of lower priority, but only once, using idle watchers to keep the event |
2394 | of lower priority, but only once, using idle watchers to keep the event |
1619 | loop from blocking if lower-priority coroutines are active, thus mapping |
2395 | loop from blocking if lower-priority coroutines are active, thus mapping |
1620 | low-priority coroutines to idle/background tasks). |
2396 | low-priority coroutines to idle/background tasks). |
|
|
2397 | .PP |
|
|
2398 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
2399 | priority, to ensure that they are being run before any other watchers |
|
|
2400 | after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). |
|
|
2401 | .PP |
|
|
2402 | Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not |
|
|
2403 | activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they |
|
|
2404 | might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As |
|
|
2405 | \&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event |
|
|
2406 | loops those other event loops might be in an unusable state until their |
|
|
2407 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
|
|
2408 | others). |
|
|
2409 | .PP |
|
|
2410 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2411 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1621 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
2412 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1622 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
2413 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1623 | .PD 0 |
2414 | .PD 0 |
1624 | .IP "ev_check_init (ev_check *, callback)" 4 |
2415 | .IP "ev_check_init (ev_check *, callback)" 4 |
1625 | .IX Item "ev_check_init (ev_check *, callback)" |
2416 | .IX Item "ev_check_init (ev_check *, callback)" |
1626 | .PD |
2417 | .PD |
1627 | Initialises and configures the prepare or check watcher \- they have no |
2418 | Initialises and configures the prepare or check watcher \- they have no |
1628 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
2419 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1629 | macros, but using them is utterly, utterly and completely pointless. |
2420 | macros, but using them is utterly, utterly, utterly and completely |
|
|
2421 | pointless. |
1630 | .PP |
2422 | .PP |
1631 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
2423 | \fIExamples\fR |
1632 | and a timeout watcher in a prepare handler, as required by libadns, and |
2424 | .IX Subsection "Examples" |
|
|
2425 | .PP |
|
|
2426 | There are a number of principal ways to embed other event loops or modules |
|
|
2427 | into libev. Here are some ideas on how to include libadns into libev |
|
|
2428 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
2429 | use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a |
|
|
2430 | Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the |
|
|
2431 | Glib event loop). |
|
|
2432 | .PP |
|
|
2433 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
1633 | in a check watcher, destroy them and call into libadns. What follows is |
2434 | and in a check watcher, destroy them and call into libadns. What follows |
1634 | pseudo-code only of course: |
2435 | is pseudo-code only of course. This requires you to either use a low |
|
|
2436 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
2437 | the callbacks for the IO/timeout watchers might not have been called yet. |
1635 | .PP |
2438 | .PP |
1636 | .Vb 2 |
2439 | .Vb 2 |
1637 | \& static ev_io iow [nfd]; |
2440 | \& static ev_io iow [nfd]; |
1638 | \& static ev_timer tw; |
2441 | \& static ev_timer tw; |
1639 | .Ve |
2442 | \& |
1640 | .PP |
|
|
1641 | .Vb 9 |
|
|
1642 | \& static void |
2443 | \& static void |
1643 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
2444 | \& io_cb (struct ev_loop *loop, ev_io *w, int revents) |
1644 | \& { |
2445 | \& { |
1645 | \& // set the relevant poll flags |
|
|
1646 | \& // could also call adns_processreadable etc. here |
|
|
1647 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1648 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1649 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1650 | \& } |
2446 | \& } |
1651 | .Ve |
2447 | \& |
1652 | .PP |
|
|
1653 | .Vb 8 |
|
|
1654 | \& // create io watchers for each fd and a timer before blocking |
2448 | \& // create io watchers for each fd and a timer before blocking |
1655 | \& static void |
2449 | \& static void |
1656 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
2450 | \& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents) |
1657 | \& { |
2451 | \& { |
1658 | \& int timeout = 3600000; |
2452 | \& int timeout = 3600000; |
1659 | \& struct pollfd fds [nfd]; |
2453 | \& struct pollfd fds [nfd]; |
1660 | \& // actual code will need to loop here and realloc etc. |
2454 | \& // actual code will need to loop here and realloc etc. |
1661 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2455 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1662 | .Ve |
2456 | \& |
1663 | .PP |
|
|
1664 | .Vb 3 |
|
|
1665 | \& /* the callback is illegal, but won't be called as we stop during check */ |
2457 | \& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ |
1666 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
2458 | \& ev_timer_init (&tw, 0, timeout * 1e\-3); |
1667 | \& ev_timer_start (loop, &tw); |
2459 | \& ev_timer_start (loop, &tw); |
1668 | .Ve |
2460 | \& |
1669 | .PP |
|
|
1670 | .Vb 6 |
|
|
1671 | \& // create on ev_io per pollfd |
2461 | \& // create one ev_io per pollfd |
1672 | \& for (int i = 0; i < nfd; ++i) |
2462 | \& for (int i = 0; i < nfd; ++i) |
1673 | \& { |
2463 | \& { |
1674 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
2464 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1675 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
2465 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1676 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
2466 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
|
|
2467 | \& |
|
|
2468 | \& fds [i].revents = 0; |
|
|
2469 | \& ev_io_start (loop, iow + i); |
|
|
2470 | \& } |
|
|
2471 | \& } |
|
|
2472 | \& |
|
|
2473 | \& // stop all watchers after blocking |
|
|
2474 | \& static void |
|
|
2475 | \& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents) |
|
|
2476 | \& { |
|
|
2477 | \& ev_timer_stop (loop, &tw); |
|
|
2478 | \& |
|
|
2479 | \& for (int i = 0; i < nfd; ++i) |
|
|
2480 | \& { |
|
|
2481 | \& // set the relevant poll flags |
|
|
2482 | \& // could also call adns_processreadable etc. here |
|
|
2483 | \& struct pollfd *fd = fds + i; |
|
|
2484 | \& int revents = ev_clear_pending (iow + i); |
|
|
2485 | \& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN; |
|
|
2486 | \& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT; |
|
|
2487 | \& |
|
|
2488 | \& // now stop the watcher |
|
|
2489 | \& ev_io_stop (loop, iow + i); |
|
|
2490 | \& } |
|
|
2491 | \& |
|
|
2492 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
2493 | \& } |
1677 | .Ve |
2494 | .Ve |
|
|
2495 | .PP |
|
|
2496 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
2497 | in the prepare watcher and would dispose of the check watcher. |
|
|
2498 | .PP |
|
|
2499 | Method 3: If the module to be embedded supports explicit event |
|
|
2500 | notification (libadns does), you can also make use of the actual watcher |
|
|
2501 | callbacks, and only destroy/create the watchers in the prepare watcher. |
1678 | .PP |
2502 | .PP |
1679 | .Vb 5 |
2503 | .Vb 5 |
1680 | \& fds [i].revents = 0; |
|
|
1681 | \& iow [i].data = fds + i; |
|
|
1682 | \& ev_io_start (loop, iow + i); |
|
|
1683 | \& } |
|
|
1684 | \& } |
|
|
1685 | .Ve |
|
|
1686 | .PP |
|
|
1687 | .Vb 5 |
|
|
1688 | \& // stop all watchers after blocking |
|
|
1689 | \& static void |
2504 | \& static void |
1690 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
2505 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
1691 | \& { |
2506 | \& { |
1692 | \& ev_timer_stop (loop, &tw); |
2507 | \& adns_state ads = (adns_state)w\->data; |
1693 | .Ve |
2508 | \& update_now (EV_A); |
1694 | .PP |
2509 | \& |
1695 | .Vb 2 |
2510 | \& adns_processtimeouts (ads, &tv_now); |
1696 | \& for (int i = 0; i < nfd; ++i) |
|
|
1697 | \& ev_io_stop (loop, iow + i); |
|
|
1698 | .Ve |
|
|
1699 | .PP |
|
|
1700 | .Vb 2 |
|
|
1701 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1702 | \& } |
2511 | \& } |
|
|
2512 | \& |
|
|
2513 | \& static void |
|
|
2514 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
2515 | \& { |
|
|
2516 | \& adns_state ads = (adns_state)w\->data; |
|
|
2517 | \& update_now (EV_A); |
|
|
2518 | \& |
|
|
2519 | \& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now); |
|
|
2520 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now); |
|
|
2521 | \& } |
|
|
2522 | \& |
|
|
2523 | \& // do not ever call adns_afterpoll |
|
|
2524 | .Ve |
|
|
2525 | .PP |
|
|
2526 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
2527 | want to embed is not flexible enough to support it. Instead, you can |
|
|
2528 | override their poll function. The drawback with this solution is that the |
|
|
2529 | main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses |
|
|
2530 | this approach, effectively embedding \s-1EV\s0 as a client into the horrible |
|
|
2531 | libglib event loop. |
|
|
2532 | .PP |
|
|
2533 | .Vb 4 |
|
|
2534 | \& static gint |
|
|
2535 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
2536 | \& { |
|
|
2537 | \& int got_events = 0; |
|
|
2538 | \& |
|
|
2539 | \& for (n = 0; n < nfds; ++n) |
|
|
2540 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
2541 | \& |
|
|
2542 | \& if (timeout >= 0) |
|
|
2543 | \& // create/start timer |
|
|
2544 | \& |
|
|
2545 | \& // poll |
|
|
2546 | \& ev_loop (EV_A_ 0); |
|
|
2547 | \& |
|
|
2548 | \& // stop timer again |
|
|
2549 | \& if (timeout >= 0) |
|
|
2550 | \& ev_timer_stop (EV_A_ &to); |
|
|
2551 | \& |
|
|
2552 | \& // stop io watchers again \- their callbacks should have set |
|
|
2553 | \& for (n = 0; n < nfds; ++n) |
|
|
2554 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
2555 | \& |
|
|
2556 | \& return got_events; |
|
|
2557 | \& } |
1703 | .Ve |
2558 | .Ve |
1704 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
2559 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
1705 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
2560 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1706 | .IX Subsection "ev_embed - when one backend isn't enough..." |
2561 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1707 | This is a rather advanced watcher type that lets you embed one event loop |
2562 | This is a rather advanced watcher type that lets you embed one event loop |
… | |
… | |
1713 | prioritise I/O. |
2568 | prioritise I/O. |
1714 | .PP |
2569 | .PP |
1715 | As an example for a bug workaround, the kqueue backend might only support |
2570 | As an example for a bug workaround, the kqueue backend might only support |
1716 | sockets on some platform, so it is unusable as generic backend, but you |
2571 | sockets on some platform, so it is unusable as generic backend, but you |
1717 | still want to make use of it because you have many sockets and it scales |
2572 | still want to make use of it because you have many sockets and it scales |
1718 | so nicely. In this case, you would create a kqueue-based loop and embed it |
2573 | so nicely. In this case, you would create a kqueue-based loop and embed |
1719 | into your default loop (which might use e.g. poll). Overall operation will |
2574 | it into your default loop (which might use e.g. poll). Overall operation |
1720 | be a bit slower because first libev has to poll and then call kevent, but |
2575 | will be a bit slower because first libev has to call \f(CW\*(C`poll\*(C'\fR and then |
1721 | at least you can use both at what they are best. |
2576 | \&\f(CW\*(C`kevent\*(C'\fR, but at least you can use both mechanisms for what they are |
|
|
2577 | best: \f(CW\*(C`kqueue\*(C'\fR for scalable sockets and \f(CW\*(C`poll\*(C'\fR if you want it to work :) |
1722 | .PP |
2578 | .PP |
1723 | As for prioritising I/O: rarely you have the case where some fds have |
2579 | As for prioritising I/O: under rare circumstances you have the case where |
1724 | to be watched and handled very quickly (with low latency), and even |
2580 | some fds have to be watched and handled very quickly (with low latency), |
1725 | priorities and idle watchers might have too much overhead. In this case |
2581 | and even priorities and idle watchers might have too much overhead. In |
1726 | you would put all the high priority stuff in one loop and all the rest in |
2582 | this case you would put all the high priority stuff in one loop and all |
1727 | a second one, and embed the second one in the first. |
2583 | the rest in a second one, and embed the second one in the first. |
1728 | .PP |
2584 | .PP |
1729 | As long as the watcher is active, the callback will be invoked every time |
2585 | As long as the watcher is active, the callback will be invoked every |
1730 | there might be events pending in the embedded loop. The callback must then |
2586 | time there might be events pending in the embedded loop. The callback |
1731 | call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke |
2587 | must then call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single |
1732 | their callbacks (you could also start an idle watcher to give the embedded |
2588 | sweep and invoke their callbacks (the callback doesn't need to invoke the |
1733 | loop strictly lower priority for example). You can also set the callback |
2589 | \&\f(CW\*(C`ev_embed_sweep\*(C'\fR function directly, it could also start an idle watcher |
1734 | to \f(CW0\fR, in which case the embed watcher will automatically execute the |
2590 | to give the embedded loop strictly lower priority for example). |
1735 | embedded loop sweep. |
|
|
1736 | .PP |
2591 | .PP |
1737 | As long as the watcher is started it will automatically handle events. The |
2592 | You can also set the callback to \f(CW0\fR, in which case the embed watcher |
1738 | callback will be invoked whenever some events have been handled. You can |
2593 | will automatically execute the embedded loop sweep whenever necessary. |
1739 | set the callback to \f(CW0\fR to avoid having to specify one if you are not |
|
|
1740 | interested in that. |
|
|
1741 | .PP |
2594 | .PP |
1742 | Also, there have not currently been made special provisions for forking: |
2595 | Fork detection will be handled transparently while the \f(CW\*(C`ev_embed\*(C'\fR watcher |
1743 | when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, |
2596 | is active, i.e., the embedded loop will automatically be forked when the |
1744 | but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers |
2597 | embedding loop forks. In other cases, the user is responsible for calling |
1745 | yourself. |
2598 | \&\f(CW\*(C`ev_loop_fork\*(C'\fR on the embedded loop. |
1746 | .PP |
2599 | .PP |
1747 | Unfortunately, not all backends are embeddable, only the ones returned by |
2600 | Unfortunately, not all backends are embeddable: only the ones returned by |
1748 | \&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any |
2601 | \&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any |
1749 | portable one. |
2602 | portable one. |
1750 | .PP |
2603 | .PP |
1751 | So when you want to use this feature you will always have to be prepared |
2604 | So when you want to use this feature you will always have to be prepared |
1752 | that you cannot get an embeddable loop. The recommended way to get around |
2605 | that you cannot get an embeddable loop. The recommended way to get around |
1753 | this is to have a separate variables for your embeddable loop, try to |
2606 | this is to have a separate variables for your embeddable loop, try to |
1754 | create it, and if that fails, use the normal loop for everything: |
2607 | create it, and if that fails, use the normal loop for everything. |
1755 | .PP |
2608 | .PP |
1756 | .Vb 3 |
2609 | \fI\f(CI\*(C`ev_embed\*(C'\fI and fork\fR |
1757 | \& struct ev_loop *loop_hi = ev_default_init (0); |
2610 | .IX Subsection "ev_embed and fork" |
1758 | \& struct ev_loop *loop_lo = 0; |
|
|
1759 | \& struct ev_embed embed; |
|
|
1760 | .Ve |
|
|
1761 | .PP |
2611 | .PP |
1762 | .Vb 5 |
2612 | While the \f(CW\*(C`ev_embed\*(C'\fR watcher is running, forks in the embedding loop will |
1763 | \& // see if there is a chance of getting one that works |
2613 | automatically be applied to the embedded loop as well, so no special |
1764 | \& // (remember that a flags value of 0 means autodetection) |
2614 | fork handling is required in that case. When the watcher is not running, |
1765 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
2615 | however, it is still the task of the libev user to call \f(CW\*(C`ev_loop_fork ()\*(C'\fR |
1766 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
2616 | as applicable. |
1767 | \& : 0; |
|
|
1768 | .Ve |
|
|
1769 | .PP |
2617 | .PP |
1770 | .Vb 8 |
2618 | \fIWatcher-Specific Functions and Data Members\fR |
1771 | \& // if we got one, then embed it, otherwise default to loop_hi |
2619 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1772 | \& if (loop_lo) |
|
|
1773 | \& { |
|
|
1774 | \& ev_embed_init (&embed, 0, loop_lo); |
|
|
1775 | \& ev_embed_start (loop_hi, &embed); |
|
|
1776 | \& } |
|
|
1777 | \& else |
|
|
1778 | \& loop_lo = loop_hi; |
|
|
1779 | .Ve |
|
|
1780 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2620 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1781 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2621 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1782 | .PD 0 |
2622 | .PD 0 |
1783 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2623 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1784 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2624 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1785 | .PD |
2625 | .PD |
1786 | Configures the watcher to embed the given loop, which must be |
2626 | Configures the watcher to embed the given loop, which must be |
1787 | embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be |
2627 | embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be |
1788 | invoked automatically, otherwise it is the responsibility of the callback |
2628 | invoked automatically, otherwise it is the responsibility of the callback |
1789 | to invoke it (it will continue to be called until the sweep has been done, |
2629 | to invoke it (it will continue to be called until the sweep has been done, |
1790 | if you do not want thta, you need to temporarily stop the embed watcher). |
2630 | if you do not want that, you need to temporarily stop the embed watcher). |
1791 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
2631 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
1792 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
2632 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
1793 | Make a single, non-blocking sweep over the embedded loop. This works |
2633 | Make a single, non-blocking sweep over the embedded loop. This works |
1794 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
2634 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
1795 | apropriate way for embedded loops. |
2635 | appropriate way for embedded loops. |
1796 | .IP "struct ev_loop *loop [read\-only]" 4 |
2636 | .IP "struct ev_loop *other [read\-only]" 4 |
1797 | .IX Item "struct ev_loop *loop [read-only]" |
2637 | .IX Item "struct ev_loop *other [read-only]" |
1798 | The embedded event loop. |
2638 | The embedded event loop. |
|
|
2639 | .PP |
|
|
2640 | \fIExamples\fR |
|
|
2641 | .IX Subsection "Examples" |
|
|
2642 | .PP |
|
|
2643 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
2644 | event loop. If that is not possible, use the default loop. The default |
|
|
2645 | loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in |
|
|
2646 | \&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be |
|
|
2647 | used). |
|
|
2648 | .PP |
|
|
2649 | .Vb 3 |
|
|
2650 | \& struct ev_loop *loop_hi = ev_default_init (0); |
|
|
2651 | \& struct ev_loop *loop_lo = 0; |
|
|
2652 | \& ev_embed embed; |
|
|
2653 | \& |
|
|
2654 | \& // see if there is a chance of getting one that works |
|
|
2655 | \& // (remember that a flags value of 0 means autodetection) |
|
|
2656 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
|
|
2657 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
|
|
2658 | \& : 0; |
|
|
2659 | \& |
|
|
2660 | \& // if we got one, then embed it, otherwise default to loop_hi |
|
|
2661 | \& if (loop_lo) |
|
|
2662 | \& { |
|
|
2663 | \& ev_embed_init (&embed, 0, loop_lo); |
|
|
2664 | \& ev_embed_start (loop_hi, &embed); |
|
|
2665 | \& } |
|
|
2666 | \& else |
|
|
2667 | \& loop_lo = loop_hi; |
|
|
2668 | .Ve |
|
|
2669 | .PP |
|
|
2670 | Example: Check if kqueue is available but not recommended and create |
|
|
2671 | a kqueue backend for use with sockets (which usually work with any |
|
|
2672 | kqueue implementation). Store the kqueue/socket\-only event loop in |
|
|
2673 | \&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too). |
|
|
2674 | .PP |
|
|
2675 | .Vb 3 |
|
|
2676 | \& struct ev_loop *loop = ev_default_init (0); |
|
|
2677 | \& struct ev_loop *loop_socket = 0; |
|
|
2678 | \& ev_embed embed; |
|
|
2679 | \& |
|
|
2680 | \& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
2681 | \& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
2682 | \& { |
|
|
2683 | \& ev_embed_init (&embed, 0, loop_socket); |
|
|
2684 | \& ev_embed_start (loop, &embed); |
|
|
2685 | \& } |
|
|
2686 | \& |
|
|
2687 | \& if (!loop_socket) |
|
|
2688 | \& loop_socket = loop; |
|
|
2689 | \& |
|
|
2690 | \& // now use loop_socket for all sockets, and loop for everything else |
|
|
2691 | .Ve |
1799 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
2692 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
1800 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
2693 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
1801 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
2694 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
1802 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
2695 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
1803 | whoever is a good citizen cared to tell libev about it by calling |
2696 | whoever is a good citizen cared to tell libev about it by calling |
1804 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
2697 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
1805 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
2698 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
1806 | and only in the child after the fork. If whoever good citizen calling |
2699 | and only in the child after the fork. If whoever good citizen calling |
1807 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
2700 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
1808 | handlers will be invoked, too, of course. |
2701 | handlers will be invoked, too, of course. |
|
|
2702 | .PP |
|
|
2703 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2704 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1809 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
2705 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
1810 | .IX Item "ev_fork_init (ev_signal *, callback)" |
2706 | .IX Item "ev_fork_init (ev_signal *, callback)" |
1811 | Initialises and configures the fork watcher \- it has no parameters of any |
2707 | Initialises and configures the fork watcher \- it has no parameters of any |
1812 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
2708 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
1813 | believe me. |
2709 | believe me. |
|
|
2710 | .ie n .Sh """ev_async"" \- how to wake up another event loop" |
|
|
2711 | .el .Sh "\f(CWev_async\fP \- how to wake up another event loop" |
|
|
2712 | .IX Subsection "ev_async - how to wake up another event loop" |
|
|
2713 | In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other |
|
|
2714 | asynchronous sources such as signal handlers (as opposed to multiple event |
|
|
2715 | loops \- those are of course safe to use in different threads). |
|
|
2716 | .PP |
|
|
2717 | Sometimes, however, you need to wake up another event loop you do not |
|
|
2718 | control, for example because it belongs to another thread. This is what |
|
|
2719 | \&\f(CW\*(C`ev_async\*(C'\fR watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you |
|
|
2720 | can signal it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal |
|
|
2721 | safe. |
|
|
2722 | .PP |
|
|
2723 | This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, |
|
|
2724 | too, are asynchronous in nature, and signals, too, will be compressed |
|
|
2725 | (i.e. the number of callback invocations may be less than the number of |
|
|
2726 | \&\f(CW\*(C`ev_async_sent\*(C'\fR calls). |
|
|
2727 | .PP |
|
|
2728 | Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not |
|
|
2729 | just the default loop. |
|
|
2730 | .PP |
|
|
2731 | \fIQueueing\fR |
|
|
2732 | .IX Subsection "Queueing" |
|
|
2733 | .PP |
|
|
2734 | \&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason |
|
|
2735 | is that the author does not know of a simple (or any) algorithm for a |
|
|
2736 | multiple-writer-single-reader queue that works in all cases and doesn't |
|
|
2737 | need elaborate support such as pthreads. |
|
|
2738 | .PP |
|
|
2739 | That means that if you want to queue data, you have to provide your own |
|
|
2740 | queue. But at least I can tell you how to implement locking around your |
|
|
2741 | queue: |
|
|
2742 | .IP "queueing from a signal handler context" 4 |
|
|
2743 | .IX Item "queueing from a signal handler context" |
|
|
2744 | To implement race-free queueing, you simply add to the queue in the signal |
|
|
2745 | handler but you block the signal handler in the watcher callback. Here is |
|
|
2746 | an example that does that for some fictitious \s-1SIGUSR1\s0 handler: |
|
|
2747 | .Sp |
|
|
2748 | .Vb 1 |
|
|
2749 | \& static ev_async mysig; |
|
|
2750 | \& |
|
|
2751 | \& static void |
|
|
2752 | \& sigusr1_handler (void) |
|
|
2753 | \& { |
|
|
2754 | \& sometype data; |
|
|
2755 | \& |
|
|
2756 | \& // no locking etc. |
|
|
2757 | \& queue_put (data); |
|
|
2758 | \& ev_async_send (EV_DEFAULT_ &mysig); |
|
|
2759 | \& } |
|
|
2760 | \& |
|
|
2761 | \& static void |
|
|
2762 | \& mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
2763 | \& { |
|
|
2764 | \& sometype data; |
|
|
2765 | \& sigset_t block, prev; |
|
|
2766 | \& |
|
|
2767 | \& sigemptyset (&block); |
|
|
2768 | \& sigaddset (&block, SIGUSR1); |
|
|
2769 | \& sigprocmask (SIG_BLOCK, &block, &prev); |
|
|
2770 | \& |
|
|
2771 | \& while (queue_get (&data)) |
|
|
2772 | \& process (data); |
|
|
2773 | \& |
|
|
2774 | \& if (sigismember (&prev, SIGUSR1) |
|
|
2775 | \& sigprocmask (SIG_UNBLOCK, &block, 0); |
|
|
2776 | \& } |
|
|
2777 | .Ve |
|
|
2778 | .Sp |
|
|
2779 | (Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR |
|
|
2780 | instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it |
|
|
2781 | either...). |
|
|
2782 | .IP "queueing from a thread context" 4 |
|
|
2783 | .IX Item "queueing from a thread context" |
|
|
2784 | The strategy for threads is different, as you cannot (easily) block |
|
|
2785 | threads but you can easily preempt them, so to queue safely you need to |
|
|
2786 | employ a traditional mutex lock, such as in this pthread example: |
|
|
2787 | .Sp |
|
|
2788 | .Vb 2 |
|
|
2789 | \& static ev_async mysig; |
|
|
2790 | \& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER; |
|
|
2791 | \& |
|
|
2792 | \& static void |
|
|
2793 | \& otherthread (void) |
|
|
2794 | \& { |
|
|
2795 | \& // only need to lock the actual queueing operation |
|
|
2796 | \& pthread_mutex_lock (&mymutex); |
|
|
2797 | \& queue_put (data); |
|
|
2798 | \& pthread_mutex_unlock (&mymutex); |
|
|
2799 | \& |
|
|
2800 | \& ev_async_send (EV_DEFAULT_ &mysig); |
|
|
2801 | \& } |
|
|
2802 | \& |
|
|
2803 | \& static void |
|
|
2804 | \& mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
2805 | \& { |
|
|
2806 | \& pthread_mutex_lock (&mymutex); |
|
|
2807 | \& |
|
|
2808 | \& while (queue_get (&data)) |
|
|
2809 | \& process (data); |
|
|
2810 | \& |
|
|
2811 | \& pthread_mutex_unlock (&mymutex); |
|
|
2812 | \& } |
|
|
2813 | .Ve |
|
|
2814 | .PP |
|
|
2815 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2816 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
2817 | .IP "ev_async_init (ev_async *, callback)" 4 |
|
|
2818 | .IX Item "ev_async_init (ev_async *, callback)" |
|
|
2819 | Initialises and configures the async watcher \- it has no parameters of any |
|
|
2820 | kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless, |
|
|
2821 | trust me. |
|
|
2822 | .IP "ev_async_send (loop, ev_async *)" 4 |
|
|
2823 | .IX Item "ev_async_send (loop, ev_async *)" |
|
|
2824 | Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds |
|
|
2825 | an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike |
|
|
2826 | \&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or |
|
|
2827 | similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding |
|
|
2828 | section below on what exactly this means). |
|
|
2829 | .Sp |
|
|
2830 | This call incurs the overhead of a system call only once per loop iteration, |
|
|
2831 | so while the overhead might be noticeable, it doesn't apply to repeated |
|
|
2832 | calls to \f(CW\*(C`ev_async_send\*(C'\fR. |
|
|
2833 | .IP "bool = ev_async_pending (ev_async *)" 4 |
|
|
2834 | .IX Item "bool = ev_async_pending (ev_async *)" |
|
|
2835 | Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the |
|
|
2836 | watcher but the event has not yet been processed (or even noted) by the |
|
|
2837 | event loop. |
|
|
2838 | .Sp |
|
|
2839 | \&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When |
|
|
2840 | the loop iterates next and checks for the watcher to have become active, |
|
|
2841 | it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very |
|
|
2842 | quickly check whether invoking the loop might be a good idea. |
|
|
2843 | .Sp |
|
|
2844 | Not that this does \fInot\fR check whether the watcher itself is pending, only |
|
|
2845 | whether it has been requested to make this watcher pending. |
1814 | .SH "OTHER FUNCTIONS" |
2846 | .SH "OTHER FUNCTIONS" |
1815 | .IX Header "OTHER FUNCTIONS" |
2847 | .IX Header "OTHER FUNCTIONS" |
1816 | There are some other functions of possible interest. Described. Here. Now. |
2848 | There are some other functions of possible interest. Described. Here. Now. |
1817 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
2849 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
1818 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
2850 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
1819 | This function combines a simple timer and an I/O watcher, calls your |
2851 | This function combines a simple timer and an I/O watcher, calls your |
1820 | callback on whichever event happens first and automatically stop both |
2852 | callback on whichever event happens first and automatically stops both |
1821 | watchers. This is useful if you want to wait for a single event on an fd |
2853 | watchers. This is useful if you want to wait for a single event on an fd |
1822 | or timeout without having to allocate/configure/start/stop/free one or |
2854 | or timeout without having to allocate/configure/start/stop/free one or |
1823 | more watchers yourself. |
2855 | more watchers yourself. |
1824 | .Sp |
2856 | .Sp |
1825 | If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events |
2857 | If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the |
1826 | is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and |
2858 | \&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for |
1827 | \&\f(CW\*(C`events\*(C'\fR set will be craeted and started. |
2859 | the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started. |
1828 | .Sp |
2860 | .Sp |
1829 | If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be |
2861 | If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be |
1830 | started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and |
2862 | started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and |
1831 | repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of |
2863 | repeat = 0) will be started. \f(CW0\fR is a valid timeout. |
1832 | dubious value. |
|
|
1833 | .Sp |
2864 | .Sp |
1834 | The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets |
2865 | The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets |
1835 | passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of |
2866 | passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of |
1836 | \&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR |
2867 | \&\f(CW\*(C`EV_ERROR\*(C'\fR, \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_TIMEOUT\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR |
1837 | value passed to \f(CW\*(C`ev_once\*(C'\fR: |
2868 | value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR |
|
|
2869 | a timeout and an io event at the same time \- you probably should give io |
|
|
2870 | events precedence. |
|
|
2871 | .Sp |
|
|
2872 | Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. |
1838 | .Sp |
2873 | .Sp |
1839 | .Vb 7 |
2874 | .Vb 7 |
1840 | \& static void stdin_ready (int revents, void *arg) |
2875 | \& static void stdin_ready (int revents, void *arg) |
1841 | \& { |
2876 | \& { |
1842 | \& if (revents & EV_TIMEOUT) |
|
|
1843 | \& /* doh, nothing entered */; |
|
|
1844 | \& else if (revents & EV_READ) |
2877 | \& if (revents & EV_READ) |
1845 | \& /* stdin might have data for us, joy! */; |
2878 | \& /* stdin might have data for us, joy! */; |
|
|
2879 | \& else if (revents & EV_TIMEOUT) |
|
|
2880 | \& /* doh, nothing entered */; |
1846 | \& } |
2881 | \& } |
1847 | .Ve |
2882 | \& |
1848 | .Sp |
|
|
1849 | .Vb 1 |
|
|
1850 | \& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2883 | \& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
1851 | .Ve |
2884 | .Ve |
1852 | .IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 |
2885 | .IP "ev_feed_event (struct ev_loop *, watcher *, int revents)" 4 |
1853 | .IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" |
2886 | .IX Item "ev_feed_event (struct ev_loop *, watcher *, int revents)" |
1854 | Feeds the given event set into the event loop, as if the specified event |
2887 | Feeds the given event set into the event loop, as if the specified event |
1855 | had happened for the specified watcher (which must be a pointer to an |
2888 | had happened for the specified watcher (which must be a pointer to an |
1856 | initialised but not necessarily started event watcher). |
2889 | initialised but not necessarily started event watcher). |
1857 | .IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 |
2890 | .IP "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" 4 |
1858 | .IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" |
2891 | .IX Item "ev_feed_fd_event (struct ev_loop *, int fd, int revents)" |
1859 | Feed an event on the given fd, as if a file descriptor backend detected |
2892 | Feed an event on the given fd, as if a file descriptor backend detected |
1860 | the given events it. |
2893 | the given events it. |
1861 | .IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 |
2894 | .IP "ev_feed_signal_event (struct ev_loop *loop, int signum)" 4 |
1862 | .IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" |
2895 | .IX Item "ev_feed_signal_event (struct ev_loop *loop, int signum)" |
1863 | Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default |
2896 | Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default |
1864 | loop!). |
2897 | loop!). |
1865 | .SH "LIBEVENT EMULATION" |
2898 | .SH "LIBEVENT EMULATION" |
1866 | .IX Header "LIBEVENT EMULATION" |
2899 | .IX Header "LIBEVENT EMULATION" |
1867 | Libev offers a compatibility emulation layer for libevent. It cannot |
2900 | Libev offers a compatibility emulation layer for libevent. It cannot |
1868 | emulate the internals of libevent, so here are some usage hints: |
2901 | emulate the internals of libevent, so here are some usage hints: |
|
|
2902 | .IP "\(bu" 4 |
1869 | .IP "* Use it by including <event.h>, as usual." 4 |
2903 | Use it by including <event.h>, as usual. |
1870 | .IX Item "Use it by including <event.h>, as usual." |
2904 | .IP "\(bu" 4 |
1871 | .PD 0 |
2905 | The following members are fully supported: ev_base, ev_callback, |
1872 | .IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 |
2906 | ev_arg, ev_fd, ev_res, ev_events. |
1873 | .IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." |
2907 | .IP "\(bu" 4 |
1874 | .IP "* Avoid using ev_flags and the EVLIST_*\-macros, while it is maintained by libev, it does not work exactly the same way as in libevent (consider it a private \s-1API\s0)." 4 |
2908 | Avoid using ev_flags and the EVLIST_*\-macros, while it is |
1875 | .IX Item "Avoid using ev_flags and the EVLIST_*-macros, while it is maintained by libev, it does not work exactly the same way as in libevent (consider it a private API)." |
2909 | maintained by libev, it does not work exactly the same way as in libevent (consider |
1876 | .IP "* Priorities are not currently supported. Initialising priorities will fail and all watchers will have the same priority, even though there is an ev_pri field." 4 |
2910 | it a private \s-1API\s0). |
1877 | .IX Item "Priorities are not currently supported. Initialising priorities will fail and all watchers will have the same priority, even though there is an ev_pri field." |
2911 | .IP "\(bu" 4 |
|
|
2912 | Priorities are not currently supported. Initialising priorities |
|
|
2913 | will fail and all watchers will have the same priority, even though there |
|
|
2914 | is an ev_pri field. |
|
|
2915 | .IP "\(bu" 4 |
|
|
2916 | In libevent, the last base created gets the signals, in libev, the |
|
|
2917 | first base created (== the default loop) gets the signals. |
|
|
2918 | .IP "\(bu" 4 |
1878 | .IP "* Other members are not supported." 4 |
2919 | Other members are not supported. |
1879 | .IX Item "Other members are not supported." |
2920 | .IP "\(bu" 4 |
1880 | .IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 |
2921 | The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need |
1881 | .IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." |
2922 | to use the libev header file and library. |
1882 | .PD |
|
|
1883 | .SH "\*(C+ SUPPORT" |
2923 | .SH "\*(C+ SUPPORT" |
1884 | .IX Header " SUPPORT" |
2924 | .IX Header " SUPPORT" |
1885 | Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow |
2925 | Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow |
1886 | you to use some convinience methods to start/stop watchers and also change |
2926 | you to use some convenience methods to start/stop watchers and also change |
1887 | the callback model to a model using method callbacks on objects. |
2927 | the callback model to a model using method callbacks on objects. |
1888 | .PP |
2928 | .PP |
1889 | To use it, |
2929 | To use it, |
1890 | .PP |
2930 | .PP |
1891 | .Vb 1 |
2931 | .Vb 1 |
1892 | \& #include <ev++.h> |
2932 | \& #include <ev++.h> |
1893 | .Ve |
2933 | .Ve |
1894 | .PP |
2934 | .PP |
1895 | (it is not installed by default). This automatically includes \fIev.h\fR |
2935 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1896 | and puts all of its definitions (many of them macros) into the global |
2936 | of them macros) into the global namespace. All \*(C+ specific things are |
1897 | namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace. |
2937 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
|
|
2938 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1898 | .PP |
2939 | .PP |
1899 | It should support all the same embedding options as \fIev.h\fR, most notably |
2940 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1900 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
2941 | classes add (compared to plain C\-style watchers) is the event loop pointer |
|
|
2942 | that the watcher is associated with (or no additional members at all if |
|
|
2943 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
|
|
2944 | .PP |
|
|
2945 | Currently, functions, and static and non-static member functions can be |
|
|
2946 | used as callbacks. Other types should be easy to add as long as they only |
|
|
2947 | need one additional pointer for context. If you need support for other |
|
|
2948 | types of functors please contact the author (preferably after implementing |
|
|
2949 | it). |
1901 | .PP |
2950 | .PP |
1902 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
2951 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1903 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
2952 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
1904 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
2953 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1905 | .IX Item "ev::READ, ev::WRITE etc." |
2954 | .IX Item "ev::READ, ev::WRITE etc." |
… | |
… | |
1917 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
2966 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
1918 | defines by many implementations. |
2967 | defines by many implementations. |
1919 | .Sp |
2968 | .Sp |
1920 | All of those classes have these methods: |
2969 | All of those classes have these methods: |
1921 | .RS 4 |
2970 | .RS 4 |
1922 | .IP "ev::TYPE::TYPE (object *, object::method *)" 4 |
2971 | .IP "ev::TYPE::TYPE ()" 4 |
1923 | .IX Item "ev::TYPE::TYPE (object *, object::method *)" |
2972 | .IX Item "ev::TYPE::TYPE ()" |
1924 | .PD 0 |
2973 | .PD 0 |
1925 | .IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4 |
2974 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
1926 | .IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" |
2975 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
1927 | .IP "ev::TYPE::~TYPE" 4 |
2976 | .IP "ev::TYPE::~TYPE" 4 |
1928 | .IX Item "ev::TYPE::~TYPE" |
2977 | .IX Item "ev::TYPE::~TYPE" |
1929 | .PD |
2978 | .PD |
1930 | The constructor takes a pointer to an object and a method pointer to |
2979 | The constructor (optionally) takes an event loop to associate the watcher |
1931 | the event handler callback to call in this class. The constructor calls |
2980 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
1932 | \&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method |
2981 | .Sp |
1933 | before starting it. If you do not specify a loop then the constructor |
2982 | The constructor calls \f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the |
1934 | automatically associates the default loop with this watcher. |
2983 | \&\f(CW\*(C`set\*(C'\fR method before starting it. |
|
|
2984 | .Sp |
|
|
2985 | It will not set a callback, however: You have to call the templated \f(CW\*(C`set\*(C'\fR |
|
|
2986 | method to set a callback before you can start the watcher. |
|
|
2987 | .Sp |
|
|
2988 | (The reason why you have to use a method is a limitation in \*(C+ which does |
|
|
2989 | not allow explicit template arguments for constructors). |
1935 | .Sp |
2990 | .Sp |
1936 | The destructor automatically stops the watcher if it is active. |
2991 | The destructor automatically stops the watcher if it is active. |
|
|
2992 | .IP "w\->set<class, &class::method> (object *)" 4 |
|
|
2993 | .IX Item "w->set<class, &class::method> (object *)" |
|
|
2994 | This method sets the callback method to call. The method has to have a |
|
|
2995 | signature of \f(CW\*(C`void (*)(ev_TYPE &, int)\*(C'\fR, it receives the watcher as |
|
|
2996 | first argument and the \f(CW\*(C`revents\*(C'\fR as second. The object must be given as |
|
|
2997 | parameter and is stored in the \f(CW\*(C`data\*(C'\fR member of the watcher. |
|
|
2998 | .Sp |
|
|
2999 | This method synthesizes efficient thunking code to call your method from |
|
|
3000 | the C callback that libev requires. If your compiler can inline your |
|
|
3001 | callback (i.e. it is visible to it at the place of the \f(CW\*(C`set\*(C'\fR call and |
|
|
3002 | your compiler is good :), then the method will be fully inlined into the |
|
|
3003 | thunking function, making it as fast as a direct C callback. |
|
|
3004 | .Sp |
|
|
3005 | Example: simple class declaration and watcher initialisation |
|
|
3006 | .Sp |
|
|
3007 | .Vb 4 |
|
|
3008 | \& struct myclass |
|
|
3009 | \& { |
|
|
3010 | \& void io_cb (ev::io &w, int revents) { } |
|
|
3011 | \& } |
|
|
3012 | \& |
|
|
3013 | \& myclass obj; |
|
|
3014 | \& ev::io iow; |
|
|
3015 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
|
|
3016 | .Ve |
|
|
3017 | .IP "w\->set (object *)" 4 |
|
|
3018 | .IX Item "w->set (object *)" |
|
|
3019 | This is an \fBexperimental\fR feature that might go away in a future version. |
|
|
3020 | .Sp |
|
|
3021 | This is a variation of a method callback \- leaving out the method to call |
|
|
3022 | will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use |
|
|
3023 | functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all |
|
|
3024 | the time. Incidentally, you can then also leave out the template argument |
|
|
3025 | list. |
|
|
3026 | .Sp |
|
|
3027 | The \f(CW\*(C`operator ()\*(C'\fR method prototype must be \f(CW\*(C`void operator ()(watcher &w, |
|
|
3028 | int revents)\*(C'\fR. |
|
|
3029 | .Sp |
|
|
3030 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
3031 | .Sp |
|
|
3032 | Example: use a functor object as callback. |
|
|
3033 | .Sp |
|
|
3034 | .Vb 7 |
|
|
3035 | \& struct myfunctor |
|
|
3036 | \& { |
|
|
3037 | \& void operator() (ev::io &w, int revents) |
|
|
3038 | \& { |
|
|
3039 | \& ... |
|
|
3040 | \& } |
|
|
3041 | \& } |
|
|
3042 | \& |
|
|
3043 | \& myfunctor f; |
|
|
3044 | \& |
|
|
3045 | \& ev::io w; |
|
|
3046 | \& w.set (&f); |
|
|
3047 | .Ve |
|
|
3048 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
3049 | .IX Item "w->set<function> (void *data = 0)" |
|
|
3050 | Also sets a callback, but uses a static method or plain function as |
|
|
3051 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
|
|
3052 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
|
|
3053 | .Sp |
|
|
3054 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
3055 | .Sp |
|
|
3056 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
3057 | .Sp |
|
|
3058 | Example: Use a plain function as callback. |
|
|
3059 | .Sp |
|
|
3060 | .Vb 2 |
|
|
3061 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
3062 | \& iow.set <io_cb> (); |
|
|
3063 | .Ve |
1937 | .IP "w\->set (struct ev_loop *)" 4 |
3064 | .IP "w\->set (struct ev_loop *)" 4 |
1938 | .IX Item "w->set (struct ev_loop *)" |
3065 | .IX Item "w->set (struct ev_loop *)" |
1939 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
3066 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1940 | do this when the watcher is inactive (and not pending either). |
3067 | do this when the watcher is inactive (and not pending either). |
1941 | .IP "w\->set ([args])" 4 |
3068 | .IP "w\->set ([arguments])" 4 |
1942 | .IX Item "w->set ([args])" |
3069 | .IX Item "w->set ([arguments])" |
1943 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
3070 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Must be |
1944 | called at least once. Unlike the C counterpart, an active watcher gets |
3071 | called at least once. Unlike the C counterpart, an active watcher gets |
1945 | automatically stopped and restarted. |
3072 | automatically stopped and restarted when reconfiguring it with this |
|
|
3073 | method. |
1946 | .IP "w\->start ()" 4 |
3074 | .IP "w\->start ()" 4 |
1947 | .IX Item "w->start ()" |
3075 | .IX Item "w->start ()" |
1948 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the |
3076 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
1949 | constructor already takes the loop. |
3077 | constructor already stores the event loop. |
1950 | .IP "w\->stop ()" 4 |
3078 | .IP "w\->stop ()" 4 |
1951 | .IX Item "w->stop ()" |
3079 | .IX Item "w->stop ()" |
1952 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
3080 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
1953 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
3081 | .ie n .IP "w\->again () (""ev::timer""\fR, \f(CW""ev::periodic"" only)" 4 |
1954 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
3082 | .el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 |
1955 | .IX Item "w->again () ev::timer, ev::periodic only" |
3083 | .IX Item "w->again () (ev::timer, ev::periodic only)" |
1956 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
3084 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
1957 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
3085 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
1958 | .ie n .IP "w\->sweep () ""ev::embed"" only" 4 |
3086 | .ie n .IP "w\->sweep () (""ev::embed"" only)" 4 |
1959 | .el .IP "w\->sweep () \f(CWev::embed\fR only" 4 |
3087 | .el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 |
1960 | .IX Item "w->sweep () ev::embed only" |
3088 | .IX Item "w->sweep () (ev::embed only)" |
1961 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
3089 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
1962 | .ie n .IP "w\->update () ""ev::stat"" only" 4 |
3090 | .ie n .IP "w\->update () (""ev::stat"" only)" 4 |
1963 | .el .IP "w\->update () \f(CWev::stat\fR only" 4 |
3091 | .el .IP "w\->update () (\f(CWev::stat\fR only)" 4 |
1964 | .IX Item "w->update () ev::stat only" |
3092 | .IX Item "w->update () (ev::stat only)" |
1965 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
3093 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
1966 | .RE |
3094 | .RE |
1967 | .RS 4 |
3095 | .RS 4 |
1968 | .RE |
3096 | .RE |
1969 | .PP |
3097 | .PP |
1970 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
3098 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
1971 | the constructor. |
3099 | the constructor. |
1972 | .PP |
3100 | .PP |
1973 | .Vb 4 |
3101 | .Vb 4 |
1974 | \& class myclass |
3102 | \& class myclass |
1975 | \& { |
3103 | \& { |
1976 | \& ev_io io; void io_cb (ev::io &w, int revents); |
3104 | \& ev::io io ; void io_cb (ev::io &w, int revents); |
1977 | \& ev_idle idle void idle_cb (ev::idle &w, int revents); |
3105 | \& ev::idle idle; void idle_cb (ev::idle &w, int revents); |
1978 | .Ve |
3106 | \& |
1979 | .PP |
|
|
1980 | .Vb 2 |
|
|
1981 | \& myclass (); |
3107 | \& myclass (int fd) |
1982 | \& } |
|
|
1983 | .Ve |
|
|
1984 | .PP |
|
|
1985 | .Vb 6 |
|
|
1986 | \& myclass::myclass (int fd) |
|
|
1987 | \& : io (this, &myclass::io_cb), |
|
|
1988 | \& idle (this, &myclass::idle_cb) |
|
|
1989 | \& { |
3108 | \& { |
|
|
3109 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
3110 | \& idle.set <myclass, &myclass::idle_cb> (this); |
|
|
3111 | \& |
1990 | \& io.start (fd, ev::READ); |
3112 | \& io.start (fd, ev::READ); |
|
|
3113 | \& } |
1991 | \& } |
3114 | \& }; |
1992 | .Ve |
3115 | .Ve |
|
|
3116 | .SH "OTHER LANGUAGE BINDINGS" |
|
|
3117 | .IX Header "OTHER LANGUAGE BINDINGS" |
|
|
3118 | Libev does not offer other language bindings itself, but bindings for a |
|
|
3119 | number of languages exist in the form of third-party packages. If you know |
|
|
3120 | any interesting language binding in addition to the ones listed here, drop |
|
|
3121 | me a note. |
|
|
3122 | .IP "Perl" 4 |
|
|
3123 | .IX Item "Perl" |
|
|
3124 | The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test |
|
|
3125 | libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module, |
|
|
3126 | there are additional modules that implement libev-compatible interfaces |
|
|
3127 | to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), |
|
|
3128 | \&\f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the \f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR |
|
|
3129 | and \f(CW\*(C`EV::Glib\*(C'\fR). |
|
|
3130 | .Sp |
|
|
3131 | It can be found and installed via \s-1CPAN\s0, its homepage is at |
|
|
3132 | <http://software.schmorp.de/pkg/EV>. |
|
|
3133 | .IP "Python" 4 |
|
|
3134 | .IX Item "Python" |
|
|
3135 | Python bindings can be found at <http://code.google.com/p/pyev/>. It |
|
|
3136 | seems to be quite complete and well-documented. Note, however, that the |
|
|
3137 | patch they require for libev is outright dangerous as it breaks the \s-1ABI\s0 |
|
|
3138 | for everybody else, and therefore, should never be applied in an installed |
|
|
3139 | libev (if python requires an incompatible \s-1ABI\s0 then it needs to embed |
|
|
3140 | libev). |
|
|
3141 | .IP "Ruby" 4 |
|
|
3142 | .IX Item "Ruby" |
|
|
3143 | Tony Arcieri has written a ruby extension that offers access to a subset |
|
|
3144 | of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and |
|
|
3145 | more on top of it. It can be found via gem servers. Its homepage is at |
|
|
3146 | <http://rev.rubyforge.org/>. |
|
|
3147 | .Sp |
|
|
3148 | Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR |
|
|
3149 | makes rev work even on mingw. |
|
|
3150 | .IP "D" 4 |
|
|
3151 | .IX Item "D" |
|
|
3152 | Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to |
|
|
3153 | be found at <http://proj.llucax.com.ar/wiki/evd>. |
|
|
3154 | .IP "Ocaml" 4 |
|
|
3155 | .IX Item "Ocaml" |
|
|
3156 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
|
|
3157 | <http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. |
1993 | .SH "MACRO MAGIC" |
3158 | .SH "MACRO MAGIC" |
1994 | .IX Header "MACRO MAGIC" |
3159 | .IX Header "MACRO MAGIC" |
1995 | Libev can be compiled with a variety of options, the most fundemantal is |
3160 | Libev can be compiled with a variety of options, the most fundamental |
1996 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and |
3161 | of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) |
1997 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
3162 | functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
1998 | .PP |
3163 | .PP |
1999 | To make it easier to write programs that cope with either variant, the |
3164 | To make it easier to write programs that cope with either variant, the |
2000 | following macros are defined: |
3165 | following macros are defined: |
2001 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
3166 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
2002 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
3167 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
… | |
… | |
2004 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
3169 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
2005 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
3170 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
2006 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
3171 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
2007 | .Sp |
3172 | .Sp |
2008 | .Vb 3 |
3173 | .Vb 3 |
2009 | \& ev_unref (EV_A); |
3174 | \& ev_unref (EV_A); |
2010 | \& ev_timer_add (EV_A_ watcher); |
3175 | \& ev_timer_add (EV_A_ watcher); |
2011 | \& ev_loop (EV_A_ 0); |
3176 | \& ev_loop (EV_A_ 0); |
2012 | .Ve |
3177 | .Ve |
2013 | .Sp |
3178 | .Sp |
2014 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
3179 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
2015 | which is often provided by the following macro. |
3180 | which is often provided by the following macro. |
2016 | .ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 |
3181 | .ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 |
… | |
… | |
2019 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
3184 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
2020 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
3185 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
2021 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
3186 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
2022 | .Sp |
3187 | .Sp |
2023 | .Vb 2 |
3188 | .Vb 2 |
2024 | \& // this is how ev_unref is being declared |
3189 | \& // this is how ev_unref is being declared |
2025 | \& static void ev_unref (EV_P); |
3190 | \& static void ev_unref (EV_P); |
2026 | .Ve |
3191 | \& |
2027 | .Sp |
|
|
2028 | .Vb 2 |
|
|
2029 | \& // this is how you can declare your typical callback |
3192 | \& // this is how you can declare your typical callback |
2030 | \& static void cb (EV_P_ ev_timer *w, int revents) |
3193 | \& static void cb (EV_P_ ev_timer *w, int revents) |
2031 | .Ve |
3194 | .Ve |
2032 | .Sp |
3195 | .Sp |
2033 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
3196 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
2034 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
3197 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
2035 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
3198 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
2036 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
3199 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2037 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
3200 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2038 | Similar to the other two macros, this gives you the value of the default |
3201 | Similar to the other two macros, this gives you the value of the default |
2039 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
3202 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
|
|
3203 | .ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4 |
|
|
3204 | .el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 |
|
|
3205 | .IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" |
|
|
3206 | Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the |
|
|
3207 | default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour |
|
|
3208 | is undefined when the default loop has not been initialised by a previous |
|
|
3209 | execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR. |
|
|
3210 | .Sp |
|
|
3211 | It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first |
|
|
3212 | watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards. |
2040 | .PP |
3213 | .PP |
2041 | Example: Declare and initialise a check watcher, utilising the above |
3214 | Example: Declare and initialise a check watcher, utilising the above |
2042 | macros so it will work regardless of whether multiple loops are supported |
3215 | macros so it will work regardless of whether multiple loops are supported |
2043 | or not. |
3216 | or not. |
2044 | .PP |
3217 | .PP |
2045 | .Vb 5 |
3218 | .Vb 5 |
2046 | \& static void |
3219 | \& static void |
2047 | \& check_cb (EV_P_ ev_timer *w, int revents) |
3220 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2048 | \& { |
3221 | \& { |
2049 | \& ev_check_stop (EV_A_ w); |
3222 | \& ev_check_stop (EV_A_ w); |
2050 | \& } |
3223 | \& } |
2051 | .Ve |
3224 | \& |
2052 | .PP |
|
|
2053 | .Vb 4 |
|
|
2054 | \& ev_check check; |
3225 | \& ev_check check; |
2055 | \& ev_check_init (&check, check_cb); |
3226 | \& ev_check_init (&check, check_cb); |
2056 | \& ev_check_start (EV_DEFAULT_ &check); |
3227 | \& ev_check_start (EV_DEFAULT_ &check); |
2057 | \& ev_loop (EV_DEFAULT_ 0); |
3228 | \& ev_loop (EV_DEFAULT_ 0); |
2058 | .Ve |
3229 | .Ve |
2059 | .SH "EMBEDDING" |
3230 | .SH "EMBEDDING" |
2060 | .IX Header "EMBEDDING" |
3231 | .IX Header "EMBEDDING" |
2061 | Libev can (and often is) directly embedded into host |
3232 | Libev can (and often is) directly embedded into host |
2062 | applications. Examples of applications that embed it include the Deliantra |
3233 | applications. Examples of applications that embed it include the Deliantra |
2063 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
3234 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
2064 | and rxvt\-unicode. |
3235 | and rxvt-unicode. |
2065 | .PP |
3236 | .PP |
2066 | The goal is to enable you to just copy the neecssary files into your |
3237 | The goal is to enable you to just copy the necessary files into your |
2067 | source directory without having to change even a single line in them, so |
3238 | source directory without having to change even a single line in them, so |
2068 | you can easily upgrade by simply copying (or having a checked-out copy of |
3239 | you can easily upgrade by simply copying (or having a checked-out copy of |
2069 | libev somewhere in your source tree). |
3240 | libev somewhere in your source tree). |
2070 | .Sh "\s-1FILESETS\s0" |
3241 | .Sh "\s-1FILESETS\s0" |
2071 | .IX Subsection "FILESETS" |
3242 | .IX Subsection "FILESETS" |
2072 | Depending on what features you need you need to include one or more sets of files |
3243 | Depending on what features you need you need to include one or more sets of files |
2073 | in your app. |
3244 | in your application. |
2074 | .PP |
3245 | .PP |
2075 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
3246 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
2076 | .IX Subsection "CORE EVENT LOOP" |
3247 | .IX Subsection "CORE EVENT LOOP" |
2077 | .PP |
3248 | .PP |
2078 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
3249 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
2079 | configuration (no autoconf): |
3250 | configuration (no autoconf): |
2080 | .PP |
3251 | .PP |
2081 | .Vb 2 |
3252 | .Vb 2 |
2082 | \& #define EV_STANDALONE 1 |
3253 | \& #define EV_STANDALONE 1 |
2083 | \& #include "ev.c" |
3254 | \& #include "ev.c" |
2084 | .Ve |
3255 | .Ve |
2085 | .PP |
3256 | .PP |
2086 | This will automatically include \fIev.h\fR, too, and should be done in a |
3257 | This will automatically include \fIev.h\fR, too, and should be done in a |
2087 | single C source file only to provide the function implementations. To use |
3258 | single C source file only to provide the function implementations. To use |
2088 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
3259 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
2089 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
3260 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
2090 | where you can put other configuration options): |
3261 | where you can put other configuration options): |
2091 | .PP |
3262 | .PP |
2092 | .Vb 2 |
3263 | .Vb 2 |
2093 | \& #define EV_STANDALONE 1 |
3264 | \& #define EV_STANDALONE 1 |
2094 | \& #include "ev.h" |
3265 | \& #include "ev.h" |
2095 | .Ve |
3266 | .Ve |
2096 | .PP |
3267 | .PP |
2097 | Both header files and implementation files can be compiled with a \*(C+ |
3268 | Both header files and implementation files can be compiled with a \*(C+ |
2098 | compiler (at least, thats a stated goal, and breakage will be treated |
3269 | compiler (at least, that's a stated goal, and breakage will be treated |
2099 | as a bug). |
3270 | as a bug). |
2100 | .PP |
3271 | .PP |
2101 | You need the following files in your source tree, or in a directory |
3272 | You need the following files in your source tree, or in a directory |
2102 | in your include path (e.g. in libev/ when using \-Ilibev): |
3273 | in your include path (e.g. in libev/ when using \-Ilibev): |
2103 | .PP |
3274 | .PP |
2104 | .Vb 4 |
3275 | .Vb 4 |
2105 | \& ev.h |
3276 | \& ev.h |
2106 | \& ev.c |
3277 | \& ev.c |
2107 | \& ev_vars.h |
3278 | \& ev_vars.h |
2108 | \& ev_wrap.h |
3279 | \& ev_wrap.h |
2109 | .Ve |
3280 | \& |
2110 | .PP |
|
|
2111 | .Vb 1 |
|
|
2112 | \& ev_win32.c required on win32 platforms only |
3281 | \& ev_win32.c required on win32 platforms only |
2113 | .Ve |
3282 | \& |
2114 | .PP |
|
|
2115 | .Vb 5 |
|
|
2116 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
3283 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
2117 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
3284 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2118 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
3285 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2119 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
3286 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2120 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
3287 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2121 | .Ve |
3288 | .Ve |
2122 | .PP |
3289 | .PP |
2123 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
3290 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
2124 | to compile this single file. |
3291 | to compile this single file. |
2125 | .PP |
3292 | .PP |
… | |
… | |
2127 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
3294 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
2128 | .PP |
3295 | .PP |
2129 | To include the libevent compatibility \s-1API\s0, also include: |
3296 | To include the libevent compatibility \s-1API\s0, also include: |
2130 | .PP |
3297 | .PP |
2131 | .Vb 1 |
3298 | .Vb 1 |
2132 | \& #include "event.c" |
3299 | \& #include "event.c" |
2133 | .Ve |
3300 | .Ve |
2134 | .PP |
3301 | .PP |
2135 | in the file including \fIev.c\fR, and: |
3302 | in the file including \fIev.c\fR, and: |
2136 | .PP |
3303 | .PP |
2137 | .Vb 1 |
3304 | .Vb 1 |
2138 | \& #include "event.h" |
3305 | \& #include "event.h" |
2139 | .Ve |
3306 | .Ve |
2140 | .PP |
3307 | .PP |
2141 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
3308 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
2142 | .PP |
3309 | .PP |
2143 | You need the following additional files for this: |
3310 | You need the following additional files for this: |
2144 | .PP |
3311 | .PP |
2145 | .Vb 2 |
3312 | .Vb 2 |
2146 | \& event.h |
3313 | \& event.h |
2147 | \& event.c |
3314 | \& event.c |
2148 | .Ve |
3315 | .Ve |
2149 | .PP |
3316 | .PP |
2150 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
3317 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
2151 | .IX Subsection "AUTOCONF SUPPORT" |
3318 | .IX Subsection "AUTOCONF SUPPORT" |
2152 | .PP |
3319 | .PP |
2153 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in |
3320 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in |
2154 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
3321 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
2155 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then |
3322 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then |
2156 | include \fIconfig.h\fR and configure itself accordingly. |
3323 | include \fIconfig.h\fR and configure itself accordingly. |
2157 | .PP |
3324 | .PP |
2158 | For this of course you need the m4 file: |
3325 | For this of course you need the m4 file: |
2159 | .PP |
3326 | .PP |
2160 | .Vb 1 |
3327 | .Vb 1 |
2161 | \& libev.m4 |
3328 | \& libev.m4 |
2162 | .Ve |
3329 | .Ve |
2163 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
3330 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
2164 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
3331 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
2165 | Libev can be configured via a variety of preprocessor symbols you have to define |
3332 | Libev can be configured via a variety of preprocessor symbols you have to |
2166 | before including any of its files. The default is not to build for multiplicity |
3333 | define before including any of its files. The default in the absence of |
2167 | and only include the select backend. |
3334 | autoconf is documented for every option. |
2168 | .IP "\s-1EV_STANDALONE\s0" 4 |
3335 | .IP "\s-1EV_STANDALONE\s0" 4 |
2169 | .IX Item "EV_STANDALONE" |
3336 | .IX Item "EV_STANDALONE" |
2170 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
3337 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
2171 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
3338 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
2172 | implementations for some libevent functions (such as logging, which is not |
3339 | implementations for some libevent functions (such as logging, which is not |
2173 | supported). It will also not define any of the structs usually found in |
3340 | supported). It will also not define any of the structs usually found in |
2174 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
3341 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
|
|
3342 | .Sp |
|
|
3343 | In stanbdalone mode, libev will still try to automatically deduce the |
|
|
3344 | configuration, but has to be more conservative. |
2175 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
3345 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
2176 | .IX Item "EV_USE_MONOTONIC" |
3346 | .IX Item "EV_USE_MONOTONIC" |
2177 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
3347 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2178 | monotonic clock option at both compiletime and runtime. Otherwise no use |
3348 | monotonic clock option at both compile time and runtime. Otherwise no |
2179 | of the monotonic clock option will be attempted. If you enable this, you |
3349 | use of the monotonic clock option will be attempted. If you enable this, |
2180 | usually have to link against librt or something similar. Enabling it when |
3350 | you usually have to link against librt or something similar. Enabling it |
2181 | the functionality isn't available is safe, though, althoguh you have |
3351 | when the functionality isn't available is safe, though, although you have |
2182 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
3352 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
2183 | function is hiding in (often \fI\-lrt\fR). |
3353 | function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR. |
2184 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
3354 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
2185 | .IX Item "EV_USE_REALTIME" |
3355 | .IX Item "EV_USE_REALTIME" |
2186 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
3356 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2187 | realtime clock option at compiletime (and assume its availability at |
3357 | real-time clock option at compile time (and assume its availability at |
2188 | runtime if successful). Otherwise no use of the realtime clock option will |
3358 | runtime if successful). Otherwise no use of the real-time clock option will |
2189 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
3359 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
2190 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
3360 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the |
2191 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
3361 | note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
|
|
3362 | .IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4 |
|
|
3363 | .IX Item "EV_USE_CLOCK_SYSCALL" |
|
|
3364 | If defined to be \f(CW1\fR, libev will try to use a direct syscall instead |
|
|
3365 | of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option |
|
|
3366 | exists because on GNU/Linux, \f(CW\*(C`clock_gettime\*(C'\fR is in \f(CW\*(C`librt\*(C'\fR, but \f(CW\*(C`librt\*(C'\fR |
|
|
3367 | unconditionally pulls in \f(CW\*(C`libpthread\*(C'\fR, slowing down single-threaded |
|
|
3368 | programs needlessly. Using a direct syscall is slightly slower (in |
|
|
3369 | theory), because no optimised vdso implementation can be used, but avoids |
|
|
3370 | the pthread dependency. Defaults to \f(CW1\fR on GNU/Linux with glibc 2.x or |
|
|
3371 | higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). |
|
|
3372 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
|
|
3373 | .IX Item "EV_USE_NANOSLEEP" |
|
|
3374 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
|
|
3375 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
|
|
3376 | .IP "\s-1EV_USE_EVENTFD\s0" 4 |
|
|
3377 | .IX Item "EV_USE_EVENTFD" |
|
|
3378 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is |
|
|
3379 | available and will probe for kernel support at runtime. This will improve |
|
|
3380 | \&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. |
|
|
3381 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
3382 | 2.7 or newer, otherwise disabled. |
2192 | .IP "\s-1EV_USE_SELECT\s0" 4 |
3383 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2193 | .IX Item "EV_USE_SELECT" |
3384 | .IX Item "EV_USE_SELECT" |
2194 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
3385 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2195 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
3386 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no |
2196 | other method takes over, select will be it. Otherwise the select backend |
3387 | other method takes over, select will be it. Otherwise the select backend |
2197 | will not be compiled in. |
3388 | will not be compiled in. |
2198 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
3389 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
2199 | .IX Item "EV_SELECT_USE_FD_SET" |
3390 | .IX Item "EV_SELECT_USE_FD_SET" |
2200 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
3391 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
2201 | structure. This is useful if libev doesn't compile due to a missing |
3392 | structure. This is useful if libev doesn't compile due to a missing |
2202 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on |
3393 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout |
2203 | exotic systems. This usually limits the range of file descriptors to some |
3394 | on exotic systems. This usually limits the range of file descriptors to |
2204 | low limit such as 1024 or might have other limitations (winsocket only |
3395 | some low limit such as 1024 or might have other limitations (winsocket |
2205 | allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might |
3396 | only allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, |
2206 | influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. |
3397 | configures the maximum size of the \f(CW\*(C`fd_set\*(C'\fR. |
2207 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
3398 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
2208 | .IX Item "EV_SELECT_IS_WINSOCKET" |
3399 | .IX Item "EV_SELECT_IS_WINSOCKET" |
2209 | When defined to \f(CW1\fR, the select backend will assume that |
3400 | When defined to \f(CW1\fR, the select backend will assume that |
2210 | select/socket/connect etc. don't understand file descriptors but |
3401 | select/socket/connect etc. don't understand file descriptors but |
2211 | wants osf handles on win32 (this is the case when the select to |
3402 | wants osf handles on win32 (this is the case when the select to |
2212 | be used is the winsock select). This means that it will call |
3403 | be used is the winsock select). This means that it will call |
2213 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
3404 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
2214 | it is assumed that all these functions actually work on fds, even |
3405 | it is assumed that all these functions actually work on fds, even |
2215 | on win32. Should not be defined on non\-win32 platforms. |
3406 | on win32. Should not be defined on non\-win32 platforms. |
|
|
3407 | .IP "\s-1EV_FD_TO_WIN32_HANDLE\s0" 4 |
|
|
3408 | .IX Item "EV_FD_TO_WIN32_HANDLE" |
|
|
3409 | If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map |
|
|
3410 | file descriptors to socket handles. When not defining this symbol (the |
|
|
3411 | default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually |
|
|
3412 | correct. In some cases, programs use their own file descriptor management, |
|
|
3413 | in which case they can provide this function to map fds to socket handles. |
2216 | .IP "\s-1EV_USE_POLL\s0" 4 |
3414 | .IP "\s-1EV_USE_POLL\s0" 4 |
2217 | .IX Item "EV_USE_POLL" |
3415 | .IX Item "EV_USE_POLL" |
2218 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
3416 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
2219 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
3417 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
2220 | takes precedence over select. |
3418 | takes precedence over select. |
2221 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
3419 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
2222 | .IX Item "EV_USE_EPOLL" |
3420 | .IX Item "EV_USE_EPOLL" |
2223 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
3421 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
2224 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
3422 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
2225 | otherwise another method will be used as fallback. This is the |
3423 | otherwise another method will be used as fallback. This is the preferred |
2226 | preferred backend for GNU/Linux systems. |
3424 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
|
|
3425 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
2227 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
3426 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
2228 | .IX Item "EV_USE_KQUEUE" |
3427 | .IX Item "EV_USE_KQUEUE" |
2229 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
3428 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
2230 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
3429 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
2231 | otherwise another method will be used as fallback. This is the preferred |
3430 | otherwise another method will be used as fallback. This is the preferred |
… | |
… | |
2241 | 10 port style backend. Its availability will be detected at runtime, |
3440 | 10 port style backend. Its availability will be detected at runtime, |
2242 | otherwise another method will be used as fallback. This is the preferred |
3441 | otherwise another method will be used as fallback. This is the preferred |
2243 | backend for Solaris 10 systems. |
3442 | backend for Solaris 10 systems. |
2244 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
3443 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2245 | .IX Item "EV_USE_DEVPOLL" |
3444 | .IX Item "EV_USE_DEVPOLL" |
2246 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
3445 | Reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2247 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
3446 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
2248 | .IX Item "EV_USE_INOTIFY" |
3447 | .IX Item "EV_USE_INOTIFY" |
2249 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
3448 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
2250 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
3449 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
2251 | be detected at runtime. |
3450 | be detected at runtime. If undefined, it will be enabled if the headers |
|
|
3451 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
|
|
3452 | .IP "\s-1EV_ATOMIC_T\s0" 4 |
|
|
3453 | .IX Item "EV_ATOMIC_T" |
|
|
3454 | Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose |
|
|
3455 | access is atomic with respect to other threads or signal contexts. No such |
|
|
3456 | type is easily found in the C language, so you can provide your own type |
|
|
3457 | that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" |
|
|
3458 | as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. |
|
|
3459 | .Sp |
|
|
3460 | In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR |
|
|
3461 | (from \fIsignal.h\fR), which is usually good enough on most platforms. |
2252 | .IP "\s-1EV_H\s0" 4 |
3462 | .IP "\s-1EV_H\s0" 4 |
2253 | .IX Item "EV_H" |
3463 | .IX Item "EV_H" |
2254 | The name of the \fIev.h\fR header file used to include it. The default if |
3464 | The name of the \fIev.h\fR header file used to include it. The default if |
2255 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
3465 | undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be |
2256 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
3466 | used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2257 | .IP "\s-1EV_CONFIG_H\s0" 4 |
3467 | .IP "\s-1EV_CONFIG_H\s0" 4 |
2258 | .IX Item "EV_CONFIG_H" |
3468 | .IX Item "EV_CONFIG_H" |
2259 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
3469 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
2260 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
3470 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
2261 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
3471 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
2262 | .IP "\s-1EV_EVENT_H\s0" 4 |
3472 | .IP "\s-1EV_EVENT_H\s0" 4 |
2263 | .IX Item "EV_EVENT_H" |
3473 | .IX Item "EV_EVENT_H" |
2264 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
3474 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
2265 | of how the \fIevent.h\fR header can be found. |
3475 | of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. |
2266 | .IP "\s-1EV_PROTOTYPES\s0" 4 |
3476 | .IP "\s-1EV_PROTOTYPES\s0" 4 |
2267 | .IX Item "EV_PROTOTYPES" |
3477 | .IX Item "EV_PROTOTYPES" |
2268 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
3478 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
2269 | prototypes, but still define all the structs and other symbols. This is |
3479 | prototypes, but still define all the structs and other symbols. This is |
2270 | occasionally useful if you want to provide your own wrapper functions |
3480 | occasionally useful if you want to provide your own wrapper functions |
… | |
… | |
2274 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
3484 | If undefined or defined to \f(CW1\fR, then all event-loop-specific functions |
2275 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
3485 | will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create |
2276 | additional independent event loops. Otherwise there will be no support |
3486 | additional independent event loops. Otherwise there will be no support |
2277 | for multiple event loops and there is no first event loop pointer |
3487 | for multiple event loops and there is no first event loop pointer |
2278 | argument. Instead, all functions act on the single default loop. |
3488 | argument. Instead, all functions act on the single default loop. |
|
|
3489 | .IP "\s-1EV_MINPRI\s0" 4 |
|
|
3490 | .IX Item "EV_MINPRI" |
|
|
3491 | .PD 0 |
|
|
3492 | .IP "\s-1EV_MAXPRI\s0" 4 |
|
|
3493 | .IX Item "EV_MAXPRI" |
|
|
3494 | .PD |
|
|
3495 | The range of allowed priorities. \f(CW\*(C`EV_MINPRI\*(C'\fR must be smaller or equal to |
|
|
3496 | \&\f(CW\*(C`EV_MAXPRI\*(C'\fR, but otherwise there are no non-obvious limitations. You can |
|
|
3497 | provide for more priorities by overriding those symbols (usually defined |
|
|
3498 | to be \f(CW\*(C`\-2\*(C'\fR and \f(CW2\fR, respectively). |
|
|
3499 | .Sp |
|
|
3500 | When doing priority-based operations, libev usually has to linearly search |
|
|
3501 | all the priorities, so having many of them (hundreds) uses a lot of space |
|
|
3502 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
|
|
3503 | fine. |
|
|
3504 | .Sp |
|
|
3505 | If your embedding application does not need any priorities, defining these |
|
|
3506 | both to \f(CW0\fR will save some memory and \s-1CPU\s0. |
2279 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
3507 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
2280 | .IX Item "EV_PERIODIC_ENABLE" |
3508 | .IX Item "EV_PERIODIC_ENABLE" |
2281 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
3509 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
2282 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
3510 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2283 | code. |
3511 | code. |
… | |
… | |
2287 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
3515 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
2288 | code. |
3516 | code. |
2289 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
3517 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
2290 | .IX Item "EV_EMBED_ENABLE" |
3518 | .IX Item "EV_EMBED_ENABLE" |
2291 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
3519 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
2292 | defined to be \f(CW0\fR, then they are not. |
3520 | defined to be \f(CW0\fR, then they are not. Embed watchers rely on most other |
|
|
3521 | watcher types, which therefore must not be disabled. |
2293 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
3522 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
2294 | .IX Item "EV_STAT_ENABLE" |
3523 | .IX Item "EV_STAT_ENABLE" |
2295 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
3524 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
2296 | defined to be \f(CW0\fR, then they are not. |
3525 | defined to be \f(CW0\fR, then they are not. |
2297 | .IP "\s-1EV_FORK_ENABLE\s0" 4 |
3526 | .IP "\s-1EV_FORK_ENABLE\s0" 4 |
2298 | .IX Item "EV_FORK_ENABLE" |
3527 | .IX Item "EV_FORK_ENABLE" |
2299 | If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If |
3528 | If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If |
2300 | defined to be \f(CW0\fR, then they are not. |
3529 | defined to be \f(CW0\fR, then they are not. |
|
|
3530 | .IP "\s-1EV_ASYNC_ENABLE\s0" 4 |
|
|
3531 | .IX Item "EV_ASYNC_ENABLE" |
|
|
3532 | If undefined or defined to be \f(CW1\fR, then async watchers are supported. If |
|
|
3533 | defined to be \f(CW0\fR, then they are not. |
2301 | .IP "\s-1EV_MINIMAL\s0" 4 |
3534 | .IP "\s-1EV_MINIMAL\s0" 4 |
2302 | .IX Item "EV_MINIMAL" |
3535 | .IX Item "EV_MINIMAL" |
2303 | If you need to shave off some kilobytes of code at the expense of some |
3536 | If you need to shave off some kilobytes of code at the expense of some |
2304 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
3537 | speed, define this symbol to \f(CW1\fR. Currently this is used to override some |
2305 | some inlining decisions, saves roughly 30% codesize of amd64. |
3538 | inlining decisions, saves roughly 30% code size on amd64. It also selects a |
|
|
3539 | much smaller 2\-heap for timer management over the default 4\-heap. |
2306 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
3540 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2307 | .IX Item "EV_PID_HASHSIZE" |
3541 | .IX Item "EV_PID_HASHSIZE" |
2308 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
3542 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2309 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
3543 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
2310 | than enough. If you need to manage thousands of children you might want to |
3544 | than enough. If you need to manage thousands of children you might want to |
2311 | increase this value (\fImust\fR be a power of two). |
3545 | increase this value (\fImust\fR be a power of two). |
2312 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
3546 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
2313 | .IX Item "EV_INOTIFY_HASHSIZE" |
3547 | .IX Item "EV_INOTIFY_HASHSIZE" |
2314 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
3548 | \&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by |
2315 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
3549 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
2316 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
3550 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
2317 | watchers you might want to increase this value (\fImust\fR be a power of |
3551 | watchers you might want to increase this value (\fImust\fR be a power of |
2318 | two). |
3552 | two). |
|
|
3553 | .IP "\s-1EV_USE_4HEAP\s0" 4 |
|
|
3554 | .IX Item "EV_USE_4HEAP" |
|
|
3555 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
|
|
3556 | timer and periodics heaps, libev uses a 4\-heap when this symbol is defined |
|
|
3557 | to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably |
|
|
3558 | faster performance with many (thousands) of watchers. |
|
|
3559 | .Sp |
|
|
3560 | The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR |
|
|
3561 | (disabled). |
|
|
3562 | .IP "\s-1EV_HEAP_CACHE_AT\s0" 4 |
|
|
3563 | .IX Item "EV_HEAP_CACHE_AT" |
|
|
3564 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
|
|
3565 | timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within |
|
|
3566 | the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), |
|
|
3567 | which uses 8\-12 bytes more per watcher and a few hundred bytes more code, |
|
|
3568 | but avoids random read accesses on heap changes. This improves performance |
|
|
3569 | noticeably with many (hundreds) of watchers. |
|
|
3570 | .Sp |
|
|
3571 | The default is \f(CW1\fR unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set in which case it is \f(CW0\fR |
|
|
3572 | (disabled). |
|
|
3573 | .IP "\s-1EV_VERIFY\s0" 4 |
|
|
3574 | .IX Item "EV_VERIFY" |
|
|
3575 | Controls how much internal verification (see \f(CW\*(C`ev_loop_verify ()\*(C'\fR) will |
|
|
3576 | be done: If set to \f(CW0\fR, no internal verification code will be compiled |
|
|
3577 | in. If set to \f(CW1\fR, then verification code will be compiled in, but not |
|
|
3578 | called. If set to \f(CW2\fR, then the internal verification code will be |
|
|
3579 | called once per loop, which can slow down libev. If set to \f(CW3\fR, then the |
|
|
3580 | verification code will be called very frequently, which will slow down |
|
|
3581 | libev considerably. |
|
|
3582 | .Sp |
|
|
3583 | The default is \f(CW1\fR, unless \f(CW\*(C`EV_MINIMAL\*(C'\fR is set, in which case it will be |
|
|
3584 | \&\f(CW0\fR. |
2319 | .IP "\s-1EV_COMMON\s0" 4 |
3585 | .IP "\s-1EV_COMMON\s0" 4 |
2320 | .IX Item "EV_COMMON" |
3586 | .IX Item "EV_COMMON" |
2321 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
3587 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2322 | this macro to a something else you can include more and other types of |
3588 | this macro to a something else you can include more and other types of |
2323 | members. You have to define it each time you include one of the files, |
3589 | members. You have to define it each time you include one of the files, |
2324 | though, and it must be identical each time. |
3590 | though, and it must be identical each time. |
2325 | .Sp |
3591 | .Sp |
2326 | For example, the perl \s-1EV\s0 module uses something like this: |
3592 | For example, the perl \s-1EV\s0 module uses something like this: |
2327 | .Sp |
3593 | .Sp |
2328 | .Vb 3 |
3594 | .Vb 3 |
2329 | \& #define EV_COMMON \e |
3595 | \& #define EV_COMMON \e |
2330 | \& SV *self; /* contains this struct */ \e |
3596 | \& SV *self; /* contains this struct */ \e |
2331 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
3597 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
2332 | .Ve |
3598 | .Ve |
2333 | .IP "\s-1EV_CB_DECLARE\s0 (type)" 4 |
3599 | .IP "\s-1EV_CB_DECLARE\s0 (type)" 4 |
2334 | .IX Item "EV_CB_DECLARE (type)" |
3600 | .IX Item "EV_CB_DECLARE (type)" |
2335 | .PD 0 |
3601 | .PD 0 |
2336 | .IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 |
3602 | .IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 |
… | |
… | |
2338 | .IP "ev_set_cb (ev, cb)" 4 |
3604 | .IP "ev_set_cb (ev, cb)" 4 |
2339 | .IX Item "ev_set_cb (ev, cb)" |
3605 | .IX Item "ev_set_cb (ev, cb)" |
2340 | .PD |
3606 | .PD |
2341 | Can be used to change the callback member declaration in each watcher, |
3607 | Can be used to change the callback member declaration in each watcher, |
2342 | and the way callbacks are invoked and set. Must expand to a struct member |
3608 | and the way callbacks are invoked and set. Must expand to a struct member |
2343 | definition and a statement, respectively. See the \fIev.v\fR header file for |
3609 | definition and a statement, respectively. See the \fIev.h\fR header file for |
2344 | their default definitions. One possible use for overriding these is to |
3610 | their default definitions. One possible use for overriding these is to |
2345 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
3611 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2346 | method calls instead of plain function calls in \*(C+. |
3612 | method calls instead of plain function calls in \*(C+. |
|
|
3613 | .Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
|
|
3614 | .IX Subsection "EXPORTED API SYMBOLS" |
|
|
3615 | If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of |
|
|
3616 | exported symbols, you can use the provided \fISymbol.*\fR files which list |
|
|
3617 | all public symbols, one per line: |
|
|
3618 | .PP |
|
|
3619 | .Vb 2 |
|
|
3620 | \& Symbols.ev for libev proper |
|
|
3621 | \& Symbols.event for the libevent emulation |
|
|
3622 | .Ve |
|
|
3623 | .PP |
|
|
3624 | This can also be used to rename all public symbols to avoid clashes with |
|
|
3625 | multiple versions of libev linked together (which is obviously bad in |
|
|
3626 | itself, but sometimes it is inconvenient to avoid this). |
|
|
3627 | .PP |
|
|
3628 | A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
|
|
3629 | include before including \fIev.h\fR: |
|
|
3630 | .PP |
|
|
3631 | .Vb 1 |
|
|
3632 | \& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
3633 | .Ve |
|
|
3634 | .PP |
|
|
3635 | This would create a file \fIwrap.h\fR which essentially looks like this: |
|
|
3636 | .PP |
|
|
3637 | .Vb 4 |
|
|
3638 | \& #define ev_backend myprefix_ev_backend |
|
|
3639 | \& #define ev_check_start myprefix_ev_check_start |
|
|
3640 | \& #define ev_check_stop myprefix_ev_check_stop |
|
|
3641 | \& ... |
|
|
3642 | .Ve |
2347 | .Sh "\s-1EXAMPLES\s0" |
3643 | .Sh "\s-1EXAMPLES\s0" |
2348 | .IX Subsection "EXAMPLES" |
3644 | .IX Subsection "EXAMPLES" |
2349 | For a real-world example of a program the includes libev |
3645 | For a real-world example of a program the includes libev |
2350 | verbatim, you can have a look at the \s-1EV\s0 perl module |
3646 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2351 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
3647 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
2352 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
3648 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
2353 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
3649 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2354 | will be compiled. It is pretty complex because it provides its own header |
3650 | will be compiled. It is pretty complex because it provides its own header |
2355 | file. |
3651 | file. |
2356 | .Sp |
3652 | .PP |
2357 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
3653 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2358 | that everybody includes and which overrides some configure choices: |
3654 | that everybody includes and which overrides some configure choices: |
2359 | .Sp |
3655 | .PP |
2360 | .Vb 9 |
3656 | .Vb 9 |
2361 | \& #define EV_MINIMAL 1 |
3657 | \& #define EV_MINIMAL 1 |
2362 | \& #define EV_USE_POLL 0 |
3658 | \& #define EV_USE_POLL 0 |
2363 | \& #define EV_MULTIPLICITY 0 |
3659 | \& #define EV_MULTIPLICITY 0 |
2364 | \& #define EV_PERIODIC_ENABLE 0 |
3660 | \& #define EV_PERIODIC_ENABLE 0 |
2365 | \& #define EV_STAT_ENABLE 0 |
3661 | \& #define EV_STAT_ENABLE 0 |
2366 | \& #define EV_FORK_ENABLE 0 |
3662 | \& #define EV_FORK_ENABLE 0 |
2367 | \& #define EV_CONFIG_H <config.h> |
3663 | \& #define EV_CONFIG_H <config.h> |
2368 | \& #define EV_MINPRI 0 |
3664 | \& #define EV_MINPRI 0 |
2369 | \& #define EV_MAXPRI 0 |
3665 | \& #define EV_MAXPRI 0 |
2370 | .Ve |
3666 | \& |
2371 | .Sp |
|
|
2372 | .Vb 1 |
|
|
2373 | \& #include "ev++.h" |
3667 | \& #include "ev++.h" |
2374 | .Ve |
3668 | .Ve |
2375 | .Sp |
3669 | .PP |
2376 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
3670 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
2377 | .Sp |
3671 | .PP |
2378 | .Vb 2 |
3672 | .Vb 2 |
2379 | \& #include "ev_cpp.h" |
3673 | \& #include "ev_cpp.h" |
2380 | \& #include "ev.c" |
3674 | \& #include "ev.c" |
2381 | .Ve |
3675 | .Ve |
|
|
3676 | .SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" |
|
|
3677 | .IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" |
|
|
3678 | .Sh "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" |
|
|
3679 | .IX Subsection "THREADS AND COROUTINES" |
|
|
3680 | \fI\s-1THREADS\s0\fR |
|
|
3681 | .IX Subsection "THREADS" |
|
|
3682 | .PP |
|
|
3683 | All libev functions are reentrant and thread-safe unless explicitly |
|
|
3684 | documented otherwise, but libev implements no locking itself. This means |
|
|
3685 | that you can use as many loops as you want in parallel, as long as there |
|
|
3686 | are no concurrent calls into any libev function with the same loop |
|
|
3687 | parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter, |
|
|
3688 | of course): libev guarantees that different event loops share no data |
|
|
3689 | structures that need any locking. |
|
|
3690 | .PP |
|
|
3691 | Or to put it differently: calls with different loop parameters can be done |
|
|
3692 | concurrently from multiple threads, calls with the same loop parameter |
|
|
3693 | must be done serially (but can be done from different threads, as long as |
|
|
3694 | only one thread ever is inside a call at any point in time, e.g. by using |
|
|
3695 | a mutex per loop). |
|
|
3696 | .PP |
|
|
3697 | Specifically to support threads (and signal handlers), libev implements |
|
|
3698 | so-called \f(CW\*(C`ev_async\*(C'\fR watchers, which allow some limited form of |
|
|
3699 | concurrency on the same event loop, namely waking it up \*(L"from the |
|
|
3700 | outside\*(R". |
|
|
3701 | .PP |
|
|
3702 | If you want to know which design (one loop, locking, or multiple loops |
|
|
3703 | without or something else still) is best for your problem, then I cannot |
|
|
3704 | help you, but here is some generic advice: |
|
|
3705 | .IP "\(bu" 4 |
|
|
3706 | most applications have a main thread: use the default libev loop |
|
|
3707 | in that thread, or create a separate thread running only the default loop. |
|
|
3708 | .Sp |
|
|
3709 | This helps integrating other libraries or software modules that use libev |
|
|
3710 | themselves and don't care/know about threading. |
|
|
3711 | .IP "\(bu" 4 |
|
|
3712 | one loop per thread is usually a good model. |
|
|
3713 | .Sp |
|
|
3714 | Doing this is almost never wrong, sometimes a better-performance model |
|
|
3715 | exists, but it is always a good start. |
|
|
3716 | .IP "\(bu" 4 |
|
|
3717 | other models exist, such as the leader/follower pattern, where one |
|
|
3718 | loop is handed through multiple threads in a kind of round-robin fashion. |
|
|
3719 | .Sp |
|
|
3720 | Choosing a model is hard \- look around, learn, know that usually you can do |
|
|
3721 | better than you currently do :\-) |
|
|
3722 | .IP "\(bu" 4 |
|
|
3723 | often you need to talk to some other thread which blocks in the |
|
|
3724 | event loop. |
|
|
3725 | .Sp |
|
|
3726 | \&\f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other threads safely |
|
|
3727 | (or from signal contexts...). |
|
|
3728 | .Sp |
|
|
3729 | An example use would be to communicate signals or other events that only |
|
|
3730 | work in the default loop by registering the signal watcher with the |
|
|
3731 | default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop |
|
|
3732 | watcher callback into the event loop interested in the signal. |
|
|
3733 | .PP |
|
|
3734 | \fI\s-1COROUTINES\s0\fR |
|
|
3735 | .IX Subsection "COROUTINES" |
|
|
3736 | .PP |
|
|
3737 | Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): |
|
|
3738 | libev fully supports nesting calls to its functions from different |
|
|
3739 | coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two |
|
|
3740 | different coroutines, and switch freely between both coroutines running the |
|
|
3741 | loop, as long as you don't confuse yourself). The only exception is that |
|
|
3742 | you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. |
|
|
3743 | .PP |
|
|
3744 | Care has been taken to ensure that libev does not keep local state inside |
|
|
3745 | \&\f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow for coroutine switches as |
|
|
3746 | they do not call any callbacks. |
|
|
3747 | .Sh "\s-1COMPILER\s0 \s-1WARNINGS\s0" |
|
|
3748 | .IX Subsection "COMPILER WARNINGS" |
|
|
3749 | Depending on your compiler and compiler settings, you might get no or a |
|
|
3750 | lot of warnings when compiling libev code. Some people are apparently |
|
|
3751 | scared by this. |
|
|
3752 | .PP |
|
|
3753 | However, these are unavoidable for many reasons. For one, each compiler |
|
|
3754 | has different warnings, and each user has different tastes regarding |
|
|
3755 | warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when |
|
|
3756 | targeting a specific compiler and compiler-version. |
|
|
3757 | .PP |
|
|
3758 | Another reason is that some compiler warnings require elaborate |
|
|
3759 | workarounds, or other changes to the code that make it less clear and less |
|
|
3760 | maintainable. |
|
|
3761 | .PP |
|
|
3762 | And of course, some compiler warnings are just plain stupid, or simply |
|
|
3763 | wrong (because they don't actually warn about the condition their message |
|
|
3764 | seems to warn about). For example, certain older gcc versions had some |
|
|
3765 | warnings that resulted an extreme number of false positives. These have |
|
|
3766 | been fixed, but some people still insist on making code warn-free with |
|
|
3767 | such buggy versions. |
|
|
3768 | .PP |
|
|
3769 | While libev is written to generate as few warnings as possible, |
|
|
3770 | \&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev |
|
|
3771 | with any compiler warnings enabled unless you are prepared to cope with |
|
|
3772 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
3773 | warnings, not errors, or proof of bugs. |
|
|
3774 | .Sh "\s-1VALGRIND\s0" |
|
|
3775 | .IX Subsection "VALGRIND" |
|
|
3776 | Valgrind has a special section here because it is a popular tool that is |
|
|
3777 | highly useful. Unfortunately, valgrind reports are very hard to interpret. |
|
|
3778 | .PP |
|
|
3779 | If you think you found a bug (memory leak, uninitialised data access etc.) |
|
|
3780 | in libev, then check twice: If valgrind reports something like: |
|
|
3781 | .PP |
|
|
3782 | .Vb 3 |
|
|
3783 | \& ==2274== definitely lost: 0 bytes in 0 blocks. |
|
|
3784 | \& ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
3785 | \& ==2274== still reachable: 256 bytes in 1 blocks. |
|
|
3786 | .Ve |
|
|
3787 | .PP |
|
|
3788 | Then there is no memory leak, just as memory accounted to global variables |
|
|
3789 | is not a memleak \- the memory is still being referenced, and didn't leak. |
|
|
3790 | .PP |
|
|
3791 | Similarly, under some circumstances, valgrind might report kernel bugs |
|
|
3792 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
|
|
3793 | although an acceptable workaround has been found here), or it might be |
|
|
3794 | confused. |
|
|
3795 | .PP |
|
|
3796 | Keep in mind that valgrind is a very good tool, but only a tool. Don't |
|
|
3797 | make it into some kind of religion. |
|
|
3798 | .PP |
|
|
3799 | If you are unsure about something, feel free to contact the mailing list |
|
|
3800 | with the full valgrind report and an explanation on why you think this |
|
|
3801 | is a bug in libev (best check the archives, too :). However, don't be |
|
|
3802 | annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance |
|
|
3803 | of learning how to interpret valgrind properly. |
|
|
3804 | .PP |
|
|
3805 | If you need, for some reason, empty reports from valgrind for your project |
|
|
3806 | I suggest using suppression lists. |
|
|
3807 | .SH "PORTABILITY NOTES" |
|
|
3808 | .IX Header "PORTABILITY NOTES" |
|
|
3809 | .Sh "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" |
|
|
3810 | .IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" |
|
|
3811 | Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev |
|
|
3812 | requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 |
|
|
3813 | model. Libev still offers limited functionality on this platform in |
|
|
3814 | the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket |
|
|
3815 | descriptors. This only applies when using Win32 natively, not when using |
|
|
3816 | e.g. cygwin. |
|
|
3817 | .PP |
|
|
3818 | Lifting these limitations would basically require the full |
|
|
3819 | re-implementation of the I/O system. If you are into these kinds of |
|
|
3820 | things, then note that glib does exactly that for you in a very portable |
|
|
3821 | way (note also that glib is the slowest event library known to man). |
|
|
3822 | .PP |
|
|
3823 | There is no supported compilation method available on windows except |
|
|
3824 | embedding it into other applications. |
|
|
3825 | .PP |
|
|
3826 | Not a libev limitation but worth mentioning: windows apparently doesn't |
|
|
3827 | accept large writes: instead of resulting in a partial write, windows will |
|
|
3828 | either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large, |
|
|
3829 | so make sure you only write small amounts into your sockets (less than a |
|
|
3830 | megabyte seems safe, but this apparently depends on the amount of memory |
|
|
3831 | available). |
|
|
3832 | .PP |
|
|
3833 | Due to the many, low, and arbitrary limits on the win32 platform and |
|
|
3834 | the abysmal performance of winsockets, using a large number of sockets |
|
|
3835 | is not recommended (and not reasonable). If your program needs to use |
|
|
3836 | more than a hundred or so sockets, then likely it needs to use a totally |
|
|
3837 | different implementation for windows, as libev offers the \s-1POSIX\s0 readiness |
|
|
3838 | notification model, which cannot be implemented efficiently on windows |
|
|
3839 | (Microsoft monopoly games). |
|
|
3840 | .PP |
|
|
3841 | A typical way to use libev under windows is to embed it (see the embedding |
|
|
3842 | section for details) and use the following \fIevwrap.h\fR header file instead |
|
|
3843 | of \fIev.h\fR: |
|
|
3844 | .PP |
|
|
3845 | .Vb 2 |
|
|
3846 | \& #define EV_STANDALONE /* keeps ev from requiring config.h */ |
|
|
3847 | \& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
|
|
3848 | \& |
|
|
3849 | \& #include "ev.h" |
|
|
3850 | .Ve |
|
|
3851 | .PP |
|
|
3852 | And compile the following \fIevwrap.c\fR file into your project (make sure |
|
|
3853 | you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!): |
|
|
3854 | .PP |
|
|
3855 | .Vb 2 |
|
|
3856 | \& #include "evwrap.h" |
|
|
3857 | \& #include "ev.c" |
|
|
3858 | .Ve |
|
|
3859 | .IP "The winsocket select function" 4 |
|
|
3860 | .IX Item "The winsocket select function" |
|
|
3861 | The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it |
|
|
3862 | requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is |
|
|
3863 | also extremely buggy). This makes select very inefficient, and also |
|
|
3864 | requires a mapping from file descriptors to socket handles (the Microsoft |
|
|
3865 | C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the |
|
|
3866 | discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and |
|
|
3867 | \&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info. |
|
|
3868 | .Sp |
|
|
3869 | The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime |
|
|
3870 | libraries and raw winsocket select is: |
|
|
3871 | .Sp |
|
|
3872 | .Vb 2 |
|
|
3873 | \& #define EV_USE_SELECT 1 |
|
|
3874 | \& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
|
|
3875 | .Ve |
|
|
3876 | .Sp |
|
|
3877 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
|
|
3878 | complexity in the O(nA\*^X) range when using win32. |
|
|
3879 | .IP "Limited number of file descriptors" 4 |
|
|
3880 | .IX Item "Limited number of file descriptors" |
|
|
3881 | Windows has numerous arbitrary (and low) limits on things. |
|
|
3882 | .Sp |
|
|
3883 | Early versions of winsocket's select only supported waiting for a maximum |
|
|
3884 | of \f(CW64\fR handles (probably owning to the fact that all windows kernels |
|
|
3885 | can only wait for \f(CW64\fR things at the same time internally; Microsoft |
|
|
3886 | recommends spawning a chain of threads and wait for 63 handles and the |
|
|
3887 | previous thread in each. Great). |
|
|
3888 | .Sp |
|
|
3889 | Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR |
|
|
3890 | to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select |
|
|
3891 | call (which might be in libev or elsewhere, for example, perl does its own |
|
|
3892 | select emulation on windows). |
|
|
3893 | .Sp |
|
|
3894 | Another limit is the number of file descriptors in the Microsoft runtime |
|
|
3895 | libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish |
|
|
3896 | or something like this inside Microsoft). You can increase this by calling |
|
|
3897 | \&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another |
|
|
3898 | arbitrary limit), but is broken in many versions of the Microsoft runtime |
|
|
3899 | libraries. |
|
|
3900 | .Sp |
|
|
3901 | This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on |
|
|
3902 | windows version and/or the phase of the moon). To get more, you need to |
|
|
3903 | wrap all I/O functions and provide your own fd management, but the cost of |
|
|
3904 | calling select (O(nA\*^X)) will likely make this unworkable. |
|
|
3905 | .Sh "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" |
|
|
3906 | .IX Subsection "PORTABILITY REQUIREMENTS" |
|
|
3907 | In addition to a working ISO-C implementation and of course the |
|
|
3908 | backend-specific APIs, libev relies on a few additional extensions: |
|
|
3909 | .ie n .IP """void (*)(ev_watcher_type *, int revents)""\fR must have compatible calling conventions regardless of \f(CW""ev_watcher_type *""." 4 |
|
|
3910 | .el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 |
|
|
3911 | .IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." |
|
|
3912 | Libev assumes not only that all watcher pointers have the same internal |
|
|
3913 | structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also |
|
|
3914 | assumes that the same (machine) code can be used to call any watcher |
|
|
3915 | callback: The watcher callbacks have different type signatures, but libev |
|
|
3916 | calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. |
|
|
3917 | .ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 |
|
|
3918 | .el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 |
|
|
3919 | .IX Item "sig_atomic_t volatile must be thread-atomic as well" |
|
|
3920 | The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as |
|
|
3921 | \&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different |
|
|
3922 | threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is |
|
|
3923 | believed to be sufficiently portable. |
|
|
3924 | .ie n .IP """sigprocmask"" must work in a threaded environment" 4 |
|
|
3925 | .el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4 |
|
|
3926 | .IX Item "sigprocmask must work in a threaded environment" |
|
|
3927 | Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not |
|
|
3928 | allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical |
|
|
3929 | pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main |
|
|
3930 | thread\*(R" or will block signals process-wide, both behaviours would |
|
|
3931 | be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and |
|
|
3932 | \&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. |
|
|
3933 | .Sp |
|
|
3934 | The most portable way to handle signals is to block signals in all threads |
|
|
3935 | except the initial one, and run the default loop in the initial thread as |
|
|
3936 | well. |
|
|
3937 | .ie n .IP """long"" must be large enough for common memory allocation sizes" 4 |
|
|
3938 | .el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 |
|
|
3939 | .IX Item "long must be large enough for common memory allocation sizes" |
|
|
3940 | To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally |
|
|
3941 | instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX |
|
|
3942 | systems (Microsoft...) this might be unexpectedly low, but is still at |
|
|
3943 | least 31 bits everywhere, which is enough for hundreds of millions of |
|
|
3944 | watchers. |
|
|
3945 | .ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 |
|
|
3946 | .el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 |
|
|
3947 | .IX Item "double must hold a time value in seconds with enough accuracy" |
|
|
3948 | The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to |
|
|
3949 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
|
|
3950 | enough for at least into the year 4000. This requirement is fulfilled by |
|
|
3951 | implementations implementing \s-1IEEE\s0 754 (basically all existing ones). |
|
|
3952 | .PP |
|
|
3953 | If you know of other additional requirements drop me a note. |
2382 | .SH "COMPLEXITIES" |
3954 | .SH "ALGORITHMIC COMPLEXITIES" |
2383 | .IX Header "COMPLEXITIES" |
3955 | .IX Header "ALGORITHMIC COMPLEXITIES" |
2384 | In this section the complexities of (many of) the algorithms used inside |
3956 | In this section the complexities of (many of) the algorithms used inside |
2385 | libev will be explained. For complexity discussions about backends see the |
3957 | libev will be documented. For complexity discussions about backends see |
2386 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
3958 | the documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2387 | .RS 4 |
3959 | .PP |
|
|
3960 | All of the following are about amortised time: If an array needs to be |
|
|
3961 | extended, libev needs to realloc and move the whole array, but this |
|
|
3962 | happens asymptotically rarer with higher number of elements, so O(1) might |
|
|
3963 | mean that libev does a lengthy realloc operation in rare cases, but on |
|
|
3964 | average it is much faster and asymptotically approaches constant time. |
2388 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
3965 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2389 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
3966 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
|
|
3967 | This means that, when you have a watcher that triggers in one hour and |
|
|
3968 | there are 100 watchers that would trigger before that, then inserting will |
|
|
3969 | have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers. |
|
|
3970 | .IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4 |
|
|
3971 | .IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" |
|
|
3972 | That means that changing a timer costs less than removing/adding them, |
|
|
3973 | as only the relative motion in the event queue has to be paid for. |
|
|
3974 | .IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4 |
|
|
3975 | .IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" |
|
|
3976 | These just add the watcher into an array or at the head of a list. |
|
|
3977 | .IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4 |
|
|
3978 | .IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)" |
2390 | .PD 0 |
3979 | .PD 0 |
2391 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
|
|
2392 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
|
|
2393 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
|
|
2394 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
|
|
2395 | .IP "Stopping check/prepare/idle watchers: O(1)" 4 |
|
|
2396 | .IX Item "Stopping check/prepare/idle watchers: O(1)" |
|
|
2397 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
3980 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2398 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
3981 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
3982 | .PD |
|
|
3983 | These watchers are stored in lists, so they need to be walked to find the |
|
|
3984 | correct watcher to remove. The lists are usually short (you don't usually |
|
|
3985 | have many watchers waiting for the same fd or signal: one is typical, two |
|
|
3986 | is rare). |
2399 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
3987 | .IP "Finding the next timer in each loop iteration: O(1)" 4 |
2400 | .IX Item "Finding the next timer per loop iteration: O(1)" |
3988 | .IX Item "Finding the next timer in each loop iteration: O(1)" |
|
|
3989 | By virtue of using a binary or 4\-heap, the next timer is always found at a |
|
|
3990 | fixed position in the storage array. |
2401 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
3991 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2402 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
3992 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2403 | .IP "Activating one watcher: O(1)" 4 |
3993 | A change means an I/O watcher gets started or stopped, which requires |
2404 | .IX Item "Activating one watcher: O(1)" |
3994 | libev to recalculate its status (and possibly tell the kernel, depending |
2405 | .RE |
3995 | on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used). |
2406 | .RS 4 |
3996 | .IP "Activating one watcher (putting it into the pending state): O(1)" 4 |
|
|
3997 | .IX Item "Activating one watcher (putting it into the pending state): O(1)" |
|
|
3998 | .PD 0 |
|
|
3999 | .IP "Priority handling: O(number_of_priorities)" 4 |
|
|
4000 | .IX Item "Priority handling: O(number_of_priorities)" |
2407 | .PD |
4001 | .PD |
|
|
4002 | Priorities are implemented by allocating some space for each |
|
|
4003 | priority. When doing priority-based operations, libev usually has to |
|
|
4004 | linearly search all the priorities, but starting/stopping and activating |
|
|
4005 | watchers becomes O(1) with respect to priority handling. |
|
|
4006 | .IP "Sending an ev_async: O(1)" 4 |
|
|
4007 | .IX Item "Sending an ev_async: O(1)" |
|
|
4008 | .PD 0 |
|
|
4009 | .IP "Processing ev_async_send: O(number_of_async_watchers)" 4 |
|
|
4010 | .IX Item "Processing ev_async_send: O(number_of_async_watchers)" |
|
|
4011 | .IP "Processing signals: O(max_signal_number)" 4 |
|
|
4012 | .IX Item "Processing signals: O(max_signal_number)" |
|
|
4013 | .PD |
|
|
4014 | Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR |
|
|
4015 | calls in the current loop iteration. Checking for async and signal events |
|
|
4016 | involves iterating over all running async watchers or all signal numbers. |
2408 | .SH "AUTHOR" |
4017 | .SH "AUTHOR" |
2409 | .IX Header "AUTHOR" |
4018 | .IX Header "AUTHOR" |
2410 | Marc Lehmann <libev@schmorp.de>. |
4019 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |