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

Comparing libev/ev.3 (file contents):
Revision 1.63 by root, Wed Apr 2 15:23:11 2008 UTC vs.
Revision 1.72 by root, Tue Oct 21 20:06:52 2008 UTC

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