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

Comparing libev/ev.3 (file contents):
Revision 1.58 by root, Sat Dec 22 16:53:56 2007 UTC vs.
Revision 1.63 by root, Wed Apr 2 15:23:11 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-22" "perl v5.8.8" "User Contributed Perl Documentation" 135.TH EV 1 "2008-04-02" "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 "EXAMPLE PROGRAM" 147.Sh "\s-1EXAMPLE\s0 \s-1PROGRAM\s0"
141.IX Header "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
212.PP 217.PP
213You register interest in certain events by registering so-called \fIevent 218You register interest in certain events by registering so-called \fIevent
214watchers\fR, which are relatively small C structures you initialise with the 219watchers\fR, which are relatively small C structures you initialise with the
215details of the event, and then hand it over to libev by \fIstarting\fR the 220details of the event, and then hand it over to libev by \fIstarting\fR the
216watcher. 221watcher.
217.SH "FEATURES" 222.Sh "\s-1FEATURES\s0"
218.IX Header "FEATURES" 223.IX Subsection "FEATURES"
219Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 224Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the
220BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 225BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms
221for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 226for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface
222(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers 227(for \f(CW\*(C`ev_stat\*(C'\fR), relative timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers
223with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals 228with customised rescheduling (\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals
228(\f(CW\*(C`ev_fork\*(C'\fR). 233(\f(CW\*(C`ev_fork\*(C'\fR).
229.PP 234.PP
230It also is quite fast (see this 235It also is quite fast (see this
231benchmark comparing it to libevent 236benchmark comparing it to libevent
232for example). 237for example).
233.SH "CONVENTIONS" 238.Sh "\s-1CONVENTIONS\s0"
234.IX Header "CONVENTIONS" 239.IX Subsection "CONVENTIONS"
235Libev is very configurable. In this manual the default configuration will 240Libev is very configurable. In this manual the default (and most common)
236be described, which supports multiple event loops. For more info about 241configuration will be described, which supports multiple event loops. For
237various configuration options please have a look at \fB\s-1EMBED\s0\fR section in 242more info about various configuration options please have a look at
238this manual. If libev was configured without support for multiple event 243\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
239loops, then all functions taking an initial argument of name \f(CW\*(C`loop\*(C'\fR 244for multiple event loops, then all functions taking an initial argument of
240(which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have this argument. 245name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
241.SH "TIME REPRESENTATION" 246this argument.
247.Sh "\s-1TIME\s0 \s-1REPRESENTATION\s0"
242.IX Header "TIME REPRESENTATION" 248.IX Subsection "TIME REPRESENTATION"
243Libev represents time as a single floating point number, representing the 249Libev represents time as a single floating point number, representing the
244(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near 250(fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
245the beginning of 1970, details are complicated, don't ask). This type is 251the beginning of 1970, details are complicated, don't ask). This type is
246called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases 252called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases
247to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on 253to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on
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.
342\& persistent_realloc (void *ptr, size_t size) 348\& persistent_realloc (void *ptr, size_t size)
343\& { 349\& {
344\& for (;;) 350\& for (;;)
345\& { 351\& {
346\& void *newptr = realloc (ptr, size); 352\& void *newptr = realloc (ptr, size);
347.Ve 353\&
348.Sp
349.Vb 2
350\& if (newptr) 354\& if (newptr)
351\& return newptr; 355\& return newptr;
352.Ve 356\&
353.Sp
354.Vb 3
355\& sleep (60); 357\& sleep (60);
356\& } 358\& }
357\& } 359\& }
358.Ve 360\&
359.Sp
360.Vb 2
361\& ... 361\& ...
362\& ev_set_allocator (persistent_realloc); 362\& ev_set_allocator (persistent_realloc);
363.Ve 363.Ve
364.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4 364.IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4
365.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));" 365.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));"
378\& fatal_error (const char *msg) 378\& fatal_error (const char *msg)
379\& { 379\& {
380\& perror (msg); 380\& perror (msg);
381\& abort (); 381\& abort ();
382\& } 382\& }
383.Ve 383\&
384.Sp
385.Vb 2
386\& ... 384\& ...
387\& ev_set_syserr_cb (fatal_error); 385\& ev_set_syserr_cb (fatal_error);
388.Ve 386.Ve
389.SH "FUNCTIONS CONTROLLING THE EVENT LOOP" 387.SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
390.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP" 388.IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
405false. If it already was initialised it simply returns it (and ignores the 403false. 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). 404flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards).
407.Sp 405.Sp
408If you don't know what event loop to use, use the one returned from this 406If you don't know what event loop to use, use the one returned from this
409function. 407function.
408.Sp
409Note that this function is \fInot\fR thread-safe, so if you want to use it
410from multiple threads, you have to lock (note also that this is unlikely,
411as loops cannot bes hared easily between threads anyway).
412.Sp
413The default loop is the only loop that can handle \f(CW\*(C`ev_signal\*(C'\fR and
414\&\f(CW\*(C`ev_child\*(C'\fR watchers, and to do this, it always registers a handler
415for \f(CW\*(C`SIGCHLD\*(C'\fR. If this is a problem for your app you can either
416create a dynamic loop with \f(CW\*(C`ev_loop_new\*(C'\fR that doesn't do that, or you
417can simply overwrite the \f(CW\*(C`SIGCHLD\*(C'\fR signal handler \fIafter\fR calling
418\&\f(CW\*(C`ev_default_init\*(C'\fR.
410.Sp 419.Sp
411The flags argument can be used to specify special behaviour or specific 420The 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). 421backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).
413.Sp 422.Sp
414The following flags are supported: 423The following flags are supported:
435enabling this flag. 444enabling this flag.
436.Sp 445.Sp
437This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 446This 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 447and 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 448iterations 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 449GNU/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 450without 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). 451\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster).
443.Sp 452.Sp
444The big advantage of this flag is that you can forget about fork (and 453The 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 454forget about forgetting to tell libev about forking) when you use this
446flag. 455flag.
452.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 461.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
453This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 462This 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, 463libev 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 464but 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 465using 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. 466usually the fastest backend for a low number of (low-numbered :) fds.
458.Sp 467.Sp
459To get good performance out of this backend you need a high amount of 468To 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 469parallelity (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 470writing 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 471connections as possible during one iteration. You might also want to have
547.Sp 556.Sp
548While this backend scales well, it requires one system call per active 557While this backend scales well, it requires one system call per active
549file descriptor per loop iteration. For small and medium numbers of file 558file 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 559descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
551might perform better. 560might perform better.
561.Sp
562On the positive side, ignoring the spurious readyness notifications, this
563backend actually performed to specification in all tests and is fully
564embeddable, which is a rare feat among the OS-specific backends.
552.ie n .IP """EVBACKEND_ALL""" 4 565.ie n .IP """EVBACKEND_ALL""" 4
553.el .IP "\f(CWEVBACKEND_ALL\fR" 4 566.el .IP "\f(CWEVBACKEND_ALL\fR" 4
554.IX Item "EVBACKEND_ALL" 567.IX Item "EVBACKEND_ALL"
555Try all backends (even potentially broken ones that wouldn't be tried 568Try 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 569with \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. 572It is definitely not recommended to use this flag.
560.RE 573.RE
561.RS 4 574.RS 4
562.Sp 575.Sp
563If one or more of these are ored into the flags value, then only these 576If 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 577backends will be tried (in the reverse order as listed here). If none are
565specified, most compiled-in backend will be tried, usually in reverse 578specified, all backends in \f(CW\*(C`ev_recommended_backends ()\*(C'\fR will be tried.
566order of their flag values :)
567.Sp 579.Sp
568The most typical usage is like this: 580The most typical usage is like this:
569.Sp 581.Sp
570.Vb 2 582.Vb 2
571\& if (!ev_default_loop (0)) 583\& if (!ev_default_loop (0))
591.IX Item "struct ev_loop *ev_loop_new (unsigned int flags)" 603.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 604Similar 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 605always 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 606handle signal and child watchers, and attempts to do so will be greeted by
595undefined behaviour (or a failed assertion if assertions are enabled). 607undefined behaviour (or a failed assertion if assertions are enabled).
608.Sp
609Note that this function \fIis\fR thread-safe, and the recommended way to use
610libev with threads is indeed to create one loop per thread, and using the
611default loop in the \*(L"main\*(R" or \*(L"initial\*(R" thread.
596.Sp 612.Sp
597Example: Try to create a event loop that uses epoll and nothing else. 613Example: Try to create a event loop that uses epoll and nothing else.
598.Sp 614.Sp
599.Vb 3 615.Vb 3
600\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 616\& struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
623.IX Item "ev_loop_destroy (loop)" 639.IX Item "ev_loop_destroy (loop)"
624Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an 640Like \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. 641earlier call to \f(CW\*(C`ev_loop_new\*(C'\fR.
626.IP "ev_default_fork ()" 4 642.IP "ev_default_fork ()" 4
627.IX Item "ev_default_fork ()" 643.IX Item "ev_default_fork ()"
644This 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 645to 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 646name, 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 647the child process (or both child and parent, but that again makes little
631again makes little sense). 648sense). You \fImust\fR call it in the child before using any of the libev
649functions, and it will only take effect at the next \f(CW\*(C`ev_loop\*(C'\fR iteration.
632.Sp 650.Sp
633You \fImust\fR call this function in the child process after forking if and 651On 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 652process if and only if you want to use the event library in the child. If
635fork+exec, you don't have to call it. 653you just fork+exec, you don't have to call it at all.
636.Sp 654.Sp
637The function itself is quite fast and it's usually not a problem to call 655The 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 656it 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: 657quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR:
640.Sp 658.Sp
641.Vb 1 659.Vb 1
642\& pthread_atfork (0, 0, ev_default_fork); 660\& pthread_atfork (0, 0, ev_default_fork);
643.Ve 661.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 662.IP "ev_loop_fork (loop)" 4
649.IX Item "ev_loop_fork (loop)" 663.IX Item "ev_loop_fork (loop)"
650Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by 664Like \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 665\&\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. 666after fork, and how you do this is entirely your own problem.
667.IP "int ev_is_default_loop (loop)" 4
668.IX Item "int ev_is_default_loop (loop)"
669Returns true when the given loop actually is the default loop, false otherwise.
653.IP "unsigned int ev_loop_count (loop)" 4 670.IP "unsigned int ev_loop_count (loop)" 4
654.IX Item "unsigned int ev_loop_count (loop)" 671.IX Item "unsigned int ev_loop_count (loop)"
655Returns the count of loop iterations for the loop, which is identical to 672Returns 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 673the number of times libev did poll for new events. It starts at \f(CW0\fR and
657happily wraps around with enough iterations. 674happily 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 714libev 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. 715usually a better approach for this kind of thing.
699.Sp 716.Sp
700Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does: 717Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
701.Sp 718.Sp
702.Vb 19 719.Vb 10
703\& - Before the first iteration, call any pending watchers. 720\& \- Before the first iteration, call any pending watchers.
704\& * If there are no active watchers (reference count is zero), return. 721\& * If EVFLAG_FORKCHECK was used, check for a fork.
705\& - Queue all prepare watchers and then call all outstanding watchers. 722\& \- If a fork was detected, queue and call all fork watchers.
723\& \- Queue and call all prepare watchers.
706\& - If we have been forked, recreate the kernel state. 724\& \- If we have been forked, recreate the kernel state.
707\& - Update the kernel state with all outstanding changes. 725\& \- Update the kernel state with all outstanding changes.
708\& - Update the "event loop time". 726\& \- Update the "event loop time".
709\& - Calculate for how long to block. 727\& \- Calculate for how long to sleep or block, if at all
728\& (active idle watchers, EVLOOP_NONBLOCK or not having
729\& any active watchers at all will result in not sleeping).
730\& \- Sleep if the I/O and timer collect interval say so.
710\& - Block the process, waiting for any events. 731\& \- Block the process, waiting for any events.
711\& - Queue all outstanding I/O (fd) events. 732\& \- Queue all outstanding I/O (fd) events.
712\& - Update the "event loop time" and do time jump handling. 733\& \- Update the "event loop time" and do time jump handling.
713\& - Queue all outstanding timers. 734\& \- Queue all outstanding timers.
714\& - Queue all outstanding periodics. 735\& \- Queue all outstanding periodics.
715\& - If no events are pending now, queue all idle watchers. 736\& \- If no events are pending now, queue all idle watchers.
716\& - Queue all check watchers. 737\& \- Queue all check watchers.
717\& - Call all queued watchers in reverse order (i.e. check watchers first). 738\& \- 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 739\& Signals and child watchers are implemented as I/O watchers, and will
719\& be handled here by queueing them when their watcher gets executed. 740\& be handled here by queueing them when their watcher gets executed.
720\& - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 741\& \- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
721\& were used, return, otherwise continue with step *. 742\& were used, or there are no active watchers, return, otherwise
743\& continue with step *.
722.Ve 744.Ve
723.Sp 745.Sp
724Example: Queue some jobs and then loop until no events are outsanding 746Example: Queue some jobs and then loop until no events are outstanding
725anymore. 747anymore.
726.Sp 748.Sp
727.Vb 4 749.Vb 4
728\& ... queue jobs here, make sure they register event watchers as long 750\& ... 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..) 751\& ... as they still have work to do (even an idle watcher will do..)
734.IX Item "ev_unloop (loop, how)" 756.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 757Can 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 758has 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 759\&\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. 760\&\f(CW\*(C`EVUNLOOP_ALL\*(C'\fR, which will make all nested \f(CW\*(C`ev_loop\*(C'\fR calls return.
761.Sp
762This \*(L"unloop state\*(R" will be cleared when entering \f(CW\*(C`ev_loop\*(C'\fR again.
739.IP "ev_ref (loop)" 4 763.IP "ev_ref (loop)" 4
740.IX Item "ev_ref (loop)" 764.IX Item "ev_ref (loop)"
741.PD 0 765.PD 0
742.IP "ev_unref (loop)" 4 766.IP "ev_unref (loop)" 4
743.IX Item "ev_unref (loop)" 767.IX Item "ev_unref (loop)"
749returning, \fIev_unref()\fR after starting, and \fIev_ref()\fR before stopping it. For 773returning, \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 774example, 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 775visible 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 776no 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 777way 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. 778libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR
779(but only if the watcher wasn't active before, or was active before,
780respectively).
755.Sp 781.Sp
756Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR 782Example: Create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
757running when nothing else is active. 783running when nothing else is active.
758.Sp 784.Sp
759.Vb 4 785.Vb 4
816\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents) 842\& static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
817\& { 843\& {
818\& ev_io_stop (w); 844\& ev_io_stop (w);
819\& ev_unloop (loop, EVUNLOOP_ALL); 845\& ev_unloop (loop, EVUNLOOP_ALL);
820\& } 846\& }
821.Ve 847\&
822.PP
823.Vb 6
824\& struct ev_loop *loop = ev_default_loop (0); 848\& struct ev_loop *loop = ev_default_loop (0);
825\& struct ev_io stdin_watcher; 849\& struct ev_io stdin_watcher;
826\& ev_init (&stdin_watcher, my_cb); 850\& ev_init (&stdin_watcher, my_cb);
827\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 851\& ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
828\& ev_io_start (loop, &stdin_watcher); 852\& ev_io_start (loop, &stdin_watcher);
916.ie n .IP """EV_FORK""" 4 940.ie n .IP """EV_FORK""" 4
917.el .IP "\f(CWEV_FORK\fR" 4 941.el .IP "\f(CWEV_FORK\fR" 4
918.IX Item "EV_FORK" 942.IX Item "EV_FORK"
919The event loop has been resumed in the child process after fork (see 943The event loop has been resumed in the child process after fork (see
920\&\f(CW\*(C`ev_fork\*(C'\fR). 944\&\f(CW\*(C`ev_fork\*(C'\fR).
945.ie n .IP """EV_ASYNC""" 4
946.el .IP "\f(CWEV_ASYNC\fR" 4
947.IX Item "EV_ASYNC"
948The given async watcher has been asynchronously notified (see \f(CW\*(C`ev_async\*(C'\fR).
921.ie n .IP """EV_ERROR""" 4 949.ie n .IP """EV_ERROR""" 4
922.el .IP "\f(CWEV_ERROR\fR" 4 950.el .IP "\f(CWEV_ERROR\fR" 4
923.IX Item "EV_ERROR" 951.IX Item "EV_ERROR"
924An unspecified error has occured, the watcher has been stopped. This might 952An unspecified error has occured, the watcher has been stopped. This might
925happen because the watcher could not be properly started because libev 953happen 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, 1117In 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: 1118you need to use \f(CW\*(C`offsetof\*(C'\fR:
1091.PP 1119.PP
1092.Vb 1 1120.Vb 1
1093\& #include <stddef.h> 1121\& #include <stddef.h>
1094.Ve 1122\&
1095.PP
1096.Vb 6
1097\& static void 1123\& static void
1098\& t1_cb (EV_P_ struct ev_timer *w, int revents) 1124\& t1_cb (EV_P_ struct ev_timer *w, int revents)
1099\& { 1125\& {
1100\& struct my_biggy big = (struct my_biggy * 1126\& struct my_biggy big = (struct my_biggy *
1101\& (((char *)w) - offsetof (struct my_biggy, t1)); 1127\& (((char *)w) \- offsetof (struct my_biggy, t1));
1102\& } 1128\& }
1103.Ve 1129\&
1104.PP
1105.Vb 6
1106\& static void 1130\& static void
1107\& t2_cb (EV_P_ struct ev_timer *w, int revents) 1131\& t2_cb (EV_P_ struct ev_timer *w, int revents)
1108\& { 1132\& {
1109\& struct my_biggy big = (struct my_biggy * 1133\& struct my_biggy big = (struct my_biggy *
1110\& (((char *)w) - offsetof (struct my_biggy, t2)); 1134\& (((char *)w) \- offsetof (struct my_biggy, t2));
1111\& } 1135\& }
1112.Ve 1136.Ve
1113.SH "WATCHER TYPES" 1137.SH "WATCHER TYPES"
1114.IX Header "WATCHER TYPES" 1138.IX Header "WATCHER TYPES"
1115This section describes each watcher in detail, but will not repeat 1139This section describes each watcher in detail, but will not repeat
1138In general you can register as many read and/or write event watchers per 1162In general you can register as many read and/or write event watchers per
1139fd as you want (as long as you don't confuse yourself). Setting all file 1163fd as you want (as long as you don't confuse yourself). Setting all file
1140descriptors to non-blocking mode is also usually a good idea (but not 1164descriptors to non-blocking mode is also usually a good idea (but not
1141required if you know what you are doing). 1165required if you know what you are doing).
1142.PP 1166.PP
1143You have to be careful with dup'ed file descriptors, though. Some backends
1144(the linux epoll backend is a notable example) cannot handle dup'ed file
1145descriptors correctly if you register interest in two or more fds pointing
1146to the same underlying file/socket/etc. description (that is, they share
1147the same underlying \*(L"file open\*(R").
1148.PP
1149If you must do this, then force the use of a known-to-be-good backend 1167If you must do this, then force the use of a known-to-be-good backend
1150(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and 1168(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
1151\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR). 1169\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).
1152.PP 1170.PP
1153Another thing you have to watch out for is that it is quite easy to 1171Another thing you have to watch out for is that it is quite easy to
1189.PP 1207.PP
1190\fIThe special problem of dup'ed file descriptors\fR 1208\fIThe special problem of dup'ed file descriptors\fR
1191.IX Subsection "The special problem of dup'ed file descriptors" 1209.IX Subsection "The special problem of dup'ed file descriptors"
1192.PP 1210.PP
1193Some backends (e.g. epoll), cannot register events for file descriptors, 1211Some backends (e.g. epoll), cannot register events for file descriptors,
1194but only events for the underlying file descriptions. That menas when you 1212but only events for the underlying file descriptions. That means when you
1195have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors and register events for them, only one 1213have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or weirder constellations, and register
1196file descriptor might actually receive events. 1214events for them, only one file descriptor might actually receive events.
1197.PP 1215.PP
1198There is no workaorund possible except not registering events 1216There is no workaround possible except not registering events
1199for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or to resort to 1217for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors, or to resort to
1200\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1218\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1201.PP 1219.PP
1202\fIThe special problem of fork\fR 1220\fIThe special problem of fork\fR
1203.IX Subsection "The special problem of fork" 1221.IX Subsection "The special problem of fork"
1204.PP 1222.PP
1208.PP 1226.PP
1209To support fork in your programs, you either have to call 1227To support fork in your programs, you either have to call
1210\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, 1228\&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child,
1211enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or 1229enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or
1212\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1230\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1231.PP
1232\fIThe special problem of \s-1SIGPIPE\s0\fR
1233.IX Subsection "The special problem of SIGPIPE"
1234.PP
1235While not really specific to libev, it is easy to forget about \s-1SIGPIPE:\s0
1236when reading from a pipe whose other end has been closed, your program
1237gets send a \s-1SIGPIPE\s0, which, by default, aborts your program. For most
1238programs this is sensible behaviour, for daemons, this is usually
1239undesirable.
1240.PP
1241So when you encounter spurious, unexplained daemon exits, make sure you
1242ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1243somewhere, as that would have given you a big clue).
1213.PP 1244.PP
1214\fIWatcher-Specific Functions\fR 1245\fIWatcher-Specific Functions\fR
1215.IX Subsection "Watcher-Specific Functions" 1246.IX Subsection "Watcher-Specific Functions"
1216.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 1247.IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
1217.IX Item "ev_io_init (ev_io *, callback, int fd, int events)" 1248.IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
1227The file descriptor being watched. 1258The file descriptor being watched.
1228.IP "int events [read\-only]" 4 1259.IP "int events [read\-only]" 4
1229.IX Item "int events [read-only]" 1260.IX Item "int events [read-only]"
1230The events being watched. 1261The events being watched.
1231.PP 1262.PP
1263\fIExamples\fR
1264.IX Subsection "Examples"
1265.PP
1232Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 1266Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
1233readable, but only once. Since it is likely line\-buffered, you could 1267readable, but only once. Since it is likely line-buffered, you could
1234attempt to read a whole line in the callback. 1268attempt to read a whole line in the callback.
1235.PP 1269.PP
1236.Vb 6 1270.Vb 6
1237\& static void 1271\& static void
1238\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1272\& stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1239\& { 1273\& {
1240\& ev_io_stop (loop, w); 1274\& ev_io_stop (loop, w);
1241\& .. read from stdin here (or from w->fd) and haqndle any I/O errors 1275\& .. read from stdin here (or from w\->fd) and haqndle any I/O errors
1242\& } 1276\& }
1243.Ve 1277\&
1244.PP
1245.Vb 6
1246\& ... 1278\& ...
1247\& struct ev_loop *loop = ev_default_init (0); 1279\& struct ev_loop *loop = ev_default_init (0);
1248\& struct ev_io stdin_readable; 1280\& struct ev_io stdin_readable;
1249\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); 1281\& ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1250\& ev_io_start (loop, &stdin_readable); 1282\& ev_io_start (loop, &stdin_readable);
1267of the event triggering whatever timeout you are modifying/starting. If 1299of the event triggering whatever timeout you are modifying/starting. If
1268you suspect event processing to be delayed and you \fIneed\fR to base the timeout 1300you suspect event processing to be delayed and you \fIneed\fR to base the timeout
1269on the current time, use something like this to adjust for this: 1301on the current time, use something like this to adjust for this:
1270.PP 1302.PP
1271.Vb 1 1303.Vb 1
1272\& ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1304\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.);
1273.Ve 1305.Ve
1274.PP 1306.PP
1275The callback is guarenteed to be invoked only when its timeout has passed, 1307The callback is guarenteed to be invoked only when its timeout has passed,
1276but if multiple timers become ready during the same loop iteration then 1308but if multiple timers become ready during the same loop iteration then
1277order of execution is undefined. 1309order of execution is undefined.
1292The timer itself will do a best-effort at avoiding drift, that is, if you 1324The timer itself will do a best-effort at avoiding drift, that is, if you
1293configure a timer to trigger every 10 seconds, then it will trigger at 1325configure a timer to trigger every 10 seconds, then it will trigger at
1294exactly 10 second intervals. If, however, your program cannot keep up with 1326exactly 10 second intervals. If, however, your program cannot keep up with
1295the timer (because it takes longer than those 10 seconds to do stuff) the 1327the timer (because it takes longer than those 10 seconds to do stuff) the
1296timer will not fire more than once per event loop iteration. 1328timer will not fire more than once per event loop iteration.
1297.IP "ev_timer_again (loop)" 4 1329.IP "ev_timer_again (loop, ev_timer *)" 4
1298.IX Item "ev_timer_again (loop)" 1330.IX Item "ev_timer_again (loop, ev_timer *)"
1299This will act as if the timer timed out and restart it again if it is 1331This will act as if the timer timed out and restart it again if it is
1300repeating. The exact semantics are: 1332repeating. The exact semantics are:
1301.Sp 1333.Sp
1302If the timer is pending, its pending status is cleared. 1334If the timer is pending, its pending status is cleared.
1303.Sp 1335.Sp
1321.Sp 1353.Sp
1322.Vb 8 1354.Vb 8
1323\& ev_timer_init (timer, callback, 0., 5.); 1355\& ev_timer_init (timer, callback, 0., 5.);
1324\& ev_timer_again (loop, timer); 1356\& ev_timer_again (loop, timer);
1325\& ... 1357\& ...
1326\& timer->again = 17.; 1358\& timer\->again = 17.;
1327\& ev_timer_again (loop, timer); 1359\& ev_timer_again (loop, timer);
1328\& ... 1360\& ...
1329\& timer->again = 10.; 1361\& timer\->again = 10.;
1330\& ev_timer_again (loop, timer); 1362\& ev_timer_again (loop, timer);
1331.Ve 1363.Ve
1332.Sp 1364.Sp
1333This is more slightly efficient then stopping/starting the timer each time 1365This is more slightly efficient then stopping/starting the timer each time
1334you want to modify its timeout value. 1366you want to modify its timeout value.
1336.IX Item "ev_tstamp repeat [read-write]" 1368.IX Item "ev_tstamp repeat [read-write]"
1337The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out 1369The current \f(CW\*(C`repeat\*(C'\fR value. Will be used each time the watcher times out
1338or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any), 1370or \f(CW\*(C`ev_timer_again\*(C'\fR is called and determines the next timeout (if any),
1339which is also when any modifications are taken into account. 1371which is also when any modifications are taken into account.
1340.PP 1372.PP
1373\fIExamples\fR
1374.IX Subsection "Examples"
1375.PP
1341Example: Create a timer that fires after 60 seconds. 1376Example: Create a timer that fires after 60 seconds.
1342.PP 1377.PP
1343.Vb 5 1378.Vb 5
1344\& static void 1379\& static void
1345\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1380\& one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1346\& { 1381\& {
1347\& .. one minute over, w is actually stopped right here 1382\& .. one minute over, w is actually stopped right here
1348\& } 1383\& }
1349.Ve 1384\&
1350.PP
1351.Vb 3
1352\& struct ev_timer mytimer; 1385\& struct ev_timer mytimer;
1353\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.); 1386\& ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1354\& ev_timer_start (loop, &mytimer); 1387\& ev_timer_start (loop, &mytimer);
1355.Ve 1388.Ve
1356.PP 1389.PP
1361\& static void 1394\& static void
1362\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1395\& timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1363\& { 1396\& {
1364\& .. ten seconds without any activity 1397\& .. ten seconds without any activity
1365\& } 1398\& }
1366.Ve 1399\&
1367.PP
1368.Vb 4
1369\& struct ev_timer mytimer; 1400\& struct ev_timer mytimer;
1370\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */ 1401\& ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1371\& ev_timer_again (&mytimer); /* start timer */ 1402\& ev_timer_again (&mytimer); /* start timer */
1372\& ev_loop (loop, 0); 1403\& ev_loop (loop, 0);
1373.Ve 1404\&
1374.PP
1375.Vb 3
1376\& // and in some piece of code that gets executed on any "activity": 1405\& // and in some piece of code that gets executed on any "activity":
1377\& // reset the timeout to start ticking again at 10 seconds 1406\& // reset the timeout to start ticking again at 10 seconds
1378\& ev_timer_again (&mytimer); 1407\& ev_timer_again (&mytimer);
1379.Ve 1408.Ve
1380.ie n .Sh """ev_periodic"" \- to cron or not to cron?" 1409.ie n .Sh """ev_periodic"" \- to cron or not to cron?"
1408.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)" 1437.IX Item "ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)"
1409.PD 1438.PD
1410Lots of arguments, lets sort it out... There are basically three modes of 1439Lots of arguments, lets sort it out... There are basically three modes of
1411operation, and we will explain them from simplest to complex: 1440operation, and we will explain them from simplest to complex:
1412.RS 4 1441.RS 4
1442.IP "\(bu" 4
1413.IP "* absolute timer (at = time, interval = reschedule_cb = 0)" 4 1443absolute timer (at = time, interval = reschedule_cb = 0)
1414.IX Item "absolute timer (at = time, interval = reschedule_cb = 0)" 1444.Sp
1415In this configuration the watcher triggers an event at the wallclock time 1445In this configuration the watcher triggers an event at the wallclock time
1416\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs, 1446\&\f(CW\*(C`at\*(C'\fR and doesn't repeat. It will not adjust when a time jump occurs,
1417that is, if it is to be run at January 1st 2011 then it will run when the 1447that is, if it is to be run at January 1st 2011 then it will run when the
1418system time reaches or surpasses this time. 1448system time reaches or surpasses this time.
1449.IP "\(bu" 4
1419.IP "* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 4 1450repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1420.IX Item "non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)" 1451.Sp
1421In this mode the watcher will always be scheduled to time out at the next 1452In this mode the watcher will always be scheduled to time out at the next
1422\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative) 1453\&\f(CW\*(C`at + N * interval\*(C'\fR time (for some integer N, which can also be negative)
1423and then repeat, regardless of any time jumps. 1454and then repeat, regardless of any time jumps.
1424.Sp 1455.Sp
1425This can be used to create timers that do not drift with respect to system 1456This can be used to create timers that do not drift with respect to system
1439time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps. 1470time where \f(CW\*(C`time = at (mod interval)\*(C'\fR, regardless of any time jumps.
1440.Sp 1471.Sp
1441For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near 1472For numerical stability it is preferable that the \f(CW\*(C`at\*(C'\fR value is near
1442\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for 1473\&\f(CW\*(C`ev_now ()\*(C'\fR (the current time), but there is no range requirement for
1443this value. 1474this value.
1475.IP "\(bu" 4
1444.IP "* manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 4 1476manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1445.IX Item "manual reschedule mode (at and interval ignored, reschedule_cb = callback)" 1477.Sp
1446In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being 1478In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`at\*(C'\fR are both being
1447ignored. Instead, each time the periodic watcher gets scheduled, the 1479ignored. Instead, each time the periodic watcher gets scheduled, the
1448reschedule callback will be called with the watcher as first, and the 1480reschedule callback will be called with the watcher as first, and the
1449current time as second argument. 1481current time as second argument.
1450.Sp 1482.Sp
1505.IP "ev_tstamp at [read\-only]" 4 1537.IP "ev_tstamp at [read\-only]" 4
1506.IX Item "ev_tstamp at [read-only]" 1538.IX Item "ev_tstamp at [read-only]"
1507When active, contains the absolute time that the watcher is supposed to 1539When active, contains the absolute time that the watcher is supposed to
1508trigger next. 1540trigger next.
1509.PP 1541.PP
1542\fIExamples\fR
1543.IX Subsection "Examples"
1544.PP
1510Example: Call a callback every hour, or, more precisely, whenever the 1545Example: Call a callback every hour, or, more precisely, whenever the
1511system clock is divisible by 3600. The callback invocation times have 1546system clock is divisible by 3600. The callback invocation times have
1512potentially a lot of jittering, but good long-term stability. 1547potentially a lot of jittering, but good long-term stability.
1513.PP 1548.PP
1514.Vb 5 1549.Vb 5
1515\& static void 1550\& static void
1516\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents) 1551\& clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1517\& { 1552\& {
1518\& ... its now a full hour (UTC, or TAI or whatever your clock follows) 1553\& ... its now a full hour (UTC, or TAI or whatever your clock follows)
1519\& } 1554\& }
1520.Ve 1555\&
1521.PP
1522.Vb 3
1523\& struct ev_periodic hourly_tick; 1556\& struct ev_periodic hourly_tick;
1524\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0); 1557\& ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1525\& ev_periodic_start (loop, &hourly_tick); 1558\& ev_periodic_start (loop, &hourly_tick);
1526.Ve 1559.Ve
1527.PP 1560.PP
1528Example: The same as above, but use a reschedule callback to do it: 1561Example: The same as above, but use a reschedule callback to do it:
1529.PP 1562.PP
1530.Vb 1 1563.Vb 1
1531\& #include <math.h> 1564\& #include <math.h>
1532.Ve 1565\&
1533.PP
1534.Vb 5
1535\& static ev_tstamp 1566\& static ev_tstamp
1536\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now) 1567\& my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1537\& { 1568\& {
1538\& return fmod (now, 3600.) + 3600.; 1569\& return fmod (now, 3600.) + 3600.;
1539\& } 1570\& }
1540.Ve 1571\&
1541.PP
1542.Vb 1
1543\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb); 1572\& ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1544.Ve 1573.Ve
1545.PP 1574.PP
1546Example: Call a callback every hour, starting now: 1575Example: Call a callback every hour, starting now:
1547.PP 1576.PP
1563first watcher gets started will libev actually register a signal watcher 1592first watcher gets started will libev actually register a signal watcher
1564with the kernel (thus it coexists with your own signal handlers as long 1593with the kernel (thus it coexists with your own signal handlers as long
1565as you don't register any with libev). Similarly, when the last signal 1594as you don't register any with libev). Similarly, when the last signal
1566watcher for a signal is stopped libev will reset the signal handler to 1595watcher for a signal is stopped libev will reset the signal handler to
1567\&\s-1SIG_DFL\s0 (regardless of what it was set to before). 1596\&\s-1SIG_DFL\s0 (regardless of what it was set to before).
1597.PP
1598If possible and supported, libev will install its handlers with
1599\&\f(CW\*(C`SA_RESTART\*(C'\fR behaviour enabled, so syscalls should not be unduly
1600interrupted. If you have a problem with syscalls getting interrupted by
1601signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher and unblock
1602them in an \f(CW\*(C`ev_prepare\*(C'\fR watcher.
1568.PP 1603.PP
1569\fIWatcher-Specific Functions and Data Members\fR 1604\fIWatcher-Specific Functions and Data Members\fR
1570.IX Subsection "Watcher-Specific Functions and Data Members" 1605.IX Subsection "Watcher-Specific Functions and Data Members"
1571.IP "ev_signal_init (ev_signal *, callback, int signum)" 4 1606.IP "ev_signal_init (ev_signal *, callback, int signum)" 4
1572.IX Item "ev_signal_init (ev_signal *, callback, int signum)" 1607.IX Item "ev_signal_init (ev_signal *, callback, int signum)"
1577Configures the watcher to trigger on the given signal number (usually one 1612Configures the watcher to trigger on the given signal number (usually one
1578of the \f(CW\*(C`SIGxxx\*(C'\fR constants). 1613of the \f(CW\*(C`SIGxxx\*(C'\fR constants).
1579.IP "int signum [read\-only]" 4 1614.IP "int signum [read\-only]" 4
1580.IX Item "int signum [read-only]" 1615.IX Item "int signum [read-only]"
1581The signal the watcher watches out for. 1616The signal the watcher watches out for.
1617.PP
1618\fIExamples\fR
1619.IX Subsection "Examples"
1620.PP
1621Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
1622.PP
1623.Vb 5
1624\& static void
1625\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1626\& {
1627\& ev_unloop (loop, EVUNLOOP_ALL);
1628\& }
1629\&
1630\& struct ev_signal signal_watcher;
1631\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1632\& ev_signal_start (loop, &sigint_cb);
1633.Ve
1582.ie n .Sh """ev_child"" \- watch out for process status changes" 1634.ie n .Sh """ev_child"" \- watch out for process status changes"
1583.el .Sh "\f(CWev_child\fP \- watch out for process status changes" 1635.el .Sh "\f(CWev_child\fP \- watch out for process status changes"
1584.IX Subsection "ev_child - watch out for process status changes" 1636.IX Subsection "ev_child - watch out for process status changes"
1585Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to 1637Child watchers trigger when your process receives a \s-1SIGCHLD\s0 in response to
1586some child status changes (most typically when a child of yours dies). 1638some child status changes (most typically when a child of yours dies). It
1639is permissible to install a child watcher \fIafter\fR the child has been
1640forked (which implies it might have already exited), as long as the event
1641loop isn't entered (or is continued from a watcher).
1642.PP
1643Only the default event loop is capable of handling signals, and therefore
1644you can only rgeister child watchers in the default event loop.
1645.PP
1646\fIProcess Interaction\fR
1647.IX Subsection "Process Interaction"
1648.PP
1649Libev grabs \f(CW\*(C`SIGCHLD\*(C'\fR as soon as the default event loop is
1650initialised. This is necessary to guarantee proper behaviour even if
1651the first child watcher is started after the child exits. The occurance
1652of \f(CW\*(C`SIGCHLD\*(C'\fR is recorded asynchronously, but child reaping is done
1653synchronously as part of the event loop processing. Libev always reaps all
1654children, even ones not watched.
1655.PP
1656\fIOverriding the Built-In Processing\fR
1657.IX Subsection "Overriding the Built-In Processing"
1658.PP
1659Libev offers no special support for overriding the built-in child
1660processing, but if your application collides with libev's default child
1661handler, you can override it easily by installing your own handler for
1662\&\f(CW\*(C`SIGCHLD\*(C'\fR after initialising the default loop, and making sure the
1663default loop never gets destroyed. You are encouraged, however, to use an
1664event-based approach to child reaping and thus use libev's support for
1665that, so other libev users can use \f(CW\*(C`ev_child\*(C'\fR watchers freely.
1587.PP 1666.PP
1588\fIWatcher-Specific Functions and Data Members\fR 1667\fIWatcher-Specific Functions and Data Members\fR
1589.IX Subsection "Watcher-Specific Functions and Data Members" 1668.IX Subsection "Watcher-Specific Functions and Data Members"
1590.IP "ev_child_init (ev_child *, callback, int pid)" 4 1669.IP "ev_child_init (ev_child *, callback, int pid, int trace)" 4
1591.IX Item "ev_child_init (ev_child *, callback, int pid)" 1670.IX Item "ev_child_init (ev_child *, callback, int pid, int trace)"
1592.PD 0 1671.PD 0
1593.IP "ev_child_set (ev_child *, int pid)" 4 1672.IP "ev_child_set (ev_child *, int pid, int trace)" 4
1594.IX Item "ev_child_set (ev_child *, int pid)" 1673.IX Item "ev_child_set (ev_child *, int pid, int trace)"
1595.PD 1674.PD
1596Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or 1675Configures the watcher to wait for status changes of process \f(CW\*(C`pid\*(C'\fR (or
1597\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look 1676\&\fIany\fR process if \f(CW\*(C`pid\*(C'\fR is specified as \f(CW0\fR). The callback can look
1598at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see 1677at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watcher structure to see
1599the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems 1678the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
1600\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the 1679\&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
1601process causing the status change. 1680process causing the status change. \f(CW\*(C`trace\*(C'\fR must be either \f(CW0\fR (only
1681activate the watcher when the process terminates) or \f(CW1\fR (additionally
1682activate the watcher when the process is stopped or continued).
1602.IP "int pid [read\-only]" 4 1683.IP "int pid [read\-only]" 4
1603.IX Item "int pid [read-only]" 1684.IX Item "int pid [read-only]"
1604The process id this watcher watches out for, or \f(CW0\fR, meaning any process id. 1685The process id this watcher watches out for, or \f(CW0\fR, meaning any process id.
1605.IP "int rpid [read\-write]" 4 1686.IP "int rpid [read\-write]" 4
1606.IX Item "int rpid [read-write]" 1687.IX Item "int rpid [read-write]"
1608.IP "int rstatus [read\-write]" 4 1689.IP "int rstatus [read\-write]" 4
1609.IX Item "int rstatus [read-write]" 1690.IX Item "int rstatus [read-write]"
1610The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems 1691The process exit/trace status caused by \f(CW\*(C`rpid\*(C'\fR (see your systems
1611\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details). 1692\&\f(CW\*(C`waitpid\*(C'\fR and \f(CW\*(C`sys/wait.h\*(C'\fR documentation for details).
1612.PP 1693.PP
1613Example: Try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0. 1694\fIExamples\fR
1695.IX Subsection "Examples"
1614.PP 1696.PP
1697Example: \f(CW\*(C`fork()\*(C'\fR a new process and install a child handler to wait for
1698its completion.
1699.PP
1615.Vb 5 1700.Vb 1
1701\& ev_child cw;
1702\&
1616\& static void 1703\& static void
1617\& sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1704\& child_cb (EV_P_ struct ev_child *w, int revents)
1618\& { 1705\& {
1619\& ev_unloop (loop, EVUNLOOP_ALL); 1706\& ev_child_stop (EV_A_ w);
1707\& printf ("process %d exited with status %x\en", w\->rpid, w\->rstatus);
1620\& } 1708\& }
1621.Ve 1709\&
1622.PP 1710\& pid_t pid = fork ();
1623.Vb 3 1711\&
1624\& struct ev_signal signal_watcher; 1712\& if (pid < 0)
1625\& ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1713\& // error
1626\& ev_signal_start (loop, &sigint_cb); 1714\& else if (pid == 0)
1715\& {
1716\& // the forked child executes here
1717\& exit (1);
1718\& }
1719\& else
1720\& {
1721\& ev_child_init (&cw, child_cb, pid, 0);
1722\& ev_child_start (EV_DEFAULT_ &cw);
1723\& }
1627.Ve 1724.Ve
1628.ie n .Sh """ev_stat"" \- did the file attributes just change?" 1725.ie n .Sh """ev_stat"" \- did the file attributes just change?"
1629.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?" 1726.el .Sh "\f(CWev_stat\fP \- did the file attributes just change?"
1630.IX Subsection "ev_stat - did the file attributes just change?" 1727.IX Subsection "ev_stat - did the file attributes just change?"
1631This watches a filesystem path for attribute changes. That is, it calls 1728This watches a filesystem path for attribute changes. That is, it calls
1650impose a minimum interval which is currently around \f(CW0.1\fR, but thats 1747impose a minimum interval which is currently around \f(CW0.1\fR, but thats
1651usually overkill. 1748usually overkill.
1652.PP 1749.PP
1653This watcher type is not meant for massive numbers of stat watchers, 1750This watcher type is not meant for massive numbers of stat watchers,
1654as even with OS-supported change notifications, this can be 1751as even with OS-supported change notifications, this can be
1655resource\-intensive. 1752resource-intensive.
1656.PP 1753.PP
1657At the time of this writing, only the Linux inotify interface is 1754At the time of this writing, only the Linux inotify interface is
1658implemented (implementing kqueue support is left as an exercise for the 1755implemented (implementing kqueue support is left as an exercise for the
1659reader). Inotify will be used to give hints only and should not change the 1756reader). Inotify will be used to give hints only and should not change the
1660semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs 1757semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers, which means that libev sometimes needs
1661to fall back to regular polling again even with inotify, but changes are 1758to fall back to regular polling again even with inotify, but changes are
1662usually detected immediately, and if the file exists there will be no 1759usually detected immediately, and if the file exists there will be no
1663polling. 1760polling.
1761.PP
1762\fI\s-1ABI\s0 Issues (Largefile Support)\fR
1763.IX Subsection "ABI Issues (Largefile Support)"
1764.PP
1765Libev by default (unless the user overrides this) uses the default
1766compilation environment, which means that on systems with optionally
1767disabled large file support, you get the 32 bit version of the stat
1768structure. When using the library from programs that change the \s-1ABI\s0 to
1769use 64 bit file offsets the programs will fail. In that case you have to
1770compile libev with the same flags to get binary compatibility. This is
1771obviously the case with any flags that change the \s-1ABI\s0, but the problem is
1772most noticably with ev_stat and largefile support.
1773.PP
1774\fIInotify\fR
1775.IX Subsection "Inotify"
1776.PP
1777When \f(CW\*(C`inotify (7)\*(C'\fR support has been compiled into libev (generally only
1778available on Linux) and present at runtime, it will be used to speed up
1779change detection where possible. The inotify descriptor will be created lazily
1780when the first \f(CW\*(C`ev_stat\*(C'\fR watcher is being started.
1781.PP
1782Inotify presense does not change the semantics of \f(CW\*(C`ev_stat\*(C'\fR watchers
1783except that changes might be detected earlier, and in some cases, to avoid
1784making regular \f(CW\*(C`stat\*(C'\fR calls. Even in the presense of inotify support
1785there are many cases where libev has to resort to regular \f(CW\*(C`stat\*(C'\fR polling.
1786.PP
1787(There is no support for kqueue, as apparently it cannot be used to
1788implement this functionality, due to the requirement of having a file
1789descriptor open on the object at all times).
1790.PP
1791\fIThe special problem of stat time resolution\fR
1792.IX Subsection "The special problem of stat time resolution"
1793.PP
1794The \f(CW\*(C`stat ()\*(C'\fR syscall only supports full-second resolution portably, and
1795even on systems where the resolution is higher, many filesystems still
1796only support whole seconds.
1797.PP
1798That means that, if the time is the only thing that changes, you might
1799miss updates: on the first update, \f(CW\*(C`ev_stat\*(C'\fR detects a change and calls
1800your callback, which does something. When there is another update within
1801the same second, \f(CW\*(C`ev_stat\*(C'\fR will be unable to detect it.
1802.PP
1803The solution to this is to delay acting on a change for a second (or till
1804the next second boundary), using a roughly one-second delay \f(CW\*(C`ev_timer\*(C'\fR
1805(\f(CW\*(C`ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)\*(C'\fR). The \f(CW.01\fR
1806is added to work around small timing inconsistencies of some operating
1807systems.
1664.PP 1808.PP
1665\fIWatcher-Specific Functions and Data Members\fR 1809\fIWatcher-Specific Functions and Data Members\fR
1666.IX Subsection "Watcher-Specific Functions and Data Members" 1810.IX Subsection "Watcher-Specific Functions and Data Members"
1667.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4 1811.IP "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 4
1668.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)" 1812.IX Item "ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)"
1677path for as long as the watcher is active. 1821path for as long as the watcher is active.
1678.Sp 1822.Sp
1679The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected, 1823The callback will be receive \f(CW\*(C`EV_STAT\*(C'\fR when a change was detected,
1680relative to the attributes at the time the watcher was started (or the 1824relative to the attributes at the time the watcher was started (or the
1681last change was detected). 1825last change was detected).
1682.IP "ev_stat_stat (ev_stat *)" 4 1826.IP "ev_stat_stat (loop, ev_stat *)" 4
1683.IX Item "ev_stat_stat (ev_stat *)" 1827.IX Item "ev_stat_stat (loop, ev_stat *)"
1684Updates the stat buffer immediately with new values. If you change the 1828Updates the stat buffer immediately with new values. If you change the
1685watched path in your callback, you could call this fucntion to avoid 1829watched path in your callback, you could call this fucntion to avoid
1686detecting this change (while introducing a race condition). Can also be 1830detecting this change (while introducing a race condition). Can also be
1687useful simply to find out the new values. 1831useful simply to find out the new values.
1688.IP "ev_statdata attr [read\-only]" 4 1832.IP "ev_statdata attr [read\-only]" 4
1700The specified interval. 1844The specified interval.
1701.IP "const char *path [read\-only]" 4 1845.IP "const char *path [read\-only]" 4
1702.IX Item "const char *path [read-only]" 1846.IX Item "const char *path [read-only]"
1703The filesystem path that is being watched. 1847The filesystem path that is being watched.
1704.PP 1848.PP
1849\fIExamples\fR
1850.IX Subsection "Examples"
1851.PP
1705Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes. 1852Example: Watch \f(CW\*(C`/etc/passwd\*(C'\fR for attribute changes.
1706.PP 1853.PP
1707.Vb 15 1854.Vb 10
1708\& static void 1855\& static void
1709\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1856\& passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1710\& { 1857\& {
1711\& /* /etc/passwd changed in some way */ 1858\& /* /etc/passwd changed in some way */
1712\& if (w->attr.st_nlink) 1859\& if (w\->attr.st_nlink)
1713\& { 1860\& {
1714\& printf ("passwd current size %ld\en", (long)w->attr.st_size); 1861\& printf ("passwd current size %ld\en", (long)w\->attr.st_size);
1715\& printf ("passwd current atime %ld\en", (long)w->attr.st_mtime); 1862\& printf ("passwd current atime %ld\en", (long)w\->attr.st_mtime);
1716\& printf ("passwd current mtime %ld\en", (long)w->attr.st_mtime); 1863\& printf ("passwd current mtime %ld\en", (long)w\->attr.st_mtime);
1717\& } 1864\& }
1718\& else 1865\& else
1719\& /* you shalt not abuse printf for puts */ 1866\& /* you shalt not abuse printf for puts */
1720\& puts ("wow, /etc/passwd is not there, expect problems. " 1867\& puts ("wow, /etc/passwd is not there, expect problems. "
1721\& "if this is windows, they already arrived\en"); 1868\& "if this is windows, they already arrived\en");
1722\& } 1869\& }
1723.Ve 1870\&
1724.PP
1725.Vb 2
1726\& ... 1871\& ...
1727\& ev_stat passwd; 1872\& ev_stat passwd;
1873\&
1874\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1875\& ev_stat_start (loop, &passwd);
1728.Ve 1876.Ve
1877.PP
1878Example: Like above, but additionally use a one-second delay so we do not
1879miss updates (however, frequent updates will delay processing, too, so
1880one might do the work both on \f(CW\*(C`ev_stat\*(C'\fR callback invocation \fIand\fR on
1881\&\f(CW\*(C`ev_timer\*(C'\fR callback invocation).
1729.PP 1882.PP
1730.Vb 2 1883.Vb 2
1884\& static ev_stat passwd;
1885\& static ev_timer timer;
1886\&
1887\& static void
1888\& timer_cb (EV_P_ ev_timer *w, int revents)
1889\& {
1890\& ev_timer_stop (EV_A_ w);
1891\&
1892\& /* now it\*(Aqs one second after the most recent passwd change */
1893\& }
1894\&
1895\& static void
1896\& stat_cb (EV_P_ ev_stat *w, int revents)
1897\& {
1898\& /* reset the one\-second timer */
1899\& ev_timer_again (EV_A_ &timer);
1900\& }
1901\&
1902\& ...
1731\& ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1903\& ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1732\& ev_stat_start (loop, &passwd); 1904\& ev_stat_start (loop, &passwd);
1905\& ev_timer_init (&timer, timer_cb, 0., 1.01);
1733.Ve 1906.Ve
1734.ie n .Sh """ev_idle"" \- when you've got nothing better to do..." 1907.ie n .Sh """ev_idle"" \- when you've got nothing better to do..."
1735.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..." 1908.el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do..."
1736.IX Subsection "ev_idle - when you've got nothing better to do..." 1909.IX Subsection "ev_idle - when you've got nothing better to do..."
1737Idle watchers trigger events when no other events of the same or higher 1910Idle watchers trigger events when no other events of the same or higher
1748The most noteworthy effect is that as long as any idle watchers are 1921The most noteworthy effect is that as long as any idle watchers are
1749active, the process will not block when waiting for new events. 1922active, the process will not block when waiting for new events.
1750.PP 1923.PP
1751Apart from keeping your process non-blocking (which is a useful 1924Apart from keeping your process non-blocking (which is a useful
1752effect on its own sometimes), idle watchers are a good place to do 1925effect on its own sometimes), idle watchers are a good place to do
1753\&\*(L"pseudo\-background processing\*(R", or delay processing stuff to after the 1926\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
1754event loop has handled all outstanding events. 1927event loop has handled all outstanding events.
1755.PP 1928.PP
1756\fIWatcher-Specific Functions and Data Members\fR 1929\fIWatcher-Specific Functions and Data Members\fR
1757.IX Subsection "Watcher-Specific Functions and Data Members" 1930.IX Subsection "Watcher-Specific Functions and Data Members"
1758.IP "ev_idle_init (ev_signal *, callback)" 4 1931.IP "ev_idle_init (ev_signal *, callback)" 4
1759.IX Item "ev_idle_init (ev_signal *, callback)" 1932.IX Item "ev_idle_init (ev_signal *, callback)"
1760Initialises and configures the idle watcher \- it has no parameters of any 1933Initialises and configures the idle watcher \- it has no parameters of any
1761kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless, 1934kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
1762believe me. 1935believe me.
1763.PP 1936.PP
1937\fIExamples\fR
1938.IX Subsection "Examples"
1939.PP
1764Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 1940Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
1765callback, free it. Also, use no error checking, as usual. 1941callback, free it. Also, use no error checking, as usual.
1766.PP 1942.PP
1767.Vb 7 1943.Vb 7
1768\& static void 1944\& static void
1769\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1945\& idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1770\& { 1946\& {
1771\& free (w); 1947\& free (w);
1772\& // now do something you wanted to do when the program has 1948\& // now do something you wanted to do when the program has
1773\& // no longer asnything immediate to do. 1949\& // no longer anything immediate to do.
1774\& } 1950\& }
1775.Ve 1951\&
1776.PP
1777.Vb 3
1778\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1952\& struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1779\& ev_idle_init (idle_watcher, idle_cb); 1953\& ev_idle_init (idle_watcher, idle_cb);
1780\& ev_idle_start (loop, idle_cb); 1954\& ev_idle_start (loop, idle_cb);
1781.Ve 1955.Ve
1782.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!" 1956.ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop!"
1824priority, to ensure that they are being run before any other watchers 1998priority, to ensure that they are being run before any other watchers
1825after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, 1999after the poll. Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers,
1826too) should not activate (\*(L"feed\*(R") events into libev. While libev fully 2000too) should not activate (\*(L"feed\*(R") events into libev. While libev fully
1827supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers 2001supports this, they will be called before other \f(CW\*(C`ev_check\*(C'\fR watchers
1828did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other 2002did their job. As \f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other
1829(non\-libev) event loops those other event loops might be in an unusable 2003(non-libev) event loops those other event loops might be in an unusable
1830state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to 2004state until their \f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to
1831coexist peacefully with others). 2005coexist peacefully with others).
1832.PP 2006.PP
1833\fIWatcher-Specific Functions and Data Members\fR 2007\fIWatcher-Specific Functions and Data Members\fR
1834.IX Subsection "Watcher-Specific Functions and Data Members" 2008.IX Subsection "Watcher-Specific Functions and Data Members"
1840.PD 2014.PD
1841Initialises and configures the prepare or check watcher \- they have no 2015Initialises and configures the prepare or check watcher \- they have no
1842parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR 2016parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
1843macros, but using them is utterly, utterly and completely pointless. 2017macros, but using them is utterly, utterly and completely pointless.
1844.PP 2018.PP
2019\fIExamples\fR
2020.IX Subsection "Examples"
2021.PP
1845There are a number of principal ways to embed other event loops or modules 2022There are a number of principal ways to embed other event loops or modules
1846into libev. Here are some ideas on how to include libadns into libev 2023into libev. Here are some ideas on how to include libadns into libev
1847(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could 2024(there is a Perl module named \f(CW\*(C`EV::ADNS\*(C'\fR that does this, which you could
1848use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR 2025use for an actually working example. Another Perl module named \f(CW\*(C`EV::Glib\*(C'\fR
1849embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0 2026embeds a Glib main context into libev, and finally, \f(CW\*(C`Glib::EV\*(C'\fR embeds \s-1EV\s0
1856the callbacks for the IO/timeout watchers might not have been called yet. 2033the callbacks for the IO/timeout watchers might not have been called yet.
1857.PP 2034.PP
1858.Vb 2 2035.Vb 2
1859\& static ev_io iow [nfd]; 2036\& static ev_io iow [nfd];
1860\& static ev_timer tw; 2037\& static ev_timer tw;
1861.Ve 2038\&
1862.PP
1863.Vb 4
1864\& static void 2039\& static void
1865\& io_cb (ev_loop *loop, ev_io *w, int revents) 2040\& io_cb (ev_loop *loop, ev_io *w, int revents)
1866\& { 2041\& {
1867\& } 2042\& }
1868.Ve 2043\&
1869.PP
1870.Vb 8
1871\& // create io watchers for each fd and a timer before blocking 2044\& // create io watchers for each fd and a timer before blocking
1872\& static void 2045\& static void
1873\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents) 2046\& adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1874\& { 2047\& {
1875\& int timeout = 3600000; 2048\& int timeout = 3600000;
1876\& struct pollfd fds [nfd]; 2049\& struct pollfd fds [nfd];
1877\& // actual code will need to loop here and realloc etc. 2050\& // actual code will need to loop here and realloc etc.
1878\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2051\& adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1879.Ve 2052\&
1880.PP
1881.Vb 3
1882\& /* the callback is illegal, but won't be called as we stop during check */ 2053\& /* the callback is illegal, but won\*(Aqt be called as we stop during check */
1883\& ev_timer_init (&tw, 0, timeout * 1e-3); 2054\& ev_timer_init (&tw, 0, timeout * 1e\-3);
1884\& ev_timer_start (loop, &tw); 2055\& ev_timer_start (loop, &tw);
1885.Ve 2056\&
1886.PP
1887.Vb 6
1888\& // create one ev_io per pollfd 2057\& // create one ev_io per pollfd
1889\& for (int i = 0; i < nfd; ++i) 2058\& for (int i = 0; i < nfd; ++i)
1890\& { 2059\& {
1891\& ev_io_init (iow + i, io_cb, fds [i].fd, 2060\& ev_io_init (iow + i, io_cb, fds [i].fd,
1892\& ((fds [i].events & POLLIN ? EV_READ : 0) 2061\& ((fds [i].events & POLLIN ? EV_READ : 0)
1893\& | (fds [i].events & POLLOUT ? EV_WRITE : 0))); 2062\& | (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1894.Ve 2063\&
1895.PP
1896.Vb 4
1897\& fds [i].revents = 0; 2064\& fds [i].revents = 0;
1898\& ev_io_start (loop, iow + i); 2065\& ev_io_start (loop, iow + i);
1899\& } 2066\& }
1900\& } 2067\& }
1901.Ve 2068\&
1902.PP
1903.Vb 5
1904\& // stop all watchers after blocking 2069\& // stop all watchers after blocking
1905\& static void 2070\& static void
1906\& adns_check_cb (ev_loop *loop, ev_check *w, int revents) 2071\& adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1907\& { 2072\& {
1908\& ev_timer_stop (loop, &tw); 2073\& ev_timer_stop (loop, &tw);
1909.Ve 2074\&
1910.PP
1911.Vb 8
1912\& for (int i = 0; i < nfd; ++i) 2075\& for (int i = 0; i < nfd; ++i)
1913\& { 2076\& {
1914\& // set the relevant poll flags 2077\& // set the relevant poll flags
1915\& // could also call adns_processreadable etc. here 2078\& // could also call adns_processreadable etc. here
1916\& struct pollfd *fd = fds + i; 2079\& struct pollfd *fd = fds + i;
1917\& int revents = ev_clear_pending (iow + i); 2080\& int revents = ev_clear_pending (iow + i);
1918\& if (revents & EV_READ ) fd->revents |= fd->events & POLLIN; 2081\& if (revents & EV_READ ) fd\->revents |= fd\->events & POLLIN;
1919\& if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT; 2082\& if (revents & EV_WRITE) fd\->revents |= fd\->events & POLLOUT;
1920.Ve 2083\&
1921.PP
1922.Vb 3
1923\& // now stop the watcher 2084\& // now stop the watcher
1924\& ev_io_stop (loop, iow + i); 2085\& ev_io_stop (loop, iow + i);
1925\& } 2086\& }
1926.Ve 2087\&
1927.PP
1928.Vb 2
1929\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop)); 2088\& adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1930\& } 2089\& }
1931.Ve 2090.Ve
1932.PP 2091.PP
1933Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR 2092Method 2: This would be just like method 1, but you run \f(CW\*(C`adns_afterpoll\*(C'\fR
1939.PP 2098.PP
1940.Vb 5 2099.Vb 5
1941\& static void 2100\& static void
1942\& timer_cb (EV_P_ ev_timer *w, int revents) 2101\& timer_cb (EV_P_ ev_timer *w, int revents)
1943\& { 2102\& {
1944\& adns_state ads = (adns_state)w->data; 2103\& adns_state ads = (adns_state)w\->data;
1945\& update_now (EV_A); 2104\& update_now (EV_A);
1946.Ve 2105\&
1947.PP
1948.Vb 2
1949\& adns_processtimeouts (ads, &tv_now); 2106\& adns_processtimeouts (ads, &tv_now);
1950\& } 2107\& }
1951.Ve 2108\&
1952.PP
1953.Vb 5
1954\& static void 2109\& static void
1955\& io_cb (EV_P_ ev_io *w, int revents) 2110\& io_cb (EV_P_ ev_io *w, int revents)
1956\& { 2111\& {
1957\& adns_state ads = (adns_state)w->data; 2112\& adns_state ads = (adns_state)w\->data;
1958\& update_now (EV_A); 2113\& update_now (EV_A);
1959.Ve 2114\&
1960.PP
1961.Vb 3
1962\& if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now); 2115\& if (revents & EV_READ ) adns_processreadable (ads, w\->fd, &tv_now);
1963\& if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now); 2116\& if (revents & EV_WRITE) adns_processwriteable (ads, w\->fd, &tv_now);
1964\& } 2117\& }
1965.Ve 2118\&
1966.PP
1967.Vb 1
1968\& // do not ever call adns_afterpoll 2119\& // do not ever call adns_afterpoll
1969.Ve 2120.Ve
1970.PP 2121.PP
1971Method 4: Do not use a prepare or check watcher because the module you 2122Method 4: Do not use a prepare or check watcher because the module you
1972want to embed is too inflexible to support it. Instead, youc na override 2123want to embed is too inflexible to support it. Instead, youc na override
1977.Vb 4 2128.Vb 4
1978\& static gint 2129\& static gint
1979\& event_poll_func (GPollFD *fds, guint nfds, gint timeout) 2130\& event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1980\& { 2131\& {
1981\& int got_events = 0; 2132\& int got_events = 0;
1982.Ve 2133\&
1983.PP
1984.Vb 2
1985\& for (n = 0; n < nfds; ++n) 2134\& for (n = 0; n < nfds; ++n)
1986\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events 2135\& // create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1987.Ve 2136\&
1988.PP
1989.Vb 2
1990\& if (timeout >= 0) 2137\& if (timeout >= 0)
1991\& // create/start timer 2138\& // create/start timer
1992.Ve 2139\&
1993.PP
1994.Vb 2
1995\& // poll 2140\& // poll
1996\& ev_loop (EV_A_ 0); 2141\& ev_loop (EV_A_ 0);
1997.Ve 2142\&
1998.PP
1999.Vb 3
2000\& // stop timer again 2143\& // stop timer again
2001\& if (timeout >= 0) 2144\& if (timeout >= 0)
2002\& ev_timer_stop (EV_A_ &to); 2145\& ev_timer_stop (EV_A_ &to);
2003.Ve 2146\&
2004.PP
2005.Vb 3
2006\& // stop io watchers again - their callbacks should have set 2147\& // stop io watchers again \- their callbacks should have set
2007\& for (n = 0; n < nfds; ++n) 2148\& for (n = 0; n < nfds; ++n)
2008\& ev_io_stop (EV_A_ iow [n]); 2149\& ev_io_stop (EV_A_ iow [n]);
2009.Ve 2150\&
2010.PP
2011.Vb 2
2012\& return got_events; 2151\& return got_events;
2013\& } 2152\& }
2014.Ve 2153.Ve
2015.ie n .Sh """ev_embed"" \- when one backend isn't enough..." 2154.ie n .Sh """ev_embed"" \- when one backend isn't enough..."
2016.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." 2155.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..."
2060portable one. 2199portable one.
2061.PP 2200.PP
2062So when you want to use this feature you will always have to be prepared 2201So when you want to use this feature you will always have to be prepared
2063that you cannot get an embeddable loop. The recommended way to get around 2202that you cannot get an embeddable loop. The recommended way to get around
2064this is to have a separate variables for your embeddable loop, try to 2203this is to have a separate variables for your embeddable loop, try to
2065create it, and if that fails, use the normal loop for everything: 2204create it, and if that fails, use the normal loop for everything.
2066.PP
2067.Vb 3
2068\& struct ev_loop *loop_hi = ev_default_init (0);
2069\& struct ev_loop *loop_lo = 0;
2070\& struct ev_embed embed;
2071.Ve
2072.PP
2073.Vb 5
2074\& // see if there is a chance of getting one that works
2075\& // (remember that a flags value of 0 means autodetection)
2076\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2077\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2078\& : 0;
2079.Ve
2080.PP
2081.Vb 8
2082\& // if we got one, then embed it, otherwise default to loop_hi
2083\& if (loop_lo)
2084\& {
2085\& ev_embed_init (&embed, 0, loop_lo);
2086\& ev_embed_start (loop_hi, &embed);
2087\& }
2088\& else
2089\& loop_lo = loop_hi;
2090.Ve
2091.PP 2205.PP
2092\fIWatcher-Specific Functions and Data Members\fR 2206\fIWatcher-Specific Functions and Data Members\fR
2093.IX Subsection "Watcher-Specific Functions and Data Members" 2207.IX Subsection "Watcher-Specific Functions and Data Members"
2094.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 2208.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
2095.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 2209.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
2108similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most 2222similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
2109apropriate way for embedded loops. 2223apropriate way for embedded loops.
2110.IP "struct ev_loop *other [read\-only]" 4 2224.IP "struct ev_loop *other [read\-only]" 4
2111.IX Item "struct ev_loop *other [read-only]" 2225.IX Item "struct ev_loop *other [read-only]"
2112The embedded event loop. 2226The embedded event loop.
2227.PP
2228\fIExamples\fR
2229.IX Subsection "Examples"
2230.PP
2231Example: Try to get an embeddable event loop and embed it into the default
2232event loop. If that is not possible, use the default loop. The default
2233loop is stored in \f(CW\*(C`loop_hi\*(C'\fR, while the mebeddable loop is stored in
2234\&\f(CW\*(C`loop_lo\*(C'\fR (which is \f(CW\*(C`loop_hi\*(C'\fR in the acse no embeddable loop can be
2235used).
2236.PP
2237.Vb 3
2238\& struct ev_loop *loop_hi = ev_default_init (0);
2239\& struct ev_loop *loop_lo = 0;
2240\& struct ev_embed embed;
2241\&
2242\& // see if there is a chance of getting one that works
2243\& // (remember that a flags value of 0 means autodetection)
2244\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2245\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2246\& : 0;
2247\&
2248\& // if we got one, then embed it, otherwise default to loop_hi
2249\& if (loop_lo)
2250\& {
2251\& ev_embed_init (&embed, 0, loop_lo);
2252\& ev_embed_start (loop_hi, &embed);
2253\& }
2254\& else
2255\& loop_lo = loop_hi;
2256.Ve
2257.PP
2258Example: Check if kqueue is available but not recommended and create
2259a kqueue backend for use with sockets (which usually work with any
2260kqueue implementation). Store the kqueue/socket\-only event loop in
2261\&\f(CW\*(C`loop_socket\*(C'\fR. (One might optionally use \f(CW\*(C`EVFLAG_NOENV\*(C'\fR, too).
2262.PP
2263.Vb 3
2264\& struct ev_loop *loop = ev_default_init (0);
2265\& struct ev_loop *loop_socket = 0;
2266\& struct ev_embed embed;
2267\&
2268\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2269\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2270\& {
2271\& ev_embed_init (&embed, 0, loop_socket);
2272\& ev_embed_start (loop, &embed);
2273\& }
2274\&
2275\& if (!loop_socket)
2276\& loop_socket = loop;
2277\&
2278\& // now use loop_socket for all sockets, and loop for everything else
2279.Ve
2113.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" 2280.ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork"
2114.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 2281.el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
2115.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 2282.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
2116Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 2283Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
2117whoever is a good citizen cared to tell libev about it by calling 2284whoever is a good citizen cared to tell libev about it by calling
2126.IP "ev_fork_init (ev_signal *, callback)" 4 2293.IP "ev_fork_init (ev_signal *, callback)" 4
2127.IX Item "ev_fork_init (ev_signal *, callback)" 2294.IX Item "ev_fork_init (ev_signal *, callback)"
2128Initialises and configures the fork watcher \- it has no parameters of any 2295Initialises and configures the fork watcher \- it has no parameters of any
2129kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless, 2296kind. There is a \f(CW\*(C`ev_fork_set\*(C'\fR macro, but using it is utterly pointless,
2130believe me. 2297believe me.
2298.ie n .Sh """ev_async"" \- how to wake up another event loop"
2299.el .Sh "\f(CWev_async\fP \- how to wake up another event loop"
2300.IX Subsection "ev_async - how to wake up another event loop"
2301In general, you cannot use an \f(CW\*(C`ev_loop\*(C'\fR from multiple threads or other
2302asynchronous sources such as signal handlers (as opposed to multiple event
2303loops \- those are of course safe to use in different threads).
2304.PP
2305Sometimes, however, you need to wake up another event loop you do not
2306control, for example because it belongs to another thread. This is what
2307\&\f(CW\*(C`ev_async\*(C'\fR watchers do: as long as the \f(CW\*(C`ev_async\*(C'\fR watcher is active, you
2308can signal it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal
2309safe.
2310.PP
2311This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
2312too, are asynchronous in nature, and signals, too, will be compressed
2313(i.e. the number of callback invocations may be less than the number of
2314\&\f(CW\*(C`ev_async_sent\*(C'\fR calls).
2315.PP
2316Unlike \f(CW\*(C`ev_signal\*(C'\fR watchers, \f(CW\*(C`ev_async\*(C'\fR works with any event loop, not
2317just the default loop.
2318.PP
2319\fIQueueing\fR
2320.IX Subsection "Queueing"
2321.PP
2322\&\f(CW\*(C`ev_async\*(C'\fR does not support queueing of data in any way. The reason
2323is that the author does not know of a simple (or any) algorithm for a
2324multiple-writer-single-reader queue that works in all cases and doesn't
2325need elaborate support such as pthreads.
2326.PP
2327That means that if you want to queue data, you have to provide your own
2328queue. But at least I can tell you would implement locking around your
2329queue:
2330.IP "queueing from a signal handler context" 4
2331.IX Item "queueing from a signal handler context"
2332To implement race-free queueing, you simply add to the queue in the signal
2333handler but you block the signal handler in the watcher callback. Here is an example that does that for
2334some fictitiuous \s-1SIGUSR1\s0 handler:
2335.Sp
2336.Vb 1
2337\& static ev_async mysig;
2338\&
2339\& static void
2340\& sigusr1_handler (void)
2341\& {
2342\& sometype data;
2343\&
2344\& // no locking etc.
2345\& queue_put (data);
2346\& ev_async_send (EV_DEFAULT_ &mysig);
2347\& }
2348\&
2349\& static void
2350\& mysig_cb (EV_P_ ev_async *w, int revents)
2351\& {
2352\& sometype data;
2353\& sigset_t block, prev;
2354\&
2355\& sigemptyset (&block);
2356\& sigaddset (&block, SIGUSR1);
2357\& sigprocmask (SIG_BLOCK, &block, &prev);
2358\&
2359\& while (queue_get (&data))
2360\& process (data);
2361\&
2362\& if (sigismember (&prev, SIGUSR1)
2363\& sigprocmask (SIG_UNBLOCK, &block, 0);
2364\& }
2365.Ve
2366.Sp
2367(Note: pthreads in theory requires you to use \f(CW\*(C`pthread_setmask\*(C'\fR
2368instead of \f(CW\*(C`sigprocmask\*(C'\fR when you use threads, but libev doesn't do it
2369either...).
2370.IP "queueing from a thread context" 4
2371.IX Item "queueing from a thread context"
2372The strategy for threads is different, as you cannot (easily) block
2373threads but you can easily preempt them, so to queue safely you need to
2374employ a traditional mutex lock, such as in this pthread example:
2375.Sp
2376.Vb 2
2377\& static ev_async mysig;
2378\& static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2379\&
2380\& static void
2381\& otherthread (void)
2382\& {
2383\& // only need to lock the actual queueing operation
2384\& pthread_mutex_lock (&mymutex);
2385\& queue_put (data);
2386\& pthread_mutex_unlock (&mymutex);
2387\&
2388\& ev_async_send (EV_DEFAULT_ &mysig);
2389\& }
2390\&
2391\& static void
2392\& mysig_cb (EV_P_ ev_async *w, int revents)
2393\& {
2394\& pthread_mutex_lock (&mymutex);
2395\&
2396\& while (queue_get (&data))
2397\& process (data);
2398\&
2399\& pthread_mutex_unlock (&mymutex);
2400\& }
2401.Ve
2402.PP
2403\fIWatcher-Specific Functions and Data Members\fR
2404.IX Subsection "Watcher-Specific Functions and Data Members"
2405.IP "ev_async_init (ev_async *, callback)" 4
2406.IX Item "ev_async_init (ev_async *, callback)"
2407Initialises and configures the async watcher \- it has no parameters of any
2408kind. There is a \f(CW\*(C`ev_asynd_set\*(C'\fR macro, but using it is utterly pointless,
2409believe me.
2410.IP "ev_async_send (loop, ev_async *)" 4
2411.IX Item "ev_async_send (loop, ev_async *)"
2412Sends/signals/activates the given \f(CW\*(C`ev_async\*(C'\fR watcher, that is, feeds
2413an \f(CW\*(C`EV_ASYNC\*(C'\fR event on the watcher into the event loop. Unlike
2414\&\f(CW\*(C`ev_feed_event\*(C'\fR, this call is safe to do in other threads, signal or
2415similar contexts (see the dicusssion of \f(CW\*(C`EV_ATOMIC_T\*(C'\fR in the embedding
2416section below on what exactly this means).
2417.Sp
2418This call incurs the overhead of a syscall only once per loop iteration,
2419so while the overhead might be noticable, it doesn't apply to repeated
2420calls to \f(CW\*(C`ev_async_send\*(C'\fR.
2421.IP "bool = ev_async_pending (ev_async *)" 4
2422.IX Item "bool = ev_async_pending (ev_async *)"
2423Returns a non-zero value when \f(CW\*(C`ev_async_send\*(C'\fR has been called on the
2424watcher but the event has not yet been processed (or even noted) by the
2425event loop.
2426.Sp
2427\&\f(CW\*(C`ev_async_send\*(C'\fR sets a flag in the watcher and wakes up the loop. When
2428the loop iterates next and checks for the watcher to have become active,
2429it will reset the flag again. \f(CW\*(C`ev_async_pending\*(C'\fR can be used to very
2430quickly check wether invoking the loop might be a good idea.
2431.Sp
2432Not that this does \fInot\fR check wether the watcher itself is pending, only
2433wether it has been requested to make this watcher pending.
2131.SH "OTHER FUNCTIONS" 2434.SH "OTHER FUNCTIONS"
2132.IX Header "OTHER FUNCTIONS" 2435.IX Header "OTHER FUNCTIONS"
2133There are some other functions of possible interest. Described. Here. Now. 2436There are some other functions of possible interest. Described. Here. Now.
2134.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 2437.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4
2135.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 2438.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)"
2159\& if (revents & EV_TIMEOUT) 2462\& if (revents & EV_TIMEOUT)
2160\& /* doh, nothing entered */; 2463\& /* doh, nothing entered */;
2161\& else if (revents & EV_READ) 2464\& else if (revents & EV_READ)
2162\& /* stdin might have data for us, joy! */; 2465\& /* stdin might have data for us, joy! */;
2163\& } 2466\& }
2164.Ve 2467\&
2165.Sp
2166.Vb 1
2167\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 2468\& ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2168.Ve 2469.Ve
2169.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4 2470.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4
2170.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)" 2471.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)"
2171Feeds the given event set into the event loop, as if the specified event 2472Feeds the given event set into the event loop, as if the specified event
2181loop!). 2482loop!).
2182.SH "LIBEVENT EMULATION" 2483.SH "LIBEVENT EMULATION"
2183.IX Header "LIBEVENT EMULATION" 2484.IX Header "LIBEVENT EMULATION"
2184Libev offers a compatibility emulation layer for libevent. It cannot 2485Libev offers a compatibility emulation layer for libevent. It cannot
2185emulate the internals of libevent, so here are some usage hints: 2486emulate the internals of libevent, so here are some usage hints:
2487.IP "\(bu" 4
2186.IP "* Use it by including <event.h>, as usual." 4 2488Use it by including <event.h>, as usual.
2187.IX Item "Use it by including <event.h>, as usual." 2489.IP "\(bu" 4
2188.PD 0 2490The following members are fully supported: ev_base, ev_callback,
2189.IP "* The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 4 2491ev_arg, ev_fd, ev_res, ev_events.
2190.IX Item "The following members are fully supported: ev_base, ev_callback, ev_arg, ev_fd, ev_res, ev_events." 2492.IP "\(bu" 4
2191.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 2493Avoid using ev_flags and the EVLIST_*\-macros, while it is
2192.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)." 2494maintained by libev, it does not work exactly the same way as in libevent (consider
2193.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 2495it a private \s-1API\s0).
2194.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." 2496.IP "\(bu" 4
2497Priorities are not currently supported. Initialising priorities
2498will fail and all watchers will have the same priority, even though there
2499is an ev_pri field.
2500.IP "\(bu" 4
2195.IP "* Other members are not supported." 4 2501Other members are not supported.
2196.IX Item "Other members are not supported." 2502.IP "\(bu" 4
2197.IP "* The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need to use the libev header file and library." 4 2503The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
2198.IX Item "The libev emulation is not ABI compatible to libevent, you need to use the libev header file and library." 2504to use the libev header file and library.
2199.PD
2200.SH "\*(C+ SUPPORT" 2505.SH "\*(C+ SUPPORT"
2201.IX Header " SUPPORT" 2506.IX Header " SUPPORT"
2202Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 2507Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
2203you to use some convinience methods to start/stop watchers and also change 2508you to use some convinience methods to start/stop watchers and also change
2204the callback model to a model using method callbacks on objects. 2509the callback model to a model using method callbacks on objects.
2284.Vb 4 2589.Vb 4
2285\& struct myclass 2590\& struct myclass
2286\& { 2591\& {
2287\& void io_cb (ev::io &w, int revents) { } 2592\& void io_cb (ev::io &w, int revents) { }
2288\& } 2593\& }
2289.Ve 2594\&
2290.Sp
2291.Vb 3
2292\& myclass obj; 2595\& myclass obj;
2293\& ev::io iow; 2596\& ev::io iow;
2294\& iow.set <myclass, &myclass::io_cb> (&obj); 2597\& iow.set <myclass, &myclass::io_cb> (&obj);
2295.Ve 2598.Ve
2296.IP "w\->set<function> (void *data = 0)" 4 2599.IP "w\->set<function> (void *data = 0)" 4
2347the constructor. 2650the constructor.
2348.PP 2651.PP
2349.Vb 4 2652.Vb 4
2350\& class myclass 2653\& class myclass
2351\& { 2654\& {
2352\& ev_io io; void io_cb (ev::io &w, int revents); 2655\& ev::io io; void io_cb (ev::io &w, int revents);
2353\& ev_idle idle void idle_cb (ev::idle &w, int revents); 2656\& ev:idle idle void idle_cb (ev::idle &w, int revents);
2354.Ve 2657\&
2355.PP
2356.Vb 2
2357\& myclass (); 2658\& myclass (int fd)
2358\& }
2359.Ve
2360.PP
2361.Vb 4
2362\& myclass::myclass (int fd)
2363\& { 2659\& {
2364\& io .set <myclass, &myclass::io_cb > (this); 2660\& io .set <myclass, &myclass::io_cb > (this);
2365\& idle.set <myclass, &myclass::idle_cb> (this); 2661\& idle.set <myclass, &myclass::idle_cb> (this);
2366.Ve 2662\&
2367.PP
2368.Vb 2
2369\& io.start (fd, ev::READ); 2663\& io.start (fd, ev::READ);
2664\& }
2370\& } 2665\& };
2371.Ve 2666.Ve
2667.SH "OTHER LANGUAGE BINDINGS"
2668.IX Header "OTHER LANGUAGE BINDINGS"
2669Libev does not offer other language bindings itself, but bindings for a
2670numbe rof languages exist in the form of third-party packages. If you know
2671any interesting language binding in addition to the ones listed here, drop
2672me a note.
2673.IP "Perl" 4
2674.IX Item "Perl"
2675The \s-1EV\s0 module implements the full libev \s-1API\s0 and is actually used to test
2676libev. \s-1EV\s0 is developed together with libev. Apart from the \s-1EV\s0 core module,
2677there are additional modules that implement libev-compatible interfaces
2678to \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
2679\&\f(CW\*(C`libglib\*(C'\fR event core (\f(CW\*(C`Glib::EV\*(C'\fR and \f(CW\*(C`EV::Glib\*(C'\fR).
2680.Sp
2681It can be found and installed via \s-1CPAN\s0, its homepage is found at
2682<http://software.schmorp.de/pkg/EV>.
2683.IP "Ruby" 4
2684.IX Item "Ruby"
2685Tony Arcieri has written a ruby extension that offers access to a subset
2686of the libev \s-1API\s0 and adds filehandle abstractions, asynchronous \s-1DNS\s0 and
2687more on top of it. It can be found via gem servers. Its homepage is at
2688<http://rev.rubyforge.org/>.
2689.IP "D" 4
2690.IX Item "D"
2691Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
2692be found at <http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2372.SH "MACRO MAGIC" 2693.SH "MACRO MAGIC"
2373.IX Header "MACRO MAGIC" 2694.IX Header "MACRO MAGIC"
2374Libev can be compiled with a variety of options, the most fundamantal 2695Libev can be compiled with a variety of options, the most fundamantal
2375of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 2696of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
2376functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 2697functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
2400\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example: 2721\&\f(CW\*(C`EV_P_\*(C'\fR is used when other parameters are following. Example:
2401.Sp 2722.Sp
2402.Vb 2 2723.Vb 2
2403\& // this is how ev_unref is being declared 2724\& // this is how ev_unref is being declared
2404\& static void ev_unref (EV_P); 2725\& static void ev_unref (EV_P);
2405.Ve 2726\&
2406.Sp
2407.Vb 2
2408\& // this is how you can declare your typical callback 2727\& // this is how you can declare your typical callback
2409\& static void cb (EV_P_ ev_timer *w, int revents) 2728\& static void cb (EV_P_ ev_timer *w, int revents)
2410.Ve 2729.Ve
2411.Sp 2730.Sp
2412It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite 2731It declares a parameter \f(CW\*(C`loop\*(C'\fR of type \f(CW\*(C`struct ev_loop *\*(C'\fR, quite
2425\& static void 2744\& static void
2426\& check_cb (EV_P_ ev_timer *w, int revents) 2745\& check_cb (EV_P_ ev_timer *w, int revents)
2427\& { 2746\& {
2428\& ev_check_stop (EV_A_ w); 2747\& ev_check_stop (EV_A_ w);
2429\& } 2748\& }
2430.Ve 2749\&
2431.PP
2432.Vb 4
2433\& ev_check check; 2750\& ev_check check;
2434\& ev_check_init (&check, check_cb); 2751\& ev_check_init (&check, check_cb);
2435\& ev_check_start (EV_DEFAULT_ &check); 2752\& ev_check_start (EV_DEFAULT_ &check);
2436\& ev_loop (EV_DEFAULT_ 0); 2753\& ev_loop (EV_DEFAULT_ 0);
2437.Ve 2754.Ve
2438.SH "EMBEDDING" 2755.SH "EMBEDDING"
2439.IX Header "EMBEDDING" 2756.IX Header "EMBEDDING"
2440Libev can (and often is) directly embedded into host 2757Libev can (and often is) directly embedded into host
2441applications. Examples of applications that embed it include the Deliantra 2758applications. Examples of applications that embed it include the Deliantra
2442Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) 2759Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
2443and rxvt\-unicode. 2760and rxvt-unicode.
2444.PP 2761.PP
2445The goal is to enable you to just copy the necessary files into your 2762The goal is to enable you to just copy the necessary files into your
2446source directory without having to change even a single line in them, so 2763source directory without having to change even a single line in them, so
2447you can easily upgrade by simply copying (or having a checked-out copy of 2764you can easily upgrade by simply copying (or having a checked-out copy of
2448libev somewhere in your source tree). 2765libev somewhere in your source tree).
2483.Vb 4 2800.Vb 4
2484\& ev.h 2801\& ev.h
2485\& ev.c 2802\& ev.c
2486\& ev_vars.h 2803\& ev_vars.h
2487\& ev_wrap.h 2804\& ev_wrap.h
2488.Ve 2805\&
2489.PP
2490.Vb 1
2491\& ev_win32.c required on win32 platforms only 2806\& ev_win32.c required on win32 platforms only
2492.Ve 2807\&
2493.PP
2494.Vb 5
2495\& ev_select.c only when select backend is enabled (which is enabled by default) 2808\& ev_select.c only when select backend is enabled (which is enabled by default)
2496\& ev_poll.c only when poll backend is enabled (disabled by default) 2809\& ev_poll.c only when poll backend is enabled (disabled by default)
2497\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 2810\& ev_epoll.c only when the epoll backend is enabled (disabled by default)
2498\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 2811\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2499\& ev_port.c only when the solaris port backend is enabled (disabled by default) 2812\& ev_port.c only when the solaris port backend is enabled (disabled by default)
2594wants osf handles on win32 (this is the case when the select to 2907wants osf handles on win32 (this is the case when the select to
2595be used is the winsock select). This means that it will call 2908be used is the winsock select). This means that it will call
2596\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise, 2909\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
2597it is assumed that all these functions actually work on fds, even 2910it is assumed that all these functions actually work on fds, even
2598on win32. Should not be defined on non\-win32 platforms. 2911on win32. Should not be defined on non\-win32 platforms.
2912.IP "\s-1EV_FD_TO_WIN32_HANDLE\s0" 4
2913.IX Item "EV_FD_TO_WIN32_HANDLE"
2914If \f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR is enabled, then libev needs a way to map
2915file descriptors to socket handles. When not defining this symbol (the
2916default), then libev will call \f(CW\*(C`_get_osfhandle\*(C'\fR, which is usually
2917correct. In some cases, programs use their own file descriptor management,
2918in which case they can provide this function to map fds to socket handles.
2599.IP "\s-1EV_USE_POLL\s0" 4 2919.IP "\s-1EV_USE_POLL\s0" 4
2600.IX Item "EV_USE_POLL" 2920.IX Item "EV_USE_POLL"
2601If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 2921If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
2602backend. Otherwise it will be enabled on non\-win32 platforms. It 2922backend. Otherwise it will be enabled on non\-win32 platforms. It
2603takes precedence over select. 2923takes precedence over select.
2630.IP "\s-1EV_USE_INOTIFY\s0" 4 2950.IP "\s-1EV_USE_INOTIFY\s0" 4
2631.IX Item "EV_USE_INOTIFY" 2951.IX Item "EV_USE_INOTIFY"
2632If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify 2952If defined to be \f(CW1\fR, libev will compile in support for the Linux inotify
2633interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will 2953interface to speed up \f(CW\*(C`ev_stat\*(C'\fR watchers. Its actual availability will
2634be detected at runtime. 2954be detected at runtime.
2955.IP "\s-1EV_ATOMIC_T\s0" 4
2956.IX Item "EV_ATOMIC_T"
2957Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
2958access is atomic with respect to other threads or signal contexts. No such
2959type is easily found in the C language, so you can provide your own type
2960that you know is safe for your purposes. It is used both for signal handler \*(L"locking\*(R"
2961as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR watchers.
2962.Sp
2963In the absense of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
2964(from \fIsignal.h\fR), which is usually good enough on most platforms.
2635.IP "\s-1EV_H\s0" 4 2965.IP "\s-1EV_H\s0" 4
2636.IX Item "EV_H" 2966.IX Item "EV_H"
2637The name of the \fIev.h\fR header file used to include it. The default if 2967The name of the \fIev.h\fR header file used to include it. The default if
2638undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This 2968undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
2639can be used to virtually rename the \fIev.h\fR header file in case of conflicts. 2969used to virtually rename the \fIev.h\fR header file in case of conflicts.
2640.IP "\s-1EV_CONFIG_H\s0" 4 2970.IP "\s-1EV_CONFIG_H\s0" 4
2641.IX Item "EV_CONFIG_H" 2971.IX Item "EV_CONFIG_H"
2642If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override 2972If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
2643\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to 2973\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
2644\&\f(CW\*(C`EV_H\*(C'\fR, above. 2974\&\f(CW\*(C`EV_H\*(C'\fR, above.
2645.IP "\s-1EV_EVENT_H\s0" 4 2975.IP "\s-1EV_EVENT_H\s0" 4
2646.IX Item "EV_EVENT_H" 2976.IX Item "EV_EVENT_H"
2647Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea 2977Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
2648of how the \fIevent.h\fR header can be found. 2978of how the \fIevent.h\fR header can be found, the default is \f(CW"event.h"\fR.
2649.IP "\s-1EV_PROTOTYPES\s0" 4 2979.IP "\s-1EV_PROTOTYPES\s0" 4
2650.IX Item "EV_PROTOTYPES" 2980.IX Item "EV_PROTOTYPES"
2651If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function 2981If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
2652prototypes, but still define all the structs and other symbols. This is 2982prototypes, but still define all the structs and other symbols. This is
2653occasionally useful if you want to provide your own wrapper functions 2983occasionally useful if you want to provide your own wrapper functions
2697defined to be \f(CW0\fR, then they are not. 3027defined to be \f(CW0\fR, then they are not.
2698.IP "\s-1EV_FORK_ENABLE\s0" 4 3028.IP "\s-1EV_FORK_ENABLE\s0" 4
2699.IX Item "EV_FORK_ENABLE" 3029.IX Item "EV_FORK_ENABLE"
2700If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If 3030If undefined or defined to be \f(CW1\fR, then fork watchers are supported. If
2701defined to be \f(CW0\fR, then they are not. 3031defined to be \f(CW0\fR, then they are not.
3032.IP "\s-1EV_ASYNC_ENABLE\s0" 4
3033.IX Item "EV_ASYNC_ENABLE"
3034If undefined or defined to be \f(CW1\fR, then async watchers are supported. If
3035defined to be \f(CW0\fR, then they are not.
2702.IP "\s-1EV_MINIMAL\s0" 4 3036.IP "\s-1EV_MINIMAL\s0" 4
2703.IX Item "EV_MINIMAL" 3037.IX Item "EV_MINIMAL"
2704If you need to shave off some kilobytes of code at the expense of some 3038If you need to shave off some kilobytes of code at the expense of some
2705speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override 3039speed, define this symbol to \f(CW1\fR. Currently only used for gcc to override
2706some inlining decisions, saves roughly 30% codesize of amd64. 3040some inlining decisions, saves roughly 30% codesize of amd64.
2710pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more 3044pid. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), usually more
2711than enough. If you need to manage thousands of children you might want to 3045than enough. If you need to manage thousands of children you might want to
2712increase this value (\fImust\fR be a power of two). 3046increase this value (\fImust\fR be a power of two).
2713.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4 3047.IP "\s-1EV_INOTIFY_HASHSIZE\s0" 4
2714.IX Item "EV_INOTIFY_HASHSIZE" 3048.IX Item "EV_INOTIFY_HASHSIZE"
2715\&\f(CW\*(C`ev_staz\*(C'\fR watchers use a small hash table to distribute workload by 3049\&\f(CW\*(C`ev_stat\*(C'\fR watchers use a small hash table to distribute workload by
2716inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR), 3050inotify watch id. The default size is \f(CW16\fR (or \f(CW1\fR with \f(CW\*(C`EV_MINIMAL\*(C'\fR),
2717usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR 3051usually more than enough. If you need to manage thousands of \f(CW\*(C`ev_stat\*(C'\fR
2718watchers you might want to increase this value (\fImust\fR be a power of 3052watchers you might want to increase this value (\fImust\fR be a power of
2719two). 3053two).
2720.IP "\s-1EV_COMMON\s0" 4 3054.IP "\s-1EV_COMMON\s0" 4
2748.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 3082.Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0"
2749.IX Subsection "EXPORTED API SYMBOLS" 3083.IX Subsection "EXPORTED API SYMBOLS"
2750If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of 3084If you need to re-export the \s-1API\s0 (e.g. via a dll) and you need a list of
2751exported symbols, you can use the provided \fISymbol.*\fR files which list 3085exported symbols, you can use the provided \fISymbol.*\fR files which list
2752all public symbols, one per line: 3086all public symbols, one per line:
2753.Sp 3087.PP
2754.Vb 2 3088.Vb 2
2755\& Symbols.ev for libev proper 3089\& Symbols.ev for libev proper
2756\& Symbols.event for the libevent emulation 3090\& Symbols.event for the libevent emulation
2757.Ve 3091.Ve
2758.Sp 3092.PP
2759This can also be used to rename all public symbols to avoid clashes with 3093This can also be used to rename all public symbols to avoid clashes with
2760multiple versions of libev linked together (which is obviously bad in 3094multiple versions of libev linked together (which is obviously bad in
2761itself, but sometimes it is inconvinient to avoid this). 3095itself, but sometimes it is inconvinient to avoid this).
2762.Sp 3096.PP
2763A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to 3097A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to
2764include before including \fIev.h\fR: 3098include before including \fIev.h\fR:
2765.Sp 3099.PP
2766.Vb 1 3100.Vb 1
2767\& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h 3101\& <Symbols.ev sed \-e "s/.*/#define & myprefix_&/" >wrap.h
2768.Ve 3102.Ve
2769.Sp 3103.PP
2770This would create a file \fIwrap.h\fR which essentially looks like this: 3104This would create a file \fIwrap.h\fR which essentially looks like this:
2771.Sp 3105.PP
2772.Vb 4 3106.Vb 4
2773\& #define ev_backend myprefix_ev_backend 3107\& #define ev_backend myprefix_ev_backend
2774\& #define ev_check_start myprefix_ev_check_start 3108\& #define ev_check_start myprefix_ev_check_start
2775\& #define ev_check_stop myprefix_ev_check_stop 3109\& #define ev_check_stop myprefix_ev_check_stop
2776\& ... 3110\& ...
2782(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 3116(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
2783the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public 3117the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
2784interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file 3118interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
2785will be compiled. It is pretty complex because it provides its own header 3119will be compiled. It is pretty complex because it provides its own header
2786file. 3120file.
2787.Sp 3121.PP
2788The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file 3122The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
2789that everybody includes and which overrides some configure choices: 3123that everybody includes and which overrides some configure choices:
2790.Sp 3124.PP
2791.Vb 9 3125.Vb 9
2792\& #define EV_MINIMAL 1 3126\& #define EV_MINIMAL 1
2793\& #define EV_USE_POLL 0 3127\& #define EV_USE_POLL 0
2794\& #define EV_MULTIPLICITY 0 3128\& #define EV_MULTIPLICITY 0
2795\& #define EV_PERIODIC_ENABLE 0 3129\& #define EV_PERIODIC_ENABLE 0
2796\& #define EV_STAT_ENABLE 0 3130\& #define EV_STAT_ENABLE 0
2797\& #define EV_FORK_ENABLE 0 3131\& #define EV_FORK_ENABLE 0
2798\& #define EV_CONFIG_H <config.h> 3132\& #define EV_CONFIG_H <config.h>
2799\& #define EV_MINPRI 0 3133\& #define EV_MINPRI 0
2800\& #define EV_MAXPRI 0 3134\& #define EV_MAXPRI 0
2801.Ve 3135\&
2802.Sp
2803.Vb 1
2804\& #include "ev++.h" 3136\& #include "ev++.h"
2805.Ve 3137.Ve
2806.Sp 3138.PP
2807And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled: 3139And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
2808.Sp 3140.PP
2809.Vb 2 3141.Vb 2
2810\& #include "ev_cpp.h" 3142\& #include "ev_cpp.h"
2811\& #include "ev.c" 3143\& #include "ev.c"
2812.Ve 3144.Ve
2813.SH "COMPLEXITIES" 3145.SH "COMPLEXITIES"
2814.IX Header "COMPLEXITIES" 3146.IX Header "COMPLEXITIES"
2815In this section the complexities of (many of) the algorithms used inside 3147In this section the complexities of (many of) the algorithms used inside
2816libev will be explained. For complexity discussions about backends see the 3148libev will be explained. For complexity discussions about backends see the
2817documentation for \f(CW\*(C`ev_default_init\*(C'\fR. 3149documentation for \f(CW\*(C`ev_default_init\*(C'\fR.
2818.Sp 3150.PP
2819All of the following are about amortised time: If an array needs to be 3151All of the following are about amortised time: If an array needs to be
2820extended, libev needs to realloc and move the whole array, but this 3152extended, libev needs to realloc and move the whole array, but this
2821happens asymptotically never with higher number of elements, so O(1) might 3153happens asymptotically never with higher number of elements, so O(1) might
2822mean it might do a lengthy realloc operation in rare cases, but on average 3154mean it might do a lengthy realloc operation in rare cases, but on average
2823it is much faster and asymptotically approaches constant time. 3155it is much faster and asymptotically approaches constant time.
2824.RS 4
2825.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4 3156.IP "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 4
2826.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)" 3157.IX Item "Starting and stopping timer/periodic watchers: O(log skipped_other_timers)"
2827This means that, when you have a watcher that triggers in one hour and 3158This means that, when you have a watcher that triggers in one hour and
2828there are 100 watchers that would trigger before that then inserting will 3159there are 100 watchers that would trigger before that then inserting will
2829have to skip those 100 watchers. 3160have to skip roughly seven (\f(CW\*(C`ld 100\*(C'\fR) of these watchers.
2830.IP "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 4 3161.IP "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)" 4
2831.IX Item "Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)" 3162.IX Item "Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)"
2832That means that for changing a timer costs less than removing/adding them 3163That means that changing a timer costs less than removing/adding them
2833as only the relative motion in the event queue has to be paid for. 3164as only the relative motion in the event queue has to be paid for.
2834.IP "Starting io/check/prepare/idle/signal/child watchers: O(1)" 4 3165.IP "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)" 4
2835.IX Item "Starting io/check/prepare/idle/signal/child watchers: O(1)" 3166.IX Item "Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)"
2836These just add the watcher into an array or at the head of a list. 3167These just add the watcher into an array or at the head of a list.
3168.IP "Stopping check/prepare/idle/fork/async watchers: O(1)" 4
2837=item Stopping check/prepare/idle watchers: O(1) 3169.IX Item "Stopping check/prepare/idle/fork/async watchers: O(1)"
3170.PD 0
2838.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4 3171.IP "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % \s-1EV_PID_HASHSIZE\s0))" 4
2839.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))" 3172.IX Item "Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))"
3173.PD
2840These watchers are stored in lists then need to be walked to find the 3174These watchers are stored in lists then need to be walked to find the
2841correct watcher to remove. The lists are usually short (you don't usually 3175correct watcher to remove. The lists are usually short (you don't usually
2842have many watchers waiting for the same fd or signal). 3176have many watchers waiting for the same fd or signal).
2843.IP "Finding the next timer per loop iteration: O(1)" 4 3177.IP "Finding the next timer in each loop iteration: O(1)" 4
2844.IX Item "Finding the next timer per loop iteration: O(1)" 3178.IX Item "Finding the next timer in each loop iteration: O(1)"
2845.PD 0 3179By virtue of using a binary heap, the next timer is always found at the
3180beginning of the storage array.
2846.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4 3181.IP "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 4
2847.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)" 3182.IX Item "Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)"
2848.PD
2849A change means an I/O watcher gets started or stopped, which requires 3183A change means an I/O watcher gets started or stopped, which requires
2850libev to recalculate its status (and possibly tell the kernel). 3184libev to recalculate its status (and possibly tell the kernel, depending
2851.IP "Activating one watcher: O(1)" 4 3185on backend and wether \f(CW\*(C`ev_io_set\*(C'\fR was used).
2852.IX Item "Activating one watcher: O(1)" 3186.IP "Activating one watcher (putting it into the pending state): O(1)" 4
3187.IX Item "Activating one watcher (putting it into the pending state): O(1)"
2853.PD 0 3188.PD 0
2854.IP "Priority handling: O(number_of_priorities)" 4 3189.IP "Priority handling: O(number_of_priorities)" 4
2855.IX Item "Priority handling: O(number_of_priorities)" 3190.IX Item "Priority handling: O(number_of_priorities)"
2856.PD 3191.PD
2857Priorities are implemented by allocating some space for each 3192Priorities are implemented by allocating some space for each
2858priority. When doing priority-based operations, libev usually has to 3193priority. When doing priority-based operations, libev usually has to
2859linearly search all the priorities. 3194linearly search all the priorities, but starting/stopping and activating
2860.RE 3195watchers becomes O(1) w.r.t. priority handling.
2861.RS 4 3196.IP "Sending an ev_async: O(1)" 4
3197.IX Item "Sending an ev_async: O(1)"
3198.PD 0
3199.IP "Processing ev_async_send: O(number_of_async_watchers)" 4
3200.IX Item "Processing ev_async_send: O(number_of_async_watchers)"
3201.IP "Processing signals: O(max_signal_number)" 4
3202.IX Item "Processing signals: O(max_signal_number)"
3203.PD
3204Sending involves a syscall \fIiff\fR there were no other \f(CW\*(C`ev_async_send\*(C'\fR
3205calls in the current loop iteration. Checking for async and signal events
3206involves iterating over all running async watchers or all signal numbers.
3207.SH "Win32 platform limitations and workarounds"
3208.IX Header "Win32 platform limitations and workarounds"
3209Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
3210requires, and its I/O model is fundamentally incompatible with the \s-1POSIX\s0
3211model. Libev still offers limited functionality on this platform in
3212the form of the \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR backend, and only supports socket
3213descriptors. This only applies when using Win32 natively, not when using
3214e.g. cygwin.
3215.PP
3216There is no supported compilation method available on windows except
3217embedding it into other applications.
3218.PP
3219Due to the many, low, and arbitrary limits on the win32 platform and the
3220abysmal performance of winsockets, using a large number of sockets is not
3221recommended (and not reasonable). If your program needs to use more than
3222a hundred or so sockets, then likely it needs to use a totally different
3223implementation for windows, as libev offers the \s-1POSIX\s0 model, which cannot
3224be implemented efficiently on windows (microsoft monopoly games).
3225.IP "The winsocket select function" 4
3226.IX Item "The winsocket select function"
3227The winsocket \f(CW\*(C`select\*(C'\fR function doesn't follow \s-1POSIX\s0 in that it requires
3228socket \fIhandles\fR and not socket \fIfile descriptors\fR. This makes select
3229very inefficient, and also requires a mapping from file descriptors
3230to socket handles. See the discussion of the \f(CW\*(C`EV_SELECT_USE_FD_SET\*(C'\fR,
3231\&\f(CW\*(C`EV_SELECT_IS_WINSOCKET\*(C'\fR and \f(CW\*(C`EV_FD_TO_WIN32_HANDLE\*(C'\fR preprocessor
3232symbols for more info.
3233.Sp
3234The configuration for a \*(L"naked\*(R" win32 using the microsoft runtime
3235libraries and raw winsocket select is:
3236.Sp
3237.Vb 2
3238\& #define EV_USE_SELECT 1
3239\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3240.Ve
3241.Sp
3242Note that winsockets handling of fd sets is O(n), so you can easily get a
3243complexity in the O(nA\*^X) range when using win32.
3244.IP "Limited number of file descriptors" 4
3245.IX Item "Limited number of file descriptors"
3246Windows has numerous arbitrary (and low) limits on things. Early versions
3247of winsocket's select only supported waiting for a max. of \f(CW64\fR handles
3248(probably owning to the fact that all windows kernels can only wait for
3249\&\f(CW64\fR things at the same time internally; microsoft recommends spawning a
3250chain of threads and wait for 63 handles and the previous thread in each).
3251.Sp
3252Newer versions support more handles, but you need to define \f(CW\*(C`FD_SETSIZE\*(C'\fR
3253to some high number (e.g. \f(CW2048\fR) before compiling the winsocket select
3254call (which might be in libev or elsewhere, for example, perl does its own
3255select emulation on windows).
3256.Sp
3257Another limit is the number of file descriptors in the microsoft runtime
3258libraries, which by default is \f(CW64\fR (there must be a hidden \fI64\fR fetish
3259or something like this inside microsoft). You can increase this by calling
3260\&\f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR (another
3261arbitrary limit), but is broken in many versions of the microsoft runtime
3262libraries.
3263.Sp
3264This might get you to about \f(CW512\fR or \f(CW2048\fR sockets (depending on
3265windows version and/or the phase of the moon). To get more, you need to
3266wrap all I/O functions and provide your own fd management, but the cost of
3267calling select (O(nA\*^X)) will likely make this unworkable.
2862.SH "AUTHOR" 3268.SH "AUTHOR"
2863.IX Header "AUTHOR" 3269.IX Header "AUTHOR"
2864Marc Lehmann <libev@schmorp.de>. 3270Marc Lehmann <libev@schmorp.de>.
3271.SH "POD ERRORS"
3272.IX Header "POD ERRORS"
3273Hey! \fBThe above document had some coding errors, which are explained below:\fR
3274.IP "Around line 2996:" 4
3275.IX Item "Around line 2996:"
3276You forgot a '=back' before '=head2'

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines