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

Comparing libev/ev.3 (file contents):
Revision 1.59 by root, Tue Dec 25 07:16:53 2007 UTC vs.
Revision 1.64 by root, Wed Apr 16 17:08:29 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 \{\
127.\} 130.\}
128.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
129.\" ======================================================================== 132.\" ========================================================================
130.\" 133.\"
131.IX Title "EV 1" 134.IX Title "EV 1"
132.TH EV 1 "2007-12-25" "perl v5.8.8" "User Contributed Perl Documentation" 135.TH EV 1 "2008-04-11" "perl v5.10.0" "User Contributed Perl Documentation"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
133.SH "NAME" 140.SH "NAME"
134libev \- a high performance full\-featured event loop written in C 141libev \- a high performance full\-featured event loop written in C
135.SH "SYNOPSIS" 142.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
137.Vb 1 144.Vb 1
138\& #include <ev.h> 145\& #include <ev.h>
139.Ve 146.Ve
140.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
141.IX Subsection "EXAMPLE PROGRAM" 148.IX Subsection "EXAMPLE PROGRAM"
142.Vb 1 149.Vb 2
150\& // a single header file is required
143\& #include <ev.h> 151\& #include <ev.h>
144.Ve 152\&
145.PP 153\& // every watcher type has its own typedef\*(Aqd struct
146.Vb 2 154\& // with the name ev_<type>
147\& ev_io stdin_watcher; 155\& ev_io stdin_watcher;
148\& ev_timer timeout_watcher; 156\& ev_timer timeout_watcher;
149.Ve 157\&
150.PP 158\& // all watcher callbacks have a similar signature
151.Vb 8
152\& /* called when data readable on stdin */ 159\& // this callback is called when data is readable on stdin
153\& static void 160\& static void
154\& stdin_cb (EV_P_ struct ev_io *w, int revents) 161\& stdin_cb (EV_P_ struct ev_io *w, int revents)
155\& { 162\& {
156\& /* puts ("stdin ready"); */ 163\& puts ("stdin ready");
157\& ev_io_stop (EV_A_ w); /* just a syntax example */ 164\& // for one\-shot events, one must manually stop the watcher
158\& ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ 165\& // with its corresponding stop function.
166\& ev_io_stop (EV_A_ w);
167\&
168\& // this causes all nested ev_loop\*(Aqs to stop iterating
169\& ev_unloop (EV_A_ EVUNLOOP_ALL);
159\& } 170\& }
160.Ve 171\&
161.PP 172\& // another callback, this time for a time\-out
162.Vb 6
163\& static void 173\& static void
164\& timeout_cb (EV_P_ struct ev_timer *w, int revents) 174\& timeout_cb (EV_P_ struct ev_timer *w, int revents)
165\& { 175\& {
166\& /* puts ("timeout"); */ 176\& puts ("timeout");
167\& ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ 177\& // this causes the innermost ev_loop to stop iterating
178\& ev_unloop (EV_A_ EVUNLOOP_ONE);
168\& } 179\& }
169.Ve 180\&
170.PP
171.Vb 4
172\& int 181\& int
173\& main (void) 182\& main (void)
174\& { 183\& {
184\& // use the default event loop unless you have special needs
175\& struct ev_loop *loop = ev_default_loop (0); 185\& struct ev_loop *loop = ev_default_loop (0);
176.Ve 186\&
177.PP
178.Vb 3
179\& /* initialise an io watcher, then start it */ 187\& // initialise an io watcher, then start it
188\& // this one will watch for stdin to become readable
180\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 189\& ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
181\& ev_io_start (loop, &stdin_watcher); 190\& ev_io_start (loop, &stdin_watcher);
182.Ve 191\&
183.PP 192\& // initialise a timer watcher, then start it
184.Vb 3
185\& /* simple non-repeating 5.5 second timeout */ 193\& // simple non\-repeating 5.5 second timeout
186\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 194\& ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
187\& ev_timer_start (loop, &timeout_watcher); 195\& ev_timer_start (loop, &timeout_watcher);
188.Ve 196\&
189.PP 197\& // now wait for events to arrive
190.Vb 2
191\& /* loop till timeout or data ready */
192\& ev_loop (loop, 0); 198\& ev_loop (loop, 0);
193.Ve 199\&
194.PP 200\& // unloop was called, so exit
195.Vb 2
196\& return 0; 201\& return 0;
197\& } 202\& }
198.Ve 203.Ve
199.SH "DESCRIPTION" 204.SH "DESCRIPTION"
200.IX Header "DESCRIPTION" 205.IX Header "DESCRIPTION"
201The newest version of this document is also available as a html-formatted 206The newest version of this document is also available as an html-formatted
202web page you might find easier to navigate when reading it for the first 207web page you might find easier to navigate when reading it for the first
203time: <http://cvs.schmorp.de/libev/ev.html>. 208time: <http://cvs.schmorp.de/libev/ev.html>.
204.PP 209.PP
205Libev is an event loop: you register interest in certain events (such as a 210Libev is an event loop: you register interest in certain events (such as a
206file descriptor being readable or a timeout occurring), and it will manage 211file descriptor being readable or a timeout occurring), and it will manage
230It also is quite fast (see this 235It also is quite fast (see this
231benchmark comparing it to libevent 236benchmark comparing it to libevent
232for example). 237for example).
233.Sh "\s-1CONVENTIONS\s0" 238.Sh "\s-1CONVENTIONS\s0"
234.IX Subsection "CONVENTIONS" 239.IX Subsection "CONVENTIONS"
235Libev is very configurable. In this manual the default configuration will 240Libev is very configurable. In this manual the default (and most common)
236be described, which supports multiple event loops. For more info about 241configuration will be described, which supports multiple event loops. For
237various configuration options please have a look at \fB\s-1EMBED\s0\fR section in 242more info about various configuration options please have a look at
238this manual. If libev was configured without support for multiple event 243\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
239loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR 244for multiple event loops, then all functions taking an initial argument of
240(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. 245name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
246this argument.
241.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0" 247.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0"
242.IX Subsection "TIME REPRESENTATION" 248.IX Subsection "TIME REPRESENTATION"
243Libev represents time as a single floating point number, representing the 249Libev represents time as a single floating point number, representing the
244(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 250(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
245the beginning of 1970, details are complicated, don't ask). This type is 251the beginning of 1970, details are complicated, don't ask). This type is
313(assuming you know what you are doing). This is the set of backends that 319(assuming you know what you are doing). This is the set of backends that
314libev will probe for if you specify no backends explicitly. 320libev will probe for if you specify no backends explicitly.
315.IP "unsigned int ev_embeddable_backends ()" 4 321.IP "unsigned int ev_embeddable_backends ()" 4
316.IX Item "unsigned int ev_embeddable_backends ()" 322.IX Item "unsigned int ev_embeddable_backends ()"
317Returns the set of backends that are embeddable in other event loops. This 323Returns the set of backends that are embeddable in other event loops. This
318is the theoretical, all\-platform, value. To find which backends 324is the theoretical, all-platform, value. To find which backends
319might be supported on the current system, you would need to look at 325might be supported on the current system, you would need to look at
320\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for 326\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
321recommended ones. 327recommended ones.
322.Sp 328.Sp
323See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 329See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
324.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 330.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
325.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 331.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
326Sets the allocation function to use (the prototype is similar \- the 332Sets the allocation function to use (the prototype is similar \- the
327semantics is identical \- to the realloc C function). It is used to 333semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
328allocate and free memory (no surprises here). If it returns zero when 334used to allocate and free memory (no surprises here). If it returns zero
329memory needs to be allocated, the library might abort or take some 335when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
330potentially destructive action. The default is your system realloc 336or take some potentially destructive action.
331function. 337.Sp
338Since some systems (at least OpenBSD and Darwin) fail to implement
339correct \f(CW\*(C`realloc\*(C'\fR semantics, libev will use a wrapper around the system
340\&\f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions by default.
332.Sp 341.Sp
333You could override this function in high-availability programs to, say, 342You could override this function in high-availability programs to, say,
334free some memory if it cannot allocate memory, to use a special allocator, 343free some memory if it cannot allocate memory, to use a special allocator,
335or even to sleep a while and retry until some memory is available. 344or even to sleep a while and retry until some memory is available.
336.Sp 345.Sp
337Example: Replace the libev allocator with one that waits a bit and then 346Example: Replace the libev allocator with one that waits a bit and then
338retries). 347retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR).
339.Sp 348.Sp
340.Vb 6 349.Vb 6
341\& static void * 350\& static void *
342\& persistent_realloc (void *ptr, size_t size) 351\& persistent_realloc (void *ptr, size_t size)
343\& { 352\& {
344\& for (;;) 353\& for (;;)
345\& { 354\& {
346\& void *newptr = realloc (ptr, size); 355\& void *newptr = realloc (ptr, size);
347.Ve 356\&
348.Sp
349.Vb 2
350\& if (newptr) 357\& if (newptr)
351\& return newptr; 358\& return newptr;
352.Ve 359\&
353.Sp
354.Vb 3
355\& sleep (60); 360\& sleep (60);
356\& } 361\& }
357\& } 362\& }
358.Ve 363\&
359.Sp
360.Vb 2
361\& ... 364\& ...
362\& ev_set_allocator (persistent_realloc); 365\& ev_set_allocator (persistent_realloc);
363.Ve 366.Ve
364.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 367.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4
365.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 368.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));"
378\& fatal_error (const char *msg) 381\& fatal_error (const char *msg)
379\& { 382\& {
380\& perror (msg); 383\& perror (msg);
381\& abort (); 384\& abort ();
382\& } 385\& }
383.Ve 386\&
384.Sp
385.Vb 2
386\& ... 387\& ...
387\& ev_set_syserr_cb (fatal_error); 388\& ev_set_syserr_cb (fatal_error);
388.Ve 389.Ve
389.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 390.SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
390.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 391.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
391An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two 392An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two
392types of such loops, the \fIdefault\fR loop, which supports signals and child 393types of such loops, the \fIdefault\fR loop, which supports signals and child
393events, and dynamically created loops which do not. 394events, and dynamically created loops which do not.
394.PP
395If you use threads, a common model is to run the default event loop
396in your main thread (or in a separate thread) and for each thread you
397create, you also create another event loop. Libev itself does no locking
398whatsoever, so if you mix calls to the same event loop in different
399threads, make sure you lock (this is usually a bad idea, though, even if
400done correctly, because it's hideous and inefficient).
401.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4 395.IP "struct ev_loop *ev_default_loop (unsigned int flags)" 4
402.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)" 396.IX Item "struct ev_loop *ev_default_loop (unsigned int flags)"
403This will initialise the default event loop if it hasn't been initialised 397This will initialise the default event loop if it hasn't been initialised
404yet and return it. If the default loop could not be initialised, returns 398yet and return it. If the default loop could not be initialised, returns
405false. If it already was initialised it simply returns it (and ignores the 399false. If it already was initialised it simply returns it (and ignores the
406flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards). 400flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards).
407.Sp 401.Sp
408If you don't know what event loop to use, use the one returned from this 402If you don't know what event loop to use, use the one returned from this
409function. 403function.
404.Sp
405Note that this function is \fInot\fR thread-safe, so if you want to use it
406from multiple threads, you have to lock (note also that this is unlikely,
407as loops cannot bes hared easily between threads anyway).
408.Sp
409The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and
410\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler
411for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your app you can either
412create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you
413can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling
414\&\f(CW\*(C`ev_default_init\*(C'\fR.
410.Sp 415.Sp
411The flags argument can be used to specify special behaviour or specific 416The flags argument can be used to specify special behaviour or specific
412backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). 417backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
413.Sp 418.Sp
414The following flags are supported: 419The following flags are supported:
435enabling this flag. 440enabling this flag.
436.Sp 441.Sp
437This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 442This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
438and thus this might slow down your event loop if you do a lot of loop 443and thus this might slow down your event loop if you do a lot of loop
439iterations and little real work, but is usually not noticeable (on my 444iterations and little real work, but is usually not noticeable (on my
440Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 445GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence
441without a syscall and thus \fIvery\fR fast, but my Linux system also has 446without a syscall and thus \fIvery\fR fast, but my GNU/Linux system also has
442\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 447\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
443.Sp 448.Sp
444The big advantage of this flag is that you can forget about fork (and 449The big advantage of this flag is that you can forget about fork (and
445forget about forgetting to tell libev about forking) when you use this 450forget about forgetting to tell libev about forking) when you use this
446flag. 451flag.
452.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 457.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
453This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 458This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
454libev tries to roll its own fd_set with no limits on the number of fds, 459libev tries to roll its own fd_set with no limits on the number of fds,
455but if that fails, expect a fairly low limit on the number of fds when 460but if that fails, expect a fairly low limit on the number of fds when
456using this backend. It doesn't scale too well (O(highest_fd)), but its 461using this backend. It doesn't scale too well (O(highest_fd)), but its
457usually the fastest backend for a low number of (low\-numbered :) fds. 462usually the fastest backend for a low number of (low-numbered :) fds.
458.Sp 463.Sp
459To get good performance out of this backend you need a high amount of 464To get good performance out of this backend you need a high amount of
460parallelity (most of the file descriptors should be busy). If you are 465parallelity (most of the file descriptors should be busy). If you are
461writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many 466writing a server, you should \f(CW\*(C`accept ()\*(C'\fR in a loop to accept as many
462connections as possible during one iteration. You might also want to have 467connections as possible during one iteration. You might also want to have
477For few fds, this backend is a bit little slower than poll and select, 482For few fds, this backend is a bit little slower than poll and select,
478but it scales phenomenally better. While poll and select usually scale 483but it scales phenomenally better. While poll and select usually scale
479like O(total_fds) where n is the total number of fds (or the highest fd), 484like O(total_fds) where n is the total number of fds (or the highest fd),
480epoll scales either O(1) or O(active_fds). The epoll design has a number 485epoll scales either O(1) or O(active_fds). The epoll design has a number
481of shortcomings, such as silently dropping events in some hard-to-detect 486of shortcomings, such as silently dropping events in some hard-to-detect
482cases and rewiring a syscall per fd change, no fork support and bad 487cases and requiring a syscall per fd change, no fork support and bad
483support for dup. 488support for dup.
484.Sp 489.Sp
485While stopping, setting and starting an I/O watcher in the same iteration 490While stopping, setting and starting an I/O watcher in the same iteration
486will result in some caching, there is still a syscall per such incident 491will result in some caching, there is still a syscall per such incident
487(because the fd could point to a different file description now), so its 492(because the fd could point to a different file description now), so its
547.Sp 552.Sp
548While this backend scales well, it requires one system call per active 553While this backend scales well, it requires one system call per active
549file descriptor per loop iteration. For small and medium numbers of file 554file descriptor per loop iteration. For small and medium numbers of file
550descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 555descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
551might perform better. 556might perform better.
557.Sp
558On the positive side, ignoring the spurious readyness notifications, this
559backend actually performed to specification in all tests and is fully
560embeddable, which is a rare feat among the OS-specific backends.
552.ie n .IP """EVBACKEND_ALL""" 4 561.ie n .IP """EVBACKEND_ALL""" 4
553.el .IP "\f(CWEVBACKEND_ALL\fR" 4 562.el .IP "\f(CWEVBACKEND_ALL\fR" 4
554.IX Item "EVBACKEND_ALL" 563.IX Item "EVBACKEND_ALL"
555Try all backends (even potentially broken ones that wouldn't be tried 564Try all backends (even potentially broken ones that wouldn't be tried
556with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as 565with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
559It is definitely not recommended to use this flag. 568It is definitely not recommended to use this flag.
560.RE 569.RE
561.RS 4 570.RS 4
562.Sp 571.Sp
563If one or more of these are ored into the flags value, then only these 572If one or more of these are ored into the flags value, then only these
564backends will be tried (in the reverse order as given here). If none are 573backends will be tried (in the reverse order as listed here). If none are
565specified, most compiled-in backend will be tried, usually in reverse 574specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried.
566order of their flag values :)
567.Sp 575.Sp
568The most typical usage is like this: 576The most typical usage is like this:
569.Sp 577.Sp
570.Vb 2 578.Vb 2
571\& if (!ev_default_loop (0)) 579\& if (!ev_default_loop (0))
591.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" 599.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
592Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is 600Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loop that is
593always distinct from the default loop. Unlike the default loop, it cannot 601always distinct from the default loop. Unlike the default loop, it cannot
594handle signal and child watchers, and attempts to do so will be greeted by 602handle signal and child watchers, and attempts to do so will be greeted by
595undefined behaviour (or a failed assertion if assertions are enabled). 603undefined behaviour (or a failed assertion if assertions are enabled).
604.Sp
605Note that this function \fIis\fR thread-safe, and the recommended way to use
606libev with threads is indeed to create one loop per thread, and using the
607default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
596.Sp 608.Sp
597Example: Try to create a event loop that uses epoll and nothing else. 609Example: Try to create a event loop that uses epoll and nothing else.
598.Sp 610.Sp
599.Vb 3 611.Vb 3
600\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 612\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
623.IX Item "ev_loop_destroy (loop)" 635.IX Item "ev_loop_destroy (loop)"
624Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an 636Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
625earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR. 637earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
626.IP "ev_default_fork ()" 4 638.IP "ev_default_fork ()" 4
627.IX Item "ev_default_fork ()" 639.IX Item "ev_default_fork ()"
640This function sets a flag that causes subsequent \f(CW\*(C`ev_loop\*(C'\fR iterations
628This function reinitialises the kernel state for backends that have 641to reinitialise the kernel state for backends that have one. Despite the
629one. Despite the name, you can call it anytime, but it makes most sense 642name, you can call it anytime, but it makes most sense after forking, in
630after forking, in either the parent or child process (or both, but that 643the child process (or both child and parent, but that again makes little
631again makes little sense). 644sense). You \fImust\fR call it in the child before using any of the libev
645functions, and it will only take effect at the next \f(CW\*(C`ev_loop\*(C'\fR iteration.
632.Sp 646.Sp
633You \fImust\fR call this function in the child process after forking if and 647On the other hand, you only need to call this function in the child
634only if you want to use the event library in both processes. If you just 648process if and only if you want to use the event library in the child. If
635fork+exec, you don't have to call it. 649you just fork+exec, you don't have to call it at all.
636.Sp 650.Sp
637The function itself is quite fast and it's usually not a problem to call 651The function itself is quite fast and it's usually not a problem to call
638it just in case after a fork. To make this easy, the function will fit in 652it just in case after a fork. To make this easy, the function will fit in
639quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR: 653quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR:
640.Sp 654.Sp
641.Vb 1 655.Vb 1
642\& pthread_atfork (0, 0, ev_default_fork); 656\& pthread_atfork (0, 0, ev_default_fork);
643.Ve 657.Ve
644.Sp
645At the moment, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR are safe to use
646without calling this function, so if you force one of those backends you
647do not need to care.
648.IP "ev_loop_fork (loop)" 4 658.IP "ev_loop_fork (loop)" 4
649.IX Item "ev_loop_fork (loop)" 659.IX Item "ev_loop_fork (loop)"
650Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 660Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
651\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop 661\&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
652after fork, and how you do this is entirely your own problem. 662after fork, and how you do this is entirely your own problem.
663.IP "int ev_is_default_loop (loop)" 4
664.IX Item "int ev_is_default_loop (loop)"
665Returns true when the given loop actually is the default loop, false otherwise.
653.IP "unsigned int ev_loop_count (loop)" 4 666.IP "unsigned int ev_loop_count (loop)" 4
654.IX Item "unsigned int ev_loop_count (loop)" 667.IX Item "unsigned int ev_loop_count (loop)"
655Returns the count of loop iterations for the loop, which is identical to 668Returns the count of loop iterations for the loop, which is identical to
656the number of times libev did poll for new events. It starts at \f(CW0\fR and 669the number of times libev did poll for new events. It starts at \f(CW0\fR and
657happily wraps around with enough iterations. 670happily wraps around with enough iterations.
697libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is 710libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
698usually a better approach for this kind of thing. 711usually a better approach for this kind of thing.
699.Sp 712.Sp
700Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 713Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
701.Sp 714.Sp
702.Vb 19 715.Vb 10
703\& - Before the first iteration, call any pending watchers. 716\& \- Before the first iteration, call any pending watchers.
704\& * If there are no active watchers (reference count is zero), return. 717\& * If EVFLAG_FORKCHECK was used, check for a fork.
705\& - Queue all prepare watchers and then call all outstanding watchers. 718\& \- If a fork was detected, queue and call all fork watchers.
719\& \- Queue and call all prepare watchers.
706\& - If we have been forked, recreate the kernel state. 720\& \- If we have been forked, recreate the kernel state.
707\& - Update the kernel state with all outstanding changes. 721\& \- Update the kernel state with all outstanding changes.
708\& - Update the "event loop time". 722\& \- Update the "event loop time".
709\& - Calculate for how long to block. 723\& \- Calculate for how long to sleep or block, if at all
724\& (active idle watchers, EVLOOP_NONBLOCK or not having
725\& any active watchers at all will result in not sleeping).
726\& \- Sleep if the I/O and timer collect interval say so.
710\& - Block the process, waiting for any events. 727\& \- Block the process, waiting for any events.
711\& - Queue all outstanding I/O (fd) events. 728\& \- Queue all outstanding I/O (fd) events.
712\& - Update the "event loop time" and do time jump handling. 729\& \- Update the "event loop time" and do time jump handling.
713\& - Queue all outstanding timers. 730\& \- Queue all outstanding timers.
714\& - Queue all outstanding periodics. 731\& \- Queue all outstanding periodics.
715\& - If no events are pending now, queue all idle watchers. 732\& \- If no events are pending now, queue all idle watchers.
716\& - Queue all check watchers. 733\& \- Queue all check watchers.
717\& - Call all queued watchers in reverse order (i.e. check watchers first). 734\& \- Call all queued watchers in reverse order (i.e. check watchers first).
718\& Signals and child watchers are implemented as I/O watchers, and will 735\& Signals and child watchers are implemented as I/O watchers, and will
719\& be handled here by queueing them when their watcher gets executed. 736\& be handled here by queueing them when their watcher gets executed.
720\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 737\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
721\& were used, return, otherwise continue with step *. 738\& were used, or there are no active watchers, return, otherwise
739\& continue with step *.
722.Ve 740.Ve
723.Sp 741.Sp
724Example: Queue some jobs and then loop until no events are outsanding 742Example: Queue some jobs and then loop until no events are outstanding
725anymore. 743anymore.
726.Sp 744.Sp
727.Vb 4 745.Vb 4
728\& ... queue jobs here, make sure they register event watchers as long 746\& ... queue jobs here, make sure they register event watchers as long
729\& ... as they still have work to do (even an idle watcher will do..) 747\& ... as they still have work to do (even an idle watcher will do..)
734.IX Item "ev_unloop (loop, how)" 752.IX Item "ev_unloop (loop, how)"
735Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it 753Can be used to make a call to \f(CW\*(C`ev_loop\*(C'\fR return early (but only after it
736has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either 754has processed all outstanding events). The \f(CW\*(C`how\*(C'\fR argument must be either
737\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or 755\&\f(CW\*(C`EVUNLOOP_ONE\*(C'\fR, which will make the innermost \f(CW\*(C`ev_loop\*(C'\fR call return, or
738\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return. 756\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return.
757.Sp
758This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again.
739.IP "ev_ref (loop)" 4 759.IP "ev_ref (loop)" 4
740.IX Item "ev_ref (loop)" 760.IX Item "ev_ref (loop)"
741.PD 0 761.PD 0
742.IP "ev_unref (loop)" 4 762.IP "ev_unref (loop)" 4
743.IX Item "ev_unref (loop)" 763.IX Item "ev_unref (loop)"
749returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For 769returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For
750example, libev itself uses this for its internal signal pipe: It is not 770example, libev itself uses this for its internal signal pipe: It is not
751visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if 771visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exiting if
752no event watchers registered by it are active. It is also an excellent 772no event watchers registered by it are active. It is also an excellent
753way to do this for generic recurring timers or from within third-party 773way to do this for generic recurring timers or from within third-party
754libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR. 774libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR
775(but only if the watcher wasn't active before, or was active before,
776respectively).
755.Sp 777.Sp
756Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 778Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
757running when nothing else is active. 779running when nothing else is active.
758.Sp 780.Sp
759.Vb 4 781.Vb 4
816\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 838\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
817\& { 839\& {
818\& ev_io_stop (w); 840\& ev_io_stop (w);
819\& ev_unloop (loop, EVUNLOOP_ALL); 841\& ev_unloop (loop, EVUNLOOP_ALL);
820\& } 842\& }
821.Ve 843\&
822.PP
823.Vb 6
824\& struct ev_loop *loop = ev_default_loop (0); 844\& struct ev_loop *loop = ev_default_loop (0);
825\& struct ev_io stdin_watcher; 845\& struct ev_io stdin_watcher;
826\& ev_init (&stdin_watcher, my_cb); 846\& ev_init (&stdin_watcher, my_cb);
827\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 847\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
828\& ev_io_start (loop, &stdin_watcher); 848\& ev_io_start (loop, &stdin_watcher);
916.ie n .IP """EV_FORK""" 4 936.ie n .IP """EV_FORK""" 4
917.el .IP "\f(CWEV_FORK\fR" 4 937.el .IP "\f(CWEV_FORK\fR" 4
918.IX Item "EV_FORK" 938.IX Item "EV_FORK"
919The event loop has been resumed in the child process after fork (see 939The event loop has been resumed in the child process after fork (see
920\&\f(CW\*(C`ev_fork\*(C'\fR). 940\&\f(CW\*(C`ev_fork\*(C'\fR).
941.ie n .IP """EV_ASYNC""" 4
942.el .IP "\f(CWEV_ASYNC\fR" 4
943.IX Item "EV_ASYNC"
944The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
921.ie n .IP """EV_ERROR""" 4 945.ie n .IP """EV_ERROR""" 4
922.el .IP "\f(CWEV_ERROR\fR" 4 946.el .IP "\f(CWEV_ERROR\fR" 4
923.IX Item "EV_ERROR" 947.IX Item "EV_ERROR"
924An unspecified error has occured, the watcher has been stopped. This might 948An unspecified error has occured, the watcher has been stopped. This might
925happen because the watcher could not be properly started because libev 949happen because the watcher could not be properly started because libev
1089In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated, 1113In this case getting the pointer to \f(CW\*(C`my_biggy\*(C'\fR is a bit more complicated,
1090you need to use \f(CW\*(C`offsetof\*(C'\fR: 1114you need to use \f(CW\*(C`offsetof\*(C'\fR:
1091.PP 1115.PP
1092.Vb 1 1116.Vb 1
1093\& #include <stddef.h> 1117\& #include <stddef.h>
1094.Ve 1118\&
1095.PP
1096.Vb 6
1097\& static void 1119\& static void
1098\& t1_cb (EV_P_ struct ev_timer *w, int revents) 1120\& t1_cb (EV_P_ struct ev_timer *w, int revents)
1099\& { 1121\& {
1100\& struct my_biggy big = (struct my_biggy * 1122\& struct my_biggy big = (struct my_biggy *
1101\& (((char *)w) - offsetof (struct my_biggy, t1)); 1123\& (((char *)w) \- offsetof (struct my_biggy, t1));
1102\& } 1124\& }
1103.Ve 1125\&
1104.PP
1105.Vb 6
1106\& static void 1126\& static void
1107\& t2_cb (EV_P_ struct ev_timer *w, int revents) 1127\& t2_cb (EV_P_ struct ev_timer *w, int revents)
1108\& { 1128\& {
1109\& struct my_biggy big = (struct my_biggy * 1129\& struct my_biggy big = (struct my_biggy *
1110\& (((char *)w) - offsetof (struct my_biggy, t2)); 1130\& (((char *)w) \- offsetof (struct my_biggy, t2));
1111\& } 1131\& }
1112.Ve 1132.Ve
1113.SH "WATCHER TYPES" 1133.SH "WATCHER TYPES"
1114.IX Header "WATCHER TYPES" 1134.IX Header "WATCHER TYPES"
1115This section describes each watcher in detail, but will not repeat 1135This section describes each watcher in detail, but will not repeat
1203To support fork in your programs, you either have to call 1223To support fork in your programs, you either have to call
1204\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, 1224\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child,
1205enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or 1225enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or
1206\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1226\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1207.PP 1227.PP
1228\fIThe special problem of \s-1SIGPIPE\s0\fR
1229.IX Subsection "The special problem of SIGPIPE"
1230.PP
1231While not really specific to libev, it is easy to forget about \s-1SIGPIPE:\s0
1232when reading from a pipe whose other end has been closed, your program
1233gets send a \s-1SIGPIPE\s0, which, by default, aborts your program. For most
1234programs this is sensible behaviour, for daemons, this is usually
1235undesirable.
1236.PP
1237So when you encounter spurious, unexplained daemon exits, make sure you
1238ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1239somewhere, as that would have given you a big clue).
1240.PP
1208\fIWatcher-Specific Functions\fR 1241\fIWatcher-Specific Functions\fR
1209.IX Subsection "Watcher-Specific Functions" 1242.IX Subsection "Watcher-Specific Functions"
1210.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1243.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
1211.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1244.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
1212.PD 0 1245.PD 0
1221The file descriptor being watched. 1254The file descriptor being watched.
1222.IP "int events [read\-only]" 4 1255.IP "int events [read\-only]" 4
1223.IX Item "int events [read-only]" 1256.IX Item "int events [read-only]"
1224The events being watched. 1257The events being watched.
1225.PP 1258.PP
1259\fIExamples\fR
1260.IX Subsection "Examples"
1261.PP
1226Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1262Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
1227readable, but only once. Since it is likely line\-buffered, you could 1263readable, but only once. Since it is likely line-buffered, you could
1228attempt to read a whole line in the callback. 1264attempt to read a whole line in the callback.
1229.PP 1265.PP
1230.Vb 6 1266.Vb 6
1231\& static void 1267\& static void
1232\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1268\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1233\& { 1269\& {
1234\& ev_io_stop (loop, w); 1270\& ev_io_stop (loop, w);
1235\& .. read from stdin here (or from w->fd) and haqndle any I/O errors 1271\& .. read from stdin here (or from w\->fd) and haqndle any I/O errors
1236\& } 1272\& }
1237.Ve 1273\&
1238.PP
1239.Vb 6
1240\& ... 1274\& ...
1241\& struct ev_loop *loop = ev_default_init (0); 1275\& struct ev_loop *loop = ev_default_init (0);
1242\& struct ev_io stdin_readable; 1276\& struct ev_io stdin_readable;
1243\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1277\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1244\& ev_io_start (loop, &stdin_readable); 1278\& ev_io_start (loop, &stdin_readable);
1261of the event triggering whatever timeout you are modifying/starting. If 1295of the event triggering whatever timeout you are modifying/starting. If
1262you suspect event processing to be delayed and you \fIneed\fR to base the timeout 1296you suspect event processing to be delayed and you \fIneed\fR to base the timeout
1263on the current time, use something like this to adjust for this: 1297on the current time, use something like this to adjust for this:
1264.PP 1298.PP
1265.Vb 1 1299.Vb 1
1266\& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1300\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.);
1267.Ve 1301.Ve
1268.PP 1302.PP
1269The callback is guarenteed to be invoked only when its timeout has passed, 1303The callback is guarenteed to be invoked only when its timeout has passed,
1270but if multiple timers become ready during the same loop iteration then 1304but if multiple timers become ready during the same loop iteration then
1271order of execution is undefined. 1305order of execution is undefined.
1286The timer itself will do a best-effort at avoiding drift, that is, if you 1320The timer itself will do a best-effort at avoiding drift, that is, if you
1287configure a timer to trigger every 10 seconds, then it will trigger at 1321configure a timer to trigger every 10 seconds, then it will trigger at
1288exactly 10 second intervals. If, however, your program cannot keep up with 1322exactly 10 second intervals. If, however, your program cannot keep up with
1289the timer (because it takes longer than those 10 seconds to do stuff) the 1323the timer (because it takes longer than those 10 seconds to do stuff) the
1290timer will not fire more than once per event loop iteration. 1324timer will not fire more than once per event loop iteration.
1291.IP "ev_timer_again (loop)" 4 1325.IP "ev_timer_again (loop, ev_timer *)" 4
1292.IX Item "ev_timer_again (loop)" 1326.IX Item "ev_timer_again (loop, ev_timer *)"
1293This will act as if the timer timed out and restart it again if it is 1327This will act as if the timer timed out and restart it again if it is
1294repeating. The exact semantics are: 1328repeating. The exact semantics are:
1295.Sp 1329.Sp
1296If the timer is pending, its pending status is cleared. 1330If the timer is pending, its pending status is cleared.
1297.Sp 1331.Sp
1315.Sp 1349.Sp
1316.Vb 8 1350.Vb 8
1317\& ev_timer_init (timer, callback, 0., 5.); 1351\& ev_timer_init (timer, callback, 0., 5.);
1318\& ev_timer_again (loop, timer); 1352\& ev_timer_again (loop, timer);
1319\& ... 1353\& ...
1320\& timer->again = 17.; 1354\& timer\->again = 17.;
1321\& ev_timer_again (loop, timer); 1355\& ev_timer_again (loop, timer);
1322\& ... 1356\& ...
1323\& timer->again = 10.; 1357\& timer\->again = 10.;
1324\& ev_timer_again (loop, timer); 1358\& ev_timer_again (loop, timer);
1325.Ve 1359.Ve
1326.Sp 1360.Sp
1327This is more slightly efficient then stopping/starting the timer each time 1361This is more slightly efficient then stopping/starting the timer each time
1328you want to modify its timeout value. 1362you want to modify its timeout value.
1330.IX Item "ev_tstamp repeat [read-write]" 1364.IX Item "ev_tstamp repeat [read-write]"
1331The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 1365The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1332or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), 1366or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1333which is also when any modifications are taken into account. 1367which is also when any modifications are taken into account.
1334.PP 1368.PP
1369\fIExamples\fR
1370.IX Subsection "Examples"
1371.PP
1335Example: Create a timer that fires after 60 seconds. 1372Example: Create a timer that fires after 60 seconds.
1336.PP 1373.PP
1337.Vb 5 1374.Vb 5
1338\& static void 1375\& static void
1339\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1376\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1340\& { 1377\& {
1341\& .. one minute over, w is actually stopped right here 1378\& .. one minute over, w is actually stopped right here
1342\& } 1379\& }
1343.Ve 1380\&
1344.PP
1345.Vb 3
1346\& struct ev_timer mytimer; 1381\& struct ev_timer mytimer;
1347\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1382\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1348\& ev_timer_start (loop, &mytimer); 1383\& ev_timer_start (loop, &mytimer);
1349.Ve 1384.Ve
1350.PP 1385.PP
1355\& static void 1390\& static void
1356\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1391\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1357\& { 1392\& {
1358\& .. ten seconds without any activity 1393\& .. ten seconds without any activity
1359\& } 1394\& }
1360.Ve 1395\&
1361.PP
1362.Vb 4
1363\& struct ev_timer mytimer; 1396\& struct ev_timer mytimer;
1364\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 1397\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1365\& ev_timer_again (&mytimer); /* start timer */ 1398\& ev_timer_again (&mytimer); /* start timer */
1366\& ev_loop (loop, 0); 1399\& ev_loop (loop, 0);
1367.Ve 1400\&
1368.PP
1369.Vb 3
1370\& // and in some piece of code that gets executed on any "activity": 1401\& // and in some piece of code that gets executed on any "activity":
1371\& // reset the timeout to start ticking again at 10 seconds 1402\& // reset the timeout to start ticking again at 10 seconds
1372\& ev_timer_again (&mytimer); 1403\& ev_timer_again (&mytimer);
1373.Ve 1404.Ve
1374.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 1405.ie n .Sh """ev_periodic"" \- to cron or not to cron?"
1402.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 1433.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)"
1403.PD 1434.PD
1404Lots of arguments, lets sort it out... There are basically three modes of 1435Lots of arguments, lets sort it out... There are basically three modes of
1405operation, and we will explain them from simplest to complex: 1436operation, and we will explain them from simplest to complex:
1406.RS 4 1437.RS 4
1438.IP "\(bu" 4
1407.IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 1439absolute timer (at = time, interval = reschedule_cb = 0)
1408.IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" 1440.Sp
1409In this configuration the watcher triggers an event at the wallclock time 1441In this configuration the watcher triggers an event at the wallclock time
1410\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 1442\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs,
1411that is, if it is to be run at January 1st 2011 then it will run when the 1443that is, if it is to be run at January 1st 2011 then it will run when the
1412system time reaches or surpasses this time. 1444system time reaches or surpasses this time.
1445.IP "\(bu" 4
1413.IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 1446repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1414.IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 1447.Sp
1415In this mode the watcher will always be scheduled to time out at the next 1448In this mode the watcher will always be scheduled to time out at the next
1416\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) 1449\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative)
1417and then repeat, regardless of any time jumps. 1450and then repeat, regardless of any time jumps.
1418.Sp 1451.Sp
1419This can be used to create timers that do not drift with respect to system 1452This can be used to create timers that do not drift with respect to system
1433time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 1466time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.
1434.Sp 1467.Sp
1435For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near 1468For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near
1436\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 1469\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1437this value. 1470this value.
1471.IP "\(bu" 4
1438.IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 1472manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1439.IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 1473.Sp
1440In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 1474In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being
1441ignored. Instead, each time the periodic watcher gets scheduled, the 1475ignored. Instead, each time the periodic watcher gets scheduled, the
1442reschedule callback will be called with the watcher as first, and the 1476reschedule callback will be called with the watcher as first, and the
1443current time as second argument. 1477current time as second argument.
1444.Sp 1478.Sp
1499.IP "ev_tstamp at [read\-only]" 4 1533.IP "ev_tstamp at [read\-only]" 4
1500.IX Item "ev_tstamp at [read-only]" 1534.IX Item "ev_tstamp at [read-only]"
1501When active, contains the absolute time that the watcher is supposed to 1535When active, contains the absolute time that the watcher is supposed to
1502trigger next. 1536trigger next.
1503.PP 1537.PP
1538\fIExamples\fR
1539.IX Subsection "Examples"
1540.PP
1504Example: Call a callback every hour, or, more precisely, whenever the 1541Example: Call a callback every hour, or, more precisely, whenever the
1505system clock is divisible by 3600. The callback invocation times have 1542system clock is divisible by 3600. The callback invocation times have
1506potentially a lot of jittering, but good long-term stability. 1543potentially a lot of jittering, but good long-term stability.
1507.PP 1544.PP
1508.Vb 5 1545.Vb 5
1509\& static void 1546\& static void
1510\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1547\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1511\& { 1548\& {
1512\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 1549\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1513\& } 1550\& }
1514.Ve 1551\&
1515.PP
1516.Vb 3
1517\& struct ev_periodic hourly_tick; 1552\& struct ev_periodic hourly_tick;
1518\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1553\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1519\& ev_periodic_start (loop, &hourly_tick); 1554\& ev_periodic_start (loop, &hourly_tick);
1520.Ve 1555.Ve
1521.PP 1556.PP
1522Example: The same as above, but use a reschedule callback to do it: 1557Example: The same as above, but use a reschedule callback to do it:
1523.PP 1558.PP
1524.Vb 1 1559.Vb 1
1525\& #include <math.h> 1560\& #include <math.h>
1526.Ve 1561\&
1527.PP
1528.Vb 5
1529\& static ev_tstamp 1562\& static ev_tstamp
1530\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1563\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1531\& { 1564\& {
1532\& return fmod (now, 3600.) + 3600.; 1565\& return fmod (now, 3600.) + 3600.;
1533\& } 1566\& }
1534.Ve 1567\&
1535.PP
1536.Vb 1
1537\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1568\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1538.Ve 1569.Ve
1539.PP 1570.PP
1540Example: Call a callback every hour, starting now: 1571Example: Call a callback every hour, starting now:
1541.PP 1572.PP
1557first watcher gets started will libev actually register a signal watcher 1588first watcher gets started will libev actually register a signal watcher
1558with the kernel (thus it coexists with your own signal handlers as long 1589with the kernel (thus it coexists with your own signal handlers as long
1559as you don't register any with libev). Similarly, when the last signal 1590as you don't register any with libev). Similarly, when the last signal
1560watcher for a signal is stopped libev will reset the signal handler to 1591watcher for a signal is stopped libev will reset the signal handler to
1561\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 1592\&\s-1SIG_DFL\s0 (regardless of what it was set to before).
1593.PP
1594If possible and supported, libev will install its handlers with
1595\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so syscalls should not be unduly
1596interrupted. If you have a problem with syscalls getting interrupted by
1597signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock
1598them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
1562.PP 1599.PP
1563\fIWatcher-Specific Functions and Data Members\fR 1600\fIWatcher-Specific Functions and Data Members\fR
1564.IX Subsection "Watcher-Specific Functions and Data Members" 1601.IX Subsection "Watcher-Specific Functions and Data Members"
1565.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 1602.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
1566.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 1603.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
1571Configures the watcher to trigger on the given signal number (usually one 1608Configures the watcher to trigger on the given signal number (usually one
1572of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 1609of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1573.IP "int signum [read\-only]" 4 1610.IP "int signum [read\-only]" 4
1574.IX Item "int signum [read-only]" 1611.IX Item "int signum [read-only]"
1575The signal the watcher watches out for. 1612The signal the watcher watches out for.
1613.PP
1614\fIExamples\fR
1615.IX Subsection "Examples"
1616.PP
1617Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1618.PP
1619.Vb 5
1620\& static void
1621\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1622\& {
1623\& ev_unloop (loop, EVUNLOOP_ALL);
1624\& }
1625\&
1626\& struct ev_signal signal_watcher;
1627\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1628\& ev_signal_start (loop, &sigint_cb);
1629.Ve
1576.ie n .Sh """ev_child"" \- watch out for process status changes" 1630.ie n .Sh """ev_child"" \- watch out for process status changes"
1577.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 1631.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1578.IX Subsection "ev_child - watch out for process status changes" 1632.IX Subsection "ev_child - watch out for process status changes"
1579Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1633Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1580some child status changes (most typically when a child of yours dies). 1634some child status changes (most typically when a child of yours dies). It
1635is permissible to install a child watcher \fIafter\fR the child has been
1636forked (which implies it might have already exited), as long as the event
1637loop isn't entered (or is continued from a watcher).
1638.PP
1639Only the default event loop is capable of handling signals, and therefore
1640you can only rgeister child watchers in the default event loop.
1641.PP
1642\fIProcess Interaction\fR
1643.IX Subsection "Process Interaction"
1644.PP
1645Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
1646initialised. This is necessary to guarantee proper behaviour even if
1647the first child watcher is started after the child exits. The occurance
1648of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
1649synchronously as part of the event loop processing. Libev always reaps all
1650children, even ones not watched.
1651.PP
1652\fIOverriding the Built-In Processing\fR
1653.IX Subsection "Overriding the Built-In Processing"
1654.PP
1655Libev offers no special support for overriding the built-in child
1656processing, but if your application collides with libev's default child
1657handler, you can override it easily by installing your own handler for
1658\&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the
1659default loop never gets destroyed. You are encouraged, however, to use an
1660event-based approach to child reaping and thus use libev's support for
1661that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely.
1581.PP 1662.PP
1582\fIWatcher-Specific Functions and Data Members\fR 1663\fIWatcher-Specific Functions and Data Members\fR
1583.IX Subsection "Watcher-Specific Functions and Data Members" 1664.IX Subsection "Watcher-Specific Functions and Data Members"
1584.IP "ev_child_init (ev_child *, callback, int pid)" 4 1665.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
1585.IX Item "ev_child_init (ev_child *, callback, int pid)" 1666.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
1586.PD 0 1667.PD 0
1587.IP "ev_child_set (ev_child *, int pid)" 4 1668.IP "ev_child_set (ev_child *, int pid, int trace)" 4
1588.IX Item "ev_child_set (ev_child *, int pid)" 1669.IX Item "ev_child_set (ev_child *, int pid, int trace)"
1589.PD 1670.PD
1590Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or 1671Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or
1591\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 1672\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1592at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 1673at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1593the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 1674the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1594\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 1675\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1595process causing the status change. 1676process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only
1677activate the watcher when the process terminates) or \f(CW1\fR (additionally
1678activate the watcher when the process is stopped or continued).
1596.IP "int pid [read\-only]" 4 1679.IP "int pid [read\-only]" 4
1597.IX Item "int pid [read-only]" 1680.IX Item "int pid [read-only]"
1598The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. 1681The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1599.IP "int rpid [read\-write]" 4 1682.IP "int rpid [read\-write]" 4
1600.IX Item "int rpid [read-write]" 1683.IX Item "int rpid [read-write]"
1602.IP "int rstatus [read\-write]" 4 1685.IP "int rstatus [read\-write]" 4
1603.IX Item "int rstatus [read-write]" 1686.IX Item "int rstatus [read-write]"
1604The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems 1687The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1605\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). 1688\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1606.PP 1689.PP
1607Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1690\fIExamples\fR
1691.IX Subsection "Examples"
1608.PP 1692.PP
1693Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
1694its completion.
1695.PP
1609.Vb 5 1696.Vb 1
1697\& ev_child cw;
1698\&
1610\& static void 1699\& static void
1611\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1700\& child_cb (EV_P_ struct ev_child *w, int revents)
1612\& { 1701\& {
1613\& ev_unloop (loop, EVUNLOOP_ALL); 1702\& ev_child_stop (EV_A_ w);
1703\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1614\& } 1704\& }
1615.Ve 1705\&
1616.PP 1706\& pid_t pid = fork ();
1617.Vb 3 1707\&
1618\& struct ev_signal signal_watcher; 1708\& if (pid < 0)
1619\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1709\& // error
1620\& ev_signal_start (loop, &sigint_cb); 1710\& else if (pid == 0)
1711\& {
1712\& // the forked child executes here
1713\& exit (1);
1714\& }
1715\& else
1716\& {
1717\& ev_child_init (&cw, child_cb, pid, 0);
1718\& ev_child_start (EV_DEFAULT_ &cw);
1719\& }
1621.Ve 1720.Ve
1622.ie n .Sh """ev_stat"" \- did the file attributes just change?" 1721.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1623.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 1722.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1624.IX Subsection "ev_stat - did the file attributes just change?" 1723.IX Subsection "ev_stat - did the file attributes just change?"
1625This watches a filesystem path for attribute changes. That is, it calls 1724This watches a filesystem path for attribute changes. That is, it calls
1644impose a minimum interval which is currently around \f(CW0.1\fR, but thats 1743impose a minimum interval which is currently around \f(CW0.1\fR, but thats
1645usually overkill. 1744usually overkill.
1646.PP 1745.PP
1647This watcher type is not meant for massive numbers of stat watchers, 1746This watcher type is not meant for massive numbers of stat watchers,
1648as even with OS-supported change notifications, this can be 1747as even with OS-supported change notifications, this can be
1649resource\-intensive. 1748resource-intensive.
1650.PP 1749.PP
1651At the time of this writing, only the Linux inotify interface is 1750At the time of this writing, only the Linux inotify interface is
1652implemented (implementing kqueue support is left as an exercise for the 1751implemented (implementing kqueue support is left as an exercise for the
1653reader). Inotify will be used to give hints only and should not change the 1752reader). Inotify will be used to give hints only and should not change the
1654semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs 1753semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1655to fall back to regular polling again even with inotify, but changes are 1754to fall back to regular polling again even with inotify, but changes are
1656usually detected immediately, and if the file exists there will be no 1755usually detected immediately, and if the file exists there will be no
1657polling. 1756polling.
1757.PP
1758\fI\s-1ABI\s0 Issues (Largefile Support)\fR
1759.IX Subsection "ABI Issues (Largefile Support)"
1760.PP
1761Libev by default (unless the user overrides this) uses the default
1762compilation environment, which means that on systems with optionally
1763disabled large file support, you get the 32 bit version of the stat
1764structure. When using the library from programs that change the \s-1ABI\s0 to
1765use 64 bit file offsets the programs will fail. In that case you have to
1766compile libev with the same flags to get binary compatibility. This is
1767obviously the case with any flags that change the \s-1ABI\s0, but the problem is
1768most noticably with ev_stat and largefile support.
1658.PP 1769.PP
1659\fIInotify\fR 1770\fIInotify\fR
1660.IX Subsection "Inotify" 1771.IX Subsection "Inotify"
1661.PP 1772.PP
1662When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only 1773When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only
1706path for as long as the watcher is active. 1817path for as long as the watcher is active.
1707.Sp 1818.Sp
1708The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, 1819The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected,
1709relative to the attributes at the time the watcher was started (or the 1820relative to the attributes at the time the watcher was started (or the
1710last change was detected). 1821last change was detected).
1711.IP "ev_stat_stat (ev_stat *)" 4 1822.IP "ev_stat_stat (loop, ev_stat *)" 4
1712.IX Item "ev_stat_stat (ev_stat *)" 1823.IX Item "ev_stat_stat (loop, ev_stat *)"
1713Updates the stat buffer immediately with new values. If you change the 1824Updates the stat buffer immediately with new values. If you change the
1714watched path in your callback, you could call this fucntion to avoid 1825watched path in your callback, you could call this fucntion to avoid
1715detecting this change (while introducing a race condition). Can also be 1826detecting this change (while introducing a race condition). Can also be
1716useful simply to find out the new values. 1827useful simply to find out the new values.
1717.IP "ev_statdata attr [read\-only]" 4 1828.IP "ev_statdata attr [read\-only]" 4
1734\fIExamples\fR 1845\fIExamples\fR
1735.IX Subsection "Examples" 1846.IX Subsection "Examples"
1736.PP 1847.PP
1737Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. 1848Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1738.PP 1849.PP
1739.Vb 15 1850.Vb 10
1740\& static void 1851\& static void
1741\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1852\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1742\& { 1853\& {
1743\& /* /etc/passwd changed in some way */ 1854\& /* /etc/passwd changed in some way */
1744\& if (w->attr.st_nlink) 1855\& if (w\->attr.st_nlink)
1745\& { 1856\& {
1746\& printf ("passwd current size %ld\en", (long)w->attr.st_size); 1857\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
1747\& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); 1858\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
1748\& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); 1859\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
1749\& } 1860\& }
1750\& else 1861\& else
1751\& /* you shalt not abuse printf for puts */ 1862\& /* you shalt not abuse printf for puts */
1752\& puts ("wow, /etc/passwd is not there, expect problems. " 1863\& puts ("wow, /etc/passwd is not there, expect problems. "
1753\& "if this is windows, they already arrived\en"); 1864\& "if this is windows, they already arrived\en");
1754\& } 1865\& }
1755.Ve 1866\&
1756.PP
1757.Vb 2
1758\& ... 1867\& ...
1759\& ev_stat passwd; 1868\& ev_stat passwd;
1760.Ve 1869\&
1761.PP
1762.Vb 2
1763\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); 1870\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1764\& ev_stat_start (loop, &passwd); 1871\& ev_stat_start (loop, &passwd);
1765.Ve 1872.Ve
1766.PP 1873.PP
1767Example: Like above, but additionally use a one-second delay so we do not 1874Example: Like above, but additionally use a one-second delay so we do not
1770\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation). 1877\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1771.PP 1878.PP
1772.Vb 2 1879.Vb 2
1773\& static ev_stat passwd; 1880\& static ev_stat passwd;
1774\& static ev_timer timer; 1881\& static ev_timer timer;
1775.Ve 1882\&
1776.PP
1777.Vb 4
1778\& static void 1883\& static void
1779\& timer_cb (EV_P_ ev_timer *w, int revents) 1884\& timer_cb (EV_P_ ev_timer *w, int revents)
1780\& { 1885\& {
1781\& ev_timer_stop (EV_A_ w); 1886\& ev_timer_stop (EV_A_ w);
1782.Ve 1887\&
1783.PP
1784.Vb 2
1785\& /* now it's one second after the most recent passwd change */ 1888\& /* now it\*(Aqs one second after the most recent passwd change */
1786\& } 1889\& }
1787.Ve 1890\&
1788.PP
1789.Vb 6
1790\& static void 1891\& static void
1791\& stat_cb (EV_P_ ev_stat *w, int revents) 1892\& stat_cb (EV_P_ ev_stat *w, int revents)
1792\& { 1893\& {
1793\& /* reset the one-second timer */ 1894\& /* reset the one\-second timer */
1794\& ev_timer_again (EV_A_ &timer); 1895\& ev_timer_again (EV_A_ &timer);
1795\& } 1896\& }
1796.Ve 1897\&
1797.PP
1798.Vb 4
1799\& ... 1898\& ...
1800\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); 1899\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1801\& ev_stat_start (loop, &passwd); 1900\& ev_stat_start (loop, &passwd);
1802\& ev_timer_init (&timer, timer_cb, 0., 1.01); 1901\& ev_timer_init (&timer, timer_cb, 0., 1.01);
1803.Ve 1902.Ve
1818The most noteworthy effect is that as long as any idle watchers are 1917The most noteworthy effect is that as long as any idle watchers are
1819active, the process will not block when waiting for new events. 1918active, the process will not block when waiting for new events.
1820.PP 1919.PP
1821Apart from keeping your process non-blocking (which is a useful 1920Apart from keeping your process non-blocking (which is a useful
1822effect on its own sometimes), idle watchers are a good place to do 1921effect on its own sometimes), idle watchers are a good place to do
1823\&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the 1922\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
1824event loop has handled all outstanding events. 1923event loop has handled all outstanding events.
1825.PP 1924.PP
1826\fIWatcher-Specific Functions and Data Members\fR 1925\fIWatcher-Specific Functions and Data Members\fR
1827.IX Subsection "Watcher-Specific Functions and Data Members" 1926.IX Subsection "Watcher-Specific Functions and Data Members"
1828.IP "ev_idle_init (ev_signal *, callback)" 4 1927.IP "ev_idle_init (ev_signal *, callback)" 4
1829.IX Item "ev_idle_init (ev_signal *, callback)" 1928.IX Item "ev_idle_init (ev_signal *, callback)"
1830Initialises and configures the idle watcher \- it has no parameters of any 1929Initialises and configures the idle watcher \- it has no parameters of any
1831kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 1930kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1832believe me. 1931believe me.
1833.PP 1932.PP
1933\fIExamples\fR
1934.IX Subsection "Examples"
1935.PP
1834Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 1936Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1835callback, free it. Also, use no error checking, as usual. 1937callback, free it. Also, use no error checking, as usual.
1836.PP 1938.PP
1837.Vb 7 1939.Vb 7
1838\& static void 1940\& static void
1839\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1941\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1840\& { 1942\& {
1841\& free (w); 1943\& free (w);
1842\& // now do something you wanted to do when the program has 1944\& // now do something you wanted to do when the program has
1843\& // no longer asnything immediate to do. 1945\& // no longer anything immediate to do.
1844\& } 1946\& }
1845.Ve 1947\&
1846.PP
1847.Vb 3
1848\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1948\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1849\& ev_idle_init (idle_watcher, idle_cb); 1949\& ev_idle_init (idle_watcher, idle_cb);
1850\& ev_idle_start (loop, idle_cb); 1950\& ev_idle_start (loop, idle_cb);
1851.Ve 1951.Ve
1852.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 1952.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!"
1894priority, to ensure that they are being run before any other watchers 1994priority, to ensure that they are being run before any other watchers
1895after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, 1995after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers,
1896too) should not activate (\*(L"feed\*(R") events into libev. While libev fully 1996too) should not activate (\*(L"feed\*(R") events into libev. While libev fully
1897supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers 1997supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers
1898did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other 1998did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other
1899(non\-libev) event loops those other event loops might be in an unusable 1999(non-libev) event loops those other event loops might be in an unusable
1900state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to 2000state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to
1901coexist peacefully with others). 2001coexist peacefully with others).
1902.PP 2002.PP
1903\fIWatcher-Specific Functions and Data Members\fR 2003\fIWatcher-Specific Functions and Data Members\fR
1904.IX Subsection "Watcher-Specific Functions and Data Members" 2004.IX Subsection "Watcher-Specific Functions and Data Members"
1910.PD 2010.PD
1911Initialises and configures the prepare or check watcher \- they have no 2011Initialises and configures the prepare or check watcher \- they have no
1912parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 2012parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1913macros, but using them is utterly, utterly and completely pointless. 2013macros, but using them is utterly, utterly and completely pointless.
1914.PP 2014.PP
2015\fIExamples\fR
2016.IX Subsection "Examples"
2017.PP
1915There are a number of principal ways to embed other event loops or modules 2018There are a number of principal ways to embed other event loops or modules
1916into libev. Here are some ideas on how to include libadns into libev 2019into libev. Here are some ideas on how to include libadns into libev
1917(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could 2020(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
1918use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR 2021use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR
1919embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 2022embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0
1926the callbacks for the IO/timeout watchers might not have been called yet. 2029the callbacks for the IO/timeout watchers might not have been called yet.
1927.PP 2030.PP
1928.Vb 2 2031.Vb 2
1929\& static ev_io iow [nfd]; 2032\& static ev_io iow [nfd];
1930\& static ev_timer tw; 2033\& static ev_timer tw;
1931.Ve 2034\&
1932.PP
1933.Vb 4
1934\& static void 2035\& static void
1935\& io_cb (ev_loop *loop, ev_io *w, int revents) 2036\& io_cb (ev_loop *loop, ev_io *w, int revents)
1936\& { 2037\& {
1937\& } 2038\& }
1938.Ve 2039\&
1939.PP
1940.Vb 8
1941\& // create io watchers for each fd and a timer before blocking 2040\& // create io watchers for each fd and a timer before blocking
1942\& static void 2041\& static void
1943\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 2042\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1944\& { 2043\& {
1945\& int timeout = 3600000; 2044\& int timeout = 3600000;
1946\& struct pollfd fds [nfd]; 2045\& struct pollfd fds [nfd];
1947\& // actual code will need to loop here and realloc etc. 2046\& // actual code will need to loop here and realloc etc.
1948\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2047\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1949.Ve 2048\&
1950.PP
1951.Vb 3
1952\& /* the callback is illegal, but won't be called as we stop during check */ 2049\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
1953\& ev_timer_init (&tw, 0, timeout * 1e-3); 2050\& ev_timer_init (&tw, 0, timeout * 1e\-3);
1954\& ev_timer_start (loop, &tw); 2051\& ev_timer_start (loop, &tw);
1955.Ve 2052\&
1956.PP
1957.Vb 6
1958\& // create one ev_io per pollfd 2053\& // create one ev_io per pollfd
1959\& for (int i = 0; i < nfd; ++i) 2054\& for (int i = 0; i < nfd; ++i)
1960\& { 2055\& {
1961\& ev_io_init (iow + i, io_cb, fds [i].fd, 2056\& ev_io_init (iow + i, io_cb, fds [i].fd,
1962\& ((fds [i].events & POLLIN ? EV_READ : 0) 2057\& ((fds [i].events & POLLIN ? EV_READ : 0)
1963\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 2058\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1964.Ve 2059\&
1965.PP
1966.Vb 4
1967\& fds [i].revents = 0; 2060\& fds [i].revents = 0;
1968\& ev_io_start (loop, iow + i); 2061\& ev_io_start (loop, iow + i);
1969\& } 2062\& }
1970\& } 2063\& }
1971.Ve 2064\&
1972.PP
1973.Vb 5
1974\& // stop all watchers after blocking 2065\& // stop all watchers after blocking
1975\& static void 2066\& static void
1976\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 2067\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1977\& { 2068\& {
1978\& ev_timer_stop (loop, &tw); 2069\& ev_timer_stop (loop, &tw);
1979.Ve 2070\&
1980.PP
1981.Vb 8
1982\& for (int i = 0; i < nfd; ++i) 2071\& for (int i = 0; i < nfd; ++i)
1983\& { 2072\& {
1984\& // set the relevant poll flags 2073\& // set the relevant poll flags
1985\& // could also call adns_processreadable etc. here 2074\& // could also call adns_processreadable etc. here
1986\& struct pollfd *fd = fds + i; 2075\& struct pollfd *fd = fds + i;
1987\& int revents = ev_clear_pending (iow + i); 2076\& int revents = ev_clear_pending (iow + i);
1988\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; 2077\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
1989\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; 2078\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
1990.Ve 2079\&
1991.PP
1992.Vb 3
1993\& // now stop the watcher 2080\& // now stop the watcher
1994\& ev_io_stop (loop, iow + i); 2081\& ev_io_stop (loop, iow + i);
1995\& } 2082\& }
1996.Ve 2083\&
1997.PP
1998.Vb 2
1999\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 2084\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
2000\& } 2085\& }
2001.Ve 2086.Ve
2002.PP 2087.PP
2003Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR 2088Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
2009.PP 2094.PP
2010.Vb 5 2095.Vb 5
2011\& static void 2096\& static void
2012\& timer_cb (EV_P_ ev_timer *w, int revents) 2097\& timer_cb (EV_P_ ev_timer *w, int revents)
2013\& { 2098\& {
2014\& adns_state ads = (adns_state)w->data; 2099\& adns_state ads = (adns_state)w\->data;
2015\& update_now (EV_A); 2100\& update_now (EV_A);
2016.Ve 2101\&
2017.PP
2018.Vb 2
2019\& adns_processtimeouts (ads, &tv_now); 2102\& adns_processtimeouts (ads, &tv_now);
2020\& } 2103\& }
2021.Ve 2104\&
2022.PP
2023.Vb 5
2024\& static void 2105\& static void
2025\& io_cb (EV_P_ ev_io *w, int revents) 2106\& io_cb (EV_P_ ev_io *w, int revents)
2026\& { 2107\& {
2027\& adns_state ads = (adns_state)w->data; 2108\& adns_state ads = (adns_state)w\->data;
2028\& update_now (EV_A); 2109\& update_now (EV_A);
2029.Ve 2110\&
2030.PP
2031.Vb 3
2032\& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); 2111\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
2033\& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); 2112\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
2034\& } 2113\& }
2035.Ve 2114\&
2036.PP
2037.Vb 1
2038\& // do not ever call adns_afterpoll 2115\& // do not ever call adns_afterpoll
2039.Ve 2116.Ve
2040.PP 2117.PP
2041Method 4: Do not use a prepare or check watcher because the module you 2118Method 4: Do not use a prepare or check watcher because the module you
2042want to embed is too inflexible to support it. Instead, youc na override 2119want to embed is too inflexible to support it. Instead, youc na override
2047.Vb 4 2124.Vb 4
2048\& static gint 2125\& static gint
2049\& event_poll_func (GPollFD *fds, guint nfds, gint timeout) 2126\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2050\& { 2127\& {
2051\& int got_events = 0; 2128\& int got_events = 0;
2052.Ve 2129\&
2053.PP
2054.Vb 2
2055\& for (n = 0; n < nfds; ++n) 2130\& for (n = 0; n < nfds; ++n)
2056\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events 2131\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2057.Ve 2132\&
2058.PP
2059.Vb 2
2060\& if (timeout >= 0) 2133\& if (timeout >= 0)
2061\& // create/start timer 2134\& // create/start timer
2062.Ve 2135\&
2063.PP
2064.Vb 2
2065\& // poll 2136\& // poll
2066\& ev_loop (EV_A_ 0); 2137\& ev_loop (EV_A_ 0);
2067.Ve 2138\&
2068.PP
2069.Vb 3
2070\& // stop timer again 2139\& // stop timer again
2071\& if (timeout >= 0) 2140\& if (timeout >= 0)
2072\& ev_timer_stop (EV_A_ &to); 2141\& ev_timer_stop (EV_A_ &to);
2073.Ve 2142\&
2074.PP
2075.Vb 3
2076\& // stop io watchers again - their callbacks should have set 2143\& // stop io watchers again \- their callbacks should have set
2077\& for (n = 0; n < nfds; ++n) 2144\& for (n = 0; n < nfds; ++n)
2078\& ev_io_stop (EV_A_ iow [n]); 2145\& ev_io_stop (EV_A_ iow [n]);
2079.Ve 2146\&
2080.PP
2081.Vb 2
2082\& return got_events; 2147\& return got_events;
2083\& } 2148\& }
2084.Ve 2149.Ve
2085.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 2150.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
2086.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 2151.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
2130portable one. 2195portable one.
2131.PP 2196.PP
2132So when you want to use this feature you will always have to be prepared 2197So when you want to use this feature you will always have to be prepared
2133that you cannot get an embeddable loop. The recommended way to get around 2198that you cannot get an embeddable loop. The recommended way to get around
2134this is to have a separate variables for your embeddable loop, try to 2199this is to have a separate variables for your embeddable loop, try to
2135create it, and if that fails, use the normal loop for everything: 2200create it, and if that fails, use the normal loop for everything.
2136.PP
2137.Vb 3
2138\& struct ev_loop *loop_hi = ev_default_init (0);
2139\& struct ev_loop *loop_lo = 0;
2140\& struct ev_embed embed;
2141.Ve
2142.PP
2143.Vb 5
2144\& // see if there is a chance of getting one that works
2145\& // (remember that a flags value of 0 means autodetection)
2146\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2147\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2148\& : 0;
2149.Ve
2150.PP
2151.Vb 8
2152\& // if we got one, then embed it, otherwise default to loop_hi
2153\& if (loop_lo)
2154\& {
2155\& ev_embed_init (&embed, 0, loop_lo);
2156\& ev_embed_start (loop_hi, &embed);
2157\& }
2158\& else
2159\& loop_lo = loop_hi;
2160.Ve
2161.PP 2201.PP
2162\fIWatcher-Specific Functions and Data Members\fR 2202\fIWatcher-Specific Functions and Data Members\fR
2163.IX Subsection "Watcher-Specific Functions and Data Members" 2203.IX Subsection "Watcher-Specific Functions and Data Members"
2164.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 2204.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
2165.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 2205.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
2178similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 2218similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
2179apropriate way for embedded loops. 2219apropriate way for embedded loops.
2180.IP "struct ev_loop *other [read\-only]" 4 2220.IP "struct ev_loop *other [read\-only]" 4
2181.IX Item "struct ev_loop *other [read-only]" 2221.IX Item "struct ev_loop *other [read-only]"
2182The embedded event loop. 2222The embedded event loop.
2223.PP
2224\fIExamples\fR
2225.IX Subsection "Examples"
2226.PP
2227Example: Try to get an embeddable event loop and embed it into the default
2228event loop. If that is not possible, use the default loop. The default
2229loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the mebeddable loop is stored in
2230\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the acse no embeddable loop can be
2231used).
2232.PP
2233.Vb 3
2234\& struct ev_loop *loop_hi = ev_default_init (0);
2235\& struct ev_loop *loop_lo = 0;
2236\& struct ev_embed embed;
2237\&
2238\& // see if there is a chance of getting one that works
2239\& // (remember that a flags value of 0 means autodetection)
2240\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2241\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2242\& : 0;
2243\&
2244\& // if we got one, then embed it, otherwise default to loop_hi
2245\& if (loop_lo)
2246\& {
2247\& ev_embed_init (&embed, 0, loop_lo);
2248\& ev_embed_start (loop_hi, &embed);
2249\& }
2250\& else
2251\& loop_lo = loop_hi;
2252.Ve
2253.PP
2254Example: Check if kqueue is available but not recommended and create
2255a kqueue backend for use with sockets (which usually work with any
2256kqueue implementation). Store the kqueue/socket\-only event loop in
2257\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
2258.PP
2259.Vb 3
2260\& struct ev_loop *loop = ev_default_init (0);
2261\& struct ev_loop *loop_socket = 0;
2262\& struct ev_embed embed;
2263\&
2264\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2265\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2266\& {
2267\& ev_embed_init (&embed, 0, loop_socket);
2268\& ev_embed_start (loop, &embed);
2269\& }
2270\&
2271\& if (!loop_socket)
2272\& loop_socket = loop;
2273\&
2274\& // now use loop_socket for all sockets, and loop for everything else
2275.Ve
2183.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" 2276.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
2184.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 2277.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2185.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 2278.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2186Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 2279Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2187whoever is a good citizen cared to tell libev about it by calling 2280whoever is a good citizen cared to tell libev about it by calling
2196.IP "ev_fork_init (ev_signal *, callback)" 4 2289.IP "ev_fork_init (ev_signal *, callback)" 4
2197.IX Item "ev_fork_init (ev_signal *, callback)" 2290.IX Item "ev_fork_init (ev_signal *, callback)"
2198Initialises and configures the fork watcher \- it has no parameters of any 2291Initialises and configures the fork watcher \- it has no parameters of any
2199kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, 2292kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
2200believe me. 2293believe me.
2294.ie n .Sh """ev_async"" \- how to wake up another event loop"
2295.el .Sh "\f(CWev_async\fP \- how to wake up another event loop"
2296.IX Subsection "ev_async - how to wake up another event loop"
2297In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
2298asynchronous sources such as signal handlers (as opposed to multiple event
2299loops \- those are of course safe to use in different threads).
2300.PP
2301Sometimes, however, you need to wake up another event loop you do not
2302control, for example because it belongs to another thread. This is what
2303\&\f(CW\*(C`ev_async\*(C'\fR watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you
2304can signal it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal
2305safe.
2306.PP
2307This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
2308too, are asynchronous in nature, and signals, too, will be compressed
2309(i.e. the number of callback invocations may be less than the number of
2310\&\f(CW\*(C`ev_async_sent\*(C'\fR calls).
2311.PP
2312Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not
2313just the default loop.
2314.PP
2315\fIQueueing\fR
2316.IX Subsection "Queueing"
2317.PP
2318\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
2319is that the author does not know of a simple (or any) algorithm for a
2320multiple-writer-single-reader queue that works in all cases and doesn't
2321need elaborate support such as pthreads.
2322.PP
2323That means that if you want to queue data, you have to provide your own
2324queue. But at least I can tell you would implement locking around your
2325queue:
2326.IP "queueing from a signal handler context" 4
2327.IX Item "queueing from a signal handler context"
2328To implement race-free queueing, you simply add to the queue in the signal
2329handler but you block the signal handler in the watcher callback. Here is an example that does that for
2330some fictitiuous \s-1SIGUSR1\s0 handler:
2331.Sp
2332.Vb 1
2333\& static ev_async mysig;
2334\&
2335\& static void
2336\& sigusr1_handler (void)
2337\& {
2338\& sometype data;
2339\&
2340\& // no locking etc.
2341\& queue_put (data);
2342\& ev_async_send (EV_DEFAULT_ &mysig);
2343\& }
2344\&
2345\& static void
2346\& mysig_cb (EV_P_ ev_async *w, int revents)
2347\& {
2348\& sometype data;
2349\& sigset_t block, prev;
2350\&
2351\& sigemptyset (&block);
2352\& sigaddset (&block, SIGUSR1);
2353\& sigprocmask (SIG_BLOCK, &block, &prev);
2354\&
2355\& while (queue_get (&data))
2356\& process (data);
2357\&
2358\& if (sigismember (&prev, SIGUSR1)
2359\& sigprocmask (SIG_UNBLOCK, &block, 0);
2360\& }
2361.Ve
2362.Sp
2363(Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR
2364instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it
2365either...).
2366.IP "queueing from a thread context" 4
2367.IX Item "queueing from a thread context"
2368The strategy for threads is different, as you cannot (easily) block
2369threads but you can easily preempt them, so to queue safely you need to
2370employ a traditional mutex lock, such as in this pthread example:
2371.Sp
2372.Vb 2
2373\& static ev_async mysig;
2374\& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2375\&
2376\& static void
2377\& otherthread (void)
2378\& {
2379\& // only need to lock the actual queueing operation
2380\& pthread_mutex_lock (&mymutex);
2381\& queue_put (data);
2382\& pthread_mutex_unlock (&mymutex);
2383\&
2384\& ev_async_send (EV_DEFAULT_ &mysig);
2385\& }
2386\&
2387\& static void
2388\& mysig_cb (EV_P_ ev_async *w, int revents)
2389\& {
2390\& pthread_mutex_lock (&mymutex);
2391\&
2392\& while (queue_get (&data))
2393\& process (data);
2394\&
2395\& pthread_mutex_unlock (&mymutex);
2396\& }
2397.Ve
2398.PP
2399\fIWatcher-Specific Functions and Data Members\fR
2400.IX Subsection "Watcher-Specific Functions and Data Members"
2401.IP "ev_async_init (ev_async *, callback)" 4
2402.IX Item "ev_async_init (ev_async *, callback)"
2403Initialises and configures the async watcher \- it has no parameters of any
2404kind. There is a \f(CW\*(C`ev_asynd_set\*(C'\fR macro, but using it is utterly pointless,
2405believe me.
2406.IP "ev_async_send (loop, ev_async *)" 4
2407.IX Item "ev_async_send (loop, ev_async *)"
2408Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
2409an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2410\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do in other threads, signal or
2411similar contexts (see the dicusssion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2412section below on what exactly this means).
2413.Sp
2414This call incurs the overhead of a syscall only once per loop iteration,
2415so while the overhead might be noticable, it doesn't apply to repeated
2416calls to \f(CW\*(C`ev_async_send\*(C'\fR.
2417.IP "bool = ev_async_pending (ev_async *)" 4
2418.IX Item "bool = ev_async_pending (ev_async *)"
2419Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2420watcher but the event has not yet been processed (or even noted) by the
2421event loop.
2422.Sp
2423\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2424the loop iterates next and checks for the watcher to have become active,
2425it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2426quickly check wether invoking the loop might be a good idea.
2427.Sp
2428Not that this does \fInot\fR check wether the watcher itself is pending, only
2429wether it has been requested to make this watcher pending.
2201.SH "OTHER FUNCTIONS" 2430.SH "OTHER FUNCTIONS"
2202.IX Header "OTHER FUNCTIONS" 2431.IX Header "OTHER FUNCTIONS"
2203There are some other functions of possible interest. Described. Here. Now. 2432There are some other functions of possible interest. Described. Here. Now.
2204.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 2433.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
2205.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 2434.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
2229\& if (revents & EV_TIMEOUT) 2458\& if (revents & EV_TIMEOUT)
2230\& /* doh, nothing entered */; 2459\& /* doh, nothing entered */;
2231\& else if (revents & EV_READ) 2460\& else if (revents & EV_READ)
2232\& /* stdin might have data for us, joy! */; 2461\& /* stdin might have data for us, joy! */;
2233\& } 2462\& }
2234.Ve 2463\&
2235.Sp
2236.Vb 1
2237\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 2464\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2238.Ve 2465.Ve
2239.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 2466.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4
2240.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 2467.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)"
2241Feeds the given event set into the event loop, as if the specified event 2468Feeds the given event set into the event loop, as if the specified event
2251loop!). 2478loop!).
2252.SH "LIBEVENT EMULATION" 2479.SH "LIBEVENT EMULATION"
2253.IX Header "LIBEVENT EMULATION" 2480.IX Header "LIBEVENT EMULATION"
2254Libev offers a compatibility emulation layer for libevent. It cannot 2481Libev offers a compatibility emulation layer for libevent. It cannot
2255emulate the internals of libevent, so here are some usage hints: 2482emulate the internals of libevent, so here are some usage hints:
2483.IP "\(bu" 4
2256.IP "* Use it by including <event.h>, as usual." 4 2484Use it by including <event.h>, as usual.
2257.IX Item "Use it by including <event.h>, as usual." 2485.IP "\(bu" 4
2258.PD 0 2486The following members are fully supported: ev_base, ev_callback,
2259.IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 2487ev_arg, ev_fd, ev_res, ev_events.
2260.IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 2488.IP "\(bu" 4
2261.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 2489Avoid using ev_flags and the EVLIST_*\-macros, while it is
2262.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)." 2490maintained by libev, it does not work exactly the same way as in libevent (consider
2263.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 2491it a private \s-1API\s0).
2264.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." 2492.IP "\(bu" 4
2493Priorities are not currently supported. Initialising priorities
2494will fail and all watchers will have the same priority, even though there
2495is an ev_pri field.
2496.IP "\(bu" 4
2497In libevent, the last base created gets the signals, in libev, the
2498first base created (== the default loop) gets the signals.
2499.IP "\(bu" 4
2265.IP "* Other members are not supported." 4 2500Other members are not supported.
2266.IX Item "Other members are not supported." 2501.IP "\(bu" 4
2267.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 2502The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
2268.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." 2503to use the libev header file and library.
2269.PD
2270.SH "\*(C+ SUPPORT" 2504.SH "\*(C+ SUPPORT"
2271.IX Header " SUPPORT" 2505.IX Header " SUPPORT"
2272Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 2506Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
2273you to use some convinience methods to start/stop watchers and also change 2507you to use some convinience methods to start/stop watchers and also change
2274the callback model to a model using method callbacks on objects. 2508the callback model to a model using method callbacks on objects.
2354.Vb 4 2588.Vb 4
2355\& struct myclass 2589\& struct myclass
2356\& { 2590\& {
2357\& void io_cb (ev::io &w, int revents) { } 2591\& void io_cb (ev::io &w, int revents) { }
2358\& } 2592\& }
2359.Ve 2593\&
2360.Sp
2361.Vb 3
2362\& myclass obj; 2594\& myclass obj;
2363\& ev::io iow; 2595\& ev::io iow;
2364\& iow.set <myclass, &myclass::io_cb> (&obj); 2596\& iow.set <myclass, &myclass::io_cb> (&obj);
2365.Ve 2597.Ve
2366.IP "w\->set<function> (void *data = 0)" 4 2598.IP "w\->set<function> (void *data = 0)" 4
2417the constructor. 2649the constructor.
2418.PP 2650.PP
2419.Vb 4 2651.Vb 4
2420\& class myclass 2652\& class myclass
2421\& { 2653\& {
2422\& ev_io io; void io_cb (ev::io &w, int revents); 2654\& ev::io io; void io_cb (ev::io &w, int revents);
2423\& ev_idle idle void idle_cb (ev::idle &w, int revents); 2655\& ev:idle idle void idle_cb (ev::idle &w, int revents);
2424.Ve 2656\&
2425.PP
2426.Vb 2
2427\& myclass (); 2657\& myclass (int fd)
2428\& }
2429.Ve
2430.PP
2431.Vb 4
2432\& myclass::myclass (int fd)
2433\& { 2658\& {
2434\& io .set <myclass, &myclass::io_cb > (this); 2659\& io .set <myclass, &myclass::io_cb > (this);
2435\& idle.set <myclass, &myclass::idle_cb> (this); 2660\& idle.set <myclass, &myclass::idle_cb> (this);
2436.Ve 2661\&
2437.PP
2438.Vb 2
2439\& io.start (fd, ev::READ); 2662\& io.start (fd, ev::READ);
2663\& }
2440\& } 2664\& };
2441.Ve 2665.Ve
2666.SH "OTHER LANGUAGE BINDINGS"
2667.IX Header "OTHER LANGUAGE BINDINGS"
2668Libev does not offer other language bindings itself, but bindings for a
2669numbe rof languages exist in the form of third-party packages. If you know
2670any interesting language binding in addition to the ones listed here, drop
2671me a note.
2672.IP "Perl" 4
2673.IX Item "Perl"
2674The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
2675libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
2676there are additional modules that implement libev-compatible interfaces
2677to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR), \f(CW\*(C`Net::SNMP\*(C'\fR (\f(CW\*(C`Net::SNMP::EV\*(C'\fR) and the
2678\&\f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR and \f(CW\*(C`EV::Glib\*(C'\fR).
2679.Sp
2680It can be found and installed via \s-1CPAN\s0, its homepage is found at
2681<http://software.schmorp.de/pkg/EV>.
2682.IP "Ruby" 4
2683.IX Item "Ruby"
2684Tony Arcieri has written a ruby extension that offers access to a subset
2685of the libev \s-1API\s0 and adds filehandle abstractions, asynchronous \s-1DNS\s0 and
2686more on top of it. It can be found via gem servers. Its homepage is at
2687<http://rev.rubyforge.org/>.
2688.IP "D" 4
2689.IX Item "D"
2690Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
2691be found at <http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2442.SH "MACRO MAGIC" 2692.SH "MACRO MAGIC"
2443.IX Header "MACRO MAGIC" 2693.IX Header "MACRO MAGIC"
2444Libev can be compiled with a variety of options, the most fundamantal 2694Libev can be compiled with a variety of options, the most fundamantal
2445of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 2695of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
2446functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 2696functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2470\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: 2720\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2471.Sp 2721.Sp
2472.Vb 2 2722.Vb 2
2473\& // this is how ev_unref is being declared 2723\& // this is how ev_unref is being declared
2474\& static void ev_unref (EV_P); 2724\& static void ev_unref (EV_P);
2475.Ve 2725\&
2476.Sp
2477.Vb 2
2478\& // this is how you can declare your typical callback 2726\& // this is how you can declare your typical callback
2479\& static void cb (EV_P_ ev_timer *w, int revents) 2727\& static void cb (EV_P_ ev_timer *w, int revents)
2480.Ve 2728.Ve
2481.Sp 2729.Sp
2482It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite 2730It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2484.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4 2732.ie n .IP """EV_DEFAULT""\fR, \f(CW""EV_DEFAULT_""" 4
2485.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4 2733.el .IP "\f(CWEV_DEFAULT\fR, \f(CWEV_DEFAULT_\fR" 4
2486.IX Item "EV_DEFAULT, EV_DEFAULT_" 2734.IX Item "EV_DEFAULT, EV_DEFAULT_"
2487Similar to the other two macros, this gives you the value of the default 2735Similar to the other two macros, this gives you the value of the default
2488loop, if multiple loops are supported (\*(L"ev loop default\*(R"). 2736loop, if multiple loops are supported (\*(L"ev loop default\*(R").
2737.ie n .IP """EV_DEFAULT_UC""\fR, \f(CW""EV_DEFAULT_UC_""" 4
2738.el .IP "\f(CWEV_DEFAULT_UC\fR, \f(CWEV_DEFAULT_UC_\fR" 4
2739.IX Item "EV_DEFAULT_UC, EV_DEFAULT_UC_"
2740Usage identical to \f(CW\*(C`EV_DEFAULT\*(C'\fR and \f(CW\*(C`EV_DEFAULT_\*(C'\fR, but requires that the
2741default loop has been initialised (\f(CW\*(C`UC\*(C'\fR == unchecked). Their behaviour
2742is undefined when the default loop has not been initialised by a previous
2743execution of \f(CW\*(C`EV_DEFAULT\*(C'\fR, \f(CW\*(C`EV_DEFAULT_\*(C'\fR or \f(CW\*(C`ev_default_init (...)\*(C'\fR.
2744.Sp
2745It is often prudent to use \f(CW\*(C`EV_DEFAULT\*(C'\fR when initialising the first
2746watcher in a function but use \f(CW\*(C`EV_DEFAULT_UC\*(C'\fR afterwards.
2489.PP 2747.PP
2490Example: Declare and initialise a check watcher, utilising the above 2748Example: Declare and initialise a check watcher, utilising the above
2491macros so it will work regardless of whether multiple loops are supported 2749macros so it will work regardless of whether multiple loops are supported
2492or not. 2750or not.
2493.PP 2751.PP
2495\& static void 2753\& static void
2496\& check_cb (EV_P_ ev_timer *w, int revents) 2754\& check_cb (EV_P_ ev_timer *w, int revents)
2497\& { 2755\& {
2498\& ev_check_stop (EV_A_ w); 2756\& ev_check_stop (EV_A_ w);
2499\& } 2757\& }
2500.Ve 2758\&
2501.PP
2502.Vb 4
2503\& ev_check check; 2759\& ev_check check;
2504\& ev_check_init (&check, check_cb); 2760\& ev_check_init (&check, check_cb);
2505\& ev_check_start (EV_DEFAULT_ &check); 2761\& ev_check_start (EV_DEFAULT_ &check);
2506\& ev_loop (EV_DEFAULT_ 0); 2762\& ev_loop (EV_DEFAULT_ 0);
2507.Ve 2763.Ve
2508.SH "EMBEDDING" 2764.SH "EMBEDDING"
2509.IX Header "EMBEDDING" 2765.IX Header "EMBEDDING"
2510Libev can (and often is) directly embedded into host 2766Libev can (and often is) directly embedded into host
2511applications. Examples of applications that embed it include the Deliantra 2767applications. Examples of applications that embed it include the Deliantra
2512Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) 2768Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
2513and rxvt\-unicode. 2769and rxvt-unicode.
2514.PP 2770.PP
2515The goal is to enable you to just copy the necessary files into your 2771The goal is to enable you to just copy the necessary files into your
2516source directory without having to change even a single line in them, so 2772source directory without having to change even a single line in them, so
2517you can easily upgrade by simply copying (or having a checked-out copy of 2773you can easily upgrade by simply copying (or having a checked-out copy of
2518libev somewhere in your source tree). 2774libev somewhere in your source tree).
2553.Vb 4 2809.Vb 4
2554\& ev.h 2810\& ev.h
2555\& ev.c 2811\& ev.c
2556\& ev_vars.h 2812\& ev_vars.h
2557\& ev_wrap.h 2813\& ev_wrap.h
2558.Ve 2814\&
2559.PP
2560.Vb 1
2561\& ev_win32.c required on win32 platforms only 2815\& ev_win32.c required on win32 platforms only
2562.Ve 2816\&
2563.PP
2564.Vb 5
2565\& ev_select.c only when select backend is enabled (which is enabled by default) 2817\& ev_select.c only when select backend is enabled (which is enabled by default)
2566\& ev_poll.c only when poll backend is enabled (disabled by default) 2818\& ev_poll.c only when poll backend is enabled (disabled by default)
2567\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 2819\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2568\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2820\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2569\& ev_port.c only when the solaris port backend is enabled (disabled by default) 2821\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2609.Vb 1 2861.Vb 1
2610\& libev.m4 2862\& libev.m4
2611.Ve 2863.Ve
2612.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 2864.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
2613.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 2865.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
2614Libev can be configured via a variety of preprocessor symbols you have to define 2866Libev can be configured via a variety of preprocessor symbols you have to
2615before including any of its files. The default is not to build for multiplicity 2867define before including any of its files. The default in the absense of
2616and only include the select backend. 2868autoconf is noted for every option.
2617.IP "\s-1EV_STANDALONE\s0" 4 2869.IP "\s-1EV_STANDALONE\s0" 4
2618.IX Item "EV_STANDALONE" 2870.IX Item "EV_STANDALONE"
2619Must always be \f(CW1\fR if you do not use autoconf configuration, which 2871Must always be \f(CW1\fR if you do not use autoconf configuration, which
2620keeps libev from including \fIconfig.h\fR, and it also defines dummy 2872keeps libev from including \fIconfig.h\fR, and it also defines dummy
2621implementations for some libevent functions (such as logging, which is not 2873implementations for some libevent functions (such as logging, which is not
2640note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. 2892note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though.
2641.IP "\s-1EV_USE_NANOSLEEP\s0" 4 2893.IP "\s-1EV_USE_NANOSLEEP\s0" 4
2642.IX Item "EV_USE_NANOSLEEP" 2894.IX Item "EV_USE_NANOSLEEP"
2643If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available 2895If defined to be \f(CW1\fR, libev will assume that \f(CW\*(C`nanosleep ()\*(C'\fR is available
2644and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR. 2896and will use it for delays. Otherwise it will use \f(CW\*(C`select ()\*(C'\fR.
2897.IP "\s-1EV_USE_EVENTFD\s0" 4
2898.IX Item "EV_USE_EVENTFD"
2899If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
2900available and will probe for kernel support at runtime. This will improve
2901\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
2902If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
29032.7 or newer, otherwise disabled.
2645.IP "\s-1EV_USE_SELECT\s0" 4 2904.IP "\s-1EV_USE_SELECT\s0" 4
2646.IX Item "EV_USE_SELECT" 2905.IX Item "EV_USE_SELECT"
2647If undefined or defined to be \f(CW1\fR, libev will compile in support for the 2906If undefined or defined to be \f(CW1\fR, libev will compile in support for the
2648\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no 2907\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no
2649other method takes over, select will be it. Otherwise the select backend 2908other method takes over, select will be it. Otherwise the select backend
2664wants osf handles on win32 (this is the case when the select to 2923wants osf handles on win32 (this is the case when the select to
2665be used is the winsock select). This means that it will call 2924be used is the winsock select). This means that it will call
2666\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, 2925\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
2667it is assumed that all these functions actually work on fds, even 2926it is assumed that all these functions actually work on fds, even
2668on win32. Should not be defined on non\-win32 platforms. 2927on win32. Should not be defined on non\-win32 platforms.
2928.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0" 4
2929.IX Item "EV_FD_TO_WIN32_HANDLE"
2930If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
2931file descriptors to socket handles. When not defining this symbol (the
2932default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
2933correct. In some cases, programs use their own file descriptor management,
2934in which case they can provide this function to map fds to socket handles.
2669.IP "\s-1EV_USE_POLL\s0" 4 2935.IP "\s-1EV_USE_POLL\s0" 4
2670.IX Item "EV_USE_POLL" 2936.IX Item "EV_USE_POLL"
2671If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 2937If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
2672backend. Otherwise it will be enabled on non\-win32 platforms. It 2938backend. Otherwise it will be enabled on non\-win32 platforms. It
2673takes precedence over select. 2939takes precedence over select.
2674.IP "\s-1EV_USE_EPOLL\s0" 4 2940.IP "\s-1EV_USE_EPOLL\s0" 4
2675.IX Item "EV_USE_EPOLL" 2941.IX Item "EV_USE_EPOLL"
2676If defined to be \f(CW1\fR, libev will compile in support for the Linux 2942If defined to be \f(CW1\fR, libev will compile in support for the Linux
2677\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 2943\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
2678otherwise another method will be used as fallback. This is the 2944otherwise another method will be used as fallback. This is the preferred
2679preferred backend for GNU/Linux systems. 2945backend for GNU/Linux systems. If undefined, it will be enabled if the
2946headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2680.IP "\s-1EV_USE_KQUEUE\s0" 4 2947.IP "\s-1EV_USE_KQUEUE\s0" 4
2681.IX Item "EV_USE_KQUEUE" 2948.IX Item "EV_USE_KQUEUE"
2682If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 2949If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
2683\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 2950\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
2684otherwise another method will be used as fallback. This is the preferred 2951otherwise another method will be used as fallback. This is the preferred
2699reserved for future expansion, works like the \s-1USE\s0 symbols above. 2966reserved for future expansion, works like the \s-1USE\s0 symbols above.
2700.IP "\s-1EV_USE_INOTIFY\s0" 4 2967.IP "\s-1EV_USE_INOTIFY\s0" 4
2701.IX Item "EV_USE_INOTIFY" 2968.IX Item "EV_USE_INOTIFY"
2702If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 2969If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2703interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 2970interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2704be detected at runtime. 2971be detected at runtime. If undefined, it will be enabled if the headers
2972indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2973.IP "\s-1EV_ATOMIC_T\s0" 4
2974.IX Item "EV_ATOMIC_T"
2975Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
2976access is atomic with respect to other threads or signal contexts. No such
2977type is easily found in the C language, so you can provide your own type
2978that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R"
2979as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers.
2980.Sp
2981In the absense of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
2982(from \fIsignal.h\fR), which is usually good enough on most platforms.
2705.IP "\s-1EV_H\s0" 4 2983.IP "\s-1EV_H\s0" 4
2706.IX Item "EV_H" 2984.IX Item "EV_H"
2707The name of the \fIev.h\fR header file used to include it. The default if 2985The name of the \fIev.h\fR header file used to include it. The default if
2708undefined is \f(CW"ev.h"\fR in \fIevent.h\fR and \fIev.c\fR. This can be used to 2986undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
2709virtually rename the \fIev.h\fR header file in case of conflicts. 2987used to virtually rename the \fIev.h\fR header file in case of conflicts.
2710.IP "\s-1EV_CONFIG_H\s0" 4 2988.IP "\s-1EV_CONFIG_H\s0" 4
2711.IX Item "EV_CONFIG_H" 2989.IX Item "EV_CONFIG_H"
2712If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 2990If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
2713\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 2991\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
2714\&\f(CW\*(C`EV_H\*(C'\fR, above. 2992\&\f(CW\*(C`EV_H\*(C'\fR, above.
2715.IP "\s-1EV_EVENT_H\s0" 4 2993.IP "\s-1EV_EVENT_H\s0" 4
2716.IX Item "EV_EVENT_H" 2994.IX Item "EV_EVENT_H"
2717Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 2995Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
2718of how the \fIevent.h\fR header can be found, the dfeault is \f(CW"event.h"\fR. 2996of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
2719.IP "\s-1EV_PROTOTYPES\s0" 4 2997.IP "\s-1EV_PROTOTYPES\s0" 4
2720.IX Item "EV_PROTOTYPES" 2998.IX Item "EV_PROTOTYPES"
2721If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 2999If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
2722prototypes, but still define all the structs and other symbols. This is 3000prototypes, but still define all the structs and other symbols. This is
2723occasionally useful if you want to provide your own wrapper functions 3001occasionally useful if you want to provide your own wrapper functions
2766If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If 3044If undefined or defined to be \f(CW1\fR, then stat watchers are supported. If
2767defined to be \f(CW0\fR, then they are not. 3045defined to be \f(CW0\fR, then they are not.
2768.IP "\s-1EV_FORK_ENABLE\s0" 4 3046.IP "\s-1EV_FORK_ENABLE\s0" 4
2769.IX Item "EV_FORK_ENABLE" 3047.IX Item "EV_FORK_ENABLE"
2770If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If 3048If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
3049defined to be \f(CW0\fR, then they are not.
3050.IP "\s-1EV_ASYNC_ENABLE\s0" 4
3051.IX Item "EV_ASYNC_ENABLE"
3052If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
2771defined to be \f(CW0\fR, then they are not. 3053defined to be \f(CW0\fR, then they are not.
2772.IP "\s-1EV_MINIMAL\s0" 4 3054.IP "\s-1EV_MINIMAL\s0" 4
2773.IX Item "EV_MINIMAL" 3055.IX Item "EV_MINIMAL"
2774If you need to shave off some kilobytes of code at the expense of some 3056If you need to shave off some kilobytes of code at the expense of some
2775speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override 3057speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override
2818.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 3100.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
2819.IX Subsection "EXPORTED API SYMBOLS" 3101.IX Subsection "EXPORTED API SYMBOLS"
2820If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of 3102If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of
2821exported symbols, you can use the provided \fISymbol.*\fR files which list 3103exported symbols, you can use the provided \fISymbol.*\fR files which list
2822all public symbols, one per line: 3104all public symbols, one per line:
2823.Sp 3105.PP
2824.Vb 2 3106.Vb 2
2825\& Symbols.ev for libev proper 3107\& Symbols.ev for libev proper
2826\& Symbols.event for the libevent emulation 3108\& Symbols.event for the libevent emulation
2827.Ve 3109.Ve
2828.Sp 3110.PP
2829This can also be used to rename all public symbols to avoid clashes with 3111This can also be used to rename all public symbols to avoid clashes with
2830multiple versions of libev linked together (which is obviously bad in 3112multiple versions of libev linked together (which is obviously bad in
2831itself, but sometimes it is inconvinient to avoid this). 3113itself, but sometimes it is inconvinient to avoid this).
2832.Sp 3114.PP
2833A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to 3115A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
2834include before including \fIev.h\fR: 3116include before including \fIev.h\fR:
2835.Sp 3117.PP
2836.Vb 1 3118.Vb 1
2837\& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h 3119\& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h
2838.Ve 3120.Ve
2839.Sp 3121.PP
2840This would create a file \fIwrap.h\fR which essentially looks like this: 3122This would create a file \fIwrap.h\fR which essentially looks like this:
2841.Sp 3123.PP
2842.Vb 4 3124.Vb 4
2843\& #define ev_backend myprefix_ev_backend 3125\& #define ev_backend myprefix_ev_backend
2844\& #define ev_check_start myprefix_ev_check_start 3126\& #define ev_check_start myprefix_ev_check_start
2845\& #define ev_check_stop myprefix_ev_check_stop 3127\& #define ev_check_stop myprefix_ev_check_stop
2846\& ... 3128\& ...
2852(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 3134(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
2853the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public 3135the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
2854interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file 3136interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
2855will be compiled. It is pretty complex because it provides its own header 3137will be compiled. It is pretty complex because it provides its own header
2856file. 3138file.
2857.Sp 3139.PP
2858The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 3140The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
2859that everybody includes and which overrides some configure choices: 3141that everybody includes and which overrides some configure choices:
2860.Sp 3142.PP
2861.Vb 9 3143.Vb 9
2862\& #define EV_MINIMAL 1 3144\& #define EV_MINIMAL 1
2863\& #define EV_USE_POLL 0 3145\& #define EV_USE_POLL 0
2864\& #define EV_MULTIPLICITY 0 3146\& #define EV_MULTIPLICITY 0
2865\& #define EV_PERIODIC_ENABLE 0 3147\& #define EV_PERIODIC_ENABLE 0
2866\& #define EV_STAT_ENABLE 0 3148\& #define EV_STAT_ENABLE 0
2867\& #define EV_FORK_ENABLE 0 3149\& #define EV_FORK_ENABLE 0
2868\& #define EV_CONFIG_H <config.h> 3150\& #define EV_CONFIG_H <config.h>
2869\& #define EV_MINPRI 0 3151\& #define EV_MINPRI 0
2870\& #define EV_MAXPRI 0 3152\& #define EV_MAXPRI 0
2871.Ve 3153\&
2872.Sp
2873.Vb 1
2874\& #include "ev++.h" 3154\& #include "ev++.h"
2875.Ve 3155.Ve
2876.Sp 3156.PP
2877And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 3157And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
2878.Sp 3158.PP
2879.Vb 2 3159.Vb 2
2880\& #include "ev_cpp.h" 3160\& #include "ev_cpp.h"
2881\& #include "ev.c" 3161\& #include "ev.c"
2882.Ve 3162.Ve
3163.SH "THREADS AND COROUTINES"
3164.IX Header "THREADS AND COROUTINES"
3165.Sh "\s-1THREADS\s0"
3166.IX Subsection "THREADS"
3167Libev itself is completely threadsafe, but it uses no locking. This
3168means that you can use as many loops as you want in parallel, as long as
3169only one thread ever calls into one libev function with the same loop
3170parameter.
3171.PP
3172Or put differently: calls with different loop parameters can be done in
3173parallel from multiple threads, calls with the same loop parameter must be
3174done serially (but can be done from different threads, as long as only one
3175thread ever is inside a call at any point in time, e.g. by using a mutex
3176per loop).
3177.PP
3178If you want to know which design is best for your problem, then I cannot
3179help you but by giving some generic advice:
3180.IP "\(bu" 4
3181most applications have a main thread: use the default libev loop
3182in that thread, or create a seperate thread running only the default loop.
3183.Sp
3184This helps integrating other libraries or software modules that use libev
3185themselves and don't care/know about threading.
3186.IP "\(bu" 4
3187one loop per thread is usually a good model.
3188.Sp
3189Doing this is almost never wrong, sometimes a better-performance model
3190exists, but it is always a good start.
3191.IP "\(bu" 4
3192other models exist, such as the leader/follower pattern, where one
3193loop is handed through multiple threads in a kind of round-robbin fashion.
3194.Sp
3195Chosing a model is hard \- look around, learn, know that usually you cna do
3196better than you currently do :\-)
3197.IP "\(bu" 4
3198often you need to talk to some other thread which blocks in the
3199event loop \- \f(CW\*(C`ev_async\*(C'\fR watchers can be used to wake them up from other
3200threads safely (or from signal contexts...).
3201.Sh "\s-1COROUTINES\s0"
3202.IX Subsection "COROUTINES"
3203Libev is much more accomodating to coroutines (\*(L"cooperative threads\*(R"):
3204libev fully supports nesting calls to it's functions from different
3205coroutines (e.g. you can call \f(CW\*(C`ev_loop\*(C'\fR on the same loop from two
3206different coroutines and switch freely between both coroutines running the
3207loop, as long as you don't confuse yourself). The only exception is that
3208you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
3209.PP
3210Care has been invested into making sure that libev does not keep local
3211state inside \f(CW\*(C`ev_loop\*(C'\fR, and other calls do not usually allow coroutine
3212switches.
2883.SH "COMPLEXITIES" 3213.SH "COMPLEXITIES"
2884.IX Header "COMPLEXITIES" 3214.IX Header "COMPLEXITIES"
2885In this section the complexities of (many of) the algorithms used inside 3215In this section the complexities of (many of) the algorithms used inside
2886libev will be explained. For complexity discussions about backends see the 3216libev will be explained. For complexity discussions about backends see the
2887documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 3217documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2888.Sp 3218.PP
2889All of the following are about amortised time: If an array needs to be 3219All of the following are about amortised time: If an array needs to be
2890extended, libev needs to realloc and move the whole array, but this 3220extended, libev needs to realloc and move the whole array, but this
2891happens asymptotically never with higher number of elements, so O(1) might 3221happens asymptotically never with higher number of elements, so O(1) might
2892mean it might do a lengthy realloc operation in rare cases, but on average 3222mean it might do a lengthy realloc operation in rare cases, but on average
2893it is much faster and asymptotically approaches constant time. 3223it is much faster and asymptotically approaches constant time.
2894.RS 4
2895.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 3224.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2896.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 3225.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2897This means that, when you have a watcher that triggers in one hour and 3226This means that, when you have a watcher that triggers in one hour and
2898there are 100 watchers that would trigger before that then inserting will 3227there are 100 watchers that would trigger before that then inserting will
2899have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers. 3228have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
2900.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4 3229.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
2901.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 3230.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
2902That means that changing a timer costs less than removing/adding them 3231That means that changing a timer costs less than removing/adding them
2903as only the relative motion in the event queue has to be paid for. 3232as only the relative motion in the event queue has to be paid for.
2904.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 3233.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
2905.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 3234.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
2906These just add the watcher into an array or at the head of a list. 3235These just add the watcher into an array or at the head of a list.
2907.IP "Stopping check/prepare/idle watchers: O(1)" 4 3236.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
2908.IX Item "Stopping check/prepare/idle watchers: O(1)" 3237.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
2909.PD 0 3238.PD 0
2910.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 3239.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2911.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 3240.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
2912.PD 3241.PD
2913These watchers are stored in lists then need to be walked to find the 3242These watchers are stored in lists then need to be walked to find the
2929.IX Item "Priority handling: O(number_of_priorities)" 3258.IX Item "Priority handling: O(number_of_priorities)"
2930.PD 3259.PD
2931Priorities are implemented by allocating some space for each 3260Priorities are implemented by allocating some space for each
2932priority. When doing priority-based operations, libev usually has to 3261priority. When doing priority-based operations, libev usually has to
2933linearly search all the priorities, but starting/stopping and activating 3262linearly search all the priorities, but starting/stopping and activating
2934watchers becomes O(1) w.r.t. prioritiy handling. 3263watchers becomes O(1) w.r.t. priority handling.
2935.RE 3264.IP "Sending an ev_async: O(1)" 4
2936.RS 4 3265.IX Item "Sending an ev_async: O(1)"
3266.PD 0
3267.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
3268.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
3269.IP "Processing signals: O(max_signal_number)" 4
3270.IX Item "Processing signals: O(max_signal_number)"
3271.PD
3272Sending involves a syscall \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
3273calls in the current loop iteration. Checking for async and signal events
3274involves iterating over all running async watchers or all signal numbers.
3275.SH "Win32 platform limitations and workarounds"
3276.IX Header "Win32 platform limitations and workarounds"
3277Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
3278requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
3279model. Libev still offers limited functionality on this platform in
3280the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
3281descriptors. This only applies when using Win32 natively, not when using
3282e.g. cygwin.
3283.PP
3284There is no supported compilation method available on windows except
3285embedding it into other applications.
3286.PP
3287Due to the many, low, and arbitrary limits on the win32 platform and the
3288abysmal performance of winsockets, using a large number of sockets is not
3289recommended (and not reasonable). If your program needs to use more than
3290a hundred or so sockets, then likely it needs to use a totally different
3291implementation for windows, as libev offers the \s-1POSIX\s0 model, which cannot
3292be implemented efficiently on windows (microsoft monopoly games).
3293.IP "The winsocket select function" 4
3294.IX Item "The winsocket select function"
3295The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it requires
3296socket \fIhandles\fR and not socket \fIfile descriptors\fR. This makes select
3297very inefficient, and also requires a mapping from file descriptors
3298to socket handles. See the discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR,
3299\&\f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and \f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor
3300symbols for more info.
3301.Sp
3302The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime
3303libraries and raw winsocket select is:
3304.Sp
3305.Vb 2
3306\& #define EV_USE_SELECT 1
3307\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3308.Ve
3309.Sp
3310Note that winsockets handling of fd sets is O(n), so you can easily get a
3311complexity in the O(nA\*^X) range when using win32.
3312.IP "Limited number of file descriptors" 4
3313.IX Item "Limited number of file descriptors"
3314Windows has numerous arbitrary (and low) limits on things. Early versions
3315of winsocket's select only supported waiting for a max. of \f(CW64\fR handles
3316(probably owning to the fact that all windows kernels can only wait for
3317\&\f(CW64\fR things at the same time internally; microsoft recommends spawning a
3318chain of threads and wait for 63 handles and the previous thread in each).
3319.Sp
3320Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3321to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3322call (which might be in libev or elsewhere, for example, perl does its own
3323select emulation on windows).
3324.Sp
3325Another limit is the number of file descriptors in the microsoft runtime
3326libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish
3327or something like this inside microsoft). You can increase this by calling
3328\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another
3329arbitrary limit), but is broken in many versions of the microsoft runtime
3330libraries.
3331.Sp
3332This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on
3333windows version and/or the phase of the moon). To get more, you need to
3334wrap all I/O functions and provide your own fd management, but the cost of
3335calling select (O(nA\*^X)) will likely make this unworkable.
2937.SH "AUTHOR" 3336.SH "AUTHOR"
2938.IX Header "AUTHOR" 3337.IX Header "AUTHOR"
2939Marc Lehmann <libev@schmorp.de>. 3338Marc Lehmann <libev@schmorp.de>.
3339.SH "POD ERRORS"
3340.IX Header "POD ERRORS"
3341Hey! \fBThe above document had some coding errors, which are explained below:\fR
3342.IP "Around line 3015:" 4
3343.IX Item "Around line 3015:"
3344You forgot a '=back' before '=head2'

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines