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

Comparing libev/ev.3 (file contents):
Revision 1.89 by root, Sat Mar 24 19:38:51 2012 UTC vs.
Revision 1.126 by root, Sat Jun 3 08:53:03 2023 UTC

1.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) 1.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
36.el\{\ 36.el\{\
37. ds -- \|\(em\| 37. ds -- \|\(em\|
38. ds PI \(*p 38. ds PI \(*p
39. ds L" `` 39. ds L" ``
40. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
41'br\} 43'br\}
42.\" 44.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
45.el .ds Aq ' 47.el .ds Aq '
46.\" 48.\"
47.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is >0, we'll generate index entries on stderr for
48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
51.ie \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
52. de IX 55.de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54.. 56..
55. nr % 0 57.nr rF 0
56. rr F 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{\
60. if \nF \{\
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
63..
64. if !\nF==2 \{\
65. nr % 0
66. nr F 2
67. \}
68. \}
57.\} 69.\}
58.el \{\ 70.rr rF
59. de IX
60..
61.\}
62.\" 71.\"
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
66.if n \{\ 75.if n \{\
122.\} 131.\}
123.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
124.\" ======================================================================== 133.\" ========================================================================
125.\" 134.\"
126.IX Title "LIBEV 3" 135.IX Title "LIBEV 3"
127.TH LIBEV 3 "2012-03-23" "libev-4.11" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2023-05-15" "libev-4.33" "libev - high performance full featured event loop"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
130.if n .ad l 139.if n .ad l
131.nh 140.nh
132.SH "NAME" 141.SH "NAME"
134.SH "SYNOPSIS" 143.SH "SYNOPSIS"
135.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
136.Vb 1 145.Vb 1
137\& #include <ev.h> 146\& #include <ev.h>
138.Ve 147.Ve
139.SS "\s-1EXAMPLE\s0 \s-1PROGRAM\s0" 148.SS "\s-1EXAMPLE PROGRAM\s0"
140.IX Subsection "EXAMPLE PROGRAM" 149.IX Subsection "EXAMPLE PROGRAM"
141.Vb 2 150.Vb 2
142\& // a single header file is required 151\& // a single header file is required
143\& #include <ev.h> 152\& #include <ev.h>
144\& 153\&
212throughout this document. 221throughout this document.
213.SH "WHAT TO READ WHEN IN A HURRY" 222.SH "WHAT TO READ WHEN IN A HURRY"
214.IX Header "WHAT TO READ WHEN IN A HURRY" 223.IX Header "WHAT TO READ WHEN IN A HURRY"
215This manual tries to be very detailed, but unfortunately, this also makes 224This manual tries to be very detailed, but unfortunately, this also makes
216it very long. If you just want to know the basics of libev, I suggest 225it very long. If you just want to know the basics of libev, I suggest
217reading \*(L"\s-1ANATOMY\s0 \s-1OF\s0 A \s-1WATCHER\s0\*(R", then the \*(L"\s-1EXAMPLE\s0 \s-1PROGRAM\s0\*(R" above and 226reading \*(L"\s-1ANATOMY OF A WATCHER\*(R"\s0, then the \*(L"\s-1EXAMPLE PROGRAM\*(R"\s0 above and
218look up the missing functions in \*(L"\s-1GLOBAL\s0 \s-1FUNCTIONS\s0\*(R" and the \f(CW\*(C`ev_io\*(C'\fR and 227look up the missing functions in \*(L"\s-1GLOBAL FUNCTIONS\*(R"\s0 and the \f(CW\*(C`ev_io\*(C'\fR and
219\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER\s0 \s-1TYPES\s0\*(R". 228\&\f(CW\*(C`ev_timer\*(C'\fR sections in \*(L"\s-1WATCHER TYPES\*(R"\s0.
220.SH "ABOUT LIBEV" 229.SH "ABOUT LIBEV"
221.IX Header "ABOUT LIBEV" 230.IX Header "ABOUT LIBEV"
222Libev is an event loop: you register interest in certain events (such as a 231Libev is an event loop: you register interest in certain events (such as a
223file descriptor being readable or a timeout occurring), and it will manage 232file descriptor being readable or a timeout occurring), and it will manage
224these event sources and provide your program with events. 233these event sources and provide your program with events.
231watchers\fR, which are relatively small C structures you initialise with the 240watchers\fR, which are relatively small C structures you initialise with the
232details of the event, and then hand it over to libev by \fIstarting\fR the 241details of the event, and then hand it over to libev by \fIstarting\fR the
233watcher. 242watcher.
234.SS "\s-1FEATURES\s0" 243.SS "\s-1FEATURES\s0"
235.IX Subsection "FEATURES" 244.IX Subsection "FEATURES"
236Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific \f(CW\*(C`epoll\*(C'\fR, the 245Libev supports \f(CW\*(C`select\*(C'\fR, \f(CW\*(C`poll\*(C'\fR, the Linux-specific aio and \f(CW\*(C`epoll\*(C'\fR
237BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port mechanisms 246interfaces, the BSD-specific \f(CW\*(C`kqueue\*(C'\fR and the Solaris-specific event port
238for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR interface 247mechanisms for file descriptor events (\f(CW\*(C`ev_io\*(C'\fR), the Linux \f(CW\*(C`inotify\*(C'\fR
239(for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner 248interface (for \f(CW\*(C`ev_stat\*(C'\fR), Linux eventfd/signalfd (for faster and cleaner
240inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative 249inter-thread wakeup (\f(CW\*(C`ev_async\*(C'\fR)/signal handling (\f(CW\*(C`ev_signal\*(C'\fR)) relative
241timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling 250timers (\f(CW\*(C`ev_timer\*(C'\fR), absolute timers with customised rescheduling
242(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status 251(\f(CW\*(C`ev_periodic\*(C'\fR), synchronous signals (\f(CW\*(C`ev_signal\*(C'\fR), process status
243change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event 252change events (\f(CW\*(C`ev_child\*(C'\fR), and event watchers dealing with the event
244loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and 253loop mechanism itself (\f(CW\*(C`ev_idle\*(C'\fR, \f(CW\*(C`ev_embed\*(C'\fR, \f(CW\*(C`ev_prepare\*(C'\fR and
255more info about various configuration options please have a look at 264more info about various configuration options please have a look at
256\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support 265\&\fB\s-1EMBED\s0\fR section in this manual. If libev was configured without support
257for multiple event loops, then all functions taking an initial argument of 266for multiple event loops, then all functions taking an initial argument of
258name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have 267name \f(CW\*(C`loop\*(C'\fR (which is always of type \f(CW\*(C`struct ev_loop *\*(C'\fR) will not have
259this argument. 268this argument.
260.SS "\s-1TIME\s0 \s-1REPRESENTATION\s0" 269.SS "\s-1TIME REPRESENTATION\s0"
261.IX Subsection "TIME REPRESENTATION" 270.IX Subsection "TIME REPRESENTATION"
262Libev represents time as a single floating point number, representing 271Libev represents time as a single floating point number, representing
263the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice 272the (fractional) number of seconds since the (\s-1POSIX\s0) epoch (in practice
264somewhere near the beginning of 1970, details are complicated, don't 273somewhere near the beginning of 1970, details are complicated, don't
265ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use 274ask). This type is called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use
282When libev detects a usage error such as a negative timer interval, then 291When libev detects a usage error such as a negative timer interval, then
283it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism, 292it will print a diagnostic message and abort (via the \f(CW\*(C`assert\*(C'\fR mechanism,
284so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in 293so \f(CW\*(C`NDEBUG\*(C'\fR will disable this checking): these are programming errors in
285the libev caller and need to be fixed there. 294the libev caller and need to be fixed there.
286.PP 295.PP
296Via the \f(CW\*(C`EV_FREQUENT\*(C'\fR macro you can compile in and/or enable extensive
297consistency checking code inside libev that can be used to check for
298internal inconsistencies, suually caused by application bugs.
299.PP
287Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions, and also has 300Libev also has a few internal error-checking \f(CW\*(C`assert\*(C'\fRions. These do not
288extensive consistency checking code. These do not trigger under normal
289circumstances, as they indicate either a bug in libev or worse. 301trigger under normal circumstances, as they indicate either a bug in libev
302or worse.
290.SH "GLOBAL FUNCTIONS" 303.SH "GLOBAL FUNCTIONS"
291.IX Header "GLOBAL FUNCTIONS" 304.IX Header "GLOBAL FUNCTIONS"
292These functions can be called anytime, even before initialising the 305These functions can be called anytime, even before initialising the
293library in any way. 306library in any way.
294.IP "ev_tstamp ev_time ()" 4 307.IP "ev_tstamp ev_time ()" 4
367current system. To find which embeddable backends might be supported on 380current system. To find which embeddable backends might be supported on
368the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends () 381the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
369& ev_supported_backends ()\*(C'\fR, likewise for recommended ones. 382& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
370.Sp 383.Sp
371See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 384See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
372.IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4 385.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
373.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 386.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
374Sets the allocation function to use (the prototype is similar \- the 387Sets the allocation function to use (the prototype is similar \- the
375semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is 388semantics are identical to the \f(CW\*(C`realloc\*(C'\fR C89/SuS/POSIX function). It is
376used to allocate and free memory (no surprises here). If it returns zero 389used to allocate and free memory (no surprises here). If it returns zero
377when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort 390when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
378or take some potentially destructive action. 391or take some potentially destructive action.
383.Sp 396.Sp
384You could override this function in high-availability programs to, say, 397You could override this function in high-availability programs to, say,
385free some memory if it cannot allocate memory, to use a special allocator, 398free some memory if it cannot allocate memory, to use a special allocator,
386or even to sleep a while and retry until some memory is available. 399or even to sleep a while and retry until some memory is available.
387.Sp 400.Sp
401Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses
402which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and
403is probably a good basis for your own implementation.
404.Sp
405.Vb 5
406\& static void *
407\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
408\& {
409\& if (size)
410\& return realloc (ptr, size);
411\&
412\& free (ptr);
413\& return 0;
414\& }
415.Ve
416.Sp
388Example: Replace the libev allocator with one that waits a bit and then 417Example: Replace the libev allocator with one that waits a bit and then
389retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). 418retries.
390.Sp 419.Sp
391.Vb 6 420.Vb 8
392\& static void * 421\& static void *
393\& persistent_realloc (void *ptr, size_t size) 422\& persistent_realloc (void *ptr, size_t size)
394\& { 423\& {
424\& if (!size)
425\& {
426\& free (ptr);
427\& return 0;
428\& }
429\&
395\& for (;;) 430\& for (;;)
396\& { 431\& {
397\& void *newptr = realloc (ptr, size); 432\& void *newptr = realloc (ptr, size);
398\& 433\&
399\& if (newptr) 434\& if (newptr)
404\& } 439\& }
405\& 440\&
406\& ... 441\& ...
407\& ev_set_allocator (persistent_realloc); 442\& ev_set_allocator (persistent_realloc);
408.Ve 443.Ve
409.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4 444.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
410.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))" 445.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())"
411Set the callback function to call on a retryable system call error (such 446Set the callback function to call on a retryable system call error (such
412as failed select, poll, epoll_wait). The message is a printable string 447as failed select, poll, epoll_wait). The message is a printable string
413indicating the system call or subsystem causing the problem. If this 448indicating the system call or subsystem causing the problem. If this
414callback is set, then libev will expect it to remedy the situation, no 449callback is set, then libev will expect it to remedy the situation, no
415matter what, when it returns. That is, libev will generally retry the 450matter what, when it returns. That is, libev will generally retry the
514.IX Item "EVFLAG_NOENV" 549.IX Item "EVFLAG_NOENV"
515If this flag bit is or'ed into the flag value (or the program runs setuid 550If this flag bit is or'ed into the flag value (or the program runs setuid
516or setgid) then libev will \fInot\fR look at the environment variable 551or setgid) then libev will \fInot\fR look at the environment variable
517\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will 552\&\f(CW\*(C`LIBEV_FLAGS\*(C'\fR. Otherwise (the default), this environment variable will
518override the flags completely if it is found in the environment. This is 553override the flags completely if it is found in the environment. This is
519useful to try out specific backends to test their performance, or to work 554useful to try out specific backends to test their performance, to work
520around bugs. 555around bugs, or to make libev threadsafe (accessing environment variables
556cannot be done in a threadsafe way, but usually it works if no other
557thread modifies them).
521.ie n .IP """EVFLAG_FORKCHECK""" 4 558.ie n .IP """EVFLAG_FORKCHECK""" 4
522.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 559.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
523.IX Item "EVFLAG_FORKCHECK" 560.IX Item "EVFLAG_FORKCHECK"
524Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also 561Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also
525make libev check for a fork in each iteration by enabling this flag. 562make libev check for a fork in each iteration by enabling this flag.
526.Sp 563.Sp
527This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 564This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop,
528and thus this might slow down your event loop if you do a lot of loop 565and thus this might slow down your event loop if you do a lot of loop
529iterations and little real work, but is usually not noticeable (on my 566iterations and little real work, but is usually not noticeable (on my
530GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn sequence 567GNU/Linux system for example, \f(CW\*(C`getpid\*(C'\fR is actually a simple 5\-insn
531without a system call and thus \fIvery\fR fast, but my GNU/Linux system also has 568sequence without a system call and thus \fIvery\fR fast, but my GNU/Linux
532\&\f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). 569system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
570versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
533.Sp 571.Sp
534The big advantage of this flag is that you can forget about fork (and 572The big advantage of this flag is that you can forget about fork (and
535forget about forgetting to tell libev about forking) when you use this 573forget about forgetting to tell libev about forking, although you still
536flag. 574have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
537.Sp 575.Sp
538This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 576This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
539environment variable. 577environment variable.
540.ie n .IP """EVFLAG_NOINOTIFY""" 4 578.ie n .IP """EVFLAG_NOINOTIFY""" 4
541.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 579.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
568want to handle signals only in specific threads and want to avoid libev 606want to handle signals only in specific threads and want to avoid libev
569unblocking the signals. 607unblocking the signals.
570.Sp 608.Sp
571It's also required by \s-1POSIX\s0 in a threaded program, as libev calls 609It's also required by \s-1POSIX\s0 in a threaded program, as libev calls
572\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified. 610\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
611.ie n .IP """EVFLAG_NOTIMERFD""" 4
612.el .IP "\f(CWEVFLAG_NOTIMERFD\fR" 4
613.IX Item "EVFLAG_NOTIMERFD"
614When this flag is specified, the libev will avoid using a \f(CW\*(C`timerfd\*(C'\fR to
615detect time jumps. It will still be able to detect time jumps, but takes
616longer and has a lower accuracy in doing so, but saves a file descriptor
617per loop.
573.Sp 618.Sp
574This flag's behaviour will become the default in future versions of libev. 619The current implementation only tries to use a \f(CW\*(C`timerfd\*(C'\fR when the first
620\&\f(CW\*(C`ev_periodic\*(C'\fR watcher is started and falls back on other methods if it
621cannot be created, but this behaviour might change in the future.
575.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 622.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
576.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 623.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
577.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 624.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
578This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 625This is your standard \fBselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
579libev tries to roll its own fd_set with no limits on the number of fds, 626libev tries to roll its own fd_set with no limits on the number of fds,
580but if that fails, expect a fairly low limit on the number of fds when 627but if that fails, expect a fairly low limit on the number of fds when
581using this backend. It doesn't scale too well (O(highest_fd)), but its 628using this backend. It doesn't scale too well (O(highest_fd)), but its
582usually the fastest backend for a low number of (low-numbered :) fds. 629usually the fastest backend for a low number of (low-numbered :) fds.
583.Sp 630.Sp
591This 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 638This 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
592\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the 639\&\f(CW\*(C`writefds\*(C'\fR set (and to work around Microsoft Windows bugs, also onto the
593\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform). 640\&\f(CW\*(C`exceptfds\*(C'\fR set on that platform).
594.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4 641.ie n .IP """EVBACKEND_POLL"" (value 2, poll backend, available everywhere except on windows)" 4
595.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4 642.el .IP "\f(CWEVBACKEND_POLL\fR (value 2, poll backend, available everywhere except on windows)" 4
596.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)" 643.IX Item "EVBACKEND_POLL (value 2, poll backend, available everywhere except on windows)"
597And this is your standard \fIpoll\fR\|(2) backend. It's more complicated 644And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
598than select, but handles sparse fds better and has no artificial 645than select, but handles sparse fds better and has no artificial
599limit on the number of fds you can use (except it will slow down 646limit on the number of fds you can use (except it will slow down
600considerably with a lot of inactive fds). It scales similarly to select, 647considerably with a lot of inactive fds). It scales similarly to select,
601i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for 648i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
602performance tips. 649performance tips.
603.Sp 650.Sp
604This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 651This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and
605\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR. 652\&\f(CW\*(C`EV_WRITE\*(C'\fR to \f(CW\*(C`POLLOUT | POLLERR | POLLHUP\*(C'\fR.
606.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 653.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
607.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 654.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
608.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 655.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
609Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 656Use the Linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
610kernels). 657kernels).
611.Sp 658.Sp
612For few fds, this backend is a bit little slower than poll and select, but 659For few fds, this backend is a bit little slower than poll and select, but
613it scales phenomenally better. While poll and select usually scale like 660it scales phenomenally better. While poll and select usually scale like
614O(total_fds) where total_fds is the total number of fds (or the highest 661O(total_fds) where total_fds is the total number of fds (or the highest
660All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or 707All this means that, in practice, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR can be as fast or
661faster than epoll for maybe up to a hundred file descriptors, depending on 708faster than epoll for maybe up to a hundred file descriptors, depending on
662the usage. So sad. 709the usage. So sad.
663.Sp 710.Sp
664While nominally embeddable in other event loops, this feature is broken in 711While nominally embeddable in other event loops, this feature is broken in
665all kernel versions tested so far. 712a lot of kernel revisions, but probably(!) works in current versions.
713.Sp
714This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
715\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
716.ie n .IP """EVBACKEND_LINUXAIO"" (value 64, Linux)" 4
717.el .IP "\f(CWEVBACKEND_LINUXAIO\fR (value 64, Linux)" 4
718.IX Item "EVBACKEND_LINUXAIO (value 64, Linux)"
719Use the Linux-specific Linux \s-1AIO\s0 (\fInot\fR \f(CWaio(7)\fR but \f(CWio_submit(2)\fR) event interface available in post\-4.18 kernels (but libev
720only tries to use it in 4.19+).
721.Sp
722This is another Linux train wreck of an event interface.
723.Sp
724If this backend works for you (as of this writing, it was very
725experimental), it is the best event interface available on Linux and might
726be well worth enabling it \- if it isn't available in your kernel this will
727be detected and this backend will be skipped.
728.Sp
729This backend can batch oneshot requests and supports a user-space ring
730buffer to receive events. It also doesn't suffer from most of the design
731problems of epoll (such as not being able to remove event sources from
732the epoll set), and generally sounds too good to be true. Because, this
733being the Linux kernel, of course it suffers from a whole new set of
734limitations, forcing you to fall back to epoll, inheriting all its design
735issues.
736.Sp
737For one, it is not easily embeddable (but probably could be done using
738an event fd at some extra overhead). It also is subject to a system wide
739limit that can be configured in \fI/proc/sys/fs/aio\-max\-nr\fR. If no \s-1AIO\s0
740requests are left, this backend will be skipped during initialisation, and
741will switch to epoll when the loop is active.
742.Sp
743Most problematic in practice, however, is that not all file descriptors
744work with it. For example, in Linux 5.1, \s-1TCP\s0 sockets, pipes, event fds,
745files, \fI/dev/null\fR and many others are supported, but ttys do not work
746properly (a known bug that the kernel developers don't care about, see
747<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
748(yet?) a generic event polling interface.
749.Sp
750Overall, it seems the Linux developers just don't want it to have a
751generic event handling mechanism other than \f(CW\*(C`select\*(C'\fR or \f(CW\*(C`poll\*(C'\fR.
752.Sp
753To work around all these problem, the current version of libev uses its
754epoll backend as a fallback for file descriptor types that do not work. Or
755falls back completely to epoll if the kernel acts up.
666.Sp 756.Sp
667This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 757This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as
668\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 758\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
669.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 759.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4
670.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 760.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
671.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 761.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
672Kqueue deserves special mention, as at the time of this writing, it 762Kqueue deserves special mention, as at the time this backend was
673was broken on all BSDs except NetBSD (usually it doesn't work reliably 763implemented, it was broken on all BSDs except NetBSD (usually it doesn't
674with anything but sockets and pipes, except on Darwin, where of course 764work reliably with anything but sockets and pipes, except on Darwin,
675it's completely useless). Unlike epoll, however, whose brokenness 765where of course it's completely useless). Unlike epoll, however, whose
676is by design, these kqueue bugs can (and eventually will) be fixed 766brokenness is by design, these kqueue bugs can be (and mostly have been)
677without \s-1API\s0 changes to existing programs. For this reason it's not being 767fixed without \s-1API\s0 changes to existing programs. For this reason it's not
678\&\*(L"auto-detected\*(R" unless you explicitly specify it in the flags (i.e. using 768being \*(L"auto-detected\*(R" on all platforms unless you explicitly specify it
679\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) 769in the flags (i.e. using \f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a
680system like NetBSD. 770known-to-be-good (\-enough) system like NetBSD.
681.Sp 771.Sp
682You still can embed kqueue into a normal poll or select backend and use it 772You still can embed kqueue into a normal poll or select backend and use it
683only for sockets (after having made sure that sockets work with kqueue on 773only for sockets (after having made sure that sockets work with kqueue on
684the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 774the target platform). See \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.
685.Sp 775.Sp
686It scales in the same way as the epoll backend, but the interface to the 776It scales in the same way as the epoll backend, but the interface to the
687kernel is more efficient (which says nothing about its actual speed, of 777kernel is more efficient (which says nothing about its actual speed, of
688course). While stopping, setting and starting an I/O watcher does never 778course). While stopping, setting and starting an I/O watcher does never
689cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to 779cause an extra system call as with \f(CW\*(C`EVBACKEND_EPOLL\*(C'\fR, it still adds up to
690two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (but 780two event changes per incident. Support for \f(CW\*(C`fork ()\*(C'\fR is very bad (you
691sane, unlike epoll) and it drops fds silently in similarly hard-to-detect 781might have to leak fds on fork, but it's more sane than epoll) and it
692cases 782drops fds silently in similarly hard-to-detect cases.
693.Sp 783.Sp
694This backend usually performs well under most conditions. 784This backend usually performs well under most conditions.
695.Sp 785.Sp
696While nominally embeddable in other event loops, this doesn't work 786While nominally embeddable in other event loops, this doesn't work
697everywhere, so you might need to test for this. And since it is broken 787everywhere, so you might need to test for this. And since it is broken
698almost everywhere, you should only use it when you have a lot of sockets 788almost everywhere, you should only use it when you have a lot of sockets
699(for which it usually works), by embedding it into another event loop 789(for which it usually works), by embedding it into another event loop
700(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course 790(e.g. \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR (but \f(CW\*(C`poll\*(C'\fR is of course
701also broken on \s-1OS\s0 X)) and, did I mention it, using it only for sockets. 791also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
702.Sp 792.Sp
703This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 793This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with
704\&\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 794\&\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
705\&\f(CW\*(C`NOTE_EOF\*(C'\fR. 795\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
706.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 796.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
710implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 800implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets
711and is not embeddable, which would limit the usefulness of this backend 801and is not embeddable, which would limit the usefulness of this backend
712immensely. 802immensely.
713.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 803.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
714.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 804.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
715.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 805.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
716This uses the Solaris 10 event port mechanism. As with everything on Solaris, 806This uses the Solaris 10 event port mechanism. As with everything on
717it's really slow, but it still scales very well (O(active_fds)). 807Solaris, it's really slow, but it still scales very well (O(active_fds)).
718.Sp 808.Sp
719While this backend scales well, it requires one system call per active 809While this backend scales well, it requires one system call per active
720file descriptor per loop iteration. For small and medium numbers of file 810file descriptor per loop iteration. For small and medium numbers of file
721descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend 811descriptors a \*(L"slow\*(R" \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR backend
722might perform better. 812might perform better.
774used if available. 864used if available.
775.Sp 865.Sp
776.Vb 1 866.Vb 1
777\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 867\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
778.Ve 868.Ve
869.Sp
870Example: Similarly, on linux, you mgiht want to take advantage of the
871linux aio backend if possible, but fall back to something else if that
872isn't available.
873.Sp
874.Vb 1
875\& struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
876.Ve
779.RE 877.RE
780.IP "ev_loop_destroy (loop)" 4 878.IP "ev_loop_destroy (loop)" 4
781.IX Item "ev_loop_destroy (loop)" 879.IX Item "ev_loop_destroy (loop)"
782Destroys an event loop object (frees all memory and kernel state 880Destroys an event loop object (frees all memory and kernel state
783etc.). None of the active event watchers will be stopped in the normal 881etc.). None of the active event watchers will be stopped in the normal
799except in the rare occasion where you really need to free its resources. 897except in the rare occasion where you really need to free its resources.
800If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR 898If you need dynamically allocated loops it is better to use \f(CW\*(C`ev_loop_new\*(C'\fR
801and \f(CW\*(C`ev_loop_destroy\*(C'\fR. 899and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
802.IP "ev_loop_fork (loop)" 4 900.IP "ev_loop_fork (loop)" 4
803.IX Item "ev_loop_fork (loop)" 901.IX Item "ev_loop_fork (loop)"
804This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to 902This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations
805reinitialise the kernel state for backends that have one. Despite the 903to reinitialise the kernel state for backends that have one. Despite
806name, you can call it anytime, but it makes most sense after forking, in 904the name, you can call it anytime you are allowed to start or stop
807the child process. You \fImust\fR call it (or use \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the 905watchers (except inside an \f(CW\*(C`ev_prepare\*(C'\fR callback), but it makes most
808child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR. 906sense after forking, in the child process. You \fImust\fR call it (or use
907\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
809.Sp 908.Sp
909In addition, if you want to reuse a loop (via this function or
910\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
911.Sp
810Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after 912Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after
811a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is 913a fork, \fIeven if you do not plan to use the loop in the parent\fR. This is
812because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things 914because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
813during fork. 915during fork.
814.Sp 916.Sp
815On the other hand, you only need to call this function in the child 917On the other hand, you only need to call this function in the child
909given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR 1011given loop other than \f(CW\*(C`ev_resume\*(C'\fR, and you \fBmust not\fR call \f(CW\*(C`ev_resume\*(C'\fR
910without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR. 1012without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
911.Sp 1013.Sp
912Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the 1014Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the
913event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR). 1015event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
914.IP "ev_run (loop, int flags)" 4 1016.IP "bool ev_run (loop, int flags)" 4
915.IX Item "ev_run (loop, int flags)" 1017.IX Item "bool ev_run (loop, int flags)"
916Finally, this is it, the event handler. This function usually is called 1018Finally, this is it, the event handler. This function usually is called
917after you have initialised all your watchers and you want to start 1019after you have initialised all your watchers and you want to start
918handling events. It will ask the operating system for any new events, call 1020handling events. It will ask the operating system for any new events, call
919the watcher callbacks, an then repeat the whole process indefinitely: This 1021the watcher callbacks, and then repeat the whole process indefinitely: This
920is why event loops are called \fIloops\fR. 1022is why event loops are called \fIloops\fR.
921.Sp 1023.Sp
922If the flags argument is specified as \f(CW0\fR, it will keep handling events 1024If the flags argument is specified as \f(CW0\fR, it will keep handling events
923until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was 1025until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
924called. 1026called.
1027.Sp
1028The return value is false if there are no more active watchers (which
1029usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
1030(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
925.Sp 1031.Sp
926Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than 1032Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than
927relying on all watchers to be stopped when deciding when a program has 1033relying on all watchers to be stopped when deciding when a program has
928finished (especially in interactive programs), but having a program 1034finished (especially in interactive programs), but having a program
929that automatically loops as long as it has to and no longer by virtue 1035that automatically loops as long as it has to and no longer by virtue
930of relying on its watchers stopping correctly, that is truly a thing of 1036of relying on its watchers stopping correctly, that is truly a thing of
931beauty. 1037beauty.
932.Sp 1038.Sp
933This function is also \fImostly\fR exception-safe \- you can break out of 1039This function is \fImostly\fR exception-safe \- you can break out of a
934a \f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+ 1040\&\f(CW\*(C`ev_run\*(C'\fR call by calling \f(CW\*(C`longjmp\*(C'\fR in a callback, throwing a \*(C+
935exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor 1041exception and so on. This does not decrement the \f(CW\*(C`ev_depth\*(C'\fR value, nor
936will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks. 1042will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
937.Sp 1043.Sp
938A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle 1044A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle
939those events and any already outstanding ones, but will not wait and 1045those events and any already outstanding ones, but will not wait and
981\& \- Queue all expired timers. 1087\& \- Queue all expired timers.
982\& \- Queue all expired periodics. 1088\& \- Queue all expired periodics.
983\& \- Queue all idle watchers with priority higher than that of pending events. 1089\& \- Queue all idle watchers with priority higher than that of pending events.
984\& \- Queue all check watchers. 1090\& \- Queue all check watchers.
985\& \- Call all queued watchers in reverse order (i.e. check watchers first). 1091\& \- Call all queued watchers in reverse order (i.e. check watchers first).
986\& Signals and child watchers are implemented as I/O watchers, and will 1092\& Signals, async and child watchers are implemented as I/O watchers, and
987\& be handled here by queueing them when their watcher gets executed. 1093\& will be handled here by queueing them when their watcher gets executed.
988\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT 1094\& \- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
989\& were used, or there are no active watchers, goto FINISH, otherwise 1095\& were used, or there are no active watchers, goto FINISH, otherwise
990\& continue with step LOOP. 1096\& continue with step LOOP.
991\& FINISH: 1097\& FINISH:
992\& \- Reset the ev_break status iff it was EVBREAK_ONE. 1098\& \- Reset the ev_break status iff it was EVBREAK_ONE.
1136this callback instead. This is useful, for example, when you want to 1242this callback instead. This is useful, for example, when you want to
1137invoke the actual watchers inside another context (another thread etc.). 1243invoke the actual watchers inside another context (another thread etc.).
1138.Sp 1244.Sp
1139If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new 1245If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1140callback. 1246callback.
1141.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 1247.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0) throw (), void (*acquire)(\s-1EV_P\s0) throw ())" 4
1142.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))" 1248.IX Item "ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())"
1143Sometimes you want to share the same loop between multiple threads. This 1249Sometimes you want to share the same loop between multiple threads. This
1144can be done relatively simply by putting mutex_lock/unlock calls around 1250can be done relatively simply by putting mutex_lock/unlock calls around
1145each call to a libev function. 1251each call to a libev function.
1146.Sp 1252.Sp
1147However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible 1253However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1243with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher 1349with a watcher-specific start function (\f(CW\*(C`ev_TYPE_start (loop, watcher
1244*)\*(C'\fR), and you can stop watching for events at any time by calling the 1350*)\*(C'\fR), and you can stop watching for events at any time by calling the
1245corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR. 1351corresponding stop function (\f(CW\*(C`ev_TYPE_stop (loop, watcher *)\*(C'\fR.
1246.PP 1352.PP
1247As long as your watcher is active (has been started but not stopped) you 1353As long as your watcher is active (has been started but not stopped) you
1248must not touch the values stored in it. Most specifically you must never 1354must not touch the values stored in it except when explicitly documented
1249reinitialise it or call its \f(CW\*(C`ev_TYPE_set\*(C'\fR macro. 1355otherwise. Most specifically you must never reinitialise it or call its
1356\&\f(CW\*(C`ev_TYPE_set\*(C'\fR macro.
1250.PP 1357.PP
1251Each and every callback receives the event loop pointer as first, the 1358Each and every callback receives the event loop pointer as first, the
1252registered watcher structure as second, and a bitset of received events as 1359registered watcher structure as second, and a bitset of received events as
1253third argument. 1360third argument.
1254.PP 1361.PP
1295.PD 0 1402.PD 0
1296.ie n .IP """EV_CHECK""" 4 1403.ie n .IP """EV_CHECK""" 4
1297.el .IP "\f(CWEV_CHECK\fR" 4 1404.el .IP "\f(CWEV_CHECK\fR" 4
1298.IX Item "EV_CHECK" 1405.IX Item "EV_CHECK"
1299.PD 1406.PD
1300All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts 1407All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts to
1301to gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are invoked just after 1408gather new events, and all \f(CW\*(C`ev_check\*(C'\fR watchers are queued (not invoked)
1302\&\f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it invokes any callbacks for any 1409just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1410for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1411watchers invoked before the event loop sleeps or polls for new events, and
1412\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1413or lower priority within an event loop iteration.
1414.Sp
1303received events. Callbacks of both watcher types can start and stop as 1415Callbacks of both watcher types can start and stop as many watchers as
1304many watchers as they want, and all of them will be taken into account 1416they want, and all of them will be taken into account (for example, a
1305(for example, a \f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep 1417\&\f(CW\*(C`ev_prepare\*(C'\fR watcher might start an idle watcher to keep \f(CW\*(C`ev_run\*(C'\fR from
1306\&\f(CW\*(C`ev_run\*(C'\fR from blocking). 1418blocking).
1307.ie n .IP """EV_EMBED""" 4 1419.ie n .IP """EV_EMBED""" 4
1308.el .IP "\f(CWEV_EMBED\fR" 4 1420.el .IP "\f(CWEV_EMBED\fR" 4
1309.IX Item "EV_EMBED" 1421.IX Item "EV_EMBED"
1310The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1422The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1311.ie n .IP """EV_FORK""" 4 1423.ie n .IP """EV_FORK""" 4
1340bug in your program. 1452bug in your program.
1341.Sp 1453.Sp
1342Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1454Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for
1343example it might indicate that a fd is readable or writable, and if your 1455example it might indicate that a fd is readable or writable, and if your
1344callbacks is well-written it can just attempt the operation and cope with 1456callbacks is well-written it can just attempt the operation and cope with
1345the error from \fIread()\fR or \fIwrite()\fR. This will not work in multi-threaded 1457the error from \fBread()\fR or \fBwrite()\fR. This will not work in multi-threaded
1346programs, though, as the fd could already be closed and reused for another 1458programs, though, as the fd could already be closed and reused for another
1347thing, so beware. 1459thing, so beware.
1348.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1460.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1349.IX Subsection "GENERIC WATCHER FUNCTIONS" 1461.IX Subsection "GENERIC WATCHER FUNCTIONS"
1350.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1462.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1351.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1463.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1352.IX Item "ev_init (ev_TYPE *watcher, callback)" 1464.IX Item "ev_init (ev_TYPE *watcher, callback)"
1353This macro initialises the generic portion of a watcher. The contents 1465This macro initialises the generic portion of a watcher. The contents
1420therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function. 1532therefore a good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
1421.IP "bool ev_is_active (ev_TYPE *watcher)" 4 1533.IP "bool ev_is_active (ev_TYPE *watcher)" 4
1422.IX Item "bool ev_is_active (ev_TYPE *watcher)" 1534.IX Item "bool ev_is_active (ev_TYPE *watcher)"
1423Returns a true value iff the watcher is active (i.e. it has been started 1535Returns a true value iff the watcher is active (i.e. it has been started
1424and not yet been stopped). As long as a watcher is active you must not modify 1536and not yet been stopped). As long as a watcher is active you must not modify
1425it. 1537it unless documented otherwise.
1538.Sp
1539Obviously, it is safe to call this on an active watcher, or actually any
1540watcher that is initialised.
1426.IP "bool ev_is_pending (ev_TYPE *watcher)" 4 1541.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
1427.IX Item "bool ev_is_pending (ev_TYPE *watcher)" 1542.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
1428Returns a true value iff the watcher is pending, (i.e. it has outstanding 1543Returns a true value iff the watcher is pending, (i.e. it has outstanding
1429events but its callback has not yet been invoked). As long as a watcher 1544events but its callback has not yet been invoked). As long as a watcher
1430is pending (but not active) you must not call an init function on it (but 1545is pending (but not active) you must not call an init function on it (but
1431\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must 1546\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe), you must not change its priority, and you must
1432make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1547make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1433it). 1548it).
1549.Sp
1550It is safe to call this on any watcher in any state as long as it is
1551initialised.
1434.IP "callback ev_cb (ev_TYPE *watcher)" 4 1552.IP "callback ev_cb (ev_TYPE *watcher)" 4
1435.IX Item "callback ev_cb (ev_TYPE *watcher)" 1553.IX Item "callback ev_cb (ev_TYPE *watcher)"
1436Returns the callback currently set on the watcher. 1554Returns the callback currently set on the watcher.
1437.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1555.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1438.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1556.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1439Change the callback. You can change the callback at virtually any time 1557Change the callback. You can change the callback at virtually any time
1440(modulo threads). 1558(modulo threads).
1441.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 1559.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1442.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" 1560.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1443.PD 0 1561.PD 0
1451from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers). 1569from being executed (except for \f(CW\*(C`ev_idle\*(C'\fR watchers).
1452.Sp 1570.Sp
1453If you need to suppress invocation when higher priority events are pending 1571If you need to suppress invocation when higher priority events are pending
1454you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality. 1572you need to look at \f(CW\*(C`ev_idle\*(C'\fR watchers, which provide this functionality.
1455.Sp 1573.Sp
1456You \fImust not\fR change the priority of a watcher as long as it is active or 1574You \fImust not\fR change the priority of a watcher as long as it is active
1457pending. 1575or pending. Reading the priority with \f(CW\*(C`ev_priority\*(C'\fR is fine in any state.
1458.Sp 1576.Sp
1459Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is 1577Setting a priority outside the range of \f(CW\*(C`EV_MINPRI\*(C'\fR to \f(CW\*(C`EV_MAXPRI\*(C'\fR is
1460fine, as long as you do not mind that the priority value you query might 1578fine, as long as you do not mind that the priority value you query might
1461or might not have been clamped to the valid range. 1579or might not have been clamped to the valid range.
1462.Sp 1580.Sp
1463The default priority used by watchers when no priority has been set is 1581The default priority used by watchers when no priority has been set is
1464always \f(CW0\fR, which is supposed to not be too high and not be too low :). 1582always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1465.Sp 1583.Sp
1466See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1584See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1467priorities. 1585priorities.
1468.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1586.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1469.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1587.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)"
1470Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither 1588Invoke the \f(CW\*(C`watcher\*(C'\fR with the given \f(CW\*(C`loop\*(C'\fR and \f(CW\*(C`revents\*(C'\fR. Neither
1471\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback 1589\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1481callback to be invoked, which can be accomplished with this function. 1599callback to be invoked, which can be accomplished with this function.
1482.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4 1600.IP "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 4
1483.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)" 1601.IX Item "ev_feed_event (loop, ev_TYPE *watcher, int revents)"
1484Feeds the given event set into the event loop, as if the specified event 1602Feeds the given event set into the event loop, as if the specified event
1485had happened for the specified watcher (which must be a pointer to an 1603had happened for the specified watcher (which must be a pointer to an
1486initialised but not necessarily started event watcher). Obviously you must 1604initialised but not necessarily started event watcher, though it can be
1487not free the watcher as long as it has pending events. 1605active). Obviously you must not free the watcher as long as it has pending
1606events.
1488.Sp 1607.Sp
1489Stopping the watcher, letting libev invoke it, or calling 1608Stopping the watcher, letting libev invoke it, or calling
1490\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was 1609\&\f(CW\*(C`ev_clear_pending\*(C'\fR will clear the pending event, even if the watcher was
1491not started in the first place. 1610not started in the first place.
1492.Sp 1611.Sp
1493See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1612See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related
1494functions that do not need a watcher. 1613functions that do not need a watcher.
1495.PP 1614.PP
1496See also the \*(L"\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0\*(R" and \*(L"\s-1BUILDING\s0 \s-1YOUR\s0 1615See also the \*(L"\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\*(R"\s0 and \*(L"\s-1BUILDING YOUR
1497\&\s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0\*(R" idioms. 1616OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1498.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1617.SS "\s-1WATCHER STATES\s0"
1499.IX Subsection "WATCHER STATES" 1618.IX Subsection "WATCHER STATES"
1500There are various watcher states mentioned throughout this manual \- 1619There are various watcher states mentioned throughout this manual \-
1501active, pending and so on. In this section these states and the rules to 1620active, pending and so on. In this section these states and the rules to
1502transition between them will be described in more detail \- and while these 1621transition between them will be described in more detail \- and while these
1503rules might look complicated, they usually do \*(L"the right thing\*(R". 1622rules might look complicated, they usually do \*(L"the right thing\*(R".
1504.IP "initialiased" 4 1623.IP "initialised" 4
1505.IX Item "initialiased" 1624.IX Item "initialised"
1506Before a watcher can be registered with the event loop it has to be 1625Before a watcher can be registered with the event loop it has to be
1507initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to 1626initialised. This can be done with a call to \f(CW\*(C`ev_TYPE_init\*(C'\fR, or calls to
1508\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function. 1627\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1509.Sp 1628.Sp
1510In this state it is simply some block of memory that is suitable for 1629In this state it is simply some block of memory that is suitable for
1513\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again. 1632\&\f(CW\*(C`ev_TYPE_init\*(C'\fR again.
1514.IP "started/running/active" 4 1633.IP "started/running/active" 4
1515.IX Item "started/running/active" 1634.IX Item "started/running/active"
1516Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes 1635Once a watcher has been started with a call to \f(CW\*(C`ev_TYPE_start\*(C'\fR it becomes
1517property of the event loop, and is actively waiting for events. While in 1636property of the event loop, and is actively waiting for events. While in
1518this state it cannot be accessed (except in a few documented ways), moved, 1637this state it cannot be accessed (except in a few documented ways, such as
1519freed or anything else \- the only legal thing is to keep a pointer to it, 1638stoping it), moved, freed or anything else \- the only legal thing is to
1520and call libev functions on it that are documented to work on active watchers. 1639keep a pointer to it, and call libev functions on it that are documented
1640to work on active watchers.
1641.Sp
1642As a rule of thumb, before accessing a member or calling any function on
1643a watcher, it should be stopped (or freshly initialised). If that is not
1644convenient, you can check the documentation for that function or member to
1645see if it is safe to use on an active watcher.
1521.IP "pending" 4 1646.IP "pending" 4
1522.IX Item "pending" 1647.IX Item "pending"
1523If a watcher is active and libev determines that an event it is interested 1648If a watcher is active and libev determines that an event it is interested
1524in has occurred (such as a timer expiring), it will become pending. It will 1649in has occurred (such as a timer expiring), it will become pending. It
1525stay in this pending state until either it is stopped or its callback is 1650will stay in this pending state until either it is explicitly stopped or
1526about to be invoked, so it is not normally pending inside the watcher 1651its callback is about to be invoked, so it is not normally pending inside
1527callback. 1652the watcher callback.
1528.Sp 1653.Sp
1529The watcher might or might not be active while it is pending (for example, 1654Generally, the watcher might or might not be active while it is pending
1530an expired non-repeating timer can be pending but no longer active). If it 1655(for example, an expired non-repeating timer can be pending but no longer
1531is stopped, it can be freely accessed (e.g. by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR), 1656active). If it is pending but not active, it can be freely accessed (e.g.
1532but it is still property of the event loop at this time, so cannot be 1657by calling \f(CW\*(C`ev_TYPE_set\*(C'\fR), but it is still property of the event loop at
1533moved, freed or reused. And if it is active the rules described in the 1658this time, so cannot be moved, freed or reused. And if it is active the
1534previous item still apply. 1659rules described in the previous item still apply.
1660.Sp
1661Explicitly stopping a watcher will also clear the pending state
1662unconditionally, so it is safe to stop a watcher and then free it.
1535.Sp 1663.Sp
1536It is also possible to feed an event on a watcher that is not active (e.g. 1664It is also possible to feed an event on a watcher that is not active (e.g.
1537via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being 1665via \f(CW\*(C`ev_feed_event\*(C'\fR), in which case it becomes pending without being
1538active. 1666active.
1539.IP "stopped" 4 1667.IP "stopped" 4
1546.Sp 1674.Sp
1547While stopped (and not pending) the watcher is essentially in the 1675While stopped (and not pending) the watcher is essentially in the
1548initialised state, that is, it can be reused, moved, modified in any way 1676initialised state, that is, it can be reused, moved, modified in any way
1549you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR 1677you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1550it again). 1678it again).
1551.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1679.SS "\s-1WATCHER PRIORITY MODELS\s0"
1552.IX Subsection "WATCHER PRIORITY MODELS" 1680.IX Subsection "WATCHER PRIORITY MODELS"
1553Many event loops support \fIwatcher priorities\fR, which are usually small 1681Many event loops support \fIwatcher priorities\fR, which are usually small
1554integers that influence the ordering of event callback invocation 1682integers that influence the ordering of event callback invocation
1555between watchers in some way, all else being equal. 1683between watchers in some way, all else being equal.
1556.PP 1684.PP
1557In libev, Watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its 1685In libev, watcher priorities can be set using \f(CW\*(C`ev_set_priority\*(C'\fR. See its
1558description for the more technical details such as the actual priority 1686description for the more technical details such as the actual priority
1559range. 1687range.
1560.PP 1688.PP
1561There are two common ways how these these priorities are being interpreted 1689There are two common ways how these these priorities are being interpreted
1562by event loops: 1690by event loops:
1656.IX Header "WATCHER TYPES" 1784.IX Header "WATCHER TYPES"
1657This section describes each watcher in detail, but will not repeat 1785This section describes each watcher in detail, but will not repeat
1658information given in the last section. Any initialisation/set macros, 1786information given in the last section. Any initialisation/set macros,
1659functions and members specific to the watcher type are explained. 1787functions and members specific to the watcher type are explained.
1660.PP 1788.PP
1661Members are additionally marked with either \fI[read\-only]\fR, meaning that, 1789Most members are additionally marked with either \fI[read\-only]\fR, meaning
1662while the watcher is active, you can look at the member and expect some 1790that, while the watcher is active, you can look at the member and expect
1663sensible content, but you must not modify it (you can modify it while the 1791some sensible content, but you must not modify it (you can modify it while
1664watcher is stopped to your hearts content), or \fI[read\-write]\fR, which 1792the watcher is stopped to your hearts content), or \fI[read\-write]\fR, which
1665means you can expect it to have some sensible content while the watcher 1793means you can expect it to have some sensible content while the watcher is
1666is active, but you can also modify it. Modifying it may not do something 1794active, but you can also modify it (within the same thread as the event
1795loop, i.e. without creating data races). Modifying it may not do something
1667sensible or take immediate effect (or do anything at all), but libev will 1796sensible or take immediate effect (or do anything at all), but libev will
1668not crash or malfunction in any way. 1797not crash or malfunction in any way.
1798.PP
1799In any case, the documentation for each member will explain what the
1800effects are, and if there are any additional access restrictions.
1669.ie n .SS """ev_io"" \- is this file descriptor readable or writable?" 1801.ie n .SS """ev_io"" \- is this file descriptor readable or writable?"
1670.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?" 1802.el .SS "\f(CWev_io\fP \- is this file descriptor readable or writable?"
1671.IX Subsection "ev_io - is this file descriptor readable or writable?" 1803.IX Subsection "ev_io - is this file descriptor readable or writable?"
1672I/O watchers check whether a file descriptor is readable or writable 1804I/O watchers check whether a file descriptor is readable or writable
1673in each iteration of the event loop, or, more precisely, when reading 1805in each iteration of the event loop, or, more precisely, when reading
1701But really, best use non-blocking mode. 1833But really, best use non-blocking mode.
1702.PP 1834.PP
1703\fIThe special problem of disappearing file descriptors\fR 1835\fIThe special problem of disappearing file descriptors\fR
1704.IX Subsection "The special problem of disappearing file descriptors" 1836.IX Subsection "The special problem of disappearing file descriptors"
1705.PP 1837.PP
1706Some backends (e.g. kqueue, epoll) need to be told about closing a file 1838Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1707descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other means, 1839a file descriptor (either due to calling \f(CW\*(C`close\*(C'\fR explicitly or any other
1708such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some file 1840means, such as \f(CW\*(C`dup2\*(C'\fR). The reason is that you register interest in some
1709descriptor, but when it goes away, the operating system will silently drop 1841file descriptor, but when it goes away, the operating system will silently
1710this interest. If another file descriptor with the same number then is 1842drop this interest. If another file descriptor with the same number then
1711registered with libev, there is no efficient way to see that this is, in 1843is registered with libev, there is no efficient way to see that this is,
1712fact, a different file descriptor. 1844in fact, a different file descriptor.
1713.PP 1845.PP
1714To avoid having to explicitly tell libev about such cases, libev follows 1846To avoid having to explicitly tell libev about such cases, libev follows
1715the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev 1847the following policy: Each time \f(CW\*(C`ev_io_set\*(C'\fR is being called, libev
1716will assume that this is potentially a new file descriptor, otherwise 1848will assume that this is potentially a new file descriptor, otherwise
1717it is assumed that the file descriptor stays the same. That means that 1849it is assumed that the file descriptor stays the same. That means that
1754wish to read \- you would first have to request some data. 1886wish to read \- you would first have to request some data.
1755.PP 1887.PP
1756Since files are typically not-so-well supported by advanced notification 1888Since files are typically not-so-well supported by advanced notification
1757mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect 1889mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect
1758to files, even though you should not use it. The reason for this is 1890to files, even though you should not use it. The reason for this is
1759convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT\s0, which is 1891convenience: sometimes you want to watch \s-1STDIN\s0 or \s-1STDOUT,\s0 which is
1760usually a tty, often a pipe, but also sometimes files or special devices 1892usually a tty, often a pipe, but also sometimes files or special devices
1761(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with 1893(for example, \f(CW\*(C`epoll\*(C'\fR on Linux works with \fI/dev/random\fR but not with
1762\&\fI/dev/urandom\fR), and even though the file might better be served with 1894\&\fI/dev/urandom\fR), and even though the file might better be served with
1763asynchronous I/O instead of with non-blocking I/O, it is still useful when 1895asynchronous I/O instead of with non-blocking I/O, it is still useful when
1764it \*(L"just works\*(R" instead of freezing. 1896it \*(L"just works\*(R" instead of freezing.
1765.PP 1897.PP
1766So avoid file descriptors pointing to files when you know it (e.g. use 1898So avoid file descriptors pointing to files when you know it (e.g. use
1767libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT\s0, or 1899libeio), but use them when it is convenient, e.g. for \s-1STDIN/STDOUT,\s0 or
1768when you rarely read from a file instead of from a socket, and want to 1900when you rarely read from a file instead of from a socket, and want to
1769reuse the same code path. 1901reuse the same code path.
1770.PP 1902.PP
1771\fIThe special problem of fork\fR 1903\fIThe special problem of fork\fR
1772.IX Subsection "The special problem of fork" 1904.IX Subsection "The special problem of fork"
1773.PP 1905.PP
1774Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit 1906Some backends (epoll, kqueue, linuxaio, iouring) do not support \f(CW\*(C`fork ()\*(C'\fR
1775useless behaviour. Libev fully supports fork, but needs to be told about 1907at all or exhibit useless behaviour. Libev fully supports fork, but needs
1776it in the child if you want to continue to use it in the child. 1908to be told about it in the child if you want to continue to use it in the
1909child.
1777.PP 1910.PP
1778To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork 1911To support fork in your child processes, you have to call \f(CW\*(C`ev_loop_fork
1779()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to 1912()\*(C'\fR after a fork in the child, enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to
1780\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. 1913\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
1781.PP 1914.PP
1782\fIThe special problem of \s-1SIGPIPE\s0\fR 1915\fIThe special problem of \s-1SIGPIPE\s0\fR
1783.IX Subsection "The special problem of SIGPIPE" 1916.IX Subsection "The special problem of SIGPIPE"
1784.PP 1917.PP
1785While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1918While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR:
1786when writing to a pipe whose other end has been closed, your program gets 1919when writing to a pipe whose other end has been closed, your program gets
1787sent a \s-1SIGPIPE\s0, which, by default, aborts your program. For most programs 1920sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1788this is sensible behaviour, for daemons, this is usually undesirable. 1921this is sensible behaviour, for daemons, this is usually undesirable.
1789.PP 1922.PP
1790So when you encounter spurious, unexplained daemon exits, make sure you 1923So when you encounter spurious, unexplained daemon exits, make sure you
1791ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon 1924ignore \s-1SIGPIPE\s0 (and maybe make sure you log the exit status of your daemon
1792somewhere, as that would have given you a big clue). 1925somewhere, as that would have given you a big clue).
1793.PP 1926.PP
1794\fIThe special problem of \fIaccept()\fIing when you can't\fR 1927\fIThe special problem of \f(BIaccept()\fIing when you can't\fR
1795.IX Subsection "The special problem of accept()ing when you can't" 1928.IX Subsection "The special problem of accept()ing when you can't"
1796.PP 1929.PP
1797Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1930Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example,
1798found in post\-2004 Linux) have the peculiar behaviour of not removing a 1931found in post\-2004 Linux) have the peculiar behaviour of not removing a
1799connection from the pending queue in all error cases. 1932connection from the pending queue in all error cases.
1838.PD 0 1971.PD 0
1839.IP "ev_io_set (ev_io *, int fd, int events)" 4 1972.IP "ev_io_set (ev_io *, int fd, int events)" 4
1840.IX Item "ev_io_set (ev_io *, int fd, int events)" 1973.IX Item "ev_io_set (ev_io *, int fd, int events)"
1841.PD 1974.PD
1842Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to 1975Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The \f(CW\*(C`fd\*(C'\fR is the file descriptor to
1843receive 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 1976receive 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, both
1844\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR, to express the desire to receive the given events. 1977\&\f(CW\*(C`EV_READ | EV_WRITE\*(C'\fR or \f(CW0\fR, to express the desire to receive the given
1978events.
1979.Sp
1980Note that setting the \f(CW\*(C`events\*(C'\fR to \f(CW0\fR and starting the watcher is
1981supported, but not specially optimized \- if your program sometimes happens
1982to generate this combination this is fine, but if it is easy to avoid
1983starting an io watcher watching for no events you should do so.
1984.IP "ev_io_modify (ev_io *, int events)" 4
1985.IX Item "ev_io_modify (ev_io *, int events)"
1986Similar to \f(CW\*(C`ev_io_set\*(C'\fR, but only changes the requested events. Using this
1987might be faster with some backends, as libev can assume that the \f(CW\*(C`fd\*(C'\fR
1988still refers to the same underlying file description, something it cannot
1989do when using \f(CW\*(C`ev_io_set\*(C'\fR.
1845.IP "int fd [read\-only]" 4 1990.IP "int fd [no\-modify]" 4
1846.IX Item "int fd [read-only]" 1991.IX Item "int fd [no-modify]"
1847The file descriptor being watched. 1992The file descriptor being watched. While it can be read at any time, you
1993must not modify this member even when the watcher is stopped \- always use
1994\&\f(CW\*(C`ev_io_set\*(C'\fR for that.
1848.IP "int events [read\-only]" 4 1995.IP "int events [no\-modify]" 4
1849.IX Item "int events [read-only]" 1996.IX Item "int events [no-modify]"
1850The events being watched. 1997The set of events the fd is being watched for, among other flags. Remember
1998that this is a bit set \- to test for \f(CW\*(C`EV_READ\*(C'\fR, use \f(CW\*(C`w\->events &
1999EV_READ\*(C'\fR, and similarly for \f(CW\*(C`EV_WRITE\*(C'\fR.
2000.Sp
2001As with \f(CW\*(C`fd\*(C'\fR, you must not modify this member even when the watcher is
2002stopped, always use \f(CW\*(C`ev_io_set\*(C'\fR or \f(CW\*(C`ev_io_modify\*(C'\fR for that.
1851.PP 2003.PP
1852\fIExamples\fR 2004\fIExamples\fR
1853.IX Subsection "Examples" 2005.IX Subsection "Examples"
1854.PP 2006.PP
1855Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well 2007Example: Call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
1990\& callback (EV_P_ ev_timer *w, int revents) 2142\& callback (EV_P_ ev_timer *w, int revents)
1991\& { 2143\& {
1992\& // calculate when the timeout would happen 2144\& // calculate when the timeout would happen
1993\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout; 2145\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1994\& 2146\&
1995\& // if negative, it means we the timeout already occured 2147\& // if negative, it means we the timeout already occurred
1996\& if (after < 0.) 2148\& if (after < 0.)
1997\& { 2149\& {
1998\& // timeout occurred, take action 2150\& // timeout occurred, take action
1999\& } 2151\& }
2000\& else 2152\& else
2019.Sp 2171.Sp
2020Otherwise, we now the earliest time at which the timeout would trigger, 2172Otherwise, we now the earliest time at which the timeout would trigger,
2021and simply start the timer with this timeout value. 2173and simply start the timer with this timeout value.
2022.Sp 2174.Sp
2023In other words, each time the callback is invoked it will check whether 2175In other words, each time the callback is invoked it will check whether
2024the timeout cocured. If not, it will simply reschedule itself to check 2176the timeout occurred. If not, it will simply reschedule itself to check
2025again at the earliest time it could time out. Rinse. Repeat. 2177again at the earliest time it could time out. Rinse. Repeat.
2026.Sp 2178.Sp
2027This scheme causes more callback invocations (about one every 60 seconds 2179This scheme causes more callback invocations (about one every 60 seconds
2028minus half the average time between activity), but virtually no calls to 2180minus half the average time between activity), but virtually no calls to
2029libev to change the timeout. 2181libev to change the timeout.
2047\& last_activity = ev_now (EV_A); 2199\& last_activity = ev_now (EV_A);
2048.Ve 2200.Ve
2049.Sp 2201.Sp
2050When your timeout value changes, then the timeout can be changed by simply 2202When your timeout value changes, then the timeout can be changed by simply
2051providing a new value, stopping the timer and calling the callback, which 2203providing a new value, stopping the timer and calling the callback, which
2052will agaion do the right thing (for example, time out immediately :). 2204will again do the right thing (for example, time out immediately :).
2053.Sp 2205.Sp
2054.Vb 3 2206.Vb 3
2055\& timeout = new_value; 2207\& timeout = new_value;
2056\& ev_timer_stop (EV_A_ &timer); 2208\& ev_timer_stop (EV_A_ &timer);
2057\& callback (EV_A_ &timer, 0); 2209\& callback (EV_A_ &timer, 0);
2141.PP 2293.PP
2142The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2294The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR
2143time. This is usually the right thing as this timestamp refers to the time 2295time. This is usually the right thing as this timestamp refers to the time
2144of the event triggering whatever timeout you are modifying/starting. If 2296of the event triggering whatever timeout you are modifying/starting. If
2145you suspect event processing to be delayed and you \fIneed\fR to base the 2297you suspect event processing to be delayed and you \fIneed\fR to base the
2146timeout on the current time, use something like this to adjust for this: 2298timeout on the current time, use something like the following to adjust
2299for it:
2147.PP 2300.PP
2148.Vb 1 2301.Vb 1
2149\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2302\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
2150.Ve 2303.Ve
2151.PP 2304.PP
2152If the event loop is suspended for a long time, you can also force an 2305If the event loop is suspended for a long time, you can also force an
2153update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update 2306update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2154()\*(C'\fR. 2307()\*(C'\fR, although that will push the event time of all outstanding events
2308further into the future.
2155.PP 2309.PP
2156\fIThe special problem of unsynchronised clocks\fR 2310\fIThe special problem of unsynchronised clocks\fR
2157.IX Subsection "The special problem of unsynchronised clocks" 2311.IX Subsection "The special problem of unsynchronised clocks"
2158.PP 2312.PP
2159Modern systems have a variety of clocks \- libev itself uses the normal 2313Modern systems have a variety of clocks \- libev itself uses the normal
2224.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)" 2378.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2225.PD 0 2379.PD 0
2226.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2380.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4
2227.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 2381.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2228.PD 2382.PD
2229Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2383Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds (fractional and
2230is \f(CW0.\fR, then it will automatically be stopped once the timeout is 2384negative values are supported). If \f(CW\*(C`repeat\*(C'\fR is \f(CW0.\fR, then it will
2231reached. If it is positive, then the timer will automatically be 2385automatically be stopped once the timeout is reached. If it is positive,
2232configured to trigger again \f(CW\*(C`repeat\*(C'\fR seconds later, again, and again, 2386then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2233until stopped manually. 2387seconds later, again, and again, until stopped manually.
2234.Sp 2388.Sp
2235The timer itself will do a best-effort at avoiding drift, that is, if 2389The timer itself will do a best-effort at avoiding drift, that is, if
2236you configure a timer to trigger every 10 seconds, then it will normally 2390you configure a timer to trigger every 10 seconds, then it will normally
2237trigger at exactly 10 second intervals. If, however, your program cannot 2391trigger at exactly 10 second intervals. If, however, your program cannot
2238keep up with the timer (because it takes longer than those 10 seconds to 2392keep up with the timer (because it takes longer than those 10 seconds to
2320Periodic watchers are also timers of a kind, but they are very versatile 2474Periodic watchers are also timers of a kind, but they are very versatile
2321(and unfortunately a bit complex). 2475(and unfortunately a bit complex).
2322.PP 2476.PP
2323Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or 2477Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or
2324relative time, the physical time that passes) but on wall clock time 2478relative time, the physical time that passes) but on wall clock time
2325(absolute time, the thing you can read on your calender or clock). The 2479(absolute time, the thing you can read on your calendar or clock). The
2326difference is that wall clock time can run faster or slower than real 2480difference is that wall clock time can run faster or slower than real
2327time, and time jumps are not uncommon (e.g. when you adjust your 2481time, and time jumps are not uncommon (e.g. when you adjust your
2328wrist-watch). 2482wrist-watch).
2329.PP 2483.PP
2330You can tell a periodic watcher to trigger after some specific point 2484You can tell a periodic watcher to trigger after some specific point
2335\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting 2489\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2336it, as it uses a relative timeout). 2490it, as it uses a relative timeout).
2337.PP 2491.PP
2338\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2492\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex
2339timers, such as triggering an event on each \*(L"midnight, local time\*(R", or 2493timers, such as triggering an event on each \*(L"midnight, local time\*(R", or
2340other complicated rules. This cannot be done with \f(CW\*(C`ev_timer\*(C'\fR watchers, as 2494other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2341those cannot react to time jumps. 2495watchers, as those cannot react to time jumps.
2342.PP 2496.PP
2343As with timers, the callback is guaranteed to be invoked only when the 2497As with timers, the callback is guaranteed to be invoked only when the
2344point in time where it is supposed to trigger has passed. If multiple 2498point in time where it is supposed to trigger has passed. If multiple
2345timers become ready during the same loop iteration then the ones with 2499timers become ready during the same loop iteration then the ones with
2346earlier time-out values are invoked before ones with later time-out values 2500earlier time-out values are invoked before ones with later time-out values
2407In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being 2561In this mode the values for \f(CW\*(C`interval\*(C'\fR and \f(CW\*(C`offset\*(C'\fR are both being
2408ignored. Instead, each time the periodic watcher gets scheduled, the 2562ignored. Instead, each time the periodic watcher gets scheduled, the
2409reschedule callback will be called with the watcher as first, and the 2563reschedule callback will be called with the watcher as first, and the
2410current time as second argument. 2564current time as second argument.
2411.Sp 2565.Sp
2412\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2566\&\s-1NOTE:\s0 \fIThis callback \s-1MUST NOT\s0 stop or destroy any periodic watcher, ever,
2413or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly 2567or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2414allowed by documentation here\fR. 2568allowed by documentation here\fR.
2415.Sp 2569.Sp
2416If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2570If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop
2417it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the 2571it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2435.Sp 2589.Sp
2436\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2590\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or
2437equal to the passed \f(CI\*(C`now\*(C'\fI value\fR. 2591equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2438.Sp 2592.Sp
2439This can be used to create very complex timers, such as a timer that 2593This can be used to create very complex timers, such as a timer that
2440triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate the 2594triggers on \*(L"next midnight, local time\*(R". To do this, you would calculate
2441next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for this. How 2595the next midnight after \f(CW\*(C`now\*(C'\fR and return the timestamp value for
2442you do this is, again, up to you (but it is not trivial, which is the main 2596this. Here is a (completely untested, no error checking) example on how to
2443reason I omitted it as an example). 2597do this:
2598.Sp
2599.Vb 1
2600\& #include <time.h>
2601\&
2602\& static ev_tstamp
2603\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2604\& {
2605\& time_t tnow = (time_t)now;
2606\& struct tm tm;
2607\& localtime_r (&tnow, &tm);
2608\&
2609\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2610\& ++tm.tm_mday; // midnight next day
2611\&
2612\& return mktime (&tm);
2613\& }
2614.Ve
2615.Sp
2616Note: this code might run into trouble on days that have more then two
2617midnights (beginning and end).
2444.RE 2618.RE
2445.RS 4 2619.RS 4
2446.RE 2620.RE
2447.IP "ev_periodic_again (loop, ev_periodic *)" 4 2621.IP "ev_periodic_again (loop, ev_periodic *)" 4
2448.IX Item "ev_periodic_again (loop, ev_periodic *)" 2622.IX Item "ev_periodic_again (loop, ev_periodic *)"
2533only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your 2707only within the same loop, i.e. you can watch for \f(CW\*(C`SIGINT\*(C'\fR in your
2534default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for 2708default loop and for \f(CW\*(C`SIGIO\*(C'\fR in another loop, but you cannot watch for
2535\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At 2709\&\f(CW\*(C`SIGINT\*(C'\fR in both the default loop and another loop at the same time. At
2536the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop. 2710the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2537.PP 2711.PP
2538When the first watcher gets started will libev actually register something 2712Only after the first watcher for a signal is started will libev actually
2539with the kernel (thus it coexists with your own signal handlers as long as 2713register something with the kernel. It thus coexists with your own signal
2540you don't register any with libev for the same signal). 2714handlers as long as you don't register any with libev for the same signal.
2541.PP 2715.PP
2542If possible and supported, libev will install its handlers with 2716If possible and supported, libev will install its handlers with
2543\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should 2717\&\f(CW\*(C`SA_RESTART\*(C'\fR (or equivalent) behaviour enabled, so system calls should
2544not be unduly interrupted. If you have a problem with system calls getting 2718not be unduly interrupted. If you have a problem with system calls getting
2545interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher 2719interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2606The signal the watcher watches out for. 2780The signal the watcher watches out for.
2607.PP 2781.PP
2608\fIExamples\fR 2782\fIExamples\fR
2609.IX Subsection "Examples" 2783.IX Subsection "Examples"
2610.PP 2784.PP
2611Example: Try to exit cleanly on \s-1SIGINT\s0. 2785Example: Try to exit cleanly on \s-1SIGINT.\s0
2612.PP 2786.PP
2613.Vb 5 2787.Vb 5
2614\& static void 2788\& static void
2615\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2789\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2616\& { 2790\& {
2731.ie n .SS """ev_stat"" \- did the file attributes just change?" 2905.ie n .SS """ev_stat"" \- did the file attributes just change?"
2732.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2906.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2733.IX Subsection "ev_stat - did the file attributes just change?" 2907.IX Subsection "ev_stat - did the file attributes just change?"
2734This watches a file system path for attribute changes. That is, it calls 2908This watches a file system path for attribute changes. That is, it calls
2735\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed) 2909\&\f(CW\*(C`stat\*(C'\fR on that path in regular intervals (or when the \s-1OS\s0 says it changed)
2736and sees if it changed compared to the last time, invoking the callback if 2910and sees if it changed compared to the last time, invoking the callback
2737it did. 2911if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2912happen after the watcher has been started will be reported.
2738.PP 2913.PP
2739The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2914The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does
2740not exist\*(R" is a status change like any other. The condition \*(L"path does not 2915not exist\*(R" is a status change like any other. The condition \*(L"path does not
2741exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the 2916exist\*(R" (or more correctly \*(L"path cannot be stat'ed\*(R") is signified by the
2742\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at 2917\&\f(CW\*(C`st_nlink\*(C'\fR field being zero (which is otherwise always forced to be at
2772compilation environment, which means that on systems with large file 2947compilation environment, which means that on systems with large file
2773support disabled by default, you get the 32 bit version of the stat 2948support disabled by default, you get the 32 bit version of the stat
2774structure. When using the library from programs that change the \s-1ABI\s0 to 2949structure. When using the library from programs that change the \s-1ABI\s0 to
2775use 64 bit file offsets the programs will fail. In that case you have to 2950use 64 bit file offsets the programs will fail. In that case you have to
2776compile libev with the same flags to get binary compatibility. This is 2951compile libev with the same flags to get binary compatibility. This is
2777obviously the case with any flags that change the \s-1ABI\s0, but the problem is 2952obviously the case with any flags that change the \s-1ABI,\s0 but the problem is
2778most noticeably displayed with ev_stat and large file support. 2953most noticeably displayed with ev_stat and large file support.
2779.PP 2954.PP
2780The solution for this is to lobby your distribution maker to make large 2955The solution for this is to lobby your distribution maker to make large
2781file interfaces available by default (as e.g. FreeBSD does) and not 2956file interfaces available by default (as e.g. FreeBSD does) and not
2782optional. Libev cannot simply switch on large file support because it has 2957optional. Libev cannot simply switch on large file support because it has
2973Apart from keeping your process non-blocking (which is a useful 3148Apart from keeping your process non-blocking (which is a useful
2974effect on its own sometimes), idle watchers are a good place to do 3149effect on its own sometimes), idle watchers are a good place to do
2975\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the 3150\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2976event loop has handled all outstanding events. 3151event loop has handled all outstanding events.
2977.PP 3152.PP
3153\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3154.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3155.PP
3156As long as there is at least one active idle watcher, libev will never
3157sleep unnecessarily. Or in other words, it will loop as fast as possible.
3158For this to work, the idle watcher doesn't need to be invoked at all \- the
3159lowest priority will do.
3160.PP
3161This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3162to do something on each event loop iteration \- for example to balance load
3163between different connections.
3164.PP
3165See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3166example.
3167.PP
2978\fIWatcher-Specific Functions and Data Members\fR 3168\fIWatcher-Specific Functions and Data Members\fR
2979.IX Subsection "Watcher-Specific Functions and Data Members" 3169.IX Subsection "Watcher-Specific Functions and Data Members"
2980.IP "ev_idle_init (ev_idle *, callback)" 4 3170.IP "ev_idle_init (ev_idle *, callback)" 4
2981.IX Item "ev_idle_init (ev_idle *, callback)" 3171.IX Item "ev_idle_init (ev_idle *, callback)"
2982Initialises and configures the idle watcher \- it has no parameters of any 3172Initialises and configures the idle watcher \- it has no parameters of any
2987.IX Subsection "Examples" 3177.IX Subsection "Examples"
2988.PP 3178.PP
2989Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3179Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the
2990callback, free it. Also, use no error checking, as usual. 3180callback, free it. Also, use no error checking, as usual.
2991.PP 3181.PP
2992.Vb 7 3182.Vb 5
2993\& static void 3183\& static void
2994\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3184\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2995\& { 3185\& {
3186\& // stop the watcher
3187\& ev_idle_stop (loop, w);
3188\&
3189\& // now we can free it
2996\& free (w); 3190\& free (w);
3191\&
2997\& // now do something you wanted to do when the program has 3192\& // now do something you wanted to do when the program has
2998\& // no longer anything immediate to do. 3193\& // no longer anything immediate to do.
2999\& } 3194\& }
3000\& 3195\&
3001\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3196\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
3003\& ev_idle_start (loop, idle_watcher); 3198\& ev_idle_start (loop, idle_watcher);
3004.Ve 3199.Ve
3005.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3200.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!"
3006.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!" 3201.el .SS "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop!"
3007.IX Subsection "ev_prepare and ev_check - customise your event loop!" 3202.IX Subsection "ev_prepare and ev_check - customise your event loop!"
3008Prepare and check watchers are usually (but not always) used in pairs: 3203Prepare and check watchers are often (but not always) used in pairs:
3009prepare watchers get invoked before the process blocks and check watchers 3204prepare watchers get invoked before the process blocks and check watchers
3010afterwards. 3205afterwards.
3011.PP 3206.PP
3012You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3207You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR (or similar functions that enter the
3013the current event loop from either \f(CW\*(C`ev_prepare\*(C'\fR or \f(CW\*(C`ev_check\*(C'\fR 3208current event loop) or \f(CW\*(C`ev_loop_fork\*(C'\fR from either \f(CW\*(C`ev_prepare\*(C'\fR or
3014watchers. Other loops than the current one are fine, however. The 3209\&\f(CW\*(C`ev_check\*(C'\fR watchers. Other loops than the current one are fine,
3015rationale behind this is that you do not need to check for recursion in 3210however. The rationale behind this is that you do not need to check
3016those watchers, i.e. the sequence will always be \f(CW\*(C`ev_prepare\*(C'\fR, blocking, 3211for recursion in those watchers, i.e. the sequence will always be
3017\&\f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each kind they will always be 3212\&\f(CW\*(C`ev_prepare\*(C'\fR, blocking, \f(CW\*(C`ev_check\*(C'\fR so if you have one watcher of each
3018called in pairs bracketing the blocking call. 3213kind they will always be called in pairs bracketing the blocking call.
3019.PP 3214.PP
3020Their main purpose is to integrate other event mechanisms into libev and 3215Their main purpose is to integrate other event mechanisms into libev and
3021their use is somewhat advanced. They could be used, for example, to track 3216their use is somewhat advanced. They could be used, for example, to track
3022variable changes, implement your own watchers, integrate net-snmp or a 3217variable changes, implement your own watchers, integrate net-snmp or a
3023coroutine library and lots more. They are also occasionally useful if 3218coroutine library and lots more. They are also occasionally useful if
3041with priority higher than or equal to the event loop and one coroutine 3236with priority higher than or equal to the event loop and one coroutine
3042of lower priority, but only once, using idle watchers to keep the event 3237of lower priority, but only once, using idle watchers to keep the event
3043loop from blocking if lower-priority coroutines are active, thus mapping 3238loop from blocking if lower-priority coroutines are active, thus mapping
3044low-priority coroutines to idle/background tasks). 3239low-priority coroutines to idle/background tasks).
3045.PP 3240.PP
3046It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3241When used for this purpose, it is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers
3047priority, to ensure that they are being run before any other watchers 3242highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) priority, to ensure that they are being run before
3048after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR watchers). 3243any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3244watchers).
3049.PP 3245.PP
3050Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3246Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not
3051activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they 3247activate (\*(L"feed\*(R") events into libev. While libev fully supports this, they
3052might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As 3248might get executed before other \f(CW\*(C`ev_check\*(C'\fR watchers did their job. As
3053\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event 3249\&\f(CW\*(C`ev_check\*(C'\fR watchers are often used to embed other (non-libev) event
3054loops those other event loops might be in an unusable state until their 3250loops those other event loops might be in an unusable state until their
3055\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with 3251\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
3056others). 3252others).
3253.PP
3254\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3255.IX Subsection "Abusing an ev_check watcher for its side-effect"
3256.PP
3257\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3258useful because they are called once per event loop iteration. For
3259example, if you want to handle a large number of connections fairly, you
3260normally only do a bit of work for each active connection, and if there
3261is more work to do, you wait for the next event loop iteration, so other
3262connections have a chance of making progress.
3263.PP
3264Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3265next event loop iteration. However, that isn't as soon as possible \-
3266without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3267.PP
3268This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3269single global idle watcher that is active as long as you have one active
3270\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3271will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3272invoked. Neither watcher alone can do that.
3057.PP 3273.PP
3058\fIWatcher-Specific Functions and Data Members\fR 3274\fIWatcher-Specific Functions and Data Members\fR
3059.IX Subsection "Watcher-Specific Functions and Data Members" 3275.IX Subsection "Watcher-Specific Functions and Data Members"
3060.IP "ev_prepare_init (ev_prepare *, callback)" 4 3276.IP "ev_prepare_init (ev_prepare *, callback)" 4
3061.IX Item "ev_prepare_init (ev_prepare *, callback)" 3277.IX Item "ev_prepare_init (ev_prepare *, callback)"
3172.Ve 3388.Ve
3173.PP 3389.PP
3174Method 4: Do not use a prepare or check watcher because the module you 3390Method 4: Do not use a prepare or check watcher because the module you
3175want to embed is not flexible enough to support it. Instead, you can 3391want to embed is not flexible enough to support it. Instead, you can
3176override their poll function. The drawback with this solution is that the 3392override their poll function. The drawback with this solution is that the
3177main loop is now no longer controllable by \s-1EV\s0. The \f(CW\*(C`Glib::EV\*(C'\fR module uses 3393main loop is now no longer controllable by \s-1EV.\s0 The \f(CW\*(C`Glib::EV\*(C'\fR module uses
3178this approach, effectively embedding \s-1EV\s0 as a client into the horrible 3394this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3179libglib event loop. 3395libglib event loop.
3180.PP 3396.PP
3181.Vb 4 3397.Vb 4
3182\& static gint 3398\& static gint
3266\fIWatcher-Specific Functions and Data Members\fR 3482\fIWatcher-Specific Functions and Data Members\fR
3267.IX Subsection "Watcher-Specific Functions and Data Members" 3483.IX Subsection "Watcher-Specific Functions and Data Members"
3268.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3484.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
3269.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 3485.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3270.PD 0 3486.PD 0
3271.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3487.IP "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)" 4
3272.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 3488.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3273.PD 3489.PD
3274Configures the watcher to embed the given loop, which must be 3490Configures the watcher to embed the given loop, which must be
3275embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be 3491embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
3276invoked automatically, otherwise it is the responsibility of the callback 3492invoked automatically, otherwise it is the responsibility of the callback
3277to invoke it (it will continue to be called until the sweep has been done, 3493to invoke it (it will continue to be called until the sweep has been done,
3296.PP 3512.PP
3297.Vb 3 3513.Vb 3
3298\& struct ev_loop *loop_hi = ev_default_init (0); 3514\& struct ev_loop *loop_hi = ev_default_init (0);
3299\& struct ev_loop *loop_lo = 0; 3515\& struct ev_loop *loop_lo = 0;
3300\& ev_embed embed; 3516\& ev_embed embed;
3301\& 3517\&
3302\& // see if there is a chance of getting one that works 3518\& // see if there is a chance of getting one that works
3303\& // (remember that a flags value of 0 means autodetection) 3519\& // (remember that a flags value of 0 means autodetection)
3304\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3520\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3305\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3521\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3306\& : 0; 3522\& : 0;
3322.PP 3538.PP
3323.Vb 3 3539.Vb 3
3324\& struct ev_loop *loop = ev_default_init (0); 3540\& struct ev_loop *loop = ev_default_init (0);
3325\& struct ev_loop *loop_socket = 0; 3541\& struct ev_loop *loop_socket = 0;
3326\& ev_embed embed; 3542\& ev_embed embed;
3327\& 3543\&
3328\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3544\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3329\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3545\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3330\& { 3546\& {
3331\& ev_embed_init (&embed, 0, loop_socket); 3547\& ev_embed_init (&embed, 0, loop_socket);
3332\& ev_embed_start (loop, &embed); 3548\& ev_embed_start (loop, &embed);
3340.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3556.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork"
3341.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" 3557.el .SS "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork"
3342.IX Subsection "ev_fork - the audacity to resume the event loop after a fork" 3558.IX Subsection "ev_fork - the audacity to resume the event loop after a fork"
3343Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because 3559Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because
3344whoever is a good citizen cared to tell libev about it by calling 3560whoever is a good citizen cared to tell libev about it by calling
3345\&\f(CW\*(C`ev_default_fork\*(C'\fR or \f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the 3561\&\f(CW\*(C`ev_loop_fork\*(C'\fR). The invocation is done before the event loop blocks next
3346event loop blocks next and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, 3562and before \f(CW\*(C`ev_check\*(C'\fR watchers are being called, and only in the child
3347and only in the child after the fork. If whoever good citizen calling 3563after the fork. If whoever good citizen calling \f(CW\*(C`ev_default_fork\*(C'\fR cheats
3348\&\f(CW\*(C`ev_default_fork\*(C'\fR cheats and calls it in the wrong process, the fork 3564and calls it in the wrong process, the fork handlers will be invoked, too,
3349handlers will be invoked, too, of course. 3565of course.
3350.PP 3566.PP
3351\fIThe special problem of life after fork \- how is it possible?\fR 3567\fIThe special problem of life after fork \- how is it possible?\fR
3352.IX Subsection "The special problem of life after fork - how is it possible?" 3568.IX Subsection "The special problem of life after fork - how is it possible?"
3353.PP 3569.PP
3354Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3570Most uses of \f(CW\*(C`fork ()\*(C'\fR consist of forking, then some simple calls to set
3355up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This 3571up/change the process environment, followed by a call to \f(CW\*(C`exec()\*(C'\fR. This
3356sequence should be handled by libev without any problems. 3572sequence should be handled by libev without any problems.
3357.PP 3573.PP
3358This changes when the application actually wants to do event handling 3574This changes when the application actually wants to do event handling
3359in the child, or both parent in child, in effect \*(L"continuing\*(R" after the 3575in the child, or both parent in child, in effect \*(L"continuing\*(R" after the
3440it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe. 3656it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3441.PP 3657.PP
3442This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3658This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals,
3443too, are asynchronous in nature, and signals, too, will be compressed 3659too, are asynchronous in nature, and signals, too, will be compressed
3444(i.e. the number of callback invocations may be less than the number of 3660(i.e. the number of callback invocations may be less than the number of
3445\&\f(CW\*(C`ev_async_sent\*(C'\fR calls). In fact, you could use signal watchers as a kind 3661\&\f(CW\*(C`ev_async_send\*(C'\fR calls). In fact, you could use signal watchers as a kind
3446of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused 3662of \*(L"global async watchers\*(R" by using a watcher on an otherwise unused
3447signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread, 3663signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3448even without knowing which loop owns the signal. 3664even without knowing which loop owns the signal.
3449.PP 3665.PP
3450\fIQueueing\fR 3666\fIQueueing\fR
3576is a time window between the event loop checking and resetting the async 3792is a time window between the event loop checking and resetting the async
3577notification, and the callback being invoked. 3793notification, and the callback being invoked.
3578.SH "OTHER FUNCTIONS" 3794.SH "OTHER FUNCTIONS"
3579.IX Header "OTHER FUNCTIONS" 3795.IX Header "OTHER FUNCTIONS"
3580There are some other functions of possible interest. Described. Here. Now. 3796There are some other functions of possible interest. Described. Here. Now.
3581.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3797.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)" 4
3582.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 3798.IX Item "ev_once (loop, int fd, int events, ev_tstamp timeout, callback, arg)"
3583This function combines a simple timer and an I/O watcher, calls your 3799This function combines a simple timer and an I/O watcher, calls your
3584callback on whichever event happens first and automatically stops both 3800callback on whichever event happens first and automatically stops both
3585watchers. This is useful if you want to wait for a single event on an fd 3801watchers. This is useful if you want to wait for a single event on an fd
3586or timeout without having to allocate/configure/start/stop/free one or 3802or timeout without having to allocate/configure/start/stop/free one or
3587more watchers yourself. 3803more watchers yourself.
3599\&\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_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR 3815\&\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_TIMER\*(C'\fR) and the \f(CW\*(C`arg\*(C'\fR
3600value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR 3816value passed to \f(CW\*(C`ev_once\*(C'\fR. Note that it is possible to receive \fIboth\fR
3601a timeout and an io event at the same time \- you probably should give io 3817a timeout and an io event at the same time \- you probably should give io
3602events precedence. 3818events precedence.
3603.Sp 3819.Sp
3604Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3820Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3605.Sp 3821.Sp
3606.Vb 7 3822.Vb 7
3607\& static void stdin_ready (int revents, void *arg) 3823\& static void stdin_ready (int revents, void *arg)
3608\& { 3824\& {
3609\& if (revents & EV_READ) 3825\& if (revents & EV_READ)
3625.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" 3841.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3626.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" 3842.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3627This section explains some common idioms that are not immediately 3843This section explains some common idioms that are not immediately
3628obvious. Note that examples are sprinkled over the whole manual, and this 3844obvious. Note that examples are sprinkled over the whole manual, and this
3629section only contains stuff that wouldn't fit anywhere else. 3845section only contains stuff that wouldn't fit anywhere else.
3630.SS "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0" 3846.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3631.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 3847.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
3632Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read 3848Each watcher has, by default, a \f(CW\*(C`void *data\*(C'\fR member that you can read
3633or modify at any time: libev will completely ignore it. This can be used 3849or modify at any time: libev will completely ignore it. This can be used
3634to associate arbitrary data with your watcher. If you need more data and 3850to associate arbitrary data with your watcher. If you need more data and
3635don't want to allocate memory separately and store a pointer to it in that 3851don't want to allocate memory separately and store a pointer to it in that
3661\& } 3877\& }
3662.Ve 3878.Ve
3663.PP 3879.PP
3664More interesting and less C\-conformant ways of casting your callback 3880More interesting and less C\-conformant ways of casting your callback
3665function type instead have been omitted. 3881function type instead have been omitted.
3666.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0" 3882.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3667.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" 3883.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3668Another common scenario is to use some data structure with multiple 3884Another common scenario is to use some data structure with multiple
3669embedded watchers, in effect creating your own watcher that combines 3885embedded watchers, in effect creating your own watcher that combines
3670multiple libev event sources into one \*(L"super-watcher\*(R": 3886multiple libev event sources into one \*(L"super-watcher\*(R":
3671.PP 3887.PP
3699\& { 3915\& {
3700\& struct my_biggy big = (struct my_biggy *) 3916\& struct my_biggy big = (struct my_biggy *)
3701\& (((char *)w) \- offsetof (struct my_biggy, t2)); 3917\& (((char *)w) \- offsetof (struct my_biggy, t2));
3702\& } 3918\& }
3703.Ve 3919.Ve
3704.SS "\s-1AVOIDING\s0 \s-1FINISHING\s0 \s-1BEFORE\s0 \s-1RETURNING\s0" 3920.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3705.IX Subsection "AVOIDING FINISHING BEFORE RETURNING" 3921.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3706Often you have structures like this in event-based programs: 3922Often you have structures like this in event-based programs:
3707.PP 3923.PP
3708.Vb 4 3924.Vb 4
3709\& callback () 3925\& callback ()
3731already been invoked. 3947already been invoked.
3732.PP 3948.PP
3733A common way around all these issues is to make sure that 3949A common way around all these issues is to make sure that
3734\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If 3950\&\f(CW\*(C`start_new_request\*(C'\fR \fIalways\fR returns before the callback is invoked. If
3735\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially 3951\&\f(CW\*(C`start_new_request\*(C'\fR immediately knows the result, it can artificially
3736delay invoking the callback by e.g. using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher 3952delay invoking the callback by using a \f(CW\*(C`prepare\*(C'\fR or \f(CW\*(C`idle\*(C'\fR watcher for
3737for example, or more sneakily, by reusing an existing (stopped) watcher 3953example, or more sneakily, by reusing an existing (stopped) watcher and
3738and pushing it into the pending queue: 3954pushing it into the pending queue:
3739.PP 3955.PP
3740.Vb 2 3956.Vb 2
3741\& ev_set_cb (watcher, callback); 3957\& ev_set_cb (watcher, callback);
3742\& ev_feed_event (EV_A_ watcher, 0); 3958\& ev_feed_event (EV_A_ watcher, 0);
3743.Ve 3959.Ve
3744.PP 3960.PP
3745This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is 3961This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3746invoked, while not delaying callback invocation too much. 3962invoked, while not delaying callback invocation too much.
3747.SS "\s-1MODEL/NESTED\s0 \s-1EVENT\s0 \s-1LOOP\s0 \s-1INVOCATIONS\s0 \s-1AND\s0 \s-1EXIT\s0 \s-1CONDITIONS\s0" 3963.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3748.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" 3964.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3749Often (especially in \s-1GUI\s0 toolkits) there are places where you have 3965Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3750\&\fImodal\fR interaction, which is most easily implemented by recursively 3966\&\fImodal\fR interaction, which is most easily implemented by recursively
3751invoking \f(CW\*(C`ev_run\*(C'\fR. 3967invoking \f(CW\*(C`ev_run\*(C'\fR.
3752.PP 3968.PP
3753This brings the problem of exiting \- a callback might want to finish the 3969This brings the problem of exiting \- a callback might want to finish the
3754main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but 3970main \f(CW\*(C`ev_run\*(C'\fR call, but not the nested one (e.g. user clicked \*(L"Quit\*(R", but
3755a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one 3971a modal \*(L"Are you sure?\*(R" dialog is still waiting), or just the nested one
3756and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some 3972and not the main one (e.g. user clocked \*(L"Ok\*(R" in a modal dialog), or some
3757other combination: In these cases, \f(CW\*(C`ev_break\*(C'\fR will not work alone. 3973other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3758.PP 3974.PP
3759The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR 3975The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR
3760invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is 3976invocation, and use a loop around \f(CW\*(C`ev_run\*(C'\fR until the condition is
3761triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR: 3977triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3762.PP 3978.PP
3784\& exit_main_loop = 1; 4000\& exit_main_loop = 1;
3785\& 4001\&
3786\& // exit both 4002\& // exit both
3787\& exit_main_loop = exit_nested_loop = 1; 4003\& exit_main_loop = exit_nested_loop = 1;
3788.Ve 4004.Ve
3789.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0" 4005.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3790.IX Subsection "THREAD LOCKING EXAMPLE" 4006.IX Subsection "THREAD LOCKING EXAMPLE"
3791Here is a fictitious example of how to run an event loop in a different 4007Here is a fictitious example of how to run an event loop in a different
3792thread from where callbacks are being invoked and watchers are 4008thread from where callbacks are being invoked and watchers are
3793created/added/removed. 4009created/added/removed.
3794.PP 4010.PP
3802.PP 4018.PP
3803First, you need to associate some data with the event loop: 4019First, you need to associate some data with the event loop:
3804.PP 4020.PP
3805.Vb 6 4021.Vb 6
3806\& typedef struct { 4022\& typedef struct {
3807\& mutex_t lock; /* global loop lock */ 4023\& pthread_mutex_t lock; /* global loop lock */
4024\& pthread_t tid;
4025\& pthread_cond_t invoke_cv;
3808\& ev_async async_w; 4026\& ev_async async_w;
3809\& thread_t tid;
3810\& cond_t invoke_cv;
3811\& } userdata; 4027\& } userdata;
3812\& 4028\&
3813\& void prepare_loop (EV_P) 4029\& void prepare_loop (EV_P)
3814\& { 4030\& {
3815\& // for simplicity, we use a static userdata struct. 4031\& // for simplicity, we use a static userdata struct.
3816\& static userdata u; 4032\& static userdata u;
3817\& 4033\&
3818\& ev_async_init (&u\->async_w, async_cb); 4034\& ev_async_init (&u.async_w, async_cb);
3819\& ev_async_start (EV_A_ &u\->async_w); 4035\& ev_async_start (EV_A_ &u.async_w);
3820\& 4036\&
3821\& pthread_mutex_init (&u\->lock, 0); 4037\& pthread_mutex_init (&u.lock, 0);
3822\& pthread_cond_init (&u\->invoke_cv, 0); 4038\& pthread_cond_init (&u.invoke_cv, 0);
3823\& 4039\&
3824\& // now associate this with the loop 4040\& // now associate this with the loop
3825\& ev_set_userdata (EV_A_ u); 4041\& ev_set_userdata (EV_A_ &u);
3826\& ev_set_invoke_pending_cb (EV_A_ l_invoke); 4042\& ev_set_invoke_pending_cb (EV_A_ l_invoke);
3827\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 4043\& ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3828\& 4044\&
3829\& // then create the thread running ev_run 4045\& // then create the thread running ev_run
3830\& pthread_create (&u\->tid, 0, l_run, EV_A); 4046\& pthread_create (&u.tid, 0, l_run, EV_A);
3831\& } 4047\& }
3832.Ve 4048.Ve
3833.PP 4049.PP
3834The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used 4050The callback for the \f(CW\*(C`ev_async\*(C'\fR watcher does nothing: the watcher is used
3835solely to wake up the event loop so it takes notice of any new watchers 4051solely to wake up the event loop so it takes notice of any new watchers
3935.PP 4151.PP
3936Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise 4152Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise
3937an event loop currently blocking in the kernel will have no knowledge 4153an event loop currently blocking in the kernel will have no knowledge
3938about the newly added timer. By waking up the loop it will pick up any new 4154about the newly added timer. By waking up the loop it will pick up any new
3939watchers in the next event loop iteration. 4155watchers in the next event loop iteration.
3940.SS "\s-1THREADS\s0, \s-1COROUTINES\s0, \s-1CONTINUATIONS\s0, \s-1QUEUES\s0... \s-1INSTEAD\s0 \s-1OF\s0 \s-1CALLBACKS\s0" 4156.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
3941.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" 4157.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3942While the overhead of a callback that e.g. schedules a thread is small, it 4158While the overhead of a callback that e.g. schedules a thread is small, it
3943is still an overhead. If you embed libev, and your main usage is with some 4159is still an overhead. If you embed libev, and your main usage is with some
3944kind of threads or coroutines, you might want to customise libev so that 4160kind of threads or coroutines, you might want to customise libev so that
3945doesn't need callbacks anymore. 4161doesn't need callbacks anymore.
3967.PP 4183.PP
3968.Vb 6 4184.Vb 6
3969\& void 4185\& void
3970\& wait_for_event (ev_watcher *w) 4186\& wait_for_event (ev_watcher *w)
3971\& { 4187\& {
3972\& ev_cb_set (w) = current_coro; 4188\& ev_set_cb (w, current_coro);
3973\& switch_to (libev_coro); 4189\& switch_to (libev_coro);
3974\& } 4190\& }
3975.Ve 4191.Ve
3976.PP 4192.PP
3977That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and 4193That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and
3981You can do similar tricks if you have, say, threads with an event queue \- 4197You can do similar tricks if you have, say, threads with an event queue \-
3982instead of storing a coroutine, you store the queue object and instead of 4198instead of storing a coroutine, you store the queue object and instead of
3983switching to a coroutine, you push the watcher onto the queue and notify 4199switching to a coroutine, you push the watcher onto the queue and notify
3984any waiters. 4200any waiters.
3985.PP 4201.PP
3986To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two 4202To embed libev, see \*(L"\s-1EMBEDDING\*(R"\s0, but in short, it's easiest to create two
3987files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files: 4203files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
3988.PP 4204.PP
3989.Vb 4 4205.Vb 4
3990\& // my_ev.h 4206\& // my_ev.h
3991\& #define EV_CB_DECLARE(type) struct my_coro *cb; 4207\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3992\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb); 4208\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
3993\& #include "../libev/ev.h" 4209\& #include "../libev/ev.h"
3994\& 4210\&
3995\& // my_ev.c 4211\& // my_ev.c
3996\& #define EV_H "my_ev.h" 4212\& #define EV_H "my_ev.h"
3997\& #include "../libev/ev.c" 4213\& #include "../libev/ev.c"
4030.IP "\(bu" 4 4246.IP "\(bu" 4
4031The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4247The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
4032to use the libev header file and library. 4248to use the libev header file and library.
4033.SH "\*(C+ SUPPORT" 4249.SH "\*(C+ SUPPORT"
4034.IX Header " SUPPORT" 4250.IX Header " SUPPORT"
4251.SS "C \s-1API\s0"
4252.IX Subsection "C API"
4253The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4254libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4255will work fine.
4256.PP
4257Proper exception specifications might have to be added to callbacks passed
4258to libev: exceptions may be thrown only from watcher callbacks, all other
4259callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4260callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4261specification. If you have code that needs to be compiled as both C and
4262\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4263.PP
4264.Vb 6
4265\& static void
4266\& fatal_error (const char *msg) EV_NOEXCEPT
4267\& {
4268\& perror (msg);
4269\& abort ();
4270\& }
4271\&
4272\& ...
4273\& ev_set_syserr_cb (fatal_error);
4274.Ve
4275.PP
4276The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4277\&\f(CW\*(C`ev_invoke\*(C'\fR, \f(CW\*(C`ev_invoke_pending\*(C'\fR and \f(CW\*(C`ev_loop_destroy\*(C'\fR (the latter
4278because it runs cleanup watchers).
4279.PP
4280Throwing exceptions in watcher callbacks is only supported if libev itself
4281is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4282throwing exceptions through C libraries (most do).
4283.SS "\*(C+ \s-1API\s0"
4284.IX Subsection " API"
4035Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4285Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
4036you to use some convenience methods to start/stop watchers and also change 4286you to use some convenience methods to start/stop watchers and also change
4037the callback model to a model using method callbacks on objects. 4287the callback model to a model using method callbacks on objects.
4038.PP 4288.PP
4039To use it, 4289To use it,
4149\& void operator() (ev::io &w, int revents) 4399\& void operator() (ev::io &w, int revents)
4150\& { 4400\& {
4151\& ... 4401\& ...
4152\& } 4402\& }
4153\& } 4403\& }
4154\& 4404\&
4155\& myfunctor f; 4405\& myfunctor f;
4156\& 4406\&
4157\& ev::io w; 4407\& ev::io w;
4158\& w.set (&f); 4408\& w.set (&f);
4159.Ve 4409.Ve
4177.IX Item "w->set (loop)" 4427.IX Item "w->set (loop)"
4178Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4428Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
4179do this when the watcher is inactive (and not pending either). 4429do this when the watcher is inactive (and not pending either).
4180.IP "w\->set ([arguments])" 4 4430.IP "w\->set ([arguments])" 4
4181.IX Item "w->set ([arguments])" 4431.IX Item "w->set ([arguments])"
4182Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4432Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4183method or a suitable start method must be called at least once. Unlike the 4433with the same arguments. Either this method or a suitable start method
4184C counterpart, an active watcher gets automatically stopped and restarted 4434must be called at least once. Unlike the C counterpart, an active watcher
4185when reconfiguring it with this method. 4435gets automatically stopped and restarted when reconfiguring it with this
4436method.
4437.Sp
4438For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4439clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
4440.Sp
4441For \f(CW\*(C`ev::io\*(C'\fR watchers there is an additional \f(CW\*(C`set\*(C'\fR method that acepts a
4442new event mask only, and internally calls \f(CW\*(C`ev_io_modify\*(C'\fR.
4186.IP "w\->start ()" 4 4443.IP "w\->start ()" 4
4187.IX Item "w->start ()" 4444.IX Item "w->start ()"
4188Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4445Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
4189constructor already stores the event loop. 4446constructor already stores the event loop.
4190.IP "w\->start ([arguments])" 4 4447.IP "w\->start ([arguments])" 4
4248there are additional modules that implement libev-compatible interfaces 4505there are additional modules that implement libev-compatible interfaces
4249to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4506to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4250\&\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 4507\&\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
4251and \f(CW\*(C`EV::Glib\*(C'\fR). 4508and \f(CW\*(C`EV::Glib\*(C'\fR).
4252.Sp 4509.Sp
4253It can be found and installed via \s-1CPAN\s0, its homepage is at 4510It can be found and installed via \s-1CPAN,\s0 its homepage is at
4254<http://software.schmorp.de/pkg/EV>. 4511<http://software.schmorp.de/pkg/EV>.
4255.IP "Python" 4 4512.IP "Python" 4
4256.IX Item "Python" 4513.IX Item "Python"
4257Python bindings can be found at <http://code.google.com/p/pyev/>. It 4514Python bindings can be found at <http://code.google.com/p/pyev/>. It
4258seems to be quite complete and well-documented. 4515seems to be quite complete and well-documented.
4266Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR 4523Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
4267makes rev work even on mingw. 4524makes rev work even on mingw.
4268.IP "Haskell" 4 4525.IP "Haskell" 4
4269.IX Item "Haskell" 4526.IX Item "Haskell"
4270A haskell binding to libev is available at 4527A haskell binding to libev is available at
4271http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev <http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4528<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4272.IP "D" 4 4529.IP "D" 4
4273.IX Item "D" 4530.IX Item "D"
4274Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4531Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4275be found at <http://www.llucax.com.ar/proj/ev.d/index.html>. 4532be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4276.IP "Ocaml" 4 4533.IP "Ocaml" 4
4277.IX Item "Ocaml" 4534.IX Item "Ocaml"
4278Erkki Seppala has written Ocaml bindings for libev, to be found at 4535Erkki Seppala has written Ocaml bindings for libev, to be found at
4279http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/ <http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4536<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4280.IP "Lua" 4 4537.IP "Lua" 4
4281.IX Item "Lua" 4538.IX Item "Lua"
4282Brian Maher has written a partial interface to libev for lua (at the 4539Brian Maher has written a partial interface to libev for lua (at the
4283time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at 4540time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4284http://github.com/brimworks/lua\-ev <http://github.com/brimworks/lua-ev>. 4541<http://github.com/brimworks/lua\-ev>.
4542.IP "Javascript" 4
4543.IX Item "Javascript"
4544Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4545.IP "Others" 4
4546.IX Item "Others"
4547There are others, and I stopped counting.
4285.SH "MACRO MAGIC" 4548.SH "MACRO MAGIC"
4286.IX Header "MACRO MAGIC" 4549.IX Header "MACRO MAGIC"
4287Libev can be compiled with a variety of options, the most fundamental 4550Libev can be compiled with a variety of options, the most fundamental
4288of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4551of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
4289functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4552functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
4372.SS "\s-1FILESETS\s0" 4635.SS "\s-1FILESETS\s0"
4373.IX Subsection "FILESETS" 4636.IX Subsection "FILESETS"
4374Depending on what features you need you need to include one or more sets of files 4637Depending on what features you need you need to include one or more sets of files
4375in your application. 4638in your application.
4376.PP 4639.PP
4377\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4640\fI\s-1CORE EVENT LOOP\s0\fR
4378.IX Subsection "CORE EVENT LOOP" 4641.IX Subsection "CORE EVENT LOOP"
4379.PP 4642.PP
4380To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4643To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
4381configuration (no autoconf): 4644configuration (no autoconf):
4382.PP 4645.PP
4409\& ev_vars.h 4672\& ev_vars.h
4410\& ev_wrap.h 4673\& ev_wrap.h
4411\& 4674\&
4412\& ev_win32.c required on win32 platforms only 4675\& ev_win32.c required on win32 platforms only
4413\& 4676\&
4414\& ev_select.c only when select backend is enabled (which is enabled by default) 4677\& ev_select.c only when select backend is enabled
4415\& ev_poll.c only when poll backend is enabled (disabled by default) 4678\& ev_poll.c only when poll backend is enabled
4416\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4679\& ev_epoll.c only when the epoll backend is enabled
4680\& ev_linuxaio.c only when the linux aio backend is enabled
4681\& ev_iouring.c only when the linux io_uring backend is enabled
4417\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4682\& ev_kqueue.c only when the kqueue backend is enabled
4418\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4683\& ev_port.c only when the solaris port backend is enabled
4419.Ve 4684.Ve
4420.PP 4685.PP
4421\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4686\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4422to compile this single file. 4687to compile this single file.
4423.PP 4688.PP
4424\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4689\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4425.IX Subsection "LIBEVENT COMPATIBILITY API" 4690.IX Subsection "LIBEVENT COMPATIBILITY API"
4426.PP 4691.PP
4427To include the libevent compatibility \s-1API\s0, also include: 4692To include the libevent compatibility \s-1API,\s0 also include:
4428.PP 4693.PP
4429.Vb 1 4694.Vb 1
4430\& #include "event.c" 4695\& #include "event.c"
4431.Ve 4696.Ve
4432.PP 4697.PP
4434.PP 4699.PP
4435.Vb 1 4700.Vb 1
4436\& #include "event.h" 4701\& #include "event.h"
4437.Ve 4702.Ve
4438.PP 4703.PP
4439in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4704in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4440.PP 4705.PP
4441You need the following additional files for this: 4706You need the following additional files for this:
4442.PP 4707.PP
4443.Vb 2 4708.Vb 2
4444\& event.h 4709\& event.h
4445\& event.c 4710\& event.c
4446.Ve 4711.Ve
4447.PP 4712.PP
4448\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4713\fI\s-1AUTOCONF SUPPORT\s0\fR
4449.IX Subsection "AUTOCONF SUPPORT" 4714.IX Subsection "AUTOCONF SUPPORT"
4450.PP 4715.PP
4451Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4716Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
4452whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4717whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
4453\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4718\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
4456For this of course you need the m4 file: 4721For this of course you need the m4 file:
4457.PP 4722.PP
4458.Vb 1 4723.Vb 1
4459\& libev.m4 4724\& libev.m4
4460.Ve 4725.Ve
4461.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4726.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
4462.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4727.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
4463Libev can be configured via a variety of preprocessor symbols you have to 4728Libev can be configured via a variety of preprocessor symbols you have to
4464define before including (or compiling) any of its files. The default in 4729define before including (or compiling) any of its files. The default in
4465the absence of autoconf is documented for every option. 4730the absence of autoconf is documented for every option.
4466.PP 4731.PP
4467Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4732Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4468values when compiling libev vs. including \fIev.h\fR, so it is permissible 4733values when compiling libev vs. including \fIev.h\fR, so it is permissible
4469to redefine them before including \fIev.h\fR without breaking compatibility 4734to redefine them before including \fIev.h\fR without breaking compatibility
4470to a compiled library. All other symbols change the \s-1ABI\s0, which means all 4735to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4471users of libev and the libev code itself must be compiled with compatible 4736users of libev and the libev code itself must be compiled with compatible
4472settings. 4737settings.
4473.IP "\s-1EV_COMPAT3\s0 (h)" 4 4738.IP "\s-1EV_COMPAT3\s0 (h)" 4
4474.IX Item "EV_COMPAT3 (h)" 4739.IX Item "EV_COMPAT3 (h)"
4475Backwards compatibility is a major concern for libev. This is why this 4740Backwards compatibility is a major concern for libev. This is why this
4541If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is 4806If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4542available and will probe for kernel support at runtime. This will improve 4807available and will probe for kernel support at runtime. This will improve
4543\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption. 4808\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4544If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4809If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
45452.7 or newer, otherwise disabled. 48102.7 or newer, otherwise disabled.
4811.IP "\s-1EV_USE_SIGNALFD\s0" 4
4812.IX Item "EV_USE_SIGNALFD"
4813If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`signalfd ()\*(C'\fR is
4814available and will probe for kernel support at runtime. This enables
4815the use of \s-1EVFLAG_SIGNALFD\s0 for faster and simpler signal handling. If
4816undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
48172.7 or newer, otherwise disabled.
4818.IP "\s-1EV_USE_TIMERFD\s0" 4
4819.IX Item "EV_USE_TIMERFD"
4820If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`timerfd ()\*(C'\fR is
4821available and will probe for kernel support at runtime. This allows
4822libev to detect time jumps accurately. If undefined, it will be enabled
4823if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4824\&\f(CW\*(C`TFD_TIMER_CANCEL_ON_SET\*(C'\fR, otherwise disabled.
4825.IP "\s-1EV_USE_EVENTFD\s0" 4
4826.IX Item "EV_USE_EVENTFD"
4827If defined to be \f(CW1\fR, then libev will assume that \f(CW\*(C`eventfd ()\*(C'\fR is
4828available and will probe for kernel support at runtime. This will improve
4829\&\f(CW\*(C`ev_signal\*(C'\fR and \f(CW\*(C`ev_async\*(C'\fR performance and reduce resource consumption.
4830If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
48312.7 or newer, otherwise disabled.
4546.IP "\s-1EV_USE_SELECT\s0" 4 4832.IP "\s-1EV_USE_SELECT\s0" 4
4547.IX Item "EV_USE_SELECT" 4833.IX Item "EV_USE_SELECT"
4548If undefined or defined to be \f(CW1\fR, libev will compile in support for the 4834If undefined or defined to be \f(CW1\fR, libev will compile in support for the
4549\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no 4835\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at auto-detection will be done: if no
4550other method takes over, select will be it. Otherwise the select backend 4836other method takes over, select will be it. Otherwise the select backend
4584.IX Item "EV_WIN32_CLOSE_FD(fd)" 4870.IX Item "EV_WIN32_CLOSE_FD(fd)"
4585If programs implement their own fd to handle mapping on win32, then this 4871If programs implement their own fd to handle mapping on win32, then this
4586macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister 4872macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4587file descriptors again. Note that the replacement function has to close 4873file descriptors again. Note that the replacement function has to close
4588the underlying \s-1OS\s0 handle. 4874the underlying \s-1OS\s0 handle.
4875.IP "\s-1EV_USE_WSASOCKET\s0" 4
4876.IX Item "EV_USE_WSASOCKET"
4877If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4878communication socket, which works better in some environments. Otherwise,
4879the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4880environments.
4589.IP "\s-1EV_USE_POLL\s0" 4 4881.IP "\s-1EV_USE_POLL\s0" 4
4590.IX Item "EV_USE_POLL" 4882.IX Item "EV_USE_POLL"
4591If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4883If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
4592backend. Otherwise it will be enabled on non\-win32 platforms. It 4884backend. Otherwise it will be enabled on non\-win32 platforms. It
4593takes precedence over select. 4885takes precedence over select.
4596If defined to be \f(CW1\fR, libev will compile in support for the Linux 4888If defined to be \f(CW1\fR, libev will compile in support for the Linux
4597\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime, 4889\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
4598otherwise another method will be used as fallback. This is the preferred 4890otherwise another method will be used as fallback. This is the preferred
4599backend for GNU/Linux systems. If undefined, it will be enabled if the 4891backend for GNU/Linux systems. If undefined, it will be enabled if the
4600headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4892headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4893.IP "\s-1EV_USE_LINUXAIO\s0" 4
4894.IX Item "EV_USE_LINUXAIO"
4895If defined to be \f(CW1\fR, libev will compile in support for the Linux aio
4896backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). If undefined, it will be
4897enabled on linux, otherwise disabled.
4898.IP "\s-1EV_USE_IOURING\s0" 4
4899.IX Item "EV_USE_IOURING"
4900If defined to be \f(CW1\fR, libev will compile in support for the Linux
4901io_uring backend (\f(CW\*(C`EV_USE_EPOLL\*(C'\fR must also be enabled). Due to it's
4902current limitations it has to be requested explicitly. If undefined, it
4903will be enabled on linux, otherwise disabled.
4601.IP "\s-1EV_USE_KQUEUE\s0" 4 4904.IP "\s-1EV_USE_KQUEUE\s0" 4
4602.IX Item "EV_USE_KQUEUE" 4905.IX Item "EV_USE_KQUEUE"
4603If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style 4906If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
4604\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime, 4907\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
4605otherwise another method will be used as fallback. This is the preferred 4908otherwise another method will be used as fallback. This is the preferred
4630between threads, that is, threads can be used, but threads never run on 4933between threads, that is, threads can be used, but threads never run on
4631different cpus (or different cpu cores). This reduces dependencies 4934different cpus (or different cpu cores). This reduces dependencies
4632and makes libev faster. 4935and makes libev faster.
4633.IP "\s-1EV_NO_THREADS\s0" 4 4936.IP "\s-1EV_NO_THREADS\s0" 4
4634.IX Item "EV_NO_THREADS" 4937.IX Item "EV_NO_THREADS"
4635If defined to be \f(CW1\fR, libev will assume that it will never be called 4938If defined to be \f(CW1\fR, libev will assume that it will never be called from
4636from different threads, which is a stronger assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, 4939different threads (that includes signal handlers), which is a stronger
4637above. This reduces dependencies and makes libev faster. 4940assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4941libev faster.
4638.IP "\s-1EV_ATOMIC_T\s0" 4 4942.IP "\s-1EV_ATOMIC_T\s0" 4
4639.IX Item "EV_ATOMIC_T" 4943.IX Item "EV_ATOMIC_T"
4640Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4944Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4641access is atomic and serialised with respect to other threads or signal 4945access is atomic with respect to other threads or signal contexts. No
4642contexts. No such type is easily found in the C language, so you can 4946such type is easily found in the C language, so you can provide your own
4643provide your own type that you know is safe for your purposes. It is used 4947type that you know is safe for your purposes. It is used both for signal
4644both for signal handler \*(L"locking\*(R" as well as for signal and thread safety 4948handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4645in \f(CW\*(C`ev_async\*(C'\fR watchers. 4949watchers.
4646.Sp 4950.Sp
4647In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4951In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4648(from \fIsignal.h\fR), which is usually good enough on most platforms, 4952(from \fIsignal.h\fR), which is usually good enough on most platforms.
4649although strictly speaking using a type that also implies a memory fence
4650is required.
4651.IP "\s-1EV_H\s0 (h)" 4 4953.IP "\s-1EV_H\s0 (h)" 4
4652.IX Item "EV_H (h)" 4954.IX Item "EV_H (h)"
4653The name of the \fIev.h\fR header file used to include it. The default if 4955The name of the \fIev.h\fR header file used to include it. The default if
4654undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4956undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
4655used to virtually rename the \fIev.h\fR header file in case of conflicts. 4957used to virtually rename the \fIev.h\fR header file in case of conflicts.
4694all the priorities, so having many of them (hundreds) uses a lot of space 4996all the priorities, so having many of them (hundreds) uses a lot of space
4695and time, so using the defaults of five priorities (\-2 .. +2) is usually 4997and time, so using the defaults of five priorities (\-2 .. +2) is usually
4696fine. 4998fine.
4697.Sp 4999.Sp
4698If your embedding application does not need any priorities, defining these 5000If your embedding application does not need any priorities, defining these
4699both to \f(CW0\fR will save some memory and \s-1CPU\s0. 5001both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4700.IP "\s-1EV_PERIODIC_ENABLE\s0, \s-1EV_IDLE_ENABLE\s0, \s-1EV_EMBED_ENABLE\s0, \s-1EV_STAT_ENABLE\s0, \s-1EV_PREPARE_ENABLE\s0, \s-1EV_CHECK_ENABLE\s0, \s-1EV_FORK_ENABLE\s0, \s-1EV_SIGNAL_ENABLE\s0, \s-1EV_ASYNC_ENABLE\s0, \s-1EV_CHILD_ENABLE\s0." 4 5002.IP "\s-1EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE.\s0" 4
4701.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE." 5003.IX Item "EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, EV_ASYNC_ENABLE, EV_CHILD_ENABLE."
4702If undefined or defined to be \f(CW1\fR (and the platform supports it), then 5004If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4703the respective watcher type is supported. If defined to be \f(CW0\fR, then it 5005the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4704is not. Disabling watcher types mainly saves code size. 5006is not. Disabling watcher types mainly saves code size.
4705.IP "\s-1EV_FEATURES\s0" 4 5007.IP "\s-1EV_FEATURES\s0" 4
4722\& #define EV_CHILD_ENABLE 1 5024\& #define EV_CHILD_ENABLE 1
4723\& #define EV_ASYNC_ENABLE 1 5025\& #define EV_ASYNC_ENABLE 1
4724.Ve 5026.Ve
4725.Sp 5027.Sp
4726The actual value is a bitset, it can be a combination of the following 5028The actual value is a bitset, it can be a combination of the following
4727values: 5029values (by default, all of these are enabled):
4728.RS 4 5030.RS 4
4729.ie n .IP "1 \- faster/larger code" 4 5031.ie n .IP "1 \- faster/larger code" 4
4730.el .IP "\f(CW1\fR \- faster/larger code" 4 5032.el .IP "\f(CW1\fR \- faster/larger code" 4
4731.IX Item "1 - faster/larger code" 5033.IX Item "1 - faster/larger code"
4732Use larger code to speed up some operations. 5034Use larger code to speed up some operations.
4735code size by roughly 30% on amd64). 5037code size by roughly 30% on amd64).
4736.Sp 5038.Sp
4737When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with 5039When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4738gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of 5040gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4739assertions. 5041assertions.
5042.Sp
5043The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
5044(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4740.ie n .IP "2 \- faster/larger data structures" 4 5045.ie n .IP "2 \- faster/larger data structures" 4
4741.el .IP "\f(CW2\fR \- faster/larger data structures" 4 5046.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4742.IX Item "2 - faster/larger data structures" 5047.IX Item "2 - faster/larger data structures"
4743Replaces the small 2\-heap for timer management by a faster 4\-heap, larger 5048Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4744hash table sizes and so on. This will usually further increase code size 5049hash table sizes and so on. This will usually further increase code size
4745and can additionally have an effect on the size of data structures at 5050and can additionally have an effect on the size of data structures at
4746runtime. 5051runtime.
5052.Sp
5053The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
5054(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4747.ie n .IP "4 \- full \s-1API\s0 configuration" 4 5055.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4748.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 5056.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4749.IX Item "4 - full API configuration" 5057.IX Item "4 - full API configuration"
4750This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and 5058This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4751enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). 5059enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4857called. If set to \f(CW2\fR, then the internal verification code will be 5165called. If set to \f(CW2\fR, then the internal verification code will be
4858called once per loop, which can slow down libev. If set to \f(CW3\fR, then the 5166called once per loop, which can slow down libev. If set to \f(CW3\fR, then the
4859verification code will be called very frequently, which will slow down 5167verification code will be called very frequently, which will slow down
4860libev considerably. 5168libev considerably.
4861.Sp 5169.Sp
5170Verification errors are reported via C's \f(CW\*(C`assert\*(C'\fR mechanism, so if you
5171disable that (e.g. by defining \f(CW\*(C`NDEBUG\*(C'\fR) then no errors will be reported.
5172.Sp
4862The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it 5173The default is \f(CW1\fR, unless \f(CW\*(C`EV_FEATURES\*(C'\fR overrides it, in which case it
4863will be \f(CW0\fR. 5174will be \f(CW0\fR.
4864.IP "\s-1EV_COMMON\s0" 4 5175.IP "\s-1EV_COMMON\s0" 4
4865.IX Item "EV_COMMON" 5176.IX Item "EV_COMMON"
4866By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining 5177By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR member. By redefining
4887and the way callbacks are invoked and set. Must expand to a struct member 5198and the way callbacks are invoked and set. Must expand to a struct member
4888definition and a statement, respectively. See the \fIev.h\fR header file for 5199definition and a statement, respectively. See the \fIev.h\fR header file for
4889their default definitions. One possible use for overriding these is to 5200their default definitions. One possible use for overriding these is to
4890avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5201avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
4891method calls instead of plain function calls in \*(C+. 5202method calls instead of plain function calls in \*(C+.
4892.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5203.SS "\s-1EXPORTED API SYMBOLS\s0"
4893.IX Subsection "EXPORTED API SYMBOLS" 5204.IX Subsection "EXPORTED API SYMBOLS"
4894If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5205If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
4895exported symbols, you can use the provided \fISymbol.*\fR files which list 5206exported symbols, you can use the provided \fISymbol.*\fR files which list
4896all public symbols, one per line: 5207all public symbols, one per line:
4897.PP 5208.PP
4951\& #include "ev_cpp.h" 5262\& #include "ev_cpp.h"
4952\& #include "ev.c" 5263\& #include "ev.c"
4953.Ve 5264.Ve
4954.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5265.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4955.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5266.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4956.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5267.SS "\s-1THREADS AND COROUTINES\s0"
4957.IX Subsection "THREADS AND COROUTINES" 5268.IX Subsection "THREADS AND COROUTINES"
4958\fI\s-1THREADS\s0\fR 5269\fI\s-1THREADS\s0\fR
4959.IX Subsection "THREADS" 5270.IX Subsection "THREADS"
4960.PP 5271.PP
4961All libev functions are reentrant and thread-safe unless explicitly 5272All libev functions are reentrant and thread-safe unless explicitly
5007An example use would be to communicate signals or other events that only 5318An example use would be to communicate signals or other events that only
5008work in the default loop by registering the signal watcher with the 5319work in the default loop by registering the signal watcher with the
5009default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5320default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
5010watcher callback into the event loop interested in the signal. 5321watcher callback into the event loop interested in the signal.
5011.PP 5322.PP
5012See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R". 5323See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
5013.PP 5324.PP
5014\fI\s-1COROUTINES\s0\fR 5325\fI\s-1COROUTINES\s0\fR
5015.IX Subsection "COROUTINES" 5326.IX Subsection "COROUTINES"
5016.PP 5327.PP
5017Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5328Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
5022that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5333that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
5023.PP 5334.PP
5024Care has been taken to ensure that libev does not keep local state inside 5335Care has been taken to ensure that libev does not keep local state inside
5025\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as 5336\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
5026they do not call any callbacks. 5337they do not call any callbacks.
5027.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5338.SS "\s-1COMPILER WARNINGS\s0"
5028.IX Subsection "COMPILER WARNINGS" 5339.IX Subsection "COMPILER WARNINGS"
5029Depending on your compiler and compiler settings, you might get no or a 5340Depending on your compiler and compiler settings, you might get no or a
5030lot of warnings when compiling libev code. Some people are apparently 5341lot of warnings when compiling libev code. Some people are apparently
5031scared by this. 5342scared by this.
5032.PP 5343.PP
5084.PP 5395.PP
5085If you need, for some reason, empty reports from valgrind for your project 5396If you need, for some reason, empty reports from valgrind for your project
5086I suggest using suppression lists. 5397I suggest using suppression lists.
5087.SH "PORTABILITY NOTES" 5398.SH "PORTABILITY NOTES"
5088.IX Header "PORTABILITY NOTES" 5399.IX Header "PORTABILITY NOTES"
5089.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5400.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
5090.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5401.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
5091GNU/Linux is the only common platform that supports 64 bit file/large file 5402GNU/Linux is the only common platform that supports 64 bit file/large file
5092interfaces but \fIdisables\fR them by default. 5403interfaces but \fIdisables\fR them by default.
5093.PP 5404.PP
5094That means that libev compiled in the default environment doesn't support 5405That means that libev compiled in the default environment doesn't support
5095files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. 5406files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
5096.PP 5407.PP
5097Unfortunately, many programs try to work around this GNU/Linux issue 5408Unfortunately, many programs try to work around this GNU/Linux issue
5098by enabling the large file \s-1API\s0, which makes them incompatible with the 5409by enabling the large file \s-1API,\s0 which makes them incompatible with the
5099standard libev compiled for their system. 5410standard libev compiled for their system.
5100.PP 5411.PP
5101Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5412Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
5102suddenly make it incompatible to the default compile time environment, 5413suddenly make it incompatible to the default compile time environment,
5103i.e. all programs not using special compile switches. 5414i.e. all programs not using special compile switches.
5104.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5415.SS "\s-1OS/X AND DARWIN BUGS\s0"
5105.IX Subsection "OS/X AND DARWIN BUGS" 5416.IX Subsection "OS/X AND DARWIN BUGS"
5106The whole thing is a bug if you ask me \- basically any system interface 5417The whole thing is a bug if you ask me \- basically any system interface
5107you touch is broken, whether it is locales, poll, kqueue or even the 5418you touch is broken, whether it is locales, poll, kqueue or even the
5108OpenGL drivers. 5419OpenGL drivers.
5109.PP 5420.PP
5131.PP 5442.PP
5132\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5443\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5133.IX Subsection "select is buggy" 5444.IX Subsection "select is buggy"
5134.PP 5445.PP
5135All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5446All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5136one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file 5447one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
5137descriptors you can pass in to 1024 \- your program suddenly crashes when 5448descriptors you can pass in to 1024 \- your program suddenly crashes when
5138you use more. 5449you use more.
5139.PP 5450.PP
5140There is an undocumented \*(L"workaround\*(R" for this \- defining 5451There is an undocumented \*(L"workaround\*(R" for this \- defining
5141\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5452\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
5142work on \s-1OS/X\s0. 5453work on \s-1OS/X.\s0
5143.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5454.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
5144.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5455.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
5145\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5456\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
5146.IX Subsection "errno reentrancy" 5457.IX Subsection "errno reentrancy"
5147.PP 5458.PP
5148The default compile environment on Solaris is unfortunately so 5459The default compile environment on Solaris is unfortunately so
5165great. 5476great.
5166.PP 5477.PP
5167If you can't get it to work, you can try running the program by setting 5478If you can't get it to work, you can try running the program by setting
5168the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and 5479the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
5169\&\f(CW\*(C`select\*(C'\fR backends. 5480\&\f(CW\*(C`select\*(C'\fR backends.
5170.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5481.SS "\s-1AIX POLL BUG\s0"
5171.IX Subsection "AIX POLL BUG" 5482.IX Subsection "AIX POLL BUG"
5172\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5483\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
5173this by trying to avoid the poll backend altogether (i.e. it's not even 5484this by trying to avoid the poll backend altogether (i.e. it's not even
5174compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine 5485compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
5175with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. 5486with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
5176.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5487.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
5177.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5488.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
5178\fIGeneral issues\fR 5489\fIGeneral issues\fR
5179.IX Subsection "General issues" 5490.IX Subsection "General issues"
5180.PP 5491.PP
5181Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5492Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
5250\& #define EV_USE_SELECT 1 5561\& #define EV_USE_SELECT 1
5251\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5562\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5252.Ve 5563.Ve
5253.PP 5564.PP
5254Note that winsockets handling of fd sets is O(n), so you can easily get a 5565Note that winsockets handling of fd sets is O(n), so you can easily get a
5255complexity in the O(nA\*^X) range when using win32. 5566complexity in the O(nX) range when using win32.
5256.PP 5567.PP
5257\fILimited number of file descriptors\fR 5568\fILimited number of file descriptors\fR
5258.IX Subsection "Limited number of file descriptors" 5569.IX Subsection "Limited number of file descriptors"
5259.PP 5570.PP
5260Windows has numerous arbitrary (and low) limits on things. 5571Windows has numerous arbitrary (and low) limits on things.
5276by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5587by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5277(another arbitrary limit), but is broken in many versions of the Microsoft 5588(another arbitrary limit), but is broken in many versions of the Microsoft
5278runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5589runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5279(depending on windows version and/or the phase of the moon). To get more, 5590(depending on windows version and/or the phase of the moon). To get more,
5280you need to wrap all I/O functions and provide your own fd management, but 5591you need to wrap all I/O functions and provide your own fd management, but
5281the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5592the cost of calling select (O(nX)) will likely make this unworkable.
5282.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5593.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5283.IX Subsection "PORTABILITY REQUIREMENTS" 5594.IX Subsection "PORTABILITY REQUIREMENTS"
5284In addition to a working ISO-C implementation and of course the 5595In addition to a working ISO-C implementation and of course the
5285backend-specific APIs, libev relies on a few additional extensions: 5596backend-specific APIs, libev relies on a few additional extensions:
5286.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5597.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5287.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5598.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5288.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5599.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5289Libev assumes not only that all watcher pointers have the same internal 5600Libev assumes not only that all watcher pointers have the same internal
5290structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5601structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5291assumes that the same (machine) code can be used to call any watcher 5602assumes that the same (machine) code can be used to call any watcher
5292callback: The watcher callbacks have different type signatures, but libev 5603callback: The watcher callbacks have different type signatures, but libev
5293calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5604calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5605.IP "null pointers and integer zero are represented by 0 bytes" 4
5606.IX Item "null pointers and integer zero are represented by 0 bytes"
5607Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5608relies on this setting pointers and integers to null.
5294.IP "pointer accesses must be thread-atomic" 4 5609.IP "pointer accesses must be thread-atomic" 4
5295.IX Item "pointer accesses must be thread-atomic" 5610.IX Item "pointer accesses must be thread-atomic"
5296Accessing a pointer value must be atomic, it must both be readable and 5611Accessing a pointer value must be atomic, it must both be readable and
5297writable in one piece \- this is the case on all current architectures. 5612writable in one piece \- this is the case on all current architectures.
5298.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5613.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
5311thread\*(R" or will block signals process-wide, both behaviours would 5626thread\*(R" or will block signals process-wide, both behaviours would
5312be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5627be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5313\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5628\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5314.Sp 5629.Sp
5315The most portable way to handle signals is to block signals in all threads 5630The most portable way to handle signals is to block signals in all threads
5316except the initial one, and run the default loop in the initial thread as 5631except the initial one, and run the signal handling loop in the initial
5317well. 5632thread as well.
5318.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5633.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5319.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5634.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5320.IX Item "long must be large enough for common memory allocation sizes" 5635.IX Item "long must be large enough for common memory allocation sizes"
5321To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5636To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5322instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5637instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5323systems (Microsoft...) this might be unexpectedly low, but is still at 5638systems (Microsoft...) this might be unexpectedly low, but is still at
5324least 31 bits everywhere, which is enough for hundreds of millions of 5639least 31 bits everywhere, which is enough for hundreds of millions of
5325watchers. 5640watchers.
5326.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5641.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5328.IX Item "double must hold a time value in seconds with enough accuracy" 5643.IX Item "double must hold a time value in seconds with enough accuracy"
5329The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5644The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5330have at least 51 bits of mantissa (and 9 bits of exponent), which is 5645have at least 51 bits of mantissa (and 9 bits of exponent), which is
5331good enough for at least into the year 4000 with millisecond accuracy 5646good enough for at least into the year 4000 with millisecond accuracy
5332(the design goal for libev). This requirement is overfulfilled by 5647(the design goal for libev). This requirement is overfulfilled by
5333implementations using \s-1IEEE\s0 754, which is basically all existing ones. 5648implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5334.Sp 5649.Sp
5335With \s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least the 5650With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5336year 2255 (and millisecond accuracy till the year 287396 \- by then, libev 5651year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5337is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or 5652is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5338something like that, just kidding). 5653something like that, just kidding).
5339.PP 5654.PP
5340If you know of other additional requirements drop me a note. 5655If you know of other additional requirements drop me a note.
5402calls in the current loop iteration and the loop is currently 5717calls in the current loop iteration and the loop is currently
5403blocked. Checking for async and signal events involves iterating over all 5718blocked. Checking for async and signal events involves iterating over all
5404running async watchers or all signal numbers. 5719running async watchers or all signal numbers.
5405.SH "PORTING FROM LIBEV 3.X TO 4.X" 5720.SH "PORTING FROM LIBEV 3.X TO 4.X"
5406.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5721.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5407The major version 4 introduced some incompatible changes to the \s-1API\s0. 5722The major version 4 introduced some incompatible changes to the \s-1API.\s0
5408.PP 5723.PP
5409At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5724At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5410for all changes, so most programs should still compile. The compatibility 5725for all changes, so most programs should still compile. The compatibility
5411layer might be removed in later versions of libev, so better update to the 5726layer might be removed in later versions of libev, so better update to the
5412new \s-1API\s0 early than late. 5727new \s-1API\s0 early than late.
5413.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5728.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5414.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5729.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5415.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5730.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5416The backward compatibility mechanism can be controlled by 5731The backward compatibility mechanism can be controlled by
5417\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1MACROS\s0\*(R" in \s-1PREPROCESSOR\s0 \s-1SYMBOLS\s0 in the \s-1EMBEDDING\s0 5732\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5418section. 5733section.
5419.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5734.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5420.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 5735.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5421.IX Item "ev_default_destroy and ev_default_fork have been removed" 5736.IX Item "ev_default_destroy and ev_default_fork have been removed"
5422These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: 5737These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5462.SH "GLOSSARY" 5777.SH "GLOSSARY"
5463.IX Header "GLOSSARY" 5778.IX Header "GLOSSARY"
5464.IP "active" 4 5779.IP "active" 4
5465.IX Item "active" 5780.IX Item "active"
5466A watcher is active as long as it has been started and not yet stopped. 5781A watcher is active as long as it has been started and not yet stopped.
5467See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5782See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5468.IP "application" 4 5783.IP "application" 4
5469.IX Item "application" 5784.IX Item "application"
5470In this document, an application is whatever is using libev. 5785In this document, an application is whatever is using libev.
5471.IP "backend" 4 5786.IP "backend" 4
5472.IX Item "backend" 5787.IX Item "backend"
5499The model used to describe how an event loop handles and processes 5814The model used to describe how an event loop handles and processes
5500watchers and events. 5815watchers and events.
5501.IP "pending" 4 5816.IP "pending" 4
5502.IX Item "pending" 5817.IX Item "pending"
5503A watcher is pending as soon as the corresponding event has been 5818A watcher is pending as soon as the corresponding event has been
5504detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5819detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5505.IP "real time" 4 5820.IP "real time" 4
5506.IX Item "real time" 5821.IX Item "real time"
5507The physical time that is observed. It is apparently strictly monotonic :) 5822The physical time that is observed. It is apparently strictly monotonic :)
5508.IP "wall-clock time" 4 5823.IP "wall-clock time" 4
5509.IX Item "wall-clock time" 5824.IX Item "wall-clock time"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines