[ViewVC] Diff of: cvs/libev/ev.html

Comparing libev/ev.html (file contents):
Revision 1.36 by root, Sat Nov 24 06:23:27 2007 UTC vs.
Revision 1.77 by root, Wed Dec 12 04:53:58 2007 UTC

…		…
4	<head>	4	<head>
5	<title>libev</title>	5	<title>libev</title>
6	<meta name="description" content="Pod documentation for libev" />	6	<meta name="description" content="Pod documentation for libev" />
7	<meta name="inputfile" content="<standard input>" />	7	<meta name="inputfile" content="<standard input>" />
8	<meta name="outputfile" content="<standard output>" />	8	<meta name="outputfile" content="<standard output>" />
9	<meta name="created" content="Sat Nov 24 05:58:35 2007" />	9	<meta name="created" content="Wed Dec 12 05:53:55 2007" />
10	<meta name="generator" content="Pod::Xhtml 1.57" />	10	<meta name="generator" content="Pod::Xhtml 1.57" />
11	<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>	11	<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12	<body>	12	<body>
13	<div class="pod">	13	<div class="pod">
14	<!-- INDEX START -->	14	<!-- INDEX START -->
15	<h3 id="TOP">Index</h3>	15	<h3 id="TOP">Index</h3>
16		16
17	<ul><li><a href="#NAME">NAME</a></li>	17	<ul><li><a href="#NAME">NAME</a></li>
18	<li><a href="#SYNOPSIS">SYNOPSIS</a></li>	18	<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
		19	<li><a href="#EXAMPLE_PROGRAM">EXAMPLE PROGRAM</a></li>
19	<li><a href="#DESCRIPTION">DESCRIPTION</a></li>	20	<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
20	<li><a href="#FEATURES">FEATURES</a></li>	21	<li><a href="#FEATURES">FEATURES</a></li>
21	<li><a href="#CONVENTIONS">CONVENTIONS</a></li>	22	<li><a href="#CONVENTIONS">CONVENTIONS</a></li>
22	<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li>	23	<li><a href="#TIME_REPRESENTATION">TIME REPRESENTATION</a></li>
23	<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li>	24	<li><a href="#GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</a></li>
24	<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>	25	<li><a href="#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</a></li>
25	<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>	26	<li><a href="#ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</a>
		27	<ul><li><a href="#GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</a></li>
26	<ul><li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>	28	<li><a href="#ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</a></li>
27	</ul>	29	</ul>
28	</li>	30	</li>
29	<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>	31	<li><a href="#WATCHER_TYPES">WATCHER TYPES</a>
30	<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</a></li>	32	<ul><li><a href="#code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</a>
		33	<ul><li><a href="#The_special_problem_of_disappearing_">The special problem of disappearing file descriptors</a></li>
		34	</ul>
		35	</li>
31	<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</a></li>	36	<li><a href="#code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</a></li>
32	<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</a></li>	37	<li><a href="#code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</a></li>
33	<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</a></li>	38	<li><a href="#code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</a></li>
34	<li><a href="#code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</a></li>	39	<li><a href="#code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</a></li>
		40	<li><a href="#code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</a></li>
35	<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li>	41	<li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</a></li>
36	<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li>	42	<li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</a></li>
37	<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough</a></li>	43	<li><a href="#code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</a></li>
		44	<li><a href="#code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</a></li>
38	</ul>	45	</ul>
39	</li>	46	</li>
40	<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>	47	<li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li>
41	<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>	48	<li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li>
42	<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>	49	<li><a href="#C_SUPPORT">C++ SUPPORT</a></li>
		50	<li><a href="#MACRO_MAGIC">MACRO MAGIC</a></li>
		51	<li><a href="#EMBEDDING">EMBEDDING</a>
		52	<ul><li><a href="#FILESETS">FILESETS</a>
		53	<ul><li><a href="#CORE_EVENT_LOOP">CORE EVENT LOOP</a></li>
		54	<li><a href="#LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</a></li>
		55	<li><a href="#AUTOCONF_SUPPORT">AUTOCONF SUPPORT</a></li>
		56	</ul>
		57	</li>
		58	<li><a href="#PREPROCESSOR_SYMBOLS_MACROS">PREPROCESSOR SYMBOLS/MACROS</a></li>
		59	<li><a href="#EXAMPLES">EXAMPLES</a></li>
		60	</ul>
		61	</li>
		62	<li><a href="#COMPLEXITIES">COMPLEXITIES</a></li>
43	<li><a href="#AUTHOR">AUTHOR</a>	63	<li><a href="#AUTHOR">AUTHOR</a>
44	</li>	64	</li>
45	</ul><hr />	65	</ul><hr />
46	<!-- INDEX END -->	66	<!-- INDEX END -->
47		67
48	<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>	68	<h1 id="NAME">NAME</h1>
49	<div id="NAME_CONTENT">	69	<div id="NAME_CONTENT">
50	<p>libev - a high performance full-featured event loop written in C</p>	70	<p>libev - a high performance full-featured event loop written in C</p>
51		71
52	</div>	72	</div>
53	<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>	73	<h1 id="SYNOPSIS">SYNOPSIS</h1>
54	<div id="SYNOPSIS_CONTENT">	74	<div id="SYNOPSIS_CONTENT">
55	<pre> #include <ev.h>	75	<pre> #include <ev.h>
56		76
57	</pre>	77	</pre>
58		78
59	</div>	79	</div>
60	<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>	80	<h1 id="EXAMPLE_PROGRAM">EXAMPLE PROGRAM</h1>
		81	<div id="EXAMPLE_PROGRAM_CONTENT">
		82	<pre> #include <ev.h>
		83
		84	ev_io stdin_watcher;
		85	ev_timer timeout_watcher;
		86
		87	/* called when data readable on stdin */
		88	static void
		89	stdin_cb (EV_P_ struct ev_io *w, int revents)
		90	{
		91	/* puts ("stdin ready"); */
		92	ev_io_stop (EV_A_ w); /* just a syntax example */
		93	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
		94	}
		95
		96	static void
		97	timeout_cb (EV_P_ struct ev_timer *w, int revents)
		98	{
		99	/* puts ("timeout"); */
		100	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
		101	}
		102
		103	int
		104	main (void)
		105	{
		106	struct ev_loop *loop = ev_default_loop (0);
		107
		108	/* initialise an io watcher, then start it */
		109	ev_io_init (&stdin_watcher, stdin_cb, /STDIN_FILENO/ 0, EV_READ);
		110	ev_io_start (loop, &stdin_watcher);
		111
		112	/* simple non-repeating 5.5 second timeout */
		113	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		114	ev_timer_start (loop, &timeout_watcher);
		115
		116	/* loop till timeout or data ready */
		117	ev_loop (loop, 0);
		118
		119	return 0;
		120	}
		121
		122	</pre>
		123
		124	</div>
		125	<h1 id="DESCRIPTION">DESCRIPTION</h1>
61	<div id="DESCRIPTION_CONTENT">	126	<div id="DESCRIPTION_CONTENT">
		127	<p>The newest version of this document is also available as a html-formatted
		128	web page you might find easier to navigate when reading it for the first
		129	time: <a href="http://cvs.schmorp.de/libev/ev.html">http://cvs.schmorp.de/libev/ev.html</a>.</p>
62	<p>Libev is an event loop: you register interest in certain events (such as a	130	<p>Libev is an event loop: you register interest in certain events (such as a
63	file descriptor being readable or a timeout occuring), and it will manage	131	file descriptor being readable or a timeout occuring), and it will manage
64	these event sources and provide your program with events.</p>	132	these event sources and provide your program with events.</p>
65	<p>To do this, it must take more or less complete control over your process	133	<p>To do this, it must take more or less complete control over your process
66	(or thread) by executing the <i>event loop</i> handler, and will then	134	(or thread) by executing the <i>event loop</i> handler, and will then
…		…
69	watchers</i>, which are relatively small C structures you initialise with the	137	watchers</i>, which are relatively small C structures you initialise with the
70	details of the event, and then hand it over to libev by <i>starting</i> the	138	details of the event, and then hand it over to libev by <i>starting</i> the
71	watcher.</p>	139	watcher.</p>
72		140
73	</div>	141	</div>
74	<h1 id="FEATURES">FEATURES</h1><p><a href="#TOP" class="toplink">Top</a></p>	142	<h1 id="FEATURES">FEATURES</h1>
75	<div id="FEATURES_CONTENT">	143	<div id="FEATURES_CONTENT">
76	<p>Libev supports select, poll, the linux-specific epoll and the bsd-specific	144	<p>Libev supports <code>select</code>, <code>poll</code>, the Linux-specific <code>epoll</code>, the
77	kqueue mechanisms for file descriptor events, relative timers, absolute	145	BSD-specific <code>kqueue</code> and the Solaris-specific event port mechanisms
78	timers with customised rescheduling, signal events, process status change	146	for file descriptor events (<code>ev_io</code>), the Linux <code>inotify</code> interface
79	events (related to SIGCHLD), and event watchers dealing with the event	147	(for <code>ev_stat</code>), relative timers (<code>ev_timer</code>), absolute timers
80	loop mechanism itself (idle, prepare and check watchers). It also is quite	148	with customised rescheduling (<code>ev_periodic</code>), synchronous signals
		149	(<code>ev_signal</code>), process status change events (<code>ev_child</code>), and event
		150	watchers dealing with the event loop mechanism itself (<code>ev_idle</code>,
		151	<code>ev_embed</code>, <code>ev_prepare</code> and <code>ev_check</code> watchers) as well as
		152	file watchers (<code>ev_stat</code>) and even limited support for fork events
		153	(<code>ev_fork</code>).</p>
		154	<p>It also is quite fast (see this
81	fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing	155	<a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing it to libevent
82	it to libevent for example).</p>	156	for example).</p>
83		157
84	</div>	158	</div>
85	<h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>	159	<h1 id="CONVENTIONS">CONVENTIONS</h1>
86	<div id="CONVENTIONS_CONTENT">	160	<div id="CONVENTIONS_CONTENT">
87	<p>Libev is very configurable. In this manual the default configuration	161	<p>Libev is very configurable. In this manual the default configuration will
88	will be described, which supports multiple event loops. For more info	162	be described, which supports multiple event loops. For more info about
89	about various configuration options please have a look at the file	163	various configuration options please have a look at <strong>EMBED</strong> section in
90	<cite>README.embed</cite> in the libev distribution. If libev was configured without	164	this manual. If libev was configured without support for multiple event
91	support for multiple event loops, then all functions taking an initial	165	loops, then all functions taking an initial argument of name <code>loop</code>
92	argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>)	166	(which is always of type <code>struct ev_loop *</code>) will not have this argument.</p>
93	will not have this argument.</p>
94		167
95	</div>	168	</div>
96	<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>	169	<h1 id="TIME_REPRESENTATION">TIME REPRESENTATION</h1>
97	<div id="TIME_REPRESENTATION_CONTENT">	170	<div id="TIME_REPRESENTATION_CONTENT">
98	<p>Libev represents time as a single floating point number, representing the	171	<p>Libev represents time as a single floating point number, representing the
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	172	(fractional) number of seconds since the (POSIX) epoch (somewhere near
100	the beginning of 1970, details are complicated, don't ask). This type is	173	the beginning of 1970, details are complicated, don't ask). This type is
101	called <code>ev_tstamp</code>, which is what you should use too. It usually aliases	174	called <code>ev_tstamp</code>, which is what you should use too. It usually aliases
102	to the <code>double</code> type in C, and when you need to do any calculations on	175	to the <code>double</code> type in C, and when you need to do any calculations on
103	it, you should treat it as such.</p>	176	it, you should treat it as such.</p>
104		177
105
106
107
108
109	</div>	178	</div>
110	<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>	179	<h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1>
111	<div id="GLOBAL_FUNCTIONS_CONTENT">	180	<div id="GLOBAL_FUNCTIONS_CONTENT">
112	<p>These functions can be called anytime, even before initialising the	181	<p>These functions can be called anytime, even before initialising the
113	library in any way.</p>	182	library in any way.</p>
114	<dl>	183	<dl>
115	<dt>ev_tstamp ev_time ()</dt>	184	<dt>ev_tstamp ev_time ()</dt>
…		…
119	you actually want to know.</p>	188	you actually want to know.</p>
120	</dd>	189	</dd>
121	<dt>int ev_version_major ()</dt>	190	<dt>int ev_version_major ()</dt>
122	<dt>int ev_version_minor ()</dt>	191	<dt>int ev_version_minor ()</dt>
123	<dd>	192	<dd>
124	<p>You can find out the major and minor version numbers of the library	193	<p>You can find out the major and minor ABI version numbers of the library
125	you linked against by calling the functions <code>ev_version_major</code> and	194	you linked against by calling the functions <code>ev_version_major</code> and
126	<code>ev_version_minor</code>. If you want, you can compare against the global	195	<code>ev_version_minor</code>. If you want, you can compare against the global
127	symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the	196	symbols <code>EV_VERSION_MAJOR</code> and <code>EV_VERSION_MINOR</code>, which specify the
128	version of the library your program was compiled against.</p>	197	version of the library your program was compiled against.</p>
		198	<p>These version numbers refer to the ABI version of the library, not the
		199	release version.</p>
129	<p>Usually, it's a good idea to terminate if the major versions mismatch,	200	<p>Usually, it's a good idea to terminate if the major versions mismatch,
130	as this indicates an incompatible change. Minor versions are usually	201	as this indicates an incompatible change. Minor versions are usually
131	compatible to older versions, so a larger minor version alone is usually	202	compatible to older versions, so a larger minor version alone is usually
132	not a problem.</p>	203	not a problem.</p>
133	<p>Example: make sure we haven't accidentally been linked against the wrong	204	<p>Example: Make sure we haven't accidentally been linked against the wrong
134	version:</p>	205	version.</p>
135	<pre> assert (("libev version mismatch",	206	<pre> assert (("libev version mismatch",
136	ev_version_major () == EV_VERSION_MAJOR	207	ev_version_major () == EV_VERSION_MAJOR
137	&& ev_version_minor () >= EV_VERSION_MINOR));	208	&& ev_version_minor () >= EV_VERSION_MINOR));
138		209
139	</pre>	210	</pre>
…		…
169	recommended ones.</p>	240	recommended ones.</p>
170	<p>See the description of <code>ev_embed</code> watchers for more info.</p>	241	<p>See the description of <code>ev_embed</code> watchers for more info.</p>
171	</dd>	242	</dd>
172	<dt>ev_set_allocator (void (cb)(void *ptr, long size))</dt>	243	<dt>ev_set_allocator (void (cb)(void *ptr, long size))</dt>
173	<dd>	244	<dd>
174	<p>Sets the allocation function to use (the prototype is similar to the	245	<p>Sets the allocation function to use (the prototype is similar - the
175	realloc C function, the semantics are identical). It is used to allocate	246	semantics is identical - to the realloc C function). It is used to
176	and free memory (no surprises here). If it returns zero when memory	247	allocate and free memory (no surprises here). If it returns zero when
177	needs to be allocated, the library might abort or take some potentially	248	memory needs to be allocated, the library might abort or take some
178	destructive action. The default is your system realloc function.</p>	249	potentially destructive action. The default is your system realloc
		250	function.</p>
179	<p>You could override this function in high-availability programs to, say,	251	<p>You could override this function in high-availability programs to, say,
180	free some memory if it cannot allocate memory, to use a special allocator,	252	free some memory if it cannot allocate memory, to use a special allocator,
181	or even to sleep a while and retry until some memory is available.</p>	253	or even to sleep a while and retry until some memory is available.</p>
182	<p>Example: replace the libev allocator with one that waits a bit and then	254	<p>Example: Replace the libev allocator with one that waits a bit and then
183	retries: better than mine).</p>	255	retries).</p>
184	<pre> static void *	256	<pre> static void *
185	persistent_realloc (void *ptr, long size)	257	persistent_realloc (void *ptr, size_t size)
186	{	258	{
187	for (;;)	259	for (;;)
188	{	260	{
189	void *newptr = realloc (ptr, size);	261	void *newptr = realloc (ptr, size);
190		262
…		…
207	indicating the system call or subsystem causing the problem. If this	279	indicating the system call or subsystem causing the problem. If this
208	callback is set, then libev will expect it to remedy the sitution, no	280	callback is set, then libev will expect it to remedy the sitution, no
209	matter what, when it returns. That is, libev will generally retry the	281	matter what, when it returns. That is, libev will generally retry the
210	requested operation, or, if the condition doesn't go away, do bad stuff	282	requested operation, or, if the condition doesn't go away, do bad stuff
211	(such as abort).</p>	283	(such as abort).</p>
212	<p>Example: do the same thing as libev does internally:</p>	284	<p>Example: This is basically the same thing that libev does internally, too.</p>
213	<pre> static void	285	<pre> static void
214	fatal_error (const char *msg)	286	fatal_error (const char *msg)
215	{	287	{
216	perror (msg);	288	perror (msg);
217	abort ();	289	abort ();
…		…
223	</pre>	295	</pre>
224	</dd>	296	</dd>
225	</dl>	297	</dl>
226		298
227	</div>	299	</div>
228	<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1><p><a href="#TOP" class="toplink">Top</a></p>	300	<h1 id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP">FUNCTIONS CONTROLLING THE EVENT LOOP</h1>
229	<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2">	301	<div id="FUNCTIONS_CONTROLLING_THE_EVENT_LOOP-2">
230	<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two	302	<p>An event loop is described by a <code>struct ev_loop *</code>. The library knows two
231	types of such loops, the <i>default</i> loop, which supports signals and child	303	types of such loops, the <i>default</i> loop, which supports signals and child
232	events, and dynamically created loops which do not.</p>	304	events, and dynamically created loops which do not.</p>
233	<p>If you use threads, a common model is to run the default event loop	305	<p>If you use threads, a common model is to run the default event loop
…		…
262	<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will	334	<code>LIBEV_FLAGS</code>. Otherwise (the default), this environment variable will
263	override the flags completely if it is found in the environment. This is	335	override the flags completely if it is found in the environment. This is
264	useful to try out specific backends to test their performance, or to work	336	useful to try out specific backends to test their performance, or to work
265	around bugs.</p>	337	around bugs.</p>
266	</dd>	338	</dd>
		339	<dt><code>EVFLAG_FORKCHECK</code></dt>
		340	<dd>
		341	<p>Instead of calling <code>ev_default_fork</code> or <code>ev_loop_fork</code> manually after
		342	a fork, you can also make libev check for a fork in each iteration by
		343	enabling this flag.</p>
		344	<p>This works by calling <code>getpid ()</code> on every iteration of the loop,
		345	and thus this might slow down your event loop if you do a lot of loop
		346	iterations and little real work, but is usually not noticeable (on my
		347	Linux system for example, <code>getpid</code> is actually a simple 5-insn sequence
		348	without a syscall and thus <i>very</i> fast, but my Linux system also has
		349	<code>pthread_atfork</code> which is even faster).</p>
		350	<p>The big advantage of this flag is that you can forget about fork (and
		351	forget about forgetting to tell libev about forking) when you use this
		352	flag.</p>
		353	<p>This flag setting cannot be overriden or specified in the <code>LIBEV_FLAGS</code>
		354	environment variable.</p>
		355	</dd>
267	<dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt>	356	<dt><code>EVBACKEND_SELECT</code> (value 1, portable select backend)</dt>
268	<dd>	357	<dd>
269	<p>This is your standard select(2) backend. Not <i>completely</i> standard, as	358	<p>This is your standard select(2) backend. Not <i>completely</i> standard, as
270	libev tries to roll its own fd_set with no limits on the number of fds,	359	libev tries to roll its own fd_set with no limits on the number of fds,
271	but if that fails, expect a fairly low limit on the number of fds when	360	but if that fails, expect a fairly low limit on the number of fds when
…		…
353	<dd>	442	<dd>
354	<p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is	443	<p>Similar to <code>ev_default_loop</code>, but always creates a new event loop that is
355	always distinct from the default loop. Unlike the default loop, it cannot	444	always distinct from the default loop. Unlike the default loop, it cannot
356	handle signal and child watchers, and attempts to do so will be greeted by	445	handle signal and child watchers, and attempts to do so will be greeted by
357	undefined behaviour (or a failed assertion if assertions are enabled).</p>	446	undefined behaviour (or a failed assertion if assertions are enabled).</p>
358	<p>Example: try to create a event loop that uses epoll and nothing else.</p>	447	<p>Example: Try to create a event loop that uses epoll and nothing else.</p>
359	<pre> struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	448	<pre> struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
360	if (!epoller)	449	if (!epoller)
361	fatal ("no epoll found here, maybe it hides under your chair");	450	fatal ("no epoll found here, maybe it hides under your chair");
362		451
363	</pre>	452	</pre>
364	</dd>	453	</dd>
365	<dt>ev_default_destroy ()</dt>	454	<dt>ev_default_destroy ()</dt>
366	<dd>	455	<dd>
367	<p>Destroys the default loop again (frees all memory and kernel state	456	<p>Destroys the default loop again (frees all memory and kernel state
368	etc.). This stops all registered event watchers (by not touching them in	457	etc.). None of the active event watchers will be stopped in the normal
369	any way whatsoever, although you cannot rely on this :).</p>	458	sense, so e.g. <code>ev_is_active</code> might still return true. It is your
		459	responsibility to either stop all watchers cleanly yoursef <i>before</i>
		460	calling this function, or cope with the fact afterwards (which is usually
		461	the easiest thing, youc na just ignore the watchers and/or <code>free ()</code> them
		462	for example).</p>
370	</dd>	463	</dd>
371	<dt>ev_loop_destroy (loop)</dt>	464	<dt>ev_loop_destroy (loop)</dt>
372	<dd>	465	<dd>
373	<p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an	466	<p>Like <code>ev_default_destroy</code>, but destroys an event loop created by an
374	earlier call to <code>ev_loop_new</code>.</p>	467	earlier call to <code>ev_loop_new</code>.</p>
…		…
395	<dt>ev_loop_fork (loop)</dt>	488	<dt>ev_loop_fork (loop)</dt>
396	<dd>	489	<dd>
397	<p>Like <code>ev_default_fork</code>, but acts on an event loop created by	490	<p>Like <code>ev_default_fork</code>, but acts on an event loop created by
398	<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop	491	<code>ev_loop_new</code>. Yes, you have to call this on every allocated event loop
399	after fork, and how you do this is entirely your own problem.</p>	492	after fork, and how you do this is entirely your own problem.</p>
		493	</dd>
		494	<dt>unsigned int ev_loop_count (loop)</dt>
		495	<dd>
		496	<p>Returns the count of loop iterations for the loop, which is identical to
		497	the number of times libev did poll for new events. It starts at <code>0</code> and
		498	happily wraps around with enough iterations.</p>
		499	<p>This value can sometimes be useful as a generation counter of sorts (it
		500	"ticks" the number of loop iterations), as it roughly corresponds with
		501	<code>ev_prepare</code> and <code>ev_check</code> calls.</p>
400	</dd>	502	</dd>
401	<dt>unsigned int ev_backend (loop)</dt>	503	<dt>unsigned int ev_backend (loop)</dt>
402	<dd>	504	<dd>
403	<p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in	505	<p>Returns one of the <code>EVBACKEND_*</code> flags indicating the event backend in
404	use.</p>	506	use.</p>
…		…
432	one iteration of the loop. This is useful if you are waiting for some	534	one iteration of the loop. This is useful if you are waiting for some
433	external event in conjunction with something not expressible using other	535	external event in conjunction with something not expressible using other
434	libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is	536	libev watchers. However, a pair of <code>ev_prepare</code>/<code>ev_check</code> watchers is
435	usually a better approach for this kind of thing.</p>	537	usually a better approach for this kind of thing.</p>
436	<p>Here are the gory details of what <code>ev_loop</code> does:</p>	538	<p>Here are the gory details of what <code>ev_loop</code> does:</p>
		539	<pre> - Before the first iteration, call any pending watchers.
437	<pre> * If there are no active watchers (reference count is zero), return.	540	* If there are no active watchers (reference count is zero), return.
438	- Queue prepare watchers and then call all outstanding watchers.	541	- Queue all prepare watchers and then call all outstanding watchers.
439	- If we have been forked, recreate the kernel state.	542	- If we have been forked, recreate the kernel state.
440	- Update the kernel state with all outstanding changes.	543	- Update the kernel state with all outstanding changes.
441	- Update the "event loop time".	544	- Update the "event loop time".
442	- Calculate for how long to block.	545	- Calculate for how long to block.
443	- Block the process, waiting for any events.	546	- Block the process, waiting for any events.
…		…
452	be handled here by queueing them when their watcher gets executed.	555	be handled here by queueing them when their watcher gets executed.
453	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	556	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
454	were used, return, otherwise continue with step *.	557	were used, return, otherwise continue with step *.
455		558
456	</pre>	559	</pre>
457	<p>Example: queue some jobs and then loop until no events are outsanding	560	<p>Example: Queue some jobs and then loop until no events are outsanding
458	anymore.</p>	561	anymore.</p>
459	<pre> ... queue jobs here, make sure they register event watchers as long	562	<pre> ... queue jobs here, make sure they register event watchers as long
460	... as they still have work to do (even an idle watcher will do..)	563	... as they still have work to do (even an idle watcher will do..)
461	ev_loop (my_loop, 0);	564	ev_loop (my_loop, 0);
462	... jobs done. yeah!	565	... jobs done. yeah!
…		…
481	example, libev itself uses this for its internal signal pipe: It is not	584	example, libev itself uses this for its internal signal pipe: It is not
482	visible to the libev user and should not keep <code>ev_loop</code> from exiting if	585	visible to the libev user and should not keep <code>ev_loop</code> from exiting if
483	no event watchers registered by it are active. It is also an excellent	586	no event watchers registered by it are active. It is also an excellent
484	way to do this for generic recurring timers or from within third-party	587	way to do this for generic recurring timers or from within third-party
485	libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p>	588	libraries. Just remember to <i>unref after start</i> and <i>ref before stop</i>.</p>
486	<p>Example: create a signal watcher, but keep it from keeping <code>ev_loop</code>	589	<p>Example: Create a signal watcher, but keep it from keeping <code>ev_loop</code>
487	running when nothing else is active.</p>	590	running when nothing else is active.</p>
488	<pre> struct dv_signal exitsig;	591	<pre> struct ev_signal exitsig;
489	ev_signal_init (&exitsig, sig_cb, SIGINT);	592	ev_signal_init (&exitsig, sig_cb, SIGINT);
490	ev_signal_start (myloop, &exitsig);	593	ev_signal_start (loop, &exitsig);
491	evf_unref (myloop);	594	evf_unref (loop);
492		595
493	</pre>	596	</pre>
494	<p>Example: for some weird reason, unregister the above signal handler again.</p>	597	<p>Example: For some weird reason, unregister the above signal handler again.</p>
495	<pre> ev_ref (myloop);	598	<pre> ev_ref (loop);
496	ev_signal_stop (myloop, &exitsig);	599	ev_signal_stop (loop, &exitsig);
497		600
498	</pre>	601	</pre>
499	</dd>	602	</dd>
500	</dl>	603	</dl>
501		604
		605
		606
		607
		608
502	</div>	609	</div>
503	<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1><p><a href="#TOP" class="toplink">Top</a></p>	610	<h1 id="ANATOMY_OF_A_WATCHER">ANATOMY OF A WATCHER</h1>
504	<div id="ANATOMY_OF_A_WATCHER_CONTENT">	611	<div id="ANATOMY_OF_A_WATCHER_CONTENT">
505	<p>A watcher is a structure that you create and register to record your	612	<p>A watcher is a structure that you create and register to record your
506	interest in some event. For instance, if you want to wait for STDIN to	613	interest in some event. For instance, if you want to wait for STDIN to
507	become readable, you would create an <code>ev_io</code> watcher for that:</p>	614	become readable, you would create an <code>ev_io</code> watcher for that:</p>
508	<pre> static void my_cb (struct ev_loop loop, struct ev_io w, int revents)	615	<pre> static void my_cb (struct ev_loop loop, struct ev_io w, int revents)
…		…
535	with a watcher-specific start function (<code>ev_<type>_start (loop, watcher	642	with a watcher-specific start function (<code>ev_<type>_start (loop, watcher
536	*)</code>), and you can stop watching for events at any time by calling the	643	*)</code>), and you can stop watching for events at any time by calling the
537	corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p>	644	corresponding stop function (<code>ev_<type>_stop (loop, watcher *)</code>.</p>
538	<p>As long as your watcher is active (has been started but not stopped) you	645	<p>As long as your watcher is active (has been started but not stopped) you
539	must not touch the values stored in it. Most specifically you must never	646	must not touch the values stored in it. Most specifically you must never
540	reinitialise it or call its set macro.</p>	647	reinitialise it or call its <code>set</code> macro.</p>
541	<p>You can check whether an event is active by calling the <code>ev_is_active
542	(watcher *)</code> macro. To see whether an event is outstanding (but the
543	callback for it has not been called yet) you can use the <code>ev_is_pending
544	(watcher *)</code> macro.</p>
545	<p>Each and every callback receives the event loop pointer as first, the	648	<p>Each and every callback receives the event loop pointer as first, the
546	registered watcher structure as second, and a bitset of received events as	649	registered watcher structure as second, and a bitset of received events as
547	third argument.</p>	650	third argument.</p>
548	<p>The received events usually include a single bit per event type received	651	<p>The received events usually include a single bit per event type received
549	(you can receive multiple events at the same time). The possible bit masks	652	(you can receive multiple events at the same time). The possible bit masks
…		…
569	</dd>	672	</dd>
570	<dt><code>EV_CHILD</code></dt>	673	<dt><code>EV_CHILD</code></dt>
571	<dd>	674	<dd>
572	<p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>	675	<p>The pid specified in the <code>ev_child</code> watcher has received a status change.</p>
573	</dd>	676	</dd>
		677	<dt><code>EV_STAT</code></dt>
		678	<dd>
		679	<p>The path specified in the <code>ev_stat</code> watcher changed its attributes somehow.</p>
		680	</dd>
574	<dt><code>EV_IDLE</code></dt>	681	<dt><code>EV_IDLE</code></dt>
575	<dd>	682	<dd>
576	<p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>	683	<p>The <code>ev_idle</code> watcher has determined that you have nothing better to do.</p>
577	</dd>	684	</dd>
578	<dt><code>EV_PREPARE</code></dt>	685	<dt><code>EV_PREPARE</code></dt>
…		…
583	<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any	690	<code>ev_loop</code> has gathered them, but before it invokes any callbacks for any
584	received events. Callbacks of both watcher types can start and stop as	691	received events. Callbacks of both watcher types can start and stop as
585	many watchers as they want, and all of them will be taken into account	692	many watchers as they want, and all of them will be taken into account
586	(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep	693	(for example, a <code>ev_prepare</code> watcher might start an idle watcher to keep
587	<code>ev_loop</code> from blocking).</p>	694	<code>ev_loop</code> from blocking).</p>
		695	</dd>
		696	<dt><code>EV_EMBED</code></dt>
		697	<dd>
		698	<p>The embedded event loop specified in the <code>ev_embed</code> watcher needs attention.</p>
		699	</dd>
		700	<dt><code>EV_FORK</code></dt>
		701	<dd>
		702	<p>The event loop has been resumed in the child process after fork (see
		703	<code>ev_fork</code>).</p>
588	</dd>	704	</dd>
589	<dt><code>EV_ERROR</code></dt>	705	<dt><code>EV_ERROR</code></dt>
590	<dd>	706	<dd>
591	<p>An unspecified error has occured, the watcher has been stopped. This might	707	<p>An unspecified error has occured, the watcher has been stopped. This might
592	happen because the watcher could not be properly started because libev	708	happen because the watcher could not be properly started because libev
…		…
600	programs, though, so beware.</p>	716	programs, though, so beware.</p>
601	</dd>	717	</dd>
602	</dl>	718	</dl>
603		719
604	</div>	720	</div>
		721	<h2 id="GENERIC_WATCHER_FUNCTIONS">GENERIC WATCHER FUNCTIONS</h2>
		722	<div id="GENERIC_WATCHER_FUNCTIONS_CONTENT">
		723	<p>In the following description, <code>TYPE</code> stands for the watcher type,
		724	e.g. <code>timer</code> for <code>ev_timer</code> watchers and <code>io</code> for <code>ev_io</code> watchers.</p>
		725	<dl>
		726	<dt><code>ev_init</code> (ev_TYPE *watcher, callback)</dt>
		727	<dd>
		728	<p>This macro initialises the generic portion of a watcher. The contents
		729	of the watcher object can be arbitrary (so <code>malloc</code> will do). Only
		730	the generic parts of the watcher are initialised, you <i>need</i> to call
		731	the type-specific <code>ev_TYPE_set</code> macro afterwards to initialise the
		732	type-specific parts. For each type there is also a <code>ev_TYPE_init</code> macro
		733	which rolls both calls into one.</p>
		734	<p>You can reinitialise a watcher at any time as long as it has been stopped
		735	(or never started) and there are no pending events outstanding.</p>
		736	<p>The callback is always of type <code>void ()(ev_loop loop, ev_TYPE *watcher,
		737	int revents)</code>.</p>
		738	</dd>
		739	<dt><code>ev_TYPE_set</code> (ev_TYPE *, [args])</dt>
		740	<dd>
		741	<p>This macro initialises the type-specific parts of a watcher. You need to
		742	call <code>ev_init</code> at least once before you call this macro, but you can
		743	call <code>ev_TYPE_set</code> any number of times. You must not, however, call this
		744	macro on a watcher that is active (it can be pending, however, which is a
		745	difference to the <code>ev_init</code> macro).</p>
		746	<p>Although some watcher types do not have type-specific arguments
		747	(e.g. <code>ev_prepare</code>) you still need to call its <code>set</code> macro.</p>
		748	</dd>
		749	<dt><code>ev_TYPE_init</code> (ev_TYPE *watcher, callback, [args])</dt>
		750	<dd>
		751	<p>This convinience macro rolls both <code>ev_init</code> and <code>ev_TYPE_set</code> macro
		752	calls into a single call. This is the most convinient method to initialise
		753	a watcher. The same limitations apply, of course.</p>
		754	</dd>
		755	<dt><code>ev_TYPE_start</code> (loop , ev_TYPE watcher)</dt>
		756	<dd>
		757	<p>Starts (activates) the given watcher. Only active watchers will receive
		758	events. If the watcher is already active nothing will happen.</p>
		759	</dd>
		760	<dt><code>ev_TYPE_stop</code> (loop , ev_TYPE watcher)</dt>
		761	<dd>
		762	<p>Stops the given watcher again (if active) and clears the pending
		763	status. It is possible that stopped watchers are pending (for example,
		764	non-repeating timers are being stopped when they become pending), but
		765	<code>ev_TYPE_stop</code> ensures that the watcher is neither active nor pending. If
		766	you want to free or reuse the memory used by the watcher it is therefore a
		767	good idea to always call its <code>ev_TYPE_stop</code> function.</p>
		768	</dd>
		769	<dt>bool ev_is_active (ev_TYPE *watcher)</dt>
		770	<dd>
		771	<p>Returns a true value iff the watcher is active (i.e. it has been started
		772	and not yet been stopped). As long as a watcher is active you must not modify
		773	it.</p>
		774	</dd>
		775	<dt>bool ev_is_pending (ev_TYPE *watcher)</dt>
		776	<dd>
		777	<p>Returns a true value iff the watcher is pending, (i.e. it has outstanding
		778	events but its callback has not yet been invoked). As long as a watcher
		779	is pending (but not active) you must not call an init function on it (but
		780	<code>ev_TYPE_set</code> is safe), you must not change its priority, and you must
		781	make sure the watcher is available to libev (e.g. you cannot <code>free ()</code>
		782	it).</p>
		783	</dd>
		784	<dt>callback ev_cb (ev_TYPE *watcher)</dt>
		785	<dd>
		786	<p>Returns the callback currently set on the watcher.</p>
		787	</dd>
		788	<dt>ev_cb_set (ev_TYPE *watcher, callback)</dt>
		789	<dd>
		790	<p>Change the callback. You can change the callback at virtually any time
		791	(modulo threads).</p>
		792	</dd>
		793	<dt>ev_set_priority (ev_TYPE *watcher, priority)</dt>
		794	<dt>int ev_priority (ev_TYPE *watcher)</dt>
		795	<dd>
		796	<p>Set and query the priority of the watcher. The priority is a small
		797	integer between <code>EV_MAXPRI</code> (default: <code>2</code>) and <code>EV_MINPRI</code>
		798	(default: <code>-2</code>). Pending watchers with higher priority will be invoked
		799	before watchers with lower priority, but priority will not keep watchers
		800	from being executed (except for <code>ev_idle</code> watchers).</p>
		801	<p>This means that priorities are <i>only</i> used for ordering callback
		802	invocation after new events have been received. This is useful, for
		803	example, to reduce latency after idling, or more often, to bind two
		804	watchers on the same event and make sure one is called first.</p>
		805	<p>If you need to suppress invocation when higher priority events are pending
		806	you need to look at <code>ev_idle</code> watchers, which provide this functionality.</p>
		807	<p>You <i>must not</i> change the priority of a watcher as long as it is active or
		808	pending.</p>
		809	<p>The default priority used by watchers when no priority has been set is
		810	always <code>0</code>, which is supposed to not be too high and not be too low :).</p>
		811	<p>Setting a priority outside the range of <code>EV_MINPRI</code> to <code>EV_MAXPRI</code> is
		812	fine, as long as you do not mind that the priority value you query might
		813	or might not have been adjusted to be within valid range.</p>
		814	</dd>
		815	<dt>ev_invoke (loop, ev_TYPE *watcher, int revents)</dt>
		816	<dd>
		817	<p>Invoke the <code>watcher</code> with the given <code>loop</code> and <code>revents</code>. Neither
		818	<code>loop</code> nor <code>revents</code> need to be valid as long as the watcher callback
		819	can deal with that fact.</p>
		820	</dd>
		821	<dt>int ev_clear_pending (loop, ev_TYPE *watcher)</dt>
		822	<dd>
		823	<p>If the watcher is pending, this function returns clears its pending status
		824	and returns its <code>revents</code> bitset (as if its callback was invoked). If the
		825	watcher isn't pending it does nothing and returns <code>0</code>.</p>
		826	</dd>
		827	</dl>
		828
		829
		830
		831
		832
		833	</div>
605	<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>	834	<h2 id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH">ASSOCIATING CUSTOM DATA WITH A WATCHER</h2>
606	<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">	835	<div id="ASSOCIATING_CUSTOM_DATA_WITH_A_WATCH-2">
607	<p>Each watcher has, by default, a member <code>void *data</code> that you can change	836	<p>Each watcher has, by default, a member <code>void *data</code> that you can change
608	and read at any time, libev will completely ignore it. This can be used	837	and read at any time, libev will completely ignore it. This can be used
609	to associate arbitrary data with your watcher. If you need more data and	838	to associate arbitrary data with your watcher. If you need more data and
…		…
626	struct my_io w = (struct my_io )w_;	855	struct my_io w = (struct my_io )w_;
627	...	856	...
628	}	857	}
629		858
630	</pre>	859	</pre>
631	<p>More interesting and less C-conformant ways of catsing your callback type	860	<p>More interesting and less C-conformant ways of casting your callback type
632	have been omitted....</p>	861	instead have been omitted.</p>
		862	<p>Another common scenario is having some data structure with multiple
		863	watchers:</p>
		864	<pre> struct my_biggy
		865	{
		866	int some_data;
		867	ev_timer t1;
		868	ev_timer t2;
		869	}
633		870
		871	</pre>
		872	<p>In this case getting the pointer to <code>my_biggy</code> is a bit more complicated,
		873	you need to use <code>offsetof</code>:</p>
		874	<pre> #include <stddef.h>
634		875
		876	static void
		877	t1_cb (EV_P_ struct ev_timer *w, int revents)
		878	{
		879	struct my_biggy big = (struct my_biggy *
		880	(((char *)w) - offsetof (struct my_biggy, t1));
		881	}
635		882
		883	static void
		884	t2_cb (EV_P_ struct ev_timer *w, int revents)
		885	{
		886	struct my_biggy big = (struct my_biggy *
		887	(((char *)w) - offsetof (struct my_biggy, t2));
		888	}
636		889
637		890
		891
		892
		893	</pre>
		894
638	</div>	895	</div>
639	<h1 id="WATCHER_TYPES">WATCHER TYPES</h1><p><a href="#TOP" class="toplink">Top</a></p>	896	<h1 id="WATCHER_TYPES">WATCHER TYPES</h1>
640	<div id="WATCHER_TYPES_CONTENT">	897	<div id="WATCHER_TYPES_CONTENT">
641	<p>This section describes each watcher in detail, but will not repeat	898	<p>This section describes each watcher in detail, but will not repeat
642	information given in the last section.</p>	899	information given in the last section. Any initialisation/set macros,
		900	functions and members specific to the watcher type are explained.</p>
		901	<p>Members are additionally marked with either <i>[read-only]</i>, meaning that,
		902	while the watcher is active, you can look at the member and expect some
		903	sensible content, but you must not modify it (you can modify it while the
		904	watcher is stopped to your hearts content), or <i>[read-write]</i>, which
		905	means you can expect it to have some sensible content while the watcher
		906	is active, but you can also modify it. Modifying it may not do something
		907	sensible or take immediate effect (or do anything at all), but libev will
		908	not crash or malfunction in any way.</p>
643		909
644		910
645		911
646		912
647		913
648	</div>	914	</div>
649	<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable</h2>	915	<h2 id="code_ev_io_code_is_this_file_descrip"><code>ev_io</code> - is this file descriptor readable or writable?</h2>
650	<div id="code_ev_io_code_is_this_file_descrip-2">	916	<div id="code_ev_io_code_is_this_file_descrip-2">
651	<p>I/O watchers check whether a file descriptor is readable or writable	917	<p>I/O watchers check whether a file descriptor is readable or writable
652	in each iteration of the event loop (This behaviour is called	918	in each iteration of the event loop, or, more precisely, when reading
653	level-triggering because you keep receiving events as long as the	919	would not block the process and writing would at least be able to write
654	condition persists. Remember you can stop the watcher if you don't want to	920	some data. This behaviour is called level-triggering because you keep
655	act on the event and neither want to receive future events).</p>	921	receiving events as long as the condition persists. Remember you can stop
		922	the watcher if you don't want to act on the event and neither want to
		923	receive future events.</p>
656	<p>In general you can register as many read and/or write event watchers per	924	<p>In general you can register as many read and/or write event watchers per
657	fd as you want (as long as you don't confuse yourself). Setting all file	925	fd as you want (as long as you don't confuse yourself). Setting all file
658	descriptors to non-blocking mode is also usually a good idea (but not	926	descriptors to non-blocking mode is also usually a good idea (but not
659	required if you know what you are doing).</p>	927	required if you know what you are doing).</p>
660	<p>You have to be careful with dup'ed file descriptors, though. Some backends	928	<p>You have to be careful with dup'ed file descriptors, though. Some backends
661	(the linux epoll backend is a notable example) cannot handle dup'ed file	929	(the linux epoll backend is a notable example) cannot handle dup'ed file
662	descriptors correctly if you register interest in two or more fds pointing	930	descriptors correctly if you register interest in two or more fds pointing
663	to the same underlying file/socket etc. description (that is, they share	931	to the same underlying file/socket/etc. description (that is, they share
664	the same underlying "file open").</p>	932	the same underlying "file open").</p>
665	<p>If you must do this, then force the use of a known-to-be-good backend	933	<p>If you must do this, then force the use of a known-to-be-good backend
666	(at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and	934	(at the time of this writing, this includes only <code>EVBACKEND_SELECT</code> and
667	<code>EVBACKEND_POLL</code>).</p>	935	<code>EVBACKEND_POLL</code>).</p>
		936	<p>Another thing you have to watch out for is that it is quite easy to
		937	receive "spurious" readyness notifications, that is your callback might
		938	be called with <code>EV_READ</code> but a subsequent <code>read</code>(2) will actually block
		939	because there is no data. Not only are some backends known to create a
		940	lot of those (for example solaris ports), it is very easy to get into
		941	this situation even with a relatively standard program structure. Thus
		942	it is best to always use non-blocking I/O: An extra <code>read</code>(2) returning
		943	<code>EAGAIN</code> is far preferable to a program hanging until some data arrives.</p>
		944	<p>If you cannot run the fd in non-blocking mode (for example you should not
		945	play around with an Xlib connection), then you have to seperately re-test
		946	whether a file descriptor is really ready with a known-to-be good interface
		947	such as poll (fortunately in our Xlib example, Xlib already does this on
		948	its own, so its quite safe to use).</p>
		949
		950	</div>
		951	<h3 id="The_special_problem_of_disappearing_">The special problem of disappearing file descriptors</h3>
		952	<div id="The_special_problem_of_disappearing_-2">
		953	<p>Some backends (e.g kqueue, epoll) need to be told about closing a file
		954	descriptor (either by calling <code>close</code> explicitly or by any other means,
		955	such as <code>dup</code>). The reason is that you register interest in some file
		956	descriptor, but when it goes away, the operating system will silently drop
		957	this interest. If another file descriptor with the same number then is
		958	registered with libev, there is no efficient way to see that this is, in
		959	fact, a different file descriptor.</p>
		960	<p>To avoid having to explicitly tell libev about such cases, libev follows
		961	the following policy: Each time <code>ev_io_set</code> is being called, libev
		962	will assume that this is potentially a new file descriptor, otherwise
		963	it is assumed that the file descriptor stays the same. That means that
		964	you <i>have</i> to call <code>ev_io_set</code> (or <code>ev_io_init</code>) when you change the
		965	descriptor even if the file descriptor number itself did not change.</p>
		966	<p>This is how one would do it normally anyway, the important point is that
		967	the libev application should not optimise around libev but should leave
		968	optimisations to libev.</p>
		969
		970
		971
		972
668	<dl>	973	<dl>
669	<dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>	974	<dt>ev_io_init (ev_io *, callback, int fd, int events)</dt>
670	<dt>ev_io_set (ev_io *, int fd, int events)</dt>	975	<dt>ev_io_set (ev_io *, int fd, int events)</dt>
671	<dd>	976	<dd>
672	<p>Configures an <code>ev_io</code> watcher. The fd is the file descriptor to rceeive	977	<p>Configures an <code>ev_io</code> watcher. The <code>fd</code> is the file descriptor to
673	events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_READ \|	978	rceeive events for and events is either <code>EV_READ</code>, <code>EV_WRITE</code> or
674	EV_WRITE</code> to receive the given events.</p>	979	<code>EV_READ \| EV_WRITE</code> to receive the given events.</p>
675	<p>Please note that most of the more scalable backend mechanisms (for example	980	</dd>
676	epoll and solaris ports) can result in spurious readyness notifications	981	<dt>int fd [read-only]</dt>
677	for file descriptors, so you practically need to use non-blocking I/O (and	982	<dd>
678	treat callback invocation as hint only), or retest separately with a safe	983	<p>The file descriptor being watched.</p>
679	interface before doing I/O (XLib can do this), or force the use of either	984	</dd>
680	<code>EVBACKEND_SELECT</code> or <code>EVBACKEND_POLL</code>, which don't suffer from this	985	<dt>int events [read-only]</dt>
681	problem. Also note that it is quite easy to have your callback invoked	986	<dd>
682	when the readyness condition is no longer valid even when employing	987	<p>The events being watched.</p>
683	typical ways of handling events, so its a good idea to use non-blocking
684	I/O unconditionally.</p>
685	</dd>	988	</dd>
686	</dl>	989	</dl>
687	<p>Example: call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well	990	<p>Example: Call <code>stdin_readable_cb</code> when STDIN_FILENO has become, well
688	readable, but only once. Since it is likely line-buffered, you could	991	readable, but only once. Since it is likely line-buffered, you could
689	attempt to read a whole line in the callback:</p>	992	attempt to read a whole line in the callback.</p>
690	<pre> static void	993	<pre> static void
691	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)	994	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
692	{	995	{
693	ev_io_stop (loop, w);	996	ev_io_stop (loop, w);
694	.. read from stdin here (or from w->fd) and haqndle any I/O errors	997	.. read from stdin here (or from w->fd) and haqndle any I/O errors
…		…
705		1008
706		1009
707	</pre>	1010	</pre>
708		1011
709	</div>	1012	</div>
710	<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2>	1013	<h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally repeating timeouts</h2>
711	<div id="code_ev_timer_code_relative_and_opti-2">	1014	<div id="code_ev_timer_code_relative_and_opti-2">
712	<p>Timer watchers are simple relative timers that generate an event after a	1015	<p>Timer watchers are simple relative timers that generate an event after a
713	given time, and optionally repeating in regular intervals after that.</p>	1016	given time, and optionally repeating in regular intervals after that.</p>
714	<p>The timers are based on real time, that is, if you register an event that	1017	<p>The timers are based on real time, that is, if you register an event that
715	times out after an hour and you reset your system clock to last years	1018	times out after an hour and you reset your system clock to last years
…		…
743	</dd>	1046	</dd>
744	<dt>ev_timer_again (loop)</dt>	1047	<dt>ev_timer_again (loop)</dt>
745	<dd>	1048	<dd>
746	<p>This will act as if the timer timed out and restart it again if it is	1049	<p>This will act as if the timer timed out and restart it again if it is
747	repeating. The exact semantics are:</p>	1050	repeating. The exact semantics are:</p>
		1051	<p>If the timer is pending, its pending status is cleared.</p>
748	<p>If the timer is started but nonrepeating, stop it.</p>	1052	<p>If the timer is started but nonrepeating, stop it (as if it timed out).</p>
749	<p>If the timer is repeating, either start it if necessary (with the repeat	1053	<p>If the timer is repeating, either start it if necessary (with the
750	value), or reset the running timer to the repeat value.</p>	1054	<code>repeat</code> value), or reset the running timer to the <code>repeat</code> value.</p>
751	<p>This sounds a bit complicated, but here is a useful and typical	1055	<p>This sounds a bit complicated, but here is a useful and typical
752	example: Imagine you have a tcp connection and you want a so-called idle	1056	example: Imagine you have a tcp connection and you want a so-called idle
753	timeout, that is, you want to be called when there have been, say, 60	1057	timeout, that is, you want to be called when there have been, say, 60
754	seconds of inactivity on the socket. The easiest way to do this is to	1058	seconds of inactivity on the socket. The easiest way to do this is to
755	configure an <code>ev_timer</code> with after=repeat=60 and calling ev_timer_again each	1059	configure an <code>ev_timer</code> with a <code>repeat</code> value of <code>60</code> and then call
756	time you successfully read or write some data. If you go into an idle	1060	<code>ev_timer_again</code> each time you successfully read or write some data. If
757	state where you do not expect data to travel on the socket, you can stop	1061	you go into an idle state where you do not expect data to travel on the
		1062	socket, you can <code>ev_timer_stop</code> the timer, and <code>ev_timer_again</code> will
758	the timer, and again will automatically restart it if need be.</p>	1063	automatically restart it if need be.</p>
		1064	<p>That means you can ignore the <code>after</code> value and <code>ev_timer_start</code>
		1065	altogether and only ever use the <code>repeat</code> value and <code>ev_timer_again</code>:</p>
		1066	<pre> ev_timer_init (timer, callback, 0., 5.);
		1067	ev_timer_again (loop, timer);
		1068	...
		1069	timer->again = 17.;
		1070	ev_timer_again (loop, timer);
		1071	...
		1072	timer->again = 10.;
		1073	ev_timer_again (loop, timer);
		1074
		1075	</pre>
		1076	<p>This is more slightly efficient then stopping/starting the timer each time
		1077	you want to modify its timeout value.</p>
		1078	</dd>
		1079	<dt>ev_tstamp repeat [read-write]</dt>
		1080	<dd>
		1081	<p>The current <code>repeat</code> value. Will be used each time the watcher times out
		1082	or <code>ev_timer_again</code> is called and determines the next timeout (if any),
		1083	which is also when any modifications are taken into account.</p>
759	</dd>	1084	</dd>
760	</dl>	1085	</dl>
761	<p>Example: create a timer that fires after 60 seconds.</p>	1086	<p>Example: Create a timer that fires after 60 seconds.</p>
762	<pre> static void	1087	<pre> static void
763	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)	1088	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
764	{	1089	{
765	.. one minute over, w is actually stopped right here	1090	.. one minute over, w is actually stopped right here
766	}	1091	}
…		…
768	struct ev_timer mytimer;	1093	struct ev_timer mytimer;
769	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1094	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
770	ev_timer_start (loop, &mytimer);	1095	ev_timer_start (loop, &mytimer);
771		1096
772	</pre>	1097	</pre>
773	<p>Example: create a timeout timer that times out after 10 seconds of	1098	<p>Example: Create a timeout timer that times out after 10 seconds of
774	inactivity.</p>	1099	inactivity.</p>
775	<pre> static void	1100	<pre> static void
776	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)	1101	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
777	{	1102	{
778	.. ten seconds without any activity	1103	.. ten seconds without any activity
…		…
791		1116
792		1117
793	</pre>	1118	</pre>
794		1119
795	</div>	1120	</div>
796	<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron</h2>	1121	<h2 id="code_ev_periodic_code_to_cron_or_not"><code>ev_periodic</code> - to cron or not to cron?</h2>
797	<div id="code_ev_periodic_code_to_cron_or_not-2">	1122	<div id="code_ev_periodic_code_to_cron_or_not-2">
798	<p>Periodic watchers are also timers of a kind, but they are very versatile	1123	<p>Periodic watchers are also timers of a kind, but they are very versatile
799	(and unfortunately a bit complex).</p>	1124	(and unfortunately a bit complex).</p>
800	<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)	1125	<p>Unlike <code>ev_timer</code>'s, they are not based on real time (or relative time)
801	but on wallclock time (absolute time). You can tell a periodic watcher	1126	but on wallclock time (absolute time). You can tell a periodic watcher
802	to trigger "at" some specific point in time. For example, if you tell a	1127	to trigger "at" some specific point in time. For example, if you tell a
803	periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()	1128	periodic watcher to trigger in 10 seconds (by specifiying e.g. <code>ev_now ()
804	+ 10.>) and then reset your system clock to the last year, then it will	1129	+ 10.</code>) and then reset your system clock to the last year, then it will
805	take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger	1130	take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger
806	roughly 10 seconds later and of course not if you reset your system time	1131	roughly 10 seconds later).</p>
807	again).</p>
808	<p>They can also be used to implement vastly more complex timers, such as	1132	<p>They can also be used to implement vastly more complex timers, such as
809	triggering an event on eahc midnight, local time.</p>	1133	triggering an event on each midnight, local time or other, complicated,
		1134	rules.</p>
810	<p>As with timers, the callback is guarenteed to be invoked only when the	1135	<p>As with timers, the callback is guarenteed to be invoked only when the
811	time (<code>at</code>) has been passed, but if multiple periodic timers become ready	1136	time (<code>at</code>) has been passed, but if multiple periodic timers become ready
812	during the same loop iteration then order of execution is undefined.</p>	1137	during the same loop iteration then order of execution is undefined.</p>
813	<dl>	1138	<dl>
814	<dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>	1139	<dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt>
…		…
816	<dd>	1141	<dd>
817	<p>Lots of arguments, lets sort it out... There are basically three modes of	1142	<p>Lots of arguments, lets sort it out... There are basically three modes of
818	operation, and we will explain them from simplest to complex:</p>	1143	operation, and we will explain them from simplest to complex:</p>
819	<p>	1144	<p>
820	<dl>	1145	<dl>
821	<dt>* absolute timer (interval = reschedule_cb = 0)</dt>	1146	<dt>* absolute timer (at = time, interval = reschedule_cb = 0)</dt>
822	<dd>	1147	<dd>
823	<p>In this configuration the watcher triggers an event at the wallclock time	1148	<p>In this configuration the watcher triggers an event at the wallclock time
824	<code>at</code> and doesn't repeat. It will not adjust when a time jump occurs,	1149	<code>at</code> and doesn't repeat. It will not adjust when a time jump occurs,
825	that is, if it is to be run at January 1st 2011 then it will run when the	1150	that is, if it is to be run at January 1st 2011 then it will run when the
826	system time reaches or surpasses this time.</p>	1151	system time reaches or surpasses this time.</p>
827	</dd>	1152	</dd>
828	<dt>* non-repeating interval timer (interval > 0, reschedule_cb = 0)</dt>	1153	<dt>* non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)</dt>
829	<dd>	1154	<dd>
830	<p>In this mode the watcher will always be scheduled to time out at the next	1155	<p>In this mode the watcher will always be scheduled to time out at the next
831	<code>at + N * interval</code> time (for some integer N) and then repeat, regardless	1156	<code>at + N * interval</code> time (for some integer N, which can also be negative)
832	of any time jumps.</p>	1157	and then repeat, regardless of any time jumps.</p>
833	<p>This can be used to create timers that do not drift with respect to system	1158	<p>This can be used to create timers that do not drift with respect to system
834	time:</p>	1159	time:</p>
835	<pre> ev_periodic_set (&periodic, 0., 3600., 0);	1160	<pre> ev_periodic_set (&periodic, 0., 3600., 0);
836		1161
837	</pre>	1162	</pre>
…		…
840	full hour (UTC), or more correctly, when the system time is evenly divisible	1165	full hour (UTC), or more correctly, when the system time is evenly divisible
841	by 3600.</p>	1166	by 3600.</p>
842	<p>Another way to think about it (for the mathematically inclined) is that	1167	<p>Another way to think about it (for the mathematically inclined) is that
843	<code>ev_periodic</code> will try to run the callback in this mode at the next possible	1168	<code>ev_periodic</code> will try to run the callback in this mode at the next possible
844	time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>	1169	time where <code>time = at (mod interval)</code>, regardless of any time jumps.</p>
		1170	<p>For numerical stability it is preferable that the <code>at</code> value is near
		1171	<code>ev_now ()</code> (the current time), but there is no range requirement for
		1172	this value.</p>
845	</dd>	1173	</dd>
846	<dt>* manual reschedule mode (reschedule_cb = callback)</dt>	1174	<dt>* manual reschedule mode (at and interval ignored, reschedule_cb = callback)</dt>
847	<dd>	1175	<dd>
848	<p>In this mode the values for <code>interval</code> and <code>at</code> are both being	1176	<p>In this mode the values for <code>interval</code> and <code>at</code> are both being
849	ignored. Instead, each time the periodic watcher gets scheduled, the	1177	ignored. Instead, each time the periodic watcher gets scheduled, the
850	reschedule callback will be called with the watcher as first, and the	1178	reschedule callback will be called with the watcher as first, and the
851	current time as second argument.</p>	1179	current time as second argument.</p>
852	<p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,	1180	<p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher,
853	ever, or make any event loop modifications</i>. If you need to stop it,	1181	ever, or make any event loop modifications</i>. If you need to stop it,
854	return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by	1182	return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by
855	starting a prepare watcher).</p>	1183	starting an <code>ev_prepare</code> watcher, which is legal).</p>
856	<p>Its prototype is <code>ev_tstamp (reschedule_cb)(struct ev_periodic w,	1184	<p>Its prototype is <code>ev_tstamp (reschedule_cb)(struct ev_periodic w,
857	ev_tstamp now)</code>, e.g.:</p>	1185	ev_tstamp now)</code>, e.g.:</p>
858	<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1186	<pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
859	{	1187	{
860	return now + 60.;	1188	return now + 60.;
…		…
881	<p>Simply stops and restarts the periodic watcher again. This is only useful	1209	<p>Simply stops and restarts the periodic watcher again. This is only useful
882	when you changed some parameters or the reschedule callback would return	1210	when you changed some parameters or the reschedule callback would return
883	a different time than the last time it was called (e.g. in a crond like	1211	a different time than the last time it was called (e.g. in a crond like
884	program when the crontabs have changed).</p>	1212	program when the crontabs have changed).</p>
885	</dd>	1213	</dd>
		1214	<dt>ev_tstamp offset [read-write]</dt>
		1215	<dd>
		1216	<p>When repeating, this contains the offset value, otherwise this is the
		1217	absolute point in time (the <code>at</code> value passed to <code>ev_periodic_set</code>).</p>
		1218	<p>Can be modified any time, but changes only take effect when the periodic
		1219	timer fires or <code>ev_periodic_again</code> is being called.</p>
		1220	</dd>
		1221	<dt>ev_tstamp interval [read-write]</dt>
		1222	<dd>
		1223	<p>The current interval value. Can be modified any time, but changes only
		1224	take effect when the periodic timer fires or <code>ev_periodic_again</code> is being
		1225	called.</p>
		1226	</dd>
		1227	<dt>ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]</dt>
		1228	<dd>
		1229	<p>The current reschedule callback, or <code>0</code>, if this functionality is
		1230	switched off. Can be changed any time, but changes only take effect when
		1231	the periodic timer fires or <code>ev_periodic_again</code> is being called.</p>
		1232	</dd>
886	</dl>	1233	</dl>
887	<p>Example: call a callback every hour, or, more precisely, whenever the	1234	<p>Example: Call a callback every hour, or, more precisely, whenever the
888	system clock is divisible by 3600. The callback invocation times have	1235	system clock is divisible by 3600. The callback invocation times have
889	potentially a lot of jittering, but good long-term stability.</p>	1236	potentially a lot of jittering, but good long-term stability.</p>
890	<pre> static void	1237	<pre> static void
891	clock_cb (struct ev_loop loop, struct ev_io w, int revents)	1238	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
892	{	1239	{
…		…
896	struct ev_periodic hourly_tick;	1243	struct ev_periodic hourly_tick;
897	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1244	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
898	ev_periodic_start (loop, &hourly_tick);	1245	ev_periodic_start (loop, &hourly_tick);
899		1246
900	</pre>	1247	</pre>
901	<p>Example: the same as above, but use a reschedule callback to do it:</p>	1248	<p>Example: The same as above, but use a reschedule callback to do it:</p>
902	<pre> #include <math.h>	1249	<pre> #include <math.h>
903		1250
904	static ev_tstamp	1251	static ev_tstamp
905	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1252	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
906	{	1253	{
…		…
908	}	1255	}
909		1256
910	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1257	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
911		1258
912	</pre>	1259	</pre>
913	<p>Example: call a callback every hour, starting now:</p>	1260	<p>Example: Call a callback every hour, starting now:</p>
914	<pre> struct ev_periodic hourly_tick;	1261	<pre> struct ev_periodic hourly_tick;
915	ev_periodic_init (&hourly_tick, clock_cb,	1262	ev_periodic_init (&hourly_tick, clock_cb,
916	fmod (ev_now (loop), 3600.), 3600., 0);	1263	fmod (ev_now (loop), 3600.), 3600., 0);
917	ev_periodic_start (loop, &hourly_tick);	1264	ev_periodic_start (loop, &hourly_tick);
918		1265
…		…
920		1267
921		1268
922	</pre>	1269	</pre>
923		1270
924	</div>	1271	</div>
925	<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled</h2>	1272	<h2 id="code_ev_signal_code_signal_me_when_a"><code>ev_signal</code> - signal me when a signal gets signalled!</h2>
926	<div id="code_ev_signal_code_signal_me_when_a-2">	1273	<div id="code_ev_signal_code_signal_me_when_a-2">
927	<p>Signal watchers will trigger an event when the process receives a specific	1274	<p>Signal watchers will trigger an event when the process receives a specific
928	signal one or more times. Even though signals are very asynchronous, libev	1275	signal one or more times. Even though signals are very asynchronous, libev
929	will try it's best to deliver signals synchronously, i.e. as part of the	1276	will try it's best to deliver signals synchronously, i.e. as part of the
930	normal event processing, like any other event.</p>	1277	normal event processing, like any other event.</p>
…		…
939	<dt>ev_signal_set (ev_signal *, int signum)</dt>	1286	<dt>ev_signal_set (ev_signal *, int signum)</dt>
940	<dd>	1287	<dd>
941	<p>Configures the watcher to trigger on the given signal number (usually one	1288	<p>Configures the watcher to trigger on the given signal number (usually one
942	of the <code>SIGxxx</code> constants).</p>	1289	of the <code>SIGxxx</code> constants).</p>
943	</dd>	1290	</dd>
		1291	<dt>int signum [read-only]</dt>
		1292	<dd>
		1293	<p>The signal the watcher watches out for.</p>
		1294	</dd>
944	</dl>	1295	</dl>
945		1296
946		1297
947		1298
948		1299
949		1300
950	</div>	1301	</div>
951	<h2 id="code_ev_child_code_wait_for_pid_stat"><code>ev_child</code> - wait for pid status changes</h2>	1302	<h2 id="code_ev_child_code_watch_out_for_pro"><code>ev_child</code> - watch out for process status changes</h2>
952	<div id="code_ev_child_code_wait_for_pid_stat-2">	1303	<div id="code_ev_child_code_watch_out_for_pro-2">
953	<p>Child watchers trigger when your process receives a SIGCHLD in response to	1304	<p>Child watchers trigger when your process receives a SIGCHLD in response to
954	some child status changes (most typically when a child of yours dies).</p>	1305	some child status changes (most typically when a child of yours dies).</p>
955	<dl>	1306	<dl>
956	<dt>ev_child_init (ev_child *, callback, int pid)</dt>	1307	<dt>ev_child_init (ev_child *, callback, int pid)</dt>
957	<dt>ev_child_set (ev_child *, int pid)</dt>	1308	<dt>ev_child_set (ev_child *, int pid)</dt>
…		…
961	at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see	1312	at the <code>rstatus</code> member of the <code>ev_child</code> watcher structure to see
962	the status word (use the macros from <code>sys/wait.h</code> and see your systems	1313	the status word (use the macros from <code>sys/wait.h</code> and see your systems
963	<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the	1314	<code>waitpid</code> documentation). The <code>rpid</code> member contains the pid of the
964	process causing the status change.</p>	1315	process causing the status change.</p>
965	</dd>	1316	</dd>
		1317	<dt>int pid [read-only]</dt>
		1318	<dd>
		1319	<p>The process id this watcher watches out for, or <code>0</code>, meaning any process id.</p>
		1320	</dd>
		1321	<dt>int rpid [read-write]</dt>
		1322	<dd>
		1323	<p>The process id that detected a status change.</p>
		1324	</dd>
		1325	<dt>int rstatus [read-write]</dt>
		1326	<dd>
		1327	<p>The process exit/trace status caused by <code>rpid</code> (see your systems
		1328	<code>waitpid</code> and <code>sys/wait.h</code> documentation for details).</p>
		1329	</dd>
966	</dl>	1330	</dl>
967	<p>Example: try to exit cleanly on SIGINT and SIGTERM.</p>	1331	<p>Example: Try to exit cleanly on SIGINT and SIGTERM.</p>
968	<pre> static void	1332	<pre> static void
969	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1333	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
970	{	1334	{
971	ev_unloop (loop, EVUNLOOP_ALL);	1335	ev_unloop (loop, EVUNLOOP_ALL);
972	}	1336	}
…		…
979		1343
980		1344
981	</pre>	1345	</pre>
982		1346
983	</div>	1347	</div>
		1348	<h2 id="code_ev_stat_code_did_the_file_attri"><code>ev_stat</code> - did the file attributes just change?</h2>
		1349	<div id="code_ev_stat_code_did_the_file_attri-2">
		1350	<p>This watches a filesystem path for attribute changes. That is, it calls
		1351	<code>stat</code> regularly (or when the OS says it changed) and sees if it changed
		1352	compared to the last time, invoking the callback if it did.</p>
		1353	<p>The path does not need to exist: changing from "path exists" to "path does
		1354	not exist" is a status change like any other. The condition "path does
		1355	not exist" is signified by the <code>st_nlink</code> field being zero (which is
		1356	otherwise always forced to be at least one) and all the other fields of
		1357	the stat buffer having unspecified contents.</p>
		1358	<p>The path <i>should</i> be absolute and <i>must not</i> end in a slash. If it is
		1359	relative and your working directory changes, the behaviour is undefined.</p>
		1360	<p>Since there is no standard to do this, the portable implementation simply
		1361	calls <code>stat (2)</code> regularly on the path to see if it changed somehow. You
		1362	can specify a recommended polling interval for this case. If you specify
		1363	a polling interval of <code>0</code> (highly recommended!) then a <i>suitable,
		1364	unspecified default</i> value will be used (which you can expect to be around
		1365	five seconds, although this might change dynamically). Libev will also
		1366	impose a minimum interval which is currently around <code>0.1</code>, but thats
		1367	usually overkill.</p>
		1368	<p>This watcher type is not meant for massive numbers of stat watchers,
		1369	as even with OS-supported change notifications, this can be
		1370	resource-intensive.</p>
		1371	<p>At the time of this writing, only the Linux inotify interface is
		1372	implemented (implementing kqueue support is left as an exercise for the
		1373	reader). Inotify will be used to give hints only and should not change the
		1374	semantics of <code>ev_stat</code> watchers, which means that libev sometimes needs
		1375	to fall back to regular polling again even with inotify, but changes are
		1376	usually detected immediately, and if the file exists there will be no
		1377	polling.</p>
		1378	<dl>
		1379	<dt>ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)</dt>
		1380	<dt>ev_stat_set (ev_stat , const char path, ev_tstamp interval)</dt>
		1381	<dd>
		1382	<p>Configures the watcher to wait for status changes of the given
		1383	<code>path</code>. The <code>interval</code> is a hint on how quickly a change is expected to
		1384	be detected and should normally be specified as <code>0</code> to let libev choose
		1385	a suitable value. The memory pointed to by <code>path</code> must point to the same
		1386	path for as long as the watcher is active.</p>
		1387	<p>The callback will be receive <code>EV_STAT</code> when a change was detected,
		1388	relative to the attributes at the time the watcher was started (or the
		1389	last change was detected).</p>
		1390	</dd>
		1391	<dt>ev_stat_stat (ev_stat *)</dt>
		1392	<dd>
		1393	<p>Updates the stat buffer immediately with new values. If you change the
		1394	watched path in your callback, you could call this fucntion to avoid
		1395	detecting this change (while introducing a race condition). Can also be
		1396	useful simply to find out the new values.</p>
		1397	</dd>
		1398	<dt>ev_statdata attr [read-only]</dt>
		1399	<dd>
		1400	<p>The most-recently detected attributes of the file. Although the type is of
		1401	<code>ev_statdata</code>, this is usually the (or one of the) <code>struct stat</code> types
		1402	suitable for your system. If the <code>st_nlink</code> member is <code>0</code>, then there
		1403	was some error while <code>stat</code>ing the file.</p>
		1404	</dd>
		1405	<dt>ev_statdata prev [read-only]</dt>
		1406	<dd>
		1407	<p>The previous attributes of the file. The callback gets invoked whenever
		1408	<code>prev</code> != <code>attr</code>.</p>
		1409	</dd>
		1410	<dt>ev_tstamp interval [read-only]</dt>
		1411	<dd>
		1412	<p>The specified interval.</p>
		1413	</dd>
		1414	<dt>const char *path [read-only]</dt>
		1415	<dd>
		1416	<p>The filesystem path that is being watched.</p>
		1417	</dd>
		1418	</dl>
		1419	<p>Example: Watch <code>/etc/passwd</code> for attribute changes.</p>
		1420	<pre> static void
		1421	passwd_cb (struct ev_loop loop, ev_stat w, int revents)
		1422	{
		1423	/* /etc/passwd changed in some way */
		1424	if (w->attr.st_nlink)
		1425	{
		1426	printf ("passwd current size %ld\n", (long)w->attr.st_size);
		1427	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
		1428	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
		1429	}
		1430	else
		1431	/* you shalt not abuse printf for puts */
		1432	puts ("wow, /etc/passwd is not there, expect problems. "
		1433	"if this is windows, they already arrived\n");
		1434	}
		1435
		1436	...
		1437	ev_stat passwd;
		1438
		1439	ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
		1440	ev_stat_start (loop, &passwd);
		1441
		1442
		1443
		1444
		1445	</pre>
		1446
		1447	</div>
984	<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</h2>	1448	<h2 id="code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do...</h2>
985	<div id="code_ev_idle_code_when_you_ve_got_no-2">	1449	<div id="code_ev_idle_code_when_you_ve_got_no-2">
986	<p>Idle watchers trigger events when there are no other events are pending	1450	<p>Idle watchers trigger events when no other events of the same or higher
987	(prepare, check and other idle watchers do not count). That is, as long	1451	priority are pending (prepare, check and other idle watchers do not
988	as your process is busy handling sockets or timeouts (or even signals,	1452	count).</p>
989	imagine) it will not be triggered. But when your process is idle all idle	1453	<p>That is, as long as your process is busy handling sockets or timeouts
990	watchers are being called again and again, once per event loop iteration -	1454	(or even signals, imagine) of the same or higher priority it will not be
		1455	triggered. But when your process is idle (or only lower-priority watchers
		1456	are pending), the idle watchers are being called once per event loop
991	until stopped, that is, or your process receives more events and becomes	1457	iteration - until stopped, that is, or your process receives more events
992	busy.</p>	1458	and becomes busy again with higher priority stuff.</p>
993	<p>The most noteworthy effect is that as long as any idle watchers are	1459	<p>The most noteworthy effect is that as long as any idle watchers are
994	active, the process will not block when waiting for new events.</p>	1460	active, the process will not block when waiting for new events.</p>
995	<p>Apart from keeping your process non-blocking (which is a useful	1461	<p>Apart from keeping your process non-blocking (which is a useful
996	effect on its own sometimes), idle watchers are a good place to do	1462	effect on its own sometimes), idle watchers are a good place to do
997	"pseudo-background processing", or delay processing stuff to after the	1463	"pseudo-background processing", or delay processing stuff to after the
…		…
1002	<p>Initialises and configures the idle watcher - it has no parameters of any	1468	<p>Initialises and configures the idle watcher - it has no parameters of any
1003	kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,	1469	kind. There is a <code>ev_idle_set</code> macro, but using it is utterly pointless,
1004	believe me.</p>	1470	believe me.</p>
1005	</dd>	1471	</dd>
1006	</dl>	1472	</dl>
1007	<p>Example: dynamically allocate an <code>ev_idle</code>, start it, and in the	1473	<p>Example: Dynamically allocate an <code>ev_idle</code> watcher, start it, and in the
1008	callback, free it. Alos, use no error checking, as usual.</p>	1474	callback, free it. Also, use no error checking, as usual.</p>
1009	<pre> static void	1475	<pre> static void
1010	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)	1476	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
1011	{	1477	{
1012	free (w);	1478	free (w);
1013	// now do something you wanted to do when the program has	1479	// now do something you wanted to do when the program has
…		…
1022		1488
1023		1489
1024	</pre>	1490	</pre>
1025		1491
1026	</div>	1492	</div>
1027	<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2>	1493	<h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop!</h2>
1028	<div id="code_ev_prepare_code_and_code_ev_che-2">	1494	<div id="code_ev_prepare_code_and_code_ev_che-2">
1029	<p>Prepare and check watchers are usually (but not always) used in tandem:	1495	<p>Prepare and check watchers are usually (but not always) used in tandem:
1030	prepare watchers get invoked before the process blocks and check watchers	1496	prepare watchers get invoked before the process blocks and check watchers
1031	afterwards.</p>	1497	afterwards.</p>
		1498	<p>You <i>must not</i> call <code>ev_loop</code> or similar functions that enter
		1499	the current event loop from either <code>ev_prepare</code> or <code>ev_check</code>
		1500	watchers. Other loops than the current one are fine, however. The
		1501	rationale behind this is that you do not need to check for recursion in
		1502	those watchers, i.e. the sequence will always be <code>ev_prepare</code>, blocking,
		1503	<code>ev_check</code> so if you have one watcher of each kind they will always be
		1504	called in pairs bracketing the blocking call.</p>
1032	<p>Their main purpose is to integrate other event mechanisms into libev and	1505	<p>Their main purpose is to integrate other event mechanisms into libev and
1033	their use is somewhat advanced. This could be used, for example, to track	1506	their use is somewhat advanced. This could be used, for example, to track
1034	variable changes, implement your own watchers, integrate net-snmp or a	1507	variable changes, implement your own watchers, integrate net-snmp or a
1035	coroutine library and lots more.</p>	1508	coroutine library and lots more. They are also occasionally useful if
		1509	you cache some data and want to flush it before blocking (for example,
		1510	in X programs you might want to do an <code>XFlush ()</code> in an <code>ev_prepare</code>
		1511	watcher).</p>
1036	<p>This is done by examining in each prepare call which file descriptors need	1512	<p>This is done by examining in each prepare call which file descriptors need
1037	to be watched by the other library, registering <code>ev_io</code> watchers for	1513	to be watched by the other library, registering <code>ev_io</code> watchers for
1038	them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries	1514	them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries
1039	provide just this functionality). Then, in the check watcher you check for	1515	provide just this functionality). Then, in the check watcher you check for
1040	any events that occured (by checking the pending status of all watchers	1516	any events that occured (by checking the pending status of all watchers
…		…
1047	are ready to run (it's actually more complicated: it only runs coroutines	1523	are ready to run (it's actually more complicated: it only runs coroutines
1048	with priority higher than or equal to the event loop and one coroutine	1524	with priority higher than or equal to the event loop and one coroutine
1049	of lower priority, but only once, using idle watchers to keep the event	1525	of lower priority, but only once, using idle watchers to keep the event
1050	loop from blocking if lower-priority coroutines are active, thus mapping	1526	loop from blocking if lower-priority coroutines are active, thus mapping
1051	low-priority coroutines to idle/background tasks).</p>	1527	low-priority coroutines to idle/background tasks).</p>
		1528	<p>It is recommended to give <code>ev_check</code> watchers highest (<code>EV_MAXPRI</code>)
		1529	priority, to ensure that they are being run before any other watchers
		1530	after the poll. Also, <code>ev_check</code> watchers (and <code>ev_prepare</code> watchers,
		1531	too) should not activate ("feed") events into libev. While libev fully
		1532	supports this, they will be called before other <code>ev_check</code> watchers did
		1533	their job. As <code>ev_check</code> watchers are often used to embed other event
		1534	loops those other event loops might be in an unusable state until their
		1535	<code>ev_check</code> watcher ran (always remind yourself to coexist peacefully with
		1536	others).</p>
1052	<dl>	1537	<dl>
1053	<dt>ev_prepare_init (ev_prepare *, callback)</dt>	1538	<dt>ev_prepare_init (ev_prepare *, callback)</dt>
1054	<dt>ev_check_init (ev_check *, callback)</dt>	1539	<dt>ev_check_init (ev_check *, callback)</dt>
1055	<dd>	1540	<dd>
1056	<p>Initialises and configures the prepare or check watcher - they have no	1541	<p>Initialises and configures the prepare or check watcher - they have no
1057	parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>	1542	parameters of any kind. There are <code>ev_prepare_set</code> and <code>ev_check_set</code>
1058	macros, but using them is utterly, utterly and completely pointless.</p>	1543	macros, but using them is utterly, utterly and completely pointless.</p>
1059	</dd>	1544	</dd>
1060	</dl>	1545	</dl>
1061	<p>Example: TODO.</p>	1546	<p>There are a number of principal ways to embed other event loops or modules
		1547	into libev. Here are some ideas on how to include libadns into libev
		1548	(there is a Perl module named <code>EV::ADNS</code> that does this, which you could
		1549	use for an actually working example. Another Perl module named <code>EV::Glib</code>
		1550	embeds a Glib main context into libev, and finally, <code>Glib::EV</code> embeds EV
		1551	into the Glib event loop).</p>
		1552	<p>Method 1: Add IO watchers and a timeout watcher in a prepare handler,
		1553	and in a check watcher, destroy them and call into libadns. What follows
		1554	is pseudo-code only of course. This requires you to either use a low
		1555	priority for the check watcher or use <code>ev_clear_pending</code> explicitly, as
		1556	the callbacks for the IO/timeout watchers might not have been called yet.</p>
		1557	<pre> static ev_io iow [nfd];
		1558	static ev_timer tw;
1062		1559
		1560	static void
		1561	io_cb (ev_loop loop, ev_io w, int revents)
		1562	{
		1563	}
1063		1564
		1565	// create io watchers for each fd and a timer before blocking
		1566	static void
		1567	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
		1568	{
		1569	int timeout = 3600000;
		1570	struct pollfd fds [nfd];
		1571	// actual code will need to loop here and realloc etc.
		1572	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1064		1573
		1574	/* the callback is illegal, but won't be called as we stop during check */
		1575	ev_timer_init (&tw, 0, timeout * 1e-3);
		1576	ev_timer_start (loop, &tw);
1065		1577
		1578	// create one ev_io per pollfd
		1579	for (int i = 0; i < nfd; ++i)
		1580	{
		1581	ev_io_init (iow + i, io_cb, fds [i].fd,
		1582	((fds [i].events & POLLIN ? EV_READ : 0)
		1583	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1066		1584
		1585	fds [i].revents = 0;
		1586	ev_io_start (loop, iow + i);
		1587	}
		1588	}
		1589
		1590	// stop all watchers after blocking
		1591	static void
		1592	adns_check_cb (ev_loop loop, ev_check w, int revents)
		1593	{
		1594	ev_timer_stop (loop, &tw);
		1595
		1596	for (int i = 0; i < nfd; ++i)
		1597	{
		1598	// set the relevant poll flags
		1599	// could also call adns_processreadable etc. here
		1600	struct pollfd *fd = fds + i;
		1601	int revents = ev_clear_pending (iow + i);
		1602	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1603	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1604
		1605	// now stop the watcher
		1606	ev_io_stop (loop, iow + i);
		1607	}
		1608
		1609	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1610	}
		1611
		1612	</pre>
		1613	<p>Method 2: This would be just like method 1, but you run <code>adns_afterpoll</code>
		1614	in the prepare watcher and would dispose of the check watcher.</p>
		1615	<p>Method 3: If the module to be embedded supports explicit event
		1616	notification (adns does), you can also make use of the actual watcher
		1617	callbacks, and only destroy/create the watchers in the prepare watcher.</p>
		1618	<pre> static void
		1619	timer_cb (EV_P_ ev_timer *w, int revents)
		1620	{
		1621	adns_state ads = (adns_state)w->data;
		1622	update_now (EV_A);
		1623
		1624	adns_processtimeouts (ads, &tv_now);
		1625	}
		1626
		1627	static void
		1628	io_cb (EV_P_ ev_io *w, int revents)
		1629	{
		1630	adns_state ads = (adns_state)w->data;
		1631	update_now (EV_A);
		1632
		1633	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1634	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1635	}
		1636
		1637	// do not ever call adns_afterpoll
		1638
		1639	</pre>
		1640	<p>Method 4: Do not use a prepare or check watcher because the module you
		1641	want to embed is too inflexible to support it. Instead, youc na override
		1642	their poll function. The drawback with this solution is that the main
		1643	loop is now no longer controllable by EV. The <code>Glib::EV</code> module does
		1644	this.</p>
		1645	<pre> static gint
		1646	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1647	{
		1648	int got_events = 0;
		1649
		1650	for (n = 0; n < nfds; ++n)
		1651	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1652
		1653	if (timeout >= 0)
		1654	// create/start timer
		1655
		1656	// poll
		1657	ev_loop (EV_A_ 0);
		1658
		1659	// stop timer again
		1660	if (timeout >= 0)
		1661	ev_timer_stop (EV_A_ &to);
		1662
		1663	// stop io watchers again - their callbacks should have set
		1664	for (n = 0; n < nfds; ++n)
		1665	ev_io_stop (EV_A_ iow [n]);
		1666
		1667	return got_events;
		1668	}
		1669
		1670
		1671
		1672
		1673	</pre>
		1674
1067	</div>	1675	</div>
1068	<h2 id="code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough</h2>	1676	<h2 id="code_ev_embed_code_when_one_backend_"><code>ev_embed</code> - when one backend isn't enough...</h2>
1069	<div id="code_ev_embed_code_when_one_backend_-2">	1677	<div id="code_ev_embed_code_when_one_backend_-2">
1070	<p>This is a rather advanced watcher type that lets you embed one event loop	1678	<p>This is a rather advanced watcher type that lets you embed one event loop
1071	into another.</p>	1679	into another (currently only <code>ev_io</code> events are supported in the embedded
		1680	loop, other types of watchers might be handled in a delayed or incorrect
		1681	fashion and must not be used).</p>
1072	<p>There are primarily two reasons you would want that: work around bugs and	1682	<p>There are primarily two reasons you would want that: work around bugs and
1073	prioritise I/O.</p>	1683	prioritise I/O.</p>
1074	<p>As an example for a bug workaround, the kqueue backend might only support	1684	<p>As an example for a bug workaround, the kqueue backend might only support
1075	sockets on some platform, so it is unusable as generic backend, but you	1685	sockets on some platform, so it is unusable as generic backend, but you
1076	still want to make use of it because you have many sockets and it scales	1686	still want to make use of it because you have many sockets and it scales
…		…
1081	<p>As for prioritising I/O: rarely you have the case where some fds have	1691	<p>As for prioritising I/O: rarely you have the case where some fds have
1082	to be watched and handled very quickly (with low latency), and even	1692	to be watched and handled very quickly (with low latency), and even
1083	priorities and idle watchers might have too much overhead. In this case	1693	priorities and idle watchers might have too much overhead. In this case
1084	you would put all the high priority stuff in one loop and all the rest in	1694	you would put all the high priority stuff in one loop and all the rest in
1085	a second one, and embed the second one in the first.</p>	1695	a second one, and embed the second one in the first.</p>
		1696	<p>As long as the watcher is active, the callback will be invoked every time
		1697	there might be events pending in the embedded loop. The callback must then
		1698	call <code>ev_embed_sweep (mainloop, watcher)</code> to make a single sweep and invoke
		1699	their callbacks (you could also start an idle watcher to give the embedded
		1700	loop strictly lower priority for example). You can also set the callback
		1701	to <code>0</code>, in which case the embed watcher will automatically execute the
		1702	embedded loop sweep.</p>
1086	<p>As long as the watcher is started it will automatically handle events. The	1703	<p>As long as the watcher is started it will automatically handle events. The
1087	callback will be invoked whenever some events have been handled. You can	1704	callback will be invoked whenever some events have been handled. You can
1088	set the callback to <code>0</code> to avoid having to specify one if you are not	1705	set the callback to <code>0</code> to avoid having to specify one if you are not
1089	interested in that.</p>	1706	interested in that.</p>
1090	<p>Also, there have not currently been made special provisions for forking:	1707	<p>Also, there have not currently been made special provisions for forking:
…		…
1117	else	1734	else
1118	loop_lo = loop_hi;	1735	loop_lo = loop_hi;
1119		1736
1120	</pre>	1737	</pre>
1121	<dl>	1738	<dl>
1122	<dt>ev_embed_init (ev_embed , callback, struct ev_loop loop)</dt>	1739	<dt>ev_embed_init (ev_embed , callback, struct ev_loop embedded_loop)</dt>
1123	<dt>ev_embed_set (ev_embed , callback, struct ev_loop loop)</dt>	1740	<dt>ev_embed_set (ev_embed , callback, struct ev_loop embedded_loop)</dt>
		1741	<dd>
		1742	<p>Configures the watcher to embed the given loop, which must be
		1743	embeddable. If the callback is <code>0</code>, then <code>ev_embed_sweep</code> will be
		1744	invoked automatically, otherwise it is the responsibility of the callback
		1745	to invoke it (it will continue to be called until the sweep has been done,
		1746	if you do not want thta, you need to temporarily stop the embed watcher).</p>
1124	<dd>	1747	</dd>
1125	<p>Configures the watcher to embed the given loop, which must be embeddable.</p>	1748	<dt>ev_embed_sweep (loop, ev_embed *)</dt>
		1749	<dd>
		1750	<p>Make a single, non-blocking sweep over the embedded loop. This works
		1751	similarly to <code>ev_loop (embedded_loop, EVLOOP_NONBLOCK)</code>, but in the most
		1752	apropriate way for embedded loops.</p>
		1753	</dd>
		1754	<dt>struct ev_loop *loop [read-only]</dt>
		1755	<dd>
		1756	<p>The embedded event loop.</p>
1126	</dd>	1757	</dd>
1127	</dl>	1758	</dl>
1128		1759
1129		1760
1130		1761
1131		1762
1132		1763
1133	</div>	1764	</div>
1134	<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>	1765	<h2 id="code_ev_fork_code_the_audacity_to_re"><code>ev_fork</code> - the audacity to resume the event loop after a fork</h2>
		1766	<div id="code_ev_fork_code_the_audacity_to_re-2">
		1767	<p>Fork watchers are called when a <code>fork ()</code> was detected (usually because
		1768	whoever is a good citizen cared to tell libev about it by calling
		1769	<code>ev_default_fork</code> or <code>ev_loop_fork</code>). The invocation is done before the
		1770	event loop blocks next and before <code>ev_check</code> watchers are being called,
		1771	and only in the child after the fork. If whoever good citizen calling
		1772	<code>ev_default_fork</code> cheats and calls it in the wrong process, the fork
		1773	handlers will be invoked, too, of course.</p>
		1774	<dl>
		1775	<dt>ev_fork_init (ev_signal *, callback)</dt>
		1776	<dd>
		1777	<p>Initialises and configures the fork watcher - it has no parameters of any
		1778	kind. There is a <code>ev_fork_set</code> macro, but using it is utterly pointless,
		1779	believe me.</p>
		1780	</dd>
		1781	</dl>
		1782
		1783
		1784
		1785
		1786
		1787	</div>
		1788	<h1 id="OTHER_FUNCTIONS">OTHER FUNCTIONS</h1>
1135	<div id="OTHER_FUNCTIONS_CONTENT">	1789	<div id="OTHER_FUNCTIONS_CONTENT">
1136	<p>There are some other functions of possible interest. Described. Here. Now.</p>	1790	<p>There are some other functions of possible interest. Described. Here. Now.</p>
1137	<dl>	1791	<dl>
1138	<dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>	1792	<dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt>
1139	<dd>	1793	<dd>
…		…
1163		1817
1164	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	1818	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
1165		1819
1166	</pre>	1820	</pre>
1167	</dd>	1821	</dd>
1168	<dt>ev_feed_event (loop, watcher, int events)</dt>	1822	<dt>ev_feed_event (ev_loop , watcher , int revents)</dt>
1169	<dd>	1823	<dd>
1170	<p>Feeds the given event set into the event loop, as if the specified event	1824	<p>Feeds the given event set into the event loop, as if the specified event
1171	had happened for the specified watcher (which must be a pointer to an	1825	had happened for the specified watcher (which must be a pointer to an
1172	initialised but not necessarily started event watcher).</p>	1826	initialised but not necessarily started event watcher).</p>
1173	</dd>	1827	</dd>
1174	<dt>ev_feed_fd_event (loop, int fd, int revents)</dt>	1828	<dt>ev_feed_fd_event (ev_loop *, int fd, int revents)</dt>
1175	<dd>	1829	<dd>
1176	<p>Feed an event on the given fd, as if a file descriptor backend detected	1830	<p>Feed an event on the given fd, as if a file descriptor backend detected
1177	the given events it.</p>	1831	the given events it.</p>
1178	</dd>	1832	</dd>
1179	<dt>ev_feed_signal_event (loop, int signum)</dt>	1833	<dt>ev_feed_signal_event (ev_loop *loop, int signum)</dt>
1180	<dd>	1834	<dd>
1181	<p>Feed an event as if the given signal occured (loop must be the default loop!).</p>	1835	<p>Feed an event as if the given signal occured (<code>loop</code> must be the default
		1836	loop!).</p>
1182	</dd>	1837	</dd>
1183	</dl>	1838	</dl>
1184		1839
1185		1840
1186		1841
1187		1842
1188		1843
1189	</div>	1844	</div>
1190	<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p>	1845	<h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1>
1191	<div id="LIBEVENT_EMULATION_CONTENT">	1846	<div id="LIBEVENT_EMULATION_CONTENT">
1192	<p>Libev offers a compatibility emulation layer for libevent. It cannot	1847	<p>Libev offers a compatibility emulation layer for libevent. It cannot
1193	emulate the internals of libevent, so here are some usage hints:</p>	1848	emulate the internals of libevent, so here are some usage hints:</p>
1194	<dl>	1849	<dl>
1195	<dt>* Use it by including <event.h>, as usual.</dt>	1850	<dt>* Use it by including <event.h>, as usual.</dt>
…		…
1205	<dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need	1860	<dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need
1206	to use the libev header file and library.</dt>	1861	to use the libev header file and library.</dt>
1207	</dl>	1862	</dl>
1208		1863
1209	</div>	1864	</div>
1210	<h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>	1865	<h1 id="C_SUPPORT">C++ SUPPORT</h1>
1211	<div id="C_SUPPORT_CONTENT">	1866	<div id="C_SUPPORT_CONTENT">
1212	<p>TBD.</p>	1867	<p>Libev comes with some simplistic wrapper classes for C++ that mainly allow
		1868	you to use some convinience methods to start/stop watchers and also change
		1869	the callback model to a model using method callbacks on objects.</p>
		1870	<p>To use it,</p>
		1871	<pre> #include <ev++.h>
1213		1872
		1873	</pre>
		1874	<p>This automatically includes <cite>ev.h</cite> and puts all of its definitions (many
		1875	of them macros) into the global namespace. All C++ specific things are
		1876	put into the <code>ev</code> namespace. It should support all the same embedding
		1877	options as <cite>ev.h</cite>, most notably <code>EV_MULTIPLICITY</code>.</p>
		1878	<p>Care has been taken to keep the overhead low. The only data member the C++
		1879	classes add (compared to plain C-style watchers) is the event loop pointer
		1880	that the watcher is associated with (or no additional members at all if
		1881	you disable <code>EV_MULTIPLICITY</code> when embedding libev).</p>
		1882	<p>Currently, functions, and static and non-static member functions can be
		1883	used as callbacks. Other types should be easy to add as long as they only
		1884	need one additional pointer for context. If you need support for other
		1885	types of functors please contact the author (preferably after implementing
		1886	it).</p>
		1887	<p>Here is a list of things available in the <code>ev</code> namespace:</p>
		1888	<dl>
		1889	<dt><code>ev::READ</code>, <code>ev::WRITE</code> etc.</dt>
		1890	<dd>
		1891	<p>These are just enum values with the same values as the <code>EV_READ</code> etc.
		1892	macros from <cite>ev.h</cite>.</p>
		1893	</dd>
		1894	<dt><code>ev::tstamp</code>, <code>ev::now</code></dt>
		1895	<dd>
		1896	<p>Aliases to the same types/functions as with the <code>ev_</code> prefix.</p>
		1897	</dd>
		1898	<dt><code>ev::io</code>, <code>ev::timer</code>, <code>ev::periodic</code>, <code>ev::idle</code>, <code>ev::sig</code> etc.</dt>
		1899	<dd>
		1900	<p>For each <code>ev_TYPE</code> watcher in <cite>ev.h</cite> there is a corresponding class of
		1901	the same name in the <code>ev</code> namespace, with the exception of <code>ev_signal</code>
		1902	which is called <code>ev::sig</code> to avoid clashes with the <code>signal</code> macro
		1903	defines by many implementations.</p>
		1904	<p>All of those classes have these methods:</p>
		1905	<p>
		1906	<dl>
		1907	<dt>ev::TYPE::TYPE ()</dt>
		1908	<dt>ev::TYPE::TYPE (struct ev_loop *)</dt>
		1909	<dt>ev::TYPE::~TYPE</dt>
		1910	<dd>
		1911	<p>The constructor (optionally) takes an event loop to associate the watcher
		1912	with. If it is omitted, it will use <code>EV_DEFAULT</code>.</p>
		1913	<p>The constructor calls <code>ev_init</code> for you, which means you have to call the
		1914	<code>set</code> method before starting it.</p>
		1915	<p>It will not set a callback, however: You have to call the templated <code>set</code>
		1916	method to set a callback before you can start the watcher.</p>
		1917	<p>(The reason why you have to use a method is a limitation in C++ which does
		1918	not allow explicit template arguments for constructors).</p>
		1919	<p>The destructor automatically stops the watcher if it is active.</p>
		1920	</dd>
		1921	<dt>w->set<class, &class::method> (object *)</dt>
		1922	<dd>
		1923	<p>This method sets the callback method to call. The method has to have a
		1924	signature of <code>void (*)(ev_TYPE &, int)</code>, it receives the watcher as
		1925	first argument and the <code>revents</code> as second. The object must be given as
		1926	parameter and is stored in the <code>data</code> member of the watcher.</p>
		1927	<p>This method synthesizes efficient thunking code to call your method from
		1928	the C callback that libev requires. If your compiler can inline your
		1929	callback (i.e. it is visible to it at the place of the <code>set</code> call and
		1930	your compiler is good :), then the method will be fully inlined into the
		1931	thunking function, making it as fast as a direct C callback.</p>
		1932	<p>Example: simple class declaration and watcher initialisation</p>
		1933	<pre> struct myclass
		1934	{
		1935	void io_cb (ev::io &w, int revents) { }
		1936	}
		1937
		1938	myclass obj;
		1939	ev::io iow;
		1940	iow.set <myclass, &myclass::io_cb> (&obj);
		1941
		1942	</pre>
		1943	</dd>
		1944	<dt>w->set<function> (void *data = 0)</dt>
		1945	<dd>
		1946	<p>Also sets a callback, but uses a static method or plain function as
		1947	callback. The optional <code>data</code> argument will be stored in the watcher's
		1948	<code>data</code> member and is free for you to use.</p>
		1949	<p>The prototype of the <code>function</code> must be <code>void (*)(ev::TYPE &w, int)</code>.</p>
		1950	<p>See the method-<code>set</code> above for more details.</p>
		1951	<p>Example:</p>
		1952	<pre> static void io_cb (ev::io &w, int revents) { }
		1953	iow.set <io_cb> ();
		1954
		1955	</pre>
		1956	</dd>
		1957	<dt>w->set (struct ev_loop *)</dt>
		1958	<dd>
		1959	<p>Associates a different <code>struct ev_loop</code> with this watcher. You can only
		1960	do this when the watcher is inactive (and not pending either).</p>
		1961	</dd>
		1962	<dt>w->set ([args])</dt>
		1963	<dd>
		1964	<p>Basically the same as <code>ev_TYPE_set</code>, with the same args. Must be
		1965	called at least once. Unlike the C counterpart, an active watcher gets
		1966	automatically stopped and restarted when reconfiguring it with this
		1967	method.</p>
		1968	</dd>
		1969	<dt>w->start ()</dt>
		1970	<dd>
		1971	<p>Starts the watcher. Note that there is no <code>loop</code> argument, as the
		1972	constructor already stores the event loop.</p>
		1973	</dd>
		1974	<dt>w->stop ()</dt>
		1975	<dd>
		1976	<p>Stops the watcher if it is active. Again, no <code>loop</code> argument.</p>
		1977	</dd>
		1978	<dt>w->again () <code>ev::timer</code>, <code>ev::periodic</code> only</dt>
		1979	<dd>
		1980	<p>For <code>ev::timer</code> and <code>ev::periodic</code>, this invokes the corresponding
		1981	<code>ev_TYPE_again</code> function.</p>
		1982	</dd>
		1983	<dt>w->sweep () <code>ev::embed</code> only</dt>
		1984	<dd>
		1985	<p>Invokes <code>ev_embed_sweep</code>.</p>
		1986	</dd>
		1987	<dt>w->update () <code>ev::stat</code> only</dt>
		1988	<dd>
		1989	<p>Invokes <code>ev_stat_stat</code>.</p>
		1990	</dd>
		1991	</dl>
		1992	</p>
		1993	</dd>
		1994	</dl>
		1995	<p>Example: Define a class with an IO and idle watcher, start one of them in
		1996	the constructor.</p>
		1997	<pre> class myclass
		1998	{
		1999	ev_io io; void io_cb (ev::io &w, int revents);
		2000	ev_idle idle void idle_cb (ev::idle &w, int revents);
		2001
		2002	myclass ();
		2003	}
		2004
		2005	myclass::myclass (int fd)
		2006	{
		2007	io .set <myclass, &myclass::io_cb > (this);
		2008	idle.set <myclass, &myclass::idle_cb> (this);
		2009
		2010	io.start (fd, ev::READ);
		2011	}
		2012
		2013
		2014
		2015
		2016	</pre>
		2017
1214	</div>	2018	</div>
1215	<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>	2019	<h1 id="MACRO_MAGIC">MACRO MAGIC</h1>
		2020	<div id="MACRO_MAGIC_CONTENT">
		2021	<p>Libev can be compiled with a variety of options, the most fundemantal is
		2022	<code>EV_MULTIPLICITY</code>. This option determines whether (most) functions and
		2023	callbacks have an initial <code>struct ev_loop *</code> argument.</p>
		2024	<p>To make it easier to write programs that cope with either variant, the
		2025	following macros are defined:</p>
		2026	<dl>
		2027	<dt><code>EV_A</code>, <code>EV_A_</code></dt>
		2028	<dd>
		2029	<p>This provides the loop <i>argument</i> for functions, if one is required ("ev
		2030	loop argument"). The <code>EV_A</code> form is used when this is the sole argument,
		2031	<code>EV_A_</code> is used when other arguments are following. Example:</p>
		2032	<pre> ev_unref (EV_A);
		2033	ev_timer_add (EV_A_ watcher);
		2034	ev_loop (EV_A_ 0);
		2035
		2036	</pre>
		2037	<p>It assumes the variable <code>loop</code> of type <code>struct ev_loop *</code> is in scope,
		2038	which is often provided by the following macro.</p>
		2039	</dd>
		2040	<dt><code>EV_P</code>, <code>EV_P_</code></dt>
		2041	<dd>
		2042	<p>This provides the loop <i>parameter</i> for functions, if one is required ("ev
		2043	loop parameter"). The <code>EV_P</code> form is used when this is the sole parameter,
		2044	<code>EV_P_</code> is used when other parameters are following. Example:</p>
		2045	<pre> // this is how ev_unref is being declared
		2046	static void ev_unref (EV_P);
		2047
		2048	// this is how you can declare your typical callback
		2049	static void cb (EV_P_ ev_timer *w, int revents)
		2050
		2051	</pre>
		2052	<p>It declares a parameter <code>loop</code> of type <code>struct ev_loop *</code>, quite
		2053	suitable for use with <code>EV_A</code>.</p>
		2054	</dd>
		2055	<dt><code>EV_DEFAULT</code>, <code>EV_DEFAULT_</code></dt>
		2056	<dd>
		2057	<p>Similar to the other two macros, this gives you the value of the default
		2058	loop, if multiple loops are supported ("ev loop default").</p>
		2059	</dd>
		2060	</dl>
		2061	<p>Example: Declare and initialise a check watcher, utilising the above
		2062	macros so it will work regardless of whether multiple loops are supported
		2063	or not.</p>
		2064	<pre> static void
		2065	check_cb (EV_P_ ev_timer *w, int revents)
		2066	{
		2067	ev_check_stop (EV_A_ w);
		2068	}
		2069
		2070	ev_check check;
		2071	ev_check_init (&check, check_cb);
		2072	ev_check_start (EV_DEFAULT_ &check);
		2073	ev_loop (EV_DEFAULT_ 0);
		2074
		2075	</pre>
		2076
		2077	</div>
		2078	<h1 id="EMBEDDING">EMBEDDING</h1>
		2079	<div id="EMBEDDING_CONTENT">
		2080	<p>Libev can (and often is) directly embedded into host
		2081	applications. Examples of applications that embed it include the Deliantra
		2082	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
		2083	and rxvt-unicode.</p>
		2084	<p>The goal is to enable you to just copy the neecssary files into your
		2085	source directory without having to change even a single line in them, so
		2086	you can easily upgrade by simply copying (or having a checked-out copy of
		2087	libev somewhere in your source tree).</p>
		2088
		2089	</div>
		2090	<h2 id="FILESETS">FILESETS</h2>
		2091	<div id="FILESETS_CONTENT">
		2092	<p>Depending on what features you need you need to include one or more sets of files
		2093	in your app.</p>
		2094
		2095	</div>
		2096	<h3 id="CORE_EVENT_LOOP">CORE EVENT LOOP</h3>
		2097	<div id="CORE_EVENT_LOOP_CONTENT">
		2098	<p>To include only the libev core (all the <code>ev_*</code> functions), with manual
		2099	configuration (no autoconf):</p>
		2100	<pre> #define EV_STANDALONE 1
		2101	#include "ev.c"
		2102
		2103	</pre>
		2104	<p>This will automatically include <cite>ev.h</cite>, too, and should be done in a
		2105	single C source file only to provide the function implementations. To use
		2106	it, do the same for <cite>ev.h</cite> in all files wishing to use this API (best
		2107	done by writing a wrapper around <cite>ev.h</cite> that you can include instead and
		2108	where you can put other configuration options):</p>
		2109	<pre> #define EV_STANDALONE 1
		2110	#include "ev.h"
		2111
		2112	</pre>
		2113	<p>Both header files and implementation files can be compiled with a C++
		2114	compiler (at least, thats a stated goal, and breakage will be treated
		2115	as a bug).</p>
		2116	<p>You need the following files in your source tree, or in a directory
		2117	in your include path (e.g. in libev/ when using -Ilibev):</p>
		2118	<pre> ev.h
		2119	ev.c
		2120	ev_vars.h
		2121	ev_wrap.h
		2122
		2123	ev_win32.c required on win32 platforms only
		2124
		2125	ev_select.c only when select backend is enabled (which is enabled by default)
		2126	ev_poll.c only when poll backend is enabled (disabled by default)
		2127	ev_epoll.c only when the epoll backend is enabled (disabled by default)
		2128	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
		2129	ev_port.c only when the solaris port backend is enabled (disabled by default)
		2130
		2131	</pre>
		2132	<p><cite>ev.c</cite> includes the backend files directly when enabled, so you only need
		2133	to compile this single file.</p>
		2134
		2135	</div>
		2136	<h3 id="LIBEVENT_COMPATIBILITY_API">LIBEVENT COMPATIBILITY API</h3>
		2137	<div id="LIBEVENT_COMPATIBILITY_API_CONTENT">
		2138	<p>To include the libevent compatibility API, also include:</p>
		2139	<pre> #include "event.c"
		2140
		2141	</pre>
		2142	<p>in the file including <cite>ev.c</cite>, and:</p>
		2143	<pre> #include "event.h"
		2144
		2145	</pre>
		2146	<p>in the files that want to use the libevent API. This also includes <cite>ev.h</cite>.</p>
		2147	<p>You need the following additional files for this:</p>
		2148	<pre> event.h
		2149	event.c
		2150
		2151	</pre>
		2152
		2153	</div>
		2154	<h3 id="AUTOCONF_SUPPORT">AUTOCONF SUPPORT</h3>
		2155	<div id="AUTOCONF_SUPPORT_CONTENT">
		2156	<p>Instead of using <code>EV_STANDALONE=1</code> and providing your config in
		2157	whatever way you want, you can also <code>m4_include([libev.m4])</code> in your
		2158	<cite>configure.ac</cite> and leave <code>EV_STANDALONE</code> undefined. <cite>ev.c</cite> will then
		2159	include <cite>config.h</cite> and configure itself accordingly.</p>
		2160	<p>For this of course you need the m4 file:</p>
		2161	<pre> libev.m4
		2162
		2163	</pre>
		2164
		2165	</div>
		2166	<h2 id="PREPROCESSOR_SYMBOLS_MACROS">PREPROCESSOR SYMBOLS/MACROS</h2>
		2167	<div id="PREPROCESSOR_SYMBOLS_MACROS_CONTENT">
		2168	<p>Libev can be configured via a variety of preprocessor symbols you have to define
		2169	before including any of its files. The default is not to build for multiplicity
		2170	and only include the select backend.</p>
		2171	<dl>
		2172	<dt>EV_STANDALONE</dt>
		2173	<dd>
		2174	<p>Must always be <code>1</code> if you do not use autoconf configuration, which
		2175	keeps libev from including <cite>config.h</cite>, and it also defines dummy
		2176	implementations for some libevent functions (such as logging, which is not
		2177	supported). It will also not define any of the structs usually found in
		2178	<cite>event.h</cite> that are not directly supported by the libev core alone.</p>
		2179	</dd>
		2180	<dt>EV_USE_MONOTONIC</dt>
		2181	<dd>
		2182	<p>If defined to be <code>1</code>, libev will try to detect the availability of the
		2183	monotonic clock option at both compiletime and runtime. Otherwise no use
		2184	of the monotonic clock option will be attempted. If you enable this, you
		2185	usually have to link against librt or something similar. Enabling it when
		2186	the functionality isn't available is safe, though, althoguh you have
		2187	to make sure you link against any libraries where the <code>clock_gettime</code>
		2188	function is hiding in (often <cite>-lrt</cite>).</p>
		2189	</dd>
		2190	<dt>EV_USE_REALTIME</dt>
		2191	<dd>
		2192	<p>If defined to be <code>1</code>, libev will try to detect the availability of the
		2193	realtime clock option at compiletime (and assume its availability at
		2194	runtime if successful). Otherwise no use of the realtime clock option will
		2195	be attempted. This effectively replaces <code>gettimeofday</code> by <code>clock_get
		2196	(CLOCK_REALTIME, ...)</code> and will not normally affect correctness. See tzhe note about libraries
		2197	in the description of <code>EV_USE_MONOTONIC</code>, though.</p>
		2198	</dd>
		2199	<dt>EV_USE_SELECT</dt>
		2200	<dd>
		2201	<p>If undefined or defined to be <code>1</code>, libev will compile in support for the
		2202	<code>select</code>(2) backend. No attempt at autodetection will be done: if no
		2203	other method takes over, select will be it. Otherwise the select backend
		2204	will not be compiled in.</p>
		2205	</dd>
		2206	<dt>EV_SELECT_USE_FD_SET</dt>
		2207	<dd>
		2208	<p>If defined to <code>1</code>, then the select backend will use the system <code>fd_set</code>
		2209	structure. This is useful if libev doesn't compile due to a missing
		2210	<code>NFDBITS</code> or <code>fd_mask</code> definition or it misguesses the bitset layout on
		2211	exotic systems. This usually limits the range of file descriptors to some
		2212	low limit such as 1024 or might have other limitations (winsocket only
		2213	allows 64 sockets). The <code>FD_SETSIZE</code> macro, set before compilation, might
		2214	influence the size of the <code>fd_set</code> used.</p>
		2215	</dd>
		2216	<dt>EV_SELECT_IS_WINSOCKET</dt>
		2217	<dd>
		2218	<p>When defined to <code>1</code>, the select backend will assume that
		2219	select/socket/connect etc. don't understand file descriptors but
		2220	wants osf handles on win32 (this is the case when the select to
		2221	be used is the winsock select). This means that it will call
		2222	<code>_get_osfhandle</code> on the fd to convert it to an OS handle. Otherwise,
		2223	it is assumed that all these functions actually work on fds, even
		2224	on win32. Should not be defined on non-win32 platforms.</p>
		2225	</dd>
		2226	<dt>EV_USE_POLL</dt>
		2227	<dd>
		2228	<p>If defined to be <code>1</code>, libev will compile in support for the <code>poll</code>(2)
		2229	backend. Otherwise it will be enabled on non-win32 platforms. It
		2230	takes precedence over select.</p>
		2231	</dd>
		2232	<dt>EV_USE_EPOLL</dt>
		2233	<dd>
		2234	<p>If defined to be <code>1</code>, libev will compile in support for the Linux
		2235	<code>epoll</code>(7) backend. Its availability will be detected at runtime,
		2236	otherwise another method will be used as fallback. This is the
		2237	preferred backend for GNU/Linux systems.</p>
		2238	</dd>
		2239	<dt>EV_USE_KQUEUE</dt>
		2240	<dd>
		2241	<p>If defined to be <code>1</code>, libev will compile in support for the BSD style
		2242	<code>kqueue</code>(2) backend. Its actual availability will be detected at runtime,
		2243	otherwise another method will be used as fallback. This is the preferred
		2244	backend for BSD and BSD-like systems, although on most BSDs kqueue only
		2245	supports some types of fds correctly (the only platform we found that
		2246	supports ptys for example was NetBSD), so kqueue might be compiled in, but
		2247	not be used unless explicitly requested. The best way to use it is to find
		2248	out whether kqueue supports your type of fd properly and use an embedded
		2249	kqueue loop.</p>
		2250	</dd>
		2251	<dt>EV_USE_PORT</dt>
		2252	<dd>
		2253	<p>If defined to be <code>1</code>, libev will compile in support for the Solaris
		2254	10 port style backend. Its availability will be detected at runtime,
		2255	otherwise another method will be used as fallback. This is the preferred
		2256	backend for Solaris 10 systems.</p>
		2257	</dd>
		2258	<dt>EV_USE_DEVPOLL</dt>
		2259	<dd>
		2260	<p>reserved for future expansion, works like the USE symbols above.</p>
		2261	</dd>
		2262	<dt>EV_USE_INOTIFY</dt>
		2263	<dd>
		2264	<p>If defined to be <code>1</code>, libev will compile in support for the Linux inotify
		2265	interface to speed up <code>ev_stat</code> watchers. Its actual availability will
		2266	be detected at runtime.</p>
		2267	</dd>
		2268	<dt>EV_H</dt>
		2269	<dd>
		2270	<p>The name of the <cite>ev.h</cite> header file used to include it. The default if
		2271	undefined is <code><ev.h></code> in <cite>event.h</cite> and <code>"ev.h"</code> in <cite>ev.c</cite>. This
		2272	can be used to virtually rename the <cite>ev.h</cite> header file in case of conflicts.</p>
		2273	</dd>
		2274	<dt>EV_CONFIG_H</dt>
		2275	<dd>
		2276	<p>If <code>EV_STANDALONE</code> isn't <code>1</code>, this variable can be used to override
		2277	<cite>ev.c</cite>'s idea of where to find the <cite>config.h</cite> file, similarly to
		2278	<code>EV_H</code>, above.</p>
		2279	</dd>
		2280	<dt>EV_EVENT_H</dt>
		2281	<dd>
		2282	<p>Similarly to <code>EV_H</code>, this macro can be used to override <cite>event.c</cite>'s idea
		2283	of how the <cite>event.h</cite> header can be found.</p>
		2284	</dd>
		2285	<dt>EV_PROTOTYPES</dt>
		2286	<dd>
		2287	<p>If defined to be <code>0</code>, then <cite>ev.h</cite> will not define any function
		2288	prototypes, but still define all the structs and other symbols. This is
		2289	occasionally useful if you want to provide your own wrapper functions
		2290	around libev functions.</p>
		2291	</dd>
		2292	<dt>EV_MULTIPLICITY</dt>
		2293	<dd>
		2294	<p>If undefined or defined to <code>1</code>, then all event-loop-specific functions
		2295	will have the <code>struct ev_loop *</code> as first argument, and you can create
		2296	additional independent event loops. Otherwise there will be no support
		2297	for multiple event loops and there is no first event loop pointer
		2298	argument. Instead, all functions act on the single default loop.</p>
		2299	</dd>
		2300	<dt>EV_MINPRI</dt>
		2301	<dt>EV_MAXPRI</dt>
		2302	<dd>
		2303	<p>The range of allowed priorities. <code>EV_MINPRI</code> must be smaller or equal to
		2304	<code>EV_MAXPRI</code>, but otherwise there are no non-obvious limitations. You can
		2305	provide for more priorities by overriding those symbols (usually defined
		2306	to be <code>-2</code> and <code>2</code>, respectively).</p>
		2307	<p>When doing priority-based operations, libev usually has to linearly search
		2308	all the priorities, so having many of them (hundreds) uses a lot of space
		2309	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2310	fine.</p>
		2311	<p>If your embedding app does not need any priorities, defining these both to
		2312	<code>0</code> will save some memory and cpu.</p>
		2313	</dd>
		2314	<dt>EV_PERIODIC_ENABLE</dt>
		2315	<dd>
		2316	<p>If undefined or defined to be <code>1</code>, then periodic timers are supported. If
		2317	defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
		2318	code.</p>
		2319	</dd>
		2320	<dt>EV_IDLE_ENABLE</dt>
		2321	<dd>
		2322	<p>If undefined or defined to be <code>1</code>, then idle watchers are supported. If
		2323	defined to be <code>0</code>, then they are not. Disabling them saves a few kB of
		2324	code.</p>
		2325	</dd>
		2326	<dt>EV_EMBED_ENABLE</dt>
		2327	<dd>
		2328	<p>If undefined or defined to be <code>1</code>, then embed watchers are supported. If
		2329	defined to be <code>0</code>, then they are not.</p>
		2330	</dd>
		2331	<dt>EV_STAT_ENABLE</dt>
		2332	<dd>
		2333	<p>If undefined or defined to be <code>1</code>, then stat watchers are supported. If
		2334	defined to be <code>0</code>, then they are not.</p>
		2335	</dd>
		2336	<dt>EV_FORK_ENABLE</dt>
		2337	<dd>
		2338	<p>If undefined or defined to be <code>1</code>, then fork watchers are supported. If
		2339	defined to be <code>0</code>, then they are not.</p>
		2340	</dd>
		2341	<dt>EV_MINIMAL</dt>
		2342	<dd>
		2343	<p>If you need to shave off some kilobytes of code at the expense of some
		2344	speed, define this symbol to <code>1</code>. Currently only used for gcc to override
		2345	some inlining decisions, saves roughly 30% codesize of amd64.</p>
		2346	</dd>
		2347	<dt>EV_PID_HASHSIZE</dt>
		2348	<dd>
		2349	<p><code>ev_child</code> watchers use a small hash table to distribute workload by
		2350	pid. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>), usually more
		2351	than enough. If you need to manage thousands of children you might want to
		2352	increase this value (<i>must</i> be a power of two).</p>
		2353	</dd>
		2354	<dt>EV_INOTIFY_HASHSIZE</dt>
		2355	<dd>
		2356	<p><code>ev_staz</code> watchers use a small hash table to distribute workload by
		2357	inotify watch id. The default size is <code>16</code> (or <code>1</code> with <code>EV_MINIMAL</code>),
		2358	usually more than enough. If you need to manage thousands of <code>ev_stat</code>
		2359	watchers you might want to increase this value (<i>must</i> be a power of
		2360	two).</p>
		2361	</dd>
		2362	<dt>EV_COMMON</dt>
		2363	<dd>
		2364	<p>By default, all watchers have a <code>void *data</code> member. By redefining
		2365	this macro to a something else you can include more and other types of
		2366	members. You have to define it each time you include one of the files,
		2367	though, and it must be identical each time.</p>
		2368	<p>For example, the perl EV module uses something like this:</p>
		2369	<pre> #define EV_COMMON \
		2370	SV self; / contains this struct */ \
		2371	SV cb_sv, fh /* note no trailing ";" */
		2372
		2373	</pre>
		2374	</dd>
		2375	<dt>EV_CB_DECLARE (type)</dt>
		2376	<dt>EV_CB_INVOKE (watcher, revents)</dt>
		2377	<dt>ev_set_cb (ev, cb)</dt>
		2378	<dd>
		2379	<p>Can be used to change the callback member declaration in each watcher,
		2380	and the way callbacks are invoked and set. Must expand to a struct member
		2381	definition and a statement, respectively. See the <cite>ev.v</cite> header file for
		2382	their default definitions. One possible use for overriding these is to
		2383	avoid the <code>struct ev_loop *</code> as first argument in all cases, or to use
		2384	method calls instead of plain function calls in C++.</p>
		2385
		2386	</div>
		2387	<h2 id="EXAMPLES">EXAMPLES</h2>
		2388	<div id="EXAMPLES_CONTENT">
		2389	<p>For a real-world example of a program the includes libev
		2390	verbatim, you can have a look at the EV perl module
		2391	(<a href="http://software.schmorp.de/pkg/EV.html">http://software.schmorp.de/pkg/EV.html</a>). It has the libev files in
		2392	the <cite>libev/</cite> subdirectory and includes them in the <cite>EV/EVAPI.h</cite> (public
		2393	interface) and <cite>EV.xs</cite> (implementation) files. Only the <cite>EV.xs</cite> file
		2394	will be compiled. It is pretty complex because it provides its own header
		2395	file.</p>
		2396	<p>The usage in rxvt-unicode is simpler. It has a <cite>ev_cpp.h</cite> header file
		2397	that everybody includes and which overrides some configure choices:</p>
		2398	<pre> #define EV_MINIMAL 1
		2399	#define EV_USE_POLL 0
		2400	#define EV_MULTIPLICITY 0
		2401	#define EV_PERIODIC_ENABLE 0
		2402	#define EV_STAT_ENABLE 0
		2403	#define EV_FORK_ENABLE 0
		2404	#define EV_CONFIG_H <config.h>
		2405	#define EV_MINPRI 0
		2406	#define EV_MAXPRI 0
		2407
		2408	#include "ev++.h"
		2409
		2410	</pre>
		2411	<p>And a <cite>ev_cpp.C</cite> implementation file that contains libev proper and is compiled:</p>
		2412	<pre> #include "ev_cpp.h"
		2413	#include "ev.c"
		2414
		2415
		2416
		2417
		2418	</pre>
		2419
		2420	</div>
		2421	<h1 id="COMPLEXITIES">COMPLEXITIES</h1>
		2422	<div id="COMPLEXITIES_CONTENT">
		2423	<p>In this section the complexities of (many of) the algorithms used inside
		2424	libev will be explained. For complexity discussions about backends see the
		2425	documentation for <code>ev_default_init</code>.</p>
		2426	<p>All of the following are about amortised time: If an array needs to be
		2427	extended, libev needs to realloc and move the whole array, but this
		2428	happens asymptotically never with higher number of elements, so O(1) might
		2429	mean it might do a lengthy realloc operation in rare cases, but on average
		2430	it is much faster and asymptotically approaches constant time.</p>
		2431	<p>
		2432	<dl>
		2433	<dt>Starting and stopping timer/periodic watchers: O(log skipped_other_timers)</dt>
		2434	<dd>
		2435	<p>This means that, when you have a watcher that triggers in one hour and
		2436	there are 100 watchers that would trigger before that then inserting will
		2437	have to skip those 100 watchers.</p>
		2438	</dd>
		2439	<dt>Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)</dt>
		2440	<dd>
		2441	<p>That means that for changing a timer costs less than removing/adding them
		2442	as only the relative motion in the event queue has to be paid for.</p>
		2443	</dd>
		2444	<dt>Starting io/check/prepare/idle/signal/child watchers: O(1)</dt>
		2445	<dd>
		2446	<p>These just add the watcher into an array or at the head of a list.
		2447	=item Stopping check/prepare/idle watchers: O(1)</p>
		2448	</dd>
		2449	<dt>Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))</dt>
		2450	<dd>
		2451	<p>These watchers are stored in lists then need to be walked to find the
		2452	correct watcher to remove. The lists are usually short (you don't usually
		2453	have many watchers waiting for the same fd or signal).</p>
		2454	</dd>
		2455	<dt>Finding the next timer per loop iteration: O(1)</dt>
		2456	<dt>Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)</dt>
		2457	<dd>
		2458	<p>A change means an I/O watcher gets started or stopped, which requires
		2459	libev to recalculate its status (and possibly tell the kernel).</p>
		2460	</dd>
		2461	<dt>Activating one watcher: O(1)</dt>
		2462	<dt>Priority handling: O(number_of_priorities)</dt>
		2463	<dd>
		2464	<p>Priorities are implemented by allocating some space for each
		2465	priority. When doing priority-based operations, libev usually has to
		2466	linearly search all the priorities.</p>
		2467	</dd>
		2468	</dl>
		2469	</p>
		2470
		2471
		2472
		2473
		2474
		2475	</div>
		2476	<h1 id="AUTHOR">AUTHOR</h1>
1216	<div id="AUTHOR_CONTENT">	2477	<div id="AUTHOR_CONTENT">
1217	<p>Marc Lehmann <libev@schmorp.de>.</p>	2478	<p>Marc Lehmann <libev@schmorp.de>.</p>
1218		2479
1219	</div>	2480	</div>
1220	</div></body>	2481	</div></body>
1221	</html>	2482	</html>

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing libev/ev.html (file contents): Revision 1.36 by root, Sat Nov 24 06:23:27 2007 UTC vs. Revision 1.77 by root, Wed Dec 12 04:53:58 2007 UTC

Diff Legend

Comparing libev/ev.html (file contents):
Revision 1.36 by root, Sat Nov 24 06:23:27 2007 UTC vs.
Revision 1.77 by root, Wed Dec 12 04:53:58 2007 UTC