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

Comparing libev/ev.3 (file contents):
Revision 1.88 by root, Sat Feb 4 18:55:50 2012 UTC vs.
Revision 1.110 by root, Thu Jun 20 22:44:59 2019 UTC

1.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) 1.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
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-02-04" "libev-4.11" "libev - high performance full featured event loop" 136.TH LIBEV 3 "2019-06-20" "libev-4.25" "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.
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
367current system. To find which embeddable backends might be supported on 376current 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 () 377the current system, you would need to look at \f(CW\*(C`ev_embeddable_backends ()
369& ev_supported_backends ()\*(C'\fR, likewise for recommended ones. 378& ev_supported_backends ()\*(C'\fR, likewise for recommended ones.
370.Sp 379.Sp
371See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info. 380See 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 381.IP "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())" 4
373.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))" 382.IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())"
374Sets the allocation function to use (the prototype is similar \- the 383Sets 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 384semantics 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 385used 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 386when memory needs to be allocated (\f(CW\*(C`size != 0\*(C'\fR), the library might abort
378or take some potentially destructive action. 387or take some potentially destructive action.
383.Sp 392.Sp
384You could override this function in high-availability programs to, say, 393You could override this function in high-availability programs to, say,
385free some memory if it cannot allocate memory, to use a special allocator, 394free 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. 395or even to sleep a while and retry until some memory is available.
387.Sp 396.Sp
397Example: The following is the \f(CW\*(C`realloc\*(C'\fR function that libev itself uses
398which should work with \f(CW\*(C`realloc\*(C'\fR and \f(CW\*(C`free\*(C'\fR functions of all kinds and
399is probably a good basis for your own implementation.
400.Sp
401.Vb 5
402\& static void *
403\& ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
404\& {
405\& if (size)
406\& return realloc (ptr, size);
407\&
408\& free (ptr);
409\& return 0;
410\& }
411.Ve
412.Sp
388Example: Replace the libev allocator with one that waits a bit and then 413Example: Replace the libev allocator with one that waits a bit and then
389retries (example requires a standards-compliant \f(CW\*(C`realloc\*(C'\fR). 414retries.
390.Sp 415.Sp
391.Vb 6 416.Vb 8
392\& static void * 417\& static void *
393\& persistent_realloc (void *ptr, size_t size) 418\& persistent_realloc (void *ptr, size_t size)
394\& { 419\& {
420\& if (!size)
421\& {
422\& free (ptr);
423\& return 0;
424\& }
425\&
395\& for (;;) 426\& for (;;)
396\& { 427\& {
397\& void *newptr = realloc (ptr, size); 428\& void *newptr = realloc (ptr, size);
398\& 429\&
399\& if (newptr) 430\& if (newptr)
404\& } 435\& }
405\& 436\&
406\& ... 437\& ...
407\& ev_set_allocator (persistent_realloc); 438\& ev_set_allocator (persistent_realloc);
408.Ve 439.Ve
409.IP "ev_set_syserr_cb (void (*cb)(const char *msg))" 4 440.IP "ev_set_syserr_cb (void (*cb)(const char *msg) throw ())" 4
410.IX Item "ev_set_syserr_cb (void (*cb)(const char *msg))" 441.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 442Set the callback function to call on a retryable system call error (such
412as failed select, poll, epoll_wait). The message is a printable string 443as failed select, poll, epoll_wait). The message is a printable string
413indicating the system call or subsystem causing the problem. If this 444indicating the system call or subsystem causing the problem. If this
414callback is set, then libev will expect it to remedy the situation, no 445callback is set, then libev will expect it to remedy the situation, no
415matter what, when it returns. That is, libev will generally retry the 446matter what, when it returns. That is, libev will generally retry the
514.IX Item "EVFLAG_NOENV" 545.IX Item "EVFLAG_NOENV"
515If this flag bit is or'ed into the flag value (or the program runs setuid 546If 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 547or 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 548\&\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 549override 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 550useful to try out specific backends to test their performance, to work
520around bugs. 551around bugs, or to make libev threadsafe (accessing environment variables
552cannot be done in a threadsafe way, but usually it works if no other
553thread modifies them).
521.ie n .IP """EVFLAG_FORKCHECK""" 4 554.ie n .IP """EVFLAG_FORKCHECK""" 4
522.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4 555.el .IP "\f(CWEVFLAG_FORKCHECK\fR" 4
523.IX Item "EVFLAG_FORKCHECK" 556.IX Item "EVFLAG_FORKCHECK"
524Instead of calling \f(CW\*(C`ev_loop_fork\*(C'\fR manually after a fork, you can also 557Instead 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. 558make libev check for a fork in each iteration by enabling this flag.
526.Sp 559.Sp
527This works by calling \f(CW\*(C`getpid ()\*(C'\fR on every iteration of the loop, 560This 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 561and 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 562iterations 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 563GNU/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 564sequence 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). 565system also has \f(CW\*(C`pthread_atfork\*(C'\fR which is even faster). (Update: glibc
566versions 2.25 apparently removed the \f(CW\*(C`getpid\*(C'\fR optimisation again).
533.Sp 567.Sp
534The big advantage of this flag is that you can forget about fork (and 568The 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 569forget about forgetting to tell libev about forking, although you still
536flag. 570have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR) when you use this flag.
537.Sp 571.Sp
538This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR 572This flag setting cannot be overridden or specified in the \f(CW\*(C`LIBEV_FLAGS\*(C'\fR
539environment variable. 573environment variable.
540.ie n .IP """EVFLAG_NOINOTIFY""" 4 574.ie n .IP """EVFLAG_NOINOTIFY""" 4
541.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4 575.el .IP "\f(CWEVFLAG_NOINOTIFY\fR" 4
572\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified. 606\&\f(CW\*(C`sigprocmask\*(C'\fR, whose behaviour is officially unspecified.
573.Sp 607.Sp
574This flag's behaviour will become the default in future versions of libev. 608This flag's behaviour will become the default in future versions of libev.
575.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4 609.ie n .IP """EVBACKEND_SELECT"" (value 1, portable select backend)" 4
576.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4 610.el .IP "\f(CWEVBACKEND_SELECT\fR (value 1, portable select backend)" 4
577.IX Item "EVBACKEND_SELECT (value 1, portable select backend)" 611.IX Item "EVBACKEND_SELECT (value 1, portable select backend)"
578This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as 612This 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, 613libev 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 614but 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 615using 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. 616usually the fastest backend for a low number of (low-numbered :) fds.
583.Sp 617.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 625This 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 626\&\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). 627\&\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 628.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 629.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)" 630.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 631And this is your standard \fBpoll\fR\|(2) backend. It's more complicated
598than select, but handles sparse fds better and has no artificial 632than select, but handles sparse fds better and has no artificial
599limit on the number of fds you can use (except it will slow down 633limit 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, 634considerably 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 635i.e. O(total_fds). See the entry for \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR, above, for
602performance tips. 636performance tips.
603.Sp 637.Sp
604This backend maps \f(CW\*(C`EV_READ\*(C'\fR to \f(CW\*(C`POLLIN | POLLERR | POLLHUP\*(C'\fR, and 638This 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. 639\&\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 640.ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4
607.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 641.el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4
608.IX Item "EVBACKEND_EPOLL (value 4, Linux)" 642.IX Item "EVBACKEND_EPOLL (value 4, Linux)"
609Use the linux-specific \fIepoll\fR\|(7) interface (for both pre\- and post\-2.6.9 643Use the linux-specific \fBepoll\fR\|(7) interface (for both pre\- and post\-2.6.9
610kernels). 644kernels).
611.Sp 645.Sp
612For few fds, this backend is a bit little slower than poll and select, but 646For 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 647it 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 648O(total_fds) where total_fds is the total number of fds (or the highest
666.Sp 700.Sp
667This backend maps \f(CW\*(C`EV_READ\*(C'\fR and \f(CW\*(C`EV_WRITE\*(C'\fR in the same way as 701This 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. 702\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR.
669.ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 703.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 704.el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4
671.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" 705.IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)"
672Kqueue deserves special mention, as at the time of this writing, it 706Kqueue deserves special mention, as at the time of this writing, it
673was broken on all BSDs except NetBSD (usually it doesn't work reliably 707was broken on all BSDs except NetBSD (usually it doesn't work reliably
674with anything but sockets and pipes, except on Darwin, where of course 708with anything but sockets and pipes, except on Darwin, where of course
675it's completely useless). Unlike epoll, however, whose brokenness 709it's completely useless). Unlike epoll, however, whose brokenness
676is by design, these kqueue bugs can (and eventually will) be fixed 710is by design, these kqueue bugs can (and eventually will) be fixed
685.Sp 719.Sp
686It scales in the same way as the epoll backend, but the interface to the 720It 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 721kernel is more efficient (which says nothing about its actual speed, of
688course). While stopping, setting and starting an I/O watcher does never 722course). 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 723cause 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 724two 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 725might have to leak fd's on fork, but it's more sane than epoll) and it
692cases 726drops fds silently in similarly hard-to-detect cases.
693.Sp 727.Sp
694This backend usually performs well under most conditions. 728This backend usually performs well under most conditions.
695.Sp 729.Sp
696While nominally embeddable in other event loops, this doesn't work 730While nominally embeddable in other event loops, this doesn't work
697everywhere, so you might need to test for this. And since it is broken 731everywhere, 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 732almost 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 733(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 734(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. 735also broken on \s-1OS X\s0)) and, did I mention it, using it only for sockets.
702.Sp 736.Sp
703This backend maps \f(CW\*(C`EV_READ\*(C'\fR into an \f(CW\*(C`EVFILT_READ\*(C'\fR kevent with 737This 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 738\&\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. 739\&\f(CW\*(C`NOTE_EOF\*(C'\fR.
706.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 740.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
710implementation). According to reports, \f(CW\*(C`/dev/poll\*(C'\fR only supports sockets 744implementation). 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 745and is not embeddable, which would limit the usefulness of this backend
712immensely. 746immensely.
713.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 747.ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4
714.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 748.el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4
715.IX Item "EVBACKEND_PORT (value 32, Solaris 10)" 749.IX Item "EVBACKEND_PORT (value 32, Solaris 10)"
716This uses the Solaris 10 event port mechanism. As with everything on Solaris, 750This uses the Solaris 10 event port mechanism. As with everything on Solaris,
717it's really slow, but it still scales very well (O(active_fds)). 751it's really slow, but it still scales very well (O(active_fds)).
718.Sp 752.Sp
719While this backend scales well, it requires one system call per active 753While this backend scales well, it requires one system call per active
720file descriptor per loop iteration. For small and medium numbers of file 754file descriptor per loop iteration. For small and medium numbers of file
799except in the rare occasion where you really need to free its resources. 833except 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 834If 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. 835and \f(CW\*(C`ev_loop_destroy\*(C'\fR.
802.IP "ev_loop_fork (loop)" 4 836.IP "ev_loop_fork (loop)" 4
803.IX Item "ev_loop_fork (loop)" 837.IX Item "ev_loop_fork (loop)"
804This function sets a flag that causes subsequent \f(CW\*(C`ev_run\*(C'\fR iterations to 838This 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 839to reinitialise the kernel state for backends that have one. Despite
806name, you can call it anytime, but it makes most sense after forking, in 840the 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 841watchers (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. 842sense after forking, in the child process. You \fImust\fR call it (or use
843\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR) in the child before resuming or calling \f(CW\*(C`ev_run\*(C'\fR.
809.Sp 844.Sp
845In addition, if you want to reuse a loop (via this function or
846\&\f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR), you \fIalso\fR have to ignore \f(CW\*(C`SIGPIPE\*(C'\fR.
847.Sp
810Again, you \fIhave\fR to call it on \fIany\fR loop that you want to re-use after 848Again, 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 849a 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 850because some kernel interfaces *cough* \fIkqueue\fR *cough* do funny things
813during fork. 851during fork.
814.Sp 852.Sp
815On the other hand, you only need to call this function in the child 853On 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 947given 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. 948without a previous call to \f(CW\*(C`ev_suspend\*(C'\fR.
911.Sp 949.Sp
912Calling \f(CW\*(C`ev_suspend\*(C'\fR/\f(CW\*(C`ev_resume\*(C'\fR has the side effect of updating the 950Calling \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). 951event loop time (see \f(CW\*(C`ev_now_update\*(C'\fR).
914.IP "ev_run (loop, int flags)" 4 952.IP "bool ev_run (loop, int flags)" 4
915.IX Item "ev_run (loop, int flags)" 953.IX Item "bool ev_run (loop, int flags)"
916Finally, this is it, the event handler. This function usually is called 954Finally, this is it, the event handler. This function usually is called
917after you have initialised all your watchers and you want to start 955after you have initialised all your watchers and you want to start
918handling events. It will ask the operating system for any new events, call 956handling events. It will ask the operating system for any new events, call
919the watcher callbacks, an then repeat the whole process indefinitely: This 957the watcher callbacks, and then repeat the whole process indefinitely: This
920is why event loops are called \fIloops\fR. 958is why event loops are called \fIloops\fR.
921.Sp 959.Sp
922If the flags argument is specified as \f(CW0\fR, it will keep handling events 960If 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 961until either no event watchers are active anymore or \f(CW\*(C`ev_break\*(C'\fR was
924called. 962called.
963.Sp
964The return value is false if there are no more active watchers (which
965usually means \*(L"all jobs done\*(R" or \*(L"deadlock\*(R"), and true in all other cases
966(which usually means " you should call \f(CW\*(C`ev_run\*(C'\fR again").
925.Sp 967.Sp
926Please note that an explicit \f(CW\*(C`ev_break\*(C'\fR is usually better than 968Please 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 969relying on all watchers to be stopped when deciding when a program has
928finished (especially in interactive programs), but having a program 970finished (especially in interactive programs), but having a program
929that automatically loops as long as it has to and no longer by virtue 971that 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 972of relying on its watchers stopping correctly, that is truly a thing of
931beauty. 973beauty.
932.Sp 974.Sp
933This function is also \fImostly\fR exception-safe \- you can break out of 975This 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+ 976\&\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 977exception 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. 978will it clear any outstanding \f(CW\*(C`EVBREAK_ONE\*(C'\fR breaks.
937.Sp 979.Sp
938A flags value of \f(CW\*(C`EVRUN_NOWAIT\*(C'\fR will look for new events, will handle 980A 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 981those events and any already outstanding ones, but will not wait and
1136this callback instead. This is useful, for example, when you want to 1178this callback instead. This is useful, for example, when you want to
1137invoke the actual watchers inside another context (another thread etc.). 1179invoke the actual watchers inside another context (another thread etc.).
1138.Sp 1180.Sp
1139If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new 1181If you want to reset the callback, use \f(CW\*(C`ev_invoke_pending\*(C'\fR as new
1140callback. 1182callback.
1141.IP "ev_set_loop_release_cb (loop, void (*release)(\s-1EV_P\s0), void (*acquire)(\s-1EV_P\s0))" 4 1183.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))" 1184.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 1185Sometimes you want to share the same loop between multiple threads. This
1144can be done relatively simply by putting mutex_lock/unlock calls around 1186can be done relatively simply by putting mutex_lock/unlock calls around
1145each call to a libev function. 1187each call to a libev function.
1146.Sp 1188.Sp
1147However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible 1189However, \f(CW\*(C`ev_run\*(C'\fR can run an indefinite time, so it is not feasible
1295.PD 0 1337.PD 0
1296.ie n .IP """EV_CHECK""" 4 1338.ie n .IP """EV_CHECK""" 4
1297.el .IP "\f(CWEV_CHECK\fR" 4 1339.el .IP "\f(CWEV_CHECK\fR" 4
1298.IX Item "EV_CHECK" 1340.IX Item "EV_CHECK"
1299.PD 1341.PD
1300All \f(CW\*(C`ev_prepare\*(C'\fR watchers are invoked just \fIbefore\fR \f(CW\*(C`ev_run\*(C'\fR starts 1342All \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 1343gather 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 1344just after \f(CW\*(C`ev_run\*(C'\fR has gathered them, but before it queues any callbacks
1345for any received events. That means \f(CW\*(C`ev_prepare\*(C'\fR watchers are the last
1346watchers invoked before the event loop sleeps or polls for new events, and
1347\&\f(CW\*(C`ev_check\*(C'\fR watchers will be invoked before any other watchers of the same
1348or lower priority within an event loop iteration.
1349.Sp
1303received events. Callbacks of both watcher types can start and stop as 1350Callbacks 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 1351they 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 1352\&\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). 1353blocking).
1307.ie n .IP """EV_EMBED""" 4 1354.ie n .IP """EV_EMBED""" 4
1308.el .IP "\f(CWEV_EMBED\fR" 4 1355.el .IP "\f(CWEV_EMBED\fR" 4
1309.IX Item "EV_EMBED" 1356.IX Item "EV_EMBED"
1310The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention. 1357The embedded event loop specified in the \f(CW\*(C`ev_embed\*(C'\fR watcher needs attention.
1311.ie n .IP """EV_FORK""" 4 1358.ie n .IP """EV_FORK""" 4
1340bug in your program. 1387bug in your program.
1341.Sp 1388.Sp
1342Libev will usually signal a few \*(L"dummy\*(R" events together with an error, for 1389Libev 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 1390example 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 1391callbacks 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 1392the 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 1393programs, though, as the fd could already be closed and reused for another
1347thing, so beware. 1394thing, so beware.
1348.SS "\s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0" 1395.SS "\s-1GENERIC WATCHER FUNCTIONS\s0"
1349.IX Subsection "GENERIC WATCHER FUNCTIONS" 1396.IX Subsection "GENERIC WATCHER FUNCTIONS"
1350.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4 1397.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
1351.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4 1398.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
1352.IX Item "ev_init (ev_TYPE *watcher, callback)" 1399.IX Item "ev_init (ev_TYPE *watcher, callback)"
1353This macro initialises the generic portion of a watcher. The contents 1400This macro initialises the generic portion of a watcher. The contents
1432make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR 1479make sure the watcher is available to libev (e.g. you cannot \f(CW\*(C`free ()\*(C'\fR
1433it). 1480it).
1434.IP "callback ev_cb (ev_TYPE *watcher)" 4 1481.IP "callback ev_cb (ev_TYPE *watcher)" 4
1435.IX Item "callback ev_cb (ev_TYPE *watcher)" 1482.IX Item "callback ev_cb (ev_TYPE *watcher)"
1436Returns the callback currently set on the watcher. 1483Returns the callback currently set on the watcher.
1437.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4 1484.IP "ev_set_cb (ev_TYPE *watcher, callback)" 4
1438.IX Item "ev_cb_set (ev_TYPE *watcher, callback)" 1485.IX Item "ev_set_cb (ev_TYPE *watcher, callback)"
1439Change the callback. You can change the callback at virtually any time 1486Change the callback. You can change the callback at virtually any time
1440(modulo threads). 1487(modulo threads).
1441.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4 1488.IP "ev_set_priority (ev_TYPE *watcher, int priority)" 4
1442.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)" 1489.IX Item "ev_set_priority (ev_TYPE *watcher, int priority)"
1443.PD 0 1490.PD 0
1461or might not have been clamped to the valid range. 1508or might not have been clamped to the valid range.
1462.Sp 1509.Sp
1463The default priority used by watchers when no priority has been set is 1510The 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 :). 1511always \f(CW0\fR, which is supposed to not be too high and not be too low :).
1465.Sp 1512.Sp
1466See \*(L"\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0\*(R", below, for a more thorough treatment of 1513See \*(L"\s-1WATCHER PRIORITY MODELS\*(R"\s0, below, for a more thorough treatment of
1467priorities. 1514priorities.
1468.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4 1515.IP "ev_invoke (loop, ev_TYPE *watcher, int revents)" 4
1469.IX Item "ev_invoke (loop, ev_TYPE *watcher, int revents)" 1516.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 1517Invoke 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 1518\&\f(CW\*(C`loop\*(C'\fR nor \f(CW\*(C`revents\*(C'\fR need to be valid as long as the watcher callback
1491not started in the first place. 1538not started in the first place.
1492.Sp 1539.Sp
1493See also \f(CW\*(C`ev_feed_fd_event\*(C'\fR and \f(CW\*(C`ev_feed_signal_event\*(C'\fR for related 1540See 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. 1541functions that do not need a watcher.
1495.PP 1542.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 1543See 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. 1544OWN COMPOSITE WATCHERS\*(R"\s0 idioms.
1498.SS "\s-1WATCHER\s0 \s-1STATES\s0" 1545.SS "\s-1WATCHER STATES\s0"
1499.IX Subsection "WATCHER STATES" 1546.IX Subsection "WATCHER STATES"
1500There are various watcher states mentioned throughout this manual \- 1547There are various watcher states mentioned throughout this manual \-
1501active, pending and so on. In this section these states and the rules to 1548active, 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 1549transition between them will be described in more detail \- and while these
1503rules might look complicated, they usually do \*(L"the right thing\*(R". 1550rules might look complicated, they usually do \*(L"the right thing\*(R".
1504.IP "initialiased" 4 1551.IP "initialised" 4
1505.IX Item "initialiased" 1552.IX Item "initialised"
1506Before a watcher can be registered with the event loop it has to be 1553Before 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 1554initialised. 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. 1555\&\f(CW\*(C`ev_init\*(C'\fR followed by the watcher-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR function.
1509.Sp 1556.Sp
1510In this state it is simply some block of memory that is suitable for 1557In this state it is simply some block of memory that is suitable for
1546.Sp 1593.Sp
1547While stopped (and not pending) the watcher is essentially in the 1594While stopped (and not pending) the watcher is essentially in the
1548initialised state, that is, it can be reused, moved, modified in any way 1595initialised 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 1596you wish (but when you trash the memory block, you need to \f(CW\*(C`ev_TYPE_init\*(C'\fR
1550it again). 1597it again).
1551.SS "\s-1WATCHER\s0 \s-1PRIORITY\s0 \s-1MODELS\s0" 1598.SS "\s-1WATCHER PRIORITY MODELS\s0"
1552.IX Subsection "WATCHER PRIORITY MODELS" 1599.IX Subsection "WATCHER PRIORITY MODELS"
1553Many event loops support \fIwatcher priorities\fR, which are usually small 1600Many event loops support \fIwatcher priorities\fR, which are usually small
1554integers that influence the ordering of event callback invocation 1601integers that influence the ordering of event callback invocation
1555between watchers in some way, all else being equal. 1602between watchers in some way, all else being equal.
1556.PP 1603.PP
1754wish to read \- you would first have to request some data. 1801wish to read \- you would first have to request some data.
1755.PP 1802.PP
1756Since files are typically not-so-well supported by advanced notification 1803Since files are typically not-so-well supported by advanced notification
1757mechanism, libev tries hard to emulate \s-1POSIX\s0 behaviour with respect 1804mechanism, 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 1805to 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 1806convenience: 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 1807usually 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 1808(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 1809\&\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 1810asynchronous I/O instead of with non-blocking I/O, it is still useful when
1764it \*(L"just works\*(R" instead of freezing. 1811it \*(L"just works\*(R" instead of freezing.
1765.PP 1812.PP
1766So avoid file descriptors pointing to files when you know it (e.g. use 1813So 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 1814libeio), 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 1815when you rarely read from a file instead of from a socket, and want to
1769reuse the same code path. 1816reuse the same code path.
1770.PP 1817.PP
1771\fIThe special problem of fork\fR 1818\fIThe special problem of fork\fR
1772.IX Subsection "The special problem of fork" 1819.IX Subsection "The special problem of fork"
1782\fIThe special problem of \s-1SIGPIPE\s0\fR 1829\fIThe special problem of \s-1SIGPIPE\s0\fR
1783.IX Subsection "The special problem of SIGPIPE" 1830.IX Subsection "The special problem of SIGPIPE"
1784.PP 1831.PP
1785While not really specific to libev, it is easy to forget about \f(CW\*(C`SIGPIPE\*(C'\fR: 1832While 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 1833when 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 1834sent a \s-1SIGPIPE,\s0 which, by default, aborts your program. For most programs
1788this is sensible behaviour, for daemons, this is usually undesirable. 1835this is sensible behaviour, for daemons, this is usually undesirable.
1789.PP 1836.PP
1790So when you encounter spurious, unexplained daemon exits, make sure you 1837So 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 1838ignore \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). 1839somewhere, as that would have given you a big clue).
1793.PP 1840.PP
1794\fIThe special problem of \fIaccept()\fIing when you can't\fR 1841\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" 1842.IX Subsection "The special problem of accept()ing when you can't"
1796.PP 1843.PP
1797Many implementations of the \s-1POSIX\s0 \f(CW\*(C`accept\*(C'\fR function (for example, 1844Many 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 1845found in post\-2004 Linux) have the peculiar behaviour of not removing a
1799connection from the pending queue in all error cases. 1846connection from the pending queue in all error cases.
1990\& callback (EV_P_ ev_timer *w, int revents) 2037\& callback (EV_P_ ev_timer *w, int revents)
1991\& { 2038\& {
1992\& // calculate when the timeout would happen 2039\& // calculate when the timeout would happen
1993\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout; 2040\& ev_tstamp after = last_activity \- ev_now (EV_A) + timeout;
1994\& 2041\&
1995\& // if negative, it means we the timeout already occured 2042\& // if negative, it means we the timeout already occurred
1996\& if (after < 0.) 2043\& if (after < 0.)
1997\& { 2044\& {
1998\& // timeout occurred, take action 2045\& // timeout occurred, take action
1999\& } 2046\& }
2000\& else 2047\& else
2019.Sp 2066.Sp
2020Otherwise, we now the earliest time at which the timeout would trigger, 2067Otherwise, we now the earliest time at which the timeout would trigger,
2021and simply start the timer with this timeout value. 2068and simply start the timer with this timeout value.
2022.Sp 2069.Sp
2023In other words, each time the callback is invoked it will check whether 2070In other words, each time the callback is invoked it will check whether
2024the timeout cocured. If not, it will simply reschedule itself to check 2071the timeout occurred. If not, it will simply reschedule itself to check
2025again at the earliest time it could time out. Rinse. Repeat. 2072again at the earliest time it could time out. Rinse. Repeat.
2026.Sp 2073.Sp
2027This scheme causes more callback invocations (about one every 60 seconds 2074This scheme causes more callback invocations (about one every 60 seconds
2028minus half the average time between activity), but virtually no calls to 2075minus half the average time between activity), but virtually no calls to
2029libev to change the timeout. 2076libev to change the timeout.
2047\& last_activity = ev_now (EV_A); 2094\& last_activity = ev_now (EV_A);
2048.Ve 2095.Ve
2049.Sp 2096.Sp
2050When your timeout value changes, then the timeout can be changed by simply 2097When your timeout value changes, then the timeout can be changed by simply
2051providing a new value, stopping the timer and calling the callback, which 2098providing a new value, stopping the timer and calling the callback, which
2052will agaion do the right thing (for example, time out immediately :). 2099will again do the right thing (for example, time out immediately :).
2053.Sp 2100.Sp
2054.Vb 3 2101.Vb 3
2055\& timeout = new_value; 2102\& timeout = new_value;
2056\& ev_timer_stop (EV_A_ &timer); 2103\& ev_timer_stop (EV_A_ &timer);
2057\& callback (EV_A_ &timer, 0); 2104\& callback (EV_A_ &timer, 0);
2141.PP 2188.PP
2142The relative timeouts are calculated relative to the \f(CW\*(C`ev_now ()\*(C'\fR 2189The 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 2190time. This is usually the right thing as this timestamp refers to the time
2144of the event triggering whatever timeout you are modifying/starting. If 2191of the event triggering whatever timeout you are modifying/starting. If
2145you suspect event processing to be delayed and you \fIneed\fR to base the 2192you 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: 2193timeout on the current time, use something like the following to adjust
2194for it:
2147.PP 2195.PP
2148.Vb 1 2196.Vb 1
2149\& ev_timer_set (&timer, after + ev_now () \- ev_time (), 0.); 2197\& ev_timer_set (&timer, after + (ev_time () \- ev_now ()), 0.);
2150.Ve 2198.Ve
2151.PP 2199.PP
2152If the event loop is suspended for a long time, you can also force an 2200If 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 2201update of the time returned by \f(CW\*(C`ev_now ()\*(C'\fR by calling \f(CW\*(C`ev_now_update
2154()\*(C'\fR. 2202()\*(C'\fR, although that will push the event time of all outstanding events
2203further into the future.
2155.PP 2204.PP
2156\fIThe special problem of unsynchronised clocks\fR 2205\fIThe special problem of unsynchronised clocks\fR
2157.IX Subsection "The special problem of unsynchronised clocks" 2206.IX Subsection "The special problem of unsynchronised clocks"
2158.PP 2207.PP
2159Modern systems have a variety of clocks \- libev itself uses the normal 2208Modern 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)" 2273.IX Item "ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)"
2225.PD 0 2274.PD 0
2226.IP "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)" 4 2275.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)" 2276.IX Item "ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)"
2228.PD 2277.PD
2229Configure the timer to trigger after \f(CW\*(C`after\*(C'\fR seconds. If \f(CW\*(C`repeat\*(C'\fR 2278Configure 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 2279negative 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 2280automatically 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, 2281then the timer will automatically be configured to trigger again \f(CW\*(C`repeat\*(C'\fR
2233until stopped manually. 2282seconds later, again, and again, until stopped manually.
2234.Sp 2283.Sp
2235The timer itself will do a best-effort at avoiding drift, that is, if 2284The 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 2285you configure a timer to trigger every 10 seconds, then it will normally
2237trigger at exactly 10 second intervals. If, however, your program cannot 2286trigger at exactly 10 second intervals. If, however, your program cannot
2238keep up with the timer (because it takes longer than those 10 seconds to 2287keep 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 2369Periodic watchers are also timers of a kind, but they are very versatile
2321(and unfortunately a bit complex). 2370(and unfortunately a bit complex).
2322.PP 2371.PP
2323Unlike \f(CW\*(C`ev_timer\*(C'\fR, periodic watchers are not based on real time (or 2372Unlike \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 2373relative 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 2374(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 2375difference 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 2376time, and time jumps are not uncommon (e.g. when you adjust your
2328wrist-watch). 2377wrist-watch).
2329.PP 2378.PP
2330You can tell a periodic watcher to trigger after some specific point 2379You 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 2384\&\f(CW\*(C`ev_timer\*(C'\fR, which would still trigger roughly 10 seconds after starting
2336it, as it uses a relative timeout). 2385it, as it uses a relative timeout).
2337.PP 2386.PP
2338\&\f(CW\*(C`ev_periodic\*(C'\fR watchers can also be used to implement vastly more complex 2387\&\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 2388timers, 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 2389other complicated rules. This cannot easily be done with \f(CW\*(C`ev_timer\*(C'\fR
2341those cannot react to time jumps. 2390watchers, as those cannot react to time jumps.
2342.PP 2391.PP
2343As with timers, the callback is guaranteed to be invoked only when the 2392As 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 2393point in time where it is supposed to trigger has passed. If multiple
2345timers become ready during the same loop iteration then the ones with 2394timers become ready during the same loop iteration then the ones with
2346earlier time-out values are invoked before ones with later time-out values 2395earlier 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 2456In 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 2457ignored. Instead, each time the periodic watcher gets scheduled, the
2409reschedule callback will be called with the watcher as first, and the 2458reschedule callback will be called with the watcher as first, and the
2410current time as second argument. 2459current time as second argument.
2411.Sp 2460.Sp
2412\&\s-1NOTE:\s0 \fIThis callback \s-1MUST\s0 \s-1NOT\s0 stop or destroy any periodic watcher, ever, 2461\&\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 2462or make \s-1ANY\s0 other event loop modifications whatsoever, unless explicitly
2414allowed by documentation here\fR. 2463allowed by documentation here\fR.
2415.Sp 2464.Sp
2416If you need to stop it, return \f(CW\*(C`now + 1e30\*(C'\fR (or so, fudge fudge) and stop 2465If 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 2466it afterwards (e.g. by starting an \f(CW\*(C`ev_prepare\*(C'\fR watcher, which is the
2435.Sp 2484.Sp
2436\&\s-1NOTE:\s0 \fIThis callback must always return a time that is higher than or 2485\&\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. 2486equal to the passed \f(CI\*(C`now\*(C'\fI value\fR.
2438.Sp 2487.Sp
2439This can be used to create very complex timers, such as a timer that 2488This 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 2489triggers 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 2490the 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 2491this. Here is a (completely untested, no error checking) example on how to
2443reason I omitted it as an example). 2492do this:
2493.Sp
2494.Vb 1
2495\& #include <time.h>
2496\&
2497\& static ev_tstamp
2498\& my_rescheduler (ev_periodic *w, ev_tstamp now)
2499\& {
2500\& time_t tnow = (time_t)now;
2501\& struct tm tm;
2502\& localtime_r (&tnow, &tm);
2503\&
2504\& tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day
2505\& ++tm.tm_mday; // midnight next day
2506\&
2507\& return mktime (&tm);
2508\& }
2509.Ve
2510.Sp
2511Note: this code might run into trouble on days that have more then two
2512midnights (beginning and end).
2444.RE 2513.RE
2445.RS 4 2514.RS 4
2446.RE 2515.RE
2447.IP "ev_periodic_again (loop, ev_periodic *)" 4 2516.IP "ev_periodic_again (loop, ev_periodic *)" 4
2448.IX Item "ev_periodic_again (loop, ev_periodic *)" 2517.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 2602only 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 2603default 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 2604\&\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. 2605the moment, \f(CW\*(C`SIGCHLD\*(C'\fR is permanently tied to the default loop.
2537.PP 2606.PP
2538When the first watcher gets started will libev actually register something 2607Only 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 2608register something with the kernel. It thus coexists with your own signal
2540you don't register any with libev for the same signal). 2609handlers as long as you don't register any with libev for the same signal.
2541.PP 2610.PP
2542If possible and supported, libev will install its handlers with 2611If 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 2612\&\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 2613not 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 2614interrupted by signals you can block all signals in an \f(CW\*(C`ev_check\*(C'\fR watcher
2606The signal the watcher watches out for. 2675The signal the watcher watches out for.
2607.PP 2676.PP
2608\fIExamples\fR 2677\fIExamples\fR
2609.IX Subsection "Examples" 2678.IX Subsection "Examples"
2610.PP 2679.PP
2611Example: Try to exit cleanly on \s-1SIGINT\s0. 2680Example: Try to exit cleanly on \s-1SIGINT.\s0
2612.PP 2681.PP
2613.Vb 5 2682.Vb 5
2614\& static void 2683\& static void
2615\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents) 2684\& sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2616\& { 2685\& {
2731.ie n .SS """ev_stat"" \- did the file attributes just change?" 2800.ie n .SS """ev_stat"" \- did the file attributes just change?"
2732.el .SS "\f(CWev_stat\fP \- did the file attributes just change?" 2801.el .SS "\f(CWev_stat\fP \- did the file attributes just change?"
2733.IX Subsection "ev_stat - did the file attributes just change?" 2802.IX Subsection "ev_stat - did the file attributes just change?"
2734This watches a file system path for attribute changes. That is, it calls 2803This 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) 2804\&\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 2805and sees if it changed compared to the last time, invoking the callback
2737it did. 2806if it did. Starting the watcher \f(CW\*(C`stat\*(C'\fR's the file, so only changes that
2807happen after the watcher has been started will be reported.
2738.PP 2808.PP
2739The path does not need to exist: changing from \*(L"path exists\*(R" to \*(L"path does 2809The 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 2810not 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 2811exist\*(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 2812\&\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 2842compilation environment, which means that on systems with large file
2773support disabled by default, you get the 32 bit version of the stat 2843support 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 2844structure. 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 2845use 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 2846compile 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 2847obviously 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. 2848most noticeably displayed with ev_stat and large file support.
2779.PP 2849.PP
2780The solution for this is to lobby your distribution maker to make large 2850The solution for this is to lobby your distribution maker to make large
2781file interfaces available by default (as e.g. FreeBSD does) and not 2851file interfaces available by default (as e.g. FreeBSD does) and not
2782optional. Libev cannot simply switch on large file support because it has 2852optional. Libev cannot simply switch on large file support because it has
2973Apart from keeping your process non-blocking (which is a useful 3043Apart from keeping your process non-blocking (which is a useful
2974effect on its own sometimes), idle watchers are a good place to do 3044effect 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 3045\&\*(L"pseudo-background processing\*(R", or delay processing stuff to after the
2976event loop has handled all outstanding events. 3046event loop has handled all outstanding events.
2977.PP 3047.PP
3048\fIAbusing an \f(CI\*(C`ev_idle\*(C'\fI watcher for its side-effect\fR
3049.IX Subsection "Abusing an ev_idle watcher for its side-effect"
3050.PP
3051As long as there is at least one active idle watcher, libev will never
3052sleep unnecessarily. Or in other words, it will loop as fast as possible.
3053For this to work, the idle watcher doesn't need to be invoked at all \- the
3054lowest priority will do.
3055.PP
3056This mode of operation can be useful together with an \f(CW\*(C`ev_check\*(C'\fR watcher,
3057to do something on each event loop iteration \- for example to balance load
3058between different connections.
3059.PP
3060See \*(L"Abusing an ev_check watcher for its side-effect\*(R" for a longer
3061example.
3062.PP
2978\fIWatcher-Specific Functions and Data Members\fR 3063\fIWatcher-Specific Functions and Data Members\fR
2979.IX Subsection "Watcher-Specific Functions and Data Members" 3064.IX Subsection "Watcher-Specific Functions and Data Members"
2980.IP "ev_idle_init (ev_idle *, callback)" 4 3065.IP "ev_idle_init (ev_idle *, callback)" 4
2981.IX Item "ev_idle_init (ev_idle *, callback)" 3066.IX Item "ev_idle_init (ev_idle *, callback)"
2982Initialises and configures the idle watcher \- it has no parameters of any 3067Initialises and configures the idle watcher \- it has no parameters of any
2987.IX Subsection "Examples" 3072.IX Subsection "Examples"
2988.PP 3073.PP
2989Example: Dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR watcher, start it, and in the 3074Example: 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. 3075callback, free it. Also, use no error checking, as usual.
2991.PP 3076.PP
2992.Vb 7 3077.Vb 5
2993\& static void 3078\& static void
2994\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 3079\& idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2995\& { 3080\& {
3081\& // stop the watcher
3082\& ev_idle_stop (loop, w);
3083\&
3084\& // now we can free it
2996\& free (w); 3085\& free (w);
3086\&
2997\& // now do something you wanted to do when the program has 3087\& // now do something you wanted to do when the program has
2998\& // no longer anything immediate to do. 3088\& // no longer anything immediate to do.
2999\& } 3089\& }
3000\& 3090\&
3001\& ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 3091\& ev_idle *idle_watcher = malloc (sizeof (ev_idle));
3003\& ev_idle_start (loop, idle_watcher); 3093\& ev_idle_start (loop, idle_watcher);
3004.Ve 3094.Ve
3005.ie n .SS """ev_prepare"" and ""ev_check"" \- customise your event loop!" 3095.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!" 3096.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!" 3097.IX Subsection "ev_prepare and ev_check - customise your event loop!"
3008Prepare and check watchers are usually (but not always) used in pairs: 3098Prepare and check watchers are often (but not always) used in pairs:
3009prepare watchers get invoked before the process blocks and check watchers 3099prepare watchers get invoked before the process blocks and check watchers
3010afterwards. 3100afterwards.
3011.PP 3101.PP
3012You \fImust not\fR call \f(CW\*(C`ev_run\*(C'\fR or similar functions that enter 3102You \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 3103current 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 3104\&\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 3105however. 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, 3106for 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 3107\&\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. 3108kind they will always be called in pairs bracketing the blocking call.
3019.PP 3109.PP
3020Their main purpose is to integrate other event mechanisms into libev and 3110Their main purpose is to integrate other event mechanisms into libev and
3021their use is somewhat advanced. They could be used, for example, to track 3111their use is somewhat advanced. They could be used, for example, to track
3022variable changes, implement your own watchers, integrate net-snmp or a 3112variable changes, implement your own watchers, integrate net-snmp or a
3023coroutine library and lots more. They are also occasionally useful if 3113coroutine library and lots more. They are also occasionally useful if
3041with priority higher than or equal to the event loop and one coroutine 3131with 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 3132of lower priority, but only once, using idle watchers to keep the event
3043loop from blocking if lower-priority coroutines are active, thus mapping 3133loop from blocking if lower-priority coroutines are active, thus mapping
3044low-priority coroutines to idle/background tasks). 3134low-priority coroutines to idle/background tasks).
3045.PP 3135.PP
3046It is recommended to give \f(CW\*(C`ev_check\*(C'\fR watchers highest (\f(CW\*(C`EV_MAXPRI\*(C'\fR) 3136When 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 3137highest (\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). 3138any other watchers after the poll (this doesn't matter for \f(CW\*(C`ev_prepare\*(C'\fR
3139watchers).
3049.PP 3140.PP
3050Also, \f(CW\*(C`ev_check\*(C'\fR watchers (and \f(CW\*(C`ev_prepare\*(C'\fR watchers, too) should not 3141Also, \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 3142activate (\*(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 3143might 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 3144\&\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 3145loops 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 3146\&\f(CW\*(C`ev_check\*(C'\fR watcher ran (always remind yourself to coexist peacefully with
3056others). 3147others).
3148.PP
3149\fIAbusing an \f(CI\*(C`ev_check\*(C'\fI watcher for its side-effect\fR
3150.IX Subsection "Abusing an ev_check watcher for its side-effect"
3151.PP
3152\&\f(CW\*(C`ev_check\*(C'\fR (and less often also \f(CW\*(C`ev_prepare\*(C'\fR) watchers can also be
3153useful because they are called once per event loop iteration. For
3154example, if you want to handle a large number of connections fairly, you
3155normally only do a bit of work for each active connection, and if there
3156is more work to do, you wait for the next event loop iteration, so other
3157connections have a chance of making progress.
3158.PP
3159Using an \f(CW\*(C`ev_check\*(C'\fR watcher is almost enough: it will be called on the
3160next event loop iteration. However, that isn't as soon as possible \-
3161without external events, your \f(CW\*(C`ev_check\*(C'\fR watcher will not be invoked.
3162.PP
3163This is where \f(CW\*(C`ev_idle\*(C'\fR watchers come in handy \- all you need is a
3164single global idle watcher that is active as long as you have one active
3165\&\f(CW\*(C`ev_check\*(C'\fR watcher. The \f(CW\*(C`ev_idle\*(C'\fR watcher makes sure the event loop
3166will not sleep, and the \f(CW\*(C`ev_check\*(C'\fR watcher makes sure a callback gets
3167invoked. Neither watcher alone can do that.
3057.PP 3168.PP
3058\fIWatcher-Specific Functions and Data Members\fR 3169\fIWatcher-Specific Functions and Data Members\fR
3059.IX Subsection "Watcher-Specific Functions and Data Members" 3170.IX Subsection "Watcher-Specific Functions and Data Members"
3060.IP "ev_prepare_init (ev_prepare *, callback)" 4 3171.IP "ev_prepare_init (ev_prepare *, callback)" 4
3061.IX Item "ev_prepare_init (ev_prepare *, callback)" 3172.IX Item "ev_prepare_init (ev_prepare *, callback)"
3172.Ve 3283.Ve
3173.PP 3284.PP
3174Method 4: Do not use a prepare or check watcher because the module you 3285Method 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 3286want to embed is not flexible enough to support it. Instead, you can
3176override their poll function. The drawback with this solution is that the 3287override 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 3288main 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 3289this approach, effectively embedding \s-1EV\s0 as a client into the horrible
3179libglib event loop. 3290libglib event loop.
3180.PP 3291.PP
3181.Vb 4 3292.Vb 4
3182\& static gint 3293\& static gint
3266\fIWatcher-Specific Functions and Data Members\fR 3377\fIWatcher-Specific Functions and Data Members\fR
3267.IX Subsection "Watcher-Specific Functions and Data Members" 3378.IX Subsection "Watcher-Specific Functions and Data Members"
3268.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3379.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)" 3380.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
3270.PD 0 3381.PD 0
3271.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 3382.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)" 3383.IX Item "ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)"
3273.PD 3384.PD
3274Configures the watcher to embed the given loop, which must be 3385Configures 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 3386embeddable. 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 3387invoked automatically, otherwise it is the responsibility of the callback
3277to invoke it (it will continue to be called until the sweep has been done, 3388to invoke it (it will continue to be called until the sweep has been done,
3296.PP 3407.PP
3297.Vb 3 3408.Vb 3
3298\& struct ev_loop *loop_hi = ev_default_init (0); 3409\& struct ev_loop *loop_hi = ev_default_init (0);
3299\& struct ev_loop *loop_lo = 0; 3410\& struct ev_loop *loop_lo = 0;
3300\& ev_embed embed; 3411\& ev_embed embed;
3301\& 3412\&
3302\& // see if there is a chance of getting one that works 3413\& // see if there is a chance of getting one that works
3303\& // (remember that a flags value of 0 means autodetection) 3414\& // (remember that a flags value of 0 means autodetection)
3304\& loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3415\& loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3305\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3416\& ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3306\& : 0; 3417\& : 0;
3322.PP 3433.PP
3323.Vb 3 3434.Vb 3
3324\& struct ev_loop *loop = ev_default_init (0); 3435\& struct ev_loop *loop = ev_default_init (0);
3325\& struct ev_loop *loop_socket = 0; 3436\& struct ev_loop *loop_socket = 0;
3326\& ev_embed embed; 3437\& ev_embed embed;
3327\& 3438\&
3328\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3439\& if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3329\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3440\& if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3330\& { 3441\& {
3331\& ev_embed_init (&embed, 0, loop_socket); 3442\& ev_embed_init (&embed, 0, loop_socket);
3332\& ev_embed_start (loop, &embed); 3443\& ev_embed_start (loop, &embed);
3340.ie n .SS """ev_fork"" \- the audacity to resume the event loop after a fork" 3451.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" 3452.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" 3453.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 3454Fork 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 3455whoever 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 3456\&\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, 3457and 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 3458after 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 3459and calls it in the wrong process, the fork handlers will be invoked, too,
3349handlers will be invoked, too, of course. 3460of course.
3350.PP 3461.PP
3351\fIThe special problem of life after fork \- how is it possible?\fR 3462\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?" 3463.IX Subsection "The special problem of life after fork - how is it possible?"
3353.PP 3464.PP
3354Most uses of \f(CW\*(C`fork()\*(C'\fR consist of forking, then some simple calls to set 3465Most 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 3466up/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. 3467sequence should be handled by libev without any problems.
3357.PP 3468.PP
3358This changes when the application actually wants to do event handling 3469This 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 3470in 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. 3551it by calling \f(CW\*(C`ev_async_send\*(C'\fR, which is thread\- and signal safe.
3441.PP 3552.PP
3442This functionality is very similar to \f(CW\*(C`ev_signal\*(C'\fR watchers, as signals, 3553This 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 3554too, 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 3555(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 3556\&\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 3557of \*(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, 3558signal, and \f(CW\*(C`ev_feed_signal\*(C'\fR to signal this watcher from another thread,
3448even without knowing which loop owns the signal. 3559even without knowing which loop owns the signal.
3449.PP 3560.PP
3450\fIQueueing\fR 3561\fIQueueing\fR
3576is a time window between the event loop checking and resetting the async 3687is a time window between the event loop checking and resetting the async
3577notification, and the callback being invoked. 3688notification, and the callback being invoked.
3578.SH "OTHER FUNCTIONS" 3689.SH "OTHER FUNCTIONS"
3579.IX Header "OTHER FUNCTIONS" 3690.IX Header "OTHER FUNCTIONS"
3580There are some other functions of possible interest. Described. Here. Now. 3691There are some other functions of possible interest. Described. Here. Now.
3581.IP "ev_once (loop, int fd, int events, ev_tstamp timeout, callback)" 4 3692.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)" 3693.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 3694This function combines a simple timer and an I/O watcher, calls your
3584callback on whichever event happens first and automatically stops both 3695callback 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 3696watchers. 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 3697or timeout without having to allocate/configure/start/stop/free one or
3587more watchers yourself. 3698more 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 3710\&\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 3711value 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 3712a timeout and an io event at the same time \- you probably should give io
3602events precedence. 3713events precedence.
3603.Sp 3714.Sp
3604Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO\s0. 3715Example: wait up to ten seconds for data to appear on \s-1STDIN_FILENO.\s0
3605.Sp 3716.Sp
3606.Vb 7 3717.Vb 7
3607\& static void stdin_ready (int revents, void *arg) 3718\& static void stdin_ready (int revents, void *arg)
3608\& { 3719\& {
3609\& if (revents & EV_READ) 3720\& if (revents & EV_READ)
3625.SH "COMMON OR USEFUL IDIOMS (OR BOTH)" 3736.SH "COMMON OR USEFUL IDIOMS (OR BOTH)"
3626.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)" 3737.IX Header "COMMON OR USEFUL IDIOMS (OR BOTH)"
3627This section explains some common idioms that are not immediately 3738This section explains some common idioms that are not immediately
3628obvious. Note that examples are sprinkled over the whole manual, and this 3739obvious. Note that examples are sprinkled over the whole manual, and this
3629section only contains stuff that wouldn't fit anywhere else. 3740section 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" 3741.SS "\s-1ASSOCIATING CUSTOM DATA WITH A WATCHER\s0"
3631.IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER" 3742.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 3743Each 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 3744or 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 3745to 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 3746don't want to allocate memory separately and store a pointer to it in that
3661\& } 3772\& }
3662.Ve 3773.Ve
3663.PP 3774.PP
3664More interesting and less C\-conformant ways of casting your callback 3775More interesting and less C\-conformant ways of casting your callback
3665function type instead have been omitted. 3776function type instead have been omitted.
3666.SS "\s-1BUILDING\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1COMPOSITE\s0 \s-1WATCHERS\s0" 3777.SS "\s-1BUILDING YOUR OWN COMPOSITE WATCHERS\s0"
3667.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS" 3778.IX Subsection "BUILDING YOUR OWN COMPOSITE WATCHERS"
3668Another common scenario is to use some data structure with multiple 3779Another common scenario is to use some data structure with multiple
3669embedded watchers, in effect creating your own watcher that combines 3780embedded watchers, in effect creating your own watcher that combines
3670multiple libev event sources into one \*(L"super-watcher\*(R": 3781multiple libev event sources into one \*(L"super-watcher\*(R":
3671.PP 3782.PP
3699\& { 3810\& {
3700\& struct my_biggy big = (struct my_biggy *) 3811\& struct my_biggy big = (struct my_biggy *)
3701\& (((char *)w) \- offsetof (struct my_biggy, t2)); 3812\& (((char *)w) \- offsetof (struct my_biggy, t2));
3702\& } 3813\& }
3703.Ve 3814.Ve
3704.SS "\s-1AVOIDING\s0 \s-1FINISHING\s0 \s-1BEFORE\s0 \s-1RETURNING\s0" 3815.SS "\s-1AVOIDING FINISHING BEFORE RETURNING\s0"
3705.IX Subsection "AVOIDING FINISHING BEFORE RETURNING" 3816.IX Subsection "AVOIDING FINISHING BEFORE RETURNING"
3706Often you have structures like this in event-based programs: 3817Often you have structures like this in event-based programs:
3707.PP 3818.PP
3708.Vb 4 3819.Vb 4
3709\& callback () 3820\& callback ()
3731already been invoked. 3842already been invoked.
3732.PP 3843.PP
3733A common way around all these issues is to make sure that 3844A 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 3845\&\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 3846\&\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 3847delay 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 3848example, or more sneakily, by reusing an existing (stopped) watcher and
3738and pushing it into the pending queue: 3849pushing it into the pending queue:
3739.PP 3850.PP
3740.Vb 2 3851.Vb 2
3741\& ev_set_cb (watcher, callback); 3852\& ev_set_cb (watcher, callback);
3742\& ev_feed_event (EV_A_ watcher, 0); 3853\& ev_feed_event (EV_A_ watcher, 0);
3743.Ve 3854.Ve
3744.PP 3855.PP
3745This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is 3856This way, \f(CW\*(C`start_new_request\*(C'\fR can safely return before the callback is
3746invoked, while not delaying callback invocation too much. 3857invoked, 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" 3858.SS "\s-1MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS\s0"
3748.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS" 3859.IX Subsection "MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS"
3749Often (especially in \s-1GUI\s0 toolkits) there are places where you have 3860Often (especially in \s-1GUI\s0 toolkits) there are places where you have
3750\&\fImodal\fR interaction, which is most easily implemented by recursively 3861\&\fImodal\fR interaction, which is most easily implemented by recursively
3751invoking \f(CW\*(C`ev_run\*(C'\fR. 3862invoking \f(CW\*(C`ev_run\*(C'\fR.
3752.PP 3863.PP
3753This brings the problem of exiting \- a callback might want to finish the 3864This 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 3865main \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 3866a 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 3867and 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. 3868other combination: In these cases, a simple \f(CW\*(C`ev_break\*(C'\fR will not work.
3758.PP 3869.PP
3759The solution is to maintain \*(L"break this loop\*(R" variable for each \f(CW\*(C`ev_run\*(C'\fR 3870The 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 3871invocation, 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: 3872triggered, using \f(CW\*(C`EVRUN_ONCE\*(C'\fR:
3762.PP 3873.PP
3784\& exit_main_loop = 1; 3895\& exit_main_loop = 1;
3785\& 3896\&
3786\& // exit both 3897\& // exit both
3787\& exit_main_loop = exit_nested_loop = 1; 3898\& exit_main_loop = exit_nested_loop = 1;
3788.Ve 3899.Ve
3789.SS "\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0" 3900.SS "\s-1THREAD LOCKING EXAMPLE\s0"
3790.IX Subsection "THREAD LOCKING EXAMPLE" 3901.IX Subsection "THREAD LOCKING EXAMPLE"
3791Here is a fictitious example of how to run an event loop in a different 3902Here is a fictitious example of how to run an event loop in a different
3792thread from where callbacks are being invoked and watchers are 3903thread from where callbacks are being invoked and watchers are
3793created/added/removed. 3904created/added/removed.
3794.PP 3905.PP
3935.PP 4046.PP
3936Note that sending the \f(CW\*(C`ev_async\*(C'\fR watcher is required because otherwise 4047Note 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 4048an 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 4049about the newly added timer. By waking up the loop it will pick up any new
3939watchers in the next event loop iteration. 4050watchers 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" 4051.SS "\s-1THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS\s0"
3941.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS" 4052.IX Subsection "THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS"
3942While the overhead of a callback that e.g. schedules a thread is small, it 4053While 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 4054is 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 4055kind of threads or coroutines, you might want to customise libev so that
3945doesn't need callbacks anymore. 4056doesn't need callbacks anymore.
3967.PP 4078.PP
3968.Vb 6 4079.Vb 6
3969\& void 4080\& void
3970\& wait_for_event (ev_watcher *w) 4081\& wait_for_event (ev_watcher *w)
3971\& { 4082\& {
3972\& ev_cb_set (w) = current_coro; 4083\& ev_set_cb (w, current_coro);
3973\& switch_to (libev_coro); 4084\& switch_to (libev_coro);
3974\& } 4085\& }
3975.Ve 4086.Ve
3976.PP 4087.PP
3977That basically suspends the coroutine inside \f(CW\*(C`wait_for_event\*(C'\fR and 4088That 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 \- 4092You 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 4093instead 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 4094switching to a coroutine, you push the watcher onto the queue and notify
3984any waiters. 4095any waiters.
3985.PP 4096.PP
3986To embed libev, see \s-1EMBEDDING\s0, but in short, it's easiest to create two 4097To 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: 4098files, \fImy_ev.h\fR and \fImy_ev.c\fR that include the respective libev files:
3988.PP 4099.PP
3989.Vb 4 4100.Vb 4
3990\& // my_ev.h 4101\& // my_ev.h
3991\& #define EV_CB_DECLARE(type) struct my_coro *cb; 4102\& #define EV_CB_DECLARE(type) struct my_coro *cb;
3992\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb); 4103\& #define EV_CB_INVOKE(watcher) switch_to ((watcher)\->cb)
3993\& #include "../libev/ev.h" 4104\& #include "../libev/ev.h"
3994\& 4105\&
3995\& // my_ev.c 4106\& // my_ev.c
3996\& #define EV_H "my_ev.h" 4107\& #define EV_H "my_ev.h"
3997\& #include "../libev/ev.c" 4108\& #include "../libev/ev.c"
4030.IP "\(bu" 4 4141.IP "\(bu" 4
4031The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need 4142The libev emulation is \fInot\fR \s-1ABI\s0 compatible to libevent, you need
4032to use the libev header file and library. 4143to use the libev header file and library.
4033.SH "\*(C+ SUPPORT" 4144.SH "\*(C+ SUPPORT"
4034.IX Header " SUPPORT" 4145.IX Header " SUPPORT"
4146.SS "C \s-1API\s0"
4147.IX Subsection "C API"
4148The normal C \s-1API\s0 should work fine when used from \*(C+: both ev.h and the
4149libev sources can be compiled as \*(C+. Therefore, code that uses the C \s-1API\s0
4150will work fine.
4151.PP
4152Proper exception specifications might have to be added to callbacks passed
4153to libev: exceptions may be thrown only from watcher callbacks, all other
4154callbacks (allocator, syserr, loop acquire/release and periodic reschedule
4155callbacks) must not throw exceptions, and might need a \f(CW\*(C`noexcept\*(C'\fR
4156specification. If you have code that needs to be compiled as both C and
4157\&\*(C+ you can use the \f(CW\*(C`EV_NOEXCEPT\*(C'\fR macro for this:
4158.PP
4159.Vb 6
4160\& static void
4161\& fatal_error (const char *msg) EV_NOEXCEPT
4162\& {
4163\& perror (msg);
4164\& abort ();
4165\& }
4166\&
4167\& ...
4168\& ev_set_syserr_cb (fatal_error);
4169.Ve
4170.PP
4171The only \s-1API\s0 functions that can currently throw exceptions are \f(CW\*(C`ev_run\*(C'\fR,
4172\&\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
4173because it runs cleanup watchers).
4174.PP
4175Throwing exceptions in watcher callbacks is only supported if libev itself
4176is compiled with a \*(C+ compiler or your C and \*(C+ environments allow
4177throwing exceptions through C libraries (most do).
4178.SS "\*(C+ \s-1API\s0"
4179.IX Subsection " API"
4035Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow 4180Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
4036you to use some convenience methods to start/stop watchers and also change 4181you to use some convenience methods to start/stop watchers and also change
4037the callback model to a model using method callbacks on objects. 4182the callback model to a model using method callbacks on objects.
4038.PP 4183.PP
4039To use it, 4184To use it,
4055Currently, functions, static and non-static member functions and classes 4200Currently, functions, static and non-static member functions and classes
4056with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy 4201with \f(CW\*(C`operator ()\*(C'\fR can be used as callbacks. Other types should be easy
4057to add as long as they only need one additional pointer for context. If 4202to add as long as they only need one additional pointer for context. If
4058you need support for other types of functors please contact the author 4203you need support for other types of functors please contact the author
4059(preferably after implementing it). 4204(preferably after implementing it).
4205.PP
4206For all this to work, your \*(C+ compiler either has to use the same calling
4207conventions as your C compiler (for static member functions), or you have
4208to embed libev and compile libev itself as \*(C+.
4060.PP 4209.PP
4061Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace: 4210Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
4062.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4 4211.ie n .IP """ev::READ"", ""ev::WRITE"" etc." 4
4063.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4 4212.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
4064.IX Item "ev::READ, ev::WRITE etc." 4213.IX Item "ev::READ, ev::WRITE etc."
4145\& void operator() (ev::io &w, int revents) 4294\& void operator() (ev::io &w, int revents)
4146\& { 4295\& {
4147\& ... 4296\& ...
4148\& } 4297\& }
4149\& } 4298\& }
4150\& 4299\&
4151\& myfunctor f; 4300\& myfunctor f;
4152\& 4301\&
4153\& ev::io w; 4302\& ev::io w;
4154\& w.set (&f); 4303\& w.set (&f);
4155.Ve 4304.Ve
4173.IX Item "w->set (loop)" 4322.IX Item "w->set (loop)"
4174Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only 4323Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
4175do this when the watcher is inactive (and not pending either). 4324do this when the watcher is inactive (and not pending either).
4176.IP "w\->set ([arguments])" 4 4325.IP "w\->set ([arguments])" 4
4177.IX Item "w->set ([arguments])" 4326.IX Item "w->set ([arguments])"
4178Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same arguments. Either this 4327Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR (except for \f(CW\*(C`ev::embed\*(C'\fR watchers>),
4179method or a suitable start method must be called at least once. Unlike the 4328with the same arguments. Either this method or a suitable start method
4180C counterpart, an active watcher gets automatically stopped and restarted 4329must be called at least once. Unlike the C counterpart, an active watcher
4181when reconfiguring it with this method. 4330gets automatically stopped and restarted when reconfiguring it with this
4331method.
4332.Sp
4333For \f(CW\*(C`ev::embed\*(C'\fR watchers this method is called \f(CW\*(C`set_embed\*(C'\fR, to avoid
4334clashing with the \f(CW\*(C`set (loop)\*(C'\fR method.
4182.IP "w\->start ()" 4 4335.IP "w\->start ()" 4
4183.IX Item "w->start ()" 4336.IX Item "w->start ()"
4184Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the 4337Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument, as the
4185constructor already stores the event loop. 4338constructor already stores the event loop.
4186.IP "w\->start ([arguments])" 4 4339.IP "w\->start ([arguments])" 4
4244there are additional modules that implement libev-compatible interfaces 4397there are additional modules that implement libev-compatible interfaces
4245to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays), 4398to \f(CW\*(C`libadns\*(C'\fR (\f(CW\*(C`EV::ADNS\*(C'\fR, but \f(CW\*(C`AnyEvent::DNS\*(C'\fR is preferred nowadays),
4246\&\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 4399\&\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
4247and \f(CW\*(C`EV::Glib\*(C'\fR). 4400and \f(CW\*(C`EV::Glib\*(C'\fR).
4248.Sp 4401.Sp
4249It can be found and installed via \s-1CPAN\s0, its homepage is at 4402It can be found and installed via \s-1CPAN,\s0 its homepage is at
4250<http://software.schmorp.de/pkg/EV>. 4403<http://software.schmorp.de/pkg/EV>.
4251.IP "Python" 4 4404.IP "Python" 4
4252.IX Item "Python" 4405.IX Item "Python"
4253Python bindings can be found at <http://code.google.com/p/pyev/>. It 4406Python bindings can be found at <http://code.google.com/p/pyev/>. It
4254seems to be quite complete and well-documented. 4407seems to be quite complete and well-documented.
4262Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR 4415Roger Pack reports that using the link order \f(CW\*(C`\-lws2_32 \-lmsvcrt\-ruby\-190\*(C'\fR
4263makes rev work even on mingw. 4416makes rev work even on mingw.
4264.IP "Haskell" 4 4417.IP "Haskell" 4
4265.IX Item "Haskell" 4418.IX Item "Haskell"
4266A haskell binding to libev is available at 4419A haskell binding to libev is available at
4267http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev <http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>. 4420<http://hackage.haskell.org/cgi\-bin/hackage\-scripts/package/hlibev>.
4268.IP "D" 4 4421.IP "D" 4
4269.IX Item "D" 4422.IX Item "D"
4270Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to 4423Leandro Lucarella has written a D language binding (\fIev.d\fR) for libev, to
4271be found at <http://www.llucax.com.ar/proj/ev.d/index.html>. 4424be found at <http://www.llucax.com.ar/proj/ev.d/index.html>.
4272.IP "Ocaml" 4 4425.IP "Ocaml" 4
4273.IX Item "Ocaml" 4426.IX Item "Ocaml"
4274Erkki Seppala has written Ocaml bindings for libev, to be found at 4427Erkki Seppala has written Ocaml bindings for libev, to be found at
4275http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/ <http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 4428<http://modeemi.cs.tut.fi/~flux/software/ocaml\-ev/>.
4276.IP "Lua" 4 4429.IP "Lua" 4
4277.IX Item "Lua" 4430.IX Item "Lua"
4278Brian Maher has written a partial interface to libev for lua (at the 4431Brian Maher has written a partial interface to libev for lua (at the
4279time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at 4432time of this writing, only \f(CW\*(C`ev_io\*(C'\fR and \f(CW\*(C`ev_timer\*(C'\fR), to be found at
4280http://github.com/brimworks/lua\-ev <http://github.com/brimworks/lua-ev>. 4433<http://github.com/brimworks/lua\-ev>.
4434.IP "Javascript" 4
4435.IX Item "Javascript"
4436Node.js (<http://nodejs.org>) uses libev as the underlying event library.
4437.IP "Others" 4
4438.IX Item "Others"
4439There are others, and I stopped counting.
4281.SH "MACRO MAGIC" 4440.SH "MACRO MAGIC"
4282.IX Header "MACRO MAGIC" 4441.IX Header "MACRO MAGIC"
4283Libev can be compiled with a variety of options, the most fundamental 4442Libev can be compiled with a variety of options, the most fundamental
4284of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most) 4443of which is \f(CW\*(C`EV_MULTIPLICITY\*(C'\fR. This option determines whether (most)
4285functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument. 4444functions and callbacks have an initial \f(CW\*(C`struct ev_loop *\*(C'\fR argument.
4368.SS "\s-1FILESETS\s0" 4527.SS "\s-1FILESETS\s0"
4369.IX Subsection "FILESETS" 4528.IX Subsection "FILESETS"
4370Depending on what features you need you need to include one or more sets of files 4529Depending on what features you need you need to include one or more sets of files
4371in your application. 4530in your application.
4372.PP 4531.PP
4373\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR 4532\fI\s-1CORE EVENT LOOP\s0\fR
4374.IX Subsection "CORE EVENT LOOP" 4533.IX Subsection "CORE EVENT LOOP"
4375.PP 4534.PP
4376To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual 4535To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
4377configuration (no autoconf): 4536configuration (no autoconf):
4378.PP 4537.PP
4405\& ev_vars.h 4564\& ev_vars.h
4406\& ev_wrap.h 4565\& ev_wrap.h
4407\& 4566\&
4408\& ev_win32.c required on win32 platforms only 4567\& ev_win32.c required on win32 platforms only
4409\& 4568\&
4410\& ev_select.c only when select backend is enabled (which is enabled by default) 4569\& ev_select.c only when select backend is enabled
4411\& ev_poll.c only when poll backend is enabled (disabled by default) 4570\& ev_poll.c only when poll backend is enabled
4412\& ev_epoll.c only when the epoll backend is enabled (disabled by default) 4571\& ev_epoll.c only when the epoll backend is enabled
4413\& ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4572\& ev_kqueue.c only when the kqueue backend is enabled
4414\& ev_port.c only when the solaris port backend is enabled (disabled by default) 4573\& ev_port.c only when the solaris port backend is enabled
4415.Ve 4574.Ve
4416.PP 4575.PP
4417\&\fIev.c\fR includes the backend files directly when enabled, so you only need 4576\&\fIev.c\fR includes the backend files directly when enabled, so you only need
4418to compile this single file. 4577to compile this single file.
4419.PP 4578.PP
4420\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR 4579\fI\s-1LIBEVENT COMPATIBILITY API\s0\fR
4421.IX Subsection "LIBEVENT COMPATIBILITY API" 4580.IX Subsection "LIBEVENT COMPATIBILITY API"
4422.PP 4581.PP
4423To include the libevent compatibility \s-1API\s0, also include: 4582To include the libevent compatibility \s-1API,\s0 also include:
4424.PP 4583.PP
4425.Vb 1 4584.Vb 1
4426\& #include "event.c" 4585\& #include "event.c"
4427.Ve 4586.Ve
4428.PP 4587.PP
4430.PP 4589.PP
4431.Vb 1 4590.Vb 1
4432\& #include "event.h" 4591\& #include "event.h"
4433.Ve 4592.Ve
4434.PP 4593.PP
4435in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR. 4594in the files that want to use the libevent \s-1API.\s0 This also includes \fIev.h\fR.
4436.PP 4595.PP
4437You need the following additional files for this: 4596You need the following additional files for this:
4438.PP 4597.PP
4439.Vb 2 4598.Vb 2
4440\& event.h 4599\& event.h
4441\& event.c 4600\& event.c
4442.Ve 4601.Ve
4443.PP 4602.PP
4444\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR 4603\fI\s-1AUTOCONF SUPPORT\s0\fR
4445.IX Subsection "AUTOCONF SUPPORT" 4604.IX Subsection "AUTOCONF SUPPORT"
4446.PP 4605.PP
4447Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in 4606Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your configuration in
4448whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your 4607whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
4449\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then 4608\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR undefined. \fIev.c\fR will then
4452For this of course you need the m4 file: 4611For this of course you need the m4 file:
4453.PP 4612.PP
4454.Vb 1 4613.Vb 1
4455\& libev.m4 4614\& libev.m4
4456.Ve 4615.Ve
4457.SS "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0" 4616.SS "\s-1PREPROCESSOR SYMBOLS/MACROS\s0"
4458.IX Subsection "PREPROCESSOR SYMBOLS/MACROS" 4617.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
4459Libev can be configured via a variety of preprocessor symbols you have to 4618Libev can be configured via a variety of preprocessor symbols you have to
4460define before including (or compiling) any of its files. The default in 4619define before including (or compiling) any of its files. The default in
4461the absence of autoconf is documented for every option. 4620the absence of autoconf is documented for every option.
4462.PP 4621.PP
4463Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI\s0, and can have different 4622Symbols marked with \*(L"(h)\*(R" do not change the \s-1ABI,\s0 and can have different
4464values when compiling libev vs. including \fIev.h\fR, so it is permissible 4623values when compiling libev vs. including \fIev.h\fR, so it is permissible
4465to redefine them before including \fIev.h\fR without breaking compatibility 4624to redefine them before including \fIev.h\fR without breaking compatibility
4466to a compiled library. All other symbols change the \s-1ABI\s0, which means all 4625to a compiled library. All other symbols change the \s-1ABI,\s0 which means all
4467users of libev and the libev code itself must be compiled with compatible 4626users of libev and the libev code itself must be compiled with compatible
4468settings. 4627settings.
4469.IP "\s-1EV_COMPAT3\s0 (h)" 4 4628.IP "\s-1EV_COMPAT3\s0 (h)" 4
4470.IX Item "EV_COMPAT3 (h)" 4629.IX Item "EV_COMPAT3 (h)"
4471Backwards compatibility is a major concern for libev. This is why this 4630Backwards compatibility is a major concern for libev. This is why this
4580.IX Item "EV_WIN32_CLOSE_FD(fd)" 4739.IX Item "EV_WIN32_CLOSE_FD(fd)"
4581If programs implement their own fd to handle mapping on win32, then this 4740If programs implement their own fd to handle mapping on win32, then this
4582macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister 4741macro can be used to override the \f(CW\*(C`close\*(C'\fR function, useful to unregister
4583file descriptors again. Note that the replacement function has to close 4742file descriptors again. Note that the replacement function has to close
4584the underlying \s-1OS\s0 handle. 4743the underlying \s-1OS\s0 handle.
4744.IP "\s-1EV_USE_WSASOCKET\s0" 4
4745.IX Item "EV_USE_WSASOCKET"
4746If defined to be \f(CW1\fR, libev will use \f(CW\*(C`WSASocket\*(C'\fR to create its internal
4747communication socket, which works better in some environments. Otherwise,
4748the normal \f(CW\*(C`socket\*(C'\fR function will be used, which works better in other
4749environments.
4585.IP "\s-1EV_USE_POLL\s0" 4 4750.IP "\s-1EV_USE_POLL\s0" 4
4586.IX Item "EV_USE_POLL" 4751.IX Item "EV_USE_POLL"
4587If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2) 4752If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
4588backend. Otherwise it will be enabled on non\-win32 platforms. It 4753backend. Otherwise it will be enabled on non\-win32 platforms. It
4589takes precedence over select. 4754takes precedence over select.
4626between threads, that is, threads can be used, but threads never run on 4791between threads, that is, threads can be used, but threads never run on
4627different cpus (or different cpu cores). This reduces dependencies 4792different cpus (or different cpu cores). This reduces dependencies
4628and makes libev faster. 4793and makes libev faster.
4629.IP "\s-1EV_NO_THREADS\s0" 4 4794.IP "\s-1EV_NO_THREADS\s0" 4
4630.IX Item "EV_NO_THREADS" 4795.IX Item "EV_NO_THREADS"
4631If defined to be \f(CW1\fR, libev will assume that it will never be called 4796If defined to be \f(CW1\fR, libev will assume that it will never be called from
4632from different threads, which is a stronger assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, 4797different threads (that includes signal handlers), which is a stronger
4633above. This reduces dependencies and makes libev faster. 4798assumption than \f(CW\*(C`EV_NO_SMP\*(C'\fR, above. This reduces dependencies and makes
4799libev faster.
4634.IP "\s-1EV_ATOMIC_T\s0" 4 4800.IP "\s-1EV_ATOMIC_T\s0" 4
4635.IX Item "EV_ATOMIC_T" 4801.IX Item "EV_ATOMIC_T"
4636Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose 4802Libev requires an integer type (suitable for storing \f(CW0\fR or \f(CW1\fR) whose
4637access is atomic and serialised with respect to other threads or signal 4803access is atomic with respect to other threads or signal contexts. No
4638contexts. No such type is easily found in the C language, so you can 4804such type is easily found in the C language, so you can provide your own
4639provide your own type that you know is safe for your purposes. It is used 4805type that you know is safe for your purposes. It is used both for signal
4640both for signal handler \*(L"locking\*(R" as well as for signal and thread safety 4806handler \*(L"locking\*(R" as well as for signal and thread safety in \f(CW\*(C`ev_async\*(C'\fR
4641in \f(CW\*(C`ev_async\*(C'\fR watchers. 4807watchers.
4642.Sp 4808.Sp
4643In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR 4809In the absence of this define, libev will use \f(CW\*(C`sig_atomic_t volatile\*(C'\fR
4644(from \fIsignal.h\fR), which is usually good enough on most platforms, 4810(from \fIsignal.h\fR), which is usually good enough on most platforms.
4645although strictly speaking using a type that also implies a memory fence
4646is required.
4647.IP "\s-1EV_H\s0 (h)" 4 4811.IP "\s-1EV_H\s0 (h)" 4
4648.IX Item "EV_H (h)" 4812.IX Item "EV_H (h)"
4649The name of the \fIev.h\fR header file used to include it. The default if 4813The name of the \fIev.h\fR header file used to include it. The default if
4650undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be 4814undefined is \f(CW"ev.h"\fR in \fIevent.h\fR, \fIev.c\fR and \fIev++.h\fR. This can be
4651used to virtually rename the \fIev.h\fR header file in case of conflicts. 4815used to virtually rename the \fIev.h\fR header file in case of conflicts.
4690all the priorities, so having many of them (hundreds) uses a lot of space 4854all the priorities, so having many of them (hundreds) uses a lot of space
4691and time, so using the defaults of five priorities (\-2 .. +2) is usually 4855and time, so using the defaults of five priorities (\-2 .. +2) is usually
4692fine. 4856fine.
4693.Sp 4857.Sp
4694If your embedding application does not need any priorities, defining these 4858If your embedding application does not need any priorities, defining these
4695both to \f(CW0\fR will save some memory and \s-1CPU\s0. 4859both to \f(CW0\fR will save some memory and \s-1CPU.\s0
4696.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 4860.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
4697.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." 4861.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."
4698If undefined or defined to be \f(CW1\fR (and the platform supports it), then 4862If undefined or defined to be \f(CW1\fR (and the platform supports it), then
4699the respective watcher type is supported. If defined to be \f(CW0\fR, then it 4863the respective watcher type is supported. If defined to be \f(CW0\fR, then it
4700is not. Disabling watcher types mainly saves code size. 4864is not. Disabling watcher types mainly saves code size.
4701.IP "\s-1EV_FEATURES\s0" 4 4865.IP "\s-1EV_FEATURES\s0" 4
4718\& #define EV_CHILD_ENABLE 1 4882\& #define EV_CHILD_ENABLE 1
4719\& #define EV_ASYNC_ENABLE 1 4883\& #define EV_ASYNC_ENABLE 1
4720.Ve 4884.Ve
4721.Sp 4885.Sp
4722The actual value is a bitset, it can be a combination of the following 4886The actual value is a bitset, it can be a combination of the following
4723values: 4887values (by default, all of these are enabled):
4724.RS 4 4888.RS 4
4725.ie n .IP "1 \- faster/larger code" 4 4889.ie n .IP "1 \- faster/larger code" 4
4726.el .IP "\f(CW1\fR \- faster/larger code" 4 4890.el .IP "\f(CW1\fR \- faster/larger code" 4
4727.IX Item "1 - faster/larger code" 4891.IX Item "1 - faster/larger code"
4728Use larger code to speed up some operations. 4892Use larger code to speed up some operations.
4731code size by roughly 30% on amd64). 4895code size by roughly 30% on amd64).
4732.Sp 4896.Sp
4733When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with 4897When optimising for size, use of compiler flags such as \f(CW\*(C`\-Os\*(C'\fR with
4734gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of 4898gcc is recommended, as well as \f(CW\*(C`\-DNDEBUG\*(C'\fR, as libev contains a number of
4735assertions. 4899assertions.
4900.Sp
4901The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4902(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4736.ie n .IP "2 \- faster/larger data structures" 4 4903.ie n .IP "2 \- faster/larger data structures" 4
4737.el .IP "\f(CW2\fR \- faster/larger data structures" 4 4904.el .IP "\f(CW2\fR \- faster/larger data structures" 4
4738.IX Item "2 - faster/larger data structures" 4905.IX Item "2 - faster/larger data structures"
4739Replaces the small 2\-heap for timer management by a faster 4\-heap, larger 4906Replaces the small 2\-heap for timer management by a faster 4\-heap, larger
4740hash table sizes and so on. This will usually further increase code size 4907hash table sizes and so on. This will usually further increase code size
4741and can additionally have an effect on the size of data structures at 4908and can additionally have an effect on the size of data structures at
4742runtime. 4909runtime.
4910.Sp
4911The default is off when \f(CW\*(C`_\|_OPTIMIZE_SIZE_\|_\*(C'\fR is defined by your compiler
4912(e.g. gcc with \f(CW\*(C`\-Os\*(C'\fR).
4743.ie n .IP "4 \- full \s-1API\s0 configuration" 4 4913.ie n .IP "4 \- full \s-1API\s0 configuration" 4
4744.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4 4914.el .IP "\f(CW4\fR \- full \s-1API\s0 configuration" 4
4745.IX Item "4 - full API configuration" 4915.IX Item "4 - full API configuration"
4746This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and 4916This enables priorities (sets \f(CW\*(C`EV_MAXPRI\*(C'\fR=2 and \f(CW\*(C`EV_MINPRI\*(C'\fR=\-2), and
4747enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1). 4917enables multiplicity (\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR=1).
4883and the way callbacks are invoked and set. Must expand to a struct member 5053and the way callbacks are invoked and set. Must expand to a struct member
4884definition and a statement, respectively. See the \fIev.h\fR header file for 5054definition and a statement, respectively. See the \fIev.h\fR header file for
4885their default definitions. One possible use for overriding these is to 5055their default definitions. One possible use for overriding these is to
4886avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use 5056avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use
4887method calls instead of plain function calls in \*(C+. 5057method calls instead of plain function calls in \*(C+.
4888.SS "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" 5058.SS "\s-1EXPORTED API SYMBOLS\s0"
4889.IX Subsection "EXPORTED API SYMBOLS" 5059.IX Subsection "EXPORTED API SYMBOLS"
4890If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of 5060If you need to re-export the \s-1API\s0 (e.g. via a \s-1DLL\s0) and you need a list of
4891exported symbols, you can use the provided \fISymbol.*\fR files which list 5061exported symbols, you can use the provided \fISymbol.*\fR files which list
4892all public symbols, one per line: 5062all public symbols, one per line:
4893.PP 5063.PP
4947\& #include "ev_cpp.h" 5117\& #include "ev_cpp.h"
4948\& #include "ev.c" 5118\& #include "ev.c"
4949.Ve 5119.Ve
4950.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5120.SH "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4951.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT" 5121.IX Header "INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT"
4952.SS "\s-1THREADS\s0 \s-1AND\s0 \s-1COROUTINES\s0" 5122.SS "\s-1THREADS AND COROUTINES\s0"
4953.IX Subsection "THREADS AND COROUTINES" 5123.IX Subsection "THREADS AND COROUTINES"
4954\fI\s-1THREADS\s0\fR 5124\fI\s-1THREADS\s0\fR
4955.IX Subsection "THREADS" 5125.IX Subsection "THREADS"
4956.PP 5126.PP
4957All libev functions are reentrant and thread-safe unless explicitly 5127All libev functions are reentrant and thread-safe unless explicitly
5003An example use would be to communicate signals or other events that only 5173An example use would be to communicate signals or other events that only
5004work in the default loop by registering the signal watcher with the 5174work in the default loop by registering the signal watcher with the
5005default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop 5175default loop and triggering an \f(CW\*(C`ev_async\*(C'\fR watcher from the default loop
5006watcher callback into the event loop interested in the signal. 5176watcher callback into the event loop interested in the signal.
5007.PP 5177.PP
5008See also \*(L"\s-1THREAD\s0 \s-1LOCKING\s0 \s-1EXAMPLE\s0\*(R". 5178See also \*(L"\s-1THREAD LOCKING EXAMPLE\*(R"\s0.
5009.PP 5179.PP
5010\fI\s-1COROUTINES\s0\fR 5180\fI\s-1COROUTINES\s0\fR
5011.IX Subsection "COROUTINES" 5181.IX Subsection "COROUTINES"
5012.PP 5182.PP
5013Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"): 5183Libev is very accommodating to coroutines (\*(L"cooperative threads\*(R"):
5018that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks. 5188that you must not do this from \f(CW\*(C`ev_periodic\*(C'\fR reschedule callbacks.
5019.PP 5189.PP
5020Care has been taken to ensure that libev does not keep local state inside 5190Care has been taken to ensure that libev does not keep local state inside
5021\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as 5191\&\f(CW\*(C`ev_run\*(C'\fR, and other calls do not usually allow for coroutine switches as
5022they do not call any callbacks. 5192they do not call any callbacks.
5023.SS "\s-1COMPILER\s0 \s-1WARNINGS\s0" 5193.SS "\s-1COMPILER WARNINGS\s0"
5024.IX Subsection "COMPILER WARNINGS" 5194.IX Subsection "COMPILER WARNINGS"
5025Depending on your compiler and compiler settings, you might get no or a 5195Depending on your compiler and compiler settings, you might get no or a
5026lot of warnings when compiling libev code. Some people are apparently 5196lot of warnings when compiling libev code. Some people are apparently
5027scared by this. 5197scared by this.
5028.PP 5198.PP
5080.PP 5250.PP
5081If you need, for some reason, empty reports from valgrind for your project 5251If you need, for some reason, empty reports from valgrind for your project
5082I suggest using suppression lists. 5252I suggest using suppression lists.
5083.SH "PORTABILITY NOTES" 5253.SH "PORTABILITY NOTES"
5084.IX Header "PORTABILITY NOTES" 5254.IX Header "PORTABILITY NOTES"
5085.SS "\s-1GNU/LINUX\s0 32 \s-1BIT\s0 \s-1LIMITATIONS\s0" 5255.SS "\s-1GNU/LINUX 32 BIT LIMITATIONS\s0"
5086.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS" 5256.IX Subsection "GNU/LINUX 32 BIT LIMITATIONS"
5087GNU/Linux is the only common platform that supports 64 bit file/large file 5257GNU/Linux is the only common platform that supports 64 bit file/large file
5088interfaces but \fIdisables\fR them by default. 5258interfaces but \fIdisables\fR them by default.
5089.PP 5259.PP
5090That means that libev compiled in the default environment doesn't support 5260That means that libev compiled in the default environment doesn't support
5091files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers. 5261files larger than 2GiB or so, which mainly affects \f(CW\*(C`ev_stat\*(C'\fR watchers.
5092.PP 5262.PP
5093Unfortunately, many programs try to work around this GNU/Linux issue 5263Unfortunately, many programs try to work around this GNU/Linux issue
5094by enabling the large file \s-1API\s0, which makes them incompatible with the 5264by enabling the large file \s-1API,\s0 which makes them incompatible with the
5095standard libev compiled for their system. 5265standard libev compiled for their system.
5096.PP 5266.PP
5097Likewise, libev cannot enable the large file \s-1API\s0 itself as this would 5267Likewise, libev cannot enable the large file \s-1API\s0 itself as this would
5098suddenly make it incompatible to the default compile time environment, 5268suddenly make it incompatible to the default compile time environment,
5099i.e. all programs not using special compile switches. 5269i.e. all programs not using special compile switches.
5100.SS "\s-1OS/X\s0 \s-1AND\s0 \s-1DARWIN\s0 \s-1BUGS\s0" 5270.SS "\s-1OS/X AND DARWIN BUGS\s0"
5101.IX Subsection "OS/X AND DARWIN BUGS" 5271.IX Subsection "OS/X AND DARWIN BUGS"
5102The whole thing is a bug if you ask me \- basically any system interface 5272The whole thing is a bug if you ask me \- basically any system interface
5103you touch is broken, whether it is locales, poll, kqueue or even the 5273you touch is broken, whether it is locales, poll, kqueue or even the
5104OpenGL drivers. 5274OpenGL drivers.
5105.PP 5275.PP
5127.PP 5297.PP
5128\fI\f(CI\*(C`select\*(C'\fI is buggy\fR 5298\fI\f(CI\*(C`select\*(C'\fI is buggy\fR
5129.IX Subsection "select is buggy" 5299.IX Subsection "select is buggy"
5130.PP 5300.PP
5131All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this 5301All that's left is \f(CW\*(C`select\*(C'\fR, and of course Apple found a way to fuck this
5132one up as well: On \s-1OS/X\s0, \f(CW\*(C`select\*(C'\fR actively limits the number of file 5302one up as well: On \s-1OS/X,\s0 \f(CW\*(C`select\*(C'\fR actively limits the number of file
5133descriptors you can pass in to 1024 \- your program suddenly crashes when 5303descriptors you can pass in to 1024 \- your program suddenly crashes when
5134you use more. 5304you use more.
5135.PP 5305.PP
5136There is an undocumented \*(L"workaround\*(R" for this \- defining 5306There is an undocumented \*(L"workaround\*(R" for this \- defining
5137\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR 5307\&\f(CW\*(C`_DARWIN_UNLIMITED_SELECT\*(C'\fR, which libev tries to use, so select \fIshould\fR
5138work on \s-1OS/X\s0. 5308work on \s-1OS/X.\s0
5139.SS "\s-1SOLARIS\s0 \s-1PROBLEMS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5309.SS "\s-1SOLARIS PROBLEMS AND WORKAROUNDS\s0"
5140.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS" 5310.IX Subsection "SOLARIS PROBLEMS AND WORKAROUNDS"
5141\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR 5311\fI\f(CI\*(C`errno\*(C'\fI reentrancy\fR
5142.IX Subsection "errno reentrancy" 5312.IX Subsection "errno reentrancy"
5143.PP 5313.PP
5144The default compile environment on Solaris is unfortunately so 5314The default compile environment on Solaris is unfortunately so
5161great. 5331great.
5162.PP 5332.PP
5163If you can't get it to work, you can try running the program by setting 5333If you can't get it to work, you can try running the program by setting
5164the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and 5334the environment variable \f(CW\*(C`LIBEV_FLAGS=3\*(C'\fR to only allow \f(CW\*(C`poll\*(C'\fR and
5165\&\f(CW\*(C`select\*(C'\fR backends. 5335\&\f(CW\*(C`select\*(C'\fR backends.
5166.SS "\s-1AIX\s0 \s-1POLL\s0 \s-1BUG\s0" 5336.SS "\s-1AIX POLL BUG\s0"
5167.IX Subsection "AIX POLL BUG" 5337.IX Subsection "AIX POLL BUG"
5168\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around 5338\&\s-1AIX\s0 unfortunately has a broken \f(CW\*(C`poll.h\*(C'\fR header. Libev works around
5169this by trying to avoid the poll backend altogether (i.e. it's not even 5339this by trying to avoid the poll backend altogether (i.e. it's not even
5170compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine 5340compiled in), which normally isn't a big problem as \f(CW\*(C`select\*(C'\fR works fine
5171with large bitsets on \s-1AIX\s0, and \s-1AIX\s0 is dead anyway. 5341with large bitsets on \s-1AIX,\s0 and \s-1AIX\s0 is dead anyway.
5172.SS "\s-1WIN32\s0 \s-1PLATFORM\s0 \s-1LIMITATIONS\s0 \s-1AND\s0 \s-1WORKAROUNDS\s0" 5342.SS "\s-1WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS\s0"
5173.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS" 5343.IX Subsection "WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS"
5174\fIGeneral issues\fR 5344\fIGeneral issues\fR
5175.IX Subsection "General issues" 5345.IX Subsection "General issues"
5176.PP 5346.PP
5177Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev 5347Win32 doesn't support any of the standards (e.g. \s-1POSIX\s0) that libev
5246\& #define EV_USE_SELECT 1 5416\& #define EV_USE_SELECT 1
5247\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 5417\& #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
5248.Ve 5418.Ve
5249.PP 5419.PP
5250Note that winsockets handling of fd sets is O(n), so you can easily get a 5420Note that winsockets handling of fd sets is O(n), so you can easily get a
5251complexity in the O(nA\*^X) range when using win32. 5421complexity in the O(nX) range when using win32.
5252.PP 5422.PP
5253\fILimited number of file descriptors\fR 5423\fILimited number of file descriptors\fR
5254.IX Subsection "Limited number of file descriptors" 5424.IX Subsection "Limited number of file descriptors"
5255.PP 5425.PP
5256Windows has numerous arbitrary (and low) limits on things. 5426Windows has numerous arbitrary (and low) limits on things.
5272by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR 5442by calling \f(CW\*(C`_setmaxstdio\*(C'\fR, which can increase this limit to \f(CW2048\fR
5273(another arbitrary limit), but is broken in many versions of the Microsoft 5443(another arbitrary limit), but is broken in many versions of the Microsoft
5274runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets 5444runtime libraries. This might get you to about \f(CW512\fR or \f(CW2048\fR sockets
5275(depending on windows version and/or the phase of the moon). To get more, 5445(depending on windows version and/or the phase of the moon). To get more,
5276you need to wrap all I/O functions and provide your own fd management, but 5446you need to wrap all I/O functions and provide your own fd management, but
5277the cost of calling select (O(nA\*^X)) will likely make this unworkable. 5447the cost of calling select (O(nX)) will likely make this unworkable.
5278.SS "\s-1PORTABILITY\s0 \s-1REQUIREMENTS\s0" 5448.SS "\s-1PORTABILITY REQUIREMENTS\s0"
5279.IX Subsection "PORTABILITY REQUIREMENTS" 5449.IX Subsection "PORTABILITY REQUIREMENTS"
5280In addition to a working ISO-C implementation and of course the 5450In addition to a working ISO-C implementation and of course the
5281backend-specific APIs, libev relies on a few additional extensions: 5451backend-specific APIs, libev relies on a few additional extensions:
5282.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4 5452.ie n .IP """void (*)(ev_watcher_type *, int revents)"" must have compatible calling conventions regardless of ""ev_watcher_type *""." 4
5283.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4 5453.el .IP "\f(CWvoid (*)(ev_watcher_type *, int revents)\fR must have compatible calling conventions regardless of \f(CWev_watcher_type *\fR." 4
5284.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *." 5454.IX Item "void (*)(ev_watcher_type *, int revents) must have compatible calling conventions regardless of ev_watcher_type *."
5285Libev assumes not only that all watcher pointers have the same internal 5455Libev assumes not only that all watcher pointers have the same internal
5286structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO\s0 C for example), but it also 5456structure (guaranteed by \s-1POSIX\s0 but not by \s-1ISO C\s0 for example), but it also
5287assumes that the same (machine) code can be used to call any watcher 5457assumes that the same (machine) code can be used to call any watcher
5288callback: The watcher callbacks have different type signatures, but libev 5458callback: The watcher callbacks have different type signatures, but libev
5289calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally. 5459calls them using an \f(CW\*(C`ev_watcher *\*(C'\fR internally.
5460.IP "null pointers and integer zero are represented by 0 bytes" 4
5461.IX Item "null pointers and integer zero are represented by 0 bytes"
5462Libev uses \f(CW\*(C`memset\*(C'\fR to initialise structs and arrays to \f(CW0\fR bytes, and
5463relies on this setting pointers and integers to null.
5290.IP "pointer accesses must be thread-atomic" 4 5464.IP "pointer accesses must be thread-atomic" 4
5291.IX Item "pointer accesses must be thread-atomic" 5465.IX Item "pointer accesses must be thread-atomic"
5292Accessing a pointer value must be atomic, it must both be readable and 5466Accessing a pointer value must be atomic, it must both be readable and
5293writable in one piece \- this is the case on all current architectures. 5467writable in one piece \- this is the case on all current architectures.
5294.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4 5468.ie n .IP """sig_atomic_t volatile"" must be thread-atomic as well" 4
5307thread\*(R" or will block signals process-wide, both behaviours would 5481thread\*(R" or will block signals process-wide, both behaviours would
5308be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and 5482be compatible with libev. Interaction between \f(CW\*(C`sigprocmask\*(C'\fR and
5309\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however. 5483\&\f(CW\*(C`pthread_sigmask\*(C'\fR could complicate things, however.
5310.Sp 5484.Sp
5311The most portable way to handle signals is to block signals in all threads 5485The most portable way to handle signals is to block signals in all threads
5312except the initial one, and run the default loop in the initial thread as 5486except the initial one, and run the signal handling loop in the initial
5313well. 5487thread as well.
5314.ie n .IP """long"" must be large enough for common memory allocation sizes" 4 5488.ie n .IP """long"" must be large enough for common memory allocation sizes" 4
5315.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4 5489.el .IP "\f(CWlong\fR must be large enough for common memory allocation sizes" 4
5316.IX Item "long must be large enough for common memory allocation sizes" 5490.IX Item "long must be large enough for common memory allocation sizes"
5317To improve portability and simplify its \s-1API\s0, libev uses \f(CW\*(C`long\*(C'\fR internally 5491To improve portability and simplify its \s-1API,\s0 libev uses \f(CW\*(C`long\*(C'\fR internally
5318instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX 5492instead of \f(CW\*(C`size_t\*(C'\fR when allocating its data structures. On non-POSIX
5319systems (Microsoft...) this might be unexpectedly low, but is still at 5493systems (Microsoft...) this might be unexpectedly low, but is still at
5320least 31 bits everywhere, which is enough for hundreds of millions of 5494least 31 bits everywhere, which is enough for hundreds of millions of
5321watchers. 5495watchers.
5322.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4 5496.ie n .IP """double"" must hold a time value in seconds with enough accuracy" 4
5324.IX Item "double must hold a time value in seconds with enough accuracy" 5498.IX Item "double must hold a time value in seconds with enough accuracy"
5325The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to 5499The type \f(CW\*(C`double\*(C'\fR is used to represent timestamps. It is required to
5326have at least 51 bits of mantissa (and 9 bits of exponent), which is 5500have at least 51 bits of mantissa (and 9 bits of exponent), which is
5327good enough for at least into the year 4000 with millisecond accuracy 5501good enough for at least into the year 4000 with millisecond accuracy
5328(the design goal for libev). This requirement is overfulfilled by 5502(the design goal for libev). This requirement is overfulfilled by
5329implementations using \s-1IEEE\s0 754, which is basically all existing ones. 5503implementations using \s-1IEEE 754,\s0 which is basically all existing ones.
5330.Sp 5504.Sp
5331With \s-1IEEE\s0 754 doubles, you get microsecond accuracy until at least the 5505With \s-1IEEE 754\s0 doubles, you get microsecond accuracy until at least the
5332year 2255 (and millisecond accuracy till the year 287396 \- by then, libev 5506year 2255 (and millisecond accuracy till the year 287396 \- by then, libev
5333is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or 5507is either obsolete or somebody patched it to use \f(CW\*(C`long double\*(C'\fR or
5334something like that, just kidding). 5508something like that, just kidding).
5335.PP 5509.PP
5336If you know of other additional requirements drop me a note. 5510If you know of other additional requirements drop me a note.
5398calls in the current loop iteration and the loop is currently 5572calls in the current loop iteration and the loop is currently
5399blocked. Checking for async and signal events involves iterating over all 5573blocked. Checking for async and signal events involves iterating over all
5400running async watchers or all signal numbers. 5574running async watchers or all signal numbers.
5401.SH "PORTING FROM LIBEV 3.X TO 4.X" 5575.SH "PORTING FROM LIBEV 3.X TO 4.X"
5402.IX Header "PORTING FROM LIBEV 3.X TO 4.X" 5576.IX Header "PORTING FROM LIBEV 3.X TO 4.X"
5403The major version 4 introduced some incompatible changes to the \s-1API\s0. 5577The major version 4 introduced some incompatible changes to the \s-1API.\s0
5404.PP 5578.PP
5405At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions 5579At the moment, the \f(CW\*(C`ev.h\*(C'\fR header file provides compatibility definitions
5406for all changes, so most programs should still compile. The compatibility 5580for all changes, so most programs should still compile. The compatibility
5407layer might be removed in later versions of libev, so better update to the 5581layer might be removed in later versions of libev, so better update to the
5408new \s-1API\s0 early than late. 5582new \s-1API\s0 early than late.
5409.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4 5583.ie n .IP """EV_COMPAT3"" backwards compatibility mechanism" 4
5410.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4 5584.el .IP "\f(CWEV_COMPAT3\fR backwards compatibility mechanism" 4
5411.IX Item "EV_COMPAT3 backwards compatibility mechanism" 5585.IX Item "EV_COMPAT3 backwards compatibility mechanism"
5412The backward compatibility mechanism can be controlled by 5586The backward compatibility mechanism can be controlled by
5413\&\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 5587\&\f(CW\*(C`EV_COMPAT3\*(C'\fR. See \*(L"\s-1PREPROCESSOR SYMBOLS/MACROS\*(R"\s0 in the \*(L"\s-1EMBEDDING\*(R"\s0
5414section. 5588section.
5415.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4 5589.ie n .IP """ev_default_destroy"" and ""ev_default_fork"" have been removed" 4
5416.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4 5590.el .IP "\f(CWev_default_destroy\fR and \f(CWev_default_fork\fR have been removed" 4
5417.IX Item "ev_default_destroy and ev_default_fork have been removed" 5591.IX Item "ev_default_destroy and ev_default_fork have been removed"
5418These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts: 5592These calls can be replaced easily by their \f(CW\*(C`ev_loop_xxx\*(C'\fR counterparts:
5458.SH "GLOSSARY" 5632.SH "GLOSSARY"
5459.IX Header "GLOSSARY" 5633.IX Header "GLOSSARY"
5460.IP "active" 4 5634.IP "active" 4
5461.IX Item "active" 5635.IX Item "active"
5462A watcher is active as long as it has been started and not yet stopped. 5636A watcher is active as long as it has been started and not yet stopped.
5463See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5637See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5464.IP "application" 4 5638.IP "application" 4
5465.IX Item "application" 5639.IX Item "application"
5466In this document, an application is whatever is using libev. 5640In this document, an application is whatever is using libev.
5467.IP "backend" 4 5641.IP "backend" 4
5468.IX Item "backend" 5642.IX Item "backend"
5495The model used to describe how an event loop handles and processes 5669The model used to describe how an event loop handles and processes
5496watchers and events. 5670watchers and events.
5497.IP "pending" 4 5671.IP "pending" 4
5498.IX Item "pending" 5672.IX Item "pending"
5499A watcher is pending as soon as the corresponding event has been 5673A watcher is pending as soon as the corresponding event has been
5500detected. See \*(L"\s-1WATCHER\s0 \s-1STATES\s0\*(R" for details. 5674detected. See \*(L"\s-1WATCHER STATES\*(R"\s0 for details.
5501.IP "real time" 4 5675.IP "real time" 4
5502.IX Item "real time" 5676.IX Item "real time"
5503The physical time that is observed. It is apparently strictly monotonic :) 5677The physical time that is observed. It is apparently strictly monotonic :)
5504.IP "wall-clock time" 4 5678.IP "wall-clock time" 4
5505.IX Item "wall-clock time" 5679.IX Item "wall-clock time"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines