1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 |
1 | .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
|
|
6 | .br |
|
|
7 | .if t .Sp |
|
|
8 | .ne 5 |
|
|
9 | .PP |
|
|
10 | \fB\\$1\fR |
|
|
11 | .PP |
|
|
12 | .. |
|
|
13 | .de Sp \" Vertical space (when we can't use .PP) |
5 | .de Sp \" Vertical space (when we can't use .PP) |
14 | .if t .sp .5v |
6 | .if t .sp .5v |
15 | .if n .sp |
7 | .if n .sp |
16 | .. |
8 | .. |
17 | .de Vb \" Begin verbatim text |
9 | .de Vb \" Begin verbatim text |
… | |
… | |
23 | .ft R |
15 | .ft R |
24 | .fi |
16 | .fi |
25 | .. |
17 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
18 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
19 | .\" 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 |
20 | .\" 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 |
21 | .\" 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' |
22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
23 | .\" nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
24 | .tr \(*W- |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
26 | .ie n \{\ |
35 | . ds -- \(*W- |
27 | . ds -- \(*W- |
36 | . ds PI pi |
28 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
… | |
… | |
46 | . ds PI \(*p |
38 | . ds PI \(*p |
47 | . ds L" `` |
39 | . ds L" `` |
48 | . ds R" '' |
40 | . ds R" '' |
49 | 'br\} |
41 | 'br\} |
50 | .\" |
42 | .\" |
|
|
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
|
|
44 | .ie \n(.g .ds Aq \(aq |
|
|
45 | .el .ds Aq ' |
|
|
46 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
47 | .\" 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 |
48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
50 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
51 | .ie \nF \{\ |
56 | . de IX |
52 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
53 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
54 | .. |
59 | . nr % 0 |
55 | . nr % 0 |
60 | . rr F |
56 | . rr F |
61 | .\} |
57 | .\} |
62 | .\" |
58 | .el \{\ |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
59 | . de IX |
64 | .\" way too many mistakes in technical documents. |
60 | .. |
65 | .hy 0 |
61 | .\} |
66 | .if n .na |
|
|
67 | .\" |
62 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
65 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
66 | .if n \{\ |
… | |
… | |
126 | . ds Ae AE |
121 | . ds Ae AE |
127 | .\} |
122 | .\} |
128 | .rm #[ #] #H #V #F C |
123 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
124 | .\" ======================================================================== |
130 | .\" |
125 | .\" |
131 | .IX Title ""<STANDARD INPUT>" 1" |
126 | .IX Title "LIBEV 3" |
132 | .TH "<STANDARD INPUT>" 1 "2007-12-07" "perl v5.8.8" "User Contributed Perl Documentation" |
127 | .TH LIBEV 3 "2010-11-03" "libev-4.01" "libev - high performance full featured event loop" |
|
|
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
129 | .\" way too many mistakes in technical documents. |
|
|
130 | .if n .ad l |
|
|
131 | .nh |
133 | .SH "NAME" |
132 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
133 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
134 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
135 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
136 | .Vb 1 |
138 | \& #include <ev.h> |
137 | \& #include <ev.h> |
139 | .Ve |
138 | .Ve |
140 | .SH "EXAMPLE PROGRAM" |
139 | .SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" |
141 | .IX Header "EXAMPLE PROGRAM" |
140 | .IX Subsection "EXAMPLE PROGRAM" |
142 | .Vb 1 |
|
|
143 | \& #include <ev.h> |
|
|
144 | .Ve |
|
|
145 | .PP |
|
|
146 | .Vb 2 |
141 | .Vb 2 |
|
|
142 | \& // a single header file is required |
|
|
143 | \& #include <ev.h> |
|
|
144 | \& |
|
|
145 | \& #include <stdio.h> // for puts |
|
|
146 | \& |
|
|
147 | \& // every watcher type has its own typedef\*(Aqd struct |
|
|
148 | \& // with the name ev_TYPE |
147 | \& ev_io stdin_watcher; |
149 | \& ev_io stdin_watcher; |
148 | \& ev_timer timeout_watcher; |
150 | \& ev_timer timeout_watcher; |
149 | .Ve |
151 | \& |
150 | .PP |
152 | \& // all watcher callbacks have a similar signature |
151 | .Vb 8 |
|
|
152 | \& /* called when data readable on stdin */ |
153 | \& // this callback is called when data is readable on stdin |
153 | \& static void |
154 | \& static void |
154 | \& stdin_cb (EV_P_ struct ev_io *w, int revents) |
155 | \& stdin_cb (EV_P_ ev_io *w, int revents) |
155 | \& { |
156 | \& { |
156 | \& /* puts ("stdin ready"); */ |
157 | \& puts ("stdin ready"); |
157 | \& ev_io_stop (EV_A_ w); /* just a syntax example */ |
158 | \& // for one\-shot events, one must manually stop the watcher |
158 | \& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ |
159 | \& // with its corresponding stop function. |
|
|
160 | \& ev_io_stop (EV_A_ w); |
|
|
161 | \& |
|
|
162 | \& // this causes all nested ev_run\*(Aqs to stop iterating |
|
|
163 | \& ev_break (EV_A_ EVBREAK_ALL); |
159 | \& } |
164 | \& } |
160 | .Ve |
165 | \& |
161 | .PP |
166 | \& // another callback, this time for a time\-out |
162 | .Vb 6 |
|
|
163 | \& static void |
167 | \& static void |
164 | \& timeout_cb (EV_P_ struct ev_timer *w, int revents) |
168 | \& timeout_cb (EV_P_ ev_timer *w, int revents) |
165 | \& { |
169 | \& { |
166 | \& /* puts ("timeout"); */ |
170 | \& puts ("timeout"); |
167 | \& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ |
171 | \& // this causes the innermost ev_run to stop iterating |
|
|
172 | \& ev_break (EV_A_ EVBREAK_ONE); |
168 | \& } |
173 | \& } |
169 | .Ve |
174 | \& |
170 | .PP |
|
|
171 | .Vb 4 |
|
|
172 | \& int |
175 | \& int |
173 | \& main (void) |
176 | \& main (void) |
174 | \& { |
177 | \& { |
175 | \& struct ev_loop *loop = ev_default_loop (0); |
178 | \& // use the default event loop unless you have special needs |
176 | .Ve |
179 | \& struct ev_loop *loop = EV_DEFAULT; |
177 | .PP |
180 | \& |
178 | .Vb 3 |
|
|
179 | \& /* initialise an io watcher, then start it */ |
181 | \& // initialise an io watcher, then start it |
|
|
182 | \& // this one will watch for stdin to become readable |
180 | \& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
183 | \& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); |
181 | \& ev_io_start (loop, &stdin_watcher); |
184 | \& ev_io_start (loop, &stdin_watcher); |
182 | .Ve |
185 | \& |
183 | .PP |
186 | \& // initialise a timer watcher, then start it |
184 | .Vb 3 |
|
|
185 | \& /* simple non-repeating 5.5 second timeout */ |
187 | \& // simple non\-repeating 5.5 second timeout |
186 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
188 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
187 | \& ev_timer_start (loop, &timeout_watcher); |
189 | \& ev_timer_start (loop, &timeout_watcher); |
188 | .Ve |
190 | \& |
189 | .PP |
191 | \& // now wait for events to arrive |
190 | .Vb 2 |
|
|
191 | \& /* loop till timeout or data ready */ |
|
|
192 | \& ev_loop (loop, 0); |
192 | \& ev_run (loop, 0); |
193 | .Ve |
193 | \& |
194 | .PP |
194 | \& // unloop was called, so exit |
195 | .Vb 2 |
|
|
196 | \& return 0; |
195 | \& return 0; |
197 | \& } |
196 | \& } |
198 | .Ve |
197 | .Ve |
199 | .SH "DESCRIPTION" |
198 | .SH "ABOUT THIS DOCUMENT" |
200 | .IX Header "DESCRIPTION" |
199 | .IX Header "ABOUT THIS DOCUMENT" |
|
|
200 | This document documents the libev software package. |
|
|
201 | .PP |
201 | The newest version of this document is also available as a html-formatted |
202 | The newest version of this document is also available as an html-formatted |
202 | web page you might find easier to navigate when reading it for the first |
203 | web page you might find easier to navigate when reading it for the first |
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
204 | time: <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
204 | .PP |
205 | .PP |
|
|
206 | While this document tries to be as complete as possible in documenting |
|
|
207 | libev, its usage and the rationale behind its design, it is not a tutorial |
|
|
208 | on event-based programming, nor will it introduce event-based programming |
|
|
209 | with libev. |
|
|
210 | .PP |
|
|
211 | Familiarity with event based programming techniques in general is assumed |
|
|
212 | throughout this document. |
|
|
213 | .SH "WHAT TO READ WHEN IN A HURRY" |
|
|
214 | .IX Header "WHAT TO READ WHEN IN A HURRY" |
|
|
215 | This manual tries to be very detailed, but unfortunately, this also makes |
|
|
216 | it very long. If you just want to know the basics of libev, I suggest |
|
|
217 | reading \*(L"\s-1ANATOMY\s0 \s-1OF\s0 A \s-1WATCHER\s0\*(R", then the \*(L"\s-1EXAMPLE\s0 \s-1PROGRAM\s0\*(R" above and |
|
|
218 | look up the missing functions in \*(L"\s-1GLOBAL\s0 \s-1FUNCTIONS\s0\*(R" and the \f(CW\*(C`ev_io\*(C'\fR and |
|
|
219 | \&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER\s0 \s-1TYPES\s0\*(R". |
|
|
220 | .SH "ABOUT LIBEV" |
|
|
221 | .IX Header "ABOUT LIBEV" |
205 | Libev is an event loop: you register interest in certain events (such as a |
222 | Libev is an event loop: you register interest in certain events (such as a |
206 | file descriptor being readable or a timeout occuring), and it will manage |
223 | file descriptor being readable or a timeout occurring), and it will manage |
207 | these event sources and provide your program with events. |
224 | these event sources and provide your program with events. |
208 | .PP |
225 | .PP |
209 | To do this, it must take more or less complete control over your process |
226 | To do this, it must take more or less complete control over your process |
210 | (or thread) by executing the \fIevent loop\fR handler, and will then |
227 | (or thread) by executing the \fIevent loop\fR handler, and will then |
211 | communicate events via a callback mechanism. |
228 | communicate events via a callback mechanism. |
212 | .PP |
229 | .PP |
213 | You register interest in certain events by registering so-called \fIevent |
230 | You register interest in certain events by registering so-called \fIevent |
214 | watchers\fR, which are relatively small C structures you initialise with the |
231 | watchers\fR, which are relatively small C structures you initialise with the |
215 | details of the event, and then hand it over to libev by \fIstarting\fR the |
232 | details of the event, and then hand it over to libev by \fIstarting\fR the |
216 | watcher. |
233 | watcher. |
217 | .SH "FEATURES" |
234 | .SS "\s-1FEATURES\s0" |
218 | .IX Header "FEATURES" |
235 | .IX Subsection "FEATURES" |
219 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
236 | Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the |
220 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
237 | BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms |
221 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
238 | for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface |
222 | (for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers |
239 | (for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner |
223 | with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals |
240 | inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative |
224 | (\f(CW\*(C`ev_signal\*(C'\fR), process status change events (\f(CW\*(C`ev_child\*(C'\fR), and event |
241 | timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling |
225 | watchers dealing with the event loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, |
242 | (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status |
226 | \&\f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR watchers) as well as |
243 | change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event |
227 | file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even limited support for fork events |
244 | loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and |
228 | (\f(CW\*(C`ev_fork\*(C'\fR). |
245 | \&\f(CW\*(C`ev_check\*(C'\fR watchers) as well as file watchers (\f(CW\*(C`ev_stat\*(C'\fR) and even |
|
|
246 | limited support for fork events (\f(CW\*(C`ev_fork\*(C'\fR). |
229 | .PP |
247 | .PP |
230 | It also is quite fast (see this |
248 | It also is quite fast (see this |
231 | benchmark comparing it to libevent |
249 | <benchmark> comparing it to libevent |
232 | for example). |
250 | for example). |
233 | .SH "CONVENTIONS" |
251 | .SS "\s-1CONVENTIONS\s0" |
234 | .IX Header "CONVENTIONS" |
252 | .IX Subsection "CONVENTIONS" |
235 | Libev is very configurable. In this manual the default configuration will |
253 | Libev is very configurable. In this manual the default (and most common) |
236 | be described, which supports multiple event loops. For more info about |
254 | configuration will be described, which supports multiple event loops. For |
237 | various configuration options please have a look at \fB\s-1EMBED\s0\fR section in |
255 | more info about various configuration options please have a look at |
238 | this manual. If libev was configured without support for multiple event |
256 | \&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support |
239 | loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR |
257 | for multiple event loops, then all functions taking an initial argument of |
240 | (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. |
258 | name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have |
241 | .SH "TIME REPRESENTATION" |
259 | this argument. |
|
|
260 | .SS "\s-1TIME\s0 \s-1REPRESENTATION\s0" |
242 | .IX Header "TIME REPRESENTATION" |
261 | .IX Subsection "TIME REPRESENTATION" |
243 | Libev represents time as a single floating point number, representing the |
262 | Libev represents time as a single floating point number, representing |
244 | (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near |
263 | the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice |
245 | the beginning of 1970, details are complicated, don't ask). This type is |
264 | somewhere near the beginning of 1970, details are complicated, don't |
246 | called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases |
265 | ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use |
247 | to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on |
266 | too. It usually aliases to the \f(CW\*(C`double\*(C'\fR type in C. When you need to do |
248 | it, you should treat it as such. |
267 | any calculations on it, you should treat it as some floating point value. |
|
|
268 | .PP |
|
|
269 | Unlike the name component \f(CW\*(C`stamp\*(C'\fR might indicate, it is also used for |
|
|
270 | time differences (e.g. delays) throughout libev. |
|
|
271 | .SH "ERROR HANDLING" |
|
|
272 | .IX Header "ERROR HANDLING" |
|
|
273 | Libev knows three classes of errors: operating system errors, usage errors |
|
|
274 | and internal errors (bugs). |
|
|
275 | .PP |
|
|
276 | When libev catches an operating system error it cannot handle (for example |
|
|
277 | a system call indicating a condition libev cannot fix), it calls the callback |
|
|
278 | set via \f(CW\*(C`ev_set_syserr_cb\*(C'\fR, which is supposed to fix the problem or |
|
|
279 | abort. The default is to print a diagnostic message and to call \f(CW\*(C`abort |
|
|
280 | ()\*(C'\fR. |
|
|
281 | .PP |
|
|
282 | When libev detects a usage error such as a negative timer interval, then |
|
|
283 | it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, |
|
|
284 | so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in |
|
|
285 | the libev caller and need to be fixed there. |
|
|
286 | .PP |
|
|
287 | Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has |
|
|
288 | extensive consistency checking code. These do not trigger under normal |
|
|
289 | circumstances, as they indicate either a bug in libev or worse. |
249 | .SH "GLOBAL FUNCTIONS" |
290 | .SH "GLOBAL FUNCTIONS" |
250 | .IX Header "GLOBAL FUNCTIONS" |
291 | .IX Header "GLOBAL FUNCTIONS" |
251 | These functions can be called anytime, even before initialising the |
292 | These functions can be called anytime, even before initialising the |
252 | library in any way. |
293 | library in any way. |
253 | .IP "ev_tstamp ev_time ()" 4 |
294 | .IP "ev_tstamp ev_time ()" 4 |
254 | .IX Item "ev_tstamp ev_time ()" |
295 | .IX Item "ev_tstamp ev_time ()" |
255 | Returns the current time as libev would use it. Please note that the |
296 | Returns the current time as libev would use it. Please note that the |
256 | \&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp |
297 | \&\f(CW\*(C`ev_now\*(C'\fR function is usually faster and also often returns the timestamp |
257 | you actually want to know. |
298 | you actually want to know. Also interesting is the combination of |
|
|
299 | \&\f(CW\*(C`ev_update_now\*(C'\fR and \f(CW\*(C`ev_now\*(C'\fR. |
|
|
300 | .IP "ev_sleep (ev_tstamp interval)" 4 |
|
|
301 | .IX Item "ev_sleep (ev_tstamp interval)" |
|
|
302 | Sleep for the given interval: The current thread will be blocked until |
|
|
303 | either it is interrupted or the given time interval has passed. Basically |
|
|
304 | this is a sub-second-resolution \f(CW\*(C`sleep ()\*(C'\fR. |
258 | .IP "int ev_version_major ()" 4 |
305 | .IP "int ev_version_major ()" 4 |
259 | .IX Item "int ev_version_major ()" |
306 | .IX Item "int ev_version_major ()" |
260 | .PD 0 |
307 | .PD 0 |
261 | .IP "int ev_version_minor ()" 4 |
308 | .IP "int ev_version_minor ()" 4 |
262 | .IX Item "int ev_version_minor ()" |
309 | .IX Item "int ev_version_minor ()" |
263 | .PD |
310 | .PD |
264 | You can find out the major and minor version numbers of the library |
311 | You can find out the major and minor \s-1ABI\s0 version numbers of the library |
265 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
312 | you linked against by calling the functions \f(CW\*(C`ev_version_major\*(C'\fR and |
266 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
313 | \&\f(CW\*(C`ev_version_minor\*(C'\fR. If you want, you can compare against the global |
267 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
314 | symbols \f(CW\*(C`EV_VERSION_MAJOR\*(C'\fR and \f(CW\*(C`EV_VERSION_MINOR\*(C'\fR, which specify the |
268 | version of the library your program was compiled against. |
315 | version of the library your program was compiled against. |
269 | .Sp |
316 | .Sp |
|
|
317 | These version numbers refer to the \s-1ABI\s0 version of the library, not the |
|
|
318 | release version. |
|
|
319 | .Sp |
270 | Usually, it's a good idea to terminate if the major versions mismatch, |
320 | Usually, it's a good idea to terminate if the major versions mismatch, |
271 | as this indicates an incompatible change. Minor versions are usually |
321 | as this indicates an incompatible change. Minor versions are usually |
272 | compatible to older versions, so a larger minor version alone is usually |
322 | compatible to older versions, so a larger minor version alone is usually |
273 | not a problem. |
323 | not a problem. |
274 | .Sp |
324 | .Sp |
275 | Example: Make sure we haven't accidentally been linked against the wrong |
325 | Example: Make sure we haven't accidentally been linked against the wrong |
276 | version. |
326 | version (note, however, that this will not detect other \s-1ABI\s0 mismatches, |
|
|
327 | such as \s-1LFS\s0 or reentrancy). |
277 | .Sp |
328 | .Sp |
278 | .Vb 3 |
329 | .Vb 3 |
279 | \& assert (("libev version mismatch", |
330 | \& assert (("libev version mismatch", |
280 | \& ev_version_major () == EV_VERSION_MAJOR |
331 | \& ev_version_major () == EV_VERSION_MAJOR |
281 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
332 | \& && ev_version_minor () >= EV_VERSION_MINOR)); |
282 | .Ve |
333 | .Ve |
283 | .IP "unsigned int ev_supported_backends ()" 4 |
334 | .IP "unsigned int ev_supported_backends ()" 4 |
284 | .IX Item "unsigned int ev_supported_backends ()" |
335 | .IX Item "unsigned int ev_supported_backends ()" |
285 | Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR |
336 | Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR |
286 | value) compiled into this binary of libev (independent of their |
337 | value) compiled into this binary of libev (independent of their |
… | |
… | |
289 | .Sp |
340 | .Sp |
290 | Example: make sure we have the epoll method, because yeah this is cool and |
341 | Example: make sure we have the epoll method, because yeah this is cool and |
291 | a must have and can we have a torrent of it please!!!11 |
342 | a must have and can we have a torrent of it please!!!11 |
292 | .Sp |
343 | .Sp |
293 | .Vb 2 |
344 | .Vb 2 |
294 | \& assert (("sorry, no epoll, no sex", |
345 | \& assert (("sorry, no epoll, no sex", |
295 | \& ev_supported_backends () & EVBACKEND_EPOLL)); |
346 | \& ev_supported_backends () & EVBACKEND_EPOLL)); |
296 | .Ve |
347 | .Ve |
297 | .IP "unsigned int ev_recommended_backends ()" 4 |
348 | .IP "unsigned int ev_recommended_backends ()" 4 |
298 | .IX Item "unsigned int ev_recommended_backends ()" |
349 | .IX Item "unsigned int ev_recommended_backends ()" |
299 | Return the set of all backends compiled into this binary of libev and also |
350 | Return the set of all backends compiled into this binary of libev and |
300 | recommended for this platform. This set is often smaller than the one |
351 | also recommended for this platform, meaning it will work for most file |
|
|
352 | descriptor types. This set is often smaller than the one returned by |
301 | returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on |
353 | \&\f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on most BSDs |
302 | most BSDs and will not be autodetected unless you explicitly request it |
354 | and will not be auto-detected unless you explicitly request it (assuming |
303 | (assuming you know what you are doing). This is the set of backends that |
355 | you know what you are doing). This is the set of backends that libev will |
304 | libev will probe for if you specify no backends explicitly. |
356 | probe for if you specify no backends explicitly. |
305 | .IP "unsigned int ev_embeddable_backends ()" 4 |
357 | .IP "unsigned int ev_embeddable_backends ()" 4 |
306 | .IX Item "unsigned int ev_embeddable_backends ()" |
358 | .IX Item "unsigned int ev_embeddable_backends ()" |
307 | Returns the set of backends that are embeddable in other event loops. This |
359 | Returns the set of backends that are embeddable in other event loops. This |
308 | is the theoretical, all\-platform, value. To find which backends |
360 | value is platform-specific but can include backends not available on the |
309 | might be supported on the current system, you would need to look at |
361 | current system. To find which embeddable backends might be supported on |
310 | \&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for |
362 | the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends () |
311 | recommended ones. |
363 | & ev_supported_backends ()\*(C'\fR, likewise for recommended ones. |
312 | .Sp |
364 | .Sp |
313 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
365 | See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
314 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
366 | .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 |
315 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
367 | .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" |
316 | Sets the allocation function to use (the prototype is similar \- the |
368 | Sets the allocation function to use (the prototype is similar \- the |
317 | semantics is identical \- to the realloc C function). It is used to |
369 | semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is |
318 | allocate and free memory (no surprises here). If it returns zero when |
370 | used to allocate and free memory (no surprises here). If it returns zero |
319 | memory needs to be allocated, the library might abort or take some |
371 | when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort |
320 | potentially destructive action. The default is your system realloc |
372 | or take some potentially destructive action. |
321 | function. |
373 | .Sp |
|
|
374 | Since some systems (at least OpenBSD and Darwin) fail to implement |
|
|
375 | correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system |
|
|
376 | \&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default. |
322 | .Sp |
377 | .Sp |
323 | You could override this function in high-availability programs to, say, |
378 | You could override this function in high-availability programs to, say, |
324 | free some memory if it cannot allocate memory, to use a special allocator, |
379 | free some memory if it cannot allocate memory, to use a special allocator, |
325 | or even to sleep a while and retry until some memory is available. |
380 | or even to sleep a while and retry until some memory is available. |
326 | .Sp |
381 | .Sp |
327 | Example: Replace the libev allocator with one that waits a bit and then |
382 | Example: Replace the libev allocator with one that waits a bit and then |
328 | retries). |
383 | retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). |
329 | .Sp |
384 | .Sp |
330 | .Vb 6 |
385 | .Vb 6 |
331 | \& static void * |
386 | \& static void * |
332 | \& persistent_realloc (void *ptr, size_t size) |
387 | \& persistent_realloc (void *ptr, size_t size) |
333 | \& { |
388 | \& { |
334 | \& for (;;) |
389 | \& for (;;) |
335 | \& { |
390 | \& { |
336 | \& void *newptr = realloc (ptr, size); |
391 | \& void *newptr = realloc (ptr, size); |
337 | .Ve |
392 | \& |
338 | .Sp |
|
|
339 | .Vb 2 |
|
|
340 | \& if (newptr) |
393 | \& if (newptr) |
341 | \& return newptr; |
394 | \& return newptr; |
342 | .Ve |
395 | \& |
343 | .Sp |
|
|
344 | .Vb 3 |
|
|
345 | \& sleep (60); |
396 | \& sleep (60); |
346 | \& } |
397 | \& } |
347 | \& } |
398 | \& } |
348 | .Ve |
399 | \& |
349 | .Sp |
|
|
350 | .Vb 2 |
|
|
351 | \& ... |
400 | \& ... |
352 | \& ev_set_allocator (persistent_realloc); |
401 | \& ev_set_allocator (persistent_realloc); |
353 | .Ve |
402 | .Ve |
354 | .IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 |
403 | .IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4 |
355 | .IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" |
404 | .IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))" |
356 | Set the callback function to call on a retryable syscall error (such |
405 | Set the callback function to call on a retryable system call error (such |
357 | as failed select, poll, epoll_wait). The message is a printable string |
406 | as failed select, poll, epoll_wait). The message is a printable string |
358 | indicating the system call or subsystem causing the problem. If this |
407 | indicating the system call or subsystem causing the problem. If this |
359 | callback is set, then libev will expect it to remedy the sitution, no |
408 | callback is set, then libev will expect it to remedy the situation, no |
360 | matter what, when it returns. That is, libev will generally retry the |
409 | matter what, when it returns. That is, libev will generally retry the |
361 | requested operation, or, if the condition doesn't go away, do bad stuff |
410 | requested operation, or, if the condition doesn't go away, do bad stuff |
362 | (such as abort). |
411 | (such as abort). |
363 | .Sp |
412 | .Sp |
364 | Example: This is basically the same thing that libev does internally, too. |
413 | Example: This is basically the same thing that libev does internally, too. |
… | |
… | |
368 | \& fatal_error (const char *msg) |
417 | \& fatal_error (const char *msg) |
369 | \& { |
418 | \& { |
370 | \& perror (msg); |
419 | \& perror (msg); |
371 | \& abort (); |
420 | \& abort (); |
372 | \& } |
421 | \& } |
373 | .Ve |
422 | \& |
374 | .Sp |
|
|
375 | .Vb 2 |
|
|
376 | \& ... |
423 | \& ... |
377 | \& ev_set_syserr_cb (fatal_error); |
424 | \& ev_set_syserr_cb (fatal_error); |
378 | .Ve |
425 | .Ve |
379 | .SH "FUNCTIONS CONTROLLING THE EVENT LOOP" |
426 | .SH "FUNCTIONS CONTROLLING EVENT LOOPS" |
380 | .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" |
427 | .IX Header "FUNCTIONS CONTROLLING EVENT LOOPS" |
381 | An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two |
428 | An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR (the \f(CW\*(C`struct\*(C'\fR is |
382 | types of such loops, the \fIdefault\fR loop, which supports signals and child |
429 | \&\fInot\fR optional in this case unless libev 3 compatibility is disabled, as |
383 | events, and dynamically created loops which do not. |
430 | libev 3 had an \f(CW\*(C`ev_loop\*(C'\fR function colliding with the struct name). |
384 | .PP |
431 | .PP |
385 | If you use threads, a common model is to run the default event loop |
432 | The library knows two types of such loops, the \fIdefault\fR loop, which |
386 | in your main thread (or in a separate thread) and for each thread you |
433 | supports child process events, and dynamically created event loops which |
387 | create, you also create another event loop. Libev itself does no locking |
434 | do not. |
388 | whatsoever, so if you mix calls to the same event loop in different |
|
|
389 | threads, make sure you lock (this is usually a bad idea, though, even if |
|
|
390 | done correctly, because it's hideous and inefficient). |
|
|
391 | .IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 |
435 | .IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 |
392 | .IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" |
436 | .IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" |
393 | This will initialise the default event loop if it hasn't been initialised |
437 | This returns the \*(L"default\*(R" event loop object, which is what you should |
394 | yet and return it. If the default loop could not be initialised, returns |
438 | normally use when you just need \*(L"the event loop\*(R". Event loop objects and |
395 | false. If it already was initialised it simply returns it (and ignores the |
439 | the \f(CW\*(C`flags\*(C'\fR parameter are described in more detail in the entry for |
396 | flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). |
440 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. |
|
|
441 | .Sp |
|
|
442 | If the default loop is already initialised then this function simply |
|
|
443 | returns it (and ignores the flags. If that is troubling you, check |
|
|
444 | \&\f(CW\*(C`ev_backend ()\*(C'\fR afterwards). Otherwise it will create it with the given |
|
|
445 | flags, which should almost always be \f(CW0\fR, unless the caller is also the |
|
|
446 | one calling \f(CW\*(C`ev_run\*(C'\fR or otherwise qualifies as \*(L"the main program\*(R". |
397 | .Sp |
447 | .Sp |
398 | If you don't know what event loop to use, use the one returned from this |
448 | If you don't know what event loop to use, use the one returned from this |
399 | function. |
449 | function (or via the \f(CW\*(C`EV_DEFAULT\*(C'\fR macro). |
|
|
450 | .Sp |
|
|
451 | Note that this function is \fInot\fR thread-safe, so if you want to use it |
|
|
452 | from multiple threads, you have to employ some kind of mutex (note also |
|
|
453 | that this case is unlikely, as loops cannot be shared easily between |
|
|
454 | threads anyway). |
|
|
455 | .Sp |
|
|
456 | The default loop is the only loop that can handle \f(CW\*(C`ev_child\*(C'\fR watchers, |
|
|
457 | and to do this, it always registers a handler for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is |
|
|
458 | a problem for your application you can either create a dynamic loop with |
|
|
459 | \&\f(CW\*(C`ev_loop_new\*(C'\fR which doesn't do that, or you can simply overwrite the |
|
|
460 | \&\f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling \f(CW\*(C`ev_default_init\*(C'\fR. |
|
|
461 | .Sp |
|
|
462 | Example: This is the most typical usage. |
|
|
463 | .Sp |
|
|
464 | .Vb 2 |
|
|
465 | \& if (!ev_default_loop (0)) |
|
|
466 | \& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
|
|
467 | .Ve |
|
|
468 | .Sp |
|
|
469 | Example: Restrict libev to the select and poll backends, and do not allow |
|
|
470 | environment settings to be taken into account: |
|
|
471 | .Sp |
|
|
472 | .Vb 1 |
|
|
473 | \& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
|
|
474 | .Ve |
|
|
475 | .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 |
|
|
476 | .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" |
|
|
477 | This will create and initialise a new event loop object. If the loop |
|
|
478 | could not be initialised, returns false. |
|
|
479 | .Sp |
|
|
480 | Note that this function \fIis\fR thread-safe, and one common way to use |
|
|
481 | libev with threads is indeed to create one loop per thread, and using the |
|
|
482 | default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread. |
400 | .Sp |
483 | .Sp |
401 | The flags argument can be used to specify special behaviour or specific |
484 | The flags argument can be used to specify special behaviour or specific |
402 | backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). |
485 | backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). |
403 | .Sp |
486 | .Sp |
404 | The following flags are supported: |
487 | The following flags are supported: |
… | |
… | |
409 | The default flags value. Use this if you have no clue (it's the right |
492 | The default flags value. Use this if you have no clue (it's the right |
410 | thing, believe me). |
493 | thing, believe me). |
411 | .ie n .IP """EVFLAG_NOENV""" 4 |
494 | .ie n .IP """EVFLAG_NOENV""" 4 |
412 | .el .IP "\f(CWEVFLAG_NOENV\fR" 4 |
495 | .el .IP "\f(CWEVFLAG_NOENV\fR" 4 |
413 | .IX Item "EVFLAG_NOENV" |
496 | .IX Item "EVFLAG_NOENV" |
414 | If this flag bit is ored into the flag value (or the program runs setuid |
497 | If this flag bit is or'ed into the flag value (or the program runs setuid |
415 | or setgid) then libev will \fInot\fR look at the environment variable |
498 | or setgid) then libev will \fInot\fR look at the environment variable |
416 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
499 | \&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will |
417 | override the flags completely if it is found in the environment. This is |
500 | override the flags completely if it is found in the environment. This is |
418 | useful to try out specific backends to test their performance, or to work |
501 | useful to try out specific backends to test their performance, or to work |
419 | around bugs. |
502 | around bugs. |
420 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
503 | .ie n .IP """EVFLAG_FORKCHECK""" 4 |
421 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
504 | .el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 |
422 | .IX Item "EVFLAG_FORKCHECK" |
505 | .IX Item "EVFLAG_FORKCHECK" |
423 | Instead of calling \f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR manually after |
506 | Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also |
424 | a fork, you can also make libev check for a fork in each iteration by |
507 | make libev check for a fork in each iteration by enabling this flag. |
425 | enabling this flag. |
|
|
426 | .Sp |
508 | .Sp |
427 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
509 | This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, |
428 | and thus this might slow down your event loop if you do a lot of loop |
510 | and thus this might slow down your event loop if you do a lot of loop |
429 | iterations and little real work, but is usually not noticeable (on my |
511 | iterations and little real work, but is usually not noticeable (on my |
430 | Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
512 | GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence |
431 | without a syscall and thus \fIvery\fR fast, but my Linux system also has |
513 | without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has |
432 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
514 | \&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). |
433 | .Sp |
515 | .Sp |
434 | The big advantage of this flag is that you can forget about fork (and |
516 | The big advantage of this flag is that you can forget about fork (and |
435 | forget about forgetting to tell libev about forking) when you use this |
517 | forget about forgetting to tell libev about forking) when you use this |
436 | flag. |
518 | flag. |
437 | .Sp |
519 | .Sp |
438 | This flag setting cannot be overriden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
520 | This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR |
439 | environment variable. |
521 | environment variable. |
|
|
522 | .ie n .IP """EVFLAG_NOINOTIFY""" 4 |
|
|
523 | .el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 |
|
|
524 | .IX Item "EVFLAG_NOINOTIFY" |
|
|
525 | When this flag is specified, then libev will not attempt to use the |
|
|
526 | \&\fIinotify\fR \s-1API\s0 for its \f(CW\*(C`ev_stat\*(C'\fR watchers. Apart from debugging and |
|
|
527 | testing, this flag can be useful to conserve inotify file descriptors, as |
|
|
528 | otherwise each loop using \f(CW\*(C`ev_stat\*(C'\fR watchers consumes one inotify handle. |
|
|
529 | .ie n .IP """EVFLAG_SIGNALFD""" 4 |
|
|
530 | .el .IP "\f(CWEVFLAG_SIGNALFD\fR" 4 |
|
|
531 | .IX Item "EVFLAG_SIGNALFD" |
|
|
532 | When this flag is specified, then libev will attempt to use the |
|
|
533 | \&\fIsignalfd\fR \s-1API\s0 for its \f(CW\*(C`ev_signal\*(C'\fR (and \f(CW\*(C`ev_child\*(C'\fR) watchers. This \s-1API\s0 |
|
|
534 | delivers signals synchronously, which makes it both faster and might make |
|
|
535 | it possible to get the queued signal data. It can also simplify signal |
|
|
536 | handling with threads, as long as you properly block signals in your |
|
|
537 | threads that are not interested in handling them. |
|
|
538 | .Sp |
|
|
539 | Signalfd will not be used by default as this changes your signal mask, and |
|
|
540 | there are a lot of shoddy libraries and programs (glib's threadpool for |
|
|
541 | example) that can't properly initialise their signal masks. |
440 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
542 | .ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 |
441 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
543 | .el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 |
442 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
544 | .IX Item "EVBACKEND_SELECT (value 1, portable select backend)" |
443 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
545 | This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as |
444 | libev tries to roll its own fd_set with no limits on the number of fds, |
546 | libev tries to roll its own fd_set with no limits on the number of fds, |
445 | but if that fails, expect a fairly low limit on the number of fds when |
547 | but if that fails, expect a fairly low limit on the number of fds when |
446 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
548 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
447 | the fastest backend for a low number of fds. |
549 | usually the fastest backend for a low number of (low-numbered :) fds. |
|
|
550 | .Sp |
|
|
551 | To get good performance out of this backend you need a high amount of |
|
|
552 | parallelism (most of the file descriptors should be busy). If you are |
|
|
553 | writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many |
|
|
554 | connections as possible during one iteration. You might also want to have |
|
|
555 | a look at \f(CW\*(C`ev_set_io_collect_interval ()\*(C'\fR to increase the amount of |
|
|
556 | readiness notifications you get per iteration. |
|
|
557 | .Sp |
|
|
558 | 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 |
|
|
559 | \&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the |
|
|
560 | \&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). |
448 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
561 | .ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 |
449 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
562 | .el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 |
450 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
563 | .IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" |
451 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than |
564 | And this is your standard \fIpoll\fR\|(2) backend. It's more complicated |
452 | select, but handles sparse fds better and has no artificial limit on the |
565 | than select, but handles sparse fds better and has no artificial |
453 | number of fds you can use (except it will slow down considerably with a |
566 | limit on the number of fds you can use (except it will slow down |
454 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
567 | considerably with a lot of inactive fds). It scales similarly to select, |
|
|
568 | i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for |
|
|
569 | performance tips. |
|
|
570 | .Sp |
|
|
571 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and |
|
|
572 | \&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. |
455 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
573 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
456 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
574 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
457 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
575 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
|
|
576 | Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 |
|
|
577 | kernels). |
|
|
578 | .Sp |
458 | For few fds, this backend is a bit little slower than poll and select, |
579 | For few fds, this backend is a bit little slower than poll and select, |
459 | but it scales phenomenally better. While poll and select usually scale like |
580 | but it scales phenomenally better. While poll and select usually scale |
460 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
581 | like O(total_fds) where n is the total number of fds (or the highest fd), |
461 | either O(1) or O(active_fds). |
582 | epoll scales either O(1) or O(active_fds). |
462 | .Sp |
583 | .Sp |
|
|
584 | The epoll mechanism deserves honorable mention as the most misdesigned |
|
|
585 | of the more advanced event mechanisms: mere annoyances include silently |
|
|
586 | dropping file descriptors, requiring a system call per change per file |
|
|
587 | descriptor (and unnecessary guessing of parameters), problems with dup, |
|
|
588 | returning before the timeout value, resulting in additional iterations |
|
|
589 | (and only giving 5ms accuracy while select on the same platform gives |
|
|
590 | 0.1ms) and so on. The biggest issue is fork races, however \- if a program |
|
|
591 | forks then \fIboth\fR parent and child process have to recreate the epoll |
|
|
592 | set, which can take considerable time (one syscall per file descriptor) |
|
|
593 | and is of course hard to detect. |
|
|
594 | .Sp |
|
|
595 | Epoll is also notoriously buggy \- embedding epoll fds \fIshould\fR work, but |
|
|
596 | of course \fIdoesn't\fR, and epoll just loves to report events for totally |
|
|
597 | \&\fIdifferent\fR file descriptors (even already closed ones, so one cannot |
|
|
598 | even remove them from the set) than registered in the set (especially |
|
|
599 | on \s-1SMP\s0 systems). Libev tries to counter these spurious notifications by |
|
|
600 | employing an additional generation counter and comparing that against the |
|
|
601 | events to filter out spurious ones, recreating the set when required. Last |
|
|
602 | not least, it also refuses to work with some file descriptors which work |
|
|
603 | perfectly fine with \f(CW\*(C`select\*(C'\fR (files, many character devices...). |
|
|
604 | .Sp |
|
|
605 | Epoll is truly the train wreck analog among event poll mechanisms. |
|
|
606 | .Sp |
463 | While stopping and starting an I/O watcher in the same iteration will |
607 | While stopping, setting and starting an I/O watcher in the same iteration |
464 | result in some caching, there is still a syscall per such incident |
608 | will result in some caching, there is still a system call per such |
465 | (because the fd could point to a different file description now), so its |
609 | incident (because the same \fIfile descriptor\fR could point to a different |
466 | best to avoid that. Also, \fIdup()\fRed file descriptors might not work very |
610 | \&\fIfile description\fR now), so its best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed |
467 | well if you register events for both fds. |
611 | file descriptors might not work very well if you register events for both |
|
|
612 | file descriptors. |
468 | .Sp |
613 | .Sp |
469 | Please note that epoll sometimes generates spurious notifications, so you |
614 | Best performance from this backend is achieved by not unregistering all |
470 | need to use non-blocking I/O or other means to avoid blocking when no data |
615 | watchers for a file descriptor until it has been closed, if possible, |
471 | (or space) is available. |
616 | i.e. keep at least one watcher active per fd at all times. Stopping and |
|
|
617 | starting a watcher (without re-setting it) also usually doesn't cause |
|
|
618 | extra overhead. A fork can both result in spurious notifications as well |
|
|
619 | as in libev having to destroy and recreate the epoll object, which can |
|
|
620 | take considerable time and thus should be avoided. |
|
|
621 | .Sp |
|
|
622 | All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or |
|
|
623 | faster than epoll for maybe up to a hundred file descriptors, depending on |
|
|
624 | the usage. So sad. |
|
|
625 | .Sp |
|
|
626 | While nominally embeddable in other event loops, this feature is broken in |
|
|
627 | all kernel versions tested so far. |
|
|
628 | .Sp |
|
|
629 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as |
|
|
630 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
472 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
631 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
473 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
632 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
474 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
633 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
475 | Kqueue deserves special mention, as at the time of this writing, it |
634 | Kqueue deserves special mention, as at the time of this writing, it |
476 | was broken on all BSDs except NetBSD (usually it doesn't work with |
635 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
477 | anything but sockets and pipes, except on Darwin, where of course its |
636 | with anything but sockets and pipes, except on Darwin, where of course |
478 | completely useless). For this reason its not being \*(L"autodetected\*(R" |
637 | it's completely useless). Unlike epoll, however, whose brokenness |
|
|
638 | is by design, these kqueue bugs can (and eventually will) be fixed |
|
|
639 | without \s-1API\s0 changes to existing programs. For this reason it's not being |
479 | unless you explicitly specify it explicitly in the flags (i.e. using |
640 | \&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using |
480 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). |
641 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) |
|
|
642 | system like NetBSD. |
|
|
643 | .Sp |
|
|
644 | You still can embed kqueue into a normal poll or select backend and use it |
|
|
645 | only for sockets (after having made sure that sockets work with kqueue on |
|
|
646 | the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. |
481 | .Sp |
647 | .Sp |
482 | It scales in the same way as the epoll backend, but the interface to the |
648 | It scales in the same way as the epoll backend, but the interface to the |
483 | kernel is more efficient (which says nothing about its actual speed, of |
649 | kernel is more efficient (which says nothing about its actual speed, of |
484 | course). While starting and stopping an I/O watcher does not cause an |
650 | course). While stopping, setting and starting an I/O watcher does never |
485 | extra syscall as with epoll, it still adds up to four event changes per |
651 | cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to |
486 | incident, so its best to avoid that. |
652 | two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but |
|
|
653 | sane, unlike epoll) and it drops fds silently in similarly hard-to-detect |
|
|
654 | cases |
|
|
655 | .Sp |
|
|
656 | This backend usually performs well under most conditions. |
|
|
657 | .Sp |
|
|
658 | While nominally embeddable in other event loops, this doesn't work |
|
|
659 | everywhere, so you might need to test for this. And since it is broken |
|
|
660 | almost everywhere, you should only use it when you have a lot of sockets |
|
|
661 | (for which it usually works), by embedding it into another event loop |
|
|
662 | (e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course |
|
|
663 | also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. |
|
|
664 | .Sp |
|
|
665 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with |
|
|
666 | \&\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 |
|
|
667 | \&\f(CW\*(C`NOTE_EOF\*(C'\fR. |
487 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
668 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
488 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
669 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
489 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
670 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
490 | This is not implemented yet (and might never be). |
671 | This is not implemented yet (and might never be, unless you send me an |
|
|
672 | implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets |
|
|
673 | and is not embeddable, which would limit the usefulness of this backend |
|
|
674 | immensely. |
491 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
675 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
492 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
676 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
493 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
677 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
494 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
678 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
495 | it's really slow, but it still scales very well (O(active_fds)). |
679 | it's really slow, but it still scales very well (O(active_fds)). |
496 | .Sp |
680 | .Sp |
497 | Please note that solaris ports can result in a lot of spurious |
681 | Please note that Solaris event ports can deliver a lot of spurious |
498 | notifications, so you need to use non-blocking I/O or other means to avoid |
682 | notifications, so you need to use non-blocking I/O or other means to avoid |
499 | blocking when no data (or space) is available. |
683 | blocking when no data (or space) is available. |
|
|
684 | .Sp |
|
|
685 | While this backend scales well, it requires one system call per active |
|
|
686 | file descriptor per loop iteration. For small and medium numbers of file |
|
|
687 | descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend |
|
|
688 | might perform better. |
|
|
689 | .Sp |
|
|
690 | On the positive side, with the exception of the spurious readiness |
|
|
691 | notifications, this backend actually performed fully to specification |
|
|
692 | in all tests and is fully embeddable, which is a rare feat among the |
|
|
693 | OS-specific backends (I vastly prefer correctness over speed hacks). |
|
|
694 | .Sp |
|
|
695 | This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as |
|
|
696 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
500 | .ie n .IP """EVBACKEND_ALL""" 4 |
697 | .ie n .IP """EVBACKEND_ALL""" 4 |
501 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
698 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
502 | .IX Item "EVBACKEND_ALL" |
699 | .IX Item "EVBACKEND_ALL" |
503 | Try all backends (even potentially broken ones that wouldn't be tried |
700 | Try all backends (even potentially broken ones that wouldn't be tried |
504 | with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as |
701 | with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as |
505 | \&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. |
702 | \&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR. |
|
|
703 | .Sp |
|
|
704 | It is definitely not recommended to use this flag. |
506 | .RE |
705 | .RE |
507 | .RS 4 |
706 | .RS 4 |
508 | .Sp |
707 | .Sp |
509 | If one or more of these are ored into the flags value, then only these |
708 | If one or more of the backend flags are or'ed into the flags value, |
510 | backends will be tried (in the reverse order as given here). If none are |
709 | then only these backends will be tried (in the reverse order as listed |
511 | specified, most compiled-in backend will be tried, usually in reverse |
710 | here). If none are specified, all backends in \f(CW\*(C`ev_recommended_backends |
512 | order of their flag values :) |
711 | ()\*(C'\fR will be tried. |
513 | .Sp |
712 | .Sp |
514 | The most typical usage is like this: |
713 | Example: Try to create a event loop that uses epoll and nothing else. |
515 | .Sp |
714 | .Sp |
516 | .Vb 2 |
715 | .Vb 3 |
517 | \& if (!ev_default_loop (0)) |
716 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
518 | \& fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
717 | \& if (!epoller) |
|
|
718 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
519 | .Ve |
719 | .Ve |
520 | .Sp |
720 | .Sp |
521 | Restrict libev to the select and poll backends, and do not allow |
721 | Example: Use whatever libev has to offer, but make sure that kqueue is |
522 | environment settings to be taken into account: |
722 | used if available. |
523 | .Sp |
723 | .Sp |
524 | .Vb 1 |
724 | .Vb 1 |
525 | \& ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV); |
|
|
526 | .Ve |
|
|
527 | .Sp |
|
|
528 | Use whatever libev has to offer, but make sure that kqueue is used if |
|
|
529 | available (warning, breaks stuff, best use only with your own private |
|
|
530 | event loop and only if you know the \s-1OS\s0 supports your types of fds): |
|
|
531 | .Sp |
|
|
532 | .Vb 1 |
|
|
533 | \& ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
725 | \& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
534 | .Ve |
726 | .Ve |
535 | .RE |
727 | .RE |
536 | .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4 |
|
|
537 | .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" |
|
|
538 | Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is |
|
|
539 | always distinct from the default loop. Unlike the default loop, it cannot |
|
|
540 | handle signal and child watchers, and attempts to do so will be greeted by |
|
|
541 | undefined behaviour (or a failed assertion if assertions are enabled). |
|
|
542 | .Sp |
|
|
543 | Example: Try to create a event loop that uses epoll and nothing else. |
|
|
544 | .Sp |
|
|
545 | .Vb 3 |
|
|
546 | \& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); |
|
|
547 | \& if (!epoller) |
|
|
548 | \& fatal ("no epoll found here, maybe it hides under your chair"); |
|
|
549 | .Ve |
|
|
550 | .IP "ev_default_destroy ()" 4 |
728 | .IP "ev_loop_destroy (loop)" 4 |
551 | .IX Item "ev_default_destroy ()" |
729 | .IX Item "ev_loop_destroy (loop)" |
552 | Destroys the default loop again (frees all memory and kernel state |
730 | Destroys an event loop object (frees all memory and kernel state |
553 | etc.). None of the active event watchers will be stopped in the normal |
731 | etc.). None of the active event watchers will be stopped in the normal |
554 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
732 | sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your |
555 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
733 | responsibility to either stop all watchers cleanly yourself \fIbefore\fR |
556 | calling this function, or cope with the fact afterwards (which is usually |
734 | calling this function, or cope with the fact afterwards (which is usually |
557 | the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
735 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
558 | for example). |
736 | for example). |
559 | .IP "ev_loop_destroy (loop)" 4 |
|
|
560 | .IX Item "ev_loop_destroy (loop)" |
|
|
561 | Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an |
|
|
562 | earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. |
|
|
563 | .IP "ev_default_fork ()" 4 |
|
|
564 | .IX Item "ev_default_fork ()" |
|
|
565 | This function reinitialises the kernel state for backends that have |
|
|
566 | one. Despite the name, you can call it anytime, but it makes most sense |
|
|
567 | after forking, in either the parent or child process (or both, but that |
|
|
568 | again makes little sense). |
|
|
569 | .Sp |
737 | .Sp |
570 | You \fImust\fR call this function in the child process after forking if and |
738 | Note that certain global state, such as signal state (and installed signal |
571 | only if you want to use the event library in both processes. If you just |
739 | handlers), will not be freed by this function, and related watchers (such |
572 | fork+exec, you don't have to call it. |
740 | as signal and child watchers) would need to be stopped manually. |
573 | .Sp |
741 | .Sp |
574 | The function itself is quite fast and it's usually not a problem to call |
742 | This function is normally used on loop objects allocated by |
575 | it just in case after a fork. To make this easy, the function will fit in |
743 | \&\f(CW\*(C`ev_loop_new\*(C'\fR, but it can also be used on the default loop returned by |
576 | quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR: |
744 | \&\f(CW\*(C`ev_default_loop\*(C'\fR, in which case it is not thread-safe. |
577 | .Sp |
745 | .Sp |
578 | .Vb 1 |
746 | Note that it is not advisable to call this function on the default loop |
579 | \& pthread_atfork (0, 0, ev_default_fork); |
747 | except in the rare occasion where you really need to free its resources. |
580 | .Ve |
748 | If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR |
581 | .Sp |
749 | and \f(CW\*(C`ev_loop_destroy\*(C'\fR. |
582 | At the moment, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR are safe to use |
|
|
583 | without calling this function, so if you force one of those backends you |
|
|
584 | do not need to care. |
|
|
585 | .IP "ev_loop_fork (loop)" 4 |
750 | .IP "ev_loop_fork (loop)" 4 |
586 | .IX Item "ev_loop_fork (loop)" |
751 | .IX Item "ev_loop_fork (loop)" |
587 | Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by |
752 | This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to |
588 | \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop |
753 | reinitialise the kernel state for backends that have one. Despite the |
589 | after fork, and how you do this is entirely your own problem. |
754 | name, you can call it anytime, but it makes most sense after forking, in |
|
|
755 | the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the |
|
|
756 | child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. |
|
|
757 | .Sp |
|
|
758 | Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after |
|
|
759 | a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is |
|
|
760 | because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things |
|
|
761 | during fork. |
|
|
762 | .Sp |
|
|
763 | On the other hand, you only need to call this function in the child |
|
|
764 | process if and only if you want to use the event loop in the child. If |
|
|
765 | you just fork+exec or create a new loop in the child, you don't have to |
|
|
766 | call it at all (in fact, \f(CW\*(C`epoll\*(C'\fR is so badly broken that it makes a |
|
|
767 | difference, but libev will usually detect this case on its own and do a |
|
|
768 | costly reset of the backend). |
|
|
769 | .Sp |
|
|
770 | The function itself is quite fast and it's usually not a problem to call |
|
|
771 | it just in case after a fork. |
|
|
772 | .Sp |
|
|
773 | Example: Automate calling \f(CW\*(C`ev_loop_fork\*(C'\fR on the default loop when |
|
|
774 | using pthreads. |
|
|
775 | .Sp |
|
|
776 | .Vb 5 |
|
|
777 | \& static void |
|
|
778 | \& post_fork_child (void) |
|
|
779 | \& { |
|
|
780 | \& ev_loop_fork (EV_DEFAULT); |
|
|
781 | \& } |
|
|
782 | \& |
|
|
783 | \& ... |
|
|
784 | \& pthread_atfork (0, 0, post_fork_child); |
|
|
785 | .Ve |
|
|
786 | .IP "int ev_is_default_loop (loop)" 4 |
|
|
787 | .IX Item "int ev_is_default_loop (loop)" |
|
|
788 | Returns true when the given loop is, in fact, the default loop, and false |
|
|
789 | otherwise. |
590 | .IP "unsigned int ev_loop_count (loop)" 4 |
790 | .IP "unsigned int ev_iteration (loop)" 4 |
591 | .IX Item "unsigned int ev_loop_count (loop)" |
791 | .IX Item "unsigned int ev_iteration (loop)" |
592 | Returns the count of loop iterations for the loop, which is identical to |
792 | Returns the current iteration count for the event loop, which is identical |
593 | the number of times libev did poll for new events. It starts at \f(CW0\fR and |
793 | to the number of times libev did poll for new events. It starts at \f(CW0\fR |
594 | happily wraps around with enough iterations. |
794 | and happily wraps around with enough iterations. |
595 | .Sp |
795 | .Sp |
596 | This value can sometimes be useful as a generation counter of sorts (it |
796 | This value can sometimes be useful as a generation counter of sorts (it |
597 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
797 | \&\*(L"ticks\*(R" the number of loop iterations), as it roughly corresponds with |
598 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls. |
798 | \&\f(CW\*(C`ev_prepare\*(C'\fR and \f(CW\*(C`ev_check\*(C'\fR calls \- and is incremented between the |
|
|
799 | prepare and check phases. |
|
|
800 | .IP "unsigned int ev_depth (loop)" 4 |
|
|
801 | .IX Item "unsigned int ev_depth (loop)" |
|
|
802 | Returns the number of times \f(CW\*(C`ev_run\*(C'\fR was entered minus the number of |
|
|
803 | times \f(CW\*(C`ev_run\*(C'\fR was exited, in other words, the recursion depth. |
|
|
804 | .Sp |
|
|
805 | Outside \f(CW\*(C`ev_run\*(C'\fR, this number is zero. In a callback, this number is |
|
|
806 | \&\f(CW1\fR, unless \f(CW\*(C`ev_run\*(C'\fR was invoked recursively (or from another thread), |
|
|
807 | in which case it is higher. |
|
|
808 | .Sp |
|
|
809 | Leaving \f(CW\*(C`ev_run\*(C'\fR abnormally (setjmp/longjmp, cancelling the thread |
|
|
810 | etc.), doesn't count as \*(L"exit\*(R" \- consider this as a hint to avoid such |
|
|
811 | ungentleman-like behaviour unless it's really convenient. |
599 | .IP "unsigned int ev_backend (loop)" 4 |
812 | .IP "unsigned int ev_backend (loop)" 4 |
600 | .IX Item "unsigned int ev_backend (loop)" |
813 | .IX Item "unsigned int ev_backend (loop)" |
601 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
814 | Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in |
602 | use. |
815 | use. |
603 | .IP "ev_tstamp ev_now (loop)" 4 |
816 | .IP "ev_tstamp ev_now (loop)" 4 |
604 | .IX Item "ev_tstamp ev_now (loop)" |
817 | .IX Item "ev_tstamp ev_now (loop)" |
605 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
818 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
606 | received events and started processing them. This timestamp does not |
819 | received events and started processing them. This timestamp does not |
607 | change as long as callbacks are being processed, and this is also the base |
820 | change as long as callbacks are being processed, and this is also the base |
608 | time used for relative timers. You can treat it as the timestamp of the |
821 | time used for relative timers. You can treat it as the timestamp of the |
609 | event occuring (or more correctly, libev finding out about it). |
822 | event occurring (or more correctly, libev finding out about it). |
|
|
823 | .IP "ev_now_update (loop)" 4 |
|
|
824 | .IX Item "ev_now_update (loop)" |
|
|
825 | Establishes the current time by querying the kernel, updating the time |
|
|
826 | returned by \f(CW\*(C`ev_now ()\*(C'\fR in the progress. This is a costly operation and |
|
|
827 | is usually done automatically within \f(CW\*(C`ev_run ()\*(C'\fR. |
|
|
828 | .Sp |
|
|
829 | This function is rarely useful, but when some event callback runs for a |
|
|
830 | very long time without entering the event loop, updating libev's idea of |
|
|
831 | the current time is a good idea. |
|
|
832 | .Sp |
|
|
833 | See also \*(L"The special problem of time updates\*(R" in the \f(CW\*(C`ev_timer\*(C'\fR section. |
|
|
834 | .IP "ev_suspend (loop)" 4 |
|
|
835 | .IX Item "ev_suspend (loop)" |
|
|
836 | .PD 0 |
|
|
837 | .IP "ev_resume (loop)" 4 |
|
|
838 | .IX Item "ev_resume (loop)" |
|
|
839 | .PD |
|
|
840 | These two functions suspend and resume an event loop, for use when the |
|
|
841 | loop is not used for a while and timeouts should not be processed. |
|
|
842 | .Sp |
|
|
843 | A typical use case would be an interactive program such as a game: When |
|
|
844 | the user presses \f(CW\*(C`^Z\*(C'\fR to suspend the game and resumes it an hour later it |
|
|
845 | would be best to handle timeouts as if no time had actually passed while |
|
|
846 | the program was suspended. This can be achieved by calling \f(CW\*(C`ev_suspend\*(C'\fR |
|
|
847 | in your \f(CW\*(C`SIGTSTP\*(C'\fR handler, sending yourself a \f(CW\*(C`SIGSTOP\*(C'\fR and calling |
|
|
848 | \&\f(CW\*(C`ev_resume\*(C'\fR directly afterwards to resume timer processing. |
|
|
849 | .Sp |
|
|
850 | Effectively, all \f(CW\*(C`ev_timer\*(C'\fR watchers will be delayed by the time spend |
|
|
851 | between \f(CW\*(C`ev_suspend\*(C'\fR and \f(CW\*(C`ev_resume\*(C'\fR, and all \f(CW\*(C`ev_periodic\*(C'\fR watchers |
|
|
852 | will be rescheduled (that is, they will lose any events that would have |
|
|
853 | occurred while suspended). |
|
|
854 | .Sp |
|
|
855 | After calling \f(CW\*(C`ev_suspend\*(C'\fR you \fBmust not\fR call \fIany\fR function on the |
|
|
856 | given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR |
|
|
857 | without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. |
|
|
858 | .Sp |
|
|
859 | Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the |
|
|
860 | event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). |
610 | .IP "ev_loop (loop, int flags)" 4 |
861 | .IP "ev_run (loop, int flags)" 4 |
611 | .IX Item "ev_loop (loop, int flags)" |
862 | .IX Item "ev_run (loop, int flags)" |
612 | Finally, this is it, the event handler. This function usually is called |
863 | Finally, this is it, the event handler. This function usually is called |
613 | after you initialised all your watchers and you want to start handling |
864 | after you have initialised all your watchers and you want to start |
614 | events. |
865 | handling events. It will ask the operating system for any new events, call |
|
|
866 | the watcher callbacks, an then repeat the whole process indefinitely: This |
|
|
867 | is why event loops are called \fIloops\fR. |
615 | .Sp |
868 | .Sp |
616 | If the flags argument is specified as \f(CW0\fR, it will not return until |
869 | If the flags argument is specified as \f(CW0\fR, it will keep handling events |
617 | either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called. |
870 | until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was |
|
|
871 | called. |
618 | .Sp |
872 | .Sp |
619 | Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than |
873 | Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than |
620 | relying on all watchers to be stopped when deciding when a program has |
874 | relying on all watchers to be stopped when deciding when a program has |
621 | finished (especially in interactive programs), but having a program that |
875 | finished (especially in interactive programs), but having a program |
622 | automatically loops as long as it has to and no longer by virtue of |
876 | that automatically loops as long as it has to and no longer by virtue |
623 | relying on its watchers stopping correctly is a thing of beauty. |
877 | of relying on its watchers stopping correctly, that is truly a thing of |
|
|
878 | beauty. |
624 | .Sp |
879 | .Sp |
625 | A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle |
880 | A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle |
626 | those events and any outstanding ones, but will not block your process in |
881 | those events and any already outstanding ones, but will not wait and |
627 | case there are no events and will return after one iteration of the loop. |
882 | block your process in case there are no events and will return after one |
|
|
883 | iteration of the loop. This is sometimes useful to poll and handle new |
|
|
884 | events while doing lengthy calculations, to keep the program responsive. |
628 | .Sp |
885 | .Sp |
629 | A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if |
886 | A flags value of \f(CW\*(C`EVRUN_ONCE\*(C'\fR will look for new events (waiting if |
630 | neccessary) and will handle those and any outstanding ones. It will block |
887 | necessary) and will handle those and any already outstanding ones. It |
631 | your process until at least one new event arrives, and will return after |
888 | will block your process until at least one new event arrives (which could |
632 | one iteration of the loop. This is useful if you are waiting for some |
889 | be an event internal to libev itself, so there is no guarantee that a |
633 | external event in conjunction with something not expressible using other |
890 | user-registered callback will be called), and will return after one |
|
|
891 | iteration of the loop. |
|
|
892 | .Sp |
|
|
893 | This is useful if you are waiting for some external event in conjunction |
|
|
894 | with something not expressible using other libev watchers (i.e. "roll your |
634 | libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
895 | own \f(CW\*(C`ev_run\*(C'\fR"). However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is |
635 | usually a better approach for this kind of thing. |
896 | usually a better approach for this kind of thing. |
636 | .Sp |
897 | .Sp |
637 | Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: |
898 | Here are the gory details of what \f(CW\*(C`ev_run\*(C'\fR does: |
638 | .Sp |
899 | .Sp |
639 | .Vb 18 |
900 | .Vb 10 |
640 | \& * If there are no active watchers (reference count is zero), return. |
901 | \& \- Increment loop depth. |
641 | \& - Queue prepare watchers and then call all outstanding watchers. |
902 | \& \- Reset the ev_break status. |
|
|
903 | \& \- Before the first iteration, call any pending watchers. |
|
|
904 | \& LOOP: |
|
|
905 | \& \- If EVFLAG_FORKCHECK was used, check for a fork. |
|
|
906 | \& \- If a fork was detected (by any means), queue and call all fork watchers. |
|
|
907 | \& \- Queue and call all prepare watchers. |
|
|
908 | \& \- If ev_break was called, goto FINISH. |
642 | \& - If we have been forked, recreate the kernel state. |
909 | \& \- If we have been forked, detach and recreate the kernel state |
|
|
910 | \& as to not disturb the other process. |
643 | \& - Update the kernel state with all outstanding changes. |
911 | \& \- Update the kernel state with all outstanding changes. |
644 | \& - Update the "event loop time". |
912 | \& \- Update the "event loop time" (ev_now ()). |
645 | \& - Calculate for how long to block. |
913 | \& \- Calculate for how long to sleep or block, if at all |
|
|
914 | \& (active idle watchers, EVRUN_NOWAIT or not having |
|
|
915 | \& any active watchers at all will result in not sleeping). |
|
|
916 | \& \- Sleep if the I/O and timer collect interval say so. |
|
|
917 | \& \- Increment loop iteration counter. |
646 | \& - Block the process, waiting for any events. |
918 | \& \- Block the process, waiting for any events. |
647 | \& - Queue all outstanding I/O (fd) events. |
919 | \& \- Queue all outstanding I/O (fd) events. |
648 | \& - Update the "event loop time" and do time jump handling. |
920 | \& \- Update the "event loop time" (ev_now ()), and do time jump adjustments. |
649 | \& - Queue all outstanding timers. |
921 | \& \- Queue all expired timers. |
650 | \& - Queue all outstanding periodics. |
922 | \& \- Queue all expired periodics. |
651 | \& - If no events are pending now, queue all idle watchers. |
923 | \& \- Queue all idle watchers with priority higher than that of pending events. |
652 | \& - Queue all check watchers. |
924 | \& \- Queue all check watchers. |
653 | \& - Call all queued watchers in reverse order (i.e. check watchers first). |
925 | \& \- Call all queued watchers in reverse order (i.e. check watchers first). |
654 | \& Signals and child watchers are implemented as I/O watchers, and will |
926 | \& Signals and child watchers are implemented as I/O watchers, and will |
655 | \& be handled here by queueing them when their watcher gets executed. |
927 | \& be handled here by queueing them when their watcher gets executed. |
656 | \& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
928 | \& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT |
657 | \& were used, return, otherwise continue with step *. |
929 | \& were used, or there are no active watchers, goto FINISH, otherwise |
|
|
930 | \& continue with step LOOP. |
|
|
931 | \& FINISH: |
|
|
932 | \& \- Reset the ev_break status iff it was EVBREAK_ONE. |
|
|
933 | \& \- Decrement the loop depth. |
|
|
934 | \& \- Return. |
658 | .Ve |
935 | .Ve |
659 | .Sp |
936 | .Sp |
660 | Example: Queue some jobs and then loop until no events are outsanding |
937 | Example: Queue some jobs and then loop until no events are outstanding |
661 | anymore. |
938 | anymore. |
662 | .Sp |
939 | .Sp |
663 | .Vb 4 |
940 | .Vb 4 |
664 | \& ... queue jobs here, make sure they register event watchers as long |
941 | \& ... queue jobs here, make sure they register event watchers as long |
665 | \& ... as they still have work to do (even an idle watcher will do..) |
942 | \& ... as they still have work to do (even an idle watcher will do..) |
666 | \& ev_loop (my_loop, 0); |
943 | \& ev_run (my_loop, 0); |
667 | \& ... jobs done. yeah! |
944 | \& ... jobs done or somebody called unloop. yeah! |
668 | .Ve |
945 | .Ve |
669 | .IP "ev_unloop (loop, how)" 4 |
946 | .IP "ev_break (loop, how)" 4 |
670 | .IX Item "ev_unloop (loop, how)" |
947 | .IX Item "ev_break (loop, how)" |
671 | Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it |
948 | Can be used to make a call to \f(CW\*(C`ev_run\*(C'\fR return early (but only after it |
672 | has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either |
949 | has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either |
673 | \&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or |
950 | \&\f(CW\*(C`EVBREAK_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_run\*(C'\fR call return, or |
674 | \&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. |
951 | \&\f(CW\*(C`EVBREAK_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_run\*(C'\fR calls return. |
|
|
952 | .Sp |
|
|
953 | This \*(L"break state\*(R" will be cleared when entering \f(CW\*(C`ev_run\*(C'\fR again. |
|
|
954 | .Sp |
|
|
955 | It is safe to call \f(CW\*(C`ev_break\*(C'\fR from outside any \f(CW\*(C`ev_run\*(C'\fR calls, too. |
675 | .IP "ev_ref (loop)" 4 |
956 | .IP "ev_ref (loop)" 4 |
676 | .IX Item "ev_ref (loop)" |
957 | .IX Item "ev_ref (loop)" |
677 | .PD 0 |
958 | .PD 0 |
678 | .IP "ev_unref (loop)" 4 |
959 | .IP "ev_unref (loop)" 4 |
679 | .IX Item "ev_unref (loop)" |
960 | .IX Item "ev_unref (loop)" |
680 | .PD |
961 | .PD |
681 | Ref/unref can be used to add or remove a reference count on the event |
962 | Ref/unref can be used to add or remove a reference count on the event |
682 | loop: Every watcher keeps one reference, and as long as the reference |
963 | loop: Every watcher keeps one reference, and as long as the reference |
683 | count is nonzero, \f(CW\*(C`ev_loop\*(C'\fR will not return on its own. If you have |
964 | count is nonzero, \f(CW\*(C`ev_run\*(C'\fR will not return on its own. |
684 | a watcher you never unregister that should not keep \f(CW\*(C`ev_loop\*(C'\fR from |
965 | .Sp |
685 | returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For |
966 | This is useful when you have a watcher that you never intend to |
|
|
967 | unregister, but that nevertheless should not keep \f(CW\*(C`ev_run\*(C'\fR from |
|
|
968 | returning. In such a case, call \f(CW\*(C`ev_unref\*(C'\fR after starting, and \f(CW\*(C`ev_ref\*(C'\fR |
|
|
969 | before stopping it. |
|
|
970 | .Sp |
686 | example, libev itself uses this for its internal signal pipe: It is not |
971 | As an example, libev itself uses this for its internal signal pipe: It |
687 | visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if |
972 | is not visible to the libev user and should not keep \f(CW\*(C`ev_run\*(C'\fR from |
688 | no event watchers registered by it are active. It is also an excellent |
973 | exiting if no event watchers registered by it are active. It is also an |
689 | way to do this for generic recurring timers or from within third-party |
974 | excellent way to do this for generic recurring timers or from within |
690 | libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. |
975 | third-party libraries. Just remember to \fIunref after start\fR and \fIref |
|
|
976 | before stop\fR (but only if the watcher wasn't active before, or was active |
|
|
977 | before, respectively. Note also that libev might stop watchers itself |
|
|
978 | (e.g. non-repeating timers) in which case you have to \f(CW\*(C`ev_ref\*(C'\fR |
|
|
979 | in the callback). |
691 | .Sp |
980 | .Sp |
692 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR |
981 | Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_run\*(C'\fR |
693 | running when nothing else is active. |
982 | running when nothing else is active. |
694 | .Sp |
983 | .Sp |
695 | .Vb 4 |
984 | .Vb 4 |
696 | \& struct ev_signal exitsig; |
985 | \& ev_signal exitsig; |
697 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
986 | \& ev_signal_init (&exitsig, sig_cb, SIGINT); |
698 | \& ev_signal_start (loop, &exitsig); |
987 | \& ev_signal_start (loop, &exitsig); |
699 | \& evf_unref (loop); |
988 | \& evf_unref (loop); |
700 | .Ve |
989 | .Ve |
701 | .Sp |
990 | .Sp |
702 | Example: For some weird reason, unregister the above signal handler again. |
991 | Example: For some weird reason, unregister the above signal handler again. |
703 | .Sp |
992 | .Sp |
704 | .Vb 2 |
993 | .Vb 2 |
705 | \& ev_ref (loop); |
994 | \& ev_ref (loop); |
706 | \& ev_signal_stop (loop, &exitsig); |
995 | \& ev_signal_stop (loop, &exitsig); |
707 | .Ve |
996 | .Ve |
|
|
997 | .IP "ev_set_io_collect_interval (loop, ev_tstamp interval)" 4 |
|
|
998 | .IX Item "ev_set_io_collect_interval (loop, ev_tstamp interval)" |
|
|
999 | .PD 0 |
|
|
1000 | .IP "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" 4 |
|
|
1001 | .IX Item "ev_set_timeout_collect_interval (loop, ev_tstamp interval)" |
|
|
1002 | .PD |
|
|
1003 | These advanced functions influence the time that libev will spend waiting |
|
|
1004 | for events. Both time intervals are by default \f(CW0\fR, meaning that libev |
|
|
1005 | will try to invoke timer/periodic callbacks and I/O callbacks with minimum |
|
|
1006 | latency. |
|
|
1007 | .Sp |
|
|
1008 | Setting these to a higher value (the \f(CW\*(C`interval\*(C'\fR \fImust\fR be >= \f(CW0\fR) |
|
|
1009 | allows libev to delay invocation of I/O and timer/periodic callbacks |
|
|
1010 | to increase efficiency of loop iterations (or to increase power-saving |
|
|
1011 | opportunities). |
|
|
1012 | .Sp |
|
|
1013 | The idea is that sometimes your program runs just fast enough to handle |
|
|
1014 | one (or very few) event(s) per loop iteration. While this makes the |
|
|
1015 | program responsive, it also wastes a lot of \s-1CPU\s0 time to poll for new |
|
|
1016 | events, especially with backends like \f(CW\*(C`select ()\*(C'\fR which have a high |
|
|
1017 | overhead for the actual polling but can deliver many events at once. |
|
|
1018 | .Sp |
|
|
1019 | By setting a higher \fIio collect interval\fR you allow libev to spend more |
|
|
1020 | time collecting I/O events, so you can handle more events per iteration, |
|
|
1021 | at the cost of increasing latency. Timeouts (both \f(CW\*(C`ev_periodic\*(C'\fR and |
|
|
1022 | \&\f(CW\*(C`ev_timer\*(C'\fR) will be not affected. Setting this to a non-null value will |
|
|
1023 | introduce an additional \f(CW\*(C`ev_sleep ()\*(C'\fR call into most loop iterations. The |
|
|
1024 | sleep time ensures that libev will not poll for I/O events more often then |
|
|
1025 | once per this interval, on average. |
|
|
1026 | .Sp |
|
|
1027 | Likewise, by setting a higher \fItimeout collect interval\fR you allow libev |
|
|
1028 | to spend more time collecting timeouts, at the expense of increased |
|
|
1029 | latency/jitter/inexactness (the watcher callback will be called |
|
|
1030 | later). \f(CW\*(C`ev_io\*(C'\fR watchers will not be affected. Setting this to a non-null |
|
|
1031 | value will not introduce any overhead in libev. |
|
|
1032 | .Sp |
|
|
1033 | Many (busy) programs can usually benefit by setting the I/O collect |
|
|
1034 | interval to a value near \f(CW0.1\fR or so, which is often enough for |
|
|
1035 | interactive servers (of course not for games), likewise for timeouts. It |
|
|
1036 | usually doesn't make much sense to set it to a lower value than \f(CW0.01\fR, |
|
|
1037 | as this approaches the timing granularity of most systems. Note that if |
|
|
1038 | you do transactions with the outside world and you can't increase the |
|
|
1039 | parallelity, then this setting will limit your transaction rate (if you |
|
|
1040 | need to poll once per transaction and the I/O collect interval is 0.01, |
|
|
1041 | then you can't do more than 100 transactions per second). |
|
|
1042 | .Sp |
|
|
1043 | Setting the \fItimeout collect interval\fR can improve the opportunity for |
|
|
1044 | saving power, as the program will \*(L"bundle\*(R" timer callback invocations that |
|
|
1045 | are \*(L"near\*(R" in time together, by delaying some, thus reducing the number of |
|
|
1046 | times the process sleeps and wakes up again. Another useful technique to |
|
|
1047 | reduce iterations/wake\-ups is to use \f(CW\*(C`ev_periodic\*(C'\fR watchers and make sure |
|
|
1048 | they fire on, say, one-second boundaries only. |
|
|
1049 | .Sp |
|
|
1050 | Example: we only need 0.1s timeout granularity, and we wish not to poll |
|
|
1051 | more often than 100 times per second: |
|
|
1052 | .Sp |
|
|
1053 | .Vb 2 |
|
|
1054 | \& ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); |
|
|
1055 | \& ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
|
|
1056 | .Ve |
|
|
1057 | .IP "ev_invoke_pending (loop)" 4 |
|
|
1058 | .IX Item "ev_invoke_pending (loop)" |
|
|
1059 | This call will simply invoke all pending watchers while resetting their |
|
|
1060 | pending state. Normally, \f(CW\*(C`ev_run\*(C'\fR does this automatically when required, |
|
|
1061 | but when overriding the invoke callback this call comes handy. This |
|
|
1062 | function can be invoked from a watcher \- this can be useful for example |
|
|
1063 | when you want to do some lengthy calculation and want to pass further |
|
|
1064 | event handling to another thread (you still have to make sure only one |
|
|
1065 | thread executes within \f(CW\*(C`ev_invoke_pending\*(C'\fR or \f(CW\*(C`ev_run\*(C'\fR of course). |
|
|
1066 | .IP "int ev_pending_count (loop)" 4 |
|
|
1067 | .IX Item "int ev_pending_count (loop)" |
|
|
1068 | Returns the number of pending watchers \- zero indicates that no watchers |
|
|
1069 | are pending. |
|
|
1070 | .IP "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(\s-1EV_P\s0))" 4 |
|
|
1071 | .IX Item "ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))" |
|
|
1072 | This overrides the invoke pending functionality of the loop: Instead of |
|
|
1073 | invoking all pending watchers when there are any, \f(CW\*(C`ev_run\*(C'\fR will call |
|
|
1074 | this callback instead. This is useful, for example, when you want to |
|
|
1075 | invoke the actual watchers inside another context (another thread etc.). |
|
|
1076 | .Sp |
|
|
1077 | If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new |
|
|
1078 | callback. |
|
|
1079 | .IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 |
|
|
1080 | .IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))" |
|
|
1081 | Sometimes you want to share the same loop between multiple threads. This |
|
|
1082 | can be done relatively simply by putting mutex_lock/unlock calls around |
|
|
1083 | each call to a libev function. |
|
|
1084 | .Sp |
|
|
1085 | However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible |
|
|
1086 | to wait for it to return. One way around this is to wake up the event |
|
|
1087 | loop via \f(CW\*(C`ev_break\*(C'\fR and \f(CW\*(C`av_async_send\*(C'\fR, another way is to set these |
|
|
1088 | \&\fIrelease\fR and \fIacquire\fR callbacks on the loop. |
|
|
1089 | .Sp |
|
|
1090 | When set, then \f(CW\*(C`release\*(C'\fR will be called just before the thread is |
|
|
1091 | suspended waiting for new events, and \f(CW\*(C`acquire\*(C'\fR is called just |
|
|
1092 | afterwards. |
|
|
1093 | .Sp |
|
|
1094 | Ideally, \f(CW\*(C`release\*(C'\fR will just call your mutex_unlock function, and |
|
|
1095 | \&\f(CW\*(C`acquire\*(C'\fR will just call the mutex_lock function again. |
|
|
1096 | .Sp |
|
|
1097 | While event loop modifications are allowed between invocations of |
|
|
1098 | \&\f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR (that's their only purpose after all), no |
|
|
1099 | modifications done will affect the event loop, i.e. adding watchers will |
|
|
1100 | have no effect on the set of file descriptors being watched, or the time |
|
|
1101 | waited. Use an \f(CW\*(C`ev_async\*(C'\fR watcher to wake up \f(CW\*(C`ev_run\*(C'\fR when you want it |
|
|
1102 | to take note of any changes you made. |
|
|
1103 | .Sp |
|
|
1104 | In theory, threads executing \f(CW\*(C`ev_run\*(C'\fR will be async-cancel safe between |
|
|
1105 | invocations of \f(CW\*(C`release\*(C'\fR and \f(CW\*(C`acquire\*(C'\fR. |
|
|
1106 | .Sp |
|
|
1107 | See also the locking example in the \f(CW\*(C`THREADS\*(C'\fR section later in this |
|
|
1108 | document. |
|
|
1109 | .IP "ev_set_userdata (loop, void *data)" 4 |
|
|
1110 | .IX Item "ev_set_userdata (loop, void *data)" |
|
|
1111 | .PD 0 |
|
|
1112 | .IP "ev_userdata (loop)" 4 |
|
|
1113 | .IX Item "ev_userdata (loop)" |
|
|
1114 | .PD |
|
|
1115 | Set and retrieve a single \f(CW\*(C`void *\*(C'\fR associated with a loop. When |
|
|
1116 | \&\f(CW\*(C`ev_set_userdata\*(C'\fR has never been called, then \f(CW\*(C`ev_userdata\*(C'\fR returns |
|
|
1117 | \&\f(CW0.\fR |
|
|
1118 | .Sp |
|
|
1119 | These two functions can be used to associate arbitrary data with a loop, |
|
|
1120 | and are intended solely for the \f(CW\*(C`invoke_pending_cb\*(C'\fR, \f(CW\*(C`release\*(C'\fR and |
|
|
1121 | \&\f(CW\*(C`acquire\*(C'\fR callbacks described above, but of course can be (ab\-)used for |
|
|
1122 | any other purpose as well. |
|
|
1123 | .IP "ev_verify (loop)" 4 |
|
|
1124 | .IX Item "ev_verify (loop)" |
|
|
1125 | This function only does something when \f(CW\*(C`EV_VERIFY\*(C'\fR support has been |
|
|
1126 | compiled in, which is the default for non-minimal builds. It tries to go |
|
|
1127 | through all internal structures and checks them for validity. If anything |
|
|
1128 | is found to be inconsistent, it will print an error message to standard |
|
|
1129 | error and call \f(CW\*(C`abort ()\*(C'\fR. |
|
|
1130 | .Sp |
|
|
1131 | This can be used to catch bugs inside libev itself: under normal |
|
|
1132 | circumstances, this function will never abort as of course libev keeps its |
|
|
1133 | data structures consistent. |
708 | .SH "ANATOMY OF A WATCHER" |
1134 | .SH "ANATOMY OF A WATCHER" |
709 | .IX Header "ANATOMY OF A WATCHER" |
1135 | .IX Header "ANATOMY OF A WATCHER" |
|
|
1136 | In the following description, uppercase \f(CW\*(C`TYPE\*(C'\fR in names stands for the |
|
|
1137 | watcher type, e.g. \f(CW\*(C`ev_TYPE_start\*(C'\fR can mean \f(CW\*(C`ev_timer_start\*(C'\fR for timer |
|
|
1138 | watchers and \f(CW\*(C`ev_io_start\*(C'\fR for I/O watchers. |
|
|
1139 | .PP |
710 | A watcher is a structure that you create and register to record your |
1140 | A watcher is an opaque structure that you allocate and register to record |
711 | interest in some event. For instance, if you want to wait for \s-1STDIN\s0 to |
1141 | your interest in some event. To make a concrete example, imagine you want |
712 | become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher for that: |
1142 | to wait for \s-1STDIN\s0 to become readable, you would create an \f(CW\*(C`ev_io\*(C'\fR watcher |
|
|
1143 | for that: |
713 | .PP |
1144 | .PP |
714 | .Vb 5 |
1145 | .Vb 5 |
715 | \& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1146 | \& static void my_cb (struct ev_loop *loop, ev_io *w, int revents) |
716 | \& { |
1147 | \& { |
717 | \& ev_io_stop (w); |
1148 | \& ev_io_stop (w); |
718 | \& ev_unloop (loop, EVUNLOOP_ALL); |
1149 | \& ev_break (loop, EVBREAK_ALL); |
719 | \& } |
1150 | \& } |
720 | .Ve |
1151 | \& |
721 | .PP |
|
|
722 | .Vb 6 |
|
|
723 | \& struct ev_loop *loop = ev_default_loop (0); |
1152 | \& struct ev_loop *loop = ev_default_loop (0); |
|
|
1153 | \& |
724 | \& struct ev_io stdin_watcher; |
1154 | \& ev_io stdin_watcher; |
|
|
1155 | \& |
725 | \& ev_init (&stdin_watcher, my_cb); |
1156 | \& ev_init (&stdin_watcher, my_cb); |
726 | \& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
1157 | \& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); |
727 | \& ev_io_start (loop, &stdin_watcher); |
1158 | \& ev_io_start (loop, &stdin_watcher); |
|
|
1159 | \& |
728 | \& ev_loop (loop, 0); |
1160 | \& ev_run (loop, 0); |
729 | .Ve |
1161 | .Ve |
730 | .PP |
1162 | .PP |
731 | As you can see, you are responsible for allocating the memory for your |
1163 | As you can see, you are responsible for allocating the memory for your |
732 | watcher structures (and it is usually a bad idea to do this on the stack, |
1164 | watcher structures (and it is \fIusually\fR a bad idea to do this on the |
733 | although this can sometimes be quite valid). |
1165 | stack). |
734 | .PP |
1166 | .PP |
|
|
1167 | Each watcher has an associated watcher structure (called \f(CW\*(C`struct ev_TYPE\*(C'\fR |
|
|
1168 | or simply \f(CW\*(C`ev_TYPE\*(C'\fR, as typedefs are provided for all watcher structs). |
|
|
1169 | .PP |
735 | Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init |
1170 | Each watcher structure must be initialised by a call to \f(CW\*(C`ev_init (watcher |
736 | (watcher *, callback)\*(C'\fR, which expects a callback to be provided. This |
1171 | *, callback)\*(C'\fR, which expects a callback to be provided. This callback is |
737 | callback gets invoked each time the event occurs (or, in the case of io |
1172 | invoked each time the event occurs (or, in the case of I/O watchers, each |
738 | watchers, each time the event loop detects that the file descriptor given |
1173 | time the event loop detects that the file descriptor given is readable |
739 | is readable and/or writable). |
1174 | and/or writable). |
740 | .PP |
1175 | .PP |
741 | Each watcher type has its own \f(CW\*(C`ev_<type>_set (watcher *, ...)\*(C'\fR macro |
1176 | Each watcher type further has its own \f(CW\*(C`ev_TYPE_set (watcher *, ...)\*(C'\fR |
742 | with arguments specific to this watcher type. There is also a macro |
1177 | macro to configure it, with arguments specific to the watcher type. There |
743 | to combine initialisation and setting in one call: \f(CW\*(C`ev_<type>_init |
1178 | is also a macro to combine initialisation and setting in one call: \f(CW\*(C`ev_TYPE_init (watcher *, callback, ...)\*(C'\fR. |
744 | (watcher *, callback, ...)\*(C'\fR. |
|
|
745 | .PP |
1179 | .PP |
746 | To make the watcher actually watch out for events, you have to start it |
1180 | To make the watcher actually watch out for events, you have to start it |
747 | with a watcher-specific start function (\f(CW\*(C`ev_<type>_start (loop, watcher |
1181 | with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher |
748 | *)\*(C'\fR), and you can stop watching for events at any time by calling the |
1182 | *)\*(C'\fR), and you can stop watching for events at any time by calling the |
749 | corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR. |
1183 | corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR. |
750 | .PP |
1184 | .PP |
751 | As long as your watcher is active (has been started but not stopped) you |
1185 | As long as your watcher is active (has been started but not stopped) you |
752 | must not touch the values stored in it. Most specifically you must never |
1186 | must not touch the values stored in it. Most specifically you must never |
753 | reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro. |
1187 | reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro. |
754 | .PP |
1188 | .PP |
755 | Each and every callback receives the event loop pointer as first, the |
1189 | Each and every callback receives the event loop pointer as first, the |
756 | registered watcher structure as second, and a bitset of received events as |
1190 | registered watcher structure as second, and a bitset of received events as |
757 | third argument. |
1191 | third argument. |
758 | .PP |
1192 | .PP |
… | |
… | |
767 | .el .IP "\f(CWEV_WRITE\fR" 4 |
1201 | .el .IP "\f(CWEV_WRITE\fR" 4 |
768 | .IX Item "EV_WRITE" |
1202 | .IX Item "EV_WRITE" |
769 | .PD |
1203 | .PD |
770 | The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or |
1204 | The file descriptor in the \f(CW\*(C`ev_io\*(C'\fR watcher has become readable and/or |
771 | writable. |
1205 | writable. |
772 | .ie n .IP """EV_TIMEOUT""" 4 |
1206 | .ie n .IP """EV_TIMER""" 4 |
773 | .el .IP "\f(CWEV_TIMEOUT\fR" 4 |
1207 | .el .IP "\f(CWEV_TIMER\fR" 4 |
774 | .IX Item "EV_TIMEOUT" |
1208 | .IX Item "EV_TIMER" |
775 | The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. |
1209 | The \f(CW\*(C`ev_timer\*(C'\fR watcher has timed out. |
776 | .ie n .IP """EV_PERIODIC""" 4 |
1210 | .ie n .IP """EV_PERIODIC""" 4 |
777 | .el .IP "\f(CWEV_PERIODIC\fR" 4 |
1211 | .el .IP "\f(CWEV_PERIODIC\fR" 4 |
778 | .IX Item "EV_PERIODIC" |
1212 | .IX Item "EV_PERIODIC" |
779 | The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. |
1213 | The \f(CW\*(C`ev_periodic\*(C'\fR watcher has timed out. |
… | |
… | |
799 | .PD 0 |
1233 | .PD 0 |
800 | .ie n .IP """EV_CHECK""" 4 |
1234 | .ie n .IP """EV_CHECK""" 4 |
801 | .el .IP "\f(CWEV_CHECK\fR" 4 |
1235 | .el .IP "\f(CWEV_CHECK\fR" 4 |
802 | .IX Item "EV_CHECK" |
1236 | .IX Item "EV_CHECK" |
803 | .PD |
1237 | .PD |
804 | All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_loop\*(C'\fR starts |
1238 | All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts |
805 | to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after |
1239 | to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after |
806 | \&\f(CW\*(C`ev_loop\*(C'\fR has gathered them, but before it invokes any callbacks for any |
1240 | \&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any |
807 | received events. Callbacks of both watcher types can start and stop as |
1241 | received events. Callbacks of both watcher types can start and stop as |
808 | many watchers as they want, and all of them will be taken into account |
1242 | many watchers as they want, and all of them will be taken into account |
809 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
1243 | (for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep |
810 | \&\f(CW\*(C`ev_loop\*(C'\fR from blocking). |
1244 | \&\f(CW\*(C`ev_run\*(C'\fR from blocking). |
811 | .ie n .IP """EV_EMBED""" 4 |
1245 | .ie n .IP """EV_EMBED""" 4 |
812 | .el .IP "\f(CWEV_EMBED\fR" 4 |
1246 | .el .IP "\f(CWEV_EMBED\fR" 4 |
813 | .IX Item "EV_EMBED" |
1247 | .IX Item "EV_EMBED" |
814 | The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. |
1248 | The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. |
815 | .ie n .IP """EV_FORK""" 4 |
1249 | .ie n .IP """EV_FORK""" 4 |
816 | .el .IP "\f(CWEV_FORK\fR" 4 |
1250 | .el .IP "\f(CWEV_FORK\fR" 4 |
817 | .IX Item "EV_FORK" |
1251 | .IX Item "EV_FORK" |
818 | The event loop has been resumed in the child process after fork (see |
1252 | The event loop has been resumed in the child process after fork (see |
819 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
1253 | \&\f(CW\*(C`ev_fork\*(C'\fR). |
|
|
1254 | .ie n .IP """EV_CLEANUP""" 4 |
|
|
1255 | .el .IP "\f(CWEV_CLEANUP\fR" 4 |
|
|
1256 | .IX Item "EV_CLEANUP" |
|
|
1257 | The event loop is about to be destroyed (see \f(CW\*(C`ev_cleanup\*(C'\fR). |
|
|
1258 | .ie n .IP """EV_ASYNC""" 4 |
|
|
1259 | .el .IP "\f(CWEV_ASYNC\fR" 4 |
|
|
1260 | .IX Item "EV_ASYNC" |
|
|
1261 | The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR). |
|
|
1262 | .ie n .IP """EV_CUSTOM""" 4 |
|
|
1263 | .el .IP "\f(CWEV_CUSTOM\fR" 4 |
|
|
1264 | .IX Item "EV_CUSTOM" |
|
|
1265 | Not ever sent (or otherwise used) by libev itself, but can be freely used |
|
|
1266 | by libev users to signal watchers (e.g. via \f(CW\*(C`ev_feed_event\*(C'\fR). |
820 | .ie n .IP """EV_ERROR""" 4 |
1267 | .ie n .IP """EV_ERROR""" 4 |
821 | .el .IP "\f(CWEV_ERROR\fR" 4 |
1268 | .el .IP "\f(CWEV_ERROR\fR" 4 |
822 | .IX Item "EV_ERROR" |
1269 | .IX Item "EV_ERROR" |
823 | An unspecified error has occured, the watcher has been stopped. This might |
1270 | An unspecified error has occurred, the watcher has been stopped. This might |
824 | happen because the watcher could not be properly started because libev |
1271 | happen because the watcher could not be properly started because libev |
825 | ran out of memory, a file descriptor was found to be closed or any other |
1272 | ran out of memory, a file descriptor was found to be closed or any other |
|
|
1273 | problem. Libev considers these application bugs. |
|
|
1274 | .Sp |
826 | problem. You best act on it by reporting the problem and somehow coping |
1275 | You best act on it by reporting the problem and somehow coping with the |
827 | with the watcher being stopped. |
1276 | watcher being stopped. Note that well-written programs should not receive |
|
|
1277 | an error ever, so when your watcher receives it, this usually indicates a |
|
|
1278 | bug in your program. |
828 | .Sp |
1279 | .Sp |
829 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, |
1280 | Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for |
830 | for example it might indicate that a fd is readable or writable, and if |
1281 | example it might indicate that a fd is readable or writable, and if your |
831 | your callbacks is well-written it can just attempt the operation and cope |
1282 | callbacks is well-written it can just attempt the operation and cope with |
832 | with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded |
1283 | the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded |
833 | programs, though, so beware. |
1284 | programs, though, as the fd could already be closed and reused for another |
|
|
1285 | thing, so beware. |
834 | .Sh "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
1286 | .SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" |
835 | .IX Subsection "GENERIC WATCHER FUNCTIONS" |
1287 | .IX Subsection "GENERIC WATCHER FUNCTIONS" |
836 | In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type, |
|
|
837 | 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. |
|
|
838 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
1288 | .ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 |
839 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
1289 | .el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 |
840 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
1290 | .IX Item "ev_init (ev_TYPE *watcher, callback)" |
841 | This macro initialises the generic portion of a watcher. The contents |
1291 | This macro initialises the generic portion of a watcher. The contents |
842 | of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only |
1292 | of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only |
… | |
… | |
846 | which rolls both calls into one. |
1296 | which rolls both calls into one. |
847 | .Sp |
1297 | .Sp |
848 | You can reinitialise a watcher at any time as long as it has been stopped |
1298 | You can reinitialise a watcher at any time as long as it has been stopped |
849 | (or never started) and there are no pending events outstanding. |
1299 | (or never started) and there are no pending events outstanding. |
850 | .Sp |
1300 | .Sp |
851 | The callback is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher, |
1301 | The callback is always of type \f(CW\*(C`void (*)(struct ev_loop *loop, ev_TYPE *watcher, |
852 | int revents)\*(C'\fR. |
1302 | int revents)\*(C'\fR. |
|
|
1303 | .Sp |
|
|
1304 | Example: Initialise an \f(CW\*(C`ev_io\*(C'\fR watcher in two steps. |
|
|
1305 | .Sp |
|
|
1306 | .Vb 3 |
|
|
1307 | \& ev_io w; |
|
|
1308 | \& ev_init (&w, my_cb); |
|
|
1309 | \& ev_io_set (&w, STDIN_FILENO, EV_READ); |
|
|
1310 | .Ve |
853 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4 |
1311 | .ie n .IP """ev_TYPE_set"" (ev_TYPE *watcher, [args])" 4 |
854 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4 |
1312 | .el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *watcher, [args])" 4 |
855 | .IX Item "ev_TYPE_set (ev_TYPE *, [args])" |
1313 | .IX Item "ev_TYPE_set (ev_TYPE *watcher, [args])" |
856 | This macro initialises the type-specific parts of a watcher. You need to |
1314 | This macro initialises the type-specific parts of a watcher. You need to |
857 | call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can |
1315 | call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can |
858 | call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this |
1316 | call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this |
859 | macro on a watcher that is active (it can be pending, however, which is a |
1317 | macro on a watcher that is active (it can be pending, however, which is a |
860 | difference to the \f(CW\*(C`ev_init\*(C'\fR macro). |
1318 | difference to the \f(CW\*(C`ev_init\*(C'\fR macro). |
861 | .Sp |
1319 | .Sp |
862 | Although some watcher types do not have type-specific arguments |
1320 | Although some watcher types do not have type-specific arguments |
863 | (e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. |
1321 | (e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro. |
|
|
1322 | .Sp |
|
|
1323 | See \f(CW\*(C`ev_init\*(C'\fR, above, for an example. |
864 | .ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 |
1324 | .ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4 |
865 | .el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 |
1325 | .el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4 |
866 | .IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" |
1326 | .IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])" |
867 | This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro |
1327 | This convenience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro |
868 | calls into a single call. This is the most convinient method to initialise |
1328 | calls into a single call. This is the most convenient method to initialise |
869 | a watcher. The same limitations apply, of course. |
1329 | a watcher. The same limitations apply, of course. |
|
|
1330 | .Sp |
|
|
1331 | Example: Initialise and set an \f(CW\*(C`ev_io\*(C'\fR watcher in one step. |
|
|
1332 | .Sp |
|
|
1333 | .Vb 1 |
|
|
1334 | \& ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
|
|
1335 | .Ve |
870 | .ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4 |
1336 | .ie n .IP """ev_TYPE_start"" (loop, ev_TYPE *watcher)" 4 |
871 | .el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4 |
1337 | .el .IP "\f(CWev_TYPE_start\fR (loop, ev_TYPE *watcher)" 4 |
872 | .IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)" |
1338 | .IX Item "ev_TYPE_start (loop, ev_TYPE *watcher)" |
873 | Starts (activates) the given watcher. Only active watchers will receive |
1339 | Starts (activates) the given watcher. Only active watchers will receive |
874 | events. If the watcher is already active nothing will happen. |
1340 | events. If the watcher is already active nothing will happen. |
|
|
1341 | .Sp |
|
|
1342 | Example: Start the \f(CW\*(C`ev_io\*(C'\fR watcher that is being abused as example in this |
|
|
1343 | whole section. |
|
|
1344 | .Sp |
|
|
1345 | .Vb 1 |
|
|
1346 | \& ev_io_start (EV_DEFAULT_UC, &w); |
|
|
1347 | .Ve |
875 | .ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4 |
1348 | .ie n .IP """ev_TYPE_stop"" (loop, ev_TYPE *watcher)" 4 |
876 | .el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4 |
1349 | .el .IP "\f(CWev_TYPE_stop\fR (loop, ev_TYPE *watcher)" 4 |
877 | .IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)" |
1350 | .IX Item "ev_TYPE_stop (loop, ev_TYPE *watcher)" |
878 | Stops the given watcher again (if active) and clears the pending |
1351 | Stops the given watcher if active, and clears the pending status (whether |
|
|
1352 | the watcher was active or not). |
|
|
1353 | .Sp |
879 | status. It is possible that stopped watchers are pending (for example, |
1354 | It is possible that stopped watchers are pending \- for example, |
880 | non-repeating timers are being stopped when they become pending), but |
1355 | non-repeating timers are being stopped when they become pending \- but |
881 | \&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If |
1356 | calling \f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor |
882 | you want to free or reuse the memory used by the watcher it is therefore a |
1357 | pending. If you want to free or reuse the memory used by the watcher it is |
883 | good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. |
1358 | therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. |
884 | .IP "bool ev_is_active (ev_TYPE *watcher)" 4 |
1359 | .IP "bool ev_is_active (ev_TYPE *watcher)" 4 |
885 | .IX Item "bool ev_is_active (ev_TYPE *watcher)" |
1360 | .IX Item "bool ev_is_active (ev_TYPE *watcher)" |
886 | Returns a true value iff the watcher is active (i.e. it has been started |
1361 | Returns a true value iff the watcher is active (i.e. it has been started |
887 | and not yet been stopped). As long as a watcher is active you must not modify |
1362 | and not yet been stopped). As long as a watcher is active you must not modify |
888 | it. |
1363 | it. |
889 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
1364 | .IP "bool ev_is_pending (ev_TYPE *watcher)" 4 |
890 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
1365 | .IX Item "bool ev_is_pending (ev_TYPE *watcher)" |
891 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
1366 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
892 | events but its callback has not yet been invoked). As long as a watcher |
1367 | events but its callback has not yet been invoked). As long as a watcher |
893 | is pending (but not active) you must not call an init function on it (but |
1368 | is pending (but not active) you must not call an init function on it (but |
894 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to |
1369 | \&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must |
895 | libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it). |
1370 | make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR |
|
|
1371 | it). |
896 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
1372 | .IP "callback ev_cb (ev_TYPE *watcher)" 4 |
897 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
1373 | .IX Item "callback ev_cb (ev_TYPE *watcher)" |
898 | Returns the callback currently set on the watcher. |
1374 | Returns the callback currently set on the watcher. |
899 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
1375 | .IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 |
900 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
1376 | .IX Item "ev_cb_set (ev_TYPE *watcher, callback)" |
901 | Change the callback. You can change the callback at virtually any time |
1377 | Change the callback. You can change the callback at virtually any time |
902 | (modulo threads). |
1378 | (modulo threads). |
903 | .IP "ev_set_priority (ev_TYPE *watcher, priority)" 4 |
1379 | .IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 |
904 | .IX Item "ev_set_priority (ev_TYPE *watcher, priority)" |
1380 | .IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" |
905 | .PD 0 |
1381 | .PD 0 |
906 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
1382 | .IP "int ev_priority (ev_TYPE *watcher)" 4 |
907 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
1383 | .IX Item "int ev_priority (ev_TYPE *watcher)" |
908 | .PD |
1384 | .PD |
909 | Set and query the priority of the watcher. The priority is a small |
1385 | Set and query the priority of the watcher. The priority is a small |
910 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
1386 | integer between \f(CW\*(C`EV_MAXPRI\*(C'\fR (default: \f(CW2\fR) and \f(CW\*(C`EV_MINPRI\*(C'\fR |
911 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
1387 | (default: \f(CW\*(C`\-2\*(C'\fR). Pending watchers with higher priority will be invoked |
912 | before watchers with lower priority, but priority will not keep watchers |
1388 | before watchers with lower priority, but priority will not keep watchers |
913 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
1389 | from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). |
914 | .Sp |
1390 | .Sp |
915 | This means that priorities are \fIonly\fR used for ordering callback |
|
|
916 | invocation after new events have been received. This is useful, for |
|
|
917 | example, to reduce latency after idling, or more often, to bind two |
|
|
918 | watchers on the same event and make sure one is called first. |
|
|
919 | .Sp |
|
|
920 | If you need to suppress invocation when higher priority events are pending |
1391 | If you need to suppress invocation when higher priority events are pending |
921 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
1392 | you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. |
922 | .Sp |
1393 | .Sp |
|
|
1394 | You \fImust not\fR change the priority of a watcher as long as it is active or |
|
|
1395 | pending. |
|
|
1396 | .Sp |
|
|
1397 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
|
|
1398 | fine, as long as you do not mind that the priority value you query might |
|
|
1399 | or might not have been clamped to the valid range. |
|
|
1400 | .Sp |
923 | The default priority used by watchers when no priority has been set is |
1401 | The default priority used by watchers when no priority has been set is |
924 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
1402 | always \f(CW0\fR, which is supposed to not be too high and not be too low :). |
925 | .Sp |
1403 | .Sp |
926 | Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is |
1404 | See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of |
927 | fine, as long as you do not mind that the priority value you query might |
1405 | priorities. |
928 | or might not have been adjusted to be within valid range. |
1406 | .IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
1407 | .IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" |
|
|
1408 | 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 |
|
|
1409 | \&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback |
|
|
1410 | can deal with that fact, as both are simply passed through to the |
|
|
1411 | callback. |
|
|
1412 | .IP "int ev_clear_pending (loop, ev_TYPE *watcher)" 4 |
|
|
1413 | .IX Item "int ev_clear_pending (loop, ev_TYPE *watcher)" |
|
|
1414 | If the watcher is pending, this function clears its pending status and |
|
|
1415 | returns its \f(CW\*(C`revents\*(C'\fR bitset (as if its callback was invoked). If the |
|
|
1416 | watcher isn't pending it does nothing and returns \f(CW0\fR. |
|
|
1417 | .Sp |
|
|
1418 | Sometimes it can be useful to \*(L"poll\*(R" a watcher instead of waiting for its |
|
|
1419 | callback to be invoked, which can be accomplished with this function. |
|
|
1420 | .IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4 |
|
|
1421 | .IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)" |
|
|
1422 | Feeds the given event set into the event loop, as if the specified event |
|
|
1423 | had happened for the specified watcher (which must be a pointer to an |
|
|
1424 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1425 | not free the watcher as long as it has pending events. |
|
|
1426 | .Sp |
|
|
1427 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1428 | \&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was |
|
|
1429 | not started in the first place. |
|
|
1430 | .Sp |
|
|
1431 | See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related |
|
|
1432 | functions that do not need a watcher. |
929 | .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
1433 | .SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" |
930 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
1434 | .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" |
931 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
1435 | Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change |
932 | and read at any time, libev will completely ignore it. This can be used |
1436 | and read at any time: libev will completely ignore it. This can be used |
933 | to associate arbitrary data with your watcher. If you need more data and |
1437 | to associate arbitrary data with your watcher. If you need more data and |
934 | don't want to allocate memory and store a pointer to it in that data |
1438 | don't want to allocate memory and store a pointer to it in that data |
935 | member, you can also \*(L"subclass\*(R" the watcher type and provide your own |
1439 | member, you can also \*(L"subclass\*(R" the watcher type and provide your own |
936 | data: |
1440 | data: |
937 | .PP |
1441 | .PP |
938 | .Vb 7 |
1442 | .Vb 7 |
939 | \& struct my_io |
1443 | \& struct my_io |
940 | \& { |
1444 | \& { |
941 | \& struct ev_io io; |
1445 | \& ev_io io; |
942 | \& int otherfd; |
1446 | \& int otherfd; |
943 | \& void *somedata; |
1447 | \& void *somedata; |
944 | \& struct whatever *mostinteresting; |
1448 | \& struct whatever *mostinteresting; |
945 | \& } |
1449 | \& }; |
|
|
1450 | \& |
|
|
1451 | \& ... |
|
|
1452 | \& struct my_io w; |
|
|
1453 | \& ev_io_init (&w.io, my_cb, fd, EV_READ); |
946 | .Ve |
1454 | .Ve |
947 | .PP |
1455 | .PP |
948 | And since your callback will be called with a pointer to the watcher, you |
1456 | And since your callback will be called with a pointer to the watcher, you |
949 | can cast it back to your own type: |
1457 | can cast it back to your own type: |
950 | .PP |
1458 | .PP |
951 | .Vb 5 |
1459 | .Vb 5 |
952 | \& static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents) |
1460 | \& static void my_cb (struct ev_loop *loop, ev_io *w_, int revents) |
953 | \& { |
1461 | \& { |
954 | \& struct my_io *w = (struct my_io *)w_; |
1462 | \& struct my_io *w = (struct my_io *)w_; |
955 | \& ... |
1463 | \& ... |
956 | \& } |
1464 | \& } |
957 | .Ve |
1465 | .Ve |
958 | .PP |
1466 | .PP |
959 | More interesting and less C\-conformant ways of casting your callback type |
1467 | More interesting and less C\-conformant ways of casting your callback type |
960 | instead have been omitted. |
1468 | instead have been omitted. |
961 | .PP |
1469 | .PP |
962 | Another common scenario is having some data structure with multiple |
1470 | Another common scenario is to use some data structure with multiple |
963 | watchers: |
1471 | embedded watchers: |
964 | .PP |
1472 | .PP |
965 | .Vb 6 |
1473 | .Vb 6 |
966 | \& struct my_biggy |
1474 | \& struct my_biggy |
967 | \& { |
1475 | \& { |
968 | \& int some_data; |
1476 | \& int some_data; |
969 | \& ev_timer t1; |
1477 | \& ev_timer t1; |
970 | \& ev_timer t2; |
1478 | \& ev_timer t2; |
971 | \& } |
1479 | \& } |
972 | .Ve |
1480 | .Ve |
973 | .PP |
1481 | .PP |
974 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, |
1482 | In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more |
975 | you need to use \f(CW\*(C`offsetof\*(C'\fR: |
1483 | complicated: Either you store the address of your \f(CW\*(C`my_biggy\*(C'\fR struct |
|
|
1484 | in the \f(CW\*(C`data\*(C'\fR member of the watcher (for woozies), or you need to use |
|
|
1485 | some pointer arithmetic using \f(CW\*(C`offsetof\*(C'\fR inside your watchers (for real |
|
|
1486 | programmers): |
976 | .PP |
1487 | .PP |
977 | .Vb 1 |
1488 | .Vb 1 |
978 | \& #include <stddef.h> |
1489 | \& #include <stddef.h> |
979 | .Ve |
1490 | \& |
980 | .PP |
|
|
981 | .Vb 6 |
|
|
982 | \& static void |
1491 | \& static void |
983 | \& t1_cb (EV_P_ struct ev_timer *w, int revents) |
1492 | \& t1_cb (EV_P_ ev_timer *w, int revents) |
984 | \& { |
1493 | \& { |
985 | \& struct my_biggy big = (struct my_biggy * |
1494 | \& struct my_biggy big = (struct my_biggy *) |
986 | \& (((char *)w) - offsetof (struct my_biggy, t1)); |
1495 | \& (((char *)w) \- offsetof (struct my_biggy, t1)); |
987 | \& } |
1496 | \& } |
988 | .Ve |
1497 | \& |
989 | .PP |
|
|
990 | .Vb 6 |
|
|
991 | \& static void |
1498 | \& static void |
992 | \& t2_cb (EV_P_ struct ev_timer *w, int revents) |
1499 | \& t2_cb (EV_P_ ev_timer *w, int revents) |
993 | \& { |
1500 | \& { |
994 | \& struct my_biggy big = (struct my_biggy * |
1501 | \& struct my_biggy big = (struct my_biggy *) |
995 | \& (((char *)w) - offsetof (struct my_biggy, t2)); |
1502 | \& (((char *)w) \- offsetof (struct my_biggy, t2)); |
996 | \& } |
1503 | \& } |
997 | .Ve |
1504 | .Ve |
|
|
1505 | .SS "\s-1WATCHER\s0 \s-1STATES\s0" |
|
|
1506 | .IX Subsection "WATCHER STATES" |
|
|
1507 | There are various watcher states mentioned throughout this manual \- |
|
|
1508 | active, pending and so on. In this section these states and the rules to |
|
|
1509 | transition between them will be described in more detail \- and while these |
|
|
1510 | rules might look complicated, they usually do \*(L"the right thing\*(R". |
|
|
1511 | .IP "initialiased" 4 |
|
|
1512 | .IX Item "initialiased" |
|
|
1513 | Before a watcher can be registered with the event looop it has to be |
|
|
1514 | initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to |
|
|
1515 | \&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. |
|
|
1516 | .Sp |
|
|
1517 | In this state it is simply some block of memory that is suitable for use |
|
|
1518 | in an event loop. It can be moved around, freed, reused etc. at will. |
|
|
1519 | .IP "started/running/active" 4 |
|
|
1520 | .IX Item "started/running/active" |
|
|
1521 | Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes |
|
|
1522 | property of the event loop, and is actively waiting for events. While in |
|
|
1523 | this state it cannot be accessed (except in a few documented ways), moved, |
|
|
1524 | freed or anything else \- the only legal thing is to keep a pointer to it, |
|
|
1525 | and call libev functions on it that are documented to work on active watchers. |
|
|
1526 | .IP "pending" 4 |
|
|
1527 | .IX Item "pending" |
|
|
1528 | If a watcher is active and libev determines that an event it is interested |
|
|
1529 | in has occurred (such as a timer expiring), it will become pending. It will |
|
|
1530 | stay in this pending state until either it is stopped or its callback is |
|
|
1531 | about to be invoked, so it is not normally pending inside the watcher |
|
|
1532 | callback. |
|
|
1533 | .Sp |
|
|
1534 | The watcher might or might not be active while it is pending (for example, |
|
|
1535 | an expired non-repeating timer can be pending but no longer active). If it |
|
|
1536 | is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR), |
|
|
1537 | but it is still property of the event loop at this time, so cannot be |
|
|
1538 | moved, freed or reused. And if it is active the rules described in the |
|
|
1539 | previous item still apply. |
|
|
1540 | .Sp |
|
|
1541 | It is also possible to feed an event on a watcher that is not active (e.g. |
|
|
1542 | via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being |
|
|
1543 | active. |
|
|
1544 | .IP "stopped" 4 |
|
|
1545 | .IX Item "stopped" |
|
|
1546 | A watcher can be stopped implicitly by libev (in which case it might still |
|
|
1547 | be pending), or explicitly by calling its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. The |
|
|
1548 | latter will clear any pending state the watcher might be in, regardless |
|
|
1549 | of whether it was active or not, so stopping a watcher explicitly before |
|
|
1550 | freeing it is often a good idea. |
|
|
1551 | .Sp |
|
|
1552 | While stopped (and not pending) the watcher is essentially in the |
|
|
1553 | initialised state, that is it can be reused, moved, modified in any way |
|
|
1554 | you wish. |
|
|
1555 | .SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" |
|
|
1556 | .IX Subsection "WATCHER PRIORITY MODELS" |
|
|
1557 | Many event loops support \fIwatcher priorities\fR, which are usually small |
|
|
1558 | integers that influence the ordering of event callback invocation |
|
|
1559 | between watchers in some way, all else being equal. |
|
|
1560 | .PP |
|
|
1561 | In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its |
|
|
1562 | description for the more technical details such as the actual priority |
|
|
1563 | range. |
|
|
1564 | .PP |
|
|
1565 | There are two common ways how these these priorities are being interpreted |
|
|
1566 | by event loops: |
|
|
1567 | .PP |
|
|
1568 | In the more common lock-out model, higher priorities \*(L"lock out\*(R" invocation |
|
|
1569 | of lower priority watchers, which means as long as higher priority |
|
|
1570 | watchers receive events, lower priority watchers are not being invoked. |
|
|
1571 | .PP |
|
|
1572 | The less common only-for-ordering model uses priorities solely to order |
|
|
1573 | callback invocation within a single event loop iteration: Higher priority |
|
|
1574 | watchers are invoked before lower priority ones, but they all get invoked |
|
|
1575 | before polling for new events. |
|
|
1576 | .PP |
|
|
1577 | Libev uses the second (only-for-ordering) model for all its watchers |
|
|
1578 | except for idle watchers (which use the lock-out model). |
|
|
1579 | .PP |
|
|
1580 | The rationale behind this is that implementing the lock-out model for |
|
|
1581 | watchers is not well supported by most kernel interfaces, and most event |
|
|
1582 | libraries will just poll for the same events again and again as long as |
|
|
1583 | their callbacks have not been executed, which is very inefficient in the |
|
|
1584 | common case of one high-priority watcher locking out a mass of lower |
|
|
1585 | priority ones. |
|
|
1586 | .PP |
|
|
1587 | Static (ordering) priorities are most useful when you have two or more |
|
|
1588 | watchers handling the same resource: a typical usage example is having an |
|
|
1589 | \&\f(CW\*(C`ev_io\*(C'\fR watcher to receive data, and an associated \f(CW\*(C`ev_timer\*(C'\fR to handle |
|
|
1590 | timeouts. Under load, data might be received while the program handles |
|
|
1591 | other jobs, but since timers normally get invoked first, the timeout |
|
|
1592 | handler will be executed before checking for data. In that case, giving |
|
|
1593 | the timer a lower priority than the I/O watcher ensures that I/O will be |
|
|
1594 | handled first even under adverse conditions (which is usually, but not |
|
|
1595 | always, what you want). |
|
|
1596 | .PP |
|
|
1597 | Since idle watchers use the \*(L"lock-out\*(R" model, meaning that idle watchers |
|
|
1598 | will only be executed when no same or higher priority watchers have |
|
|
1599 | received events, they can be used to implement the \*(L"lock-out\*(R" model when |
|
|
1600 | required. |
|
|
1601 | .PP |
|
|
1602 | For example, to emulate how many other event libraries handle priorities, |
|
|
1603 | you can associate an \f(CW\*(C`ev_idle\*(C'\fR watcher to each such watcher, and in |
|
|
1604 | the normal watcher callback, you just start the idle watcher. The real |
|
|
1605 | processing is done in the idle watcher callback. This causes libev to |
|
|
1606 | continuously poll and process kernel event data for the watcher, but when |
|
|
1607 | the lock-out case is known to be rare (which in turn is rare :), this is |
|
|
1608 | workable. |
|
|
1609 | .PP |
|
|
1610 | Usually, however, the lock-out model implemented that way will perform |
|
|
1611 | miserably under the type of load it was designed to handle. In that case, |
|
|
1612 | it might be preferable to stop the real watcher before starting the |
|
|
1613 | idle watcher, so the kernel will not have to process the event in case |
|
|
1614 | the actual processing will be delayed for considerable time. |
|
|
1615 | .PP |
|
|
1616 | Here is an example of an I/O watcher that should run at a strictly lower |
|
|
1617 | priority than the default, and which should only process data when no |
|
|
1618 | other events are pending: |
|
|
1619 | .PP |
|
|
1620 | .Vb 2 |
|
|
1621 | \& ev_idle idle; // actual processing watcher |
|
|
1622 | \& ev_io io; // actual event watcher |
|
|
1623 | \& |
|
|
1624 | \& static void |
|
|
1625 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
1626 | \& { |
|
|
1627 | \& // stop the I/O watcher, we received the event, but |
|
|
1628 | \& // are not yet ready to handle it. |
|
|
1629 | \& ev_io_stop (EV_A_ w); |
|
|
1630 | \& |
|
|
1631 | \& // start the idle watcher to handle the actual event. |
|
|
1632 | \& // it will not be executed as long as other watchers |
|
|
1633 | \& // with the default priority are receiving events. |
|
|
1634 | \& ev_idle_start (EV_A_ &idle); |
|
|
1635 | \& } |
|
|
1636 | \& |
|
|
1637 | \& static void |
|
|
1638 | \& idle_cb (EV_P_ ev_idle *w, int revents) |
|
|
1639 | \& { |
|
|
1640 | \& // actual processing |
|
|
1641 | \& read (STDIN_FILENO, ...); |
|
|
1642 | \& |
|
|
1643 | \& // have to start the I/O watcher again, as |
|
|
1644 | \& // we have handled the event |
|
|
1645 | \& ev_io_start (EV_P_ &io); |
|
|
1646 | \& } |
|
|
1647 | \& |
|
|
1648 | \& // initialisation |
|
|
1649 | \& ev_idle_init (&idle, idle_cb); |
|
|
1650 | \& ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ); |
|
|
1651 | \& ev_io_start (EV_DEFAULT_ &io); |
|
|
1652 | .Ve |
|
|
1653 | .PP |
|
|
1654 | In the \*(L"real\*(R" world, it might also be beneficial to start a timer, so that |
|
|
1655 | low-priority connections can not be locked out forever under load. This |
|
|
1656 | enables your program to keep a lower latency for important connections |
|
|
1657 | during short periods of high load, while not completely locking out less |
|
|
1658 | important ones. |
998 | .SH "WATCHER TYPES" |
1659 | .SH "WATCHER TYPES" |
999 | .IX Header "WATCHER TYPES" |
1660 | .IX Header "WATCHER TYPES" |
1000 | This section describes each watcher in detail, but will not repeat |
1661 | This section describes each watcher in detail, but will not repeat |
1001 | information given in the last section. Any initialisation/set macros, |
1662 | information given in the last section. Any initialisation/set macros, |
1002 | functions and members specific to the watcher type are explained. |
1663 | functions and members specific to the watcher type are explained. |
… | |
… | |
1007 | watcher is stopped to your hearts content), or \fI[read\-write]\fR, which |
1668 | watcher is stopped to your hearts content), or \fI[read\-write]\fR, which |
1008 | means you can expect it to have some sensible content while the watcher |
1669 | means you can expect it to have some sensible content while the watcher |
1009 | is active, but you can also modify it. Modifying it may not do something |
1670 | is active, but you can also modify it. Modifying it may not do something |
1010 | sensible or take immediate effect (or do anything at all), but libev will |
1671 | sensible or take immediate effect (or do anything at all), but libev will |
1011 | not crash or malfunction in any way. |
1672 | not crash or malfunction in any way. |
1012 | .ie n .Sh """ev_io"" \- is this file descriptor readable or writable?" |
1673 | .ie n .SS """ev_io"" \- is this file descriptor readable or writable?" |
1013 | .el .Sh "\f(CWev_io\fP \- is this file descriptor readable or writable?" |
1674 | .el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?" |
1014 | .IX Subsection "ev_io - is this file descriptor readable or writable?" |
1675 | .IX Subsection "ev_io - is this file descriptor readable or writable?" |
1015 | I/O watchers check whether a file descriptor is readable or writable |
1676 | I/O watchers check whether a file descriptor is readable or writable |
1016 | in each iteration of the event loop, or, more precisely, when reading |
1677 | in each iteration of the event loop, or, more precisely, when reading |
1017 | would not block the process and writing would at least be able to write |
1678 | would not block the process and writing would at least be able to write |
1018 | some data. This behaviour is called level-triggering because you keep |
1679 | some data. This behaviour is called level-triggering because you keep |
… | |
… | |
1023 | In general you can register as many read and/or write event watchers per |
1684 | In general you can register as many read and/or write event watchers per |
1024 | fd as you want (as long as you don't confuse yourself). Setting all file |
1685 | fd as you want (as long as you don't confuse yourself). Setting all file |
1025 | descriptors to non-blocking mode is also usually a good idea (but not |
1686 | descriptors to non-blocking mode is also usually a good idea (but not |
1026 | required if you know what you are doing). |
1687 | required if you know what you are doing). |
1027 | .PP |
1688 | .PP |
1028 | You have to be careful with dup'ed file descriptors, though. Some backends |
1689 | If you cannot use non-blocking mode, then force the use of a |
1029 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
1690 | known-to-be-good backend (at the time of this writing, this includes only |
1030 | descriptors correctly if you register interest in two or more fds pointing |
1691 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR). The same applies to file |
1031 | to the same underlying file/socket/etc. description (that is, they share |
1692 | descriptors for which non-blocking operation makes no sense (such as |
1032 | the same underlying \*(L"file open\*(R"). |
1693 | files) \- libev doesn't guarantee any specific behaviour in that case. |
1033 | .PP |
|
|
1034 | If you must do this, then force the use of a known-to-be-good backend |
|
|
1035 | (at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and |
|
|
1036 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). |
|
|
1037 | .PP |
1694 | .PP |
1038 | Another thing you have to watch out for is that it is quite easy to |
1695 | Another thing you have to watch out for is that it is quite easy to |
1039 | receive \*(L"spurious\*(R" readyness notifications, that is your callback might |
1696 | receive \*(L"spurious\*(R" readiness notifications, that is your callback might |
1040 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
1697 | be called with \f(CW\*(C`EV_READ\*(C'\fR but a subsequent \f(CW\*(C`read\*(C'\fR(2) will actually block |
1041 | because there is no data. Not only are some backends known to create a |
1698 | because there is no data. Not only are some backends known to create a |
1042 | lot of those (for example solaris ports), it is very easy to get into |
1699 | lot of those (for example Solaris ports), it is very easy to get into |
1043 | this situation even with a relatively standard program structure. Thus |
1700 | this situation even with a relatively standard program structure. Thus |
1044 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1701 | it is best to always use non-blocking I/O: An extra \f(CW\*(C`read\*(C'\fR(2) returning |
1045 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1702 | \&\f(CW\*(C`EAGAIN\*(C'\fR is far preferable to a program hanging until some data arrives. |
1046 | .PP |
1703 | .PP |
1047 | If you cannot run the fd in non-blocking mode (for example you should not |
1704 | If you cannot run the fd in non-blocking mode (for example you should |
1048 | play around with an Xlib connection), then you have to seperately re-test |
1705 | not play around with an Xlib connection), then you have to separately |
1049 | whether a file descriptor is really ready with a known-to-be good interface |
1706 | re-test whether a file descriptor is really ready with a known-to-be good |
1050 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1707 | interface such as poll (fortunately in our Xlib example, Xlib already |
1051 | its own, so its quite safe to use). |
1708 | does this on its own, so its quite safe to use). Some people additionally |
|
|
1709 | use \f(CW\*(C`SIGALRM\*(C'\fR and an interval timer, just to be sure you won't block |
|
|
1710 | indefinitely. |
|
|
1711 | .PP |
|
|
1712 | But really, best use non-blocking mode. |
|
|
1713 | .PP |
|
|
1714 | \fIThe special problem of disappearing file descriptors\fR |
|
|
1715 | .IX Subsection "The special problem of disappearing file descriptors" |
|
|
1716 | .PP |
|
|
1717 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
|
|
1718 | descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, |
|
|
1719 | such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file |
|
|
1720 | descriptor, but when it goes away, the operating system will silently drop |
|
|
1721 | this interest. If another file descriptor with the same number then is |
|
|
1722 | registered with libev, there is no efficient way to see that this is, in |
|
|
1723 | fact, a different file descriptor. |
|
|
1724 | .PP |
|
|
1725 | To avoid having to explicitly tell libev about such cases, libev follows |
|
|
1726 | the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev |
|
|
1727 | will assume that this is potentially a new file descriptor, otherwise |
|
|
1728 | it is assumed that the file descriptor stays the same. That means that |
|
|
1729 | 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 |
|
|
1730 | descriptor even if the file descriptor number itself did not change. |
|
|
1731 | .PP |
|
|
1732 | This is how one would do it normally anyway, the important point is that |
|
|
1733 | the libev application should not optimise around libev but should leave |
|
|
1734 | optimisations to libev. |
|
|
1735 | .PP |
|
|
1736 | \fIThe special problem of dup'ed file descriptors\fR |
|
|
1737 | .IX Subsection "The special problem of dup'ed file descriptors" |
|
|
1738 | .PP |
|
|
1739 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1740 | but only events for the underlying file descriptions. That means when you |
|
|
1741 | have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register |
|
|
1742 | events for them, only one file descriptor might actually receive events. |
|
|
1743 | .PP |
|
|
1744 | There is no workaround possible except not registering events |
|
|
1745 | for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to |
|
|
1746 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1747 | .PP |
|
|
1748 | \fIThe special problem of fork\fR |
|
|
1749 | .IX Subsection "The special problem of fork" |
|
|
1750 | .PP |
|
|
1751 | Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit |
|
|
1752 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1753 | it in the child. |
|
|
1754 | .PP |
|
|
1755 | To support fork in your programs, you either have to call |
|
|
1756 | \&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, |
|
|
1757 | enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or |
|
|
1758 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1759 | .PP |
|
|
1760 | \fIThe special problem of \s-1SIGPIPE\s0\fR |
|
|
1761 | .IX Subsection "The special problem of SIGPIPE" |
|
|
1762 | .PP |
|
|
1763 | While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: |
|
|
1764 | when writing to a pipe whose other end has been closed, your program gets |
|
|
1765 | sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs |
|
|
1766 | this is sensible behaviour, for daemons, this is usually undesirable. |
|
|
1767 | .PP |
|
|
1768 | So when you encounter spurious, unexplained daemon exits, make sure you |
|
|
1769 | ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon |
|
|
1770 | somewhere, as that would have given you a big clue). |
|
|
1771 | .PP |
|
|
1772 | \fIThe special problem of \fIaccept()\fIing when you can't\fR |
|
|
1773 | .IX Subsection "The special problem of accept()ing when you can't" |
|
|
1774 | .PP |
|
|
1775 | Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, |
|
|
1776 | found in post\-2004 Linux) have the peculiar behaviour of not removing a |
|
|
1777 | connection from the pending queue in all error cases. |
|
|
1778 | .PP |
|
|
1779 | For example, larger servers often run out of file descriptors (because |
|
|
1780 | of resource limits), causing \f(CW\*(C`accept\*(C'\fR to fail with \f(CW\*(C`ENFILE\*(C'\fR but not |
|
|
1781 | rejecting the connection, leading to libev signalling readiness on |
|
|
1782 | the next iteration again (the connection still exists after all), and |
|
|
1783 | typically causing the program to loop at 100% \s-1CPU\s0 usage. |
|
|
1784 | .PP |
|
|
1785 | Unfortunately, the set of errors that cause this issue differs between |
|
|
1786 | operating systems, there is usually little the app can do to remedy the |
|
|
1787 | situation, and no known thread-safe method of removing the connection to |
|
|
1788 | cope with overload is known (to me). |
|
|
1789 | .PP |
|
|
1790 | One of the easiest ways to handle this situation is to just ignore it |
|
|
1791 | \&\- when the program encounters an overload, it will just loop until the |
|
|
1792 | situation is over. While this is a form of busy waiting, no \s-1OS\s0 offers an |
|
|
1793 | event-based way to handle this situation, so it's the best one can do. |
|
|
1794 | .PP |
|
|
1795 | A better way to handle the situation is to log any errors other than |
|
|
1796 | \&\f(CW\*(C`EAGAIN\*(C'\fR and \f(CW\*(C`EWOULDBLOCK\*(C'\fR, making sure not to flood the log with such |
|
|
1797 | messages, and continue as usual, which at least gives the user an idea of |
|
|
1798 | what could be wrong (\*(L"raise the ulimit!\*(R"). For extra points one could stop |
|
|
1799 | the \f(CW\*(C`ev_io\*(C'\fR watcher on the listening fd \*(L"for a while\*(R", which reduces \s-1CPU\s0 |
|
|
1800 | usage. |
|
|
1801 | .PP |
|
|
1802 | If your program is single-threaded, then you could also keep a dummy file |
|
|
1803 | descriptor for overload situations (e.g. by opening \fI/dev/null\fR), and |
|
|
1804 | when you run into \f(CW\*(C`ENFILE\*(C'\fR or \f(CW\*(C`EMFILE\*(C'\fR, close it, run \f(CW\*(C`accept\*(C'\fR, |
|
|
1805 | close that fd, and create a new dummy fd. This will gracefully refuse |
|
|
1806 | clients under typical overload conditions. |
|
|
1807 | .PP |
|
|
1808 | The last way to handle it is to simply log the error and \f(CW\*(C`exit\*(C'\fR, as |
|
|
1809 | is often done with \f(CW\*(C`malloc\*(C'\fR failures, but this results in an easy |
|
|
1810 | opportunity for a DoS attack. |
|
|
1811 | .PP |
|
|
1812 | \fIWatcher-Specific Functions\fR |
|
|
1813 | .IX Subsection "Watcher-Specific Functions" |
1052 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1814 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1053 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1815 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1054 | .PD 0 |
1816 | .PD 0 |
1055 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1817 | .IP "ev_io_set (ev_io *, int fd, int events)" 4 |
1056 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1818 | .IX Item "ev_io_set (ev_io *, int fd, int events)" |
1057 | .PD |
1819 | .PD |
1058 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
1820 | Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to |
1059 | rceeive events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or |
1821 | 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 |
1060 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR to receive the given events. |
1822 | \&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events. |
1061 | .IP "int fd [read\-only]" 4 |
1823 | .IP "int fd [read\-only]" 4 |
1062 | .IX Item "int fd [read-only]" |
1824 | .IX Item "int fd [read-only]" |
1063 | The file descriptor being watched. |
1825 | The file descriptor being watched. |
1064 | .IP "int events [read\-only]" 4 |
1826 | .IP "int events [read\-only]" 4 |
1065 | .IX Item "int events [read-only]" |
1827 | .IX Item "int events [read-only]" |
1066 | The events being watched. |
1828 | The events being watched. |
1067 | .PP |
1829 | .PP |
|
|
1830 | \fIExamples\fR |
|
|
1831 | .IX Subsection "Examples" |
|
|
1832 | .PP |
1068 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1833 | Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well |
1069 | readable, but only once. Since it is likely line\-buffered, you could |
1834 | readable, but only once. Since it is likely line-buffered, you could |
1070 | attempt to read a whole line in the callback. |
1835 | attempt to read a whole line in the callback. |
1071 | .PP |
1836 | .PP |
1072 | .Vb 6 |
1837 | .Vb 6 |
1073 | \& static void |
1838 | \& static void |
1074 | \& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
1839 | \& stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents) |
1075 | \& { |
1840 | \& { |
1076 | \& ev_io_stop (loop, w); |
1841 | \& ev_io_stop (loop, w); |
1077 | \& .. read from stdin here (or from w->fd) and haqndle any I/O errors |
1842 | \& .. read from stdin here (or from w\->fd) and handle any I/O errors |
1078 | \& } |
1843 | \& } |
1079 | .Ve |
1844 | \& |
1080 | .PP |
|
|
1081 | .Vb 6 |
|
|
1082 | \& ... |
1845 | \& ... |
1083 | \& struct ev_loop *loop = ev_default_init (0); |
1846 | \& struct ev_loop *loop = ev_default_init (0); |
1084 | \& struct ev_io stdin_readable; |
1847 | \& ev_io stdin_readable; |
1085 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1848 | \& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
1086 | \& ev_io_start (loop, &stdin_readable); |
1849 | \& ev_io_start (loop, &stdin_readable); |
1087 | \& ev_loop (loop, 0); |
1850 | \& ev_run (loop, 0); |
1088 | .Ve |
1851 | .Ve |
1089 | .ie n .Sh """ev_timer"" \- relative and optionally repeating timeouts" |
1852 | .ie n .SS """ev_timer"" \- relative and optionally repeating timeouts" |
1090 | .el .Sh "\f(CWev_timer\fP \- relative and optionally repeating timeouts" |
1853 | .el .SS "\f(CWev_timer\fP \- relative and optionally repeating timeouts" |
1091 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
1854 | .IX Subsection "ev_timer - relative and optionally repeating timeouts" |
1092 | Timer watchers are simple relative timers that generate an event after a |
1855 | Timer watchers are simple relative timers that generate an event after a |
1093 | given time, and optionally repeating in regular intervals after that. |
1856 | given time, and optionally repeating in regular intervals after that. |
1094 | .PP |
1857 | .PP |
1095 | The timers are based on real time, that is, if you register an event that |
1858 | The timers are based on real time, that is, if you register an event that |
1096 | times out after an hour and you reset your system clock to last years |
1859 | times out after an hour and you reset your system clock to January last |
1097 | time, it will still time out after (roughly) and hour. \*(L"Roughly\*(R" because |
1860 | year, it will still time out after (roughly) one hour. \*(L"Roughly\*(R" because |
1098 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1861 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1099 | monotonic clock option helps a lot here). |
1862 | monotonic clock option helps a lot here). |
|
|
1863 | .PP |
|
|
1864 | The callback is guaranteed to be invoked only \fIafter\fR its timeout has |
|
|
1865 | passed (not \fIat\fR, so on systems with very low-resolution clocks this |
|
|
1866 | might introduce a small delay). If multiple timers become ready during the |
|
|
1867 | same loop iteration then the ones with earlier time-out values are invoked |
|
|
1868 | before ones of the same priority with later time-out values (but this is |
|
|
1869 | no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). |
|
|
1870 | .PP |
|
|
1871 | \fIBe smart about timeouts\fR |
|
|
1872 | .IX Subsection "Be smart about timeouts" |
|
|
1873 | .PP |
|
|
1874 | Many real-world problems involve some kind of timeout, usually for error |
|
|
1875 | recovery. A typical example is an \s-1HTTP\s0 request \- if the other side hangs, |
|
|
1876 | you want to raise some error after a while. |
|
|
1877 | .PP |
|
|
1878 | What follows are some ways to handle this problem, from obvious and |
|
|
1879 | inefficient to smart and efficient. |
|
|
1880 | .PP |
|
|
1881 | In the following, a 60 second activity timeout is assumed \- a timeout that |
|
|
1882 | gets reset to 60 seconds each time there is activity (e.g. each time some |
|
|
1883 | data or other life sign was received). |
|
|
1884 | .IP "1. Use a timer and stop, reinitialise and start it on activity." 4 |
|
|
1885 | .IX Item "1. Use a timer and stop, reinitialise and start it on activity." |
|
|
1886 | This is the most obvious, but not the most simple way: In the beginning, |
|
|
1887 | start the watcher: |
|
|
1888 | .Sp |
|
|
1889 | .Vb 2 |
|
|
1890 | \& ev_timer_init (timer, callback, 60., 0.); |
|
|
1891 | \& ev_timer_start (loop, timer); |
|
|
1892 | .Ve |
|
|
1893 | .Sp |
|
|
1894 | Then, each time there is some activity, \f(CW\*(C`ev_timer_stop\*(C'\fR it, initialise it |
|
|
1895 | and start it again: |
|
|
1896 | .Sp |
|
|
1897 | .Vb 3 |
|
|
1898 | \& ev_timer_stop (loop, timer); |
|
|
1899 | \& ev_timer_set (timer, 60., 0.); |
|
|
1900 | \& ev_timer_start (loop, timer); |
|
|
1901 | .Ve |
|
|
1902 | .Sp |
|
|
1903 | This is relatively simple to implement, but means that each time there is |
|
|
1904 | some activity, libev will first have to remove the timer from its internal |
|
|
1905 | data structure and then add it again. Libev tries to be fast, but it's |
|
|
1906 | still not a constant-time operation. |
|
|
1907 | .ie n .IP "2. Use a timer and re-start it with ""ev_timer_again"" inactivity." 4 |
|
|
1908 | .el .IP "2. Use a timer and re-start it with \f(CWev_timer_again\fR inactivity." 4 |
|
|
1909 | .IX Item "2. Use a timer and re-start it with ev_timer_again inactivity." |
|
|
1910 | This is the easiest way, and involves using \f(CW\*(C`ev_timer_again\*(C'\fR instead of |
|
|
1911 | \&\f(CW\*(C`ev_timer_start\*(C'\fR. |
|
|
1912 | .Sp |
|
|
1913 | To implement this, configure an \f(CW\*(C`ev_timer\*(C'\fR with a \f(CW\*(C`repeat\*(C'\fR value |
|
|
1914 | of \f(CW60\fR and then call \f(CW\*(C`ev_timer_again\*(C'\fR at start and each time you |
|
|
1915 | successfully read or write some data. If you go into an idle state where |
|
|
1916 | you do not expect data to travel on the socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR |
|
|
1917 | the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will automatically restart it if need be. |
|
|
1918 | .Sp |
|
|
1919 | That means you can ignore both the \f(CW\*(C`ev_timer_start\*(C'\fR function and the |
|
|
1920 | \&\f(CW\*(C`after\*(C'\fR argument to \f(CW\*(C`ev_timer_set\*(C'\fR, and only ever use the \f(CW\*(C`repeat\*(C'\fR |
|
|
1921 | member and \f(CW\*(C`ev_timer_again\*(C'\fR. |
|
|
1922 | .Sp |
|
|
1923 | At start: |
|
|
1924 | .Sp |
|
|
1925 | .Vb 3 |
|
|
1926 | \& ev_init (timer, callback); |
|
|
1927 | \& timer\->repeat = 60.; |
|
|
1928 | \& ev_timer_again (loop, timer); |
|
|
1929 | .Ve |
|
|
1930 | .Sp |
|
|
1931 | Each time there is some activity: |
|
|
1932 | .Sp |
|
|
1933 | .Vb 1 |
|
|
1934 | \& ev_timer_again (loop, timer); |
|
|
1935 | .Ve |
|
|
1936 | .Sp |
|
|
1937 | It is even possible to change the time-out on the fly, regardless of |
|
|
1938 | whether the watcher is active or not: |
|
|
1939 | .Sp |
|
|
1940 | .Vb 2 |
|
|
1941 | \& timer\->repeat = 30.; |
|
|
1942 | \& ev_timer_again (loop, timer); |
|
|
1943 | .Ve |
|
|
1944 | .Sp |
|
|
1945 | This is slightly more efficient then stopping/starting the timer each time |
|
|
1946 | you want to modify its timeout value, as libev does not have to completely |
|
|
1947 | remove and re-insert the timer from/into its internal data structure. |
|
|
1948 | .Sp |
|
|
1949 | It is, however, even simpler than the \*(L"obvious\*(R" way to do it. |
|
|
1950 | .IP "3. Let the timer time out, but then re-arm it as required." 4 |
|
|
1951 | .IX Item "3. Let the timer time out, but then re-arm it as required." |
|
|
1952 | This method is more tricky, but usually most efficient: Most timeouts are |
|
|
1953 | relatively long compared to the intervals between other activity \- in |
|
|
1954 | our example, within 60 seconds, there are usually many I/O events with |
|
|
1955 | associated activity resets. |
|
|
1956 | .Sp |
|
|
1957 | In this case, it would be more efficient to leave the \f(CW\*(C`ev_timer\*(C'\fR alone, |
|
|
1958 | but remember the time of last activity, and check for a real timeout only |
|
|
1959 | within the callback: |
|
|
1960 | .Sp |
|
|
1961 | .Vb 1 |
|
|
1962 | \& ev_tstamp last_activity; // time of last activity |
|
|
1963 | \& |
|
|
1964 | \& static void |
|
|
1965 | \& callback (EV_P_ ev_timer *w, int revents) |
|
|
1966 | \& { |
|
|
1967 | \& ev_tstamp now = ev_now (EV_A); |
|
|
1968 | \& ev_tstamp timeout = last_activity + 60.; |
|
|
1969 | \& |
|
|
1970 | \& // if last_activity + 60. is older than now, we did time out |
|
|
1971 | \& if (timeout < now) |
|
|
1972 | \& { |
|
|
1973 | \& // timeout occurred, take action |
|
|
1974 | \& } |
|
|
1975 | \& else |
|
|
1976 | \& { |
|
|
1977 | \& // callback was invoked, but there was some activity, re\-arm |
|
|
1978 | \& // the watcher to fire in last_activity + 60, which is |
|
|
1979 | \& // guaranteed to be in the future, so "again" is positive: |
|
|
1980 | \& w\->repeat = timeout \- now; |
|
|
1981 | \& ev_timer_again (EV_A_ w); |
|
|
1982 | \& } |
|
|
1983 | \& } |
|
|
1984 | .Ve |
|
|
1985 | .Sp |
|
|
1986 | To summarise the callback: first calculate the real timeout (defined |
|
|
1987 | as \*(L"60 seconds after the last activity\*(R"), then check if that time has |
|
|
1988 | been reached, which means something \fIdid\fR, in fact, time out. Otherwise |
|
|
1989 | the callback was invoked too early (\f(CW\*(C`timeout\*(C'\fR is in the future), so |
|
|
1990 | re-schedule the timer to fire at that future time, to see if maybe we have |
|
|
1991 | a timeout then. |
|
|
1992 | .Sp |
|
|
1993 | Note how \f(CW\*(C`ev_timer_again\*(C'\fR is used, taking advantage of the |
|
|
1994 | \&\f(CW\*(C`ev_timer_again\*(C'\fR optimisation when the timer is already running. |
|
|
1995 | .Sp |
|
|
1996 | This scheme causes more callback invocations (about one every 60 seconds |
|
|
1997 | minus half the average time between activity), but virtually no calls to |
|
|
1998 | libev to change the timeout. |
|
|
1999 | .Sp |
|
|
2000 | To start the timer, simply initialise the watcher and set \f(CW\*(C`last_activity\*(C'\fR |
|
|
2001 | to the current time (meaning we just have some activity :), then call the |
|
|
2002 | callback, which will \*(L"do the right thing\*(R" and start the timer: |
|
|
2003 | .Sp |
|
|
2004 | .Vb 3 |
|
|
2005 | \& ev_init (timer, callback); |
|
|
2006 | \& last_activity = ev_now (loop); |
|
|
2007 | \& callback (loop, timer, EV_TIMER); |
|
|
2008 | .Ve |
|
|
2009 | .Sp |
|
|
2010 | And when there is some activity, simply store the current time in |
|
|
2011 | \&\f(CW\*(C`last_activity\*(C'\fR, no libev calls at all: |
|
|
2012 | .Sp |
|
|
2013 | .Vb 1 |
|
|
2014 | \& last_activity = ev_now (loop); |
|
|
2015 | .Ve |
|
|
2016 | .Sp |
|
|
2017 | This technique is slightly more complex, but in most cases where the |
|
|
2018 | time-out is unlikely to be triggered, much more efficient. |
|
|
2019 | .Sp |
|
|
2020 | Changing the timeout is trivial as well (if it isn't hard-coded in the |
|
|
2021 | callback :) \- just change the timeout and invoke the callback, which will |
|
|
2022 | fix things for you. |
|
|
2023 | .IP "4. Wee, just use a double-linked list for your timeouts." 4 |
|
|
2024 | .IX Item "4. Wee, just use a double-linked list for your timeouts." |
|
|
2025 | If there is not one request, but many thousands (millions...), all |
|
|
2026 | employing some kind of timeout with the same timeout value, then one can |
|
|
2027 | do even better: |
|
|
2028 | .Sp |
|
|
2029 | When starting the timeout, calculate the timeout value and put the timeout |
|
|
2030 | at the \fIend\fR of the list. |
|
|
2031 | .Sp |
|
|
2032 | Then use an \f(CW\*(C`ev_timer\*(C'\fR to fire when the timeout at the \fIbeginning\fR of |
|
|
2033 | the list is expected to fire (for example, using the technique #3). |
|
|
2034 | .Sp |
|
|
2035 | When there is some activity, remove the timer from the list, recalculate |
|
|
2036 | the timeout, append it to the end of the list again, and make sure to |
|
|
2037 | update the \f(CW\*(C`ev_timer\*(C'\fR if it was taken from the beginning of the list. |
|
|
2038 | .Sp |
|
|
2039 | This way, one can manage an unlimited number of timeouts in O(1) time for |
|
|
2040 | starting, stopping and updating the timers, at the expense of a major |
|
|
2041 | complication, and having to use a constant timeout. The constant timeout |
|
|
2042 | ensures that the list stays sorted. |
|
|
2043 | .PP |
|
|
2044 | So which method the best? |
|
|
2045 | .PP |
|
|
2046 | Method #2 is a simple no-brain-required solution that is adequate in most |
|
|
2047 | situations. Method #3 requires a bit more thinking, but handles many cases |
|
|
2048 | better, and isn't very complicated either. In most case, choosing either |
|
|
2049 | one is fine, with #3 being better in typical situations. |
|
|
2050 | .PP |
|
|
2051 | Method #1 is almost always a bad idea, and buys you nothing. Method #4 is |
|
|
2052 | rather complicated, but extremely efficient, something that really pays |
|
|
2053 | off after the first million or so of active timers, i.e. it's usually |
|
|
2054 | overkill :) |
|
|
2055 | .PP |
|
|
2056 | \fIThe special problem of time updates\fR |
|
|
2057 | .IX Subsection "The special problem of time updates" |
|
|
2058 | .PP |
|
|
2059 | Establishing the current time is a costly operation (it usually takes at |
|
|
2060 | least two system calls): \s-1EV\s0 therefore updates its idea of the current |
|
|
2061 | time only before and after \f(CW\*(C`ev_run\*(C'\fR collects new events, which causes a |
|
|
2062 | growing difference between \f(CW\*(C`ev_now ()\*(C'\fR and \f(CW\*(C`ev_time ()\*(C'\fR when handling |
|
|
2063 | lots of events in one iteration. |
1100 | .PP |
2064 | .PP |
1101 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
2065 | The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR |
1102 | time. This is usually the right thing as this timestamp refers to the time |
2066 | time. This is usually the right thing as this timestamp refers to the time |
1103 | of the event triggering whatever timeout you are modifying/starting. If |
2067 | of the event triggering whatever timeout you are modifying/starting. If |
1104 | you suspect event processing to be delayed and you \fIneed\fR to base the timeout |
2068 | you suspect event processing to be delayed and you \fIneed\fR to base the |
1105 | on the current time, use something like this to adjust for this: |
2069 | timeout on the current time, use something like this to adjust for this: |
1106 | .PP |
2070 | .PP |
1107 | .Vb 1 |
2071 | .Vb 1 |
1108 | \& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
2072 | \& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); |
1109 | .Ve |
2073 | .Ve |
1110 | .PP |
2074 | .PP |
1111 | The callback is guarenteed to be invoked only when its timeout has passed, |
2075 | If the event loop is suspended for a long time, you can also force an |
1112 | but if multiple timers become ready during the same loop iteration then |
2076 | update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update |
1113 | order of execution is undefined. |
2077 | ()\*(C'\fR. |
|
|
2078 | .PP |
|
|
2079 | \fIThe special problems of suspended animation\fR |
|
|
2080 | .IX Subsection "The special problems of suspended animation" |
|
|
2081 | .PP |
|
|
2082 | When you leave the server world it is quite customary to hit machines that |
|
|
2083 | can suspend/hibernate \- what happens to the clocks during such a suspend? |
|
|
2084 | .PP |
|
|
2085 | Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes |
|
|
2086 | all processes, while the clocks (\f(CW\*(C`times\*(C'\fR, \f(CW\*(C`CLOCK_MONOTONIC\*(C'\fR) continue |
|
|
2087 | to run until the system is suspended, but they will not advance while the |
|
|
2088 | system is suspended. That means, on resume, it will be as if the program |
|
|
2089 | was frozen for a few seconds, but the suspend time will not be counted |
|
|
2090 | towards \f(CW\*(C`ev_timer\*(C'\fR when a monotonic clock source is used. The real time |
|
|
2091 | clock advanced as expected, but if it is used as sole clocksource, then a |
|
|
2092 | long suspend would be detected as a time jump by libev, and timers would |
|
|
2093 | be adjusted accordingly. |
|
|
2094 | .PP |
|
|
2095 | I would not be surprised to see different behaviour in different between |
|
|
2096 | operating systems, \s-1OS\s0 versions or even different hardware. |
|
|
2097 | .PP |
|
|
2098 | The other form of suspend (job control, or sending a \s-1SIGSTOP\s0) will see a |
|
|
2099 | time jump in the monotonic clocks and the realtime clock. If the program |
|
|
2100 | is suspended for a very long time, and monotonic clock sources are in use, |
|
|
2101 | then you can expect \f(CW\*(C`ev_timer\*(C'\fRs to expire as the full suspension time |
|
|
2102 | will be counted towards the timers. When no monotonic clock source is in |
|
|
2103 | use, then libev will again assume a timejump and adjust accordingly. |
|
|
2104 | .PP |
|
|
2105 | It might be beneficial for this latter case to call \f(CW\*(C`ev_suspend\*(C'\fR |
|
|
2106 | and \f(CW\*(C`ev_resume\*(C'\fR in code that handles \f(CW\*(C`SIGTSTP\*(C'\fR, to at least get |
|
|
2107 | deterministic behaviour in this case (you can do nothing against |
|
|
2108 | \&\f(CW\*(C`SIGSTOP\*(C'\fR). |
|
|
2109 | .PP |
|
|
2110 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2111 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1114 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
2112 | .IP "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 4 |
1115 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
2113 | .IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" |
1116 | .PD 0 |
2114 | .PD 0 |
1117 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
2115 | .IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 |
1118 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
2116 | .IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" |
1119 | .PD |
2117 | .PD |
1120 | Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR is |
2118 | Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR |
1121 | \&\f(CW0.\fR, then it will automatically be stopped. If it is positive, then the |
2119 | is \f(CW0.\fR, then it will automatically be stopped once the timeout is |
1122 | timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds |
2120 | reached. If it is positive, then the timer will automatically be |
1123 | later, again, and again, until stopped manually. |
2121 | configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, |
|
|
2122 | until stopped manually. |
1124 | .Sp |
2123 | .Sp |
1125 | The timer itself will do a best-effort at avoiding drift, that is, if you |
2124 | The timer itself will do a best-effort at avoiding drift, that is, if |
1126 | configure a timer to trigger every 10 seconds, then it will trigger at |
2125 | you configure a timer to trigger every 10 seconds, then it will normally |
1127 | exactly 10 second intervals. If, however, your program cannot keep up with |
2126 | trigger at exactly 10 second intervals. If, however, your program cannot |
1128 | the timer (because it takes longer than those 10 seconds to do stuff) the |
2127 | keep up with the timer (because it takes longer than those 10 seconds to |
1129 | timer will not fire more than once per event loop iteration. |
2128 | do stuff) the timer will not fire more than once per event loop iteration. |
1130 | .IP "ev_timer_again (loop)" 4 |
2129 | .IP "ev_timer_again (loop, ev_timer *)" 4 |
1131 | .IX Item "ev_timer_again (loop)" |
2130 | .IX Item "ev_timer_again (loop, ev_timer *)" |
1132 | This will act as if the timer timed out and restart it again if it is |
2131 | This will act as if the timer timed out and restart it again if it is |
1133 | repeating. The exact semantics are: |
2132 | repeating. The exact semantics are: |
1134 | .Sp |
2133 | .Sp |
1135 | If the timer is pending, its pending status is cleared. |
2134 | If the timer is pending, its pending status is cleared. |
1136 | .Sp |
2135 | .Sp |
1137 | If the timer is started but nonrepeating, stop it (as if it timed out). |
2136 | If the timer is started but non-repeating, stop it (as if it timed out). |
1138 | .Sp |
2137 | .Sp |
1139 | If the timer is repeating, either start it if necessary (with the |
2138 | If the timer is repeating, either start it if necessary (with the |
1140 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
2139 | \&\f(CW\*(C`repeat\*(C'\fR value), or reset the running timer to the \f(CW\*(C`repeat\*(C'\fR value. |
1141 | .Sp |
2140 | .Sp |
1142 | This sounds a bit complicated, but here is a useful and typical |
2141 | This sounds a bit complicated, see \*(L"Be smart about timeouts\*(R", above, for a |
1143 | example: Imagine you have a tcp connection and you want a so-called idle |
2142 | usage example. |
1144 | timeout, that is, you want to be called when there have been, say, 60 |
2143 | .IP "ev_tstamp ev_timer_remaining (loop, ev_timer *)" 4 |
1145 | seconds of inactivity on the socket. The easiest way to do this is to |
2144 | .IX Item "ev_tstamp ev_timer_remaining (loop, ev_timer *)" |
1146 | 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 |
2145 | Returns the remaining time until a timer fires. If the timer is active, |
1147 | \&\f(CW\*(C`ev_timer_again\*(C'\fR each time you successfully read or write some data. If |
2146 | then this time is relative to the current event loop time, otherwise it's |
1148 | you go into an idle state where you do not expect data to travel on the |
2147 | the timeout value currently configured. |
1149 | socket, you can \f(CW\*(C`ev_timer_stop\*(C'\fR the timer, and \f(CW\*(C`ev_timer_again\*(C'\fR will |
|
|
1150 | automatically restart it if need be. |
|
|
1151 | .Sp |
2148 | .Sp |
1152 | That means you can ignore the \f(CW\*(C`after\*(C'\fR value and \f(CW\*(C`ev_timer_start\*(C'\fR |
2149 | That is, after an \f(CW\*(C`ev_timer_set (w, 5, 7)\*(C'\fR, \f(CW\*(C`ev_timer_remaining\*(C'\fR returns |
1153 | altogether and only ever use the \f(CW\*(C`repeat\*(C'\fR value and \f(CW\*(C`ev_timer_again\*(C'\fR: |
2150 | \&\f(CW5\fR. When the timer is started and one second passes, \f(CW\*(C`ev_timer_remaining\*(C'\fR |
1154 | .Sp |
2151 | will return \f(CW4\fR. When the timer expires and is restarted, it will return |
1155 | .Vb 8 |
2152 | roughly \f(CW7\fR (likely slightly less as callback invocation takes some time, |
1156 | \& ev_timer_init (timer, callback, 0., 5.); |
2153 | too), and so on. |
1157 | \& ev_timer_again (loop, timer); |
|
|
1158 | \& ... |
|
|
1159 | \& timer->again = 17.; |
|
|
1160 | \& ev_timer_again (loop, timer); |
|
|
1161 | \& ... |
|
|
1162 | \& timer->again = 10.; |
|
|
1163 | \& ev_timer_again (loop, timer); |
|
|
1164 | .Ve |
|
|
1165 | .Sp |
|
|
1166 | This is more slightly efficient then stopping/starting the timer each time |
|
|
1167 | you want to modify its timeout value. |
|
|
1168 | .IP "ev_tstamp repeat [read\-write]" 4 |
2154 | .IP "ev_tstamp repeat [read\-write]" 4 |
1169 | .IX Item "ev_tstamp repeat [read-write]" |
2155 | .IX Item "ev_tstamp repeat [read-write]" |
1170 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
2156 | The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out |
1171 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), |
2157 | or \f(CW\*(C`ev_timer_again\*(C'\fR is called, and determines the next timeout (if any), |
1172 | which is also when any modifications are taken into account. |
2158 | which is also when any modifications are taken into account. |
1173 | .PP |
2159 | .PP |
|
|
2160 | \fIExamples\fR |
|
|
2161 | .IX Subsection "Examples" |
|
|
2162 | .PP |
1174 | Example: Create a timer that fires after 60 seconds. |
2163 | Example: Create a timer that fires after 60 seconds. |
1175 | .PP |
2164 | .PP |
1176 | .Vb 5 |
2165 | .Vb 5 |
1177 | \& static void |
2166 | \& static void |
1178 | \& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
2167 | \& one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents) |
1179 | \& { |
2168 | \& { |
1180 | \& .. one minute over, w is actually stopped right here |
2169 | \& .. one minute over, w is actually stopped right here |
1181 | \& } |
2170 | \& } |
1182 | .Ve |
2171 | \& |
1183 | .PP |
|
|
1184 | .Vb 3 |
|
|
1185 | \& struct ev_timer mytimer; |
2172 | \& ev_timer mytimer; |
1186 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
2173 | \& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); |
1187 | \& ev_timer_start (loop, &mytimer); |
2174 | \& ev_timer_start (loop, &mytimer); |
1188 | .Ve |
2175 | .Ve |
1189 | .PP |
2176 | .PP |
1190 | Example: Create a timeout timer that times out after 10 seconds of |
2177 | Example: Create a timeout timer that times out after 10 seconds of |
1191 | inactivity. |
2178 | inactivity. |
1192 | .PP |
2179 | .PP |
1193 | .Vb 5 |
2180 | .Vb 5 |
1194 | \& static void |
2181 | \& static void |
1195 | \& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
2182 | \& timeout_cb (struct ev_loop *loop, ev_timer *w, int revents) |
1196 | \& { |
2183 | \& { |
1197 | \& .. ten seconds without any activity |
2184 | \& .. ten seconds without any activity |
1198 | \& } |
2185 | \& } |
1199 | .Ve |
2186 | \& |
1200 | .PP |
|
|
1201 | .Vb 4 |
|
|
1202 | \& struct ev_timer mytimer; |
2187 | \& ev_timer mytimer; |
1203 | \& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
2188 | \& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ |
1204 | \& ev_timer_again (&mytimer); /* start timer */ |
2189 | \& ev_timer_again (&mytimer); /* start timer */ |
1205 | \& ev_loop (loop, 0); |
2190 | \& ev_run (loop, 0); |
1206 | .Ve |
2191 | \& |
1207 | .PP |
|
|
1208 | .Vb 3 |
|
|
1209 | \& // and in some piece of code that gets executed on any "activity": |
2192 | \& // and in some piece of code that gets executed on any "activity": |
1210 | \& // reset the timeout to start ticking again at 10 seconds |
2193 | \& // reset the timeout to start ticking again at 10 seconds |
1211 | \& ev_timer_again (&mytimer); |
2194 | \& ev_timer_again (&mytimer); |
1212 | .Ve |
2195 | .Ve |
1213 | .ie n .Sh """ev_periodic"" \- to cron or not to cron?" |
2196 | .ie n .SS """ev_periodic"" \- to cron or not to cron?" |
1214 | .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron?" |
2197 | .el .SS "\f(CWev_periodic\fP \- to cron or not to cron?" |
1215 | .IX Subsection "ev_periodic - to cron or not to cron?" |
2198 | .IX Subsection "ev_periodic - to cron or not to cron?" |
1216 | Periodic watchers are also timers of a kind, but they are very versatile |
2199 | Periodic watchers are also timers of a kind, but they are very versatile |
1217 | (and unfortunately a bit complex). |
2200 | (and unfortunately a bit complex). |
1218 | .PP |
2201 | .PP |
1219 | Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time) |
2202 | Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or |
1220 | but on wallclock time (absolute time). You can tell a periodic watcher |
2203 | relative time, the physical time that passes) but on wall clock time |
1221 | to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a |
2204 | (absolute time, the thing you can read on your calender or clock). The |
1222 | periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now () |
2205 | difference is that wall clock time can run faster or slower than real |
1223 | + 10.\*(C'\fR) and then reset your system clock to the last year, then it will |
2206 | time, and time jumps are not uncommon (e.g. when you adjust your |
1224 | take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger |
2207 | wrist-watch). |
1225 | roughly 10 seconds later and of course not if you reset your system time |
|
|
1226 | again). |
|
|
1227 | .PP |
2208 | .PP |
1228 | They can also be used to implement vastly more complex timers, such as |
2209 | You can tell a periodic watcher to trigger after some specific point |
1229 | triggering an event on eahc midnight, local time. |
2210 | in time: for example, if you tell a periodic watcher to trigger \*(L"in 10 |
|
|
2211 | seconds\*(R" (by specifying e.g. \f(CW\*(C`ev_now () + 10.\*(C'\fR, that is, an absolute time |
|
|
2212 | not a delay) and then reset your system clock to January of the previous |
|
|
2213 | year, then it will take a year or more to trigger the event (unlike an |
|
|
2214 | \&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting |
|
|
2215 | it, as it uses a relative timeout). |
1230 | .PP |
2216 | .PP |
|
|
2217 | \&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex |
|
|
2218 | timers, such as triggering an event on each \*(L"midnight, local time\*(R", or |
|
|
2219 | other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as |
|
|
2220 | those cannot react to time jumps. |
|
|
2221 | .PP |
1231 | As with timers, the callback is guarenteed to be invoked only when the |
2222 | As with timers, the callback is guaranteed to be invoked only when the |
1232 | time (\f(CW\*(C`at\*(C'\fR) has been passed, but if multiple periodic timers become ready |
2223 | point in time where it is supposed to trigger has passed. If multiple |
1233 | during the same loop iteration then order of execution is undefined. |
2224 | timers become ready during the same loop iteration then the ones with |
|
|
2225 | earlier time-out values are invoked before ones with later time-out values |
|
|
2226 | (but this is no longer true when a callback calls \f(CW\*(C`ev_run\*(C'\fR recursively). |
|
|
2227 | .PP |
|
|
2228 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2229 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1234 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" 4 |
2230 | .IP "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4 |
1235 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)" |
2231 | .IX Item "ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" |
1236 | .PD 0 |
2232 | .PD 0 |
1237 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 4 |
2233 | .IP "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" 4 |
1238 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" |
2234 | .IX Item "ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)" |
1239 | .PD |
2235 | .PD |
1240 | Lots of arguments, lets sort it out... There are basically three modes of |
2236 | Lots of arguments, let's sort it out... There are basically three modes of |
1241 | operation, and we will explain them from simplest to complex: |
2237 | operation, and we will explain them from simplest to most complex: |
1242 | .RS 4 |
2238 | .RS 4 |
1243 | .IP "* absolute timer (interval = reschedule_cb = 0)" 4 |
2239 | .IP "\(bu" 4 |
1244 | .IX Item "absolute timer (interval = reschedule_cb = 0)" |
2240 | absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0) |
|
|
2241 | .Sp |
1245 | In this configuration the watcher triggers an event at the wallclock time |
2242 | In this configuration the watcher triggers an event after the wall clock |
1246 | \&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, |
2243 | time \f(CW\*(C`offset\*(C'\fR has passed. It will not repeat and will not adjust when a |
1247 | that is, if it is to be run at January 1st 2011 then it will run when the |
2244 | time jump occurs, that is, if it is to be run at January 1st 2011 then it |
1248 | system time reaches or surpasses this time. |
2245 | will be stopped and invoked when the system clock reaches or surpasses |
1249 | .IP "* non-repeating interval timer (interval > 0, reschedule_cb = 0)" 4 |
2246 | this point in time. |
1250 | .IX Item "non-repeating interval timer (interval > 0, reschedule_cb = 0)" |
2247 | .IP "\(bu" 4 |
|
|
2248 | repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0) |
|
|
2249 | .Sp |
1251 | In this mode the watcher will always be scheduled to time out at the next |
2250 | In this mode the watcher will always be scheduled to time out at the next |
1252 | \&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N) and then repeat, regardless |
2251 | \&\f(CW\*(C`offset + N * interval\*(C'\fR time (for some integer N, which can also be |
1253 | of any time jumps. |
2252 | negative) and then repeat, regardless of any time jumps. The \f(CW\*(C`offset\*(C'\fR |
|
|
2253 | argument is merely an offset into the \f(CW\*(C`interval\*(C'\fR periods. |
1254 | .Sp |
2254 | .Sp |
1255 | This can be used to create timers that do not drift with respect to system |
2255 | This can be used to create timers that do not drift with respect to the |
1256 | time: |
2256 | system clock, for example, here is an \f(CW\*(C`ev_periodic\*(C'\fR that triggers each |
|
|
2257 | hour, on the hour (with respect to \s-1UTC\s0): |
1257 | .Sp |
2258 | .Sp |
1258 | .Vb 1 |
2259 | .Vb 1 |
1259 | \& ev_periodic_set (&periodic, 0., 3600., 0); |
2260 | \& ev_periodic_set (&periodic, 0., 3600., 0); |
1260 | .Ve |
2261 | .Ve |
1261 | .Sp |
2262 | .Sp |
1262 | This doesn't mean there will always be 3600 seconds in between triggers, |
2263 | This doesn't mean there will always be 3600 seconds in between triggers, |
1263 | but only that the the callback will be called when the system time shows a |
2264 | but only that the callback will be called when the system time shows a |
1264 | full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible |
2265 | full hour (\s-1UTC\s0), or more correctly, when the system time is evenly divisible |
1265 | by 3600. |
2266 | by 3600. |
1266 | .Sp |
2267 | .Sp |
1267 | Another way to think about it (for the mathematically inclined) is that |
2268 | Another way to think about it (for the mathematically inclined) is that |
1268 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
2269 | \&\f(CW\*(C`ev_periodic\*(C'\fR will try to run the callback in this mode at the next possible |
1269 | time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. |
2270 | time where \f(CW\*(C`time = offset (mod interval)\*(C'\fR, regardless of any time jumps. |
1270 | .IP "* manual reschedule mode (reschedule_cb = callback)" 4 |
2271 | .Sp |
1271 | .IX Item "manual reschedule mode (reschedule_cb = callback)" |
2272 | For numerical stability it is preferable that the \f(CW\*(C`offset\*(C'\fR value is near |
|
|
2273 | \&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for |
|
|
2274 | this value, and in fact is often specified as zero. |
|
|
2275 | .Sp |
|
|
2276 | Note also that there is an upper limit to how often a timer can fire (\s-1CPU\s0 |
|
|
2277 | speed for example), so if \f(CW\*(C`interval\*(C'\fR is very small then timing stability |
|
|
2278 | will of course deteriorate. Libev itself tries to be exact to be about one |
|
|
2279 | millisecond (if the \s-1OS\s0 supports it and the machine is fast enough). |
|
|
2280 | .IP "\(bu" 4 |
|
|
2281 | manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback) |
|
|
2282 | .Sp |
1272 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being |
2283 | In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being |
1273 | ignored. Instead, each time the periodic watcher gets scheduled, the |
2284 | ignored. Instead, each time the periodic watcher gets scheduled, the |
1274 | reschedule callback will be called with the watcher as first, and the |
2285 | reschedule callback will be called with the watcher as first, and the |
1275 | current time as second argument. |
2286 | current time as second argument. |
1276 | .Sp |
2287 | .Sp |
1277 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, |
2288 | \&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, |
1278 | ever, or make any event loop modifications\fR. If you need to stop it, |
2289 | or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly |
1279 | return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop it afterwards (e.g. by |
2290 | allowed by documentation here\fR. |
1280 | starting a prepare watcher). |
|
|
1281 | .Sp |
2291 | .Sp |
|
|
2292 | If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop |
|
|
2293 | it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the |
|
|
2294 | only event loop modification you are allowed to do). |
|
|
2295 | .Sp |
1282 | Its prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
2296 | The callback prototype is \f(CW\*(C`ev_tstamp (*reschedule_cb)(ev_periodic |
1283 | ev_tstamp now)\*(C'\fR, e.g.: |
2297 | *w, ev_tstamp now)\*(C'\fR, e.g.: |
1284 | .Sp |
2298 | .Sp |
1285 | .Vb 4 |
2299 | .Vb 5 |
|
|
2300 | \& static ev_tstamp |
1286 | \& static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
2301 | \& my_rescheduler (ev_periodic *w, ev_tstamp now) |
1287 | \& { |
2302 | \& { |
1288 | \& return now + 60.; |
2303 | \& return now + 60.; |
1289 | \& } |
2304 | \& } |
1290 | .Ve |
2305 | .Ve |
1291 | .Sp |
2306 | .Sp |
1292 | It must return the next time to trigger, based on the passed time value |
2307 | It must return the next time to trigger, based on the passed time value |
1293 | (that is, the lowest time value larger than to the second argument). It |
2308 | (that is, the lowest time value larger than to the second argument). It |
1294 | will usually be called just before the callback will be triggered, but |
2309 | will usually be called just before the callback will be triggered, but |
1295 | might be called at other times, too. |
2310 | might be called at other times, too. |
1296 | .Sp |
2311 | .Sp |
1297 | \&\s-1NOTE:\s0 \fIThis callback must always return a time that is later than the |
2312 | \&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or |
1298 | 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. |
2313 | equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. |
1299 | .Sp |
2314 | .Sp |
1300 | This can be used to create very complex timers, such as a timer that |
2315 | This can be used to create very complex timers, such as a timer that |
1301 | triggers on each midnight, local time. To do this, you would calculate the |
2316 | triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the |
1302 | next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How |
2317 | next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How |
1303 | you do this is, again, up to you (but it is not trivial, which is the main |
2318 | you do this is, again, up to you (but it is not trivial, which is the main |
1304 | reason I omitted it as an example). |
2319 | reason I omitted it as an example). |
1305 | .RE |
2320 | .RE |
1306 | .RS 4 |
2321 | .RS 4 |
… | |
… | |
1309 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
2324 | .IX Item "ev_periodic_again (loop, ev_periodic *)" |
1310 | Simply stops and restarts the periodic watcher again. This is only useful |
2325 | Simply stops and restarts the periodic watcher again. This is only useful |
1311 | when you changed some parameters or the reschedule callback would return |
2326 | when you changed some parameters or the reschedule callback would return |
1312 | a different time than the last time it was called (e.g. in a crond like |
2327 | a different time than the last time it was called (e.g. in a crond like |
1313 | program when the crontabs have changed). |
2328 | program when the crontabs have changed). |
|
|
2329 | .IP "ev_tstamp ev_periodic_at (ev_periodic *)" 4 |
|
|
2330 | .IX Item "ev_tstamp ev_periodic_at (ev_periodic *)" |
|
|
2331 | When active, returns the absolute time that the watcher is supposed |
|
|
2332 | to trigger next. This is not the same as the \f(CW\*(C`offset\*(C'\fR argument to |
|
|
2333 | \&\f(CW\*(C`ev_periodic_set\*(C'\fR, but indeed works even in interval and manual |
|
|
2334 | rescheduling modes. |
|
|
2335 | .IP "ev_tstamp offset [read\-write]" 4 |
|
|
2336 | .IX Item "ev_tstamp offset [read-write]" |
|
|
2337 | When repeating, this contains the offset value, otherwise this is the |
|
|
2338 | absolute point in time (the \f(CW\*(C`offset\*(C'\fR value passed to \f(CW\*(C`ev_periodic_set\*(C'\fR, |
|
|
2339 | although libev might modify this value for better numerical stability). |
|
|
2340 | .Sp |
|
|
2341 | Can be modified any time, but changes only take effect when the periodic |
|
|
2342 | timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1314 | .IP "ev_tstamp interval [read\-write]" 4 |
2343 | .IP "ev_tstamp interval [read\-write]" 4 |
1315 | .IX Item "ev_tstamp interval [read-write]" |
2344 | .IX Item "ev_tstamp interval [read-write]" |
1316 | The current interval value. Can be modified any time, but changes only |
2345 | The current interval value. Can be modified any time, but changes only |
1317 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
2346 | take effect when the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being |
1318 | called. |
2347 | called. |
1319 | .IP "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
2348 | .IP "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read\-write]" 4 |
1320 | .IX Item "ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]" |
2349 | .IX Item "ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]" |
1321 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
2350 | The current reschedule callback, or \f(CW0\fR, if this functionality is |
1322 | switched off. Can be changed any time, but changes only take effect when |
2351 | switched off. Can be changed any time, but changes only take effect when |
1323 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
2352 | the periodic timer fires or \f(CW\*(C`ev_periodic_again\*(C'\fR is being called. |
1324 | .PP |
2353 | .PP |
|
|
2354 | \fIExamples\fR |
|
|
2355 | .IX Subsection "Examples" |
|
|
2356 | .PP |
1325 | Example: Call a callback every hour, or, more precisely, whenever the |
2357 | Example: Call a callback every hour, or, more precisely, whenever the |
1326 | system clock is divisible by 3600. The callback invocation times have |
2358 | system time is divisible by 3600. The callback invocation times have |
1327 | potentially a lot of jittering, but good long-term stability. |
2359 | potentially a lot of jitter, but good long-term stability. |
1328 | .PP |
2360 | .PP |
1329 | .Vb 5 |
2361 | .Vb 5 |
1330 | \& static void |
2362 | \& static void |
1331 | \& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) |
2363 | \& clock_cb (struct ev_loop *loop, ev_periodic *w, int revents) |
1332 | \& { |
2364 | \& { |
1333 | \& ... its now a full hour (UTC, or TAI or whatever your clock follows) |
2365 | \& ... its now a full hour (UTC, or TAI or whatever your clock follows) |
1334 | \& } |
2366 | \& } |
1335 | .Ve |
2367 | \& |
1336 | .PP |
|
|
1337 | .Vb 3 |
|
|
1338 | \& struct ev_periodic hourly_tick; |
2368 | \& ev_periodic hourly_tick; |
1339 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
2369 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); |
1340 | \& ev_periodic_start (loop, &hourly_tick); |
2370 | \& ev_periodic_start (loop, &hourly_tick); |
1341 | .Ve |
2371 | .Ve |
1342 | .PP |
2372 | .PP |
1343 | Example: The same as above, but use a reschedule callback to do it: |
2373 | Example: The same as above, but use a reschedule callback to do it: |
1344 | .PP |
2374 | .PP |
1345 | .Vb 1 |
2375 | .Vb 1 |
1346 | \& #include <math.h> |
2376 | \& #include <math.h> |
1347 | .Ve |
2377 | \& |
1348 | .PP |
|
|
1349 | .Vb 5 |
|
|
1350 | \& static ev_tstamp |
2378 | \& static ev_tstamp |
1351 | \& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) |
2379 | \& my_scheduler_cb (ev_periodic *w, ev_tstamp now) |
1352 | \& { |
2380 | \& { |
1353 | \& return fmod (now, 3600.) + 3600.; |
2381 | \& return now + (3600. \- fmod (now, 3600.)); |
1354 | \& } |
2382 | \& } |
1355 | .Ve |
2383 | \& |
1356 | .PP |
|
|
1357 | .Vb 1 |
|
|
1358 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
2384 | \& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); |
1359 | .Ve |
2385 | .Ve |
1360 | .PP |
2386 | .PP |
1361 | Example: Call a callback every hour, starting now: |
2387 | Example: Call a callback every hour, starting now: |
1362 | .PP |
2388 | .PP |
1363 | .Vb 4 |
2389 | .Vb 4 |
1364 | \& struct ev_periodic hourly_tick; |
2390 | \& ev_periodic hourly_tick; |
1365 | \& ev_periodic_init (&hourly_tick, clock_cb, |
2391 | \& ev_periodic_init (&hourly_tick, clock_cb, |
1366 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
2392 | \& fmod (ev_now (loop), 3600.), 3600., 0); |
1367 | \& ev_periodic_start (loop, &hourly_tick); |
2393 | \& ev_periodic_start (loop, &hourly_tick); |
1368 | .Ve |
2394 | .Ve |
1369 | .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled!" |
2395 | .ie n .SS """ev_signal"" \- signal me when a signal gets signalled!" |
1370 | .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled!" |
2396 | .el .SS "\f(CWev_signal\fP \- signal me when a signal gets signalled!" |
1371 | .IX Subsection "ev_signal - signal me when a signal gets signalled!" |
2397 | .IX Subsection "ev_signal - signal me when a signal gets signalled!" |
1372 | Signal watchers will trigger an event when the process receives a specific |
2398 | Signal watchers will trigger an event when the process receives a specific |
1373 | signal one or more times. Even though signals are very asynchronous, libev |
2399 | signal one or more times. Even though signals are very asynchronous, libev |
1374 | will try it's best to deliver signals synchronously, i.e. as part of the |
2400 | will try its best to deliver signals synchronously, i.e. as part of the |
1375 | normal event processing, like any other event. |
2401 | normal event processing, like any other event. |
1376 | .PP |
2402 | .PP |
|
|
2403 | If you want signals to be delivered truly asynchronously, just use |
|
|
2404 | \&\f(CW\*(C`sigaction\*(C'\fR as you would do without libev and forget about sharing |
|
|
2405 | the signal. You can even use \f(CW\*(C`ev_async\*(C'\fR from a signal handler to |
|
|
2406 | synchronously wake up an event loop. |
|
|
2407 | .PP |
1377 | You can configure as many watchers as you like per signal. Only when the |
2408 | You can configure as many watchers as you like for the same signal, but |
|
|
2409 | only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your |
|
|
2410 | default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for |
|
|
2411 | \&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At |
|
|
2412 | the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop. |
|
|
2413 | .PP |
1378 | first watcher gets started will libev actually register a signal watcher |
2414 | When the first watcher gets started will libev actually register something |
1379 | with the kernel (thus it coexists with your own signal handlers as long |
2415 | with the kernel (thus it coexists with your own signal handlers as long as |
1380 | as you don't register any with libev). Similarly, when the last signal |
2416 | you don't register any with libev for the same signal). |
1381 | watcher for a signal is stopped libev will reset the signal handler to |
2417 | .PP |
1382 | \&\s-1SIG_DFL\s0 (regardless of what it was set to before). |
2418 | If possible and supported, libev will install its handlers with |
|
|
2419 | \&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should |
|
|
2420 | not be unduly interrupted. If you have a problem with system calls getting |
|
|
2421 | interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher |
|
|
2422 | and unblock them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher. |
|
|
2423 | .PP |
|
|
2424 | \fIThe special problem of inheritance over fork/execve/pthread_create\fR |
|
|
2425 | .IX Subsection "The special problem of inheritance over fork/execve/pthread_create" |
|
|
2426 | .PP |
|
|
2427 | Both the signal mask (\f(CW\*(C`sigprocmask\*(C'\fR) and the signal disposition |
|
|
2428 | (\f(CW\*(C`sigaction\*(C'\fR) are unspecified after starting a signal watcher (and after |
|
|
2429 | stopping it again), that is, libev might or might not block the signal, |
|
|
2430 | and might or might not set or restore the installed signal handler. |
|
|
2431 | .PP |
|
|
2432 | While this does not matter for the signal disposition (libev never |
|
|
2433 | sets signals to \f(CW\*(C`SIG_IGN\*(C'\fR, so handlers will be reset to \f(CW\*(C`SIG_DFL\*(C'\fR on |
|
|
2434 | \&\f(CW\*(C`execve\*(C'\fR), this matters for the signal mask: many programs do not expect |
|
|
2435 | certain signals to be blocked. |
|
|
2436 | .PP |
|
|
2437 | This means that before calling \f(CW\*(C`exec\*(C'\fR (from the child) you should reset |
|
|
2438 | the signal mask to whatever \*(L"default\*(R" you expect (all clear is a good |
|
|
2439 | choice usually). |
|
|
2440 | .PP |
|
|
2441 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2442 | to install a fork handler with \f(CW\*(C`pthread_atfork\*(C'\fR that resets it. That will |
|
|
2443 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2444 | .PP |
|
|
2445 | In current versions of libev, the signal will not be blocked indefinitely |
|
|
2446 | unless you use the \f(CW\*(C`signalfd\*(C'\fR \s-1API\s0 (\f(CW\*(C`EV_SIGNALFD\*(C'\fR). While this reduces |
|
|
2447 | the window of opportunity for problems, it will not go away, as libev |
|
|
2448 | \&\fIhas\fR to modify the signal mask, at least temporarily. |
|
|
2449 | .PP |
|
|
2450 | So I can't stress this enough: \fIIf you do not reset your signal mask when |
|
|
2451 | you expect it to be empty, you have a race condition in your code\fR. This |
|
|
2452 | is not a libev-specific thing, this is true for most event libraries. |
|
|
2453 | .PP |
|
|
2454 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2455 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1383 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
2456 | .IP "ev_signal_init (ev_signal *, callback, int signum)" 4 |
1384 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
2457 | .IX Item "ev_signal_init (ev_signal *, callback, int signum)" |
1385 | .PD 0 |
2458 | .PD 0 |
1386 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
2459 | .IP "ev_signal_set (ev_signal *, int signum)" 4 |
1387 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
2460 | .IX Item "ev_signal_set (ev_signal *, int signum)" |
… | |
… | |
1389 | Configures the watcher to trigger on the given signal number (usually one |
2462 | Configures the watcher to trigger on the given signal number (usually one |
1390 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
2463 | of the \f(CW\*(C`SIGxxx\*(C'\fR constants). |
1391 | .IP "int signum [read\-only]" 4 |
2464 | .IP "int signum [read\-only]" 4 |
1392 | .IX Item "int signum [read-only]" |
2465 | .IX Item "int signum [read-only]" |
1393 | The signal the watcher watches out for. |
2466 | The signal the watcher watches out for. |
|
|
2467 | .PP |
|
|
2468 | \fIExamples\fR |
|
|
2469 | .IX Subsection "Examples" |
|
|
2470 | .PP |
|
|
2471 | Example: Try to exit cleanly on \s-1SIGINT\s0. |
|
|
2472 | .PP |
|
|
2473 | .Vb 5 |
|
|
2474 | \& static void |
|
|
2475 | \& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) |
|
|
2476 | \& { |
|
|
2477 | \& ev_break (loop, EVBREAK_ALL); |
|
|
2478 | \& } |
|
|
2479 | \& |
|
|
2480 | \& ev_signal signal_watcher; |
|
|
2481 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
|
|
2482 | \& ev_signal_start (loop, &signal_watcher); |
|
|
2483 | .Ve |
1394 | .ie n .Sh """ev_child"" \- watch out for process status changes" |
2484 | .ie n .SS """ev_child"" \- watch out for process status changes" |
1395 | .el .Sh "\f(CWev_child\fP \- watch out for process status changes" |
2485 | .el .SS "\f(CWev_child\fP \- watch out for process status changes" |
1396 | .IX Subsection "ev_child - watch out for process status changes" |
2486 | .IX Subsection "ev_child - watch out for process status changes" |
1397 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
2487 | Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to |
1398 | some child status changes (most typically when a child of yours dies). |
2488 | some child status changes (most typically when a child of yours dies or |
|
|
2489 | exits). It is permissible to install a child watcher \fIafter\fR the child |
|
|
2490 | has been forked (which implies it might have already exited), as long |
|
|
2491 | as the event loop isn't entered (or is continued from a watcher), i.e., |
|
|
2492 | forking and then immediately registering a watcher for the child is fine, |
|
|
2493 | but forking and registering a watcher a few event loop iterations later or |
|
|
2494 | in the next callback invocation is not. |
|
|
2495 | .PP |
|
|
2496 | Only the default event loop is capable of handling signals, and therefore |
|
|
2497 | you can only register child watchers in the default event loop. |
|
|
2498 | .PP |
|
|
2499 | Due to some design glitches inside libev, child watchers will always be |
|
|
2500 | handled at maximum priority (their priority is set to \f(CW\*(C`EV_MAXPRI\*(C'\fR by |
|
|
2501 | libev) |
|
|
2502 | .PP |
|
|
2503 | \fIProcess Interaction\fR |
|
|
2504 | .IX Subsection "Process Interaction" |
|
|
2505 | .PP |
|
|
2506 | Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is |
|
|
2507 | initialised. This is necessary to guarantee proper behaviour even if the |
|
|
2508 | first child watcher is started after the child exits. The occurrence |
|
|
2509 | of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done |
|
|
2510 | synchronously as part of the event loop processing. Libev always reaps all |
|
|
2511 | children, even ones not watched. |
|
|
2512 | .PP |
|
|
2513 | \fIOverriding the Built-In Processing\fR |
|
|
2514 | .IX Subsection "Overriding the Built-In Processing" |
|
|
2515 | .PP |
|
|
2516 | Libev offers no special support for overriding the built-in child |
|
|
2517 | processing, but if your application collides with libev's default child |
|
|
2518 | handler, you can override it easily by installing your own handler for |
|
|
2519 | \&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the |
|
|
2520 | default loop never gets destroyed. You are encouraged, however, to use an |
|
|
2521 | event-based approach to child reaping and thus use libev's support for |
|
|
2522 | that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely. |
|
|
2523 | .PP |
|
|
2524 | \fIStopping the Child Watcher\fR |
|
|
2525 | .IX Subsection "Stopping the Child Watcher" |
|
|
2526 | .PP |
|
|
2527 | Currently, the child watcher never gets stopped, even when the |
|
|
2528 | child terminates, so normally one needs to stop the watcher in the |
|
|
2529 | callback. Future versions of libev might stop the watcher automatically |
|
|
2530 | when a child exit is detected (calling \f(CW\*(C`ev_child_stop\*(C'\fR twice is not a |
|
|
2531 | problem). |
|
|
2532 | .PP |
|
|
2533 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2534 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1399 | .IP "ev_child_init (ev_child *, callback, int pid)" 4 |
2535 | .IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4 |
1400 | .IX Item "ev_child_init (ev_child *, callback, int pid)" |
2536 | .IX Item "ev_child_init (ev_child *, callback, int pid, int trace)" |
1401 | .PD 0 |
2537 | .PD 0 |
1402 | .IP "ev_child_set (ev_child *, int pid)" 4 |
2538 | .IP "ev_child_set (ev_child *, int pid, int trace)" 4 |
1403 | .IX Item "ev_child_set (ev_child *, int pid)" |
2539 | .IX Item "ev_child_set (ev_child *, int pid, int trace)" |
1404 | .PD |
2540 | .PD |
1405 | Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or |
2541 | Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or |
1406 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
2542 | \&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look |
1407 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
2543 | at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see |
1408 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
2544 | the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems |
1409 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
2545 | \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the |
1410 | process causing the status change. |
2546 | process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only |
|
|
2547 | activate the watcher when the process terminates) or \f(CW1\fR (additionally |
|
|
2548 | activate the watcher when the process is stopped or continued). |
1411 | .IP "int pid [read\-only]" 4 |
2549 | .IP "int pid [read\-only]" 4 |
1412 | .IX Item "int pid [read-only]" |
2550 | .IX Item "int pid [read-only]" |
1413 | The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. |
2551 | The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. |
1414 | .IP "int rpid [read\-write]" 4 |
2552 | .IP "int rpid [read\-write]" 4 |
1415 | .IX Item "int rpid [read-write]" |
2553 | .IX Item "int rpid [read-write]" |
… | |
… | |
1417 | .IP "int rstatus [read\-write]" 4 |
2555 | .IP "int rstatus [read\-write]" 4 |
1418 | .IX Item "int rstatus [read-write]" |
2556 | .IX Item "int rstatus [read-write]" |
1419 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
2557 | The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems |
1420 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
2558 | \&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). |
1421 | .PP |
2559 | .PP |
1422 | Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. |
2560 | \fIExamples\fR |
|
|
2561 | .IX Subsection "Examples" |
1423 | .PP |
2562 | .PP |
|
|
2563 | Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for |
|
|
2564 | its completion. |
|
|
2565 | .PP |
1424 | .Vb 5 |
2566 | .Vb 1 |
|
|
2567 | \& ev_child cw; |
|
|
2568 | \& |
1425 | \& static void |
2569 | \& static void |
1426 | \& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
2570 | \& child_cb (EV_P_ ev_child *w, int revents) |
1427 | \& { |
2571 | \& { |
1428 | \& ev_unloop (loop, EVUNLOOP_ALL); |
2572 | \& ev_child_stop (EV_A_ w); |
|
|
2573 | \& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus); |
1429 | \& } |
2574 | \& } |
|
|
2575 | \& |
|
|
2576 | \& pid_t pid = fork (); |
|
|
2577 | \& |
|
|
2578 | \& if (pid < 0) |
|
|
2579 | \& // error |
|
|
2580 | \& else if (pid == 0) |
|
|
2581 | \& { |
|
|
2582 | \& // the forked child executes here |
|
|
2583 | \& exit (1); |
|
|
2584 | \& } |
|
|
2585 | \& else |
|
|
2586 | \& { |
|
|
2587 | \& ev_child_init (&cw, child_cb, pid, 0); |
|
|
2588 | \& ev_child_start (EV_DEFAULT_ &cw); |
|
|
2589 | \& } |
1430 | .Ve |
2590 | .Ve |
1431 | .PP |
|
|
1432 | .Vb 3 |
|
|
1433 | \& struct ev_signal signal_watcher; |
|
|
1434 | \& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
|
|
1435 | \& ev_signal_start (loop, &sigint_cb); |
|
|
1436 | .Ve |
|
|
1437 | .ie n .Sh """ev_stat"" \- did the file attributes just change?" |
2591 | .ie n .SS """ev_stat"" \- did the file attributes just change?" |
1438 | .el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" |
2592 | .el .SS "\f(CWev_stat\fP \- did the file attributes just change?" |
1439 | .IX Subsection "ev_stat - did the file attributes just change?" |
2593 | .IX Subsection "ev_stat - did the file attributes just change?" |
1440 | This watches a filesystem path for attribute changes. That is, it calls |
2594 | This watches a file system path for attribute changes. That is, it calls |
1441 | \&\f(CW\*(C`stat\*(C'\fR regularly (or when the \s-1OS\s0 says it changed) and sees if it changed |
2595 | \&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) |
1442 | compared to the last time, invoking the callback if it did. |
2596 | and sees if it changed compared to the last time, invoking the callback if |
|
|
2597 | it did. |
1443 | .PP |
2598 | .PP |
1444 | The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does |
2599 | The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does |
1445 | not exist\*(R" is a status change like any other. The condition \*(L"path does |
2600 | not exist\*(R" is a status change like any other. The condition \*(L"path does not |
1446 | not exist\*(R" is signified by the \f(CW\*(C`st_nlink\*(C'\fR field being zero (which is |
2601 | exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the |
1447 | otherwise always forced to be at least one) and all the other fields of |
2602 | \&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at |
1448 | the stat buffer having unspecified contents. |
2603 | least one) and all the other fields of the stat buffer having unspecified |
|
|
2604 | contents. |
1449 | .PP |
2605 | .PP |
1450 | The path \fIshould\fR be absolute and \fImust not\fR end in a slash. If it is |
2606 | The path \fImust not\fR end in a slash or contain special components such as |
|
|
2607 | \&\f(CW\*(C`.\*(C'\fR or \f(CW\*(C`..\*(C'\fR. The path \fIshould\fR be absolute: If it is relative and |
1451 | relative and your working directory changes, the behaviour is undefined. |
2608 | your working directory changes, then the behaviour is undefined. |
1452 | .PP |
2609 | .PP |
1453 | Since there is no standard to do this, the portable implementation simply |
2610 | Since there is no portable change notification interface available, the |
1454 | calls \f(CW\*(C`stat (2)\*(C'\fR regularly on the path to see if it changed somehow. You |
2611 | portable implementation simply calls \f(CWstat(2)\fR regularly on the path |
1455 | can specify a recommended polling interval for this case. If you specify |
2612 | to see if it changed somehow. You can specify a recommended polling |
1456 | a polling interval of \f(CW0\fR (highly recommended!) then a \fIsuitable, |
2613 | interval for this case. If you specify a polling interval of \f(CW0\fR (highly |
1457 | unspecified default\fR value will be used (which you can expect to be around |
2614 | recommended!) then a \fIsuitable, unspecified default\fR value will be used |
1458 | five seconds, although this might change dynamically). Libev will also |
2615 | (which you can expect to be around five seconds, although this might |
1459 | impose a minimum interval which is currently around \f(CW0.1\fR, but thats |
2616 | change dynamically). Libev will also impose a minimum interval which is |
1460 | usually overkill. |
2617 | currently around \f(CW0.1\fR, but that's usually overkill. |
1461 | .PP |
2618 | .PP |
1462 | This watcher type is not meant for massive numbers of stat watchers, |
2619 | This watcher type is not meant for massive numbers of stat watchers, |
1463 | as even with OS-supported change notifications, this can be |
2620 | as even with OS-supported change notifications, this can be |
1464 | resource\-intensive. |
2621 | resource-intensive. |
1465 | .PP |
2622 | .PP |
1466 | At the time of this writing, only the Linux inotify interface is |
2623 | At the time of this writing, the only OS-specific interface implemented |
1467 | implemented (implementing kqueue support is left as an exercise for the |
2624 | is the Linux inotify interface (implementing kqueue support is left as an |
1468 | reader). Inotify will be used to give hints only and should not change the |
2625 | exercise for the reader. Note, however, that the author sees no way of |
1469 | semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs |
2626 | implementing \f(CW\*(C`ev_stat\*(C'\fR semantics with kqueue, except as a hint). |
1470 | to fall back to regular polling again even with inotify, but changes are |
2627 | .PP |
1471 | usually detected immediately, and if the file exists there will be no |
2628 | \fI\s-1ABI\s0 Issues (Largefile Support)\fR |
1472 | polling. |
2629 | .IX Subsection "ABI Issues (Largefile Support)" |
|
|
2630 | .PP |
|
|
2631 | Libev by default (unless the user overrides this) uses the default |
|
|
2632 | compilation environment, which means that on systems with large file |
|
|
2633 | support disabled by default, you get the 32 bit version of the stat |
|
|
2634 | structure. When using the library from programs that change the \s-1ABI\s0 to |
|
|
2635 | use 64 bit file offsets the programs will fail. In that case you have to |
|
|
2636 | compile libev with the same flags to get binary compatibility. This is |
|
|
2637 | obviously the case with any flags that change the \s-1ABI\s0, but the problem is |
|
|
2638 | most noticeably displayed with ev_stat and large file support. |
|
|
2639 | .PP |
|
|
2640 | The solution for this is to lobby your distribution maker to make large |
|
|
2641 | file interfaces available by default (as e.g. FreeBSD does) and not |
|
|
2642 | optional. Libev cannot simply switch on large file support because it has |
|
|
2643 | to exchange stat structures with application programs compiled using the |
|
|
2644 | default compilation environment. |
|
|
2645 | .PP |
|
|
2646 | \fIInotify and Kqueue\fR |
|
|
2647 | .IX Subsection "Inotify and Kqueue" |
|
|
2648 | .PP |
|
|
2649 | When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev and present at |
|
|
2650 | runtime, it will be used to speed up change detection where possible. The |
|
|
2651 | inotify descriptor will be created lazily when the first \f(CW\*(C`ev_stat\*(C'\fR |
|
|
2652 | watcher is being started. |
|
|
2653 | .PP |
|
|
2654 | Inotify presence does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers |
|
|
2655 | except that changes might be detected earlier, and in some cases, to avoid |
|
|
2656 | making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presence of inotify support |
|
|
2657 | there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling, |
|
|
2658 | but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too |
|
|
2659 | many bugs), the path exists (i.e. stat succeeds), and the path resides on |
|
|
2660 | a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and |
|
|
2661 | xfs are fully working) libev usually gets away without polling. |
|
|
2662 | .PP |
|
|
2663 | There is no support for kqueue, as apparently it cannot be used to |
|
|
2664 | implement this functionality, due to the requirement of having a file |
|
|
2665 | descriptor open on the object at all times, and detecting renames, unlinks |
|
|
2666 | etc. is difficult. |
|
|
2667 | .PP |
|
|
2668 | \fI\f(CI\*(C`stat ()\*(C'\fI is a synchronous operation\fR |
|
|
2669 | .IX Subsection "stat () is a synchronous operation" |
|
|
2670 | .PP |
|
|
2671 | Libev doesn't normally do any kind of I/O itself, and so is not blocking |
|
|
2672 | the process. The exception are \f(CW\*(C`ev_stat\*(C'\fR watchers \- those call \f(CW\*(C`stat |
|
|
2673 | ()\*(C'\fR, which is a synchronous operation. |
|
|
2674 | .PP |
|
|
2675 | For local paths, this usually doesn't matter: unless the system is very |
|
|
2676 | busy or the intervals between stat's are large, a stat call will be fast, |
|
|
2677 | as the path data is usually in memory already (except when starting the |
|
|
2678 | watcher). |
|
|
2679 | .PP |
|
|
2680 | For networked file systems, calling \f(CW\*(C`stat ()\*(C'\fR can block an indefinite |
|
|
2681 | time due to network issues, and even under good conditions, a stat call |
|
|
2682 | often takes multiple milliseconds. |
|
|
2683 | .PP |
|
|
2684 | Therefore, it is best to avoid using \f(CW\*(C`ev_stat\*(C'\fR watchers on networked |
|
|
2685 | paths, although this is fully supported by libev. |
|
|
2686 | .PP |
|
|
2687 | \fIThe special problem of stat time resolution\fR |
|
|
2688 | .IX Subsection "The special problem of stat time resolution" |
|
|
2689 | .PP |
|
|
2690 | The \f(CW\*(C`stat ()\*(C'\fR system call only supports full-second resolution portably, |
|
|
2691 | and even on systems where the resolution is higher, most file systems |
|
|
2692 | still only support whole seconds. |
|
|
2693 | .PP |
|
|
2694 | That means that, if the time is the only thing that changes, you can |
|
|
2695 | easily miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and |
|
|
2696 | calls your callback, which does something. When there is another update |
|
|
2697 | within the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect unless the |
|
|
2698 | stat data does change in other ways (e.g. file size). |
|
|
2699 | .PP |
|
|
2700 | The solution to this is to delay acting on a change for slightly more |
|
|
2701 | than a second (or till slightly after the next full second boundary), using |
|
|
2702 | a roughly one-second-delay \f(CW\*(C`ev_timer\*(C'\fR (e.g. \f(CW\*(C`ev_timer_set (w, 0., 1.02); |
|
|
2703 | ev_timer_again (loop, w)\*(C'\fR). |
|
|
2704 | .PP |
|
|
2705 | The \f(CW.02\fR offset is added to work around small timing inconsistencies |
|
|
2706 | of some operating systems (where the second counter of the current time |
|
|
2707 | might be be delayed. One such system is the Linux kernel, where a call to |
|
|
2708 | \&\f(CW\*(C`gettimeofday\*(C'\fR might return a timestamp with a full second later than |
|
|
2709 | a subsequent \f(CW\*(C`time\*(C'\fR call \- if the equivalent of \f(CW\*(C`time ()\*(C'\fR is used to |
|
|
2710 | update file times then there will be a small window where the kernel uses |
|
|
2711 | the previous second to update file times but libev might already execute |
|
|
2712 | the timer callback). |
|
|
2713 | .PP |
|
|
2714 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2715 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1473 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
2716 | .IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 |
1474 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
2717 | .IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" |
1475 | .PD 0 |
2718 | .PD 0 |
1476 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
2719 | .IP "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" 4 |
1477 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
2720 | .IX Item "ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)" |
… | |
… | |
1480 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
2723 | \&\f(CW\*(C`path\*(C'\fR. The \f(CW\*(C`interval\*(C'\fR is a hint on how quickly a change is expected to |
1481 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
2724 | be detected and should normally be specified as \f(CW0\fR to let libev choose |
1482 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
2725 | a suitable value. The memory pointed to by \f(CW\*(C`path\*(C'\fR must point to the same |
1483 | path for as long as the watcher is active. |
2726 | path for as long as the watcher is active. |
1484 | .Sp |
2727 | .Sp |
1485 | The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, |
2728 | The callback will receive an \f(CW\*(C`EV_STAT\*(C'\fR event when a change was detected, |
1486 | relative to the attributes at the time the watcher was started (or the |
2729 | relative to the attributes at the time the watcher was started (or the |
1487 | last change was detected). |
2730 | last change was detected). |
1488 | .IP "ev_stat_stat (ev_stat *)" 4 |
2731 | .IP "ev_stat_stat (loop, ev_stat *)" 4 |
1489 | .IX Item "ev_stat_stat (ev_stat *)" |
2732 | .IX Item "ev_stat_stat (loop, ev_stat *)" |
1490 | Updates the stat buffer immediately with new values. If you change the |
2733 | Updates the stat buffer immediately with new values. If you change the |
1491 | watched path in your callback, you could call this fucntion to avoid |
2734 | watched path in your callback, you could call this function to avoid |
1492 | detecting this change (while introducing a race condition). Can also be |
2735 | detecting this change (while introducing a race condition if you are not |
1493 | useful simply to find out the new values. |
2736 | the only one changing the path). Can also be useful simply to find out the |
|
|
2737 | new values. |
1494 | .IP "ev_statdata attr [read\-only]" 4 |
2738 | .IP "ev_statdata attr [read\-only]" 4 |
1495 | .IX Item "ev_statdata attr [read-only]" |
2739 | .IX Item "ev_statdata attr [read-only]" |
1496 | The most-recently detected attributes of the file. Although the type is of |
2740 | The most-recently detected attributes of the file. Although the type is |
1497 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
2741 | \&\f(CW\*(C`ev_statdata\*(C'\fR, this is usually the (or one of the) \f(CW\*(C`struct stat\*(C'\fR types |
|
|
2742 | suitable for your system, but you can only rely on the POSIX-standardised |
1498 | suitable for your system. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there |
2743 | members to be present. If the \f(CW\*(C`st_nlink\*(C'\fR member is \f(CW0\fR, then there was |
1499 | was some error while \f(CW\*(C`stat\*(C'\fRing the file. |
2744 | some error while \f(CW\*(C`stat\*(C'\fRing the file. |
1500 | .IP "ev_statdata prev [read\-only]" 4 |
2745 | .IP "ev_statdata prev [read\-only]" 4 |
1501 | .IX Item "ev_statdata prev [read-only]" |
2746 | .IX Item "ev_statdata prev [read-only]" |
1502 | The previous attributes of the file. The callback gets invoked whenever |
2747 | The previous attributes of the file. The callback gets invoked whenever |
1503 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR. |
2748 | \&\f(CW\*(C`prev\*(C'\fR != \f(CW\*(C`attr\*(C'\fR, or, more precisely, one or more of these members |
|
|
2749 | 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, |
|
|
2750 | \&\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. |
1504 | .IP "ev_tstamp interval [read\-only]" 4 |
2751 | .IP "ev_tstamp interval [read\-only]" 4 |
1505 | .IX Item "ev_tstamp interval [read-only]" |
2752 | .IX Item "ev_tstamp interval [read-only]" |
1506 | The specified interval. |
2753 | The specified interval. |
1507 | .IP "const char *path [read\-only]" 4 |
2754 | .IP "const char *path [read\-only]" 4 |
1508 | .IX Item "const char *path [read-only]" |
2755 | .IX Item "const char *path [read-only]" |
1509 | The filesystem path that is being watched. |
2756 | The file system path that is being watched. |
|
|
2757 | .PP |
|
|
2758 | \fIExamples\fR |
|
|
2759 | .IX Subsection "Examples" |
1510 | .PP |
2760 | .PP |
1511 | Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. |
2761 | Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. |
1512 | .PP |
2762 | .PP |
1513 | .Vb 15 |
2763 | .Vb 10 |
1514 | \& static void |
2764 | \& static void |
1515 | \& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
2765 | \& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1516 | \& { |
2766 | \& { |
1517 | \& /* /etc/passwd changed in some way */ |
2767 | \& /* /etc/passwd changed in some way */ |
1518 | \& if (w->attr.st_nlink) |
2768 | \& if (w\->attr.st_nlink) |
1519 | \& { |
2769 | \& { |
1520 | \& printf ("passwd current size %ld\en", (long)w->attr.st_size); |
2770 | \& printf ("passwd current size %ld\en", (long)w\->attr.st_size); |
1521 | \& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); |
2771 | \& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime); |
1522 | \& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); |
2772 | \& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime); |
1523 | \& } |
2773 | \& } |
1524 | \& else |
2774 | \& else |
1525 | \& /* you shalt not abuse printf for puts */ |
2775 | \& /* you shalt not abuse printf for puts */ |
1526 | \& puts ("wow, /etc/passwd is not there, expect problems. " |
2776 | \& puts ("wow, /etc/passwd is not there, expect problems. " |
1527 | \& "if this is windows, they already arrived\en"); |
2777 | \& "if this is windows, they already arrived\en"); |
1528 | \& } |
2778 | \& } |
|
|
2779 | \& |
|
|
2780 | \& ... |
|
|
2781 | \& ev_stat passwd; |
|
|
2782 | \& |
|
|
2783 | \& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
|
|
2784 | \& ev_stat_start (loop, &passwd); |
1529 | .Ve |
2785 | .Ve |
|
|
2786 | .PP |
|
|
2787 | Example: Like above, but additionally use a one-second delay so we do not |
|
|
2788 | miss updates (however, frequent updates will delay processing, too, so |
|
|
2789 | one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on |
|
|
2790 | \&\f(CW\*(C`ev_timer\*(C'\fR callback invocation). |
1530 | .PP |
2791 | .PP |
1531 | .Vb 2 |
2792 | .Vb 2 |
|
|
2793 | \& static ev_stat passwd; |
|
|
2794 | \& static ev_timer timer; |
|
|
2795 | \& |
|
|
2796 | \& static void |
|
|
2797 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
2798 | \& { |
|
|
2799 | \& ev_timer_stop (EV_A_ w); |
|
|
2800 | \& |
|
|
2801 | \& /* now it\*(Aqs one second after the most recent passwd change */ |
|
|
2802 | \& } |
|
|
2803 | \& |
|
|
2804 | \& static void |
|
|
2805 | \& stat_cb (EV_P_ ev_stat *w, int revents) |
|
|
2806 | \& { |
|
|
2807 | \& /* reset the one\-second timer */ |
|
|
2808 | \& ev_timer_again (EV_A_ &timer); |
|
|
2809 | \& } |
|
|
2810 | \& |
1532 | \& ... |
2811 | \& ... |
1533 | \& ev_stat passwd; |
|
|
1534 | .Ve |
|
|
1535 | .PP |
|
|
1536 | .Vb 2 |
|
|
1537 | \& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
2812 | \& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
1538 | \& ev_stat_start (loop, &passwd); |
2813 | \& ev_stat_start (loop, &passwd); |
|
|
2814 | \& ev_timer_init (&timer, timer_cb, 0., 1.02); |
1539 | .Ve |
2815 | .Ve |
1540 | .ie n .Sh """ev_idle"" \- when you've got nothing better to do..." |
2816 | .ie n .SS """ev_idle"" \- when you've got nothing better to do..." |
1541 | .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." |
2817 | .el .SS "\f(CWev_idle\fP \- when you've got nothing better to do..." |
1542 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
2818 | .IX Subsection "ev_idle - when you've got nothing better to do..." |
1543 | Idle watchers trigger events when no other events of the same or higher |
2819 | Idle watchers trigger events when no other events of the same or higher |
1544 | priority are pending (prepare, check and other idle watchers do not |
2820 | priority are pending (prepare, check and other idle watchers do not count |
1545 | count). |
2821 | as receiving \*(L"events\*(R"). |
1546 | .PP |
2822 | .PP |
1547 | That is, as long as your process is busy handling sockets or timeouts |
2823 | That is, as long as your process is busy handling sockets or timeouts |
1548 | (or even signals, imagine) of the same or higher priority it will not be |
2824 | (or even signals, imagine) of the same or higher priority it will not be |
1549 | triggered. But when your process is idle (or only lower-priority watchers |
2825 | triggered. But when your process is idle (or only lower-priority watchers |
1550 | are pending), the idle watchers are being called once per event loop |
2826 | are pending), the idle watchers are being called once per event loop |
… | |
… | |
1554 | The most noteworthy effect is that as long as any idle watchers are |
2830 | The most noteworthy effect is that as long as any idle watchers are |
1555 | active, the process will not block when waiting for new events. |
2831 | active, the process will not block when waiting for new events. |
1556 | .PP |
2832 | .PP |
1557 | Apart from keeping your process non-blocking (which is a useful |
2833 | Apart from keeping your process non-blocking (which is a useful |
1558 | effect on its own sometimes), idle watchers are a good place to do |
2834 | effect on its own sometimes), idle watchers are a good place to do |
1559 | \&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the |
2835 | \&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the |
1560 | event loop has handled all outstanding events. |
2836 | event loop has handled all outstanding events. |
|
|
2837 | .PP |
|
|
2838 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2839 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1561 | .IP "ev_idle_init (ev_signal *, callback)" 4 |
2840 | .IP "ev_idle_init (ev_idle *, callback)" 4 |
1562 | .IX Item "ev_idle_init (ev_signal *, callback)" |
2841 | .IX Item "ev_idle_init (ev_idle *, callback)" |
1563 | Initialises and configures the idle watcher \- it has no parameters of any |
2842 | Initialises and configures the idle watcher \- it has no parameters of any |
1564 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
2843 | kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, |
1565 | believe me. |
2844 | believe me. |
1566 | .PP |
2845 | .PP |
|
|
2846 | \fIExamples\fR |
|
|
2847 | .IX Subsection "Examples" |
|
|
2848 | .PP |
1567 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
2849 | Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the |
1568 | callback, free it. Also, use no error checking, as usual. |
2850 | callback, free it. Also, use no error checking, as usual. |
1569 | .PP |
2851 | .PP |
1570 | .Vb 7 |
2852 | .Vb 7 |
1571 | \& static void |
2853 | \& static void |
1572 | \& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
2854 | \& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) |
1573 | \& { |
2855 | \& { |
1574 | \& free (w); |
2856 | \& free (w); |
1575 | \& // now do something you wanted to do when the program has |
2857 | \& // now do something you wanted to do when the program has |
1576 | \& // no longer asnything immediate to do. |
2858 | \& // no longer anything immediate to do. |
1577 | \& } |
2859 | \& } |
1578 | .Ve |
2860 | \& |
1579 | .PP |
|
|
1580 | .Vb 3 |
|
|
1581 | \& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
2861 | \& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
1582 | \& ev_idle_init (idle_watcher, idle_cb); |
2862 | \& ev_idle_init (idle_watcher, idle_cb); |
1583 | \& ev_idle_start (loop, idle_cb); |
2863 | \& ev_idle_start (loop, idle_watcher); |
1584 | .Ve |
2864 | .Ve |
1585 | .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" |
2865 | .ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" |
1586 | .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" |
2866 | .el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" |
1587 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
2867 | .IX Subsection "ev_prepare and ev_check - customise your event loop!" |
1588 | Prepare and check watchers are usually (but not always) used in tandem: |
2868 | Prepare and check watchers are usually (but not always) used in pairs: |
1589 | prepare watchers get invoked before the process blocks and check watchers |
2869 | prepare watchers get invoked before the process blocks and check watchers |
1590 | afterwards. |
2870 | afterwards. |
1591 | .PP |
2871 | .PP |
1592 | You \fImust not\fR call \f(CW\*(C`ev_loop\*(C'\fR or similar functions that enter |
2872 | You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter |
1593 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
2873 | the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR |
1594 | watchers. Other loops than the current one are fine, however. The |
2874 | watchers. Other loops than the current one are fine, however. The |
1595 | rationale behind this is that you do not need to check for recursion in |
2875 | rationale behind this is that you do not need to check for recursion in |
1596 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
2876 | those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, |
1597 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
2877 | \&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be |
1598 | called in pairs bracketing the blocking call. |
2878 | called in pairs bracketing the blocking call. |
1599 | .PP |
2879 | .PP |
1600 | Their main purpose is to integrate other event mechanisms into libev and |
2880 | Their main purpose is to integrate other event mechanisms into libev and |
1601 | their use is somewhat advanced. This could be used, for example, to track |
2881 | their use is somewhat advanced. They could be used, for example, to track |
1602 | variable changes, implement your own watchers, integrate net-snmp or a |
2882 | variable changes, implement your own watchers, integrate net-snmp or a |
1603 | coroutine library and lots more. They are also occasionally useful if |
2883 | coroutine library and lots more. They are also occasionally useful if |
1604 | you cache some data and want to flush it before blocking (for example, |
2884 | you cache some data and want to flush it before blocking (for example, |
1605 | in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR |
2885 | in X programs you might want to do an \f(CW\*(C`XFlush ()\*(C'\fR in an \f(CW\*(C`ev_prepare\*(C'\fR |
1606 | watcher). |
2886 | watcher). |
1607 | .PP |
2887 | .PP |
1608 | This is done by examining in each prepare call which file descriptors need |
2888 | This is done by examining in each prepare call which file descriptors |
1609 | to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for |
2889 | need to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers |
1610 | them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many libraries |
2890 | for them and starting an \f(CW\*(C`ev_timer\*(C'\fR watcher for any timeouts (many |
1611 | provide just this functionality). Then, in the check watcher you check for |
2891 | libraries provide exactly this functionality). Then, in the check watcher, |
1612 | any events that occured (by checking the pending status of all watchers |
2892 | you check for any events that occurred (by checking the pending status |
1613 | and stopping them) and call back into the library. The I/O and timer |
2893 | of all watchers and stopping them) and call back into the library. The |
1614 | callbacks will never actually be called (but must be valid nevertheless, |
2894 | I/O and timer callbacks will never actually be called (but must be valid |
1615 | because you never know, you know?). |
2895 | nevertheless, because you never know, you know?). |
1616 | .PP |
2896 | .PP |
1617 | As another example, the Perl Coro module uses these hooks to integrate |
2897 | As another example, the Perl Coro module uses these hooks to integrate |
1618 | coroutines into libev programs, by yielding to other active coroutines |
2898 | coroutines into libev programs, by yielding to other active coroutines |
1619 | during each prepare and only letting the process block if no coroutines |
2899 | during each prepare and only letting the process block if no coroutines |
1620 | are ready to run (it's actually more complicated: it only runs coroutines |
2900 | are ready to run (it's actually more complicated: it only runs coroutines |
1621 | with priority higher than or equal to the event loop and one coroutine |
2901 | with priority higher than or equal to the event loop and one coroutine |
1622 | of lower priority, but only once, using idle watchers to keep the event |
2902 | of lower priority, but only once, using idle watchers to keep the event |
1623 | loop from blocking if lower-priority coroutines are active, thus mapping |
2903 | loop from blocking if lower-priority coroutines are active, thus mapping |
1624 | low-priority coroutines to idle/background tasks). |
2904 | low-priority coroutines to idle/background tasks). |
|
|
2905 | .PP |
|
|
2906 | It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) |
|
|
2907 | priority, to ensure that they are being run before any other watchers |
|
|
2908 | after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). |
|
|
2909 | .PP |
|
|
2910 | Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not |
|
|
2911 | activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they |
|
|
2912 | might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As |
|
|
2913 | \&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event |
|
|
2914 | loops those other event loops might be in an unusable state until their |
|
|
2915 | \&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with |
|
|
2916 | others). |
|
|
2917 | .PP |
|
|
2918 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
2919 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1625 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
2920 | .IP "ev_prepare_init (ev_prepare *, callback)" 4 |
1626 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
2921 | .IX Item "ev_prepare_init (ev_prepare *, callback)" |
1627 | .PD 0 |
2922 | .PD 0 |
1628 | .IP "ev_check_init (ev_check *, callback)" 4 |
2923 | .IP "ev_check_init (ev_check *, callback)" 4 |
1629 | .IX Item "ev_check_init (ev_check *, callback)" |
2924 | .IX Item "ev_check_init (ev_check *, callback)" |
1630 | .PD |
2925 | .PD |
1631 | Initialises and configures the prepare or check watcher \- they have no |
2926 | Initialises and configures the prepare or check watcher \- they have no |
1632 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
2927 | parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR |
1633 | macros, but using them is utterly, utterly and completely pointless. |
2928 | macros, but using them is utterly, utterly, utterly and completely |
|
|
2929 | pointless. |
1634 | .PP |
2930 | .PP |
1635 | Example: To include a library such as adns, you would add \s-1IO\s0 watchers |
2931 | \fIExamples\fR |
1636 | and a timeout watcher in a prepare handler, as required by libadns, and |
2932 | .IX Subsection "Examples" |
|
|
2933 | .PP |
|
|
2934 | There are a number of principal ways to embed other event loops or modules |
|
|
2935 | into libev. Here are some ideas on how to include libadns into libev |
|
|
2936 | (there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could |
|
|
2937 | use as a working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR embeds a |
|
|
2938 | Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 into the |
|
|
2939 | Glib event loop). |
|
|
2940 | .PP |
|
|
2941 | Method 1: Add \s-1IO\s0 watchers and a timeout watcher in a prepare handler, |
1637 | in a check watcher, destroy them and call into libadns. What follows is |
2942 | and in a check watcher, destroy them and call into libadns. What follows |
1638 | pseudo-code only of course: |
2943 | is pseudo-code only of course. This requires you to either use a low |
|
|
2944 | priority for the check watcher or use \f(CW\*(C`ev_clear_pending\*(C'\fR explicitly, as |
|
|
2945 | the callbacks for the IO/timeout watchers might not have been called yet. |
1639 | .PP |
2946 | .PP |
1640 | .Vb 2 |
2947 | .Vb 2 |
1641 | \& static ev_io iow [nfd]; |
2948 | \& static ev_io iow [nfd]; |
1642 | \& static ev_timer tw; |
2949 | \& static ev_timer tw; |
1643 | .Ve |
2950 | \& |
1644 | .PP |
|
|
1645 | .Vb 9 |
|
|
1646 | \& static void |
2951 | \& static void |
1647 | \& io_cb (ev_loop *loop, ev_io *w, int revents) |
2952 | \& io_cb (struct ev_loop *loop, ev_io *w, int revents) |
1648 | \& { |
2953 | \& { |
1649 | \& // set the relevant poll flags |
|
|
1650 | \& // could also call adns_processreadable etc. here |
|
|
1651 | \& struct pollfd *fd = (struct pollfd *)w->data; |
|
|
1652 | \& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; |
|
|
1653 | \& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; |
|
|
1654 | \& } |
2954 | \& } |
1655 | .Ve |
2955 | \& |
1656 | .PP |
|
|
1657 | .Vb 8 |
|
|
1658 | \& // create io watchers for each fd and a timer before blocking |
2956 | \& // create io watchers for each fd and a timer before blocking |
1659 | \& static void |
2957 | \& static void |
1660 | \& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) |
2958 | \& adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents) |
1661 | \& { |
2959 | \& { |
1662 | \& int timeout = 3600000; |
2960 | \& int timeout = 3600000; |
1663 | \& struct pollfd fds [nfd]; |
2961 | \& struct pollfd fds [nfd]; |
1664 | \& // actual code will need to loop here and realloc etc. |
2962 | \& // actual code will need to loop here and realloc etc. |
1665 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2963 | \& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
1666 | .Ve |
2964 | \& |
1667 | .PP |
|
|
1668 | .Vb 3 |
|
|
1669 | \& /* the callback is illegal, but won't be called as we stop during check */ |
2965 | \& /* the callback is illegal, but won\*(Aqt be called as we stop during check */ |
1670 | \& ev_timer_init (&tw, 0, timeout * 1e-3); |
2966 | \& ev_timer_init (&tw, 0, timeout * 1e\-3, 0.); |
1671 | \& ev_timer_start (loop, &tw); |
2967 | \& ev_timer_start (loop, &tw); |
1672 | .Ve |
2968 | \& |
1673 | .PP |
|
|
1674 | .Vb 6 |
|
|
1675 | \& // create on ev_io per pollfd |
2969 | \& // create one ev_io per pollfd |
1676 | \& for (int i = 0; i < nfd; ++i) |
2970 | \& for (int i = 0; i < nfd; ++i) |
1677 | \& { |
2971 | \& { |
1678 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
2972 | \& ev_io_init (iow + i, io_cb, fds [i].fd, |
1679 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
2973 | \& ((fds [i].events & POLLIN ? EV_READ : 0) |
1680 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
2974 | \& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); |
|
|
2975 | \& |
|
|
2976 | \& fds [i].revents = 0; |
|
|
2977 | \& ev_io_start (loop, iow + i); |
|
|
2978 | \& } |
|
|
2979 | \& } |
|
|
2980 | \& |
|
|
2981 | \& // stop all watchers after blocking |
|
|
2982 | \& static void |
|
|
2983 | \& adns_check_cb (struct ev_loop *loop, ev_check *w, int revents) |
|
|
2984 | \& { |
|
|
2985 | \& ev_timer_stop (loop, &tw); |
|
|
2986 | \& |
|
|
2987 | \& for (int i = 0; i < nfd; ++i) |
|
|
2988 | \& { |
|
|
2989 | \& // set the relevant poll flags |
|
|
2990 | \& // could also call adns_processreadable etc. here |
|
|
2991 | \& struct pollfd *fd = fds + i; |
|
|
2992 | \& int revents = ev_clear_pending (iow + i); |
|
|
2993 | \& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN; |
|
|
2994 | \& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT; |
|
|
2995 | \& |
|
|
2996 | \& // now stop the watcher |
|
|
2997 | \& ev_io_stop (loop, iow + i); |
|
|
2998 | \& } |
|
|
2999 | \& |
|
|
3000 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
3001 | \& } |
1681 | .Ve |
3002 | .Ve |
|
|
3003 | .PP |
|
|
3004 | Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR |
|
|
3005 | in the prepare watcher and would dispose of the check watcher. |
|
|
3006 | .PP |
|
|
3007 | Method 3: If the module to be embedded supports explicit event |
|
|
3008 | notification (libadns does), you can also make use of the actual watcher |
|
|
3009 | callbacks, and only destroy/create the watchers in the prepare watcher. |
1682 | .PP |
3010 | .PP |
1683 | .Vb 5 |
3011 | .Vb 5 |
1684 | \& fds [i].revents = 0; |
|
|
1685 | \& iow [i].data = fds + i; |
|
|
1686 | \& ev_io_start (loop, iow + i); |
|
|
1687 | \& } |
|
|
1688 | \& } |
|
|
1689 | .Ve |
|
|
1690 | .PP |
|
|
1691 | .Vb 5 |
|
|
1692 | \& // stop all watchers after blocking |
|
|
1693 | \& static void |
3012 | \& static void |
1694 | \& adns_check_cb (ev_loop *loop, ev_check *w, int revents) |
3013 | \& timer_cb (EV_P_ ev_timer *w, int revents) |
1695 | \& { |
3014 | \& { |
1696 | \& ev_timer_stop (loop, &tw); |
3015 | \& adns_state ads = (adns_state)w\->data; |
1697 | .Ve |
3016 | \& update_now (EV_A); |
1698 | .PP |
3017 | \& |
1699 | .Vb 2 |
3018 | \& adns_processtimeouts (ads, &tv_now); |
1700 | \& for (int i = 0; i < nfd; ++i) |
|
|
1701 | \& ev_io_stop (loop, iow + i); |
|
|
1702 | .Ve |
|
|
1703 | .PP |
|
|
1704 | .Vb 2 |
|
|
1705 | \& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); |
|
|
1706 | \& } |
3019 | \& } |
|
|
3020 | \& |
|
|
3021 | \& static void |
|
|
3022 | \& io_cb (EV_P_ ev_io *w, int revents) |
|
|
3023 | \& { |
|
|
3024 | \& adns_state ads = (adns_state)w\->data; |
|
|
3025 | \& update_now (EV_A); |
|
|
3026 | \& |
|
|
3027 | \& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now); |
|
|
3028 | \& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now); |
|
|
3029 | \& } |
|
|
3030 | \& |
|
|
3031 | \& // do not ever call adns_afterpoll |
1707 | .Ve |
3032 | .Ve |
|
|
3033 | .PP |
|
|
3034 | Method 4: Do not use a prepare or check watcher because the module you |
|
|
3035 | want to embed is not flexible enough to support it. Instead, you can |
|
|
3036 | override their poll function. The drawback with this solution is that the |
|
|
3037 | main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses |
|
|
3038 | this approach, effectively embedding \s-1EV\s0 as a client into the horrible |
|
|
3039 | libglib event loop. |
|
|
3040 | .PP |
|
|
3041 | .Vb 4 |
|
|
3042 | \& static gint |
|
|
3043 | \& event_poll_func (GPollFD *fds, guint nfds, gint timeout) |
|
|
3044 | \& { |
|
|
3045 | \& int got_events = 0; |
|
|
3046 | \& |
|
|
3047 | \& for (n = 0; n < nfds; ++n) |
|
|
3048 | \& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events |
|
|
3049 | \& |
|
|
3050 | \& if (timeout >= 0) |
|
|
3051 | \& // create/start timer |
|
|
3052 | \& |
|
|
3053 | \& // poll |
|
|
3054 | \& ev_run (EV_A_ 0); |
|
|
3055 | \& |
|
|
3056 | \& // stop timer again |
|
|
3057 | \& if (timeout >= 0) |
|
|
3058 | \& ev_timer_stop (EV_A_ &to); |
|
|
3059 | \& |
|
|
3060 | \& // stop io watchers again \- their callbacks should have set |
|
|
3061 | \& for (n = 0; n < nfds; ++n) |
|
|
3062 | \& ev_io_stop (EV_A_ iow [n]); |
|
|
3063 | \& |
|
|
3064 | \& return got_events; |
|
|
3065 | \& } |
|
|
3066 | .Ve |
1708 | .ie n .Sh """ev_embed"" \- when one backend isn't enough..." |
3067 | .ie n .SS """ev_embed"" \- when one backend isn't enough..." |
1709 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
3068 | .el .SS "\f(CWev_embed\fP \- when one backend isn't enough..." |
1710 | .IX Subsection "ev_embed - when one backend isn't enough..." |
3069 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1711 | This is a rather advanced watcher type that lets you embed one event loop |
3070 | This is a rather advanced watcher type that lets you embed one event loop |
1712 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
3071 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
1713 | loop, other types of watchers might be handled in a delayed or incorrect |
3072 | loop, other types of watchers might be handled in a delayed or incorrect |
1714 | fashion and must not be used). |
3073 | fashion and must not be used). |
… | |
… | |
1717 | prioritise I/O. |
3076 | prioritise I/O. |
1718 | .PP |
3077 | .PP |
1719 | As an example for a bug workaround, the kqueue backend might only support |
3078 | As an example for a bug workaround, the kqueue backend might only support |
1720 | sockets on some platform, so it is unusable as generic backend, but you |
3079 | sockets on some platform, so it is unusable as generic backend, but you |
1721 | still want to make use of it because you have many sockets and it scales |
3080 | still want to make use of it because you have many sockets and it scales |
1722 | so nicely. In this case, you would create a kqueue-based loop and embed it |
3081 | so nicely. In this case, you would create a kqueue-based loop and embed |
1723 | into your default loop (which might use e.g. poll). Overall operation will |
3082 | it into your default loop (which might use e.g. poll). Overall operation |
1724 | be a bit slower because first libev has to poll and then call kevent, but |
3083 | will be a bit slower because first libev has to call \f(CW\*(C`poll\*(C'\fR and then |
1725 | at least you can use both at what they are best. |
3084 | \&\f(CW\*(C`kevent\*(C'\fR, but at least you can use both mechanisms for what they are |
|
|
3085 | best: \f(CW\*(C`kqueue\*(C'\fR for scalable sockets and \f(CW\*(C`poll\*(C'\fR if you want it to work :) |
1726 | .PP |
3086 | .PP |
1727 | As for prioritising I/O: rarely you have the case where some fds have |
3087 | As for prioritising I/O: under rare circumstances you have the case where |
1728 | to be watched and handled very quickly (with low latency), and even |
3088 | some fds have to be watched and handled very quickly (with low latency), |
1729 | priorities and idle watchers might have too much overhead. In this case |
3089 | and even priorities and idle watchers might have too much overhead. In |
1730 | you would put all the high priority stuff in one loop and all the rest in |
3090 | this case you would put all the high priority stuff in one loop and all |
1731 | a second one, and embed the second one in the first. |
3091 | the rest in a second one, and embed the second one in the first. |
1732 | .PP |
3092 | .PP |
1733 | As long as the watcher is active, the callback will be invoked every time |
3093 | As long as the watcher is active, the callback will be invoked every |
1734 | there might be events pending in the embedded loop. The callback must then |
3094 | time there might be events pending in the embedded loop. The callback |
1735 | call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke |
3095 | must then call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single |
1736 | their callbacks (you could also start an idle watcher to give the embedded |
3096 | sweep and invoke their callbacks (the callback doesn't need to invoke the |
1737 | loop strictly lower priority for example). You can also set the callback |
3097 | \&\f(CW\*(C`ev_embed_sweep\*(C'\fR function directly, it could also start an idle watcher |
1738 | to \f(CW0\fR, in which case the embed watcher will automatically execute the |
3098 | to give the embedded loop strictly lower priority for example). |
1739 | embedded loop sweep. |
|
|
1740 | .PP |
3099 | .PP |
1741 | As long as the watcher is started it will automatically handle events. The |
3100 | You can also set the callback to \f(CW0\fR, in which case the embed watcher |
1742 | callback will be invoked whenever some events have been handled. You can |
3101 | will automatically execute the embedded loop sweep whenever necessary. |
1743 | set the callback to \f(CW0\fR to avoid having to specify one if you are not |
|
|
1744 | interested in that. |
|
|
1745 | .PP |
3102 | .PP |
1746 | Also, there have not currently been made special provisions for forking: |
3103 | Fork detection will be handled transparently while the \f(CW\*(C`ev_embed\*(C'\fR watcher |
1747 | when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops, |
3104 | is active, i.e., the embedded loop will automatically be forked when the |
1748 | but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers |
3105 | embedding loop forks. In other cases, the user is responsible for calling |
1749 | yourself. |
3106 | \&\f(CW\*(C`ev_loop_fork\*(C'\fR on the embedded loop. |
1750 | .PP |
3107 | .PP |
1751 | Unfortunately, not all backends are embeddable, only the ones returned by |
3108 | Unfortunately, not all backends are embeddable: only the ones returned by |
1752 | \&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any |
3109 | \&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any |
1753 | portable one. |
3110 | portable one. |
1754 | .PP |
3111 | .PP |
1755 | So when you want to use this feature you will always have to be prepared |
3112 | So when you want to use this feature you will always have to be prepared |
1756 | that you cannot get an embeddable loop. The recommended way to get around |
3113 | that you cannot get an embeddable loop. The recommended way to get around |
1757 | this is to have a separate variables for your embeddable loop, try to |
3114 | this is to have a separate variables for your embeddable loop, try to |
1758 | create it, and if that fails, use the normal loop for everything: |
3115 | create it, and if that fails, use the normal loop for everything. |
1759 | .PP |
3116 | .PP |
1760 | .Vb 3 |
3117 | \fI\f(CI\*(C`ev_embed\*(C'\fI and fork\fR |
1761 | \& struct ev_loop *loop_hi = ev_default_init (0); |
3118 | .IX Subsection "ev_embed and fork" |
1762 | \& struct ev_loop *loop_lo = 0; |
|
|
1763 | \& struct ev_embed embed; |
|
|
1764 | .Ve |
|
|
1765 | .PP |
3119 | .PP |
1766 | .Vb 5 |
3120 | While the \f(CW\*(C`ev_embed\*(C'\fR watcher is running, forks in the embedding loop will |
1767 | \& // see if there is a chance of getting one that works |
3121 | automatically be applied to the embedded loop as well, so no special |
1768 | \& // (remember that a flags value of 0 means autodetection) |
3122 | fork handling is required in that case. When the watcher is not running, |
1769 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
3123 | however, it is still the task of the libev user to call \f(CW\*(C`ev_loop_fork ()\*(C'\fR |
1770 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
3124 | as applicable. |
1771 | \& : 0; |
|
|
1772 | .Ve |
|
|
1773 | .PP |
3125 | .PP |
1774 | .Vb 8 |
3126 | \fIWatcher-Specific Functions and Data Members\fR |
1775 | \& // if we got one, then embed it, otherwise default to loop_hi |
3127 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1776 | \& if (loop_lo) |
|
|
1777 | \& { |
|
|
1778 | \& ev_embed_init (&embed, 0, loop_lo); |
|
|
1779 | \& ev_embed_start (loop_hi, &embed); |
|
|
1780 | \& } |
|
|
1781 | \& else |
|
|
1782 | \& loop_lo = loop_hi; |
|
|
1783 | .Ve |
|
|
1784 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
3128 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1785 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
3129 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1786 | .PD 0 |
3130 | .PD 0 |
1787 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
3131 | .IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1788 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
3132 | .IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" |
1789 | .PD |
3133 | .PD |
1790 | Configures the watcher to embed the given loop, which must be |
3134 | Configures the watcher to embed the given loop, which must be |
1791 | embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be |
3135 | embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be |
1792 | invoked automatically, otherwise it is the responsibility of the callback |
3136 | invoked automatically, otherwise it is the responsibility of the callback |
1793 | to invoke it (it will continue to be called until the sweep has been done, |
3137 | to invoke it (it will continue to be called until the sweep has been done, |
1794 | if you do not want thta, you need to temporarily stop the embed watcher). |
3138 | if you do not want that, you need to temporarily stop the embed watcher). |
1795 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
3139 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
1796 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
3140 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
1797 | Make a single, non-blocking sweep over the embedded loop. This works |
3141 | Make a single, non-blocking sweep over the embedded loop. This works |
1798 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
3142 | similarly to \f(CW\*(C`ev_run (embedded_loop, EVRUN_NOWAIT)\*(C'\fR, but in the most |
1799 | apropriate way for embedded loops. |
3143 | appropriate way for embedded loops. |
1800 | .IP "struct ev_loop *loop [read\-only]" 4 |
3144 | .IP "struct ev_loop *other [read\-only]" 4 |
1801 | .IX Item "struct ev_loop *loop [read-only]" |
3145 | .IX Item "struct ev_loop *other [read-only]" |
1802 | The embedded event loop. |
3146 | The embedded event loop. |
|
|
3147 | .PP |
|
|
3148 | \fIExamples\fR |
|
|
3149 | .IX Subsection "Examples" |
|
|
3150 | .PP |
|
|
3151 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
3152 | event loop. If that is not possible, use the default loop. The default |
|
|
3153 | loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the embeddable loop is stored in |
|
|
3154 | \&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the case no embeddable loop can be |
|
|
3155 | used). |
|
|
3156 | .PP |
|
|
3157 | .Vb 3 |
|
|
3158 | \& struct ev_loop *loop_hi = ev_default_init (0); |
|
|
3159 | \& struct ev_loop *loop_lo = 0; |
|
|
3160 | \& ev_embed embed; |
|
|
3161 | \& |
|
|
3162 | \& // see if there is a chance of getting one that works |
|
|
3163 | \& // (remember that a flags value of 0 means autodetection) |
|
|
3164 | \& loop_lo = ev_embeddable_backends () & ev_recommended_backends () |
|
|
3165 | \& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) |
|
|
3166 | \& : 0; |
|
|
3167 | \& |
|
|
3168 | \& // if we got one, then embed it, otherwise default to loop_hi |
|
|
3169 | \& if (loop_lo) |
|
|
3170 | \& { |
|
|
3171 | \& ev_embed_init (&embed, 0, loop_lo); |
|
|
3172 | \& ev_embed_start (loop_hi, &embed); |
|
|
3173 | \& } |
|
|
3174 | \& else |
|
|
3175 | \& loop_lo = loop_hi; |
|
|
3176 | .Ve |
|
|
3177 | .PP |
|
|
3178 | Example: Check if kqueue is available but not recommended and create |
|
|
3179 | a kqueue backend for use with sockets (which usually work with any |
|
|
3180 | kqueue implementation). Store the kqueue/socket\-only event loop in |
|
|
3181 | \&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too). |
|
|
3182 | .PP |
|
|
3183 | .Vb 3 |
|
|
3184 | \& struct ev_loop *loop = ev_default_init (0); |
|
|
3185 | \& struct ev_loop *loop_socket = 0; |
|
|
3186 | \& ev_embed embed; |
|
|
3187 | \& |
|
|
3188 | \& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
3189 | \& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
3190 | \& { |
|
|
3191 | \& ev_embed_init (&embed, 0, loop_socket); |
|
|
3192 | \& ev_embed_start (loop, &embed); |
|
|
3193 | \& } |
|
|
3194 | \& |
|
|
3195 | \& if (!loop_socket) |
|
|
3196 | \& loop_socket = loop; |
|
|
3197 | \& |
|
|
3198 | \& // now use loop_socket for all sockets, and loop for everything else |
|
|
3199 | .Ve |
1803 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
3200 | .ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" |
1804 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
3201 | .el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
1805 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
3202 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
1806 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
3203 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
1807 | whoever is a good citizen cared to tell libev about it by calling |
3204 | whoever is a good citizen cared to tell libev about it by calling |
1808 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
3205 | \&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the |
1809 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
3206 | event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, |
1810 | and only in the child after the fork. If whoever good citizen calling |
3207 | and only in the child after the fork. If whoever good citizen calling |
1811 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
3208 | \&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork |
1812 | handlers will be invoked, too, of course. |
3209 | handlers will be invoked, too, of course. |
|
|
3210 | .PP |
|
|
3211 | \fIThe special problem of life after fork \- how is it possible?\fR |
|
|
3212 | .IX Subsection "The special problem of life after fork - how is it possible?" |
|
|
3213 | .PP |
|
|
3214 | Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set |
|
|
3215 | up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This |
|
|
3216 | sequence should be handled by libev without any problems. |
|
|
3217 | .PP |
|
|
3218 | This changes when the application actually wants to do event handling |
|
|
3219 | in the child, or both parent in child, in effect \*(L"continuing\*(R" after the |
|
|
3220 | fork. |
|
|
3221 | .PP |
|
|
3222 | The default mode of operation (for libev, with application help to detect |
|
|
3223 | forks) is to duplicate all the state in the child, as would be expected |
|
|
3224 | when \fIeither\fR the parent \fIor\fR the child process continues. |
|
|
3225 | .PP |
|
|
3226 | When both processes want to continue using libev, then this is usually the |
|
|
3227 | wrong result. In that case, usually one process (typically the parent) is |
|
|
3228 | supposed to continue with all watchers in place as before, while the other |
|
|
3229 | process typically wants to start fresh, i.e. without any active watchers. |
|
|
3230 | .PP |
|
|
3231 | The cleanest and most efficient way to achieve that with libev is to |
|
|
3232 | simply create a new event loop, which of course will be \*(L"empty\*(R", and |
|
|
3233 | use that for new watchers. This has the advantage of not touching more |
|
|
3234 | memory than necessary, and thus avoiding the copy-on-write, and the |
|
|
3235 | disadvantage of having to use multiple event loops (which do not support |
|
|
3236 | signal watchers). |
|
|
3237 | .PP |
|
|
3238 | When this is not possible, or you want to use the default loop for |
|
|
3239 | other reasons, then in the process that wants to start \*(L"fresh\*(R", call |
|
|
3240 | \&\f(CW\*(C`ev_loop_destroy (EV_DEFAULT)\*(C'\fR followed by \f(CW\*(C`ev_default_loop (...)\*(C'\fR. |
|
|
3241 | Destroying the default loop will \*(L"orphan\*(R" (not stop) all registered |
|
|
3242 | watchers, so you have to be careful not to execute code that modifies |
|
|
3243 | those watchers. Note also that in that case, you have to re-register any |
|
|
3244 | signal watchers. |
|
|
3245 | .PP |
|
|
3246 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
3247 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1813 | .IP "ev_fork_init (ev_signal *, callback)" 4 |
3248 | .IP "ev_fork_init (ev_fork *, callback)" 4 |
1814 | .IX Item "ev_fork_init (ev_signal *, callback)" |
3249 | .IX Item "ev_fork_init (ev_fork *, callback)" |
1815 | Initialises and configures the fork watcher \- it has no parameters of any |
3250 | Initialises and configures the fork watcher \- it has no parameters of any |
1816 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
3251 | kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, |
1817 | believe me. |
3252 | really. |
|
|
3253 | .ie n .SS """ev_cleanup"" \- even the best things end" |
|
|
3254 | .el .SS "\f(CWev_cleanup\fP \- even the best things end" |
|
|
3255 | .IX Subsection "ev_cleanup - even the best things end" |
|
|
3256 | Cleanup watchers are called just before the event loop is being destroyed |
|
|
3257 | by a call to \f(CW\*(C`ev_loop_destroy\*(C'\fR. |
|
|
3258 | .PP |
|
|
3259 | While there is no guarantee that the event loop gets destroyed, cleanup |
|
|
3260 | watchers provide a convenient method to install cleanup hooks for your |
|
|
3261 | program, worker threads and so on \- you just to make sure to destroy the |
|
|
3262 | loop when you want them to be invoked. |
|
|
3263 | .PP |
|
|
3264 | Cleanup watchers are invoked in the same way as any other watcher. Unlike |
|
|
3265 | all other watchers, they do not keep a reference to the event loop (which |
|
|
3266 | makes a lot of sense if you think about it). Like all other watchers, you |
|
|
3267 | can call libev functions in the callback, except \f(CW\*(C`ev_cleanup_start\*(C'\fR. |
|
|
3268 | .PP |
|
|
3269 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
3270 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
3271 | .IP "ev_cleanup_init (ev_cleanup *, callback)" 4 |
|
|
3272 | .IX Item "ev_cleanup_init (ev_cleanup *, callback)" |
|
|
3273 | Initialises and configures the cleanup watcher \- it has no parameters of |
|
|
3274 | any kind. There is a \f(CW\*(C`ev_cleanup_set\*(C'\fR macro, but using it is utterly |
|
|
3275 | pointless, I assure you. |
|
|
3276 | .PP |
|
|
3277 | Example: Register an atexit handler to destroy the default loop, so any |
|
|
3278 | cleanup functions are called. |
|
|
3279 | .PP |
|
|
3280 | .Vb 5 |
|
|
3281 | \& static void |
|
|
3282 | \& program_exits (void) |
|
|
3283 | \& { |
|
|
3284 | \& ev_loop_destroy (EV_DEFAULT_UC); |
|
|
3285 | \& } |
|
|
3286 | \& |
|
|
3287 | \& ... |
|
|
3288 | \& atexit (program_exits); |
|
|
3289 | .Ve |
|
|
3290 | .ie n .SS """ev_async"" \- how to wake up an event loop" |
|
|
3291 | .el .SS "\f(CWev_async\fP \- how to wake up an event loop" |
|
|
3292 | .IX Subsection "ev_async - how to wake up an event loop" |
|
|
3293 | In general, you cannot use an \f(CW\*(C`ev_run\*(C'\fR from multiple threads or other |
|
|
3294 | asynchronous sources such as signal handlers (as opposed to multiple event |
|
|
3295 | loops \- those are of course safe to use in different threads). |
|
|
3296 | .PP |
|
|
3297 | Sometimes, however, you need to wake up an event loop you do not control, |
|
|
3298 | for example because it belongs to another thread. This is what \f(CW\*(C`ev_async\*(C'\fR |
|
|
3299 | watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you can signal |
|
|
3300 | it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe. |
|
|
3301 | .PP |
|
|
3302 | This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, |
|
|
3303 | too, are asynchronous in nature, and signals, too, will be compressed |
|
|
3304 | (i.e. the number of callback invocations may be less than the number of |
|
|
3305 | \&\f(CW\*(C`ev_async_sent\*(C'\fR calls). |
|
|
3306 | .PP |
|
|
3307 | Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not |
|
|
3308 | just the default loop. |
|
|
3309 | .PP |
|
|
3310 | \fIQueueing\fR |
|
|
3311 | .IX Subsection "Queueing" |
|
|
3312 | .PP |
|
|
3313 | \&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason |
|
|
3314 | is that the author does not know of a simple (or any) algorithm for a |
|
|
3315 | multiple-writer-single-reader queue that works in all cases and doesn't |
|
|
3316 | need elaborate support such as pthreads or unportable memory access |
|
|
3317 | semantics. |
|
|
3318 | .PP |
|
|
3319 | That means that if you want to queue data, you have to provide your own |
|
|
3320 | queue. But at least I can tell you how to implement locking around your |
|
|
3321 | queue: |
|
|
3322 | .IP "queueing from a signal handler context" 4 |
|
|
3323 | .IX Item "queueing from a signal handler context" |
|
|
3324 | To implement race-free queueing, you simply add to the queue in the signal |
|
|
3325 | handler but you block the signal handler in the watcher callback. Here is |
|
|
3326 | an example that does that for some fictitious \s-1SIGUSR1\s0 handler: |
|
|
3327 | .Sp |
|
|
3328 | .Vb 1 |
|
|
3329 | \& static ev_async mysig; |
|
|
3330 | \& |
|
|
3331 | \& static void |
|
|
3332 | \& sigusr1_handler (void) |
|
|
3333 | \& { |
|
|
3334 | \& sometype data; |
|
|
3335 | \& |
|
|
3336 | \& // no locking etc. |
|
|
3337 | \& queue_put (data); |
|
|
3338 | \& ev_async_send (EV_DEFAULT_ &mysig); |
|
|
3339 | \& } |
|
|
3340 | \& |
|
|
3341 | \& static void |
|
|
3342 | \& mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
3343 | \& { |
|
|
3344 | \& sometype data; |
|
|
3345 | \& sigset_t block, prev; |
|
|
3346 | \& |
|
|
3347 | \& sigemptyset (&block); |
|
|
3348 | \& sigaddset (&block, SIGUSR1); |
|
|
3349 | \& sigprocmask (SIG_BLOCK, &block, &prev); |
|
|
3350 | \& |
|
|
3351 | \& while (queue_get (&data)) |
|
|
3352 | \& process (data); |
|
|
3353 | \& |
|
|
3354 | \& if (sigismember (&prev, SIGUSR1) |
|
|
3355 | \& sigprocmask (SIG_UNBLOCK, &block, 0); |
|
|
3356 | \& } |
|
|
3357 | .Ve |
|
|
3358 | .Sp |
|
|
3359 | (Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR |
|
|
3360 | instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it |
|
|
3361 | either...). |
|
|
3362 | .IP "queueing from a thread context" 4 |
|
|
3363 | .IX Item "queueing from a thread context" |
|
|
3364 | The strategy for threads is different, as you cannot (easily) block |
|
|
3365 | threads but you can easily preempt them, so to queue safely you need to |
|
|
3366 | employ a traditional mutex lock, such as in this pthread example: |
|
|
3367 | .Sp |
|
|
3368 | .Vb 2 |
|
|
3369 | \& static ev_async mysig; |
|
|
3370 | \& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER; |
|
|
3371 | \& |
|
|
3372 | \& static void |
|
|
3373 | \& otherthread (void) |
|
|
3374 | \& { |
|
|
3375 | \& // only need to lock the actual queueing operation |
|
|
3376 | \& pthread_mutex_lock (&mymutex); |
|
|
3377 | \& queue_put (data); |
|
|
3378 | \& pthread_mutex_unlock (&mymutex); |
|
|
3379 | \& |
|
|
3380 | \& ev_async_send (EV_DEFAULT_ &mysig); |
|
|
3381 | \& } |
|
|
3382 | \& |
|
|
3383 | \& static void |
|
|
3384 | \& mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
3385 | \& { |
|
|
3386 | \& pthread_mutex_lock (&mymutex); |
|
|
3387 | \& |
|
|
3388 | \& while (queue_get (&data)) |
|
|
3389 | \& process (data); |
|
|
3390 | \& |
|
|
3391 | \& pthread_mutex_unlock (&mymutex); |
|
|
3392 | \& } |
|
|
3393 | .Ve |
|
|
3394 | .PP |
|
|
3395 | \fIWatcher-Specific Functions and Data Members\fR |
|
|
3396 | .IX Subsection "Watcher-Specific Functions and Data Members" |
|
|
3397 | .IP "ev_async_init (ev_async *, callback)" 4 |
|
|
3398 | .IX Item "ev_async_init (ev_async *, callback)" |
|
|
3399 | Initialises and configures the async watcher \- it has no parameters of any |
|
|
3400 | kind. There is a \f(CW\*(C`ev_async_set\*(C'\fR macro, but using it is utterly pointless, |
|
|
3401 | trust me. |
|
|
3402 | .IP "ev_async_send (loop, ev_async *)" 4 |
|
|
3403 | .IX Item "ev_async_send (loop, ev_async *)" |
|
|
3404 | Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds |
|
|
3405 | an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike |
|
|
3406 | \&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do from other threads, signal or |
|
|
3407 | similar contexts (see the discussion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding |
|
|
3408 | section below on what exactly this means). |
|
|
3409 | .Sp |
|
|
3410 | Note that, as with other watchers in libev, multiple events might get |
|
|
3411 | compressed into a single callback invocation (another way to look at this |
|
|
3412 | is that \f(CW\*(C`ev_async\*(C'\fR watchers are level-triggered, set on \f(CW\*(C`ev_async_send\*(C'\fR, |
|
|
3413 | reset when the event loop detects that). |
|
|
3414 | .Sp |
|
|
3415 | This call incurs the overhead of a system call only once per event loop |
|
|
3416 | iteration, so while the overhead might be noticeable, it doesn't apply to |
|
|
3417 | repeated calls to \f(CW\*(C`ev_async_send\*(C'\fR for the same event loop. |
|
|
3418 | .IP "bool = ev_async_pending (ev_async *)" 4 |
|
|
3419 | .IX Item "bool = ev_async_pending (ev_async *)" |
|
|
3420 | Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the |
|
|
3421 | watcher but the event has not yet been processed (or even noted) by the |
|
|
3422 | event loop. |
|
|
3423 | .Sp |
|
|
3424 | \&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When |
|
|
3425 | the loop iterates next and checks for the watcher to have become active, |
|
|
3426 | it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very |
|
|
3427 | quickly check whether invoking the loop might be a good idea. |
|
|
3428 | .Sp |
|
|
3429 | Not that this does \fInot\fR check whether the watcher itself is pending, |
|
|
3430 | only whether it has been requested to make this watcher pending: there |
|
|
3431 | is a time window between the event loop checking and resetting the async |
|
|
3432 | notification, and the callback being invoked. |
1818 | .SH "OTHER FUNCTIONS" |
3433 | .SH "OTHER FUNCTIONS" |
1819 | .IX Header "OTHER FUNCTIONS" |
3434 | .IX Header "OTHER FUNCTIONS" |
1820 | There are some other functions of possible interest. Described. Here. Now. |
3435 | There are some other functions of possible interest. Described. Here. Now. |
1821 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
3436 | .IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 |
1822 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
3437 | .IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" |
1823 | This function combines a simple timer and an I/O watcher, calls your |
3438 | This function combines a simple timer and an I/O watcher, calls your |
1824 | callback on whichever event happens first and automatically stop both |
3439 | callback on whichever event happens first and automatically stops both |
1825 | watchers. This is useful if you want to wait for a single event on an fd |
3440 | watchers. This is useful if you want to wait for a single event on an fd |
1826 | or timeout without having to allocate/configure/start/stop/free one or |
3441 | or timeout without having to allocate/configure/start/stop/free one or |
1827 | more watchers yourself. |
3442 | more watchers yourself. |
1828 | .Sp |
3443 | .Sp |
1829 | If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and events |
3444 | If \f(CW\*(C`fd\*(C'\fR is less than 0, then no I/O watcher will be started and the |
1830 | is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for the given \f(CW\*(C`fd\*(C'\fR and |
3445 | \&\f(CW\*(C`events\*(C'\fR argument is being ignored. Otherwise, an \f(CW\*(C`ev_io\*(C'\fR watcher for |
1831 | \&\f(CW\*(C`events\*(C'\fR set will be craeted and started. |
3446 | the given \f(CW\*(C`fd\*(C'\fR and \f(CW\*(C`events\*(C'\fR set will be created and started. |
1832 | .Sp |
3447 | .Sp |
1833 | If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be |
3448 | If \f(CW\*(C`timeout\*(C'\fR is less than 0, then no timeout watcher will be |
1834 | started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and |
3449 | started. Otherwise an \f(CW\*(C`ev_timer\*(C'\fR watcher with after = \f(CW\*(C`timeout\*(C'\fR (and |
1835 | repeat = 0) will be started. While \f(CW0\fR is a valid timeout, it is of |
3450 | repeat = 0) will be started. \f(CW0\fR is a valid timeout. |
1836 | dubious value. |
|
|
1837 | .Sp |
3451 | .Sp |
1838 | The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and gets |
3452 | The callback has the type \f(CW\*(C`void (*cb)(int revents, void *arg)\*(C'\fR and is |
1839 | passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of |
3453 | passed an \f(CW\*(C`revents\*(C'\fR set like normal event callbacks (a combination of |
1840 | \&\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 |
3454 | \&\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_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR |
1841 | value passed to \f(CW\*(C`ev_once\*(C'\fR: |
3455 | value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR |
|
|
3456 | a timeout and an io event at the same time \- you probably should give io |
|
|
3457 | events precedence. |
|
|
3458 | .Sp |
|
|
3459 | Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. |
1842 | .Sp |
3460 | .Sp |
1843 | .Vb 7 |
3461 | .Vb 7 |
1844 | \& static void stdin_ready (int revents, void *arg) |
3462 | \& static void stdin_ready (int revents, void *arg) |
1845 | \& { |
3463 | \& { |
1846 | \& if (revents & EV_TIMEOUT) |
|
|
1847 | \& /* doh, nothing entered */; |
|
|
1848 | \& else if (revents & EV_READ) |
3464 | \& if (revents & EV_READ) |
1849 | \& /* stdin might have data for us, joy! */; |
3465 | \& /* stdin might have data for us, joy! */; |
|
|
3466 | \& else if (revents & EV_TIMER) |
|
|
3467 | \& /* doh, nothing entered */; |
1850 | \& } |
3468 | \& } |
1851 | .Ve |
3469 | \& |
1852 | .Sp |
|
|
1853 | .Vb 1 |
|
|
1854 | \& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3470 | \& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
1855 | .Ve |
3471 | .Ve |
1856 | .IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 |
|
|
1857 | .IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" |
|
|
1858 | Feeds the given event set into the event loop, as if the specified event |
|
|
1859 | had happened for the specified watcher (which must be a pointer to an |
|
|
1860 | initialised but not necessarily started event watcher). |
|
|
1861 | .IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4 |
3472 | .IP "ev_feed_fd_event (loop, int fd, int revents)" 4 |
1862 | .IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)" |
3473 | .IX Item "ev_feed_fd_event (loop, int fd, int revents)" |
1863 | Feed an event on the given fd, as if a file descriptor backend detected |
3474 | Feed an event on the given fd, as if a file descriptor backend detected |
1864 | the given events it. |
3475 | the given events it. |
1865 | .IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4 |
3476 | .IP "ev_feed_signal_event (loop, int signum)" 4 |
1866 | .IX Item "ev_feed_signal_event (ev_loop *loop, int signum)" |
3477 | .IX Item "ev_feed_signal_event (loop, int signum)" |
1867 | Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default |
3478 | Feed an event as if the given signal occurred (\f(CW\*(C`loop\*(C'\fR must be the default |
1868 | loop!). |
3479 | loop!). |
1869 | .SH "LIBEVENT EMULATION" |
3480 | .SH "LIBEVENT EMULATION" |
1870 | .IX Header "LIBEVENT EMULATION" |
3481 | .IX Header "LIBEVENT EMULATION" |
1871 | Libev offers a compatibility emulation layer for libevent. It cannot |
3482 | Libev offers a compatibility emulation layer for libevent. It cannot |
1872 | emulate the internals of libevent, so here are some usage hints: |
3483 | emulate the internals of libevent, so here are some usage hints: |
|
|
3484 | .IP "\(bu" 4 |
1873 | .IP "* Use it by including <event.h>, as usual." 4 |
3485 | Use it by including <event.h>, as usual. |
1874 | .IX Item "Use it by including <event.h>, as usual." |
3486 | .IP "\(bu" 4 |
1875 | .PD 0 |
3487 | The following members are fully supported: ev_base, ev_callback, |
1876 | .IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 |
3488 | ev_arg, ev_fd, ev_res, ev_events. |
1877 | .IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." |
3489 | .IP "\(bu" 4 |
1878 | .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 |
3490 | Avoid using ev_flags and the EVLIST_*\-macros, while it is |
1879 | .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)." |
3491 | maintained by libev, it does not work exactly the same way as in libevent (consider |
1880 | .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 |
3492 | it a private \s-1API\s0). |
1881 | .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." |
3493 | .IP "\(bu" 4 |
|
|
3494 | Priorities are not currently supported. Initialising priorities |
|
|
3495 | will fail and all watchers will have the same priority, even though there |
|
|
3496 | is an ev_pri field. |
|
|
3497 | .IP "\(bu" 4 |
|
|
3498 | In libevent, the last base created gets the signals, in libev, the |
|
|
3499 | first base created (== the default loop) gets the signals. |
|
|
3500 | .IP "\(bu" 4 |
1882 | .IP "* Other members are not supported." 4 |
3501 | Other members are not supported. |
1883 | .IX Item "Other members are not supported." |
3502 | .IP "\(bu" 4 |
1884 | .IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 |
3503 | The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need |
1885 | .IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." |
3504 | to use the libev header file and library. |
1886 | .PD |
|
|
1887 | .SH "\*(C+ SUPPORT" |
3505 | .SH "\*(C+ SUPPORT" |
1888 | .IX Header " SUPPORT" |
3506 | .IX Header " SUPPORT" |
1889 | Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow |
3507 | Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow |
1890 | you to use some convinience methods to start/stop watchers and also change |
3508 | you to use some convenience methods to start/stop watchers and also change |
1891 | the callback model to a model using method callbacks on objects. |
3509 | the callback model to a model using method callbacks on objects. |
1892 | .PP |
3510 | .PP |
1893 | To use it, |
3511 | To use it, |
1894 | .PP |
3512 | .PP |
1895 | .Vb 1 |
3513 | .Vb 1 |
1896 | \& #include <ev++.h> |
3514 | \& #include <ev++.h> |
1897 | .Ve |
3515 | .Ve |
1898 | .PP |
3516 | .PP |
1899 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
3517 | This automatically includes \fIev.h\fR and puts all of its definitions (many |
1900 | of them macros) into the global namespace. All \*(C+ specific things are |
3518 | of them macros) into the global namespace. All \*(C+ specific things are |
1901 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
3519 | put into the \f(CW\*(C`ev\*(C'\fR namespace. It should support all the same embedding |
1902 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
3520 | options as \fIev.h\fR, most notably \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. |
1903 | .PP |
3521 | .PP |
1904 | Care has been taken to keep the overhead low. The only data member added |
3522 | Care has been taken to keep the overhead low. The only data member the \*(C+ |
1905 | to the C\-style watchers is the event loop the watcher is associated with |
3523 | classes add (compared to plain C\-style watchers) is the event loop pointer |
1906 | (or no additional members at all if you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when |
3524 | that the watcher is associated with (or no additional members at all if |
1907 | embedding libev). |
3525 | you disable \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR when embedding libev). |
1908 | .PP |
3526 | .PP |
1909 | Currently, functions and static and non-static member functions can be |
3527 | Currently, functions, and static and non-static member functions can be |
1910 | used as callbacks. Other types should be easy to add as long as they only |
3528 | used as callbacks. Other types should be easy to add as long as they only |
1911 | need one additional pointer for context. If you need support for other |
3529 | need one additional pointer for context. If you need support for other |
1912 | types of functors please contact the author (preferably after implementing |
3530 | types of functors please contact the author (preferably after implementing |
1913 | it). |
3531 | it). |
1914 | .PP |
3532 | .PP |
1915 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
3533 | Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: |
1916 | .ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4 |
3534 | .ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 |
1917 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
3535 | .el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 |
1918 | .IX Item "ev::READ, ev::WRITE etc." |
3536 | .IX Item "ev::READ, ev::WRITE etc." |
1919 | These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. |
3537 | These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc. |
1920 | macros from \fIev.h\fR. |
3538 | macros from \fIev.h\fR. |
1921 | .ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4 |
3539 | .ie n .IP """ev::tstamp"", ""ev::now""" 4 |
1922 | .el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 |
3540 | .el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4 |
1923 | .IX Item "ev::tstamp, ev::now" |
3541 | .IX Item "ev::tstamp, ev::now" |
1924 | Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. |
3542 | Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix. |
1925 | .ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4 |
3543 | .ie n .IP """ev::io"", ""ev::timer"", ""ev::periodic"", ""ev::idle"", ""ev::sig"" etc." 4 |
1926 | .el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 |
3544 | .el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4 |
1927 | .IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." |
3545 | .IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc." |
1928 | For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of |
3546 | For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of |
1929 | the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR |
3547 | the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR |
1930 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
3548 | which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro |
… | |
… | |
1933 | All of those classes have these methods: |
3551 | All of those classes have these methods: |
1934 | .RS 4 |
3552 | .RS 4 |
1935 | .IP "ev::TYPE::TYPE ()" 4 |
3553 | .IP "ev::TYPE::TYPE ()" 4 |
1936 | .IX Item "ev::TYPE::TYPE ()" |
3554 | .IX Item "ev::TYPE::TYPE ()" |
1937 | .PD 0 |
3555 | .PD 0 |
1938 | .IP "ev::TYPE::TYPE (struct ev_loop *)" 4 |
3556 | .IP "ev::TYPE::TYPE (loop)" 4 |
1939 | .IX Item "ev::TYPE::TYPE (struct ev_loop *)" |
3557 | .IX Item "ev::TYPE::TYPE (loop)" |
1940 | .IP "ev::TYPE::~TYPE" 4 |
3558 | .IP "ev::TYPE::~TYPE" 4 |
1941 | .IX Item "ev::TYPE::~TYPE" |
3559 | .IX Item "ev::TYPE::~TYPE" |
1942 | .PD |
3560 | .PD |
1943 | The constructor (optionally) takes an event loop to associate the watcher |
3561 | The constructor (optionally) takes an event loop to associate the watcher |
1944 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
3562 | with. If it is omitted, it will use \f(CW\*(C`EV_DEFAULT\*(C'\fR. |
… | |
… | |
1967 | thunking function, making it as fast as a direct C callback. |
3585 | thunking function, making it as fast as a direct C callback. |
1968 | .Sp |
3586 | .Sp |
1969 | Example: simple class declaration and watcher initialisation |
3587 | Example: simple class declaration and watcher initialisation |
1970 | .Sp |
3588 | .Sp |
1971 | .Vb 4 |
3589 | .Vb 4 |
1972 | \& struct myclass |
3590 | \& struct myclass |
1973 | \& { |
3591 | \& { |
1974 | \& void io_cb (ev::io &w, int revents) { } |
3592 | \& void io_cb (ev::io &w, int revents) { } |
1975 | \& } |
3593 | \& } |
1976 | .Ve |
3594 | \& |
1977 | .Sp |
|
|
1978 | .Vb 3 |
|
|
1979 | \& myclass obj; |
3595 | \& myclass obj; |
1980 | \& ev::io iow; |
3596 | \& ev::io iow; |
1981 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
3597 | \& iow.set <myclass, &myclass::io_cb> (&obj); |
1982 | .Ve |
3598 | .Ve |
1983 | .IP "w\->set (void (*function)(watcher &w, int), void *data = 0)" 4 |
3599 | .IP "w\->set (object *)" 4 |
1984 | .IX Item "w->set (void (*function)(watcher &w, int), void *data = 0)" |
3600 | .IX Item "w->set (object *)" |
|
|
3601 | This is a variation of a method callback \- leaving out the method to call |
|
|
3602 | will default the method to \f(CW\*(C`operator ()\*(C'\fR, which makes it possible to use |
|
|
3603 | functor objects without having to manually specify the \f(CW\*(C`operator ()\*(C'\fR all |
|
|
3604 | the time. Incidentally, you can then also leave out the template argument |
|
|
3605 | list. |
|
|
3606 | .Sp |
|
|
3607 | The \f(CW\*(C`operator ()\*(C'\fR method prototype must be \f(CW\*(C`void operator ()(watcher &w, |
|
|
3608 | int revents)\*(C'\fR. |
|
|
3609 | .Sp |
|
|
3610 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
3611 | .Sp |
|
|
3612 | Example: use a functor object as callback. |
|
|
3613 | .Sp |
|
|
3614 | .Vb 7 |
|
|
3615 | \& struct myfunctor |
|
|
3616 | \& { |
|
|
3617 | \& void operator() (ev::io &w, int revents) |
|
|
3618 | \& { |
|
|
3619 | \& ... |
|
|
3620 | \& } |
|
|
3621 | \& } |
|
|
3622 | \& |
|
|
3623 | \& myfunctor f; |
|
|
3624 | \& |
|
|
3625 | \& ev::io w; |
|
|
3626 | \& w.set (&f); |
|
|
3627 | .Ve |
|
|
3628 | .IP "w\->set<function> (void *data = 0)" 4 |
|
|
3629 | .IX Item "w->set<function> (void *data = 0)" |
1985 | Also sets a callback, but uses a static method or plain function as |
3630 | Also sets a callback, but uses a static method or plain function as |
1986 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
3631 | callback. The optional \f(CW\*(C`data\*(C'\fR argument will be stored in the watcher's |
1987 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
3632 | \&\f(CW\*(C`data\*(C'\fR member and is free for you to use. |
1988 | .Sp |
3633 | .Sp |
|
|
3634 | The prototype of the \f(CW\*(C`function\*(C'\fR must be \f(CW\*(C`void (*)(ev::TYPE &w, int)\*(C'\fR. |
|
|
3635 | .Sp |
1989 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
3636 | See the method\-\f(CW\*(C`set\*(C'\fR above for more details. |
|
|
3637 | .Sp |
|
|
3638 | Example: Use a plain function as callback. |
|
|
3639 | .Sp |
|
|
3640 | .Vb 2 |
|
|
3641 | \& static void io_cb (ev::io &w, int revents) { } |
|
|
3642 | \& iow.set <io_cb> (); |
|
|
3643 | .Ve |
1990 | .IP "w\->set (struct ev_loop *)" 4 |
3644 | .IP "w\->set (loop)" 4 |
1991 | .IX Item "w->set (struct ev_loop *)" |
3645 | .IX Item "w->set (loop)" |
1992 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
3646 | Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only |
1993 | do this when the watcher is inactive (and not pending either). |
3647 | do this when the watcher is inactive (and not pending either). |
1994 | .IP "w\->set ([args])" 4 |
3648 | .IP "w\->set ([arguments])" 4 |
1995 | .IX Item "w->set ([args])" |
3649 | .IX Item "w->set ([arguments])" |
1996 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be |
3650 | Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this |
1997 | called at least once. Unlike the C counterpart, an active watcher gets |
3651 | method or a suitable start method must be called at least once. Unlike the |
1998 | automatically stopped and restarted when reconfiguring it with this |
3652 | C counterpart, an active watcher gets automatically stopped and restarted |
1999 | method. |
3653 | when reconfiguring it with this method. |
2000 | .IP "w\->start ()" 4 |
3654 | .IP "w\->start ()" 4 |
2001 | .IX Item "w->start ()" |
3655 | .IX Item "w->start ()" |
2002 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
3656 | Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the |
2003 | constructor already stores the event loop. |
3657 | constructor already stores the event loop. |
|
|
3658 | .IP "w\->start ([arguments])" 4 |
|
|
3659 | .IX Item "w->start ([arguments])" |
|
|
3660 | Instead of calling \f(CW\*(C`set\*(C'\fR and \f(CW\*(C`start\*(C'\fR methods separately, it is often |
|
|
3661 | convenient to wrap them in one call. Uses the same type of arguments as |
|
|
3662 | the configure \f(CW\*(C`set\*(C'\fR method of the watcher. |
2004 | .IP "w\->stop ()" 4 |
3663 | .IP "w\->stop ()" 4 |
2005 | .IX Item "w->stop ()" |
3664 | .IX Item "w->stop ()" |
2006 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
3665 | Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument. |
2007 | .ie n .IP "w\->again () ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4 |
3666 | .ie n .IP "w\->again () (""ev::timer"", ""ev::periodic"" only)" 4 |
2008 | .el .IP "w\->again () \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4 |
3667 | .el .IP "w\->again () (\f(CWev::timer\fR, \f(CWev::periodic\fR only)" 4 |
2009 | .IX Item "w->again () ev::timer, ev::periodic only" |
3668 | .IX Item "w->again () (ev::timer, ev::periodic only)" |
2010 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
3669 | For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding |
2011 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
3670 | \&\f(CW\*(C`ev_TYPE_again\*(C'\fR function. |
2012 | .ie n .IP "w\->sweep () ""ev::embed"" only" 4 |
3671 | .ie n .IP "w\->sweep () (""ev::embed"" only)" 4 |
2013 | .el .IP "w\->sweep () \f(CWev::embed\fR only" 4 |
3672 | .el .IP "w\->sweep () (\f(CWev::embed\fR only)" 4 |
2014 | .IX Item "w->sweep () ev::embed only" |
3673 | .IX Item "w->sweep () (ev::embed only)" |
2015 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
3674 | Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR. |
2016 | .ie n .IP "w\->update () ""ev::stat"" only" 4 |
3675 | .ie n .IP "w\->update () (""ev::stat"" only)" 4 |
2017 | .el .IP "w\->update () \f(CWev::stat\fR only" 4 |
3676 | .el .IP "w\->update () (\f(CWev::stat\fR only)" 4 |
2018 | .IX Item "w->update () ev::stat only" |
3677 | .IX Item "w->update () (ev::stat only)" |
2019 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
3678 | Invokes \f(CW\*(C`ev_stat_stat\*(C'\fR. |
2020 | .RE |
3679 | .RE |
2021 | .RS 4 |
3680 | .RS 4 |
2022 | .RE |
3681 | .RE |
2023 | .PP |
3682 | .PP |
2024 | Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in |
3683 | Example: Define a class with two I/O and idle watchers, start the I/O |
2025 | the constructor. |
3684 | watchers in the constructor. |
2026 | .PP |
3685 | .PP |
2027 | .Vb 4 |
3686 | .Vb 5 |
2028 | \& class myclass |
3687 | \& class myclass |
2029 | \& { |
3688 | \& { |
2030 | \& ev_io io; void io_cb (ev::io &w, int revents); |
3689 | \& ev::io io ; void io_cb (ev::io &w, int revents); |
|
|
3690 | \& ev::io2 io2 ; void io2_cb (ev::io &w, int revents); |
2031 | \& ev_idle idle void idle_cb (ev::idle &w, int revents); |
3691 | \& ev::idle idle; void idle_cb (ev::idle &w, int revents); |
2032 | .Ve |
3692 | \& |
2033 | .PP |
|
|
2034 | .Vb 2 |
|
|
2035 | \& myclass (); |
3693 | \& myclass (int fd) |
2036 | \& } |
|
|
2037 | .Ve |
|
|
2038 | .PP |
|
|
2039 | .Vb 4 |
|
|
2040 | \& myclass::myclass (int fd) |
|
|
2041 | \& { |
3694 | \& { |
2042 | \& io .set <myclass, &myclass::io_cb > (this); |
3695 | \& io .set <myclass, &myclass::io_cb > (this); |
|
|
3696 | \& io2 .set <myclass, &myclass::io2_cb > (this); |
2043 | \& idle.set <myclass, &myclass::idle_cb> (this); |
3697 | \& idle.set <myclass, &myclass::idle_cb> (this); |
2044 | .Ve |
3698 | \& |
2045 | .PP |
3699 | \& io.set (fd, ev::WRITE); // configure the watcher |
2046 | .Vb 2 |
3700 | \& io.start (); // start it whenever convenient |
2047 | \& io.start (fd, ev::READ); |
3701 | \& |
|
|
3702 | \& io2.start (fd, ev::READ); // set + start in one call |
|
|
3703 | \& } |
2048 | \& } |
3704 | \& }; |
2049 | .Ve |
3705 | .Ve |
|
|
3706 | .SH "OTHER LANGUAGE BINDINGS" |
|
|
3707 | .IX Header "OTHER LANGUAGE BINDINGS" |
|
|
3708 | Libev does not offer other language bindings itself, but bindings for a |
|
|
3709 | number of languages exist in the form of third-party packages. If you know |
|
|
3710 | any interesting language binding in addition to the ones listed here, drop |
|
|
3711 | me a note. |
|
|
3712 | .IP "Perl" 4 |
|
|
3713 | .IX Item "Perl" |
|
|
3714 | The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test |
|
|
3715 | libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module, |
|
|
3716 | there are additional modules that implement libev-compatible interfaces |
|
|
3717 | 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), |
|
|
3718 | \&\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 |
|
|
3719 | and \f(CW\*(C`EV::Glib\*(C'\fR). |
|
|
3720 | .Sp |
|
|
3721 | It can be found and installed via \s-1CPAN\s0, its homepage is at |
|
|
3722 | <http://software.schmorp.de/pkg/EV>. |
|
|
3723 | .IP "Python" 4 |
|
|
3724 | .IX Item "Python" |
|
|
3725 | Python bindings can be found at <http://code.google.com/p/pyev/>. It |
|
|
3726 | seems to be quite complete and well-documented. |
|
|
3727 | .IP "Ruby" 4 |
|
|
3728 | .IX Item "Ruby" |
|
|
3729 | Tony Arcieri has written a ruby extension that offers access to a subset |
|
|
3730 | of the libev \s-1API\s0 and adds file handle abstractions, asynchronous \s-1DNS\s0 and |
|
|
3731 | more on top of it. It can be found via gem servers. Its homepage is at |
|
|
3732 | <http://rev.rubyforge.org/>. |
|
|
3733 | .Sp |
|
|
3734 | Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR |
|
|
3735 | makes rev work even on mingw. |
|
|
3736 | .IP "Haskell" 4 |
|
|
3737 | .IX Item "Haskell" |
|
|
3738 | A haskell binding to libev is available at |
|
|
3739 | <http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>. |
|
|
3740 | .IP "D" 4 |
|
|
3741 | .IX Item "D" |
|
|
3742 | Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to |
|
|
3743 | be found at <http://proj.llucax.com.ar/wiki/evd>. |
|
|
3744 | .IP "Ocaml" 4 |
|
|
3745 | .IX Item "Ocaml" |
|
|
3746 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
|
|
3747 | <http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>. |
|
|
3748 | .IP "Lua" 4 |
|
|
3749 | .IX Item "Lua" |
|
|
3750 | Brian Maher has written a partial interface to libev for lua (at the |
|
|
3751 | time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at |
|
|
3752 | <http://github.com/brimworks/lua\-ev>. |
2050 | .SH "MACRO MAGIC" |
3753 | .SH "MACRO MAGIC" |
2051 | .IX Header "MACRO MAGIC" |
3754 | .IX Header "MACRO MAGIC" |
2052 | Libev can be compiled with a variety of options, the most fundemantal is |
3755 | Libev can be compiled with a variety of options, the most fundamental |
2053 | \&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) functions and |
3756 | of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) |
2054 | callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
3757 | functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. |
2055 | .PP |
3758 | .PP |
2056 | To make it easier to write programs that cope with either variant, the |
3759 | To make it easier to write programs that cope with either variant, the |
2057 | following macros are defined: |
3760 | following macros are defined: |
2058 | .ie n .IP """EV_A""\fR, \f(CW""EV_A_""" 4 |
3761 | .ie n .IP """EV_A"", ""EV_A_""" 4 |
2059 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
3762 | .el .IP "\f(CWEV_A\fR, \f(CWEV_A_\fR" 4 |
2060 | .IX Item "EV_A, EV_A_" |
3763 | .IX Item "EV_A, EV_A_" |
2061 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
3764 | This provides the loop \fIargument\fR for functions, if one is required (\*(L"ev |
2062 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
3765 | loop argument\*(R"). The \f(CW\*(C`EV_A\*(C'\fR form is used when this is the sole argument, |
2063 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
3766 | \&\f(CW\*(C`EV_A_\*(C'\fR is used when other arguments are following. Example: |
2064 | .Sp |
3767 | .Sp |
2065 | .Vb 3 |
3768 | .Vb 3 |
2066 | \& ev_unref (EV_A); |
3769 | \& ev_unref (EV_A); |
2067 | \& ev_timer_add (EV_A_ watcher); |
3770 | \& ev_timer_add (EV_A_ watcher); |
2068 | \& ev_loop (EV_A_ 0); |
3771 | \& ev_run (EV_A_ 0); |
2069 | .Ve |
3772 | .Ve |
2070 | .Sp |
3773 | .Sp |
2071 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
3774 | It assumes the variable \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR is in scope, |
2072 | which is often provided by the following macro. |
3775 | which is often provided by the following macro. |
2073 | .ie n .IP """EV_P""\fR, \f(CW""EV_P_""" 4 |
3776 | .ie n .IP """EV_P"", ""EV_P_""" 4 |
2074 | .el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 |
3777 | .el .IP "\f(CWEV_P\fR, \f(CWEV_P_\fR" 4 |
2075 | .IX Item "EV_P, EV_P_" |
3778 | .IX Item "EV_P, EV_P_" |
2076 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
3779 | This provides the loop \fIparameter\fR for functions, if one is required (\*(L"ev |
2077 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
3780 | loop parameter\*(R"). The \f(CW\*(C`EV_P\*(C'\fR form is used when this is the sole parameter, |
2078 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
3781 | \&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: |
2079 | .Sp |
3782 | .Sp |
2080 | .Vb 2 |
3783 | .Vb 2 |
2081 | \& // this is how ev_unref is being declared |
3784 | \& // this is how ev_unref is being declared |
2082 | \& static void ev_unref (EV_P); |
3785 | \& static void ev_unref (EV_P); |
2083 | .Ve |
3786 | \& |
2084 | .Sp |
|
|
2085 | .Vb 2 |
|
|
2086 | \& // this is how you can declare your typical callback |
3787 | \& // this is how you can declare your typical callback |
2087 | \& static void cb (EV_P_ ev_timer *w, int revents) |
3788 | \& static void cb (EV_P_ ev_timer *w, int revents) |
2088 | .Ve |
3789 | .Ve |
2089 | .Sp |
3790 | .Sp |
2090 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
3791 | It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite |
2091 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
3792 | suitable for use with \f(CW\*(C`EV_A\*(C'\fR. |
2092 | .ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 |
3793 | .ie n .IP """EV_DEFAULT"", ""EV_DEFAULT_""" 4 |
2093 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
3794 | .el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 |
2094 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
3795 | .IX Item "EV_DEFAULT, EV_DEFAULT_" |
2095 | Similar to the other two macros, this gives you the value of the default |
3796 | Similar to the other two macros, this gives you the value of the default |
2096 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
3797 | loop, if multiple loops are supported (\*(L"ev loop default\*(R"). |
|
|
3798 | .ie n .IP """EV_DEFAULT_UC"", ""EV_DEFAULT_UC_""" 4 |
|
|
3799 | .el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4 |
|
|
3800 | .IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_" |
|
|
3801 | Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the |
|
|
3802 | default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour |
|
|
3803 | is undefined when the default loop has not been initialised by a previous |
|
|
3804 | 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. |
|
|
3805 | .Sp |
|
|
3806 | It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first |
|
|
3807 | watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards. |
2097 | .PP |
3808 | .PP |
2098 | Example: Declare and initialise a check watcher, utilising the above |
3809 | Example: Declare and initialise a check watcher, utilising the above |
2099 | macros so it will work regardless of whether multiple loops are supported |
3810 | macros so it will work regardless of whether multiple loops are supported |
2100 | or not. |
3811 | or not. |
2101 | .PP |
3812 | .PP |
2102 | .Vb 5 |
3813 | .Vb 5 |
2103 | \& static void |
3814 | \& static void |
2104 | \& check_cb (EV_P_ ev_timer *w, int revents) |
3815 | \& check_cb (EV_P_ ev_timer *w, int revents) |
2105 | \& { |
3816 | \& { |
2106 | \& ev_check_stop (EV_A_ w); |
3817 | \& ev_check_stop (EV_A_ w); |
2107 | \& } |
3818 | \& } |
2108 | .Ve |
3819 | \& |
2109 | .PP |
|
|
2110 | .Vb 4 |
|
|
2111 | \& ev_check check; |
3820 | \& ev_check check; |
2112 | \& ev_check_init (&check, check_cb); |
3821 | \& ev_check_init (&check, check_cb); |
2113 | \& ev_check_start (EV_DEFAULT_ &check); |
3822 | \& ev_check_start (EV_DEFAULT_ &check); |
2114 | \& ev_loop (EV_DEFAULT_ 0); |
3823 | \& ev_run (EV_DEFAULT_ 0); |
2115 | .Ve |
3824 | .Ve |
2116 | .SH "EMBEDDING" |
3825 | .SH "EMBEDDING" |
2117 | .IX Header "EMBEDDING" |
3826 | .IX Header "EMBEDDING" |
2118 | Libev can (and often is) directly embedded into host |
3827 | Libev can (and often is) directly embedded into host |
2119 | applications. Examples of applications that embed it include the Deliantra |
3828 | applications. Examples of applications that embed it include the Deliantra |
2120 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
3829 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
2121 | and rxvt\-unicode. |
3830 | and rxvt-unicode. |
2122 | .PP |
3831 | .PP |
2123 | The goal is to enable you to just copy the neecssary files into your |
3832 | The goal is to enable you to just copy the necessary files into your |
2124 | source directory without having to change even a single line in them, so |
3833 | source directory without having to change even a single line in them, so |
2125 | you can easily upgrade by simply copying (or having a checked-out copy of |
3834 | you can easily upgrade by simply copying (or having a checked-out copy of |
2126 | libev somewhere in your source tree). |
3835 | libev somewhere in your source tree). |
2127 | .Sh "\s-1FILESETS\s0" |
3836 | .SS "\s-1FILESETS\s0" |
2128 | .IX Subsection "FILESETS" |
3837 | .IX Subsection "FILESETS" |
2129 | Depending on what features you need you need to include one or more sets of files |
3838 | Depending on what features you need you need to include one or more sets of files |
2130 | in your app. |
3839 | in your application. |
2131 | .PP |
3840 | .PP |
2132 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
3841 | \fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR |
2133 | .IX Subsection "CORE EVENT LOOP" |
3842 | .IX Subsection "CORE EVENT LOOP" |
2134 | .PP |
3843 | .PP |
2135 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
3844 | To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual |
2136 | configuration (no autoconf): |
3845 | configuration (no autoconf): |
2137 | .PP |
3846 | .PP |
2138 | .Vb 2 |
3847 | .Vb 2 |
2139 | \& #define EV_STANDALONE 1 |
3848 | \& #define EV_STANDALONE 1 |
2140 | \& #include "ev.c" |
3849 | \& #include "ev.c" |
2141 | .Ve |
3850 | .Ve |
2142 | .PP |
3851 | .PP |
2143 | This will automatically include \fIev.h\fR, too, and should be done in a |
3852 | This will automatically include \fIev.h\fR, too, and should be done in a |
2144 | single C source file only to provide the function implementations. To use |
3853 | single C source file only to provide the function implementations. To use |
2145 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
3854 | it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best |
2146 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
3855 | done by writing a wrapper around \fIev.h\fR that you can include instead and |
2147 | where you can put other configuration options): |
3856 | where you can put other configuration options): |
2148 | .PP |
3857 | .PP |
2149 | .Vb 2 |
3858 | .Vb 2 |
2150 | \& #define EV_STANDALONE 1 |
3859 | \& #define EV_STANDALONE 1 |
2151 | \& #include "ev.h" |
3860 | \& #include "ev.h" |
2152 | .Ve |
3861 | .Ve |
2153 | .PP |
3862 | .PP |
2154 | Both header files and implementation files can be compiled with a \*(C+ |
3863 | Both header files and implementation files can be compiled with a \*(C+ |
2155 | compiler (at least, thats a stated goal, and breakage will be treated |
3864 | compiler (at least, that's a stated goal, and breakage will be treated |
2156 | as a bug). |
3865 | as a bug). |
2157 | .PP |
3866 | .PP |
2158 | You need the following files in your source tree, or in a directory |
3867 | You need the following files in your source tree, or in a directory |
2159 | in your include path (e.g. in libev/ when using \-Ilibev): |
3868 | in your include path (e.g. in libev/ when using \-Ilibev): |
2160 | .PP |
3869 | .PP |
2161 | .Vb 4 |
3870 | .Vb 4 |
2162 | \& ev.h |
3871 | \& ev.h |
2163 | \& ev.c |
3872 | \& ev.c |
2164 | \& ev_vars.h |
3873 | \& ev_vars.h |
2165 | \& ev_wrap.h |
3874 | \& ev_wrap.h |
2166 | .Ve |
3875 | \& |
2167 | .PP |
|
|
2168 | .Vb 1 |
|
|
2169 | \& ev_win32.c required on win32 platforms only |
3876 | \& ev_win32.c required on win32 platforms only |
2170 | .Ve |
3877 | \& |
2171 | .PP |
|
|
2172 | .Vb 5 |
|
|
2173 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
3878 | \& ev_select.c only when select backend is enabled (which is enabled by default) |
2174 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
3879 | \& ev_poll.c only when poll backend is enabled (disabled by default) |
2175 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
3880 | \& ev_epoll.c only when the epoll backend is enabled (disabled by default) |
2176 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
3881 | \& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
2177 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
3882 | \& ev_port.c only when the solaris port backend is enabled (disabled by default) |
2178 | .Ve |
3883 | .Ve |
2179 | .PP |
3884 | .PP |
2180 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
3885 | \&\fIev.c\fR includes the backend files directly when enabled, so you only need |
2181 | to compile this single file. |
3886 | to compile this single file. |
2182 | .PP |
3887 | .PP |
… | |
… | |
2184 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
3889 | .IX Subsection "LIBEVENT COMPATIBILITY API" |
2185 | .PP |
3890 | .PP |
2186 | To include the libevent compatibility \s-1API\s0, also include: |
3891 | To include the libevent compatibility \s-1API\s0, also include: |
2187 | .PP |
3892 | .PP |
2188 | .Vb 1 |
3893 | .Vb 1 |
2189 | \& #include "event.c" |
3894 | \& #include "event.c" |
2190 | .Ve |
3895 | .Ve |
2191 | .PP |
3896 | .PP |
2192 | in the file including \fIev.c\fR, and: |
3897 | in the file including \fIev.c\fR, and: |
2193 | .PP |
3898 | .PP |
2194 | .Vb 1 |
3899 | .Vb 1 |
2195 | \& #include "event.h" |
3900 | \& #include "event.h" |
2196 | .Ve |
3901 | .Ve |
2197 | .PP |
3902 | .PP |
2198 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
3903 | in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. |
2199 | .PP |
3904 | .PP |
2200 | You need the following additional files for this: |
3905 | You need the following additional files for this: |
2201 | .PP |
3906 | .PP |
2202 | .Vb 2 |
3907 | .Vb 2 |
2203 | \& event.h |
3908 | \& event.h |
2204 | \& event.c |
3909 | \& event.c |
2205 | .Ve |
3910 | .Ve |
2206 | .PP |
3911 | .PP |
2207 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
3912 | \fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR |
2208 | .IX Subsection "AUTOCONF SUPPORT" |
3913 | .IX Subsection "AUTOCONF SUPPORT" |
2209 | .PP |
3914 | .PP |
2210 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in |
3915 | Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in |
2211 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
3916 | whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your |
2212 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then |
3917 | \&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then |
2213 | include \fIconfig.h\fR and configure itself accordingly. |
3918 | include \fIconfig.h\fR and configure itself accordingly. |
2214 | .PP |
3919 | .PP |
2215 | For this of course you need the m4 file: |
3920 | For this of course you need the m4 file: |
2216 | .PP |
3921 | .PP |
2217 | .Vb 1 |
3922 | .Vb 1 |
2218 | \& libev.m4 |
3923 | \& libev.m4 |
2219 | .Ve |
3924 | .Ve |
2220 | .Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
3925 | .SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" |
2221 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
3926 | .IX Subsection "PREPROCESSOR SYMBOLS/MACROS" |
2222 | Libev can be configured via a variety of preprocessor symbols you have to define |
3927 | Libev can be configured via a variety of preprocessor symbols you have to |
2223 | before including any of its files. The default is not to build for multiplicity |
3928 | define before including (or compiling) any of its files. The default in |
2224 | and only include the select backend. |
3929 | the absence of autoconf is documented for every option. |
|
|
3930 | .PP |
|
|
3931 | Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different |
|
|
3932 | values when compiling libev vs. including \fIev.h\fR, so it is permissible |
|
|
3933 | to redefine them before including \fIev.h\fR without breaking compatibility |
|
|
3934 | to a compiled library. All other symbols change the \s-1ABI\s0, which means all |
|
|
3935 | users of libev and the libev code itself must be compiled with compatible |
|
|
3936 | settings. |
|
|
3937 | .IP "\s-1EV_COMPAT3\s0 (h)" 4 |
|
|
3938 | .IX Item "EV_COMPAT3 (h)" |
|
|
3939 | Backwards compatibility is a major concern for libev. This is why this |
|
|
3940 | release of libev comes with wrappers for the functions and symbols that |
|
|
3941 | have been renamed between libev version 3 and 4. |
|
|
3942 | .Sp |
|
|
3943 | You can disable these wrappers (to test compatibility with future |
|
|
3944 | versions) by defining \f(CW\*(C`EV_COMPAT3\*(C'\fR to \f(CW0\fR when compiling your |
|
|
3945 | sources. This has the additional advantage that you can drop the \f(CW\*(C`struct\*(C'\fR |
|
|
3946 | from \f(CW\*(C`struct ev_loop\*(C'\fR declarations, as libev will provide an \f(CW\*(C`ev_loop\*(C'\fR |
|
|
3947 | typedef in that case. |
|
|
3948 | .Sp |
|
|
3949 | In some future version, the default for \f(CW\*(C`EV_COMPAT3\*(C'\fR will become \f(CW0\fR, |
|
|
3950 | and in some even more future version the compatibility code will be |
|
|
3951 | removed completely. |
2225 | .IP "\s-1EV_STANDALONE\s0" 4 |
3952 | .IP "\s-1EV_STANDALONE\s0 (h)" 4 |
2226 | .IX Item "EV_STANDALONE" |
3953 | .IX Item "EV_STANDALONE (h)" |
2227 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
3954 | Must always be \f(CW1\fR if you do not use autoconf configuration, which |
2228 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
3955 | keeps libev from including \fIconfig.h\fR, and it also defines dummy |
2229 | implementations for some libevent functions (such as logging, which is not |
3956 | implementations for some libevent functions (such as logging, which is not |
2230 | supported). It will also not define any of the structs usually found in |
3957 | supported). It will also not define any of the structs usually found in |
2231 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
3958 | \&\fIevent.h\fR that are not directly supported by the libev core alone. |
|
|
3959 | .Sp |
|
|
3960 | In standalone mode, libev will still try to automatically deduce the |
|
|
3961 | configuration, but has to be more conservative. |
2232 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
3962 | .IP "\s-1EV_USE_MONOTONIC\s0" 4 |
2233 | .IX Item "EV_USE_MONOTONIC" |
3963 | .IX Item "EV_USE_MONOTONIC" |
2234 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
3964 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2235 | monotonic clock option at both compiletime and runtime. Otherwise no use |
3965 | monotonic clock option at both compile time and runtime. Otherwise no |
2236 | of the monotonic clock option will be attempted. If you enable this, you |
3966 | use of the monotonic clock option will be attempted. If you enable this, |
2237 | usually have to link against librt or something similar. Enabling it when |
3967 | you usually have to link against librt or something similar. Enabling it |
2238 | the functionality isn't available is safe, though, althoguh you have |
3968 | when the functionality isn't available is safe, though, although you have |
2239 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
3969 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
2240 | function is hiding in (often \fI\-lrt\fR). |
3970 | function is hiding in (often \fI\-lrt\fR). See also \f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR. |
2241 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
3971 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
2242 | .IX Item "EV_USE_REALTIME" |
3972 | .IX Item "EV_USE_REALTIME" |
2243 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
3973 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2244 | realtime clock option at compiletime (and assume its availability at |
3974 | real-time clock option at compile time (and assume its availability |
2245 | runtime if successful). Otherwise no use of the realtime clock option will |
3975 | at runtime if successful). Otherwise no use of the real-time clock |
2246 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
3976 | option will be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR |
2247 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
3977 | by \f(CW\*(C`clock_get (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect |
2248 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
3978 | correctness. See the note about libraries in the description of |
|
|
3979 | \&\f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. Defaults to the opposite value of |
|
|
3980 | \&\f(CW\*(C`EV_USE_CLOCK_SYSCALL\*(C'\fR. |
|
|
3981 | .IP "\s-1EV_USE_CLOCK_SYSCALL\s0" 4 |
|
|
3982 | .IX Item "EV_USE_CLOCK_SYSCALL" |
|
|
3983 | If defined to be \f(CW1\fR, libev will try to use a direct syscall instead |
|
|
3984 | of calling the system-provided \f(CW\*(C`clock_gettime\*(C'\fR function. This option |
|
|
3985 | exists because on GNU/Linux, \f(CW\*(C`clock_gettime\*(C'\fR is in \f(CW\*(C`librt\*(C'\fR, but \f(CW\*(C`librt\*(C'\fR |
|
|
3986 | unconditionally pulls in \f(CW\*(C`libpthread\*(C'\fR, slowing down single-threaded |
|
|
3987 | programs needlessly. Using a direct syscall is slightly slower (in |
|
|
3988 | theory), because no optimised vdso implementation can be used, but avoids |
|
|
3989 | the pthread dependency. Defaults to \f(CW1\fR on GNU/Linux with glibc 2.x or |
|
|
3990 | higher, as it simplifies linking (no need for \f(CW\*(C`\-lrt\*(C'\fR). |
|
|
3991 | .IP "\s-1EV_USE_NANOSLEEP\s0" 4 |
|
|
3992 | .IX Item "EV_USE_NANOSLEEP" |
|
|
3993 | If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available |
|
|
3994 | and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. |
|
|
3995 | .IP "\s-1EV_USE_EVENTFD\s0" 4 |
|
|
3996 | .IX Item "EV_USE_EVENTFD" |
|
|
3997 | If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is |
|
|
3998 | available and will probe for kernel support at runtime. This will improve |
|
|
3999 | \&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. |
|
|
4000 | If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc |
|
|
4001 | 2.7 or newer, otherwise disabled. |
2249 | .IP "\s-1EV_USE_SELECT\s0" 4 |
4002 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2250 | .IX Item "EV_USE_SELECT" |
4003 | .IX Item "EV_USE_SELECT" |
2251 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
4004 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2252 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
4005 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no |
2253 | other method takes over, select will be it. Otherwise the select backend |
4006 | other method takes over, select will be it. Otherwise the select backend |
2254 | will not be compiled in. |
4007 | will not be compiled in. |
2255 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
4008 | .IP "\s-1EV_SELECT_USE_FD_SET\s0" 4 |
2256 | .IX Item "EV_SELECT_USE_FD_SET" |
4009 | .IX Item "EV_SELECT_USE_FD_SET" |
2257 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
4010 | If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR |
2258 | structure. This is useful if libev doesn't compile due to a missing |
4011 | structure. This is useful if libev doesn't compile due to a missing |
2259 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it misguesses the bitset layout on |
4012 | \&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR definition or it mis-guesses the bitset layout |
2260 | exotic systems. This usually limits the range of file descriptors to some |
4013 | on exotic systems. This usually limits the range of file descriptors to |
2261 | low limit such as 1024 or might have other limitations (winsocket only |
4014 | some low limit such as 1024 or might have other limitations (winsocket |
2262 | allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might |
4015 | only allows 64 sockets). The \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, |
2263 | influence the size of the \f(CW\*(C`fd_set\*(C'\fR used. |
4016 | configures the maximum size of the \f(CW\*(C`fd_set\*(C'\fR. |
2264 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
4017 | .IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4 |
2265 | .IX Item "EV_SELECT_IS_WINSOCKET" |
4018 | .IX Item "EV_SELECT_IS_WINSOCKET" |
2266 | When defined to \f(CW1\fR, the select backend will assume that |
4019 | When defined to \f(CW1\fR, the select backend will assume that |
2267 | select/socket/connect etc. don't understand file descriptors but |
4020 | select/socket/connect etc. don't understand file descriptors but |
2268 | wants osf handles on win32 (this is the case when the select to |
4021 | wants osf handles on win32 (this is the case when the select to |
2269 | be used is the winsock select). This means that it will call |
4022 | be used is the winsock select). This means that it will call |
2270 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
4023 | \&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, |
2271 | it is assumed that all these functions actually work on fds, even |
4024 | it is assumed that all these functions actually work on fds, even |
2272 | on win32. Should not be defined on non\-win32 platforms. |
4025 | on win32. Should not be defined on non\-win32 platforms. |
|
|
4026 | .IP "\s-1EV_FD_TO_WIN32_HANDLE\s0(fd)" 4 |
|
|
4027 | .IX Item "EV_FD_TO_WIN32_HANDLE(fd)" |
|
|
4028 | If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map |
|
|
4029 | file descriptors to socket handles. When not defining this symbol (the |
|
|
4030 | default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually |
|
|
4031 | correct. In some cases, programs use their own file descriptor management, |
|
|
4032 | in which case they can provide this function to map fds to socket handles. |
|
|
4033 | .IP "\s-1EV_WIN32_HANDLE_TO_FD\s0(handle)" 4 |
|
|
4034 | .IX Item "EV_WIN32_HANDLE_TO_FD(handle)" |
|
|
4035 | If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR then libev maps handles to file descriptors |
|
|
4036 | using the standard \f(CW\*(C`_open_osfhandle\*(C'\fR function. For programs implementing |
|
|
4037 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
4038 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
4039 | .IP "\s-1EV_WIN32_CLOSE_FD\s0(fd)" 4 |
|
|
4040 | .IX Item "EV_WIN32_CLOSE_FD(fd)" |
|
|
4041 | If programs implement their own fd to handle mapping on win32, then this |
|
|
4042 | macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister |
|
|
4043 | file descriptors again. Note that the replacement function has to close |
|
|
4044 | the underlying \s-1OS\s0 handle. |
2273 | .IP "\s-1EV_USE_POLL\s0" 4 |
4045 | .IP "\s-1EV_USE_POLL\s0" 4 |
2274 | .IX Item "EV_USE_POLL" |
4046 | .IX Item "EV_USE_POLL" |
2275 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
4047 | If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) |
2276 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
4048 | backend. Otherwise it will be enabled on non\-win32 platforms. It |
2277 | takes precedence over select. |
4049 | takes precedence over select. |
2278 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
4050 | .IP "\s-1EV_USE_EPOLL\s0" 4 |
2279 | .IX Item "EV_USE_EPOLL" |
4051 | .IX Item "EV_USE_EPOLL" |
2280 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
4052 | If defined to be \f(CW1\fR, libev will compile in support for the Linux |
2281 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
4053 | \&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, |
2282 | otherwise another method will be used as fallback. This is the |
4054 | otherwise another method will be used as fallback. This is the preferred |
2283 | preferred backend for GNU/Linux systems. |
4055 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
|
|
4056 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
2284 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
4057 | .IP "\s-1EV_USE_KQUEUE\s0" 4 |
2285 | .IX Item "EV_USE_KQUEUE" |
4058 | .IX Item "EV_USE_KQUEUE" |
2286 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
4059 | If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style |
2287 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
4060 | \&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, |
2288 | otherwise another method will be used as fallback. This is the preferred |
4061 | otherwise another method will be used as fallback. This is the preferred |
… | |
… | |
2298 | 10 port style backend. Its availability will be detected at runtime, |
4071 | 10 port style backend. Its availability will be detected at runtime, |
2299 | otherwise another method will be used as fallback. This is the preferred |
4072 | otherwise another method will be used as fallback. This is the preferred |
2300 | backend for Solaris 10 systems. |
4073 | backend for Solaris 10 systems. |
2301 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
4074 | .IP "\s-1EV_USE_DEVPOLL\s0" 4 |
2302 | .IX Item "EV_USE_DEVPOLL" |
4075 | .IX Item "EV_USE_DEVPOLL" |
2303 | reserved for future expansion, works like the \s-1USE\s0 symbols above. |
4076 | Reserved for future expansion, works like the \s-1USE\s0 symbols above. |
2304 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
4077 | .IP "\s-1EV_USE_INOTIFY\s0" 4 |
2305 | .IX Item "EV_USE_INOTIFY" |
4078 | .IX Item "EV_USE_INOTIFY" |
2306 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
4079 | If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify |
2307 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
4080 | interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will |
2308 | be detected at runtime. |
4081 | be detected at runtime. If undefined, it will be enabled if the headers |
|
|
4082 | indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
|
|
4083 | .IP "\s-1EV_ATOMIC_T\s0" 4 |
|
|
4084 | .IX Item "EV_ATOMIC_T" |
|
|
4085 | Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose |
|
|
4086 | access is atomic with respect to other threads or signal contexts. No such |
|
|
4087 | type is easily found in the C language, so you can provide your own type |
|
|
4088 | that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R" |
|
|
4089 | as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers. |
|
|
4090 | .Sp |
|
|
4091 | In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR |
|
|
4092 | (from \fIsignal.h\fR), which is usually good enough on most platforms. |
2309 | .IP "\s-1EV_H\s0" 4 |
4093 | .IP "\s-1EV_H\s0 (h)" 4 |
2310 | .IX Item "EV_H" |
4094 | .IX Item "EV_H (h)" |
2311 | The name of the \fIev.h\fR header file used to include it. The default if |
4095 | The name of the \fIev.h\fR header file used to include it. The default if |
2312 | undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This |
4096 | undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be |
2313 | can be used to virtually rename the \fIev.h\fR header file in case of conflicts. |
4097 | used to virtually rename the \fIev.h\fR header file in case of conflicts. |
2314 | .IP "\s-1EV_CONFIG_H\s0" 4 |
4098 | .IP "\s-1EV_CONFIG_H\s0 (h)" 4 |
2315 | .IX Item "EV_CONFIG_H" |
4099 | .IX Item "EV_CONFIG_H (h)" |
2316 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
4100 | If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override |
2317 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
4101 | \&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to |
2318 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
4102 | \&\f(CW\*(C`EV_H\*(C'\fR, above. |
2319 | .IP "\s-1EV_EVENT_H\s0" 4 |
4103 | .IP "\s-1EV_EVENT_H\s0 (h)" 4 |
2320 | .IX Item "EV_EVENT_H" |
4104 | .IX Item "EV_EVENT_H (h)" |
2321 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
4105 | Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea |
2322 | of how the \fIevent.h\fR header can be found. |
4106 | of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR. |
2323 | .IP "\s-1EV_PROTOTYPES\s0" 4 |
4107 | .IP "\s-1EV_PROTOTYPES\s0 (h)" 4 |
2324 | .IX Item "EV_PROTOTYPES" |
4108 | .IX Item "EV_PROTOTYPES (h)" |
2325 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
4109 | If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function |
2326 | prototypes, but still define all the structs and other symbols. This is |
4110 | prototypes, but still define all the structs and other symbols. This is |
2327 | occasionally useful if you want to provide your own wrapper functions |
4111 | occasionally useful if you want to provide your own wrapper functions |
2328 | around libev functions. |
4112 | around libev functions. |
2329 | .IP "\s-1EV_MULTIPLICITY\s0" 4 |
4113 | .IP "\s-1EV_MULTIPLICITY\s0" 4 |
… | |
… | |
2347 | When doing priority-based operations, libev usually has to linearly search |
4131 | When doing priority-based operations, libev usually has to linearly search |
2348 | all the priorities, so having many of them (hundreds) uses a lot of space |
4132 | all the priorities, so having many of them (hundreds) uses a lot of space |
2349 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
4133 | and time, so using the defaults of five priorities (\-2 .. +2) is usually |
2350 | fine. |
4134 | fine. |
2351 | .Sp |
4135 | .Sp |
2352 | If your embedding app does not need any priorities, defining these both to |
4136 | If your embedding application does not need any priorities, defining these |
2353 | \&\f(CW0\fR will save some memory and cpu. |
4137 | both to \f(CW0\fR will save some memory and \s-1CPU\s0. |
2354 | .IP "\s-1EV_PERIODIC_ENABLE\s0" 4 |
4138 | .IP "\s-1EV_PERIODIC_ENABLE\s0, \s-1EV_IDLE_ENABLE\s0, \s-1EV_EMBED_ENABLE\s0, \s-1EV_STAT_ENABLE\s0, \s-1EV_PREPARE_ENABLE\s0, \s-1EV_CHECK_ENABLE\s0, \s-1EV_FORK_ENABLE\s0, \s-1EV_SIGNAL_ENABLE\s0, \s-1EV_ASYNC_ENABLE\s0, \s-1EV_CHILD_ENABLE\s0." 4 |
2355 | .IX Item "EV_PERIODIC_ENABLE" |
4139 | .IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE." |
2356 | If undefined or defined to be \f(CW1\fR, then periodic timers are supported. If |
4140 | If undefined or defined to be \f(CW1\fR (and the platform supports it), then |
2357 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
4141 | the respective watcher type is supported. If defined to be \f(CW0\fR, then it |
2358 | code. |
4142 | is not. Disabling watcher types mainly saves code size. |
2359 | .IP "\s-1EV_IDLE_ENABLE\s0" 4 |
|
|
2360 | .IX Item "EV_IDLE_ENABLE" |
|
|
2361 | If undefined or defined to be \f(CW1\fR, then idle watchers are supported. If |
|
|
2362 | defined to be \f(CW0\fR, then they are not. Disabling them saves a few kB of |
|
|
2363 | code. |
|
|
2364 | .IP "\s-1EV_EMBED_ENABLE\s0" 4 |
|
|
2365 | .IX Item "EV_EMBED_ENABLE" |
|
|
2366 | If undefined or defined to be \f(CW1\fR, then embed watchers are supported. If |
|
|
2367 | defined to be \f(CW0\fR, then they are not. |
|
|
2368 | .IP "\s-1EV_STAT_ENABLE\s0" 4 |
4143 | .IP "\s-1EV_FEATURES\s0" 4 |
2369 | .IX Item "EV_STAT_ENABLE" |
4144 | .IX Item "EV_FEATURES" |
2370 | If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If |
|
|
2371 | defined to be \f(CW0\fR, then they are not. |
|
|
2372 | .IP "\s-1EV_FORK_ENABLE\s0" 4 |
|
|
2373 | .IX Item "EV_FORK_ENABLE" |
|
|
2374 | If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If |
|
|
2375 | defined to be \f(CW0\fR, then they are not. |
|
|
2376 | .IP "\s-1EV_MINIMAL\s0" 4 |
|
|
2377 | .IX Item "EV_MINIMAL" |
|
|
2378 | If you need to shave off some kilobytes of code at the expense of some |
4145 | If you need to shave off some kilobytes of code at the expense of some |
2379 | speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override |
4146 | speed (but with the full \s-1API\s0), you can define this symbol to request |
2380 | some inlining decisions, saves roughly 30% codesize of amd64. |
4147 | certain subsets of functionality. The default is to enable all features |
|
|
4148 | that can be enabled on the platform. |
|
|
4149 | .Sp |
|
|
4150 | A typical way to use this symbol is to define it to \f(CW0\fR (or to a bitset |
|
|
4151 | with some broad features you want) and then selectively re-enable |
|
|
4152 | additional parts you want, for example if you want everything minimal, |
|
|
4153 | but multiple event loop support, async and child watchers and the poll |
|
|
4154 | backend, use this: |
|
|
4155 | .Sp |
|
|
4156 | .Vb 5 |
|
|
4157 | \& #define EV_FEATURES 0 |
|
|
4158 | \& #define EV_MULTIPLICITY 1 |
|
|
4159 | \& #define EV_USE_POLL 1 |
|
|
4160 | \& #define EV_CHILD_ENABLE 1 |
|
|
4161 | \& #define EV_ASYNC_ENABLE 1 |
|
|
4162 | .Ve |
|
|
4163 | .Sp |
|
|
4164 | The actual value is a bitset, it can be a combination of the following |
|
|
4165 | values: |
|
|
4166 | .RS 4 |
|
|
4167 | .ie n .IP "1 \- faster/larger code" 4 |
|
|
4168 | .el .IP "\f(CW1\fR \- faster/larger code" 4 |
|
|
4169 | .IX Item "1 - faster/larger code" |
|
|
4170 | Use larger code to speed up some operations. |
|
|
4171 | .Sp |
|
|
4172 | Currently this is used to override some inlining decisions (enlarging the |
|
|
4173 | code size by roughly 30% on amd64). |
|
|
4174 | .Sp |
|
|
4175 | When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with |
|
|
4176 | gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of |
|
|
4177 | assertions. |
|
|
4178 | .ie n .IP "2 \- faster/larger data structures" 4 |
|
|
4179 | .el .IP "\f(CW2\fR \- faster/larger data structures" 4 |
|
|
4180 | .IX Item "2 - faster/larger data structures" |
|
|
4181 | Replaces the small 2\-heap for timer management by a faster 4\-heap, larger |
|
|
4182 | hash table sizes and so on. This will usually further increase code size |
|
|
4183 | and can additionally have an effect on the size of data structures at |
|
|
4184 | runtime. |
|
|
4185 | .ie n .IP "4 \- full \s-1API\s0 configuration" 4 |
|
|
4186 | .el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 |
|
|
4187 | .IX Item "4 - full API configuration" |
|
|
4188 | This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and |
|
|
4189 | enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). |
|
|
4190 | .ie n .IP "8 \- full \s-1API\s0" 4 |
|
|
4191 | .el .IP "\f(CW8\fR \- full \s-1API\s0" 4 |
|
|
4192 | .IX Item "8 - full API" |
|
|
4193 | This enables a lot of the \*(L"lesser used\*(R" \s-1API\s0 functions. See \f(CW\*(C`ev.h\*(C'\fR for |
|
|
4194 | details on which parts of the \s-1API\s0 are still available without this |
|
|
4195 | feature, and do not complain if this subset changes over time. |
|
|
4196 | .ie n .IP "16 \- enable all optional watcher types" 4 |
|
|
4197 | .el .IP "\f(CW16\fR \- enable all optional watcher types" 4 |
|
|
4198 | .IX Item "16 - enable all optional watcher types" |
|
|
4199 | Enables all optional watcher types. If you want to selectively enable |
|
|
4200 | only some watcher types other than I/O and timers (e.g. prepare, |
|
|
4201 | embed, async, child...) you can enable them manually by defining |
|
|
4202 | \&\f(CW\*(C`EV_watchertype_ENABLE\*(C'\fR to \f(CW1\fR instead. |
|
|
4203 | .ie n .IP "32 \- enable all backends" 4 |
|
|
4204 | .el .IP "\f(CW32\fR \- enable all backends" 4 |
|
|
4205 | .IX Item "32 - enable all backends" |
|
|
4206 | This enables all backends \- without this feature, you need to enable at |
|
|
4207 | least one backend manually (\f(CW\*(C`EV_USE_SELECT\*(C'\fR is a good choice). |
|
|
4208 | .ie n .IP "64 \- enable OS-specific ""helper"" APIs" 4 |
|
|
4209 | .el .IP "\f(CW64\fR \- enable OS-specific ``helper'' APIs" 4 |
|
|
4210 | .IX Item "64 - enable OS-specific helper APIs" |
|
|
4211 | Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by |
|
|
4212 | default. |
|
|
4213 | .RE |
|
|
4214 | .RS 4 |
|
|
4215 | .Sp |
|
|
4216 | Compiling with \f(CW\*(C`gcc \-Os \-DEV_STANDALONE \-DEV_USE_EPOLL=1 \-DEV_FEATURES=0\*(C'\fR |
|
|
4217 | reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb |
|
|
4218 | code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O |
|
|
4219 | watchers, timers and monotonic clock support. |
|
|
4220 | .Sp |
|
|
4221 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
|
|
4222 | when you use \f(CW\*(C`\-Wl,\-\-gc\-sections \-ffunction\-sections\*(C'\fR) functions unused by |
|
|
4223 | your program might be left out as well \- a binary starting a timer and an |
|
|
4224 | I/O watcher then might come out at only 5Kb. |
|
|
4225 | .RE |
|
|
4226 | .IP "\s-1EV_AVOID_STDIO\s0" 4 |
|
|
4227 | .IX Item "EV_AVOID_STDIO" |
|
|
4228 | If this is set to \f(CW1\fR at compiletime, then libev will avoid using stdio |
|
|
4229 | functions (printf, scanf, perror etc.). This will increase the code size |
|
|
4230 | somewhat, but if your program doesn't otherwise depend on stdio and your |
|
|
4231 | libc allows it, this avoids linking in the stdio library which is quite |
|
|
4232 | big. |
|
|
4233 | .Sp |
|
|
4234 | Note that error messages might become less precise when this option is |
|
|
4235 | enabled. |
|
|
4236 | .IP "\s-1EV_NSIG\s0" 4 |
|
|
4237 | .IX Item "EV_NSIG" |
|
|
4238 | The highest supported signal number, +1 (or, the number of |
|
|
4239 | signals): Normally, libev tries to deduce the maximum number of signals |
|
|
4240 | automatically, but sometimes this fails, in which case it can be |
|
|
4241 | specified. Also, using a lower number than detected (\f(CW32\fR should be |
|
|
4242 | good for about any system in existence) can save some memory, as libev |
|
|
4243 | statically allocates some 12\-24 bytes per signal number. |
2381 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
4244 | .IP "\s-1EV_PID_HASHSIZE\s0" 4 |
2382 | .IX Item "EV_PID_HASHSIZE" |
4245 | .IX Item "EV_PID_HASHSIZE" |
2383 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
4246 | \&\f(CW\*(C`ev_child\*(C'\fR watchers use a small hash table to distribute workload by |
2384 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more |
4247 | pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR disabled), |
2385 | than enough. If you need to manage thousands of children you might want to |
4248 | usually more than enough. If you need to manage thousands of children you |
2386 | increase this value (\fImust\fR be a power of two). |
4249 | might want to increase this value (\fImust\fR be a power of two). |
2387 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
4250 | .IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 |
2388 | .IX Item "EV_INOTIFY_HASHSIZE" |
4251 | .IX Item "EV_INOTIFY_HASHSIZE" |
2389 | \&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by |
4252 | \&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by |
2390 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), |
4253 | inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_FEATURES\*(C'\fR |
2391 | usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR |
4254 | disabled), usually more than enough. If you need to manage thousands of |
2392 | watchers you might want to increase this value (\fImust\fR be a power of |
4255 | \&\f(CW\*(C`ev_stat\*(C'\fR watchers you might want to increase this value (\fImust\fR be a |
2393 | two). |
4256 | power of two). |
|
|
4257 | .IP "\s-1EV_USE_4HEAP\s0" 4 |
|
|
4258 | .IX Item "EV_USE_4HEAP" |
|
|
4259 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
|
|
4260 | timer and periodics heaps, libev uses a 4\-heap when this symbol is defined |
|
|
4261 | to \f(CW1\fR. The 4\-heap uses more complicated (longer) code but has noticeably |
|
|
4262 | faster performance with many (thousands) of watchers. |
|
|
4263 | .Sp |
|
|
4264 | The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it |
|
|
4265 | will be \f(CW0\fR. |
|
|
4266 | .IP "\s-1EV_HEAP_CACHE_AT\s0" 4 |
|
|
4267 | .IX Item "EV_HEAP_CACHE_AT" |
|
|
4268 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
|
|
4269 | timer and periodics heaps, libev can cache the timestamp (\fIat\fR) within |
|
|
4270 | the heap structure (selected by defining \f(CW\*(C`EV_HEAP_CACHE_AT\*(C'\fR to \f(CW1\fR), |
|
|
4271 | which uses 8\-12 bytes more per watcher and a few hundred bytes more code, |
|
|
4272 | but avoids random read accesses on heap changes. This improves performance |
|
|
4273 | noticeably with many (hundreds) of watchers. |
|
|
4274 | .Sp |
|
|
4275 | The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it |
|
|
4276 | will be \f(CW0\fR. |
|
|
4277 | .IP "\s-1EV_VERIFY\s0" 4 |
|
|
4278 | .IX Item "EV_VERIFY" |
|
|
4279 | Controls how much internal verification (see \f(CW\*(C`ev_verify ()\*(C'\fR) will |
|
|
4280 | be done: If set to \f(CW0\fR, no internal verification code will be compiled |
|
|
4281 | in. If set to \f(CW1\fR, then verification code will be compiled in, but not |
|
|
4282 | called. If set to \f(CW2\fR, then the internal verification code will be |
|
|
4283 | called once per loop, which can slow down libev. If set to \f(CW3\fR, then the |
|
|
4284 | verification code will be called very frequently, which will slow down |
|
|
4285 | libev considerably. |
|
|
4286 | .Sp |
|
|
4287 | The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it |
|
|
4288 | will be \f(CW0\fR. |
2394 | .IP "\s-1EV_COMMON\s0" 4 |
4289 | .IP "\s-1EV_COMMON\s0" 4 |
2395 | .IX Item "EV_COMMON" |
4290 | .IX Item "EV_COMMON" |
2396 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
4291 | By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining |
2397 | this macro to a something else you can include more and other types of |
4292 | this macro to something else you can include more and other types of |
2398 | members. You have to define it each time you include one of the files, |
4293 | members. You have to define it each time you include one of the files, |
2399 | though, and it must be identical each time. |
4294 | though, and it must be identical each time. |
2400 | .Sp |
4295 | .Sp |
2401 | For example, the perl \s-1EV\s0 module uses something like this: |
4296 | For example, the perl \s-1EV\s0 module uses something like this: |
2402 | .Sp |
4297 | .Sp |
2403 | .Vb 3 |
4298 | .Vb 3 |
2404 | \& #define EV_COMMON \e |
4299 | \& #define EV_COMMON \e |
2405 | \& SV *self; /* contains this struct */ \e |
4300 | \& SV *self; /* contains this struct */ \e |
2406 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
4301 | \& SV *cb_sv, *fh /* note no trailing ";" */ |
2407 | .Ve |
4302 | .Ve |
2408 | .IP "\s-1EV_CB_DECLARE\s0 (type)" 4 |
4303 | .IP "\s-1EV_CB_DECLARE\s0 (type)" 4 |
2409 | .IX Item "EV_CB_DECLARE (type)" |
4304 | .IX Item "EV_CB_DECLARE (type)" |
2410 | .PD 0 |
4305 | .PD 0 |
2411 | .IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 |
4306 | .IP "\s-1EV_CB_INVOKE\s0 (watcher, revents)" 4 |
… | |
… | |
2413 | .IP "ev_set_cb (ev, cb)" 4 |
4308 | .IP "ev_set_cb (ev, cb)" 4 |
2414 | .IX Item "ev_set_cb (ev, cb)" |
4309 | .IX Item "ev_set_cb (ev, cb)" |
2415 | .PD |
4310 | .PD |
2416 | Can be used to change the callback member declaration in each watcher, |
4311 | Can be used to change the callback member declaration in each watcher, |
2417 | and the way callbacks are invoked and set. Must expand to a struct member |
4312 | and the way callbacks are invoked and set. Must expand to a struct member |
2418 | definition and a statement, respectively. See the \fIev.v\fR header file for |
4313 | definition and a statement, respectively. See the \fIev.h\fR header file for |
2419 | their default definitions. One possible use for overriding these is to |
4314 | their default definitions. One possible use for overriding these is to |
2420 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
4315 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2421 | method calls instead of plain function calls in \*(C+. |
4316 | method calls instead of plain function calls in \*(C+. |
|
|
4317 | .SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
|
|
4318 | .IX Subsection "EXPORTED API SYMBOLS" |
|
|
4319 | If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of |
|
|
4320 | exported symbols, you can use the provided \fISymbol.*\fR files which list |
|
|
4321 | all public symbols, one per line: |
|
|
4322 | .PP |
|
|
4323 | .Vb 2 |
|
|
4324 | \& Symbols.ev for libev proper |
|
|
4325 | \& Symbols.event for the libevent emulation |
|
|
4326 | .Ve |
|
|
4327 | .PP |
|
|
4328 | This can also be used to rename all public symbols to avoid clashes with |
|
|
4329 | multiple versions of libev linked together (which is obviously bad in |
|
|
4330 | itself, but sometimes it is inconvenient to avoid this). |
|
|
4331 | .PP |
|
|
4332 | A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
|
|
4333 | include before including \fIev.h\fR: |
|
|
4334 | .PP |
|
|
4335 | .Vb 1 |
|
|
4336 | \& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
4337 | .Ve |
|
|
4338 | .PP |
|
|
4339 | This would create a file \fIwrap.h\fR which essentially looks like this: |
|
|
4340 | .PP |
|
|
4341 | .Vb 4 |
|
|
4342 | \& #define ev_backend myprefix_ev_backend |
|
|
4343 | \& #define ev_check_start myprefix_ev_check_start |
|
|
4344 | \& #define ev_check_stop myprefix_ev_check_stop |
|
|
4345 | \& ... |
|
|
4346 | .Ve |
2422 | .Sh "\s-1EXAMPLES\s0" |
4347 | .SS "\s-1EXAMPLES\s0" |
2423 | .IX Subsection "EXAMPLES" |
4348 | .IX Subsection "EXAMPLES" |
2424 | For a real-world example of a program the includes libev |
4349 | For a real-world example of a program the includes libev |
2425 | verbatim, you can have a look at the \s-1EV\s0 perl module |
4350 | verbatim, you can have a look at the \s-1EV\s0 perl module |
2426 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
4351 | (<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
2427 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
4352 | the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public |
2428 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
4353 | interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file |
2429 | will be compiled. It is pretty complex because it provides its own header |
4354 | will be compiled. It is pretty complex because it provides its own header |
2430 | file. |
4355 | file. |
2431 | .Sp |
4356 | .PP |
2432 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
4357 | The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file |
2433 | that everybody includes and which overrides some configure choices: |
4358 | that everybody includes and which overrides some configure choices: |
2434 | .Sp |
4359 | .PP |
2435 | .Vb 9 |
4360 | .Vb 8 |
2436 | \& #define EV_MINIMAL 1 |
4361 | \& #define EV_FEATURES 8 |
2437 | \& #define EV_USE_POLL 0 |
4362 | \& #define EV_USE_SELECT 1 |
2438 | \& #define EV_MULTIPLICITY 0 |
|
|
2439 | \& #define EV_PERIODIC_ENABLE 0 |
4363 | \& #define EV_PREPARE_ENABLE 1 |
|
|
4364 | \& #define EV_IDLE_ENABLE 1 |
2440 | \& #define EV_STAT_ENABLE 0 |
4365 | \& #define EV_SIGNAL_ENABLE 1 |
2441 | \& #define EV_FORK_ENABLE 0 |
4366 | \& #define EV_CHILD_ENABLE 1 |
|
|
4367 | \& #define EV_USE_STDEXCEPT 0 |
2442 | \& #define EV_CONFIG_H <config.h> |
4368 | \& #define EV_CONFIG_H <config.h> |
2443 | \& #define EV_MINPRI 0 |
4369 | \& |
2444 | \& #define EV_MAXPRI 0 |
|
|
2445 | .Ve |
|
|
2446 | .Sp |
|
|
2447 | .Vb 1 |
|
|
2448 | \& #include "ev++.h" |
4370 | \& #include "ev++.h" |
2449 | .Ve |
4371 | .Ve |
2450 | .Sp |
4372 | .PP |
2451 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
4373 | And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: |
2452 | .Sp |
4374 | .PP |
2453 | .Vb 2 |
4375 | .Vb 2 |
2454 | \& #include "ev_cpp.h" |
4376 | \& #include "ev_cpp.h" |
2455 | \& #include "ev.c" |
4377 | \& #include "ev.c" |
2456 | .Ve |
4378 | .Ve |
|
|
4379 | .SH "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" |
|
|
4380 | .IX Header "INTERACTION WITH OTHER PROGRAMS OR LIBRARIES" |
|
|
4381 | .SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" |
|
|
4382 | .IX Subsection "THREADS AND COROUTINES" |
|
|
4383 | \fI\s-1THREADS\s0\fR |
|
|
4384 | .IX Subsection "THREADS" |
|
|
4385 | .PP |
|
|
4386 | All libev functions are reentrant and thread-safe unless explicitly |
|
|
4387 | documented otherwise, but libev implements no locking itself. This means |
|
|
4388 | that you can use as many loops as you want in parallel, as long as there |
|
|
4389 | are no concurrent calls into any libev function with the same loop |
|
|
4390 | parameter (\f(CW\*(C`ev_default_*\*(C'\fR calls have an implicit default loop parameter, |
|
|
4391 | of course): libev guarantees that different event loops share no data |
|
|
4392 | structures that need any locking. |
|
|
4393 | .PP |
|
|
4394 | Or to put it differently: calls with different loop parameters can be done |
|
|
4395 | concurrently from multiple threads, calls with the same loop parameter |
|
|
4396 | must be done serially (but can be done from different threads, as long as |
|
|
4397 | only one thread ever is inside a call at any point in time, e.g. by using |
|
|
4398 | a mutex per loop). |
|
|
4399 | .PP |
|
|
4400 | Specifically to support threads (and signal handlers), libev implements |
|
|
4401 | so-called \f(CW\*(C`ev_async\*(C'\fR watchers, which allow some limited form of |
|
|
4402 | concurrency on the same event loop, namely waking it up \*(L"from the |
|
|
4403 | outside\*(R". |
|
|
4404 | .PP |
|
|
4405 | If you want to know which design (one loop, locking, or multiple loops |
|
|
4406 | without or something else still) is best for your problem, then I cannot |
|
|
4407 | help you, but here is some generic advice: |
|
|
4408 | .IP "\(bu" 4 |
|
|
4409 | most applications have a main thread: use the default libev loop |
|
|
4410 | in that thread, or create a separate thread running only the default loop. |
|
|
4411 | .Sp |
|
|
4412 | This helps integrating other libraries or software modules that use libev |
|
|
4413 | themselves and don't care/know about threading. |
|
|
4414 | .IP "\(bu" 4 |
|
|
4415 | one loop per thread is usually a good model. |
|
|
4416 | .Sp |
|
|
4417 | Doing this is almost never wrong, sometimes a better-performance model |
|
|
4418 | exists, but it is always a good start. |
|
|
4419 | .IP "\(bu" 4 |
|
|
4420 | other models exist, such as the leader/follower pattern, where one |
|
|
4421 | loop is handed through multiple threads in a kind of round-robin fashion. |
|
|
4422 | .Sp |
|
|
4423 | Choosing a model is hard \- look around, learn, know that usually you can do |
|
|
4424 | better than you currently do :\-) |
|
|
4425 | .IP "\(bu" 4 |
|
|
4426 | often you need to talk to some other thread which blocks in the |
|
|
4427 | event loop. |
|
|
4428 | .Sp |
|
|
4429 | \&\f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other threads safely |
|
|
4430 | (or from signal contexts...). |
|
|
4431 | .Sp |
|
|
4432 | An example use would be to communicate signals or other events that only |
|
|
4433 | work in the default loop by registering the signal watcher with the |
|
|
4434 | default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop |
|
|
4435 | watcher callback into the event loop interested in the signal. |
|
|
4436 | .PP |
|
|
4437 | \s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0 |
|
|
4438 | .IX Subsection "THREAD LOCKING EXAMPLE" |
|
|
4439 | .PP |
|
|
4440 | Here is a fictitious example of how to run an event loop in a different |
|
|
4441 | thread than where callbacks are being invoked and watchers are |
|
|
4442 | created/added/removed. |
|
|
4443 | .PP |
|
|
4444 | For a real-world example, see the \f(CW\*(C`EV::Loop::Async\*(C'\fR perl module, |
|
|
4445 | which uses exactly this technique (which is suited for many high-level |
|
|
4446 | languages). |
|
|
4447 | .PP |
|
|
4448 | The example uses a pthread mutex to protect the loop data, a condition |
|
|
4449 | variable to wait for callback invocations, an async watcher to notify the |
|
|
4450 | event loop thread and an unspecified mechanism to wake up the main thread. |
|
|
4451 | .PP |
|
|
4452 | First, you need to associate some data with the event loop: |
|
|
4453 | .PP |
|
|
4454 | .Vb 6 |
|
|
4455 | \& typedef struct { |
|
|
4456 | \& mutex_t lock; /* global loop lock */ |
|
|
4457 | \& ev_async async_w; |
|
|
4458 | \& thread_t tid; |
|
|
4459 | \& cond_t invoke_cv; |
|
|
4460 | \& } userdata; |
|
|
4461 | \& |
|
|
4462 | \& void prepare_loop (EV_P) |
|
|
4463 | \& { |
|
|
4464 | \& // for simplicity, we use a static userdata struct. |
|
|
4465 | \& static userdata u; |
|
|
4466 | \& |
|
|
4467 | \& ev_async_init (&u\->async_w, async_cb); |
|
|
4468 | \& ev_async_start (EV_A_ &u\->async_w); |
|
|
4469 | \& |
|
|
4470 | \& pthread_mutex_init (&u\->lock, 0); |
|
|
4471 | \& pthread_cond_init (&u\->invoke_cv, 0); |
|
|
4472 | \& |
|
|
4473 | \& // now associate this with the loop |
|
|
4474 | \& ev_set_userdata (EV_A_ u); |
|
|
4475 | \& ev_set_invoke_pending_cb (EV_A_ l_invoke); |
|
|
4476 | \& ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
|
|
4477 | \& |
|
|
4478 | \& // then create the thread running ev_loop |
|
|
4479 | \& pthread_create (&u\->tid, 0, l_run, EV_A); |
|
|
4480 | \& } |
|
|
4481 | .Ve |
|
|
4482 | .PP |
|
|
4483 | The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used |
|
|
4484 | solely to wake up the event loop so it takes notice of any new watchers |
|
|
4485 | that might have been added: |
|
|
4486 | .PP |
|
|
4487 | .Vb 5 |
|
|
4488 | \& static void |
|
|
4489 | \& async_cb (EV_P_ ev_async *w, int revents) |
|
|
4490 | \& { |
|
|
4491 | \& // just used for the side effects |
|
|
4492 | \& } |
|
|
4493 | .Ve |
|
|
4494 | .PP |
|
|
4495 | The \f(CW\*(C`l_release\*(C'\fR and \f(CW\*(C`l_acquire\*(C'\fR callbacks simply unlock/lock the mutex |
|
|
4496 | protecting the loop data, respectively. |
|
|
4497 | .PP |
|
|
4498 | .Vb 6 |
|
|
4499 | \& static void |
|
|
4500 | \& l_release (EV_P) |
|
|
4501 | \& { |
|
|
4502 | \& userdata *u = ev_userdata (EV_A); |
|
|
4503 | \& pthread_mutex_unlock (&u\->lock); |
|
|
4504 | \& } |
|
|
4505 | \& |
|
|
4506 | \& static void |
|
|
4507 | \& l_acquire (EV_P) |
|
|
4508 | \& { |
|
|
4509 | \& userdata *u = ev_userdata (EV_A); |
|
|
4510 | \& pthread_mutex_lock (&u\->lock); |
|
|
4511 | \& } |
|
|
4512 | .Ve |
|
|
4513 | .PP |
|
|
4514 | The event loop thread first acquires the mutex, and then jumps straight |
|
|
4515 | into \f(CW\*(C`ev_run\*(C'\fR: |
|
|
4516 | .PP |
|
|
4517 | .Vb 4 |
|
|
4518 | \& void * |
|
|
4519 | \& l_run (void *thr_arg) |
|
|
4520 | \& { |
|
|
4521 | \& struct ev_loop *loop = (struct ev_loop *)thr_arg; |
|
|
4522 | \& |
|
|
4523 | \& l_acquire (EV_A); |
|
|
4524 | \& pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
|
|
4525 | \& ev_run (EV_A_ 0); |
|
|
4526 | \& l_release (EV_A); |
|
|
4527 | \& |
|
|
4528 | \& return 0; |
|
|
4529 | \& } |
|
|
4530 | .Ve |
|
|
4531 | .PP |
|
|
4532 | Instead of invoking all pending watchers, the \f(CW\*(C`l_invoke\*(C'\fR callback will |
|
|
4533 | signal the main thread via some unspecified mechanism (signals? pipe |
|
|
4534 | writes? \f(CW\*(C`Async::Interrupt\*(C'\fR?) and then waits until all pending watchers |
|
|
4535 | have been called (in a while loop because a) spurious wakeups are possible |
|
|
4536 | and b) skipping inter-thread-communication when there are no pending |
|
|
4537 | watchers is very beneficial): |
|
|
4538 | .PP |
|
|
4539 | .Vb 4 |
|
|
4540 | \& static void |
|
|
4541 | \& l_invoke (EV_P) |
|
|
4542 | \& { |
|
|
4543 | \& userdata *u = ev_userdata (EV_A); |
|
|
4544 | \& |
|
|
4545 | \& while (ev_pending_count (EV_A)) |
|
|
4546 | \& { |
|
|
4547 | \& wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
|
|
4548 | \& pthread_cond_wait (&u\->invoke_cv, &u\->lock); |
|
|
4549 | \& } |
|
|
4550 | \& } |
|
|
4551 | .Ve |
|
|
4552 | .PP |
|
|
4553 | Now, whenever the main thread gets told to invoke pending watchers, it |
|
|
4554 | will grab the lock, call \f(CW\*(C`ev_invoke_pending\*(C'\fR and then signal the loop |
|
|
4555 | thread to continue: |
|
|
4556 | .PP |
|
|
4557 | .Vb 4 |
|
|
4558 | \& static void |
|
|
4559 | \& real_invoke_pending (EV_P) |
|
|
4560 | \& { |
|
|
4561 | \& userdata *u = ev_userdata (EV_A); |
|
|
4562 | \& |
|
|
4563 | \& pthread_mutex_lock (&u\->lock); |
|
|
4564 | \& ev_invoke_pending (EV_A); |
|
|
4565 | \& pthread_cond_signal (&u\->invoke_cv); |
|
|
4566 | \& pthread_mutex_unlock (&u\->lock); |
|
|
4567 | \& } |
|
|
4568 | .Ve |
|
|
4569 | .PP |
|
|
4570 | Whenever you want to start/stop a watcher or do other modifications to an |
|
|
4571 | event loop, you will now have to lock: |
|
|
4572 | .PP |
|
|
4573 | .Vb 2 |
|
|
4574 | \& ev_timer timeout_watcher; |
|
|
4575 | \& userdata *u = ev_userdata (EV_A); |
|
|
4576 | \& |
|
|
4577 | \& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
4578 | \& |
|
|
4579 | \& pthread_mutex_lock (&u\->lock); |
|
|
4580 | \& ev_timer_start (EV_A_ &timeout_watcher); |
|
|
4581 | \& ev_async_send (EV_A_ &u\->async_w); |
|
|
4582 | \& pthread_mutex_unlock (&u\->lock); |
|
|
4583 | .Ve |
|
|
4584 | .PP |
|
|
4585 | Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise |
|
|
4586 | an event loop currently blocking in the kernel will have no knowledge |
|
|
4587 | about the newly added timer. By waking up the loop it will pick up any new |
|
|
4588 | watchers in the next event loop iteration. |
|
|
4589 | .PP |
|
|
4590 | \fI\s-1COROUTINES\s0\fR |
|
|
4591 | .IX Subsection "COROUTINES" |
|
|
4592 | .PP |
|
|
4593 | Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): |
|
|
4594 | libev fully supports nesting calls to its functions from different |
|
|
4595 | coroutines (e.g. you can call \f(CW\*(C`ev_run\*(C'\fR on the same loop from two |
|
|
4596 | different coroutines, and switch freely between both coroutines running |
|
|
4597 | the loop, as long as you don't confuse yourself). The only exception is |
|
|
4598 | that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. |
|
|
4599 | .PP |
|
|
4600 | Care has been taken to ensure that libev does not keep local state inside |
|
|
4601 | \&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as |
|
|
4602 | they do not call any callbacks. |
|
|
4603 | .SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" |
|
|
4604 | .IX Subsection "COMPILER WARNINGS" |
|
|
4605 | Depending on your compiler and compiler settings, you might get no or a |
|
|
4606 | lot of warnings when compiling libev code. Some people are apparently |
|
|
4607 | scared by this. |
|
|
4608 | .PP |
|
|
4609 | However, these are unavoidable for many reasons. For one, each compiler |
|
|
4610 | has different warnings, and each user has different tastes regarding |
|
|
4611 | warning options. \*(L"Warn-free\*(R" code therefore cannot be a goal except when |
|
|
4612 | targeting a specific compiler and compiler-version. |
|
|
4613 | .PP |
|
|
4614 | Another reason is that some compiler warnings require elaborate |
|
|
4615 | workarounds, or other changes to the code that make it less clear and less |
|
|
4616 | maintainable. |
|
|
4617 | .PP |
|
|
4618 | And of course, some compiler warnings are just plain stupid, or simply |
|
|
4619 | wrong (because they don't actually warn about the condition their message |
|
|
4620 | seems to warn about). For example, certain older gcc versions had some |
|
|
4621 | warnings that resulted in an extreme number of false positives. These have |
|
|
4622 | been fixed, but some people still insist on making code warn-free with |
|
|
4623 | such buggy versions. |
|
|
4624 | .PP |
|
|
4625 | While libev is written to generate as few warnings as possible, |
|
|
4626 | \&\*(L"warn-free\*(R" code is not a goal, and it is recommended not to build libev |
|
|
4627 | with any compiler warnings enabled unless you are prepared to cope with |
|
|
4628 | them (e.g. by ignoring them). Remember that warnings are just that: |
|
|
4629 | warnings, not errors, or proof of bugs. |
|
|
4630 | .SS "\s-1VALGRIND\s0" |
|
|
4631 | .IX Subsection "VALGRIND" |
|
|
4632 | Valgrind has a special section here because it is a popular tool that is |
|
|
4633 | highly useful. Unfortunately, valgrind reports are very hard to interpret. |
|
|
4634 | .PP |
|
|
4635 | If you think you found a bug (memory leak, uninitialised data access etc.) |
|
|
4636 | in libev, then check twice: If valgrind reports something like: |
|
|
4637 | .PP |
|
|
4638 | .Vb 3 |
|
|
4639 | \& ==2274== definitely lost: 0 bytes in 0 blocks. |
|
|
4640 | \& ==2274== possibly lost: 0 bytes in 0 blocks. |
|
|
4641 | \& ==2274== still reachable: 256 bytes in 1 blocks. |
|
|
4642 | .Ve |
|
|
4643 | .PP |
|
|
4644 | Then there is no memory leak, just as memory accounted to global variables |
|
|
4645 | is not a memleak \- the memory is still being referenced, and didn't leak. |
|
|
4646 | .PP |
|
|
4647 | Similarly, under some circumstances, valgrind might report kernel bugs |
|
|
4648 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
|
|
4649 | although an acceptable workaround has been found here), or it might be |
|
|
4650 | confused. |
|
|
4651 | .PP |
|
|
4652 | Keep in mind that valgrind is a very good tool, but only a tool. Don't |
|
|
4653 | make it into some kind of religion. |
|
|
4654 | .PP |
|
|
4655 | If you are unsure about something, feel free to contact the mailing list |
|
|
4656 | with the full valgrind report and an explanation on why you think this |
|
|
4657 | is a bug in libev (best check the archives, too :). However, don't be |
|
|
4658 | annoyed when you get a brisk \*(L"this is no bug\*(R" answer and take the chance |
|
|
4659 | of learning how to interpret valgrind properly. |
|
|
4660 | .PP |
|
|
4661 | If you need, for some reason, empty reports from valgrind for your project |
|
|
4662 | I suggest using suppression lists. |
|
|
4663 | .SH "PORTABILITY NOTES" |
|
|
4664 | .IX Header "PORTABILITY NOTES" |
|
|
4665 | .SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" |
|
|
4666 | .IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" |
|
|
4667 | GNU/Linux is the only common platform that supports 64 bit file/large file |
|
|
4668 | interfaces but \fIdisables\fR them by default. |
|
|
4669 | .PP |
|
|
4670 | That means that libev compiled in the default environment doesn't support |
|
|
4671 | files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. |
|
|
4672 | .PP |
|
|
4673 | Unfortunately, many programs try to work around this GNU/Linux issue |
|
|
4674 | by enabling the large file \s-1API\s0, which makes them incompatible with the |
|
|
4675 | standard libev compiled for their system. |
|
|
4676 | .PP |
|
|
4677 | Likewise, libev cannot enable the large file \s-1API\s0 itself as this would |
|
|
4678 | suddenly make it incompatible to the default compile time environment, |
|
|
4679 | i.e. all programs not using special compile switches. |
|
|
4680 | .SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" |
|
|
4681 | .IX Subsection "OS/X AND DARWIN BUGS" |
|
|
4682 | The whole thing is a bug if you ask me \- basically any system interface |
|
|
4683 | you touch is broken, whether it is locales, poll, kqueue or even the |
|
|
4684 | OpenGL drivers. |
|
|
4685 | .PP |
|
|
4686 | \fI\f(CI\*(C`kqueue\*(C'\fI is buggy\fR |
|
|
4687 | .IX Subsection "kqueue is buggy" |
|
|
4688 | .PP |
|
|
4689 | The kqueue syscall is broken in all known versions \- most versions support |
|
|
4690 | only sockets, many support pipes. |
|
|
4691 | .PP |
|
|
4692 | Libev tries to work around this by not using \f(CW\*(C`kqueue\*(C'\fR by default on this |
|
|
4693 | rotten platform, but of course you can still ask for it when creating a |
|
|
4694 | loop \- embedding a socket-only kqueue loop into a select-based one is |
|
|
4695 | probably going to work well. |
|
|
4696 | .PP |
|
|
4697 | \fI\f(CI\*(C`poll\*(C'\fI is buggy\fR |
|
|
4698 | .IX Subsection "poll is buggy" |
|
|
4699 | .PP |
|
|
4700 | Instead of fixing \f(CW\*(C`kqueue\*(C'\fR, Apple replaced their (working) \f(CW\*(C`poll\*(C'\fR |
|
|
4701 | implementation by something calling \f(CW\*(C`kqueue\*(C'\fR internally around the 10.5.6 |
|
|
4702 | release, so now \f(CW\*(C`kqueue\*(C'\fR \fIand\fR \f(CW\*(C`poll\*(C'\fR are broken. |
|
|
4703 | .PP |
|
|
4704 | Libev tries to work around this by not using \f(CW\*(C`poll\*(C'\fR by default on |
|
|
4705 | this rotten platform, but of course you can still ask for it when creating |
|
|
4706 | a loop. |
|
|
4707 | .PP |
|
|
4708 | \fI\f(CI\*(C`select\*(C'\fI is buggy\fR |
|
|
4709 | .IX Subsection "select is buggy" |
|
|
4710 | .PP |
|
|
4711 | All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this |
|
|
4712 | one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file |
|
|
4713 | descriptors you can pass in to 1024 \- your program suddenly crashes when |
|
|
4714 | you use more. |
|
|
4715 | .PP |
|
|
4716 | There is an undocumented \*(L"workaround\*(R" for this \- defining |
|
|
4717 | \&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR |
|
|
4718 | work on \s-1OS/X\s0. |
|
|
4719 | .SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" |
|
|
4720 | .IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" |
|
|
4721 | \fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR |
|
|
4722 | .IX Subsection "errno reentrancy" |
|
|
4723 | .PP |
|
|
4724 | The default compile environment on Solaris is unfortunately so |
|
|
4725 | thread-unsafe that you can't even use components/libraries compiled |
|
|
4726 | without \f(CW\*(C`\-D_REENTRANT\*(C'\fR in a threaded program, which, of course, isn't |
|
|
4727 | defined by default. A valid, if stupid, implementation choice. |
|
|
4728 | .PP |
|
|
4729 | If you want to use libev in threaded environments you have to make sure |
|
|
4730 | it's compiled with \f(CW\*(C`_REENTRANT\*(C'\fR defined. |
|
|
4731 | .PP |
|
|
4732 | \fIEvent port backend\fR |
|
|
4733 | .IX Subsection "Event port backend" |
|
|
4734 | .PP |
|
|
4735 | The scalable event interface for Solaris is called \*(L"event |
|
|
4736 | ports\*(R". Unfortunately, this mechanism is very buggy in all major |
|
|
4737 | releases. If you run into high \s-1CPU\s0 usage, your program freezes or you get |
|
|
4738 | a large number of spurious wakeups, make sure you have all the relevant |
|
|
4739 | and latest kernel patches applied. No, I don't know which ones, but there |
|
|
4740 | are multiple ones to apply, and afterwards, event ports actually work |
|
|
4741 | great. |
|
|
4742 | .PP |
|
|
4743 | If you can't get it to work, you can try running the program by setting |
|
|
4744 | the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and |
|
|
4745 | \&\f(CW\*(C`select\*(C'\fR backends. |
|
|
4746 | .SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" |
|
|
4747 | .IX Subsection "AIX POLL BUG" |
|
|
4748 | \&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around |
|
|
4749 | this by trying to avoid the poll backend altogether (i.e. it's not even |
|
|
4750 | compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine |
|
|
4751 | with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. |
|
|
4752 | .SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" |
|
|
4753 | .IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" |
|
|
4754 | \fIGeneral issues\fR |
|
|
4755 | .IX Subsection "General issues" |
|
|
4756 | .PP |
|
|
4757 | Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev |
|
|
4758 | requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0 |
|
|
4759 | model. Libev still offers limited functionality on this platform in |
|
|
4760 | the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket |
|
|
4761 | descriptors. This only applies when using Win32 natively, not when using |
|
|
4762 | e.g. cygwin. Actually, it only applies to the microsofts own compilers, |
|
|
4763 | as every compielr comes with a slightly differently broken/incompatible |
|
|
4764 | environment. |
|
|
4765 | .PP |
|
|
4766 | Lifting these limitations would basically require the full |
|
|
4767 | re-implementation of the I/O system. If you are into this kind of thing, |
|
|
4768 | then note that glib does exactly that for you in a very portable way (note |
|
|
4769 | also that glib is the slowest event library known to man). |
|
|
4770 | .PP |
|
|
4771 | There is no supported compilation method available on windows except |
|
|
4772 | embedding it into other applications. |
|
|
4773 | .PP |
|
|
4774 | Sensible signal handling is officially unsupported by Microsoft \- libev |
|
|
4775 | tries its best, but under most conditions, signals will simply not work. |
|
|
4776 | .PP |
|
|
4777 | Not a libev limitation but worth mentioning: windows apparently doesn't |
|
|
4778 | accept large writes: instead of resulting in a partial write, windows will |
|
|
4779 | either accept everything or return \f(CW\*(C`ENOBUFS\*(C'\fR if the buffer is too large, |
|
|
4780 | so make sure you only write small amounts into your sockets (less than a |
|
|
4781 | megabyte seems safe, but this apparently depends on the amount of memory |
|
|
4782 | available). |
|
|
4783 | .PP |
|
|
4784 | Due to the many, low, and arbitrary limits on the win32 platform and |
|
|
4785 | the abysmal performance of winsockets, using a large number of sockets |
|
|
4786 | is not recommended (and not reasonable). If your program needs to use |
|
|
4787 | more than a hundred or so sockets, then likely it needs to use a totally |
|
|
4788 | different implementation for windows, as libev offers the \s-1POSIX\s0 readiness |
|
|
4789 | notification model, which cannot be implemented efficiently on windows |
|
|
4790 | (due to Microsoft monopoly games). |
|
|
4791 | .PP |
|
|
4792 | A typical way to use libev under windows is to embed it (see the embedding |
|
|
4793 | section for details) and use the following \fIevwrap.h\fR header file instead |
|
|
4794 | of \fIev.h\fR: |
|
|
4795 | .PP |
|
|
4796 | .Vb 2 |
|
|
4797 | \& #define EV_STANDALONE /* keeps ev from requiring config.h */ |
|
|
4798 | \& #define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */ |
|
|
4799 | \& |
|
|
4800 | \& #include "ev.h" |
|
|
4801 | .Ve |
|
|
4802 | .PP |
|
|
4803 | And compile the following \fIevwrap.c\fR file into your project (make sure |
|
|
4804 | you do \fInot\fR compile the \fIev.c\fR or any other embedded source files!): |
|
|
4805 | .PP |
|
|
4806 | .Vb 2 |
|
|
4807 | \& #include "evwrap.h" |
|
|
4808 | \& #include "ev.c" |
|
|
4809 | .Ve |
|
|
4810 | .PP |
|
|
4811 | \fIThe winsocket \f(CI\*(C`select\*(C'\fI function\fR |
|
|
4812 | .IX Subsection "The winsocket select function" |
|
|
4813 | .PP |
|
|
4814 | The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it |
|
|
4815 | requires socket \fIhandles\fR and not socket \fIfile descriptors\fR (it is |
|
|
4816 | also extremely buggy). This makes select very inefficient, and also |
|
|
4817 | requires a mapping from file descriptors to socket handles (the Microsoft |
|
|
4818 | C runtime provides the function \f(CW\*(C`_open_osfhandle\*(C'\fR for this). See the |
|
|
4819 | discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR, \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and |
|
|
4820 | \&\f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor symbols for more info. |
|
|
4821 | .PP |
|
|
4822 | The configuration for a \*(L"naked\*(R" win32 using the Microsoft runtime |
|
|
4823 | libraries and raw winsocket select is: |
|
|
4824 | .PP |
|
|
4825 | .Vb 2 |
|
|
4826 | \& #define EV_USE_SELECT 1 |
|
|
4827 | \& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
|
|
4828 | .Ve |
|
|
4829 | .PP |
|
|
4830 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
|
|
4831 | complexity in the O(nA\*^X) range when using win32. |
|
|
4832 | .PP |
|
|
4833 | \fILimited number of file descriptors\fR |
|
|
4834 | .IX Subsection "Limited number of file descriptors" |
|
|
4835 | .PP |
|
|
4836 | Windows has numerous arbitrary (and low) limits on things. |
|
|
4837 | .PP |
|
|
4838 | Early versions of winsocket's select only supported waiting for a maximum |
|
|
4839 | of \f(CW64\fR handles (probably owning to the fact that all windows kernels |
|
|
4840 | can only wait for \f(CW64\fR things at the same time internally; Microsoft |
|
|
4841 | recommends spawning a chain of threads and wait for 63 handles and the |
|
|
4842 | previous thread in each. Sounds great!). |
|
|
4843 | .PP |
|
|
4844 | Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR |
|
|
4845 | to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select |
|
|
4846 | call (which might be in libev or elsewhere, for example, perl and many |
|
|
4847 | other interpreters do their own select emulation on windows). |
|
|
4848 | .PP |
|
|
4849 | Another limit is the number of file descriptors in the Microsoft runtime |
|
|
4850 | libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR |
|
|
4851 | fetish or something like this inside Microsoft). You can increase this |
|
|
4852 | by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR |
|
|
4853 | (another arbitrary limit), but is broken in many versions of the Microsoft |
|
|
4854 | runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets |
|
|
4855 | (depending on windows version and/or the phase of the moon). To get more, |
|
|
4856 | you need to wrap all I/O functions and provide your own fd management, but |
|
|
4857 | the cost of calling select (O(nA\*^X)) will likely make this unworkable. |
|
|
4858 | .SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" |
|
|
4859 | .IX Subsection "PORTABILITY REQUIREMENTS" |
|
|
4860 | In addition to a working ISO-C implementation and of course the |
|
|
4861 | backend-specific APIs, libev relies on a few additional extensions: |
|
|
4862 | .ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 |
|
|
4863 | .el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 |
|
|
4864 | .IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." |
|
|
4865 | Libev assumes not only that all watcher pointers have the same internal |
|
|
4866 | structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also |
|
|
4867 | assumes that the same (machine) code can be used to call any watcher |
|
|
4868 | callback: The watcher callbacks have different type signatures, but libev |
|
|
4869 | calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. |
|
|
4870 | .IP "pointer accesses must be thread-atomic" 4 |
|
|
4871 | .IX Item "pointer accesses must be thread-atomic" |
|
|
4872 | Accessing a pointer value must be atomic, it must both be readable and |
|
|
4873 | writable in one piece \- this is the case on all current architectures. |
|
|
4874 | .ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 |
|
|
4875 | .el .IP "\f(CWsig_atomic_t volatile\fR must be thread-atomic as well" 4 |
|
|
4876 | .IX Item "sig_atomic_t volatile must be thread-atomic as well" |
|
|
4877 | The type \f(CW\*(C`sig_atomic_t volatile\*(C'\fR (or whatever is defined as |
|
|
4878 | \&\f(CW\*(C`EV_ATOMIC_T\*(C'\fR) must be atomic with respect to accesses from different |
|
|
4879 | threads. This is not part of the specification for \f(CW\*(C`sig_atomic_t\*(C'\fR, but is |
|
|
4880 | believed to be sufficiently portable. |
|
|
4881 | .ie n .IP """sigprocmask"" must work in a threaded environment" 4 |
|
|
4882 | .el .IP "\f(CWsigprocmask\fR must work in a threaded environment" 4 |
|
|
4883 | .IX Item "sigprocmask must work in a threaded environment" |
|
|
4884 | Libev uses \f(CW\*(C`sigprocmask\*(C'\fR to temporarily block signals. This is not |
|
|
4885 | allowed in a threaded program (\f(CW\*(C`pthread_sigmask\*(C'\fR has to be used). Typical |
|
|
4886 | pthread implementations will either allow \f(CW\*(C`sigprocmask\*(C'\fR in the \*(L"main |
|
|
4887 | thread\*(R" or will block signals process-wide, both behaviours would |
|
|
4888 | be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and |
|
|
4889 | \&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. |
|
|
4890 | .Sp |
|
|
4891 | The most portable way to handle signals is to block signals in all threads |
|
|
4892 | except the initial one, and run the default loop in the initial thread as |
|
|
4893 | well. |
|
|
4894 | .ie n .IP """long"" must be large enough for common memory allocation sizes" 4 |
|
|
4895 | .el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 |
|
|
4896 | .IX Item "long must be large enough for common memory allocation sizes" |
|
|
4897 | To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally |
|
|
4898 | instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX |
|
|
4899 | systems (Microsoft...) this might be unexpectedly low, but is still at |
|
|
4900 | least 31 bits everywhere, which is enough for hundreds of millions of |
|
|
4901 | watchers. |
|
|
4902 | .ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 |
|
|
4903 | .el .IP "\f(CWdouble\fR must hold a time value in seconds with enough accuracy" 4 |
|
|
4904 | .IX Item "double must hold a time value in seconds with enough accuracy" |
|
|
4905 | The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to |
|
|
4906 | have at least 51 bits of mantissa (and 9 bits of exponent), which is |
|
|
4907 | good enough for at least into the year 4000 with millisecond accuracy |
|
|
4908 | (the design goal for libev). This requirement is overfulfilled by |
|
|
4909 | implementations using \s-1IEEE\s0 754, which is basically all existing ones. With |
|
|
4910 | \&\s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least 2200. |
|
|
4911 | .PP |
|
|
4912 | If you know of other additional requirements drop me a note. |
2457 | .SH "COMPLEXITIES" |
4913 | .SH "ALGORITHMIC COMPLEXITIES" |
2458 | .IX Header "COMPLEXITIES" |
4914 | .IX Header "ALGORITHMIC COMPLEXITIES" |
2459 | In this section the complexities of (many of) the algorithms used inside |
4915 | In this section the complexities of (many of) the algorithms used inside |
2460 | libev will be explained. For complexity discussions about backends see the |
4916 | libev will be documented. For complexity discussions about backends see |
2461 | documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
4917 | the documentation for \f(CW\*(C`ev_default_init\*(C'\fR. |
2462 | .Sp |
4918 | .PP |
2463 | All of the following are about amortised time: If an array needs to be |
4919 | All of the following are about amortised time: If an array needs to be |
2464 | extended, libev needs to realloc and move the whole array, but this |
4920 | extended, libev needs to realloc and move the whole array, but this |
2465 | happens asymptotically never with higher number of elements, so O(1) might |
4921 | happens asymptotically rarer with higher number of elements, so O(1) might |
2466 | mean it might do a lengthy realloc operation in rare cases, but on average |
4922 | mean that libev does a lengthy realloc operation in rare cases, but on |
2467 | it is much faster and asymptotically approaches constant time. |
4923 | average it is much faster and asymptotically approaches constant time. |
2468 | .RS 4 |
|
|
2469 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
4924 | .IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 |
2470 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
4925 | .IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" |
2471 | This means that, when you have a watcher that triggers in one hour and |
4926 | This means that, when you have a watcher that triggers in one hour and |
2472 | there are 100 watchers that would trigger before that then inserting will |
4927 | there are 100 watchers that would trigger before that, then inserting will |
2473 | have to skip those 100 watchers. |
4928 | have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers. |
2474 | .IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 |
4929 | .IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4 |
2475 | .IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" |
4930 | .IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" |
2476 | That means that for changing a timer costs less than removing/adding them |
4931 | That means that changing a timer costs less than removing/adding them, |
2477 | as only the relative motion in the event queue has to be paid for. |
4932 | as only the relative motion in the event queue has to be paid for. |
2478 | .IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 |
4933 | .IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4 |
2479 | .IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" |
4934 | .IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" |
2480 | These just add the watcher into an array or at the head of a list. |
4935 | These just add the watcher into an array or at the head of a list. |
|
|
4936 | .IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4 |
2481 | =item Stopping check/prepare/idle watchers: O(1) |
4937 | .IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)" |
|
|
4938 | .PD 0 |
2482 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
4939 | .IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 |
2483 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
4940 | .IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" |
|
|
4941 | .PD |
2484 | These watchers are stored in lists then need to be walked to find the |
4942 | These watchers are stored in lists, so they need to be walked to find the |
2485 | correct watcher to remove. The lists are usually short (you don't usually |
4943 | correct watcher to remove. The lists are usually short (you don't usually |
2486 | have many watchers waiting for the same fd or signal). |
4944 | have many watchers waiting for the same fd or signal: one is typical, two |
|
|
4945 | is rare). |
2487 | .IP "Finding the next timer per loop iteration: O(1)" 4 |
4946 | .IP "Finding the next timer in each loop iteration: O(1)" 4 |
2488 | .IX Item "Finding the next timer per loop iteration: O(1)" |
4947 | .IX Item "Finding the next timer in each loop iteration: O(1)" |
2489 | .PD 0 |
4948 | By virtue of using a binary or 4\-heap, the next timer is always found at a |
|
|
4949 | fixed position in the storage array. |
2490 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
4950 | .IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 |
2491 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
4951 | .IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" |
2492 | .PD |
|
|
2493 | A change means an I/O watcher gets started or stopped, which requires |
4952 | A change means an I/O watcher gets started or stopped, which requires |
2494 | libev to recalculate its status (and possibly tell the kernel). |
4953 | libev to recalculate its status (and possibly tell the kernel, depending |
2495 | .IP "Activating one watcher: O(1)" 4 |
4954 | on backend and whether \f(CW\*(C`ev_io_set\*(C'\fR was used). |
2496 | .IX Item "Activating one watcher: O(1)" |
4955 | .IP "Activating one watcher (putting it into the pending state): O(1)" 4 |
|
|
4956 | .IX Item "Activating one watcher (putting it into the pending state): O(1)" |
2497 | .PD 0 |
4957 | .PD 0 |
2498 | .IP "Priority handling: O(number_of_priorities)" 4 |
4958 | .IP "Priority handling: O(number_of_priorities)" 4 |
2499 | .IX Item "Priority handling: O(number_of_priorities)" |
4959 | .IX Item "Priority handling: O(number_of_priorities)" |
2500 | .PD |
4960 | .PD |
2501 | Priorities are implemented by allocating some space for each |
4961 | Priorities are implemented by allocating some space for each |
2502 | priority. When doing priority-based operations, libev usually has to |
4962 | priority. When doing priority-based operations, libev usually has to |
2503 | linearly search all the priorities. |
4963 | linearly search all the priorities, but starting/stopping and activating |
2504 | .RE |
4964 | watchers becomes O(1) with respect to priority handling. |
2505 | .RS 4 |
4965 | .IP "Sending an ev_async: O(1)" 4 |
|
|
4966 | .IX Item "Sending an ev_async: O(1)" |
|
|
4967 | .PD 0 |
|
|
4968 | .IP "Processing ev_async_send: O(number_of_async_watchers)" 4 |
|
|
4969 | .IX Item "Processing ev_async_send: O(number_of_async_watchers)" |
|
|
4970 | .IP "Processing signals: O(max_signal_number)" 4 |
|
|
4971 | .IX Item "Processing signals: O(max_signal_number)" |
|
|
4972 | .PD |
|
|
4973 | Sending involves a system call \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR |
|
|
4974 | calls in the current loop iteration. Checking for async and signal events |
|
|
4975 | involves iterating over all running async watchers or all signal numbers. |
|
|
4976 | .SH "PORTING FROM LIBEV 3.X TO 4.X" |
|
|
4977 | .IX Header "PORTING FROM LIBEV 3.X TO 4.X" |
|
|
4978 | The major version 4 introduced some incompatible changes to the \s-1API\s0. |
|
|
4979 | .PP |
|
|
4980 | At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions |
|
|
4981 | for all changes, so most programs should still compile. The compatibility |
|
|
4982 | layer might be removed in later versions of libev, so better update to the |
|
|
4983 | new \s-1API\s0 early than late. |
|
|
4984 | .ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 |
|
|
4985 | .el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 |
|
|
4986 | .IX Item "EV_COMPAT3 backwards compatibility mechanism" |
|
|
4987 | The backward compatibility mechanism can be controlled by |
|
|
4988 | \&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1MACROS\s0\*(R" in \s-1PREPROCESSOR\s0 \s-1SYMBOLS\s0 in the \s-1EMBEDDING\s0 |
|
|
4989 | section. |
|
|
4990 | .ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 |
|
|
4991 | .el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 |
|
|
4992 | .IX Item "ev_default_destroy and ev_default_fork have been removed" |
|
|
4993 | These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: |
|
|
4994 | .Sp |
|
|
4995 | .Vb 2 |
|
|
4996 | \& ev_loop_destroy (EV_DEFAULT_UC); |
|
|
4997 | \& ev_loop_fork (EV_DEFAULT); |
|
|
4998 | .Ve |
|
|
4999 | .IP "function/symbol renames" 4 |
|
|
5000 | .IX Item "function/symbol renames" |
|
|
5001 | A number of functions and symbols have been renamed: |
|
|
5002 | .Sp |
|
|
5003 | .Vb 3 |
|
|
5004 | \& ev_loop => ev_run |
|
|
5005 | \& EVLOOP_NONBLOCK => EVRUN_NOWAIT |
|
|
5006 | \& EVLOOP_ONESHOT => EVRUN_ONCE |
|
|
5007 | \& |
|
|
5008 | \& ev_unloop => ev_break |
|
|
5009 | \& EVUNLOOP_CANCEL => EVBREAK_CANCEL |
|
|
5010 | \& EVUNLOOP_ONE => EVBREAK_ONE |
|
|
5011 | \& EVUNLOOP_ALL => EVBREAK_ALL |
|
|
5012 | \& |
|
|
5013 | \& EV_TIMEOUT => EV_TIMER |
|
|
5014 | \& |
|
|
5015 | \& ev_loop_count => ev_iteration |
|
|
5016 | \& ev_loop_depth => ev_depth |
|
|
5017 | \& ev_loop_verify => ev_verify |
|
|
5018 | .Ve |
|
|
5019 | .Sp |
|
|
5020 | Most functions working on \f(CW\*(C`struct ev_loop\*(C'\fR objects don't have an |
|
|
5021 | \&\f(CW\*(C`ev_loop_\*(C'\fR prefix, so it was removed; \f(CW\*(C`ev_loop\*(C'\fR, \f(CW\*(C`ev_unloop\*(C'\fR and |
|
|
5022 | associated constants have been renamed to not collide with the \f(CW\*(C`struct |
|
|
5023 | ev_loop\*(C'\fR anymore and \f(CW\*(C`EV_TIMER\*(C'\fR now follows the same naming scheme |
|
|
5024 | as all other watcher types. Note that \f(CW\*(C`ev_loop_fork\*(C'\fR is still called |
|
|
5025 | \&\f(CW\*(C`ev_loop_fork\*(C'\fR because it would otherwise clash with the \f(CW\*(C`ev_fork\*(C'\fR |
|
|
5026 | typedef. |
|
|
5027 | .ie n .IP """EV_MINIMAL"" mechanism replaced by ""EV_FEATURES""" 4 |
|
|
5028 | .el .IP "\f(CWEV_MINIMAL\fR mechanism replaced by \f(CWEV_FEATURES\fR" 4 |
|
|
5029 | .IX Item "EV_MINIMAL mechanism replaced by EV_FEATURES" |
|
|
5030 | The preprocessor symbol \f(CW\*(C`EV_MINIMAL\*(C'\fR has been replaced by a different |
|
|
5031 | mechanism, \f(CW\*(C`EV_FEATURES\*(C'\fR. Programs using \f(CW\*(C`EV_MINIMAL\*(C'\fR usually compile |
|
|
5032 | and work, but the library code will of course be larger. |
|
|
5033 | .SH "GLOSSARY" |
|
|
5034 | .IX Header "GLOSSARY" |
|
|
5035 | .IP "active" 4 |
|
|
5036 | .IX Item "active" |
|
|
5037 | A watcher is active as long as it has been started and not yet stopped. |
|
|
5038 | See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. |
|
|
5039 | .IP "application" 4 |
|
|
5040 | .IX Item "application" |
|
|
5041 | In this document, an application is whatever is using libev. |
|
|
5042 | .IP "backend" 4 |
|
|
5043 | .IX Item "backend" |
|
|
5044 | The part of the code dealing with the operating system interfaces. |
|
|
5045 | .IP "callback" 4 |
|
|
5046 | .IX Item "callback" |
|
|
5047 | The address of a function that is called when some event has been |
|
|
5048 | detected. Callbacks are being passed the event loop, the watcher that |
|
|
5049 | received the event, and the actual event bitset. |
|
|
5050 | .IP "callback/watcher invocation" 4 |
|
|
5051 | .IX Item "callback/watcher invocation" |
|
|
5052 | The act of calling the callback associated with a watcher. |
|
|
5053 | .IP "event" 4 |
|
|
5054 | .IX Item "event" |
|
|
5055 | A change of state of some external event, such as data now being available |
|
|
5056 | for reading on a file descriptor, time having passed or simply not having |
|
|
5057 | any other events happening anymore. |
|
|
5058 | .Sp |
|
|
5059 | In libev, events are represented as single bits (such as \f(CW\*(C`EV_READ\*(C'\fR or |
|
|
5060 | \&\f(CW\*(C`EV_TIMER\*(C'\fR). |
|
|
5061 | .IP "event library" 4 |
|
|
5062 | .IX Item "event library" |
|
|
5063 | A software package implementing an event model and loop. |
|
|
5064 | .IP "event loop" 4 |
|
|
5065 | .IX Item "event loop" |
|
|
5066 | An entity that handles and processes external events and converts them |
|
|
5067 | into callback invocations. |
|
|
5068 | .IP "event model" 4 |
|
|
5069 | .IX Item "event model" |
|
|
5070 | The model used to describe how an event loop handles and processes |
|
|
5071 | watchers and events. |
|
|
5072 | .IP "pending" 4 |
|
|
5073 | .IX Item "pending" |
|
|
5074 | A watcher is pending as soon as the corresponding event has been |
|
|
5075 | detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. |
|
|
5076 | .IP "real time" 4 |
|
|
5077 | .IX Item "real time" |
|
|
5078 | The physical time that is observed. It is apparently strictly monotonic :) |
|
|
5079 | .IP "wall-clock time" 4 |
|
|
5080 | .IX Item "wall-clock time" |
|
|
5081 | The time and date as shown on clocks. Unlike real time, it can actually |
|
|
5082 | be wrong and jump forwards and backwards, e.g. when the you adjust your |
|
|
5083 | clock. |
|
|
5084 | .IP "watcher" 4 |
|
|
5085 | .IX Item "watcher" |
|
|
5086 | A data structure that describes interest in certain events. Watchers need |
|
|
5087 | to be started (attached to an event loop) before they can receive events. |
2506 | .SH "AUTHOR" |
5088 | .SH "AUTHOR" |
2507 | .IX Header "AUTHOR" |
5089 | .IX Header "AUTHOR" |
2508 | Marc Lehmann <libev@schmorp.de>. |
5090 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael |
|
|
5091 | Magnusson and Emanuele Giaquinta. |