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

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines