ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.3
(Generate patch)

Comparing libev/ev.3 (file contents):
Revision 1.41 by root, Fri Dec 7 20:13:09 2007 UTC vs.
Revision 1.68 by root, Tue Jun 17 10:16:00 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines