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