ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.110 by root, Tue Dec 25 07:05:45 2007 UTC vs.
Revision 1.258 by root, Wed Jul 15 16:58:53 2009 UTC

…		…
2		2
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
		11	// a single header file is required
11	#include <ev.h>	12	#include <ev.h>
12		13
		14	#include <stdio.h> // for puts
		15
		16	// every watcher type has its own typedef'd struct
		17	// with the name ev_TYPE
13	ev_io stdin_watcher;	18	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
15		20
16	/* called when data readable on stdin */	21	// all watcher callbacks have a similar signature
		22	// this callback is called when data is readable on stdin
17	static void	23	static void
18	stdin_cb (EV_P_ struct ev_io *w, int revents)	24	stdin_cb (EV_P_ ev_io *w, int revents)
19	{	25	{
20	/* puts ("stdin ready"); */	26	puts ("stdin ready");
21	ev_io_stop (EV_A_ w); /* just a syntax example */	27	// for one-shot events, one must manually stop the watcher
22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */	28	// with its corresponding stop function.
		29	ev_io_stop (EV_A_ w);
		30
		31	// this causes all nested ev_loop's to stop iterating
		32	ev_unloop (EV_A_ EVUNLOOP_ALL);
23	}	33	}
24		34
		35	// another callback, this time for a time-out
25	static void	36	static void
26	timeout_cb (EV_P_ struct ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
27	{	38	{
28	/* puts ("timeout"); */	39	puts ("timeout");
29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */	40	// this causes the innermost ev_loop to stop iterating
		41	ev_unloop (EV_A_ EVUNLOOP_ONE);
30	}	42	}
31		43
32	int	44	int
33	main (void)	45	main (void)
34	{	46	{
		47	// use the default event loop unless you have special needs
35	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = ev_default_loop (0);
36		49
37	/* initialise an io watcher, then start it */	50	// initialise an io watcher, then start it
		51	// this one will watch for stdin to become readable
38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
40		54
		55	// initialise a timer watcher, then start it
41	/* simple non-repeating 5.5 second timeout */	56	// simple non-repeating 5.5 second timeout
42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
44		59
45	/* loop till timeout or data ready */	60	// now wait for events to arrive
46	ev_loop (loop, 0);	61	ev_loop (loop, 0);
47		62
		63	// unloop was called, so exit
48	return 0;	64	return 0;
49	}	65	}
50		66
51	=head1 DESCRIPTION	67	=head1 ABOUT THIS DOCUMENT
52		68
		69	This document documents the libev software package.
		70
53	The newest version of this document is also available as a html-formatted	71	The newest version of this document is also available as an html-formatted
54	web page you might find easier to navigate when reading it for the first	72	web page you might find easier to navigate when reading it for the first
55	time: L<http://cvs.schmorp.de/libev/ev.html>.	73	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
		74
		75	While this document tries to be as complete as possible in documenting
		76	libev, its usage and the rationale behind its design, it is not a tutorial
		77	on event-based programming, nor will it introduce event-based programming
		78	with libev.
		79
		80	Familarity with event based programming techniques in general is assumed
		81	throughout this document.
		82
		83	=head1 ABOUT LIBEV
56		84
57	Libev is an event loop: you register interest in certain events (such as a	85	Libev is an event loop: you register interest in certain events (such as a
58	file descriptor being readable or a timeout occurring), and it will manage	86	file descriptor being readable or a timeout occurring), and it will manage
59	these event sources and provide your program with events.	87	these event sources and provide your program with events.
60		88
…		…
84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	112	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85	for example).	113	for example).
86		114
87	=head2 CONVENTIONS	115	=head2 CONVENTIONS
88		116
89	Libev is very configurable. In this manual the default configuration will	117	Libev is very configurable. In this manual the default (and most common)
90	be described, which supports multiple event loops. For more info about	118	configuration will be described, which supports multiple event loops. For
91	various configuration options please have a look at B<EMBED> section in	119	more info about various configuration options please have a look at
92	this manual. If libev was configured without support for multiple event	120	B<EMBED> section in this manual. If libev was configured without support
93	loops, then all functions taking an initial argument of name C<loop>	121	for multiple event loops, then all functions taking an initial argument of
94	(which is always of type C<struct ev_loop *>) will not have this argument.	122	name C<loop> (which is always of type C<ev_loop *>) will not have
		123	this argument.
95		124
96	=head2 TIME REPRESENTATION	125	=head2 TIME REPRESENTATION
97		126
98	Libev represents time as a single floating point number, representing the	127	Libev represents time as a single floating point number, representing
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	128	the (fractional) number of seconds since the (POSIX) epoch (somewhere
100	the beginning of 1970, details are complicated, don't ask). This type is	129	near the beginning of 1970, details are complicated, don't ask). This
101	called C<ev_tstamp>, which is what you should use too. It usually aliases	130	type is called C<ev_tstamp>, which is what you should use too. It usually
102	to the C<double> type in C, and when you need to do any calculations on	131	aliases to the C<double> type in C. When you need to do any calculations
103	it, you should treat it as some floatingpoint value. Unlike the name	132	on it, you should treat it as some floating point value. Unlike the name
104	component C<stamp> might indicate, it is also used for time differences	133	component C<stamp> might indicate, it is also used for time differences
105	throughout libev.	134	throughout libev.
		135
		136	=head1 ERROR HANDLING
		137
		138	Libev knows three classes of errors: operating system errors, usage errors
		139	and internal errors (bugs).
		140
		141	When libev catches an operating system error it cannot handle (for example
		142	a system call indicating a condition libev cannot fix), it calls the callback
		143	set via C<ev_set_syserr_cb>, which is supposed to fix the problem or
		144	abort. The default is to print a diagnostic message and to call C<abort
		145	()>.
		146
		147	When libev detects a usage error such as a negative timer interval, then
		148	it will print a diagnostic message and abort (via the C<assert> mechanism,
		149	so C<NDEBUG> will disable this checking): these are programming errors in
		150	the libev caller and need to be fixed there.
		151
		152	Libev also has a few internal error-checking C<assert>ions, and also has
		153	extensive consistency checking code. These do not trigger under normal
		154	circumstances, as they indicate either a bug in libev or worse.
		155
106		156
107	=head1 GLOBAL FUNCTIONS	157	=head1 GLOBAL FUNCTIONS
108		158
109	These functions can be called anytime, even before initialising the	159	These functions can be called anytime, even before initialising the
110	library in any way.	160	library in any way.
…		…
119		169
120	=item ev_sleep (ev_tstamp interval)	170	=item ev_sleep (ev_tstamp interval)
121		171
122	Sleep for the given interval: The current thread will be blocked until	172	Sleep for the given interval: The current thread will be blocked until
123	either it is interrupted or the given time interval has passed. Basically	173	either it is interrupted or the given time interval has passed. Basically
124	this is a subsecond-resolution C<sleep ()>.	174	this is a sub-second-resolution C<sleep ()>.
125		175
126	=item int ev_version_major ()	176	=item int ev_version_major ()
127		177
128	=item int ev_version_minor ()	178	=item int ev_version_minor ()
129		179
…		…
142	not a problem.	192	not a problem.
143		193
144	Example: Make sure we haven't accidentally been linked against the wrong	194	Example: Make sure we haven't accidentally been linked against the wrong
145	version.	195	version.
146		196
147	assert (("libev version mismatch",	197	assert (("libev version mismatch",
148	ev_version_major () == EV_VERSION_MAJOR	198	ev_version_major () == EV_VERSION_MAJOR
149	&& ev_version_minor () >= EV_VERSION_MINOR));	199	&& ev_version_minor () >= EV_VERSION_MINOR));
150		200
151	=item unsigned int ev_supported_backends ()	201	=item unsigned int ev_supported_backends ()
152		202
153	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	203	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
154	value) compiled into this binary of libev (independent of their	204	value) compiled into this binary of libev (independent of their
…		…
156	a description of the set values.	206	a description of the set values.
157		207
158	Example: make sure we have the epoll method, because yeah this is cool and	208	Example: make sure we have the epoll method, because yeah this is cool and
159	a must have and can we have a torrent of it please!!!11	209	a must have and can we have a torrent of it please!!!11
160		210
161	assert (("sorry, no epoll, no sex",	211	assert (("sorry, no epoll, no sex",
162	ev_supported_backends () & EVBACKEND_EPOLL));	212	ev_supported_backends () & EVBACKEND_EPOLL));
163		213
164	=item unsigned int ev_recommended_backends ()	214	=item unsigned int ev_recommended_backends ()
165		215
166	Return the set of all backends compiled into this binary of libev and also	216	Return the set of all backends compiled into this binary of libev and also
167	recommended for this platform. This set is often smaller than the one	217	recommended for this platform. This set is often smaller than the one
168	returned by C<ev_supported_backends>, as for example kqueue is broken on	218	returned by C<ev_supported_backends>, as for example kqueue is broken on
169	most BSDs and will not be autodetected unless you explicitly request it	219	most BSDs and will not be auto-detected unless you explicitly request it
170	(assuming you know what you are doing). This is the set of backends that	220	(assuming you know what you are doing). This is the set of backends that
171	libev will probe for if you specify no backends explicitly.	221	libev will probe for if you specify no backends explicitly.
172		222
173	=item unsigned int ev_embeddable_backends ()	223	=item unsigned int ev_embeddable_backends ()
174		224
…		…
178	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	228	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
179	recommended ones.	229	recommended ones.
180		230
181	See the description of C<ev_embed> watchers for more info.	231	See the description of C<ev_embed> watchers for more info.
182		232
183	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	233	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
184		234
185	Sets the allocation function to use (the prototype is similar - the	235	Sets the allocation function to use (the prototype is similar - the
186	semantics is identical - to the realloc C function). It is used to	236	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
187	allocate and free memory (no surprises here). If it returns zero when	237	used to allocate and free memory (no surprises here). If it returns zero
188	memory needs to be allocated, the library might abort or take some	238	when memory needs to be allocated (C<size != 0>), the library might abort
189	potentially destructive action. The default is your system realloc	239	or take some potentially destructive action.
190	function.	240
		241	Since some systems (at least OpenBSD and Darwin) fail to implement
		242	correct C<realloc> semantics, libev will use a wrapper around the system
		243	C<realloc> and C<free> functions by default.
191		244
192	You could override this function in high-availability programs to, say,	245	You could override this function in high-availability programs to, say,
193	free some memory if it cannot allocate memory, to use a special allocator,	246	free some memory if it cannot allocate memory, to use a special allocator,
194	or even to sleep a while and retry until some memory is available.	247	or even to sleep a while and retry until some memory is available.
195		248
196	Example: Replace the libev allocator with one that waits a bit and then	249	Example: Replace the libev allocator with one that waits a bit and then
197	retries).	250	retries (example requires a standards-compliant C<realloc>).
198		251
199	static void *	252	static void *
200	persistent_realloc (void *ptr, size_t size)	253	persistent_realloc (void *ptr, size_t size)
201	{	254	{
202	for (;;)	255	for (;;)
…		…
211	}	264	}
212		265
213	...	266	...
214	ev_set_allocator (persistent_realloc);	267	ev_set_allocator (persistent_realloc);
215		268
216	=item ev_set_syserr_cb (void (*cb)(const char *msg));	269	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
217		270
218	Set the callback function to call on a retryable syscall error (such	271	Set the callback function to call on a retryable system call error (such
219	as failed select, poll, epoll_wait). The message is a printable string	272	as failed select, poll, epoll_wait). The message is a printable string
220	indicating the system call or subsystem causing the problem. If this	273	indicating the system call or subsystem causing the problem. If this
221	callback is set, then libev will expect it to remedy the sitution, no	274	callback is set, then libev will expect it to remedy the situation, no
222	matter what, when it returns. That is, libev will generally retry the	275	matter what, when it returns. That is, libev will generally retry the
223	requested operation, or, if the condition doesn't go away, do bad stuff	276	requested operation, or, if the condition doesn't go away, do bad stuff
224	(such as abort).	277	(such as abort).
225		278
226	Example: This is basically the same thing that libev does internally, too.	279	Example: This is basically the same thing that libev does internally, too.
…		…
237		290
238	=back	291	=back
239		292
240	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	293	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
241		294
242	An event loop is described by a C<struct ev_loop *>. The library knows two	295	An event loop is described by a C<struct ev_loop *> (the C<struct>
243	types of such loops, the I<default> loop, which supports signals and child	296	is I<not> optional in this case, as there is also an C<ev_loop>
244	events, and dynamically created loops which do not.	297	I<function>).
245		298
246	If you use threads, a common model is to run the default event loop	299	The library knows two types of such loops, the I<default> loop, which
247	in your main thread (or in a separate thread) and for each thread you	300	supports signals and child events, and dynamically created loops which do
248	create, you also create another event loop. Libev itself does no locking	301	not.
249	whatsoever, so if you mix calls to the same event loop in different
250	threads, make sure you lock (this is usually a bad idea, though, even if
251	done correctly, because it's hideous and inefficient).
252		302
253	=over 4	303	=over 4
254		304
255	=item struct ev_loop *ev_default_loop (unsigned int flags)	305	=item struct ev_loop *ev_default_loop (unsigned int flags)
256		306
…		…
260	flags. If that is troubling you, check C<ev_backend ()> afterwards).	310	flags. If that is troubling you, check C<ev_backend ()> afterwards).
261		311
262	If you don't know what event loop to use, use the one returned from this	312	If you don't know what event loop to use, use the one returned from this
263	function.	313	function.
264		314
		315	Note that this function is I<not> thread-safe, so if you want to use it
		316	from multiple threads, you have to lock (note also that this is unlikely,
		317	as loops cannot be shared easily between threads anyway).
		318
		319	The default loop is the only loop that can handle C<ev_signal> and
		320	C<ev_child> watchers, and to do this, it always registers a handler
		321	for C<SIGCHLD>. If this is a problem for your application you can either
		322	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
		323	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
		324	C<ev_default_init>.
		325
265	The flags argument can be used to specify special behaviour or specific	326	The flags argument can be used to specify special behaviour or specific
266	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	327	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
267		328
268	The following flags are supported:	329	The following flags are supported:
269		330
…		…
274	The default flags value. Use this if you have no clue (it's the right	335	The default flags value. Use this if you have no clue (it's the right
275	thing, believe me).	336	thing, believe me).
276		337
277	=item C<EVFLAG_NOENV>	338	=item C<EVFLAG_NOENV>
278		339
279	If this flag bit is ored into the flag value (or the program runs setuid	340	If this flag bit is or'ed into the flag value (or the program runs setuid
280	or setgid) then libev will I<not> look at the environment variable	341	or setgid) then libev will I<not> look at the environment variable
281	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	342	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
282	override the flags completely if it is found in the environment. This is	343	override the flags completely if it is found in the environment. This is
283	useful to try out specific backends to test their performance, or to work	344	useful to try out specific backends to test their performance, or to work
284	around bugs.	345	around bugs.
…		…
290	enabling this flag.	351	enabling this flag.
291		352
292	This works by calling C<getpid ()> on every iteration of the loop,	353	This works by calling C<getpid ()> on every iteration of the loop,
293	and thus this might slow down your event loop if you do a lot of loop	354	and thus this might slow down your event loop if you do a lot of loop
294	iterations and little real work, but is usually not noticeable (on my	355	iterations and little real work, but is usually not noticeable (on my
295	Linux system for example, C<getpid> is actually a simple 5-insn sequence	356	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
296	without a syscall and thus I<very> fast, but my Linux system also has	357	without a system call and thus I<very> fast, but my GNU/Linux system also has
297	C<pthread_atfork> which is even faster).	358	C<pthread_atfork> which is even faster).
298		359
299	The big advantage of this flag is that you can forget about fork (and	360	The big advantage of this flag is that you can forget about fork (and
300	forget about forgetting to tell libev about forking) when you use this	361	forget about forgetting to tell libev about forking) when you use this
301	flag.	362	flag.
302		363
303	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>	364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
304	environment variable.	365	environment variable.
305		366
306	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
307		368
308	This is your standard select(2) backend. Not I<completely> standard, as	369	This is your standard select(2) backend. Not I<completely> standard, as
…		…
310	but if that fails, expect a fairly low limit on the number of fds when	371	but if that fails, expect a fairly low limit on the number of fds when
311	using this backend. It doesn't scale too well (O(highest_fd)), but its	372	using this backend. It doesn't scale too well (O(highest_fd)), but its
312	usually the fastest backend for a low number of (low-numbered :) fds.	373	usually the fastest backend for a low number of (low-numbered :) fds.
313		374
314	To get good performance out of this backend you need a high amount of	375	To get good performance out of this backend you need a high amount of
315	parallelity (most of the file descriptors should be busy). If you are	376	parallelism (most of the file descriptors should be busy). If you are
316	writing a server, you should C<accept ()> in a loop to accept as many	377	writing a server, you should C<accept ()> in a loop to accept as many
317	connections as possible during one iteration. You might also want to have	378	connections as possible during one iteration. You might also want to have
318	a look at C<ev_set_io_collect_interval ()> to increase the amount of	379	a look at C<ev_set_io_collect_interval ()> to increase the amount of
319	readyness notifications you get per iteration.	380	readiness notifications you get per iteration.
		381
		382	This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
		383	C<writefds> set (and to work around Microsoft Windows bugs, also onto the
		384	C<exceptfds> set on that platform).
320		385
321	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	386	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
322		387
323	And this is your standard poll(2) backend. It's more complicated	388	And this is your standard poll(2) backend. It's more complicated
324	than select, but handles sparse fds better and has no artificial	389	than select, but handles sparse fds better and has no artificial
325	limit on the number of fds you can use (except it will slow down	390	limit on the number of fds you can use (except it will slow down
326	considerably with a lot of inactive fds). It scales similarly to select,	391	considerably with a lot of inactive fds). It scales similarly to select,
327	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for	392	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
328	performance tips.	393	performance tips.
329		394
		395	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		396	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
		397
330	=item C<EVBACKEND_EPOLL> (value 4, Linux)	398	=item C<EVBACKEND_EPOLL> (value 4, Linux)
331		399
332	For few fds, this backend is a bit little slower than poll and select,	400	For few fds, this backend is a bit little slower than poll and select,
333	but it scales phenomenally better. While poll and select usually scale	401	but it scales phenomenally better. While poll and select usually scale
334	like O(total_fds) where n is the total number of fds (or the highest fd),	402	like O(total_fds) where n is the total number of fds (or the highest fd),
335	epoll scales either O(1) or O(active_fds). The epoll design has a number	403	epoll scales either O(1) or O(active_fds).
336	of shortcomings, such as silently dropping events in some hard-to-detect	404
337	cases and rewiring a syscall per fd change, no fork support and bad	405	The epoll mechanism deserves honorable mention as the most misdesigned
338	support for dup.	406	of the more advanced event mechanisms: mere annoyances include silently
		407	dropping file descriptors, requiring a system call per change per file
		408	descriptor (and unnecessary guessing of parameters), problems with dup and
		409	so on. The biggest issue is fork races, however - if a program forks then
		410	I<both> parent and child process have to recreate the epoll set, which can
		411	take considerable time (one syscall per file descriptor) and is of course
		412	hard to detect.
		413
		414	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		415	of course I<doesn't>, and epoll just loves to report events for totally
		416	I<different> file descriptors (even already closed ones, so one cannot
		417	even remove them from the set) than registered in the set (especially
		418	on SMP systems). Libev tries to counter these spurious notifications by
		419	employing an additional generation counter and comparing that against the
		420	events to filter out spurious ones, recreating the set when required.
339		421
340	While stopping, setting and starting an I/O watcher in the same iteration	422	While stopping, setting and starting an I/O watcher in the same iteration
341	will result in some caching, there is still a syscall per such incident	423	will result in some caching, there is still a system call per such
342	(because the fd could point to a different file description now), so its	424	incident (because the same I<file descriptor> could point to a different
343	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	425	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
344	very well if you register events for both fds.	426	file descriptors might not work very well if you register events for both
345		427	file descriptors.
346	Please note that epoll sometimes generates spurious notifications, so you
347	need to use non-blocking I/O or other means to avoid blocking when no data
348	(or space) is available.
349		428
350	Best performance from this backend is achieved by not unregistering all	429	Best performance from this backend is achieved by not unregistering all
351	watchers for a file descriptor until it has been closed, if possible, i.e.	430	watchers for a file descriptor until it has been closed, if possible,
352	keep at least one watcher active per fd at all times.	431	i.e. keep at least one watcher active per fd at all times. Stopping and
		432	starting a watcher (without re-setting it) also usually doesn't cause
		433	extra overhead. A fork can both result in spurious notifications as well
		434	as in libev having to destroy and recreate the epoll object, which can
		435	take considerable time and thus should be avoided.
353		436
		437	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		438	faster than epoll for maybe up to a hundred file descriptors, depending on
		439	the usage. So sad.
		440
354	While nominally embeddeble in other event loops, this feature is broken in	441	While nominally embeddable in other event loops, this feature is broken in
355	all kernel versions tested so far.	442	all kernel versions tested so far.
		443
		444	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		445	C<EVBACKEND_POLL>.
356		446
357	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	447	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
358		448
359	Kqueue deserves special mention, as at the time of this writing, it	449	Kqueue deserves special mention, as at the time of this writing, it
360	was broken on all BSDs except NetBSD (usually it doesn't work reliably	450	was broken on all BSDs except NetBSD (usually it doesn't work reliably
361	with anything but sockets and pipes, except on Darwin, where of course	451	with anything but sockets and pipes, except on Darwin, where of course
362	it's completely useless). For this reason it's not being "autodetected"	452	it's completely useless). Unlike epoll, however, whose brokenness
		453	is by design, these kqueue bugs can (and eventually will) be fixed
		454	without API changes to existing programs. For this reason it's not being
363	unless you explicitly specify it explicitly in the flags (i.e. using	455	"auto-detected" unless you explicitly specify it in the flags (i.e. using
364	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	456	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
365	system like NetBSD.	457	system like NetBSD.
366		458
367	You still can embed kqueue into a normal poll or select backend and use it	459	You still can embed kqueue into a normal poll or select backend and use it
368	only for sockets (after having made sure that sockets work with kqueue on	460	only for sockets (after having made sure that sockets work with kqueue on
369	the target platform). See C<ev_embed> watchers for more info.	461	the target platform). See C<ev_embed> watchers for more info.
370		462
371	It scales in the same way as the epoll backend, but the interface to the	463	It scales in the same way as the epoll backend, but the interface to the
372	kernel is more efficient (which says nothing about its actual speed, of	464	kernel is more efficient (which says nothing about its actual speed, of
373	course). While stopping, setting and starting an I/O watcher does never	465	course). While stopping, setting and starting an I/O watcher does never
374	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to	466	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
375	two event changes per incident, support for C<fork ()> is very bad and it	467	two event changes per incident. Support for C<fork ()> is very bad (but
376	drops fds silently in similarly hard-to-detect cases.	468	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		469	cases
377		470
378	This backend usually performs well under most conditions.	471	This backend usually performs well under most conditions.
379		472
380	While nominally embeddable in other event loops, this doesn't work	473	While nominally embeddable in other event loops, this doesn't work
381	everywhere, so you might need to test for this. And since it is broken	474	everywhere, so you might need to test for this. And since it is broken
382	almost everywhere, you should only use it when you have a lot of sockets	475	almost everywhere, you should only use it when you have a lot of sockets
383	(for which it usually works), by embedding it into another event loop	476	(for which it usually works), by embedding it into another event loop
384	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for	477	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
385	sockets.	478	also broken on OS X)) and, did I mention it, using it only for sockets.
		479
		480	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
		481	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
		482	C<NOTE_EOF>.
386		483
387	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	484	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
388		485
389	This is not implemented yet (and might never be, unless you send me an	486	This is not implemented yet (and might never be, unless you send me an
390	implementation). According to reports, C</dev/poll> only supports sockets	487	implementation). According to reports, C</dev/poll> only supports sockets
…		…
394	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	491	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
395		492
396	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	493	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
397	it's really slow, but it still scales very well (O(active_fds)).	494	it's really slow, but it still scales very well (O(active_fds)).
398		495
399	Please note that solaris event ports can deliver a lot of spurious	496	Please note that Solaris event ports can deliver a lot of spurious
400	notifications, so you need to use non-blocking I/O or other means to avoid	497	notifications, so you need to use non-blocking I/O or other means to avoid
401	blocking when no data (or space) is available.	498	blocking when no data (or space) is available.
402		499
403	While this backend scales well, it requires one system call per active	500	While this backend scales well, it requires one system call per active
404	file descriptor per loop iteration. For small and medium numbers of file	501	file descriptor per loop iteration. For small and medium numbers of file
405	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	502	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
406	might perform better.	503	might perform better.
407		504
		505	On the positive side, with the exception of the spurious readiness
		506	notifications, this backend actually performed fully to specification
		507	in all tests and is fully embeddable, which is a rare feat among the
		508	OS-specific backends (I vastly prefer correctness over speed hacks).
		509
		510	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		511	C<EVBACKEND_POLL>.
		512
408	=item C<EVBACKEND_ALL>	513	=item C<EVBACKEND_ALL>
409		514
410	Try all backends (even potentially broken ones that wouldn't be tried	515	Try all backends (even potentially broken ones that wouldn't be tried
411	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	516	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
412	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	517	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
413		518
414	It is definitely not recommended to use this flag.	519	It is definitely not recommended to use this flag.
415		520
416	=back	521	=back
417		522
418	If one or more of these are ored into the flags value, then only these	523	If one or more of these are or'ed into the flags value, then only these
419	backends will be tried (in the reverse order as given here). If none are	524	backends will be tried (in the reverse order as listed here). If none are
420	specified, most compiled-in backend will be tried, usually in reverse	525	specified, all backends in C<ev_recommended_backends ()> will be tried.
421	order of their flag values :)
422		526
423	The most typical usage is like this:	527	Example: This is the most typical usage.
424		528
425	if (!ev_default_loop (0))	529	if (!ev_default_loop (0))
426	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	530	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
427		531
428	Restrict libev to the select and poll backends, and do not allow	532	Example: Restrict libev to the select and poll backends, and do not allow
429	environment settings to be taken into account:	533	environment settings to be taken into account:
430		534
431	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	535	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
432		536
433	Use whatever libev has to offer, but make sure that kqueue is used if	537	Example: Use whatever libev has to offer, but make sure that kqueue is
434	available (warning, breaks stuff, best use only with your own private	538	used if available (warning, breaks stuff, best use only with your own
435	event loop and only if you know the OS supports your types of fds):	539	private event loop and only if you know the OS supports your types of
		540	fds):
436		541
437	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	542	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
438		543
439	=item struct ev_loop *ev_loop_new (unsigned int flags)	544	=item struct ev_loop *ev_loop_new (unsigned int flags)
440		545
441	Similar to C<ev_default_loop>, but always creates a new event loop that is	546	Similar to C<ev_default_loop>, but always creates a new event loop that is
442	always distinct from the default loop. Unlike the default loop, it cannot	547	always distinct from the default loop. Unlike the default loop, it cannot
443	handle signal and child watchers, and attempts to do so will be greeted by	548	handle signal and child watchers, and attempts to do so will be greeted by
444	undefined behaviour (or a failed assertion if assertions are enabled).	549	undefined behaviour (or a failed assertion if assertions are enabled).
445		550
		551	Note that this function I<is> thread-safe, and the recommended way to use
		552	libev with threads is indeed to create one loop per thread, and using the
		553	default loop in the "main" or "initial" thread.
		554
446	Example: Try to create a event loop that uses epoll and nothing else.	555	Example: Try to create a event loop that uses epoll and nothing else.
447		556
448	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	557	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
449	if (!epoller)	558	if (!epoller)
450	fatal ("no epoll found here, maybe it hides under your chair");	559	fatal ("no epoll found here, maybe it hides under your chair");
451		560
452	=item ev_default_destroy ()	561	=item ev_default_destroy ()
453		562
454	Destroys the default loop again (frees all memory and kernel state	563	Destroys the default loop again (frees all memory and kernel state
455	etc.). None of the active event watchers will be stopped in the normal	564	etc.). None of the active event watchers will be stopped in the normal
456	sense, so e.g. C<ev_is_active> might still return true. It is your	565	sense, so e.g. C<ev_is_active> might still return true. It is your
457	responsibility to either stop all watchers cleanly yoursef I<before>	566	responsibility to either stop all watchers cleanly yourself I<before>
458	calling this function, or cope with the fact afterwards (which is usually	567	calling this function, or cope with the fact afterwards (which is usually
459	the easiest thing, you can just ignore the watchers and/or C<free ()> them	568	the easiest thing, you can just ignore the watchers and/or C<free ()> them
460	for example).	569	for example).
461		570
462	Note that certain global state, such as signal state, will not be freed by	571	Note that certain global state, such as signal state (and installed signal
463	this function, and related watchers (such as signal and child watchers)	572	handlers), will not be freed by this function, and related watchers (such
464	would need to be stopped manually.	573	as signal and child watchers) would need to be stopped manually.
465		574
466	In general it is not advisable to call this function except in the	575	In general it is not advisable to call this function except in the
467	rare occasion where you really need to free e.g. the signal handling	576	rare occasion where you really need to free e.g. the signal handling
468	pipe fds. If you need dynamically allocated loops it is better to use	577	pipe fds. If you need dynamically allocated loops it is better to use
469	C<ev_loop_new> and C<ev_loop_destroy>).	578	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
473	Like C<ev_default_destroy>, but destroys an event loop created by an	582	Like C<ev_default_destroy>, but destroys an event loop created by an
474	earlier call to C<ev_loop_new>.	583	earlier call to C<ev_loop_new>.
475		584
476	=item ev_default_fork ()	585	=item ev_default_fork ()
477		586
		587	This function sets a flag that causes subsequent C<ev_loop> iterations
478	This function reinitialises the kernel state for backends that have	588	to reinitialise the kernel state for backends that have one. Despite the
479	one. Despite the name, you can call it anytime, but it makes most sense	589	name, you can call it anytime, but it makes most sense after forking, in
480	after forking, in either the parent or child process (or both, but that	590	the child process (or both child and parent, but that again makes little
481	again makes little sense).	591	sense). You I<must> call it in the child before using any of the libev
		592	functions, and it will only take effect at the next C<ev_loop> iteration.
482		593
483	You I<must> call this function in the child process after forking if and	594	On the other hand, you only need to call this function in the child
484	only if you want to use the event library in both processes. If you just	595	process if and only if you want to use the event library in the child. If
485	fork+exec, you don't have to call it.	596	you just fork+exec, you don't have to call it at all.
486		597
487	The function itself is quite fast and it's usually not a problem to call	598	The function itself is quite fast and it's usually not a problem to call
488	it just in case after a fork. To make this easy, the function will fit in	599	it just in case after a fork. To make this easy, the function will fit in
489	quite nicely into a call to C<pthread_atfork>:	600	quite nicely into a call to C<pthread_atfork>:
490		601
491	pthread_atfork (0, 0, ev_default_fork);	602	pthread_atfork (0, 0, ev_default_fork);
492		603
493	At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
494	without calling this function, so if you force one of those backends you
495	do not need to care.
496
497	=item ev_loop_fork (loop)	604	=item ev_loop_fork (loop)
498		605
499	Like C<ev_default_fork>, but acts on an event loop created by	606	Like C<ev_default_fork>, but acts on an event loop created by
500	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	607	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
501	after fork, and how you do this is entirely your own problem.	608	after fork that you want to re-use in the child, and how you do this is
		609	entirely your own problem.
		610
		611	=item int ev_is_default_loop (loop)
		612
		613	Returns true when the given loop is, in fact, the default loop, and false
		614	otherwise.
502		615
503	=item unsigned int ev_loop_count (loop)	616	=item unsigned int ev_loop_count (loop)
504		617
505	Returns the count of loop iterations for the loop, which is identical to	618	Returns the count of loop iterations for the loop, which is identical to
506	the number of times libev did poll for new events. It starts at C<0> and	619	the number of times libev did poll for new events. It starts at C<0> and
507	happily wraps around with enough iterations.	620	happily wraps around with enough iterations.
508		621
509	This value can sometimes be useful as a generation counter of sorts (it	622	This value can sometimes be useful as a generation counter of sorts (it
510	"ticks" the number of loop iterations), as it roughly corresponds with	623	"ticks" the number of loop iterations), as it roughly corresponds with
511	C<ev_prepare> and C<ev_check> calls.	624	C<ev_prepare> and C<ev_check> calls.
		625
		626	=item unsigned int ev_loop_depth (loop)
		627
		628	Returns the number of times C<ev_loop> was entered minus the number of
		629	times C<ev_loop> was exited, in other words, the recursion depth.
		630
		631	Outside C<ev_loop>, this number is zero. In a callback, this number is
		632	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
		633	in which case it is higher.
		634
		635	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
		636	etc.), doesn't count as exit.
512		637
513	=item unsigned int ev_backend (loop)	638	=item unsigned int ev_backend (loop)
514		639
515	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	640	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
516	use.	641	use.
…		…
521	received events and started processing them. This timestamp does not	646	received events and started processing them. This timestamp does not
522	change as long as callbacks are being processed, and this is also the base	647	change as long as callbacks are being processed, and this is also the base
523	time used for relative timers. You can treat it as the timestamp of the	648	time used for relative timers. You can treat it as the timestamp of the
524	event occurring (or more correctly, libev finding out about it).	649	event occurring (or more correctly, libev finding out about it).
525		650
		651	=item ev_now_update (loop)
		652
		653	Establishes the current time by querying the kernel, updating the time
		654	returned by C<ev_now ()> in the progress. This is a costly operation and
		655	is usually done automatically within C<ev_loop ()>.
		656
		657	This function is rarely useful, but when some event callback runs for a
		658	very long time without entering the event loop, updating libev's idea of
		659	the current time is a good idea.
		660
		661	See also L<The special problem of time updates> in the C<ev_timer> section.
		662
		663	=item ev_suspend (loop)
		664
		665	=item ev_resume (loop)
		666
		667	These two functions suspend and resume a loop, for use when the loop is
		668	not used for a while and timeouts should not be processed.
		669
		670	A typical use case would be an interactive program such as a game: When
		671	the user presses C<^Z> to suspend the game and resumes it an hour later it
		672	would be best to handle timeouts as if no time had actually passed while
		673	the program was suspended. This can be achieved by calling C<ev_suspend>
		674	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		675	C<ev_resume> directly afterwards to resume timer processing.
		676
		677	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		678	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		679	will be rescheduled (that is, they will lose any events that would have
		680	occured while suspended).
		681
		682	After calling C<ev_suspend> you B<must not> call I<any> function on the
		683	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		684	without a previous call to C<ev_suspend>.
		685
		686	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		687	event loop time (see C<ev_now_update>).
		688
526	=item ev_loop (loop, int flags)	689	=item ev_loop (loop, int flags)
527		690
528	Finally, this is it, the event handler. This function usually is called	691	Finally, this is it, the event handler. This function usually is called
529	after you initialised all your watchers and you want to start handling	692	after you initialised all your watchers and you want to start handling
530	events.	693	events.
…		…
532	If the flags argument is specified as C<0>, it will not return until	695	If the flags argument is specified as C<0>, it will not return until
533	either no event watchers are active anymore or C<ev_unloop> was called.	696	either no event watchers are active anymore or C<ev_unloop> was called.
534		697
535	Please note that an explicit C<ev_unloop> is usually better than	698	Please note that an explicit C<ev_unloop> is usually better than
536	relying on all watchers to be stopped when deciding when a program has	699	relying on all watchers to be stopped when deciding when a program has
537	finished (especially in interactive programs), but having a program that	700	finished (especially in interactive programs), but having a program
538	automatically loops as long as it has to and no longer by virtue of	701	that automatically loops as long as it has to and no longer by virtue
539	relying on its watchers stopping correctly is a thing of beauty.	702	of relying on its watchers stopping correctly, that is truly a thing of
		703	beauty.
540		704
541	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	705	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
542	those events and any outstanding ones, but will not block your process in	706	those events and any already outstanding ones, but will not block your
543	case there are no events and will return after one iteration of the loop.	707	process in case there are no events and will return after one iteration of
		708	the loop.
544		709
545	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	710	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
546	neccessary) and will handle those and any outstanding ones. It will block	711	necessary) and will handle those and any already outstanding ones. It
547	your process until at least one new event arrives, and will return after	712	will block your process until at least one new event arrives (which could
548	one iteration of the loop. This is useful if you are waiting for some	713	be an event internal to libev itself, so there is no guarantee that a
549	external event in conjunction with something not expressible using other	714	user-registered callback will be called), and will return after one
		715	iteration of the loop.
		716
		717	This is useful if you are waiting for some external event in conjunction
		718	with something not expressible using other libev watchers (i.e. "roll your
550	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	719	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
551	usually a better approach for this kind of thing.	720	usually a better approach for this kind of thing.
552		721
553	Here are the gory details of what C<ev_loop> does:	722	Here are the gory details of what C<ev_loop> does:
554		723
555	- Before the first iteration, call any pending watchers.	724	- Before the first iteration, call any pending watchers.
556	* If there are no active watchers (reference count is zero), return.	725	* If EVFLAG_FORKCHECK was used, check for a fork.
557	- Queue all prepare watchers and then call all outstanding watchers.	726	- If a fork was detected (by any means), queue and call all fork watchers.
		727	- Queue and call all prepare watchers.
558	- If we have been forked, recreate the kernel state.	728	- If we have been forked, detach and recreate the kernel state
		729	as to not disturb the other process.
559	- Update the kernel state with all outstanding changes.	730	- Update the kernel state with all outstanding changes.
560	- Update the "event loop time".	731	- Update the "event loop time" (ev_now ()).
561	- Calculate for how long to block.	732	- Calculate for how long to sleep or block, if at all
		733	(active idle watchers, EVLOOP_NONBLOCK or not having
		734	any active watchers at all will result in not sleeping).
		735	- Sleep if the I/O and timer collect interval say so.
562	- Block the process, waiting for any events.	736	- Block the process, waiting for any events.
563	- Queue all outstanding I/O (fd) events.	737	- Queue all outstanding I/O (fd) events.
564	- Update the "event loop time" and do time jump handling.	738	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
565	- Queue all outstanding timers.	739	- Queue all expired timers.
566	- Queue all outstanding periodics.	740	- Queue all expired periodics.
567	- If no events are pending now, queue all idle watchers.	741	- Unless any events are pending now, queue all idle watchers.
568	- Queue all check watchers.	742	- Queue all check watchers.
569	- Call all queued watchers in reverse order (i.e. check watchers first).	743	- Call all queued watchers in reverse order (i.e. check watchers first).
570	Signals and child watchers are implemented as I/O watchers, and will	744	Signals and child watchers are implemented as I/O watchers, and will
571	be handled here by queueing them when their watcher gets executed.	745	be handled here by queueing them when their watcher gets executed.
572	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	746	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
573	were used, return, otherwise continue with step *.	747	were used, or there are no active watchers, return, otherwise
		748	continue with step *.
574		749
575	Example: Queue some jobs and then loop until no events are outsanding	750	Example: Queue some jobs and then loop until no events are outstanding
576	anymore.	751	anymore.
577		752
578	... queue jobs here, make sure they register event watchers as long	753	... queue jobs here, make sure they register event watchers as long
579	... as they still have work to do (even an idle watcher will do..)	754	... as they still have work to do (even an idle watcher will do..)
580	ev_loop (my_loop, 0);	755	ev_loop (my_loop, 0);
581	... jobs done. yeah!	756	... jobs done or somebody called unloop. yeah!
582		757
583	=item ev_unloop (loop, how)	758	=item ev_unloop (loop, how)
584		759
585	Can be used to make a call to C<ev_loop> return early (but only after it	760	Can be used to make a call to C<ev_loop> return early (but only after it
586	has processed all outstanding events). The C<how> argument must be either	761	has processed all outstanding events). The C<how> argument must be either
587	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	762	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
588	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	763	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
589		764
		765	This "unloop state" will be cleared when entering C<ev_loop> again.
		766
		767	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		768
590	=item ev_ref (loop)	769	=item ev_ref (loop)
591		770
592	=item ev_unref (loop)	771	=item ev_unref (loop)
593		772
594	Ref/unref can be used to add or remove a reference count on the event	773	Ref/unref can be used to add or remove a reference count on the event
595	loop: Every watcher keeps one reference, and as long as the reference	774	loop: Every watcher keeps one reference, and as long as the reference
596	count is nonzero, C<ev_loop> will not return on its own. If you have	775	count is nonzero, C<ev_loop> will not return on its own.
		776
597	a watcher you never unregister that should not keep C<ev_loop> from	777	If you have a watcher you never unregister that should not keep C<ev_loop>
598	returning, ev_unref() after starting, and ev_ref() before stopping it. For	778	from returning, call ev_unref() after starting, and ev_ref() before
		779	stopping it.
		780
599	example, libev itself uses this for its internal signal pipe: It is not	781	As an example, libev itself uses this for its internal signal pipe: It
600	visible to the libev user and should not keep C<ev_loop> from exiting if	782	is not visible to the libev user and should not keep C<ev_loop> from
601	no event watchers registered by it are active. It is also an excellent	783	exiting if no event watchers registered by it are active. It is also an
602	way to do this for generic recurring timers or from within third-party	784	excellent way to do this for generic recurring timers or from within
603	libraries. Just remember to I<unref after start> and I<ref before stop>.	785	third-party libraries. Just remember to I<unref after start> and I<ref
		786	before stop> (but only if the watcher wasn't active before, or was active
		787	before, respectively. Note also that libev might stop watchers itself
		788	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		789	in the callback).
604		790
605	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	791	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
606	running when nothing else is active.	792	running when nothing else is active.
607		793
608	struct ev_signal exitsig;	794	ev_signal exitsig;
609	ev_signal_init (&exitsig, sig_cb, SIGINT);	795	ev_signal_init (&exitsig, sig_cb, SIGINT);
610	ev_signal_start (loop, &exitsig);	796	ev_signal_start (loop, &exitsig);
611	evf_unref (loop);	797	evf_unref (loop);
612		798
613	Example: For some weird reason, unregister the above signal handler again.	799	Example: For some weird reason, unregister the above signal handler again.
614		800
615	ev_ref (loop);	801	ev_ref (loop);
616	ev_signal_stop (loop, &exitsig);	802	ev_signal_stop (loop, &exitsig);
617		803
618	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	804	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
619		805
620	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	806	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
621		807
622	These advanced functions influence the time that libev will spend waiting	808	These advanced functions influence the time that libev will spend waiting
623	for events. Both are by default C<0>, meaning that libev will try to	809	for events. Both time intervals are by default C<0>, meaning that libev
624	invoke timer/periodic callbacks and I/O callbacks with minimum latency.	810	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		811	latency.
625		812
626	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	813	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
627	allows libev to delay invocation of I/O and timer/periodic callbacks to	814	allows libev to delay invocation of I/O and timer/periodic callbacks
628	increase efficiency of loop iterations.	815	to increase efficiency of loop iterations (or to increase power-saving
		816	opportunities).
629		817
630	The background is that sometimes your program runs just fast enough to	818	The idea is that sometimes your program runs just fast enough to handle
631	handle one (or very few) event(s) per loop iteration. While this makes	819	one (or very few) event(s) per loop iteration. While this makes the
632	the program responsive, it also wastes a lot of CPU time to poll for new	820	program responsive, it also wastes a lot of CPU time to poll for new
633	events, especially with backends like C<select ()> which have a high	821	events, especially with backends like C<select ()> which have a high
634	overhead for the actual polling but can deliver many events at once.	822	overhead for the actual polling but can deliver many events at once.
635		823
636	By setting a higher I<io collect interval> you allow libev to spend more	824	By setting a higher I<io collect interval> you allow libev to spend more
637	time collecting I/O events, so you can handle more events per iteration,	825	time collecting I/O events, so you can handle more events per iteration,
638	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	826	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
639	C<ev_timer>) will be not affected. Setting this to a non-null value will	827	C<ev_timer>) will be not affected. Setting this to a non-null value will
640	introduce an additional C<ev_sleep ()> call into most loop iterations.	828	introduce an additional C<ev_sleep ()> call into most loop iterations. The
		829	sleep time ensures that libev will not poll for I/O events more often then
		830	once per this interval, on average.
641		831
642	Likewise, by setting a higher I<timeout collect interval> you allow libev	832	Likewise, by setting a higher I<timeout collect interval> you allow libev
643	to spend more time collecting timeouts, at the expense of increased	833	to spend more time collecting timeouts, at the expense of increased
644	latency (the watcher callback will be called later). C<ev_io> watchers	834	latency/jitter/inexactness (the watcher callback will be called
645	will not be affected. Setting this to a non-null value will not introduce	835	later). C<ev_io> watchers will not be affected. Setting this to a non-null
646	any overhead in libev.	836	value will not introduce any overhead in libev.
647		837
648	Many (busy) programs can usually benefit by setting the io collect	838	Many (busy) programs can usually benefit by setting the I/O collect
649	interval to a value near C<0.1> or so, which is often enough for	839	interval to a value near C<0.1> or so, which is often enough for
650	interactive servers (of course not for games), likewise for timeouts. It	840	interactive servers (of course not for games), likewise for timeouts. It
651	usually doesn't make much sense to set it to a lower value than C<0.01>,	841	usually doesn't make much sense to set it to a lower value than C<0.01>,
652	as this approsaches the timing granularity of most systems.	842	as this approaches the timing granularity of most systems. Note that if
		843	you do transactions with the outside world and you can't increase the
		844	parallelity, then this setting will limit your transaction rate (if you
		845	need to poll once per transaction and the I/O collect interval is 0.01,
		846	then you can't do more than 100 transations per second).
		847
		848	Setting the I<timeout collect interval> can improve the opportunity for
		849	saving power, as the program will "bundle" timer callback invocations that
		850	are "near" in time together, by delaying some, thus reducing the number of
		851	times the process sleeps and wakes up again. Another useful technique to
		852	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
		853	they fire on, say, one-second boundaries only.
		854
		855	Example: we only need 0.1s timeout granularity, and we wish not to poll
		856	more often than 100 times per second:
		857
		858	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
		859	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
		860
		861	=item ev_invoke_pending (loop)
		862
		863	This call will simply invoke all pending watchers while resetting their
		864	pending state. Normally, C<ev_loop> does this automatically when required,
		865	but when overriding the invoke callback this call comes handy.
		866
		867	=item int ev_pending_count (loop)
		868
		869	Returns the number of pending watchers - zero indicates that no watchers
		870	are pending.
		871
		872	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
		873
		874	This overrides the invoke pending functionality of the loop: Instead of
		875	invoking all pending watchers when there are any, C<ev_loop> will call
		876	this callback instead. This is useful, for example, when you want to
		877	invoke the actual watchers inside another context (another thread etc.).
		878
		879	If you want to reset the callback, use C<ev_invoke_pending> as new
		880	callback.
		881
		882	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
		883
		884	Sometimes you want to share the same loop between multiple threads. This
		885	can be done relatively simply by putting mutex_lock/unlock calls around
		886	each call to a libev function.
		887
		888	However, C<ev_loop> can run an indefinite time, so it is not feasible to
		889	wait for it to return. One way around this is to wake up the loop via
		890	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
		891	and I<acquire> callbacks on the loop.
		892
		893	When set, then C<release> will be called just before the thread is
		894	suspended waiting for new events, and C<acquire> is called just
		895	afterwards.
		896
		897	Ideally, C<release> will just call your mutex_unlock function, and
		898	C<acquire> will just call the mutex_lock function again.
		899
		900	While event loop modifications are allowed between invocations of
		901	C<release> and C<acquire> (that's their only purpose after all), no
		902	modifications done will affect the event loop, i.e. adding watchers will
		903	have no effect on the set of file descriptors being watched, or the time
		904	waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it
		905	to take note of any changes you made.
		906
		907	In theory, threads executing C<ev_loop> will be async-cancel safe between
		908	invocations of C<release> and C<acquire>.
		909
		910	See also the locking example in the C<THREADS> section later in this
		911	document.
		912
		913	=item ev_set_userdata (loop, void *data)
		914
		915	=item ev_userdata (loop)
		916
		917	Set and retrieve a single C<void *> associated with a loop. When
		918	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
		919	C<0.>
		920
		921	These two functions can be used to associate arbitrary data with a loop,
		922	and are intended solely for the C<invoke_pending_cb>, C<release> and
		923	C<acquire> callbacks described above, but of course can be (ab-)used for
		924	any other purpose as well.
		925
		926	=item ev_loop_verify (loop)
		927
		928	This function only does something when C<EV_VERIFY> support has been
		929	compiled in, which is the default for non-minimal builds. It tries to go
		930	through all internal structures and checks them for validity. If anything
		931	is found to be inconsistent, it will print an error message to standard
		932	error and call C<abort ()>.
		933
		934	This can be used to catch bugs inside libev itself: under normal
		935	circumstances, this function will never abort as of course libev keeps its
		936	data structures consistent.
653		937
654	=back	938	=back
655		939
656		940
657	=head1 ANATOMY OF A WATCHER	941	=head1 ANATOMY OF A WATCHER
		942
		943	In the following description, uppercase C<TYPE> in names stands for the
		944	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		945	watchers and C<ev_io_start> for I/O watchers.
658		946
659	A watcher is a structure that you create and register to record your	947	A watcher is a structure that you create and register to record your
660	interest in some event. For instance, if you want to wait for STDIN to	948	interest in some event. For instance, if you want to wait for STDIN to
661	become readable, you would create an C<ev_io> watcher for that:	949	become readable, you would create an C<ev_io> watcher for that:
662		950
663	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	951	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
664	{	952	{
665	ev_io_stop (w);	953	ev_io_stop (w);
666	ev_unloop (loop, EVUNLOOP_ALL);	954	ev_unloop (loop, EVUNLOOP_ALL);
667	}	955	}
668		956
669	struct ev_loop *loop = ev_default_loop (0);	957	struct ev_loop *loop = ev_default_loop (0);
		958
670	struct ev_io stdin_watcher;	959	ev_io stdin_watcher;
		960
671	ev_init (&stdin_watcher, my_cb);	961	ev_init (&stdin_watcher, my_cb);
672	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	962	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
673	ev_io_start (loop, &stdin_watcher);	963	ev_io_start (loop, &stdin_watcher);
		964
674	ev_loop (loop, 0);	965	ev_loop (loop, 0);
675		966
676	As you can see, you are responsible for allocating the memory for your	967	As you can see, you are responsible for allocating the memory for your
677	watcher structures (and it is usually a bad idea to do this on the stack,	968	watcher structures (and it is I<usually> a bad idea to do this on the
678	although this can sometimes be quite valid).	969	stack).
		970
		971	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		972	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
679		973
680	Each watcher structure must be initialised by a call to C<ev_init	974	Each watcher structure must be initialised by a call to C<ev_init
681	(watcher *, callback)>, which expects a callback to be provided. This	975	(watcher *, callback)>, which expects a callback to be provided. This
682	callback gets invoked each time the event occurs (or, in the case of io	976	callback gets invoked each time the event occurs (or, in the case of I/O
683	watchers, each time the event loop detects that the file descriptor given	977	watchers, each time the event loop detects that the file descriptor given
684	is readable and/or writable).	978	is readable and/or writable).
685		979
686	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	980	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
687	with arguments specific to this watcher type. There is also a macro	981	macro to configure it, with arguments specific to the watcher type. There
688	to combine initialisation and setting in one call: C<< ev_<type>_init	982	is also a macro to combine initialisation and setting in one call: C<<
689	(watcher *, callback, ...) >>.	983	ev_TYPE_init (watcher *, callback, ...) >>.
690		984
691	To make the watcher actually watch out for events, you have to start it	985	To make the watcher actually watch out for events, you have to start it
692	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	986	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
693	*) >>), and you can stop watching for events at any time by calling the	987	*) >>), and you can stop watching for events at any time by calling the
694	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	988	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
695		989
696	As long as your watcher is active (has been started but not stopped) you	990	As long as your watcher is active (has been started but not stopped) you
697	must not touch the values stored in it. Most specifically you must never	991	must not touch the values stored in it. Most specifically you must never
698	reinitialise it or call its C<set> macro.	992	reinitialise it or call its C<ev_TYPE_set> macro.
699		993
700	Each and every callback receives the event loop pointer as first, the	994	Each and every callback receives the event loop pointer as first, the
701	registered watcher structure as second, and a bitset of received events as	995	registered watcher structure as second, and a bitset of received events as
702	third argument.	996	third argument.
703		997
…		…
757	=item C<EV_FORK>	1051	=item C<EV_FORK>
758		1052
759	The event loop has been resumed in the child process after fork (see	1053	The event loop has been resumed in the child process after fork (see
760	C<ev_fork>).	1054	C<ev_fork>).
761		1055
		1056	=item C<EV_ASYNC>
		1057
		1058	The given async watcher has been asynchronously notified (see C<ev_async>).
		1059
		1060	=item C<EV_CUSTOM>
		1061
		1062	Not ever sent (or otherwise used) by libev itself, but can be freely used
		1063	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		1064
762	=item C<EV_ERROR>	1065	=item C<EV_ERROR>
763		1066
764	An unspecified error has occured, the watcher has been stopped. This might	1067	An unspecified error has occurred, the watcher has been stopped. This might
765	happen because the watcher could not be properly started because libev	1068	happen because the watcher could not be properly started because libev
766	ran out of memory, a file descriptor was found to be closed or any other	1069	ran out of memory, a file descriptor was found to be closed or any other
		1070	problem. Libev considers these application bugs.
		1071
767	problem. You best act on it by reporting the problem and somehow coping	1072	You best act on it by reporting the problem and somehow coping with the
768	with the watcher being stopped.	1073	watcher being stopped. Note that well-written programs should not receive
		1074	an error ever, so when your watcher receives it, this usually indicates a
		1075	bug in your program.
769		1076
770	Libev will usually signal a few "dummy" events together with an error,	1077	Libev will usually signal a few "dummy" events together with an error, for
771	for example it might indicate that a fd is readable or writable, and if	1078	example it might indicate that a fd is readable or writable, and if your
772	your callbacks is well-written it can just attempt the operation and cope	1079	callbacks is well-written it can just attempt the operation and cope with
773	with the error from read() or write(). This will not work in multithreaded	1080	the error from read() or write(). This will not work in multi-threaded
774	programs, though, so beware.	1081	programs, though, as the fd could already be closed and reused for another
		1082	thing, so beware.
775		1083
776	=back	1084	=back
777		1085
778	=head2 GENERIC WATCHER FUNCTIONS	1086	=head2 GENERIC WATCHER FUNCTIONS
779
780	In the following description, C<TYPE> stands for the watcher type,
781	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
782		1087
783	=over 4	1088	=over 4
784		1089
785	=item C<ev_init> (ev_TYPE *watcher, callback)	1090	=item C<ev_init> (ev_TYPE *watcher, callback)
786		1091
…		…
792	which rolls both calls into one.	1097	which rolls both calls into one.
793		1098
794	You can reinitialise a watcher at any time as long as it has been stopped	1099	You can reinitialise a watcher at any time as long as it has been stopped
795	(or never started) and there are no pending events outstanding.	1100	(or never started) and there are no pending events outstanding.
796		1101
797	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	1102	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
798	int revents)>.	1103	int revents)>.
		1104
		1105	Example: Initialise an C<ev_io> watcher in two steps.
		1106
		1107	ev_io w;
		1108	ev_init (&w, my_cb);
		1109	ev_io_set (&w, STDIN_FILENO, EV_READ);
799		1110
800	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1111	=item C<ev_TYPE_set> (ev_TYPE *, [args])
801		1112
802	This macro initialises the type-specific parts of a watcher. You need to	1113	This macro initialises the type-specific parts of a watcher. You need to
803	call C<ev_init> at least once before you call this macro, but you can	1114	call C<ev_init> at least once before you call this macro, but you can
…		…
806	difference to the C<ev_init> macro).	1117	difference to the C<ev_init> macro).
807		1118
808	Although some watcher types do not have type-specific arguments	1119	Although some watcher types do not have type-specific arguments
809	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	1120	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
810		1121
		1122	See C<ev_init>, above, for an example.
		1123
811	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	1124	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
812		1125
813	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	1126	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
814	calls into a single call. This is the most convinient method to initialise	1127	calls into a single call. This is the most convenient method to initialise
815	a watcher. The same limitations apply, of course.	1128	a watcher. The same limitations apply, of course.
		1129
		1130	Example: Initialise and set an C<ev_io> watcher in one step.
		1131
		1132	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
816		1133
817	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1134	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
818		1135
819	Starts (activates) the given watcher. Only active watchers will receive	1136	Starts (activates) the given watcher. Only active watchers will receive
820	events. If the watcher is already active nothing will happen.	1137	events. If the watcher is already active nothing will happen.
821		1138
		1139	Example: Start the C<ev_io> watcher that is being abused as example in this
		1140	whole section.
		1141
		1142	ev_io_start (EV_DEFAULT_UC, &w);
		1143
822	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1144	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
823		1145
824	Stops the given watcher again (if active) and clears the pending	1146	Stops the given watcher if active, and clears the pending status (whether
		1147	the watcher was active or not).
		1148
825	status. It is possible that stopped watchers are pending (for example,	1149	It is possible that stopped watchers are pending - for example,
826	non-repeating timers are being stopped when they become pending), but	1150	non-repeating timers are being stopped when they become pending - but
827	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	1151	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
828	you want to free or reuse the memory used by the watcher it is therefore a	1152	pending. If you want to free or reuse the memory used by the watcher it is
829	good idea to always call its C<ev_TYPE_stop> function.	1153	therefore a good idea to always call its C<ev_TYPE_stop> function.
830		1154
831	=item bool ev_is_active (ev_TYPE *watcher)	1155	=item bool ev_is_active (ev_TYPE *watcher)
832		1156
833	Returns a true value iff the watcher is active (i.e. it has been started	1157	Returns a true value iff the watcher is active (i.e. it has been started
834	and not yet been stopped). As long as a watcher is active you must not modify	1158	and not yet been stopped). As long as a watcher is active you must not modify
…		…
860	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1184	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
861	(default: C<-2>). Pending watchers with higher priority will be invoked	1185	(default: C<-2>). Pending watchers with higher priority will be invoked
862	before watchers with lower priority, but priority will not keep watchers	1186	before watchers with lower priority, but priority will not keep watchers
863	from being executed (except for C<ev_idle> watchers).	1187	from being executed (except for C<ev_idle> watchers).
864		1188
865	This means that priorities are I<only> used for ordering callback
866	invocation after new events have been received. This is useful, for
867	example, to reduce latency after idling, or more often, to bind two
868	watchers on the same event and make sure one is called first.
869
870	If you need to suppress invocation when higher priority events are pending	1189	If you need to suppress invocation when higher priority events are pending
871	you need to look at C<ev_idle> watchers, which provide this functionality.	1190	you need to look at C<ev_idle> watchers, which provide this functionality.
872		1191
873	You I<must not> change the priority of a watcher as long as it is active or	1192	You I<must not> change the priority of a watcher as long as it is active or
874	pending.	1193	pending.
875		1194
		1195	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1196	fine, as long as you do not mind that the priority value you query might
		1197	or might not have been clamped to the valid range.
		1198
876	The default priority used by watchers when no priority has been set is	1199	The default priority used by watchers when no priority has been set is
877	always C<0>, which is supposed to not be too high and not be too low :).	1200	always C<0>, which is supposed to not be too high and not be too low :).
878		1201
879	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1202	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
880	fine, as long as you do not mind that the priority value you query might	1203	priorities.
881	or might not have been adjusted to be within valid range.
882		1204
883	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1205	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
884		1206
885	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1207	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
886	C<loop> nor C<revents> need to be valid as long as the watcher callback	1208	C<loop> nor C<revents> need to be valid as long as the watcher callback
887	can deal with that fact.	1209	can deal with that fact, as both are simply passed through to the
		1210	callback.
888		1211
889	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1212	=item int ev_clear_pending (loop, ev_TYPE *watcher)
890		1213
891	If the watcher is pending, this function returns clears its pending status	1214	If the watcher is pending, this function clears its pending status and
892	and returns its C<revents> bitset (as if its callback was invoked). If the	1215	returns its C<revents> bitset (as if its callback was invoked). If the
893	watcher isn't pending it does nothing and returns C<0>.	1216	watcher isn't pending it does nothing and returns C<0>.
894		1217
		1218	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1219	callback to be invoked, which can be accomplished with this function.
		1220
895	=back	1221	=back
896		1222
897		1223
898	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1224	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
899		1225
900	Each watcher has, by default, a member C<void *data> that you can change	1226	Each watcher has, by default, a member C<void *data> that you can change
901	and read at any time, libev will completely ignore it. This can be used	1227	and read at any time: libev will completely ignore it. This can be used
902	to associate arbitrary data with your watcher. If you need more data and	1228	to associate arbitrary data with your watcher. If you need more data and
903	don't want to allocate memory and store a pointer to it in that data	1229	don't want to allocate memory and store a pointer to it in that data
904	member, you can also "subclass" the watcher type and provide your own	1230	member, you can also "subclass" the watcher type and provide your own
905	data:	1231	data:
906		1232
907	struct my_io	1233	struct my_io
908	{	1234	{
909	struct ev_io io;	1235	ev_io io;
910	int otherfd;	1236	int otherfd;
911	void *somedata;	1237	void *somedata;
912	struct whatever *mostinteresting;	1238	struct whatever *mostinteresting;
913	}	1239	};
		1240
		1241	...
		1242	struct my_io w;
		1243	ev_io_init (&w.io, my_cb, fd, EV_READ);
914		1244
915	And since your callback will be called with a pointer to the watcher, you	1245	And since your callback will be called with a pointer to the watcher, you
916	can cast it back to your own type:	1246	can cast it back to your own type:
917		1247
918	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1248	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
919	{	1249	{
920	struct my_io *w = (struct my_io *)w_;	1250	struct my_io *w = (struct my_io *)w_;
921	...	1251	...
922	}	1252	}
923		1253
924	More interesting and less C-conformant ways of casting your callback type	1254	More interesting and less C-conformant ways of casting your callback type
925	instead have been omitted.	1255	instead have been omitted.
926		1256
927	Another common scenario is having some data structure with multiple	1257	Another common scenario is to use some data structure with multiple
928	watchers:	1258	embedded watchers:
929		1259
930	struct my_biggy	1260	struct my_biggy
931	{	1261	{
932	int some_data;	1262	int some_data;
933	ev_timer t1;	1263	ev_timer t1;
934	ev_timer t2;	1264	ev_timer t2;
935	}	1265	}
936		1266
937	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1267	In this case getting the pointer to C<my_biggy> is a bit more
938	you need to use C<offsetof>:	1268	complicated: Either you store the address of your C<my_biggy> struct
		1269	in the C<data> member of the watcher (for woozies), or you need to use
		1270	some pointer arithmetic using C<offsetof> inside your watchers (for real
		1271	programmers):
939		1272
940	#include <stddef.h>	1273	#include <stddef.h>
941		1274
942	static void	1275	static void
943	t1_cb (EV_P_ struct ev_timer *w, int revents)	1276	t1_cb (EV_P_ ev_timer *w, int revents)
944	{	1277	{
945	struct my_biggy big = (struct my_biggy *	1278	struct my_biggy big = (struct my_biggy *)
946	(((char *)w) - offsetof (struct my_biggy, t1));	1279	(((char *)w) - offsetof (struct my_biggy, t1));
947	}	1280	}
948		1281
949	static void	1282	static void
950	t2_cb (EV_P_ struct ev_timer *w, int revents)	1283	t2_cb (EV_P_ ev_timer *w, int revents)
951	{	1284	{
952	struct my_biggy big = (struct my_biggy *	1285	struct my_biggy big = (struct my_biggy *)
953	(((char *)w) - offsetof (struct my_biggy, t2));	1286	(((char *)w) - offsetof (struct my_biggy, t2));
954	}	1287	}
		1288
		1289	=head2 WATCHER PRIORITY MODELS
		1290
		1291	Many event loops support I<watcher priorities>, which are usually small
		1292	integers that influence the ordering of event callback invocation
		1293	between watchers in some way, all else being equal.
		1294
		1295	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1296	description for the more technical details such as the actual priority
		1297	range.
		1298
		1299	There are two common ways how these these priorities are being interpreted
		1300	by event loops:
		1301
		1302	In the more common lock-out model, higher priorities "lock out" invocation
		1303	of lower priority watchers, which means as long as higher priority
		1304	watchers receive events, lower priority watchers are not being invoked.
		1305
		1306	The less common only-for-ordering model uses priorities solely to order
		1307	callback invocation within a single event loop iteration: Higher priority
		1308	watchers are invoked before lower priority ones, but they all get invoked
		1309	before polling for new events.
		1310
		1311	Libev uses the second (only-for-ordering) model for all its watchers
		1312	except for idle watchers (which use the lock-out model).
		1313
		1314	The rationale behind this is that implementing the lock-out model for
		1315	watchers is not well supported by most kernel interfaces, and most event
		1316	libraries will just poll for the same events again and again as long as
		1317	their callbacks have not been executed, which is very inefficient in the
		1318	common case of one high-priority watcher locking out a mass of lower
		1319	priority ones.
		1320
		1321	Static (ordering) priorities are most useful when you have two or more
		1322	watchers handling the same resource: a typical usage example is having an
		1323	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1324	timeouts. Under load, data might be received while the program handles
		1325	other jobs, but since timers normally get invoked first, the timeout
		1326	handler will be executed before checking for data. In that case, giving
		1327	the timer a lower priority than the I/O watcher ensures that I/O will be
		1328	handled first even under adverse conditions (which is usually, but not
		1329	always, what you want).
		1330
		1331	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1332	will only be executed when no same or higher priority watchers have
		1333	received events, they can be used to implement the "lock-out" model when
		1334	required.
		1335
		1336	For example, to emulate how many other event libraries handle priorities,
		1337	you can associate an C<ev_idle> watcher to each such watcher, and in
		1338	the normal watcher callback, you just start the idle watcher. The real
		1339	processing is done in the idle watcher callback. This causes libev to
		1340	continously poll and process kernel event data for the watcher, but when
		1341	the lock-out case is known to be rare (which in turn is rare :), this is
		1342	workable.
		1343
		1344	Usually, however, the lock-out model implemented that way will perform
		1345	miserably under the type of load it was designed to handle. In that case,
		1346	it might be preferable to stop the real watcher before starting the
		1347	idle watcher, so the kernel will not have to process the event in case
		1348	the actual processing will be delayed for considerable time.
		1349
		1350	Here is an example of an I/O watcher that should run at a strictly lower
		1351	priority than the default, and which should only process data when no
		1352	other events are pending:
		1353
		1354	ev_idle idle; // actual processing watcher
		1355	ev_io io; // actual event watcher
		1356
		1357	static void
		1358	io_cb (EV_P_ ev_io *w, int revents)
		1359	{
		1360	// stop the I/O watcher, we received the event, but
		1361	// are not yet ready to handle it.
		1362	ev_io_stop (EV_A_ w);
		1363
		1364	// start the idle watcher to ahndle the actual event.
		1365	// it will not be executed as long as other watchers
		1366	// with the default priority are receiving events.
		1367	ev_idle_start (EV_A_ &idle);
		1368	}
		1369
		1370	static void
		1371	idle_cb (EV_P_ ev_idle *w, int revents)
		1372	{
		1373	// actual processing
		1374	read (STDIN_FILENO, ...);
		1375
		1376	// have to start the I/O watcher again, as
		1377	// we have handled the event
		1378	ev_io_start (EV_P_ &io);
		1379	}
		1380
		1381	// initialisation
		1382	ev_idle_init (&idle, idle_cb);
		1383	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1384	ev_io_start (EV_DEFAULT_ &io);
		1385
		1386	In the "real" world, it might also be beneficial to start a timer, so that
		1387	low-priority connections can not be locked out forever under load. This
		1388	enables your program to keep a lower latency for important connections
		1389	during short periods of high load, while not completely locking out less
		1390	important ones.
955		1391
956		1392
957	=head1 WATCHER TYPES	1393	=head1 WATCHER TYPES
958		1394
959	This section describes each watcher in detail, but will not repeat	1395	This section describes each watcher in detail, but will not repeat
…		…
983	In general you can register as many read and/or write event watchers per	1419	In general you can register as many read and/or write event watchers per
984	fd as you want (as long as you don't confuse yourself). Setting all file	1420	fd as you want (as long as you don't confuse yourself). Setting all file
985	descriptors to non-blocking mode is also usually a good idea (but not	1421	descriptors to non-blocking mode is also usually a good idea (but not
986	required if you know what you are doing).	1422	required if you know what you are doing).
987		1423
988	If you must do this, then force the use of a known-to-be-good backend	1424	If you cannot use non-blocking mode, then force the use of a
989	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1425	known-to-be-good backend (at the time of this writing, this includes only
990	C<EVBACKEND_POLL>).	1426	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
		1427	descriptors for which non-blocking operation makes no sense (such as
		1428	files) - libev doesn't guarentee any specific behaviour in that case.
991		1429
992	Another thing you have to watch out for is that it is quite easy to	1430	Another thing you have to watch out for is that it is quite easy to
993	receive "spurious" readyness notifications, that is your callback might	1431	receive "spurious" readiness notifications, that is your callback might
994	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1432	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
995	because there is no data. Not only are some backends known to create a	1433	because there is no data. Not only are some backends known to create a
996	lot of those (for example solaris ports), it is very easy to get into	1434	lot of those (for example Solaris ports), it is very easy to get into
997	this situation even with a relatively standard program structure. Thus	1435	this situation even with a relatively standard program structure. Thus
998	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1436	it is best to always use non-blocking I/O: An extra C<read>(2) returning
999	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1437	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1000		1438
1001	If you cannot run the fd in non-blocking mode (for example you should not	1439	If you cannot run the fd in non-blocking mode (for example you should
1002	play around with an Xlib connection), then you have to seperately re-test	1440	not play around with an Xlib connection), then you have to separately
1003	whether a file descriptor is really ready with a known-to-be good interface	1441	re-test whether a file descriptor is really ready with a known-to-be good
1004	such as poll (fortunately in our Xlib example, Xlib already does this on	1442	interface such as poll (fortunately in our Xlib example, Xlib already
1005	its own, so its quite safe to use).	1443	does this on its own, so its quite safe to use). Some people additionally
		1444	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1445	indefinitely.
		1446
		1447	But really, best use non-blocking mode.
1006		1448
1007	=head3 The special problem of disappearing file descriptors	1449	=head3 The special problem of disappearing file descriptors
1008		1450
1009	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1451	Some backends (e.g. kqueue, epoll) need to be told about closing a file
1010	descriptor (either by calling C<close> explicitly or by any other means,	1452	descriptor (either due to calling C<close> explicitly or any other means,
1011	such as C<dup>). The reason is that you register interest in some file	1453	such as C<dup2>). The reason is that you register interest in some file
1012	descriptor, but when it goes away, the operating system will silently drop	1454	descriptor, but when it goes away, the operating system will silently drop
1013	this interest. If another file descriptor with the same number then is	1455	this interest. If another file descriptor with the same number then is
1014	registered with libev, there is no efficient way to see that this is, in	1456	registered with libev, there is no efficient way to see that this is, in
1015	fact, a different file descriptor.	1457	fact, a different file descriptor.
1016		1458
…		…
1045	To support fork in your programs, you either have to call	1487	To support fork in your programs, you either have to call
1046	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1488	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1047	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1489	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1048	C<EVBACKEND_POLL>.	1490	C<EVBACKEND_POLL>.
1049		1491
		1492	=head3 The special problem of SIGPIPE
		1493
		1494	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
		1495	when writing to a pipe whose other end has been closed, your program gets
		1496	sent a SIGPIPE, which, by default, aborts your program. For most programs
		1497	this is sensible behaviour, for daemons, this is usually undesirable.
		1498
		1499	So when you encounter spurious, unexplained daemon exits, make sure you
		1500	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1501	somewhere, as that would have given you a big clue).
		1502
1050		1503
1051	=head3 Watcher-Specific Functions	1504	=head3 Watcher-Specific Functions
1052		1505
1053	=over 4	1506	=over 4
1054		1507
1055	=item ev_io_init (ev_io *, callback, int fd, int events)	1508	=item ev_io_init (ev_io *, callback, int fd, int events)
1056		1509
1057	=item ev_io_set (ev_io *, int fd, int events)	1510	=item ev_io_set (ev_io *, int fd, int events)
1058		1511
1059	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1512	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1060	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1513	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1061	C<EV_READ | EV_WRITE> to receive the given events.	1514	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1062		1515
1063	=item int fd [read-only]	1516	=item int fd [read-only]
1064		1517
1065	The file descriptor being watched.	1518	The file descriptor being watched.
1066		1519
1067	=item int events [read-only]	1520	=item int events [read-only]
1068		1521
1069	The events being watched.	1522	The events being watched.
1070		1523
1071	=back	1524	=back
		1525
		1526	=head3 Examples
1072		1527
1073	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1528	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1074	readable, but only once. Since it is likely line-buffered, you could	1529	readable, but only once. Since it is likely line-buffered, you could
1075	attempt to read a whole line in the callback.	1530	attempt to read a whole line in the callback.
1076		1531
1077	static void	1532	static void
1078	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1533	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1079	{	1534	{
1080	ev_io_stop (loop, w);	1535	ev_io_stop (loop, w);
1081	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1536	.. read from stdin here (or from w->fd) and handle any I/O errors
1082	}	1537	}
1083		1538
1084	...	1539	...
1085	struct ev_loop *loop = ev_default_init (0);	1540	struct ev_loop *loop = ev_default_init (0);
1086	struct ev_io stdin_readable;	1541	ev_io stdin_readable;
1087	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1542	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1088	ev_io_start (loop, &stdin_readable);	1543	ev_io_start (loop, &stdin_readable);
1089	ev_loop (loop, 0);	1544	ev_loop (loop, 0);
1090		1545
1091		1546
1092	=head2 C<ev_timer> - relative and optionally repeating timeouts	1547	=head2 C<ev_timer> - relative and optionally repeating timeouts
1093		1548
1094	Timer watchers are simple relative timers that generate an event after a	1549	Timer watchers are simple relative timers that generate an event after a
1095	given time, and optionally repeating in regular intervals after that.	1550	given time, and optionally repeating in regular intervals after that.
1096		1551
1097	The timers are based on real time, that is, if you register an event that	1552	The timers are based on real time, that is, if you register an event that
1098	times out after an hour and you reset your system clock to last years	1553	times out after an hour and you reset your system clock to January last
1099	time, it will still time out after (roughly) and hour. "Roughly" because	1554	year, it will still time out after (roughly) one hour. "Roughly" because
1100	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1555	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1101	monotonic clock option helps a lot here).	1556	monotonic clock option helps a lot here).
		1557
		1558	The callback is guaranteed to be invoked only I<after> its timeout has
		1559	passed (not I<at>, so on systems with very low-resolution clocks this
		1560	might introduce a small delay). If multiple timers become ready during the
		1561	same loop iteration then the ones with earlier time-out values are invoked
		1562	before ones of the same priority with later time-out values (but this is
		1563	no longer true when a callback calls C<ev_loop> recursively).
		1564
		1565	=head3 Be smart about timeouts
		1566
		1567	Many real-world problems involve some kind of timeout, usually for error
		1568	recovery. A typical example is an HTTP request - if the other side hangs,
		1569	you want to raise some error after a while.
		1570
		1571	What follows are some ways to handle this problem, from obvious and
		1572	inefficient to smart and efficient.
		1573
		1574	In the following, a 60 second activity timeout is assumed - a timeout that
		1575	gets reset to 60 seconds each time there is activity (e.g. each time some
		1576	data or other life sign was received).
		1577
		1578	=over 4
		1579
		1580	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1581
		1582	This is the most obvious, but not the most simple way: In the beginning,
		1583	start the watcher:
		1584
		1585	ev_timer_init (timer, callback, 60., 0.);
		1586	ev_timer_start (loop, timer);
		1587
		1588	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1589	and start it again:
		1590
		1591	ev_timer_stop (loop, timer);
		1592	ev_timer_set (timer, 60., 0.);
		1593	ev_timer_start (loop, timer);
		1594
		1595	This is relatively simple to implement, but means that each time there is
		1596	some activity, libev will first have to remove the timer from its internal
		1597	data structure and then add it again. Libev tries to be fast, but it's
		1598	still not a constant-time operation.
		1599
		1600	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1601
		1602	This is the easiest way, and involves using C<ev_timer_again> instead of
		1603	C<ev_timer_start>.
		1604
		1605	To implement this, configure an C<ev_timer> with a C<repeat> value
		1606	of C<60> and then call C<ev_timer_again> at start and each time you
		1607	successfully read or write some data. If you go into an idle state where
		1608	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1609	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1610
		1611	That means you can ignore both the C<ev_timer_start> function and the
		1612	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1613	member and C<ev_timer_again>.
		1614
		1615	At start:
		1616
		1617	ev_init (timer, callback);
		1618	timer->repeat = 60.;
		1619	ev_timer_again (loop, timer);
		1620
		1621	Each time there is some activity:
		1622
		1623	ev_timer_again (loop, timer);
		1624
		1625	It is even possible to change the time-out on the fly, regardless of
		1626	whether the watcher is active or not:
		1627
		1628	timer->repeat = 30.;
		1629	ev_timer_again (loop, timer);
		1630
		1631	This is slightly more efficient then stopping/starting the timer each time
		1632	you want to modify its timeout value, as libev does not have to completely
		1633	remove and re-insert the timer from/into its internal data structure.
		1634
		1635	It is, however, even simpler than the "obvious" way to do it.
		1636
		1637	=item 3. Let the timer time out, but then re-arm it as required.
		1638
		1639	This method is more tricky, but usually most efficient: Most timeouts are
		1640	relatively long compared to the intervals between other activity - in
		1641	our example, within 60 seconds, there are usually many I/O events with
		1642	associated activity resets.
		1643
		1644	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1645	but remember the time of last activity, and check for a real timeout only
		1646	within the callback:
		1647
		1648	ev_tstamp last_activity; // time of last activity
		1649
		1650	static void
		1651	callback (EV_P_ ev_timer *w, int revents)
		1652	{
		1653	ev_tstamp now = ev_now (EV_A);
		1654	ev_tstamp timeout = last_activity + 60.;
		1655
		1656	// if last_activity + 60. is older than now, we did time out
		1657	if (timeout < now)
		1658	{
		1659	// timeout occured, take action
		1660	}
		1661	else
		1662	{
		1663	// callback was invoked, but there was some activity, re-arm
		1664	// the watcher to fire in last_activity + 60, which is
		1665	// guaranteed to be in the future, so "again" is positive:
		1666	w->repeat = timeout - now;
		1667	ev_timer_again (EV_A_ w);
		1668	}
		1669	}
		1670
		1671	To summarise the callback: first calculate the real timeout (defined
		1672	as "60 seconds after the last activity"), then check if that time has
		1673	been reached, which means something I<did>, in fact, time out. Otherwise
		1674	the callback was invoked too early (C<timeout> is in the future), so
		1675	re-schedule the timer to fire at that future time, to see if maybe we have
		1676	a timeout then.
		1677
		1678	Note how C<ev_timer_again> is used, taking advantage of the
		1679	C<ev_timer_again> optimisation when the timer is already running.
		1680
		1681	This scheme causes more callback invocations (about one every 60 seconds
		1682	minus half the average time between activity), but virtually no calls to
		1683	libev to change the timeout.
		1684
		1685	To start the timer, simply initialise the watcher and set C<last_activity>
		1686	to the current time (meaning we just have some activity :), then call the
		1687	callback, which will "do the right thing" and start the timer:
		1688
		1689	ev_init (timer, callback);
		1690	last_activity = ev_now (loop);
		1691	callback (loop, timer, EV_TIMEOUT);
		1692
		1693	And when there is some activity, simply store the current time in
		1694	C<last_activity>, no libev calls at all:
		1695
		1696	last_actiivty = ev_now (loop);
		1697
		1698	This technique is slightly more complex, but in most cases where the
		1699	time-out is unlikely to be triggered, much more efficient.
		1700
		1701	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1702	callback :) - just change the timeout and invoke the callback, which will
		1703	fix things for you.
		1704
		1705	=item 4. Wee, just use a double-linked list for your timeouts.
		1706
		1707	If there is not one request, but many thousands (millions...), all
		1708	employing some kind of timeout with the same timeout value, then one can
		1709	do even better:
		1710
		1711	When starting the timeout, calculate the timeout value and put the timeout
		1712	at the I<end> of the list.
		1713
		1714	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1715	the list is expected to fire (for example, using the technique #3).
		1716
		1717	When there is some activity, remove the timer from the list, recalculate
		1718	the timeout, append it to the end of the list again, and make sure to
		1719	update the C<ev_timer> if it was taken from the beginning of the list.
		1720
		1721	This way, one can manage an unlimited number of timeouts in O(1) time for
		1722	starting, stopping and updating the timers, at the expense of a major
		1723	complication, and having to use a constant timeout. The constant timeout
		1724	ensures that the list stays sorted.
		1725
		1726	=back
		1727
		1728	So which method the best?
		1729
		1730	Method #2 is a simple no-brain-required solution that is adequate in most
		1731	situations. Method #3 requires a bit more thinking, but handles many cases
		1732	better, and isn't very complicated either. In most case, choosing either
		1733	one is fine, with #3 being better in typical situations.
		1734
		1735	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1736	rather complicated, but extremely efficient, something that really pays
		1737	off after the first million or so of active timers, i.e. it's usually
		1738	overkill :)
		1739
		1740	=head3 The special problem of time updates
		1741
		1742	Establishing the current time is a costly operation (it usually takes at
		1743	least two system calls): EV therefore updates its idea of the current
		1744	time only before and after C<ev_loop> collects new events, which causes a
		1745	growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1746	lots of events in one iteration.
1102		1747
1103	The relative timeouts are calculated relative to the C<ev_now ()>	1748	The relative timeouts are calculated relative to the C<ev_now ()>
1104	time. This is usually the right thing as this timestamp refers to the time	1749	time. This is usually the right thing as this timestamp refers to the time
1105	of the event triggering whatever timeout you are modifying/starting. If	1750	of the event triggering whatever timeout you are modifying/starting. If
1106	you suspect event processing to be delayed and you I<need> to base the timeout	1751	you suspect event processing to be delayed and you I<need> to base the
1107	on the current time, use something like this to adjust for this:	1752	timeout on the current time, use something like this to adjust for this:
1108		1753
1109	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1754	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1110		1755
1111	The callback is guarenteed to be invoked only when its timeout has passed,	1756	If the event loop is suspended for a long time, you can also force an
1112	but if multiple timers become ready during the same loop iteration then	1757	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1113	order of execution is undefined.	1758	()>.
		1759
		1760	=head3 The special problems of suspended animation
		1761
		1762	When you leave the server world it is quite customary to hit machines that
		1763	can suspend/hibernate - what happens to the clocks during such a suspend?
		1764
		1765	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		1766	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		1767	to run until the system is suspended, but they will not advance while the
		1768	system is suspended. That means, on resume, it will be as if the program
		1769	was frozen for a few seconds, but the suspend time will not be counted
		1770	towards C<ev_timer> when a monotonic clock source is used. The real time
		1771	clock advanced as expected, but if it is used as sole clocksource, then a
		1772	long suspend would be detected as a time jump by libev, and timers would
		1773	be adjusted accordingly.
		1774
		1775	I would not be surprised to see different behaviour in different between
		1776	operating systems, OS versions or even different hardware.
		1777
		1778	The other form of suspend (job control, or sending a SIGSTOP) will see a
		1779	time jump in the monotonic clocks and the realtime clock. If the program
		1780	is suspended for a very long time, and monotonic clock sources are in use,
		1781	then you can expect C<ev_timer>s to expire as the full suspension time
		1782	will be counted towards the timers. When no monotonic clock source is in
		1783	use, then libev will again assume a timejump and adjust accordingly.
		1784
		1785	It might be beneficial for this latter case to call C<ev_suspend>
		1786	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		1787	deterministic behaviour in this case (you can do nothing against
		1788	C<SIGSTOP>).
1114		1789
1115	=head3 Watcher-Specific Functions and Data Members	1790	=head3 Watcher-Specific Functions and Data Members
1116		1791
1117	=over 4	1792	=over 4
1118		1793
1119	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1794	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1120		1795
1121	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1796	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1122		1797
1123	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1798	Configure the timer to trigger after C<after> seconds. If C<repeat>
1124	C<0.>, then it will automatically be stopped. If it is positive, then the	1799	is C<0.>, then it will automatically be stopped once the timeout is
1125	timer will automatically be configured to trigger again C<repeat> seconds	1800	reached. If it is positive, then the timer will automatically be
1126	later, again, and again, until stopped manually.	1801	configured to trigger again C<repeat> seconds later, again, and again,
		1802	until stopped manually.
1127		1803
1128	The timer itself will do a best-effort at avoiding drift, that is, if you	1804	The timer itself will do a best-effort at avoiding drift, that is, if
1129	configure a timer to trigger every 10 seconds, then it will trigger at	1805	you configure a timer to trigger every 10 seconds, then it will normally
1130	exactly 10 second intervals. If, however, your program cannot keep up with	1806	trigger at exactly 10 second intervals. If, however, your program cannot
1131	the timer (because it takes longer than those 10 seconds to do stuff) the	1807	keep up with the timer (because it takes longer than those 10 seconds to
1132	timer will not fire more than once per event loop iteration.	1808	do stuff) the timer will not fire more than once per event loop iteration.
1133		1809
1134	=item ev_timer_again (loop)	1810	=item ev_timer_again (loop, ev_timer *)
1135		1811
1136	This will act as if the timer timed out and restart it again if it is	1812	This will act as if the timer timed out and restart it again if it is
1137	repeating. The exact semantics are:	1813	repeating. The exact semantics are:
1138		1814
1139	If the timer is pending, its pending status is cleared.	1815	If the timer is pending, its pending status is cleared.
1140		1816
1141	If the timer is started but nonrepeating, stop it (as if it timed out).	1817	If the timer is started but non-repeating, stop it (as if it timed out).
1142		1818
1143	If the timer is repeating, either start it if necessary (with the	1819	If the timer is repeating, either start it if necessary (with the
1144	C<repeat> value), or reset the running timer to the C<repeat> value.	1820	C<repeat> value), or reset the running timer to the C<repeat> value.
1145		1821
1146	This sounds a bit complicated, but here is a useful and typical	1822	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1147	example: Imagine you have a tcp connection and you want a so-called idle	1823	usage example.
1148	timeout, that is, you want to be called when there have been, say, 60
1149	seconds of inactivity on the socket. The easiest way to do this is to
1150	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1151	C<ev_timer_again> each time you successfully read or write some data. If
1152	you go into an idle state where you do not expect data to travel on the
1153	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1154	automatically restart it if need be.
1155		1824
1156	That means you can ignore the C<after> value and C<ev_timer_start>	1825	=item ev_timer_remaining (loop, ev_timer *)
1157	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1158		1826
1159	ev_timer_init (timer, callback, 0., 5.);	1827	Returns the remaining time until a timer fires. If the timer is active,
1160	ev_timer_again (loop, timer);	1828	then this time is relative to the current event loop time, otherwise it's
1161	...	1829	the timeout value currently configured.
1162	timer->again = 17.;
1163	ev_timer_again (loop, timer);
1164	...
1165	timer->again = 10.;
1166	ev_timer_again (loop, timer);
1167		1830
1168	This is more slightly efficient then stopping/starting the timer each time	1831	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1169	you want to modify its timeout value.	1832	C<5>. When the timer is started and one second passes, C<ev_timer_remain>
		1833	will return C<4>. When the timer expires and is restarted, it will return
		1834	roughly C<7> (likely slightly less as callback invocation takes some time,
		1835	too), and so on.
1170		1836
1171	=item ev_tstamp repeat [read-write]	1837	=item ev_tstamp repeat [read-write]
1172		1838
1173	The current C<repeat> value. Will be used each time the watcher times out	1839	The current C<repeat> value. Will be used each time the watcher times out
1174	or C<ev_timer_again> is called and determines the next timeout (if any),	1840	or C<ev_timer_again> is called, and determines the next timeout (if any),
1175	which is also when any modifications are taken into account.	1841	which is also when any modifications are taken into account.
1176		1842
1177	=back	1843	=back
1178		1844
		1845	=head3 Examples
		1846
1179	Example: Create a timer that fires after 60 seconds.	1847	Example: Create a timer that fires after 60 seconds.
1180		1848
1181	static void	1849	static void
1182	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1850	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1183	{	1851	{
1184	.. one minute over, w is actually stopped right here	1852	.. one minute over, w is actually stopped right here
1185	}	1853	}
1186		1854
1187	struct ev_timer mytimer;	1855	ev_timer mytimer;
1188	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1856	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1189	ev_timer_start (loop, &mytimer);	1857	ev_timer_start (loop, &mytimer);
1190		1858
1191	Example: Create a timeout timer that times out after 10 seconds of	1859	Example: Create a timeout timer that times out after 10 seconds of
1192	inactivity.	1860	inactivity.
1193		1861
1194	static void	1862	static void
1195	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1863	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1196	{	1864	{
1197	.. ten seconds without any activity	1865	.. ten seconds without any activity
1198	}	1866	}
1199		1867
1200	struct ev_timer mytimer;	1868	ev_timer mytimer;
1201	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1869	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1202	ev_timer_again (&mytimer); /* start timer */	1870	ev_timer_again (&mytimer); /* start timer */
1203	ev_loop (loop, 0);	1871	ev_loop (loop, 0);
1204		1872
1205	// and in some piece of code that gets executed on any "activity":	1873	// and in some piece of code that gets executed on any "activity":
1206	// reset the timeout to start ticking again at 10 seconds	1874	// reset the timeout to start ticking again at 10 seconds
1207	ev_timer_again (&mytimer);	1875	ev_timer_again (&mytimer);
1208		1876
1209		1877
1210	=head2 C<ev_periodic> - to cron or not to cron?	1878	=head2 C<ev_periodic> - to cron or not to cron?
1211		1879
1212	Periodic watchers are also timers of a kind, but they are very versatile	1880	Periodic watchers are also timers of a kind, but they are very versatile
1213	(and unfortunately a bit complex).	1881	(and unfortunately a bit complex).
1214		1882
1215	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1883	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1216	but on wallclock time (absolute time). You can tell a periodic watcher	1884	relative time, the physical time that passes) but on wall clock time
1217	to trigger "at" some specific point in time. For example, if you tell a	1885	(absolute time, the thing you can read on your calender or clock). The
1218	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1886	difference is that wall clock time can run faster or slower than real
1219	+ 10.>) and then reset your system clock to the last year, then it will	1887	time, and time jumps are not uncommon (e.g. when you adjust your
1220	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1888	wrist-watch).
1221	roughly 10 seconds later).
1222		1889
1223	They can also be used to implement vastly more complex timers, such as	1890	You can tell a periodic watcher to trigger after some specific point
1224	triggering an event on each midnight, local time or other, complicated,	1891	in time: for example, if you tell a periodic watcher to trigger "in 10
1225	rules.	1892	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1893	not a delay) and then reset your system clock to January of the previous
		1894	year, then it will take a year or more to trigger the event (unlike an
		1895	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1896	it, as it uses a relative timeout).
1226		1897
		1898	C<ev_periodic> watchers can also be used to implement vastly more complex
		1899	timers, such as triggering an event on each "midnight, local time", or
		1900	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1901	those cannot react to time jumps.
		1902
1227	As with timers, the callback is guarenteed to be invoked only when the	1903	As with timers, the callback is guaranteed to be invoked only when the
1228	time (C<at>) has been passed, but if multiple periodic timers become ready	1904	point in time where it is supposed to trigger has passed. If multiple
1229	during the same loop iteration then order of execution is undefined.	1905	timers become ready during the same loop iteration then the ones with
		1906	earlier time-out values are invoked before ones with later time-out values
		1907	(but this is no longer true when a callback calls C<ev_loop> recursively).
1230		1908
1231	=head3 Watcher-Specific Functions and Data Members	1909	=head3 Watcher-Specific Functions and Data Members
1232		1910
1233	=over 4	1911	=over 4
1234		1912
1235	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1913	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1236		1914
1237	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1915	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1238		1916
1239	Lots of arguments, lets sort it out... There are basically three modes of	1917	Lots of arguments, let's sort it out... There are basically three modes of
1240	operation, and we will explain them from simplest to complex:	1918	operation, and we will explain them from simplest to most complex:
1241		1919
1242	=over 4	1920	=over 4
1243		1921
1244	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1922	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1245		1923
1246	In this configuration the watcher triggers an event at the wallclock time	1924	In this configuration the watcher triggers an event after the wall clock
1247	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1925	time C<offset> has passed. It will not repeat and will not adjust when a
1248	that is, if it is to be run at January 1st 2011 then it will run when the	1926	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1249	system time reaches or surpasses this time.	1927	will be stopped and invoked when the system clock reaches or surpasses
		1928	this point in time.
1250		1929
1251	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1930	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1252		1931
1253	In this mode the watcher will always be scheduled to time out at the next	1932	In this mode the watcher will always be scheduled to time out at the next
1254	C<at + N * interval> time (for some integer N, which can also be negative)	1933	C<offset + N * interval> time (for some integer N, which can also be
1255	and then repeat, regardless of any time jumps.	1934	negative) and then repeat, regardless of any time jumps. The C<offset>
		1935	argument is merely an offset into the C<interval> periods.
1256		1936
1257	This can be used to create timers that do not drift with respect to system	1937	This can be used to create timers that do not drift with respect to the
1258	time:	1938	system clock, for example, here is an C<ev_periodic> that triggers each
		1939	hour, on the hour (with respect to UTC):
1259		1940
1260	ev_periodic_set (&periodic, 0., 3600., 0);	1941	ev_periodic_set (&periodic, 0., 3600., 0);
1261		1942
1262	This doesn't mean there will always be 3600 seconds in between triggers,	1943	This doesn't mean there will always be 3600 seconds in between triggers,
1263	but only that the the callback will be called when the system time shows a	1944	but only that the callback will be called when the system time shows a
1264	full hour (UTC), or more correctly, when the system time is evenly divisible	1945	full hour (UTC), or more correctly, when the system time is evenly divisible
1265	by 3600.	1946	by 3600.
1266		1947
1267	Another way to think about it (for the mathematically inclined) is that	1948	Another way to think about it (for the mathematically inclined) is that
1268	C<ev_periodic> will try to run the callback in this mode at the next possible	1949	C<ev_periodic> will try to run the callback in this mode at the next possible
1269	time where C<time = at (mod interval)>, regardless of any time jumps.	1950	time where C<time = offset (mod interval)>, regardless of any time jumps.
1270		1951
1271	For numerical stability it is preferable that the C<at> value is near	1952	For numerical stability it is preferable that the C<offset> value is near
1272	C<ev_now ()> (the current time), but there is no range requirement for	1953	C<ev_now ()> (the current time), but there is no range requirement for
1273	this value.	1954	this value, and in fact is often specified as zero.
1274		1955
		1956	Note also that there is an upper limit to how often a timer can fire (CPU
		1957	speed for example), so if C<interval> is very small then timing stability
		1958	will of course deteriorate. Libev itself tries to be exact to be about one
		1959	millisecond (if the OS supports it and the machine is fast enough).
		1960
1275	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1961	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1276		1962
1277	In this mode the values for C<interval> and C<at> are both being	1963	In this mode the values for C<interval> and C<offset> are both being
1278	ignored. Instead, each time the periodic watcher gets scheduled, the	1964	ignored. Instead, each time the periodic watcher gets scheduled, the
1279	reschedule callback will be called with the watcher as first, and the	1965	reschedule callback will be called with the watcher as first, and the
1280	current time as second argument.	1966	current time as second argument.
1281		1967
1282	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1968	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1283	ever, or make any event loop modifications>. If you need to stop it,	1969	or make ANY other event loop modifications whatsoever, unless explicitly
1284	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1970	allowed by documentation here>.
1285	starting an C<ev_prepare> watcher, which is legal).
1286		1971
		1972	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1973	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1974	only event loop modification you are allowed to do).
		1975
1287	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1976	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1288	ev_tstamp now)>, e.g.:	1977	*w, ev_tstamp now)>, e.g.:
1289		1978
		1979	static ev_tstamp
1290	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1980	my_rescheduler (ev_periodic *w, ev_tstamp now)
1291	{	1981	{
1292	return now + 60.;	1982	return now + 60.;
1293	}	1983	}
1294		1984
1295	It must return the next time to trigger, based on the passed time value	1985	It must return the next time to trigger, based on the passed time value
1296	(that is, the lowest time value larger than to the second argument). It	1986	(that is, the lowest time value larger than to the second argument). It
1297	will usually be called just before the callback will be triggered, but	1987	will usually be called just before the callback will be triggered, but
1298	might be called at other times, too.	1988	might be called at other times, too.
1299		1989
1300	NOTE: I<< This callback must always return a time that is later than the	1990	NOTE: I<< This callback must always return a time that is higher than or
1301	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1991	equal to the passed C<now> value >>.
1302		1992
1303	This can be used to create very complex timers, such as a timer that	1993	This can be used to create very complex timers, such as a timer that
1304	triggers on each midnight, local time. To do this, you would calculate the	1994	triggers on "next midnight, local time". To do this, you would calculate the
1305	next midnight after C<now> and return the timestamp value for this. How	1995	next midnight after C<now> and return the timestamp value for this. How
1306	you do this is, again, up to you (but it is not trivial, which is the main	1996	you do this is, again, up to you (but it is not trivial, which is the main
1307	reason I omitted it as an example).	1997	reason I omitted it as an example).
1308		1998
1309	=back	1999	=back
…		…
1313	Simply stops and restarts the periodic watcher again. This is only useful	2003	Simply stops and restarts the periodic watcher again. This is only useful
1314	when you changed some parameters or the reschedule callback would return	2004	when you changed some parameters or the reschedule callback would return
1315	a different time than the last time it was called (e.g. in a crond like	2005	a different time than the last time it was called (e.g. in a crond like
1316	program when the crontabs have changed).	2006	program when the crontabs have changed).
1317		2007
		2008	=item ev_tstamp ev_periodic_at (ev_periodic *)
		2009
		2010	When active, returns the absolute time that the watcher is supposed
		2011	to trigger next. This is not the same as the C<offset> argument to
		2012	C<ev_periodic_set>, but indeed works even in interval and manual
		2013	rescheduling modes.
		2014
1318	=item ev_tstamp offset [read-write]	2015	=item ev_tstamp offset [read-write]
1319		2016
1320	When repeating, this contains the offset value, otherwise this is the	2017	When repeating, this contains the offset value, otherwise this is the
1321	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	2018	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		2019	although libev might modify this value for better numerical stability).
1322		2020
1323	Can be modified any time, but changes only take effect when the periodic	2021	Can be modified any time, but changes only take effect when the periodic
1324	timer fires or C<ev_periodic_again> is being called.	2022	timer fires or C<ev_periodic_again> is being called.
1325		2023
1326	=item ev_tstamp interval [read-write]	2024	=item ev_tstamp interval [read-write]
1327		2025
1328	The current interval value. Can be modified any time, but changes only	2026	The current interval value. Can be modified any time, but changes only
1329	take effect when the periodic timer fires or C<ev_periodic_again> is being	2027	take effect when the periodic timer fires or C<ev_periodic_again> is being
1330	called.	2028	called.
1331		2029
1332	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	2030	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1333		2031
1334	The current reschedule callback, or C<0>, if this functionality is	2032	The current reschedule callback, or C<0>, if this functionality is
1335	switched off. Can be changed any time, but changes only take effect when	2033	switched off. Can be changed any time, but changes only take effect when
1336	the periodic timer fires or C<ev_periodic_again> is being called.	2034	the periodic timer fires or C<ev_periodic_again> is being called.
1337		2035
1338	=item ev_tstamp at [read-only]
1339
1340	When active, contains the absolute time that the watcher is supposed to
1341	trigger next.
1342
1343	=back	2036	=back
1344		2037
		2038	=head3 Examples
		2039
1345	Example: Call a callback every hour, or, more precisely, whenever the	2040	Example: Call a callback every hour, or, more precisely, whenever the
1346	system clock is divisible by 3600. The callback invocation times have	2041	system time is divisible by 3600. The callback invocation times have
1347	potentially a lot of jittering, but good long-term stability.	2042	potentially a lot of jitter, but good long-term stability.
1348		2043
1349	static void	2044	static void
1350	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	2045	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1351	{	2046	{
1352	... its now a full hour (UTC, or TAI or whatever your clock follows)	2047	... its now a full hour (UTC, or TAI or whatever your clock follows)
1353	}	2048	}
1354		2049
1355	struct ev_periodic hourly_tick;	2050	ev_periodic hourly_tick;
1356	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	2051	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1357	ev_periodic_start (loop, &hourly_tick);	2052	ev_periodic_start (loop, &hourly_tick);
1358		2053
1359	Example: The same as above, but use a reschedule callback to do it:	2054	Example: The same as above, but use a reschedule callback to do it:
1360		2055
1361	#include <math.h>	2056	#include <math.h>
1362		2057
1363	static ev_tstamp	2058	static ev_tstamp
1364	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	2059	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1365	{	2060	{
1366	return fmod (now, 3600.) + 3600.;	2061	return now + (3600. - fmod (now, 3600.));
1367	}	2062	}
1368		2063
1369	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	2064	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1370		2065
1371	Example: Call a callback every hour, starting now:	2066	Example: Call a callback every hour, starting now:
1372		2067
1373	struct ev_periodic hourly_tick;	2068	ev_periodic hourly_tick;
1374	ev_periodic_init (&hourly_tick, clock_cb,	2069	ev_periodic_init (&hourly_tick, clock_cb,
1375	fmod (ev_now (loop), 3600.), 3600., 0);	2070	fmod (ev_now (loop), 3600.), 3600., 0);
1376	ev_periodic_start (loop, &hourly_tick);	2071	ev_periodic_start (loop, &hourly_tick);
1377		2072
1378		2073
1379	=head2 C<ev_signal> - signal me when a signal gets signalled!	2074	=head2 C<ev_signal> - signal me when a signal gets signalled!
1380		2075
1381	Signal watchers will trigger an event when the process receives a specific	2076	Signal watchers will trigger an event when the process receives a specific
1382	signal one or more times. Even though signals are very asynchronous, libev	2077	signal one or more times. Even though signals are very asynchronous, libev
1383	will try it's best to deliver signals synchronously, i.e. as part of the	2078	will try it's best to deliver signals synchronously, i.e. as part of the
1384	normal event processing, like any other event.	2079	normal event processing, like any other event.
1385		2080
		2081	If you want signals asynchronously, just use C<sigaction> as you would
		2082	do without libev and forget about sharing the signal. You can even use
		2083	C<ev_async> from a signal handler to synchronously wake up an event loop.
		2084
1386	You can configure as many watchers as you like per signal. Only when the	2085	You can configure as many watchers as you like per signal. Only when the
1387	first watcher gets started will libev actually register a signal watcher	2086	first watcher gets started will libev actually register a signal handler
1388	with the kernel (thus it coexists with your own signal handlers as long	2087	with the kernel (thus it coexists with your own signal handlers as long as
1389	as you don't register any with libev). Similarly, when the last signal	2088	you don't register any with libev for the same signal). Similarly, when
1390	watcher for a signal is stopped libev will reset the signal handler to	2089	the last signal watcher for a signal is stopped, libev will reset the
1391	SIG_DFL (regardless of what it was set to before).	2090	signal handler to SIG_DFL (regardless of what it was set to before).
		2091
		2092	If possible and supported, libev will install its handlers with
		2093	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
		2094	interrupted. If you have a problem with system calls getting interrupted by
		2095	signals you can block all signals in an C<ev_check> watcher and unblock
		2096	them in an C<ev_prepare> watcher.
1392		2097
1393	=head3 Watcher-Specific Functions and Data Members	2098	=head3 Watcher-Specific Functions and Data Members
1394		2099
1395	=over 4	2100	=over 4
1396		2101
…		…
1405		2110
1406	The signal the watcher watches out for.	2111	The signal the watcher watches out for.
1407		2112
1408	=back	2113	=back
1409		2114
		2115	=head3 Examples
		2116
		2117	Example: Try to exit cleanly on SIGINT.
		2118
		2119	static void
		2120	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
		2121	{
		2122	ev_unloop (loop, EVUNLOOP_ALL);
		2123	}
		2124
		2125	ev_signal signal_watcher;
		2126	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		2127	ev_signal_start (loop, &signal_watcher);
		2128
1410		2129
1411	=head2 C<ev_child> - watch out for process status changes	2130	=head2 C<ev_child> - watch out for process status changes
1412		2131
1413	Child watchers trigger when your process receives a SIGCHLD in response to	2132	Child watchers trigger when your process receives a SIGCHLD in response to
1414	some child status changes (most typically when a child of yours dies).	2133	some child status changes (most typically when a child of yours dies or
		2134	exits). It is permissible to install a child watcher I<after> the child
		2135	has been forked (which implies it might have already exited), as long
		2136	as the event loop isn't entered (or is continued from a watcher), i.e.,
		2137	forking and then immediately registering a watcher for the child is fine,
		2138	but forking and registering a watcher a few event loop iterations later or
		2139	in the next callback invocation is not.
		2140
		2141	Only the default event loop is capable of handling signals, and therefore
		2142	you can only register child watchers in the default event loop.
		2143
		2144	Due to some design glitches inside libev, child watchers will always be
		2145	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2146	libev)
		2147
		2148	=head3 Process Interaction
		2149
		2150	Libev grabs C<SIGCHLD> as soon as the default event loop is
		2151	initialised. This is necessary to guarantee proper behaviour even if
		2152	the first child watcher is started after the child exits. The occurrence
		2153	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		2154	synchronously as part of the event loop processing. Libev always reaps all
		2155	children, even ones not watched.
		2156
		2157	=head3 Overriding the Built-In Processing
		2158
		2159	Libev offers no special support for overriding the built-in child
		2160	processing, but if your application collides with libev's default child
		2161	handler, you can override it easily by installing your own handler for
		2162	C<SIGCHLD> after initialising the default loop, and making sure the
		2163	default loop never gets destroyed. You are encouraged, however, to use an
		2164	event-based approach to child reaping and thus use libev's support for
		2165	that, so other libev users can use C<ev_child> watchers freely.
		2166
		2167	=head3 Stopping the Child Watcher
		2168
		2169	Currently, the child watcher never gets stopped, even when the
		2170	child terminates, so normally one needs to stop the watcher in the
		2171	callback. Future versions of libev might stop the watcher automatically
		2172	when a child exit is detected.
1415		2173
1416	=head3 Watcher-Specific Functions and Data Members	2174	=head3 Watcher-Specific Functions and Data Members
1417		2175
1418	=over 4	2176	=over 4
1419		2177
1420	=item ev_child_init (ev_child *, callback, int pid)	2178	=item ev_child_init (ev_child *, callback, int pid, int trace)
1421		2179
1422	=item ev_child_set (ev_child *, int pid)	2180	=item ev_child_set (ev_child *, int pid, int trace)
1423		2181
1424	Configures the watcher to wait for status changes of process C<pid> (or	2182	Configures the watcher to wait for status changes of process C<pid> (or
1425	I<any> process if C<pid> is specified as C<0>). The callback can look	2183	I<any> process if C<pid> is specified as C<0>). The callback can look
1426	at the C<rstatus> member of the C<ev_child> watcher structure to see	2184	at the C<rstatus> member of the C<ev_child> watcher structure to see
1427	the status word (use the macros from C<sys/wait.h> and see your systems	2185	the status word (use the macros from C<sys/wait.h> and see your systems
1428	C<waitpid> documentation). The C<rpid> member contains the pid of the	2186	C<waitpid> documentation). The C<rpid> member contains the pid of the
1429	process causing the status change.	2187	process causing the status change. C<trace> must be either C<0> (only
		2188	activate the watcher when the process terminates) or C<1> (additionally
		2189	activate the watcher when the process is stopped or continued).
1430		2190
1431	=item int pid [read-only]	2191	=item int pid [read-only]
1432		2192
1433	The process id this watcher watches out for, or C<0>, meaning any process id.	2193	The process id this watcher watches out for, or C<0>, meaning any process id.
1434		2194
…		…
1441	The process exit/trace status caused by C<rpid> (see your systems	2201	The process exit/trace status caused by C<rpid> (see your systems
1442	C<waitpid> and C<sys/wait.h> documentation for details).	2202	C<waitpid> and C<sys/wait.h> documentation for details).
1443		2203
1444	=back	2204	=back
1445		2205
1446	Example: Try to exit cleanly on SIGINT and SIGTERM.	2206	=head3 Examples
1447		2207
		2208	Example: C<fork()> a new process and install a child handler to wait for
		2209	its completion.
		2210
		2211	ev_child cw;
		2212
1448	static void	2213	static void
1449	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	2214	child_cb (EV_P_ ev_child *w, int revents)
1450	{	2215	{
1451	ev_unloop (loop, EVUNLOOP_ALL);	2216	ev_child_stop (EV_A_ w);
		2217	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1452	}	2218	}
1453		2219
1454	struct ev_signal signal_watcher;	2220	pid_t pid = fork ();
1455	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2221
1456	ev_signal_start (loop, &sigint_cb);	2222	if (pid < 0)
		2223	// error
		2224	else if (pid == 0)
		2225	{
		2226	// the forked child executes here
		2227	exit (1);
		2228	}
		2229	else
		2230	{
		2231	ev_child_init (&cw, child_cb, pid, 0);
		2232	ev_child_start (EV_DEFAULT_ &cw);
		2233	}
1457		2234
1458		2235
1459	=head2 C<ev_stat> - did the file attributes just change?	2236	=head2 C<ev_stat> - did the file attributes just change?
1460		2237
1461	This watches a filesystem path for attribute changes. That is, it calls	2238	This watches a file system path for attribute changes. That is, it calls
1462	C<stat> regularly (or when the OS says it changed) and sees if it changed	2239	C<stat> on that path in regular intervals (or when the OS says it changed)
1463	compared to the last time, invoking the callback if it did.	2240	and sees if it changed compared to the last time, invoking the callback if
		2241	it did.
1464		2242
1465	The path does not need to exist: changing from "path exists" to "path does	2243	The path does not need to exist: changing from "path exists" to "path does
1466	not exist" is a status change like any other. The condition "path does	2244	not exist" is a status change like any other. The condition "path does not
1467	not exist" is signified by the C<st_nlink> field being zero (which is	2245	exist" (or more correctly "path cannot be stat'ed") is signified by the
1468	otherwise always forced to be at least one) and all the other fields of	2246	C<st_nlink> field being zero (which is otherwise always forced to be at
1469	the stat buffer having unspecified contents.	2247	least one) and all the other fields of the stat buffer having unspecified
		2248	contents.
1470		2249
1471	The path I<should> be absolute and I<must not> end in a slash. If it is	2250	The path I<must not> end in a slash or contain special components such as
		2251	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1472	relative and your working directory changes, the behaviour is undefined.	2252	your working directory changes, then the behaviour is undefined.
1473		2253
1474	Since there is no standard to do this, the portable implementation simply	2254	Since there is no portable change notification interface available, the
1475	calls C<stat (2)> regularly on the path to see if it changed somehow. You	2255	portable implementation simply calls C<stat(2)> regularly on the path
1476	can specify a recommended polling interval for this case. If you specify	2256	to see if it changed somehow. You can specify a recommended polling
1477	a polling interval of C<0> (highly recommended!) then a I<suitable,	2257	interval for this case. If you specify a polling interval of C<0> (highly
1478	unspecified default> value will be used (which you can expect to be around	2258	recommended!) then a I<suitable, unspecified default> value will be used
1479	five seconds, although this might change dynamically). Libev will also	2259	(which you can expect to be around five seconds, although this might
1480	impose a minimum interval which is currently around C<0.1>, but thats	2260	change dynamically). Libev will also impose a minimum interval which is
1481	usually overkill.	2261	currently around C<0.1>, but that's usually overkill.
1482		2262
1483	This watcher type is not meant for massive numbers of stat watchers,	2263	This watcher type is not meant for massive numbers of stat watchers,
1484	as even with OS-supported change notifications, this can be	2264	as even with OS-supported change notifications, this can be
1485	resource-intensive.	2265	resource-intensive.
1486		2266
1487	At the time of this writing, only the Linux inotify interface is	2267	At the time of this writing, the only OS-specific interface implemented
1488	implemented (implementing kqueue support is left as an exercise for the	2268	is the Linux inotify interface (implementing kqueue support is left as an
1489	reader). Inotify will be used to give hints only and should not change the	2269	exercise for the reader. Note, however, that the author sees no way of
1490	semantics of C<ev_stat> watchers, which means that libev sometimes needs	2270	implementing C<ev_stat> semantics with kqueue, except as a hint).
1491	to fall back to regular polling again even with inotify, but changes are
1492	usually detected immediately, and if the file exists there will be no
1493	polling.
1494		2271
1495	=head3 Inotify	2272	=head3 ABI Issues (Largefile Support)
1496		2273
		2274	Libev by default (unless the user overrides this) uses the default
		2275	compilation environment, which means that on systems with large file
		2276	support disabled by default, you get the 32 bit version of the stat
		2277	structure. When using the library from programs that change the ABI to
		2278	use 64 bit file offsets the programs will fail. In that case you have to
		2279	compile libev with the same flags to get binary compatibility. This is
		2280	obviously the case with any flags that change the ABI, but the problem is
		2281	most noticeably displayed with ev_stat and large file support.
		2282
		2283	The solution for this is to lobby your distribution maker to make large
		2284	file interfaces available by default (as e.g. FreeBSD does) and not
		2285	optional. Libev cannot simply switch on large file support because it has
		2286	to exchange stat structures with application programs compiled using the
		2287	default compilation environment.
		2288
		2289	=head3 Inotify and Kqueue
		2290
1497	When C<inotify (7)> support has been compiled into libev (generally only	2291	When C<inotify (7)> support has been compiled into libev and present at
1498	available on Linux) and present at runtime, it will be used to speed up	2292	runtime, it will be used to speed up change detection where possible. The
1499	change detection where possible. The inotify descriptor will be created lazily	2293	inotify descriptor will be created lazily when the first C<ev_stat>
1500	when the first C<ev_stat> watcher is being started.	2294	watcher is being started.
1501		2295
1502	Inotify presense does not change the semantics of C<ev_stat> watchers	2296	Inotify presence does not change the semantics of C<ev_stat> watchers
1503	except that changes might be detected earlier, and in some cases, to avoid	2297	except that changes might be detected earlier, and in some cases, to avoid
1504	making regular C<stat> calls. Even in the presense of inotify support	2298	making regular C<stat> calls. Even in the presence of inotify support
1505	there are many cases where libev has to resort to regular C<stat> polling.	2299	there are many cases where libev has to resort to regular C<stat> polling,
		2300	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2301	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2302	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2303	xfs are fully working) libev usually gets away without polling.
1506		2304
1507	(There is no support for kqueue, as apparently it cannot be used to	2305	There is no support for kqueue, as apparently it cannot be used to
1508	implement this functionality, due to the requirement of having a file	2306	implement this functionality, due to the requirement of having a file
1509	descriptor open on the object at all times).	2307	descriptor open on the object at all times, and detecting renames, unlinks
		2308	etc. is difficult.
		2309
		2310	=head3 C<stat ()> is a synchronous operation
		2311
		2312	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2313	the process. The exception are C<ev_stat> watchers - those call C<stat
		2314	()>, which is a synchronous operation.
		2315
		2316	For local paths, this usually doesn't matter: unless the system is very
		2317	busy or the intervals between stat's are large, a stat call will be fast,
		2318	as the path data is usually in memory already (except when starting the
		2319	watcher).
		2320
		2321	For networked file systems, calling C<stat ()> can block an indefinite
		2322	time due to network issues, and even under good conditions, a stat call
		2323	often takes multiple milliseconds.
		2324
		2325	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2326	paths, although this is fully supported by libev.
1510		2327
1511	=head3 The special problem of stat time resolution	2328	=head3 The special problem of stat time resolution
1512		2329
1513	The C<stat ()> syscall only supports full-second resolution portably, and	2330	The C<stat ()> system call only supports full-second resolution portably,
1514	even on systems where the resolution is higher, many filesystems still	2331	and even on systems where the resolution is higher, most file systems
1515	only support whole seconds.	2332	still only support whole seconds.
1516		2333
1517	That means that, if the time is the only thing that changes, you might	2334	That means that, if the time is the only thing that changes, you can
1518	miss updates: on the first update, C<ev_stat> detects a change and calls	2335	easily miss updates: on the first update, C<ev_stat> detects a change and
1519	your callback, which does something. When there is another update within	2336	calls your callback, which does something. When there is another update
1520	the same second, C<ev_stat> will be unable to detect it.	2337	within the same second, C<ev_stat> will be unable to detect unless the
		2338	stat data does change in other ways (e.g. file size).
1521		2339
1522	The solution to this is to delay acting on a change for a second (or till	2340	The solution to this is to delay acting on a change for slightly more
1523	the next second boundary), using a roughly one-second delay C<ev_timer>	2341	than a second (or till slightly after the next full second boundary), using
1524	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	2342	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1525	is added to work around small timing inconsistencies of some operating	2343	ev_timer_again (loop, w)>).
1526	systems.	2344
		2345	The C<.02> offset is added to work around small timing inconsistencies
		2346	of some operating systems (where the second counter of the current time
		2347	might be be delayed. One such system is the Linux kernel, where a call to
		2348	C<gettimeofday> might return a timestamp with a full second later than
		2349	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		2350	update file times then there will be a small window where the kernel uses
		2351	the previous second to update file times but libev might already execute
		2352	the timer callback).
1527		2353
1528	=head3 Watcher-Specific Functions and Data Members	2354	=head3 Watcher-Specific Functions and Data Members
1529		2355
1530	=over 4	2356	=over 4
1531		2357
…		…
1537	C<path>. The C<interval> is a hint on how quickly a change is expected to	2363	C<path>. The C<interval> is a hint on how quickly a change is expected to
1538	be detected and should normally be specified as C<0> to let libev choose	2364	be detected and should normally be specified as C<0> to let libev choose
1539	a suitable value. The memory pointed to by C<path> must point to the same	2365	a suitable value. The memory pointed to by C<path> must point to the same
1540	path for as long as the watcher is active.	2366	path for as long as the watcher is active.
1541		2367
1542	The callback will be receive C<EV_STAT> when a change was detected,	2368	The callback will receive an C<EV_STAT> event when a change was detected,
1543	relative to the attributes at the time the watcher was started (or the	2369	relative to the attributes at the time the watcher was started (or the
1544	last change was detected).	2370	last change was detected).
1545		2371
1546	=item ev_stat_stat (ev_stat *)	2372	=item ev_stat_stat (loop, ev_stat *)
1547		2373
1548	Updates the stat buffer immediately with new values. If you change the	2374	Updates the stat buffer immediately with new values. If you change the
1549	watched path in your callback, you could call this fucntion to avoid	2375	watched path in your callback, you could call this function to avoid
1550	detecting this change (while introducing a race condition). Can also be	2376	detecting this change (while introducing a race condition if you are not
1551	useful simply to find out the new values.	2377	the only one changing the path). Can also be useful simply to find out the
		2378	new values.
1552		2379
1553	=item ev_statdata attr [read-only]	2380	=item ev_statdata attr [read-only]
1554		2381
1555	The most-recently detected attributes of the file. Although the type is of	2382	The most-recently detected attributes of the file. Although the type is
1556	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	2383	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1557	suitable for your system. If the C<st_nlink> member is C<0>, then there	2384	suitable for your system, but you can only rely on the POSIX-standardised
		2385	members to be present. If the C<st_nlink> member is C<0>, then there was
1558	was some error while C<stat>ing the file.	2386	some error while C<stat>ing the file.
1559		2387
1560	=item ev_statdata prev [read-only]	2388	=item ev_statdata prev [read-only]
1561		2389
1562	The previous attributes of the file. The callback gets invoked whenever	2390	The previous attributes of the file. The callback gets invoked whenever
1563	C<prev> != C<attr>.	2391	C<prev> != C<attr>, or, more precisely, one or more of these members
		2392	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		2393	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1564		2394
1565	=item ev_tstamp interval [read-only]	2395	=item ev_tstamp interval [read-only]
1566		2396
1567	The specified interval.	2397	The specified interval.
1568		2398
1569	=item const char *path [read-only]	2399	=item const char *path [read-only]
1570		2400
1571	The filesystem path that is being watched.	2401	The file system path that is being watched.
1572		2402
1573	=back	2403	=back
1574		2404
1575	=head3 Examples	2405	=head3 Examples
1576		2406
1577	Example: Watch C</etc/passwd> for attribute changes.	2407	Example: Watch C</etc/passwd> for attribute changes.
1578		2408
1579	static void	2409	static void
1580	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	2410	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1581	{	2411	{
1582	/* /etc/passwd changed in some way */	2412	/* /etc/passwd changed in some way */
1583	if (w->attr.st_nlink)	2413	if (w->attr.st_nlink)
1584	{	2414	{
1585	printf ("passwd current size %ld\n", (long)w->attr.st_size);	2415	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1586	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	2416	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1587	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	2417	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1588	}	2418	}
1589	else	2419	else
1590	/* you shalt not abuse printf for puts */	2420	/* you shalt not abuse printf for puts */
1591	puts ("wow, /etc/passwd is not there, expect problems. "	2421	puts ("wow, /etc/passwd is not there, expect problems. "
1592	"if this is windows, they already arrived\n");	2422	"if this is windows, they already arrived\n");
1593	}	2423	}
1594		2424
1595	...	2425	...
1596	ev_stat passwd;	2426	ev_stat passwd;
1597		2427
1598	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	2428	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1599	ev_stat_start (loop, &passwd);	2429	ev_stat_start (loop, &passwd);
1600		2430
1601	Example: Like above, but additionally use a one-second delay so we do not	2431	Example: Like above, but additionally use a one-second delay so we do not
1602	miss updates (however, frequent updates will delay processing, too, so	2432	miss updates (however, frequent updates will delay processing, too, so
1603	one might do the work both on C<ev_stat> callback invocation I<and> on	2433	one might do the work both on C<ev_stat> callback invocation I<and> on
1604	C<ev_timer> callback invocation).	2434	C<ev_timer> callback invocation).
1605		2435
1606	static ev_stat passwd;	2436	static ev_stat passwd;
1607	static ev_timer timer;	2437	static ev_timer timer;
1608		2438
1609	static void	2439	static void
1610	timer_cb (EV_P_ ev_timer *w, int revents)	2440	timer_cb (EV_P_ ev_timer *w, int revents)
1611	{	2441	{
1612	ev_timer_stop (EV_A_ w);	2442	ev_timer_stop (EV_A_ w);
1613		2443
1614	/* now it's one second after the most recent passwd change */	2444	/* now it's one second after the most recent passwd change */
1615	}	2445	}
1616		2446
1617	static void	2447	static void
1618	stat_cb (EV_P_ ev_stat *w, int revents)	2448	stat_cb (EV_P_ ev_stat *w, int revents)
1619	{	2449	{
1620	/* reset the one-second timer */	2450	/* reset the one-second timer */
1621	ev_timer_again (EV_A_ &timer);	2451	ev_timer_again (EV_A_ &timer);
1622	}	2452	}
1623		2453
1624	...	2454	...
1625	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	2455	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1626	ev_stat_start (loop, &passwd);	2456	ev_stat_start (loop, &passwd);
1627	ev_timer_init (&timer, timer_cb, 0., 1.01);	2457	ev_timer_init (&timer, timer_cb, 0., 1.02);
1628		2458
1629		2459
1630	=head2 C<ev_idle> - when you've got nothing better to do...	2460	=head2 C<ev_idle> - when you've got nothing better to do...
1631		2461
1632	Idle watchers trigger events when no other events of the same or higher	2462	Idle watchers trigger events when no other events of the same or higher
1633	priority are pending (prepare, check and other idle watchers do not	2463	priority are pending (prepare, check and other idle watchers do not count
1634	count).	2464	as receiving "events").
1635		2465
1636	That is, as long as your process is busy handling sockets or timeouts	2466	That is, as long as your process is busy handling sockets or timeouts
1637	(or even signals, imagine) of the same or higher priority it will not be	2467	(or even signals, imagine) of the same or higher priority it will not be
1638	triggered. But when your process is idle (or only lower-priority watchers	2468	triggered. But when your process is idle (or only lower-priority watchers
1639	are pending), the idle watchers are being called once per event loop	2469	are pending), the idle watchers are being called once per event loop
…		…
1650		2480
1651	=head3 Watcher-Specific Functions and Data Members	2481	=head3 Watcher-Specific Functions and Data Members
1652		2482
1653	=over 4	2483	=over 4
1654		2484
1655	=item ev_idle_init (ev_signal *, callback)	2485	=item ev_idle_init (ev_idle *, callback)
1656		2486
1657	Initialises and configures the idle watcher - it has no parameters of any	2487	Initialises and configures the idle watcher - it has no parameters of any
1658	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2488	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1659	believe me.	2489	believe me.
1660		2490
1661	=back	2491	=back
1662		2492
		2493	=head3 Examples
		2494
1663	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2495	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1664	callback, free it. Also, use no error checking, as usual.	2496	callback, free it. Also, use no error checking, as usual.
1665		2497
1666	static void	2498	static void
1667	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2499	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1668	{	2500	{
1669	free (w);	2501	free (w);
1670	// now do something you wanted to do when the program has	2502	// now do something you wanted to do when the program has
1671	// no longer asnything immediate to do.	2503	// no longer anything immediate to do.
1672	}	2504	}
1673		2505
1674	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2506	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1675	ev_idle_init (idle_watcher, idle_cb);	2507	ev_idle_init (idle_watcher, idle_cb);
1676	ev_idle_start (loop, idle_cb);	2508	ev_idle_start (loop, idle_watcher);
1677		2509
1678		2510
1679	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2511	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1680		2512
1681	Prepare and check watchers are usually (but not always) used in tandem:	2513	Prepare and check watchers are usually (but not always) used in pairs:
1682	prepare watchers get invoked before the process blocks and check watchers	2514	prepare watchers get invoked before the process blocks and check watchers
1683	afterwards.	2515	afterwards.
1684		2516
1685	You I<must not> call C<ev_loop> or similar functions that enter	2517	You I<must not> call C<ev_loop> or similar functions that enter
1686	the current event loop from either C<ev_prepare> or C<ev_check>	2518	the current event loop from either C<ev_prepare> or C<ev_check>
…		…
1689	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2521	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1690	C<ev_check> so if you have one watcher of each kind they will always be	2522	C<ev_check> so if you have one watcher of each kind they will always be
1691	called in pairs bracketing the blocking call.	2523	called in pairs bracketing the blocking call.
1692		2524
1693	Their main purpose is to integrate other event mechanisms into libev and	2525	Their main purpose is to integrate other event mechanisms into libev and
1694	their use is somewhat advanced. This could be used, for example, to track	2526	their use is somewhat advanced. They could be used, for example, to track
1695	variable changes, implement your own watchers, integrate net-snmp or a	2527	variable changes, implement your own watchers, integrate net-snmp or a
1696	coroutine library and lots more. They are also occasionally useful if	2528	coroutine library and lots more. They are also occasionally useful if
1697	you cache some data and want to flush it before blocking (for example,	2529	you cache some data and want to flush it before blocking (for example,
1698	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>	2530	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1699	watcher).	2531	watcher).
1700		2532
1701	This is done by examining in each prepare call which file descriptors need	2533	This is done by examining in each prepare call which file descriptors
1702	to be watched by the other library, registering C<ev_io> watchers for	2534	need to be watched by the other library, registering C<ev_io> watchers
1703	them and starting an C<ev_timer> watcher for any timeouts (many libraries	2535	for them and starting an C<ev_timer> watcher for any timeouts (many
1704	provide just this functionality). Then, in the check watcher you check for	2536	libraries provide exactly this functionality). Then, in the check watcher,
1705	any events that occured (by checking the pending status of all watchers	2537	you check for any events that occurred (by checking the pending status
1706	and stopping them) and call back into the library. The I/O and timer	2538	of all watchers and stopping them) and call back into the library. The
1707	callbacks will never actually be called (but must be valid nevertheless,	2539	I/O and timer callbacks will never actually be called (but must be valid
1708	because you never know, you know?).	2540	nevertheless, because you never know, you know?).
1709		2541
1710	As another example, the Perl Coro module uses these hooks to integrate	2542	As another example, the Perl Coro module uses these hooks to integrate
1711	coroutines into libev programs, by yielding to other active coroutines	2543	coroutines into libev programs, by yielding to other active coroutines
1712	during each prepare and only letting the process block if no coroutines	2544	during each prepare and only letting the process block if no coroutines
1713	are ready to run (it's actually more complicated: it only runs coroutines	2545	are ready to run (it's actually more complicated: it only runs coroutines
…		…
1716	loop from blocking if lower-priority coroutines are active, thus mapping	2548	loop from blocking if lower-priority coroutines are active, thus mapping
1717	low-priority coroutines to idle/background tasks).	2549	low-priority coroutines to idle/background tasks).
1718		2550
1719	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2551	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1720	priority, to ensure that they are being run before any other watchers	2552	priority, to ensure that they are being run before any other watchers
		2553	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2554
1721	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2555	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1722	too) should not activate ("feed") events into libev. While libev fully	2556	activate ("feed") events into libev. While libev fully supports this, they
1723	supports this, they will be called before other C<ev_check> watchers	2557	might get executed before other C<ev_check> watchers did their job. As
1724	did their job. As C<ev_check> watchers are often used to embed other	2558	C<ev_check> watchers are often used to embed other (non-libev) event
1725	(non-libev) event loops those other event loops might be in an unusable	2559	loops those other event loops might be in an unusable state until their
1726	state until their C<ev_check> watcher ran (always remind yourself to	2560	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1727	coexist peacefully with others).	2561	others).
1728		2562
1729	=head3 Watcher-Specific Functions and Data Members	2563	=head3 Watcher-Specific Functions and Data Members
1730		2564
1731	=over 4	2565	=over 4
1732		2566
…		…
1734		2568
1735	=item ev_check_init (ev_check *, callback)	2569	=item ev_check_init (ev_check *, callback)
1736		2570
1737	Initialises and configures the prepare or check watcher - they have no	2571	Initialises and configures the prepare or check watcher - they have no
1738	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	2572	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1739	macros, but using them is utterly, utterly and completely pointless.	2573	macros, but using them is utterly, utterly, utterly and completely
		2574	pointless.
1740		2575
1741	=back	2576	=back
		2577
		2578	=head3 Examples
1742		2579
1743	There are a number of principal ways to embed other event loops or modules	2580	There are a number of principal ways to embed other event loops or modules
1744	into libev. Here are some ideas on how to include libadns into libev	2581	into libev. Here are some ideas on how to include libadns into libev
1745	(there is a Perl module named C<EV::ADNS> that does this, which you could	2582	(there is a Perl module named C<EV::ADNS> that does this, which you could
1746	use for an actually working example. Another Perl module named C<EV::Glib>	2583	use as a working example. Another Perl module named C<EV::Glib> embeds a
1747	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	2584	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1748	into the Glib event loop).	2585	Glib event loop).
1749		2586
1750	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	2587	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1751	and in a check watcher, destroy them and call into libadns. What follows	2588	and in a check watcher, destroy them and call into libadns. What follows
1752	is pseudo-code only of course. This requires you to either use a low	2589	is pseudo-code only of course. This requires you to either use a low
1753	priority for the check watcher or use C<ev_clear_pending> explicitly, as	2590	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1754	the callbacks for the IO/timeout watchers might not have been called yet.	2591	the callbacks for the IO/timeout watchers might not have been called yet.
1755		2592
1756	static ev_io iow [nfd];	2593	static ev_io iow [nfd];
1757	static ev_timer tw;	2594	static ev_timer tw;
1758		2595
1759	static void	2596	static void
1760	io_cb (ev_loop *loop, ev_io *w, int revents)	2597	io_cb (struct ev_loop *loop, ev_io *w, int revents)
1761	{	2598	{
1762	}	2599	}
1763		2600
1764	// create io watchers for each fd and a timer before blocking	2601	// create io watchers for each fd and a timer before blocking
1765	static void	2602	static void
1766	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2603	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1767	{	2604	{
1768	int timeout = 3600000;	2605	int timeout = 3600000;
1769	struct pollfd fds [nfd];	2606	struct pollfd fds [nfd];
1770	// actual code will need to loop here and realloc etc.	2607	// actual code will need to loop here and realloc etc.
1771	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2608	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1772		2609
1773	/* the callback is illegal, but won't be called as we stop during check */	2610	/* the callback is illegal, but won't be called as we stop during check */
1774	ev_timer_init (&tw, 0, timeout * 1e-3);	2611	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
1775	ev_timer_start (loop, &tw);	2612	ev_timer_start (loop, &tw);
1776		2613
1777	// create one ev_io per pollfd	2614	// create one ev_io per pollfd
1778	for (int i = 0; i < nfd; ++i)	2615	for (int i = 0; i < nfd; ++i)
1779	{	2616	{
1780	ev_io_init (iow + i, io_cb, fds [i].fd,	2617	ev_io_init (iow + i, io_cb, fds [i].fd,
1781	((fds [i].events & POLLIN ? EV_READ : 0)	2618	((fds [i].events & POLLIN ? EV_READ : 0)
1782	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2619	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1783		2620
1784	fds [i].revents = 0;	2621	fds [i].revents = 0;
1785	ev_io_start (loop, iow + i);	2622	ev_io_start (loop, iow + i);
1786	}	2623	}
1787	}	2624	}
1788		2625
1789	// stop all watchers after blocking	2626	// stop all watchers after blocking
1790	static void	2627	static void
1791	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2628	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
1792	{	2629	{
1793	ev_timer_stop (loop, &tw);	2630	ev_timer_stop (loop, &tw);
1794		2631
1795	for (int i = 0; i < nfd; ++i)	2632	for (int i = 0; i < nfd; ++i)
1796	{	2633	{
1797	// set the relevant poll flags	2634	// set the relevant poll flags
1798	// could also call adns_processreadable etc. here	2635	// could also call adns_processreadable etc. here
1799	struct pollfd *fd = fds + i;	2636	struct pollfd *fd = fds + i;
1800	int revents = ev_clear_pending (iow + i);	2637	int revents = ev_clear_pending (iow + i);
1801	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2638	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1802	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2639	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1803		2640
1804	// now stop the watcher	2641	// now stop the watcher
1805	ev_io_stop (loop, iow + i);	2642	ev_io_stop (loop, iow + i);
1806	}	2643	}
1807		2644
1808	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2645	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1809	}	2646	}
1810		2647
1811	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2648	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1812	in the prepare watcher and would dispose of the check watcher.	2649	in the prepare watcher and would dispose of the check watcher.
1813		2650
1814	Method 3: If the module to be embedded supports explicit event	2651	Method 3: If the module to be embedded supports explicit event
1815	notification (adns does), you can also make use of the actual watcher	2652	notification (libadns does), you can also make use of the actual watcher
1816	callbacks, and only destroy/create the watchers in the prepare watcher.	2653	callbacks, and only destroy/create the watchers in the prepare watcher.
1817		2654
1818	static void	2655	static void
1819	timer_cb (EV_P_ ev_timer *w, int revents)	2656	timer_cb (EV_P_ ev_timer *w, int revents)
1820	{	2657	{
1821	adns_state ads = (adns_state)w->data;	2658	adns_state ads = (adns_state)w->data;
1822	update_now (EV_A);	2659	update_now (EV_A);
1823		2660
1824	adns_processtimeouts (ads, &tv_now);	2661	adns_processtimeouts (ads, &tv_now);
1825	}	2662	}
1826		2663
1827	static void	2664	static void
1828	io_cb (EV_P_ ev_io *w, int revents)	2665	io_cb (EV_P_ ev_io *w, int revents)
1829	{	2666	{
1830	adns_state ads = (adns_state)w->data;	2667	adns_state ads = (adns_state)w->data;
1831	update_now (EV_A);	2668	update_now (EV_A);
1832		2669
1833	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2670	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1834	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2671	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1835	}	2672	}
1836		2673
1837	// do not ever call adns_afterpoll	2674	// do not ever call adns_afterpoll
1838		2675
1839	Method 4: Do not use a prepare or check watcher because the module you	2676	Method 4: Do not use a prepare or check watcher because the module you
1840	want to embed is too inflexible to support it. Instead, youc na override	2677	want to embed is not flexible enough to support it. Instead, you can
1841	their poll function. The drawback with this solution is that the main	2678	override their poll function. The drawback with this solution is that the
1842	loop is now no longer controllable by EV. The C<Glib::EV> module does	2679	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
1843	this.	2680	this approach, effectively embedding EV as a client into the horrible
		2681	libglib event loop.
1844		2682
1845	static gint	2683	static gint
1846	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2684	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1847	{	2685	{
1848	int got_events = 0;	2686	int got_events = 0;
1849		2687
1850	for (n = 0; n < nfds; ++n)	2688	for (n = 0; n < nfds; ++n)
1851	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2689	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1852		2690
1853	if (timeout >= 0)	2691	if (timeout >= 0)
1854	// create/start timer	2692	// create/start timer
1855		2693
1856	// poll	2694	// poll
1857	ev_loop (EV_A_ 0);	2695	ev_loop (EV_A_ 0);
1858		2696
1859	// stop timer again	2697	// stop timer again
1860	if (timeout >= 0)	2698	if (timeout >= 0)
1861	ev_timer_stop (EV_A_ &to);	2699	ev_timer_stop (EV_A_ &to);
1862		2700
1863	// stop io watchers again - their callbacks should have set	2701	// stop io watchers again - their callbacks should have set
1864	for (n = 0; n < nfds; ++n)	2702	for (n = 0; n < nfds; ++n)
1865	ev_io_stop (EV_A_ iow [n]);	2703	ev_io_stop (EV_A_ iow [n]);
1866		2704
1867	return got_events;	2705	return got_events;
1868	}	2706	}
1869		2707
1870		2708
1871	=head2 C<ev_embed> - when one backend isn't enough...	2709	=head2 C<ev_embed> - when one backend isn't enough...
1872		2710
1873	This is a rather advanced watcher type that lets you embed one event loop	2711	This is a rather advanced watcher type that lets you embed one event loop
…		…
1879	prioritise I/O.	2717	prioritise I/O.
1880		2718
1881	As an example for a bug workaround, the kqueue backend might only support	2719	As an example for a bug workaround, the kqueue backend might only support
1882	sockets on some platform, so it is unusable as generic backend, but you	2720	sockets on some platform, so it is unusable as generic backend, but you
1883	still want to make use of it because you have many sockets and it scales	2721	still want to make use of it because you have many sockets and it scales
1884	so nicely. In this case, you would create a kqueue-based loop and embed it	2722	so nicely. In this case, you would create a kqueue-based loop and embed
1885	into your default loop (which might use e.g. poll). Overall operation will	2723	it into your default loop (which might use e.g. poll). Overall operation
1886	be a bit slower because first libev has to poll and then call kevent, but	2724	will be a bit slower because first libev has to call C<poll> and then
1887	at least you can use both at what they are best.	2725	C<kevent>, but at least you can use both mechanisms for what they are
		2726	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
1888		2727
1889	As for prioritising I/O: rarely you have the case where some fds have	2728	As for prioritising I/O: under rare circumstances you have the case where
1890	to be watched and handled very quickly (with low latency), and even	2729	some fds have to be watched and handled very quickly (with low latency),
1891	priorities and idle watchers might have too much overhead. In this case	2730	and even priorities and idle watchers might have too much overhead. In
1892	you would put all the high priority stuff in one loop and all the rest in	2731	this case you would put all the high priority stuff in one loop and all
1893	a second one, and embed the second one in the first.	2732	the rest in a second one, and embed the second one in the first.
1894		2733
1895	As long as the watcher is active, the callback will be invoked every time	2734	As long as the watcher is active, the callback will be invoked every
1896	there might be events pending in the embedded loop. The callback must then	2735	time there might be events pending in the embedded loop. The callback
1897	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2736	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
1898	their callbacks (you could also start an idle watcher to give the embedded	2737	sweep and invoke their callbacks (the callback doesn't need to invoke the
1899	loop strictly lower priority for example). You can also set the callback	2738	C<ev_embed_sweep> function directly, it could also start an idle watcher
1900	to C<0>, in which case the embed watcher will automatically execute the	2739	to give the embedded loop strictly lower priority for example).
1901	embedded loop sweep.
1902		2740
1903	As long as the watcher is started it will automatically handle events. The	2741	You can also set the callback to C<0>, in which case the embed watcher
1904	callback will be invoked whenever some events have been handled. You can	2742	will automatically execute the embedded loop sweep whenever necessary.
1905	set the callback to C<0> to avoid having to specify one if you are not
1906	interested in that.
1907		2743
1908	Also, there have not currently been made special provisions for forking:	2744	Fork detection will be handled transparently while the C<ev_embed> watcher
1909	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2745	is active, i.e., the embedded loop will automatically be forked when the
1910	but you will also have to stop and restart any C<ev_embed> watchers	2746	embedding loop forks. In other cases, the user is responsible for calling
1911	yourself.	2747	C<ev_loop_fork> on the embedded loop.
1912		2748
1913	Unfortunately, not all backends are embeddable, only the ones returned by	2749	Unfortunately, not all backends are embeddable: only the ones returned by
1914	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2750	C<ev_embeddable_backends> are, which, unfortunately, does not include any
1915	portable one.	2751	portable one.
1916		2752
1917	So when you want to use this feature you will always have to be prepared	2753	So when you want to use this feature you will always have to be prepared
1918	that you cannot get an embeddable loop. The recommended way to get around	2754	that you cannot get an embeddable loop. The recommended way to get around
1919	this is to have a separate variables for your embeddable loop, try to	2755	this is to have a separate variables for your embeddable loop, try to
1920	create it, and if that fails, use the normal loop for everything:	2756	create it, and if that fails, use the normal loop for everything.
1921		2757
1922	struct ev_loop *loop_hi = ev_default_init (0);	2758	=head3 C<ev_embed> and fork
1923	struct ev_loop *loop_lo = 0;
1924	struct ev_embed embed;
1925
1926	// see if there is a chance of getting one that works
1927	// (remember that a flags value of 0 means autodetection)
1928	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1929	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1930	: 0;
1931		2759
1932	// if we got one, then embed it, otherwise default to loop_hi	2760	While the C<ev_embed> watcher is running, forks in the embedding loop will
1933	if (loop_lo)	2761	automatically be applied to the embedded loop as well, so no special
1934	{	2762	fork handling is required in that case. When the watcher is not running,
1935	ev_embed_init (&embed, 0, loop_lo);	2763	however, it is still the task of the libev user to call C<ev_loop_fork ()>
1936	ev_embed_start (loop_hi, &embed);	2764	as applicable.
1937	}
1938	else
1939	loop_lo = loop_hi;
1940		2765
1941	=head3 Watcher-Specific Functions and Data Members	2766	=head3 Watcher-Specific Functions and Data Members
1942		2767
1943	=over 4	2768	=over 4
1944		2769
…		…
1948		2773
1949	Configures the watcher to embed the given loop, which must be	2774	Configures the watcher to embed the given loop, which must be
1950	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2775	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1951	invoked automatically, otherwise it is the responsibility of the callback	2776	invoked automatically, otherwise it is the responsibility of the callback
1952	to invoke it (it will continue to be called until the sweep has been done,	2777	to invoke it (it will continue to be called until the sweep has been done,
1953	if you do not want thta, you need to temporarily stop the embed watcher).	2778	if you do not want that, you need to temporarily stop the embed watcher).
1954		2779
1955	=item ev_embed_sweep (loop, ev_embed *)	2780	=item ev_embed_sweep (loop, ev_embed *)
1956		2781
1957	Make a single, non-blocking sweep over the embedded loop. This works	2782	Make a single, non-blocking sweep over the embedded loop. This works
1958	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2783	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1959	apropriate way for embedded loops.	2784	appropriate way for embedded loops.
1960		2785
1961	=item struct ev_loop *other [read-only]	2786	=item struct ev_loop *other [read-only]
1962		2787
1963	The embedded event loop.	2788	The embedded event loop.
1964		2789
1965	=back	2790	=back
		2791
		2792	=head3 Examples
		2793
		2794	Example: Try to get an embeddable event loop and embed it into the default
		2795	event loop. If that is not possible, use the default loop. The default
		2796	loop is stored in C<loop_hi>, while the embeddable loop is stored in
		2797	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
		2798	used).
		2799
		2800	struct ev_loop *loop_hi = ev_default_init (0);
		2801	struct ev_loop *loop_lo = 0;
		2802	ev_embed embed;
		2803
		2804	// see if there is a chance of getting one that works
		2805	// (remember that a flags value of 0 means autodetection)
		2806	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
		2807	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
		2808	: 0;
		2809
		2810	// if we got one, then embed it, otherwise default to loop_hi
		2811	if (loop_lo)
		2812	{
		2813	ev_embed_init (&embed, 0, loop_lo);
		2814	ev_embed_start (loop_hi, &embed);
		2815	}
		2816	else
		2817	loop_lo = loop_hi;
		2818
		2819	Example: Check if kqueue is available but not recommended and create
		2820	a kqueue backend for use with sockets (which usually work with any
		2821	kqueue implementation). Store the kqueue/socket-only event loop in
		2822	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
		2823
		2824	struct ev_loop *loop = ev_default_init (0);
		2825	struct ev_loop *loop_socket = 0;
		2826	ev_embed embed;
		2827
		2828	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
		2829	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
		2830	{
		2831	ev_embed_init (&embed, 0, loop_socket);
		2832	ev_embed_start (loop, &embed);
		2833	}
		2834
		2835	if (!loop_socket)
		2836	loop_socket = loop;
		2837
		2838	// now use loop_socket for all sockets, and loop for everything else
1966		2839
1967		2840
1968	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2841	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1969		2842
1970	Fork watchers are called when a C<fork ()> was detected (usually because	2843	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
1973	event loop blocks next and before C<ev_check> watchers are being called,	2846	event loop blocks next and before C<ev_check> watchers are being called,
1974	and only in the child after the fork. If whoever good citizen calling	2847	and only in the child after the fork. If whoever good citizen calling
1975	C<ev_default_fork> cheats and calls it in the wrong process, the fork	2848	C<ev_default_fork> cheats and calls it in the wrong process, the fork
1976	handlers will be invoked, too, of course.	2849	handlers will be invoked, too, of course.
1977		2850
		2851	=head3 The special problem of life after fork - how is it possible?
		2852
		2853	Most uses of C<fork()> consist of forking, then some simple calls to ste
		2854	up/change the process environment, followed by a call to C<exec()>. This
		2855	sequence should be handled by libev without any problems.
		2856
		2857	This changes when the application actually wants to do event handling
		2858	in the child, or both parent in child, in effect "continuing" after the
		2859	fork.
		2860
		2861	The default mode of operation (for libev, with application help to detect
		2862	forks) is to duplicate all the state in the child, as would be expected
		2863	when I<either> the parent I<or> the child process continues.
		2864
		2865	When both processes want to continue using libev, then this is usually the
		2866	wrong result. In that case, usually one process (typically the parent) is
		2867	supposed to continue with all watchers in place as before, while the other
		2868	process typically wants to start fresh, i.e. without any active watchers.
		2869
		2870	The cleanest and most efficient way to achieve that with libev is to
		2871	simply create a new event loop, which of course will be "empty", and
		2872	use that for new watchers. This has the advantage of not touching more
		2873	memory than necessary, and thus avoiding the copy-on-write, and the
		2874	disadvantage of having to use multiple event loops (which do not support
		2875	signal watchers).
		2876
		2877	When this is not possible, or you want to use the default loop for
		2878	other reasons, then in the process that wants to start "fresh", call
		2879	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
		2880	the default loop will "orphan" (not stop) all registered watchers, so you
		2881	have to be careful not to execute code that modifies those watchers. Note
		2882	also that in that case, you have to re-register any signal watchers.
		2883
1978	=head3 Watcher-Specific Functions and Data Members	2884	=head3 Watcher-Specific Functions and Data Members
1979		2885
1980	=over 4	2886	=over 4
1981		2887
1982	=item ev_fork_init (ev_signal *, callback)	2888	=item ev_fork_init (ev_signal *, callback)
…		…
1986	believe me.	2892	believe me.
1987		2893
1988	=back	2894	=back
1989		2895
1990		2896
		2897	=head2 C<ev_async> - how to wake up another event loop
		2898
		2899	In general, you cannot use an C<ev_loop> from multiple threads or other
		2900	asynchronous sources such as signal handlers (as opposed to multiple event
		2901	loops - those are of course safe to use in different threads).
		2902
		2903	Sometimes, however, you need to wake up another event loop you do not
		2904	control, for example because it belongs to another thread. This is what
		2905	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2906	can signal it by calling C<ev_async_send>, which is thread- and signal
		2907	safe.
		2908
		2909	This functionality is very similar to C<ev_signal> watchers, as signals,
		2910	too, are asynchronous in nature, and signals, too, will be compressed
		2911	(i.e. the number of callback invocations may be less than the number of
		2912	C<ev_async_sent> calls).
		2913
		2914	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2915	just the default loop.
		2916
		2917	=head3 Queueing
		2918
		2919	C<ev_async> does not support queueing of data in any way. The reason
		2920	is that the author does not know of a simple (or any) algorithm for a
		2921	multiple-writer-single-reader queue that works in all cases and doesn't
		2922	need elaborate support such as pthreads.
		2923
		2924	That means that if you want to queue data, you have to provide your own
		2925	queue. But at least I can tell you how to implement locking around your
		2926	queue:
		2927
		2928	=over 4
		2929
		2930	=item queueing from a signal handler context
		2931
		2932	To implement race-free queueing, you simply add to the queue in the signal
		2933	handler but you block the signal handler in the watcher callback. Here is
		2934	an example that does that for some fictitious SIGUSR1 handler:
		2935
		2936	static ev_async mysig;
		2937
		2938	static void
		2939	sigusr1_handler (void)
		2940	{
		2941	sometype data;
		2942
		2943	// no locking etc.
		2944	queue_put (data);
		2945	ev_async_send (EV_DEFAULT_ &mysig);
		2946	}
		2947
		2948	static void
		2949	mysig_cb (EV_P_ ev_async *w, int revents)
		2950	{
		2951	sometype data;
		2952	sigset_t block, prev;
		2953
		2954	sigemptyset (&block);
		2955	sigaddset (&block, SIGUSR1);
		2956	sigprocmask (SIG_BLOCK, &block, &prev);
		2957
		2958	while (queue_get (&data))
		2959	process (data);
		2960
		2961	if (sigismember (&prev, SIGUSR1)
		2962	sigprocmask (SIG_UNBLOCK, &block, 0);
		2963	}
		2964
		2965	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2966	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2967	either...).
		2968
		2969	=item queueing from a thread context
		2970
		2971	The strategy for threads is different, as you cannot (easily) block
		2972	threads but you can easily preempt them, so to queue safely you need to
		2973	employ a traditional mutex lock, such as in this pthread example:
		2974
		2975	static ev_async mysig;
		2976	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2977
		2978	static void
		2979	otherthread (void)
		2980	{
		2981	// only need to lock the actual queueing operation
		2982	pthread_mutex_lock (&mymutex);
		2983	queue_put (data);
		2984	pthread_mutex_unlock (&mymutex);
		2985
		2986	ev_async_send (EV_DEFAULT_ &mysig);
		2987	}
		2988
		2989	static void
		2990	mysig_cb (EV_P_ ev_async *w, int revents)
		2991	{
		2992	pthread_mutex_lock (&mymutex);
		2993
		2994	while (queue_get (&data))
		2995	process (data);
		2996
		2997	pthread_mutex_unlock (&mymutex);
		2998	}
		2999
		3000	=back
		3001
		3002
		3003	=head3 Watcher-Specific Functions and Data Members
		3004
		3005	=over 4
		3006
		3007	=item ev_async_init (ev_async *, callback)
		3008
		3009	Initialises and configures the async watcher - it has no parameters of any
		3010	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
		3011	trust me.
		3012
		3013	=item ev_async_send (loop, ev_async *)
		3014
		3015	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		3016	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		3017	C<ev_feed_event>, this call is safe to do from other threads, signal or
		3018	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
		3019	section below on what exactly this means).
		3020
		3021	Note that, as with other watchers in libev, multiple events might get
		3022	compressed into a single callback invocation (another way to look at this
		3023	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		3024	reset when the event loop detects that).
		3025
		3026	This call incurs the overhead of a system call only once per event loop
		3027	iteration, so while the overhead might be noticeable, it doesn't apply to
		3028	repeated calls to C<ev_async_send> for the same event loop.
		3029
		3030	=item bool = ev_async_pending (ev_async *)
		3031
		3032	Returns a non-zero value when C<ev_async_send> has been called on the
		3033	watcher but the event has not yet been processed (or even noted) by the
		3034	event loop.
		3035
		3036	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		3037	the loop iterates next and checks for the watcher to have become active,
		3038	it will reset the flag again. C<ev_async_pending> can be used to very
		3039	quickly check whether invoking the loop might be a good idea.
		3040
		3041	Not that this does I<not> check whether the watcher itself is pending,
		3042	only whether it has been requested to make this watcher pending: there
		3043	is a time window between the event loop checking and resetting the async
		3044	notification, and the callback being invoked.
		3045
		3046	=back
		3047
		3048
1991	=head1 OTHER FUNCTIONS	3049	=head1 OTHER FUNCTIONS
1992		3050
1993	There are some other functions of possible interest. Described. Here. Now.	3051	There are some other functions of possible interest. Described. Here. Now.
1994		3052
1995	=over 4	3053	=over 4
1996		3054
1997	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	3055	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
1998		3056
1999	This function combines a simple timer and an I/O watcher, calls your	3057	This function combines a simple timer and an I/O watcher, calls your
2000	callback on whichever event happens first and automatically stop both	3058	callback on whichever event happens first and automatically stops both
2001	watchers. This is useful if you want to wait for a single event on an fd	3059	watchers. This is useful if you want to wait for a single event on an fd
2002	or timeout without having to allocate/configure/start/stop/free one or	3060	or timeout without having to allocate/configure/start/stop/free one or
2003	more watchers yourself.	3061	more watchers yourself.
2004		3062
2005	If C<fd> is less than 0, then no I/O watcher will be started and events	3063	If C<fd> is less than 0, then no I/O watcher will be started and the
2006	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	3064	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2007	C<events> set will be craeted and started.	3065	the given C<fd> and C<events> set will be created and started.
2008		3066
2009	If C<timeout> is less than 0, then no timeout watcher will be	3067	If C<timeout> is less than 0, then no timeout watcher will be
2010	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3068	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2011	repeat = 0) will be started. While C<0> is a valid timeout, it is of	3069	repeat = 0) will be started. C<0> is a valid timeout.
2012	dubious value.
2013		3070
2014	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3071	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2015	passed an C<revents> set like normal event callbacks (a combination of	3072	passed an C<revents> set like normal event callbacks (a combination of
2016	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3073	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2017	value passed to C<ev_once>:	3074	value passed to C<ev_once>. Note that it is possible to receive I<both>
		3075	a timeout and an io event at the same time - you probably should give io
		3076	events precedence.
2018		3077
		3078	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
		3079
2019	static void stdin_ready (int revents, void *arg)	3080	static void stdin_ready (int revents, void *arg)
2020	{	3081	{
2021	if (revents & EV_TIMEOUT)
2022	/* doh, nothing entered */;
2023	else if (revents & EV_READ)	3082	if (revents & EV_READ)
2024	/* stdin might have data for us, joy! */;	3083	/* stdin might have data for us, joy! */;
		3084	else if (revents & EV_TIMEOUT)
		3085	/* doh, nothing entered */;
2025	}	3086	}
2026		3087
2027	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3088	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2028		3089
2029	=item ev_feed_event (ev_loop *, watcher *, int revents)	3090	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2030		3091
2031	Feeds the given event set into the event loop, as if the specified event	3092	Feeds the given event set into the event loop, as if the specified event
2032	had happened for the specified watcher (which must be a pointer to an	3093	had happened for the specified watcher (which must be a pointer to an
2033	initialised but not necessarily started event watcher).	3094	initialised but not necessarily started event watcher).
2034		3095
2035	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	3096	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2036		3097
2037	Feed an event on the given fd, as if a file descriptor backend detected	3098	Feed an event on the given fd, as if a file descriptor backend detected
2038	the given events it.	3099	the given events it.
2039		3100
2040	=item ev_feed_signal_event (ev_loop *loop, int signum)	3101	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2041		3102
2042	Feed an event as if the given signal occured (C<loop> must be the default	3103	Feed an event as if the given signal occurred (C<loop> must be the default
2043	loop!).	3104	loop!).
2044		3105
2045	=back	3106	=back
2046		3107
2047		3108
…		…
2063		3124
2064	=item * Priorities are not currently supported. Initialising priorities	3125	=item * Priorities are not currently supported. Initialising priorities
2065	will fail and all watchers will have the same priority, even though there	3126	will fail and all watchers will have the same priority, even though there
2066	is an ev_pri field.	3127	is an ev_pri field.
2067		3128
		3129	=item * In libevent, the last base created gets the signals, in libev, the
		3130	first base created (== the default loop) gets the signals.
		3131
2068	=item * Other members are not supported.	3132	=item * Other members are not supported.
2069		3133
2070	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3134	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2071	to use the libev header file and library.	3135	to use the libev header file and library.
2072		3136
2073	=back	3137	=back
2074		3138
2075	=head1 C++ SUPPORT	3139	=head1 C++ SUPPORT
2076		3140
2077	Libev comes with some simplistic wrapper classes for C++ that mainly allow	3141	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2078	you to use some convinience methods to start/stop watchers and also change	3142	you to use some convenience methods to start/stop watchers and also change
2079	the callback model to a model using method callbacks on objects.	3143	the callback model to a model using method callbacks on objects.
2080		3144
2081	To use it,	3145	To use it,
2082		3146
2083	#include <ev++.h>	3147	#include <ev++.h>
2084		3148
2085	This automatically includes F<ev.h> and puts all of its definitions (many	3149	This automatically includes F<ev.h> and puts all of its definitions (many
2086	of them macros) into the global namespace. All C++ specific things are	3150	of them macros) into the global namespace. All C++ specific things are
2087	put into the C<ev> namespace. It should support all the same embedding	3151	put into the C<ev> namespace. It should support all the same embedding
2088	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	3152	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2155	your compiler is good :), then the method will be fully inlined into the	3219	your compiler is good :), then the method will be fully inlined into the
2156	thunking function, making it as fast as a direct C callback.	3220	thunking function, making it as fast as a direct C callback.
2157		3221
2158	Example: simple class declaration and watcher initialisation	3222	Example: simple class declaration and watcher initialisation
2159		3223
2160	struct myclass	3224	struct myclass
2161	{	3225	{
2162	void io_cb (ev::io &w, int revents) { }	3226	void io_cb (ev::io &w, int revents) { }
2163	}	3227	}
2164		3228
2165	myclass obj;	3229	myclass obj;
2166	ev::io iow;	3230	ev::io iow;
2167	iow.set <myclass, &myclass::io_cb> (&obj);	3231	iow.set <myclass, &myclass::io_cb> (&obj);
		3232
		3233	=item w->set (object *)
		3234
		3235	This is an B<experimental> feature that might go away in a future version.
		3236
		3237	This is a variation of a method callback - leaving out the method to call
		3238	will default the method to C<operator ()>, which makes it possible to use
		3239	functor objects without having to manually specify the C<operator ()> all
		3240	the time. Incidentally, you can then also leave out the template argument
		3241	list.
		3242
		3243	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3244	int revents)>.
		3245
		3246	See the method-C<set> above for more details.
		3247
		3248	Example: use a functor object as callback.
		3249
		3250	struct myfunctor
		3251	{
		3252	void operator() (ev::io &w, int revents)
		3253	{
		3254	...
		3255	}
		3256	}
		3257
		3258	myfunctor f;
		3259
		3260	ev::io w;
		3261	w.set (&f);
2168		3262
2169	=item w->set<function> (void *data = 0)	3263	=item w->set<function> (void *data = 0)
2170		3264
2171	Also sets a callback, but uses a static method or plain function as	3265	Also sets a callback, but uses a static method or plain function as
2172	callback. The optional C<data> argument will be stored in the watcher's	3266	callback. The optional C<data> argument will be stored in the watcher's
…		…
2174		3268
2175	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	3269	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2176		3270
2177	See the method-C<set> above for more details.	3271	See the method-C<set> above for more details.
2178		3272
2179	Example:	3273	Example: Use a plain function as callback.
2180		3274
2181	static void io_cb (ev::io &w, int revents) { }	3275	static void io_cb (ev::io &w, int revents) { }
2182	iow.set <io_cb> ();	3276	iow.set <io_cb> ();
2183		3277
2184	=item w->set (struct ev_loop *)	3278	=item w->set (struct ev_loop *)
2185		3279
2186	Associates a different C<struct ev_loop> with this watcher. You can only	3280	Associates a different C<struct ev_loop> with this watcher. You can only
2187	do this when the watcher is inactive (and not pending either).	3281	do this when the watcher is inactive (and not pending either).
2188		3282
2189	=item w->set ([args])	3283	=item w->set ([arguments])
2190		3284
2191	Basically the same as C<ev_TYPE_set>, with the same args. Must be	3285	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2192	called at least once. Unlike the C counterpart, an active watcher gets	3286	called at least once. Unlike the C counterpart, an active watcher gets
2193	automatically stopped and restarted when reconfiguring it with this	3287	automatically stopped and restarted when reconfiguring it with this
2194	method.	3288	method.
2195		3289
2196	=item w->start ()	3290	=item w->start ()
…		…
2220	=back	3314	=back
2221		3315
2222	Example: Define a class with an IO and idle watcher, start one of them in	3316	Example: Define a class with an IO and idle watcher, start one of them in
2223	the constructor.	3317	the constructor.
2224		3318
2225	class myclass	3319	class myclass
2226	{	3320	{
2227	ev_io io; void io_cb (ev::io &w, int revents);	3321	ev::io io ; void io_cb (ev::io &w, int revents);
2228	ev_idle idle void idle_cb (ev::idle &w, int revents);	3322	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2229		3323
2230	myclass ();	3324	myclass (int fd)
2231	}	3325	{
2232
2233	myclass::myclass (int fd)
2234	{
2235	io .set <myclass, &myclass::io_cb > (this);	3326	io .set <myclass, &myclass::io_cb > (this);
2236	idle.set <myclass, &myclass::idle_cb> (this);	3327	idle.set <myclass, &myclass::idle_cb> (this);
2237		3328
2238	io.start (fd, ev::READ);	3329	io.start (fd, ev::READ);
		3330	}
2239	}	3331	};
		3332
		3333
		3334	=head1 OTHER LANGUAGE BINDINGS
		3335
		3336	Libev does not offer other language bindings itself, but bindings for a
		3337	number of languages exist in the form of third-party packages. If you know
		3338	any interesting language binding in addition to the ones listed here, drop
		3339	me a note.
		3340
		3341	=over 4
		3342
		3343	=item Perl
		3344
		3345	The EV module implements the full libev API and is actually used to test
		3346	libev. EV is developed together with libev. Apart from the EV core module,
		3347	there are additional modules that implement libev-compatible interfaces
		3348	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
		3349	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3350	and C<EV::Glib>).
		3351
		3352	It can be found and installed via CPAN, its homepage is at
		3353	L<http://software.schmorp.de/pkg/EV>.
		3354
		3355	=item Python
		3356
		3357	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		3358	seems to be quite complete and well-documented.
		3359
		3360	=item Ruby
		3361
		3362	Tony Arcieri has written a ruby extension that offers access to a subset
		3363	of the libev API and adds file handle abstractions, asynchronous DNS and
		3364	more on top of it. It can be found via gem servers. Its homepage is at
		3365	L<http://rev.rubyforge.org/>.
		3366
		3367	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3368	makes rev work even on mingw.
		3369
		3370	=item Haskell
		3371
		3372	A haskell binding to libev is available at
		3373	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3374
		3375	=item D
		3376
		3377	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		3378	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3379
		3380	=item Ocaml
		3381
		3382	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3383	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		3384
		3385	=back
2240		3386
2241		3387
2242	=head1 MACRO MAGIC	3388	=head1 MACRO MAGIC
2243		3389
2244	Libev can be compiled with a variety of options, the most fundamantal	3390	Libev can be compiled with a variety of options, the most fundamental
2245	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	3391	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2246	functions and callbacks have an initial C<struct ev_loop *> argument.	3392	functions and callbacks have an initial C<struct ev_loop *> argument.
2247		3393
2248	To make it easier to write programs that cope with either variant, the	3394	To make it easier to write programs that cope with either variant, the
2249	following macros are defined:	3395	following macros are defined:
…		…
2254		3400
2255	This provides the loop I<argument> for functions, if one is required ("ev	3401	This provides the loop I<argument> for functions, if one is required ("ev
2256	loop argument"). The C<EV_A> form is used when this is the sole argument,	3402	loop argument"). The C<EV_A> form is used when this is the sole argument,
2257	C<EV_A_> is used when other arguments are following. Example:	3403	C<EV_A_> is used when other arguments are following. Example:
2258		3404
2259	ev_unref (EV_A);	3405	ev_unref (EV_A);
2260	ev_timer_add (EV_A_ watcher);	3406	ev_timer_add (EV_A_ watcher);
2261	ev_loop (EV_A_ 0);	3407	ev_loop (EV_A_ 0);
2262		3408
2263	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3409	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2264	which is often provided by the following macro.	3410	which is often provided by the following macro.
2265		3411
2266	=item C<EV_P>, C<EV_P_>	3412	=item C<EV_P>, C<EV_P_>
2267		3413
2268	This provides the loop I<parameter> for functions, if one is required ("ev	3414	This provides the loop I<parameter> for functions, if one is required ("ev
2269	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	3415	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2270	C<EV_P_> is used when other parameters are following. Example:	3416	C<EV_P_> is used when other parameters are following. Example:
2271		3417
2272	// this is how ev_unref is being declared	3418	// this is how ev_unref is being declared
2273	static void ev_unref (EV_P);	3419	static void ev_unref (EV_P);
2274		3420
2275	// this is how you can declare your typical callback	3421	// this is how you can declare your typical callback
2276	static void cb (EV_P_ ev_timer *w, int revents)	3422	static void cb (EV_P_ ev_timer *w, int revents)
2277		3423
2278	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	3424	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2279	suitable for use with C<EV_A>.	3425	suitable for use with C<EV_A>.
2280		3426
2281	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	3427	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2282		3428
2283	Similar to the other two macros, this gives you the value of the default	3429	Similar to the other two macros, this gives you the value of the default
2284	loop, if multiple loops are supported ("ev loop default").	3430	loop, if multiple loops are supported ("ev loop default").
		3431
		3432	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		3433
		3434	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		3435	default loop has been initialised (C<UC> == unchecked). Their behaviour
		3436	is undefined when the default loop has not been initialised by a previous
		3437	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		3438
		3439	It is often prudent to use C<EV_DEFAULT> when initialising the first
		3440	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2285		3441
2286	=back	3442	=back
2287		3443
2288	Example: Declare and initialise a check watcher, utilising the above	3444	Example: Declare and initialise a check watcher, utilising the above
2289	macros so it will work regardless of whether multiple loops are supported	3445	macros so it will work regardless of whether multiple loops are supported
2290	or not.	3446	or not.
2291		3447
2292	static void	3448	static void
2293	check_cb (EV_P_ ev_timer *w, int revents)	3449	check_cb (EV_P_ ev_timer *w, int revents)
2294	{	3450	{
2295	ev_check_stop (EV_A_ w);	3451	ev_check_stop (EV_A_ w);
2296	}	3452	}
2297		3453
2298	ev_check check;	3454	ev_check check;
2299	ev_check_init (&check, check_cb);	3455	ev_check_init (&check, check_cb);
2300	ev_check_start (EV_DEFAULT_ &check);	3456	ev_check_start (EV_DEFAULT_ &check);
2301	ev_loop (EV_DEFAULT_ 0);	3457	ev_loop (EV_DEFAULT_ 0);
2302		3458
2303	=head1 EMBEDDING	3459	=head1 EMBEDDING
2304		3460
2305	Libev can (and often is) directly embedded into host	3461	Libev can (and often is) directly embedded into host
2306	applications. Examples of applications that embed it include the Deliantra	3462	applications. Examples of applications that embed it include the Deliantra
…		…
2313	libev somewhere in your source tree).	3469	libev somewhere in your source tree).
2314		3470
2315	=head2 FILESETS	3471	=head2 FILESETS
2316		3472
2317	Depending on what features you need you need to include one or more sets of files	3473	Depending on what features you need you need to include one or more sets of files
2318	in your app.	3474	in your application.
2319		3475
2320	=head3 CORE EVENT LOOP	3476	=head3 CORE EVENT LOOP
2321		3477
2322	To include only the libev core (all the C<ev_*> functions), with manual	3478	To include only the libev core (all the C<ev_*> functions), with manual
2323	configuration (no autoconf):	3479	configuration (no autoconf):
2324		3480
2325	#define EV_STANDALONE 1	3481	#define EV_STANDALONE 1
2326	#include "ev.c"	3482	#include "ev.c"
2327		3483
2328	This will automatically include F<ev.h>, too, and should be done in a	3484	This will automatically include F<ev.h>, too, and should be done in a
2329	single C source file only to provide the function implementations. To use	3485	single C source file only to provide the function implementations. To use
2330	it, do the same for F<ev.h> in all files wishing to use this API (best	3486	it, do the same for F<ev.h> in all files wishing to use this API (best
2331	done by writing a wrapper around F<ev.h> that you can include instead and	3487	done by writing a wrapper around F<ev.h> that you can include instead and
2332	where you can put other configuration options):	3488	where you can put other configuration options):
2333		3489
2334	#define EV_STANDALONE 1	3490	#define EV_STANDALONE 1
2335	#include "ev.h"	3491	#include "ev.h"
2336		3492
2337	Both header files and implementation files can be compiled with a C++	3493	Both header files and implementation files can be compiled with a C++
2338	compiler (at least, thats a stated goal, and breakage will be treated	3494	compiler (at least, that's a stated goal, and breakage will be treated
2339	as a bug).	3495	as a bug).
2340		3496
2341	You need the following files in your source tree, or in a directory	3497	You need the following files in your source tree, or in a directory
2342	in your include path (e.g. in libev/ when using -Ilibev):	3498	in your include path (e.g. in libev/ when using -Ilibev):
2343		3499
2344	ev.h	3500	ev.h
2345	ev.c	3501	ev.c
2346	ev_vars.h	3502	ev_vars.h
2347	ev_wrap.h	3503	ev_wrap.h
2348		3504
2349	ev_win32.c required on win32 platforms only	3505	ev_win32.c required on win32 platforms only
2350		3506
2351	ev_select.c only when select backend is enabled (which is enabled by default)	3507	ev_select.c only when select backend is enabled (which is enabled by default)
2352	ev_poll.c only when poll backend is enabled (disabled by default)	3508	ev_poll.c only when poll backend is enabled (disabled by default)
2353	ev_epoll.c only when the epoll backend is enabled (disabled by default)	3509	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2354	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	3510	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2355	ev_port.c only when the solaris port backend is enabled (disabled by default)	3511	ev_port.c only when the solaris port backend is enabled (disabled by default)
2356		3512
2357	F<ev.c> includes the backend files directly when enabled, so you only need	3513	F<ev.c> includes the backend files directly when enabled, so you only need
2358	to compile this single file.	3514	to compile this single file.
2359		3515
2360	=head3 LIBEVENT COMPATIBILITY API	3516	=head3 LIBEVENT COMPATIBILITY API
2361		3517
2362	To include the libevent compatibility API, also include:	3518	To include the libevent compatibility API, also include:
2363		3519
2364	#include "event.c"	3520	#include "event.c"
2365		3521
2366	in the file including F<ev.c>, and:	3522	in the file including F<ev.c>, and:
2367		3523
2368	#include "event.h"	3524	#include "event.h"
2369		3525
2370	in the files that want to use the libevent API. This also includes F<ev.h>.	3526	in the files that want to use the libevent API. This also includes F<ev.h>.
2371		3527
2372	You need the following additional files for this:	3528	You need the following additional files for this:
2373		3529
2374	event.h	3530	event.h
2375	event.c	3531	event.c
2376		3532
2377	=head3 AUTOCONF SUPPORT	3533	=head3 AUTOCONF SUPPORT
2378		3534
2379	Instead of using C<EV_STANDALONE=1> and providing your config in	3535	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2380	whatever way you want, you can also C<m4_include([libev.m4])> in your	3536	whatever way you want, you can also C<m4_include([libev.m4])> in your
2381	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	3537	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2382	include F<config.h> and configure itself accordingly.	3538	include F<config.h> and configure itself accordingly.
2383		3539
2384	For this of course you need the m4 file:	3540	For this of course you need the m4 file:
2385		3541
2386	libev.m4	3542	libev.m4
2387		3543
2388	=head2 PREPROCESSOR SYMBOLS/MACROS	3544	=head2 PREPROCESSOR SYMBOLS/MACROS
2389		3545
2390	Libev can be configured via a variety of preprocessor symbols you have to define	3546	Libev can be configured via a variety of preprocessor symbols you have to
2391	before including any of its files. The default is not to build for multiplicity	3547	define before including any of its files. The default in the absence of
2392	and only include the select backend.	3548	autoconf is documented for every option.
2393		3549
2394	=over 4	3550	=over 4
2395		3551
2396	=item EV_STANDALONE	3552	=item EV_STANDALONE
2397		3553
…		…
2399	keeps libev from including F<config.h>, and it also defines dummy	3555	keeps libev from including F<config.h>, and it also defines dummy
2400	implementations for some libevent functions (such as logging, which is not	3556	implementations for some libevent functions (such as logging, which is not
2401	supported). It will also not define any of the structs usually found in	3557	supported). It will also not define any of the structs usually found in
2402	F<event.h> that are not directly supported by the libev core alone.	3558	F<event.h> that are not directly supported by the libev core alone.
2403		3559
		3560	In stanbdalone mode, libev will still try to automatically deduce the
		3561	configuration, but has to be more conservative.
		3562
2404	=item EV_USE_MONOTONIC	3563	=item EV_USE_MONOTONIC
2405		3564
2406	If defined to be C<1>, libev will try to detect the availability of the	3565	If defined to be C<1>, libev will try to detect the availability of the
2407	monotonic clock option at both compiletime and runtime. Otherwise no use	3566	monotonic clock option at both compile time and runtime. Otherwise no
2408	of the monotonic clock option will be attempted. If you enable this, you	3567	use of the monotonic clock option will be attempted. If you enable this,
2409	usually have to link against librt or something similar. Enabling it when	3568	you usually have to link against librt or something similar. Enabling it
2410	the functionality isn't available is safe, though, although you have	3569	when the functionality isn't available is safe, though, although you have
2411	to make sure you link against any libraries where the C<clock_gettime>	3570	to make sure you link against any libraries where the C<clock_gettime>
2412	function is hiding in (often F<-lrt>).	3571	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2413		3572
2414	=item EV_USE_REALTIME	3573	=item EV_USE_REALTIME
2415		3574
2416	If defined to be C<1>, libev will try to detect the availability of the	3575	If defined to be C<1>, libev will try to detect the availability of the
2417	realtime clock option at compiletime (and assume its availability at	3576	real-time clock option at compile time (and assume its availability
2418	runtime if successful). Otherwise no use of the realtime clock option will	3577	at runtime if successful). Otherwise no use of the real-time clock
2419	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3578	option will be attempted. This effectively replaces C<gettimeofday>
2420	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3579	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2421	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3580	correctness. See the note about libraries in the description of
		3581	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3582	C<EV_USE_CLOCK_SYSCALL>.
		3583
		3584	=item EV_USE_CLOCK_SYSCALL
		3585
		3586	If defined to be C<1>, libev will try to use a direct syscall instead
		3587	of calling the system-provided C<clock_gettime> function. This option
		3588	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3589	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3590	programs needlessly. Using a direct syscall is slightly slower (in
		3591	theory), because no optimised vdso implementation can be used, but avoids
		3592	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3593	higher, as it simplifies linking (no need for C<-lrt>).
2422		3594
2423	=item EV_USE_NANOSLEEP	3595	=item EV_USE_NANOSLEEP
2424		3596
2425	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3597	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2426	and will use it for delays. Otherwise it will use C<select ()>.	3598	and will use it for delays. Otherwise it will use C<select ()>.
2427		3599
		3600	=item EV_USE_EVENTFD
		3601
		3602	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		3603	available and will probe for kernel support at runtime. This will improve
		3604	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		3605	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		3606	2.7 or newer, otherwise disabled.
		3607
2428	=item EV_USE_SELECT	3608	=item EV_USE_SELECT
2429		3609
2430	If undefined or defined to be C<1>, libev will compile in support for the	3610	If undefined or defined to be C<1>, libev will compile in support for the
2431	C<select>(2) backend. No attempt at autodetection will be done: if no	3611	C<select>(2) backend. No attempt at auto-detection will be done: if no
2432	other method takes over, select will be it. Otherwise the select backend	3612	other method takes over, select will be it. Otherwise the select backend
2433	will not be compiled in.	3613	will not be compiled in.
2434		3614
2435	=item EV_SELECT_USE_FD_SET	3615	=item EV_SELECT_USE_FD_SET
2436		3616
2437	If defined to C<1>, then the select backend will use the system C<fd_set>	3617	If defined to C<1>, then the select backend will use the system C<fd_set>
2438	structure. This is useful if libev doesn't compile due to a missing	3618	structure. This is useful if libev doesn't compile due to a missing
2439	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	3619	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
2440	exotic systems. This usually limits the range of file descriptors to some	3620	on exotic systems. This usually limits the range of file descriptors to
2441	low limit such as 1024 or might have other limitations (winsocket only	3621	some low limit such as 1024 or might have other limitations (winsocket
2442	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3622	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2443	influence the size of the C<fd_set> used.	3623	configures the maximum size of the C<fd_set>.
2444		3624
2445	=item EV_SELECT_IS_WINSOCKET	3625	=item EV_SELECT_IS_WINSOCKET
2446		3626
2447	When defined to C<1>, the select backend will assume that	3627	When defined to C<1>, the select backend will assume that
2448	select/socket/connect etc. don't understand file descriptors but	3628	select/socket/connect etc. don't understand file descriptors but
…		…
2450	be used is the winsock select). This means that it will call	3630	be used is the winsock select). This means that it will call
2451	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	3631	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2452	it is assumed that all these functions actually work on fds, even	3632	it is assumed that all these functions actually work on fds, even
2453	on win32. Should not be defined on non-win32 platforms.	3633	on win32. Should not be defined on non-win32 platforms.
2454		3634
		3635	=item EV_FD_TO_WIN32_HANDLE
		3636
		3637	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
		3638	file descriptors to socket handles. When not defining this symbol (the
		3639	default), then libev will call C<_get_osfhandle>, which is usually
		3640	correct. In some cases, programs use their own file descriptor management,
		3641	in which case they can provide this function to map fds to socket handles.
		3642
2455	=item EV_USE_POLL	3643	=item EV_USE_POLL
2456		3644
2457	If defined to be C<1>, libev will compile in support for the C<poll>(2)	3645	If defined to be C<1>, libev will compile in support for the C<poll>(2)
2458	backend. Otherwise it will be enabled on non-win32 platforms. It	3646	backend. Otherwise it will be enabled on non-win32 platforms. It
2459	takes precedence over select.	3647	takes precedence over select.
2460		3648
2461	=item EV_USE_EPOLL	3649	=item EV_USE_EPOLL
2462		3650
2463	If defined to be C<1>, libev will compile in support for the Linux	3651	If defined to be C<1>, libev will compile in support for the Linux
2464	C<epoll>(7) backend. Its availability will be detected at runtime,	3652	C<epoll>(7) backend. Its availability will be detected at runtime,
2465	otherwise another method will be used as fallback. This is the	3653	otherwise another method will be used as fallback. This is the preferred
2466	preferred backend for GNU/Linux systems.	3654	backend for GNU/Linux systems. If undefined, it will be enabled if the
		3655	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2467		3656
2468	=item EV_USE_KQUEUE	3657	=item EV_USE_KQUEUE
2469		3658
2470	If defined to be C<1>, libev will compile in support for the BSD style	3659	If defined to be C<1>, libev will compile in support for the BSD style
2471	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	3660	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2484	otherwise another method will be used as fallback. This is the preferred	3673	otherwise another method will be used as fallback. This is the preferred
2485	backend for Solaris 10 systems.	3674	backend for Solaris 10 systems.
2486		3675
2487	=item EV_USE_DEVPOLL	3676	=item EV_USE_DEVPOLL
2488		3677
2489	reserved for future expansion, works like the USE symbols above.	3678	Reserved for future expansion, works like the USE symbols above.
2490		3679
2491	=item EV_USE_INOTIFY	3680	=item EV_USE_INOTIFY
2492		3681
2493	If defined to be C<1>, libev will compile in support for the Linux inotify	3682	If defined to be C<1>, libev will compile in support for the Linux inotify
2494	interface to speed up C<ev_stat> watchers. Its actual availability will	3683	interface to speed up C<ev_stat> watchers. Its actual availability will
2495	be detected at runtime.	3684	be detected at runtime. If undefined, it will be enabled if the headers
		3685	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		3686
		3687	=item EV_ATOMIC_T
		3688
		3689	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		3690	access is atomic with respect to other threads or signal contexts. No such
		3691	type is easily found in the C language, so you can provide your own type
		3692	that you know is safe for your purposes. It is used both for signal handler "locking"
		3693	as well as for signal and thread safety in C<ev_async> watchers.
		3694
		3695	In the absence of this define, libev will use C<sig_atomic_t volatile>
		3696	(from F<signal.h>), which is usually good enough on most platforms.
2496		3697
2497	=item EV_H	3698	=item EV_H
2498		3699
2499	The name of the F<ev.h> header file used to include it. The default if	3700	The name of the F<ev.h> header file used to include it. The default if
2500	undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to	3701	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2501	virtually rename the F<ev.h> header file in case of conflicts.	3702	used to virtually rename the F<ev.h> header file in case of conflicts.
2502		3703
2503	=item EV_CONFIG_H	3704	=item EV_CONFIG_H
2504		3705
2505	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	3706	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2506	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	3707	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2507	C<EV_H>, above.	3708	C<EV_H>, above.
2508		3709
2509	=item EV_EVENT_H	3710	=item EV_EVENT_H
2510		3711
2511	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	3712	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2512	of how the F<event.h> header can be found, the dfeault is C<"event.h">.	3713	of how the F<event.h> header can be found, the default is C<"event.h">.
2513		3714
2514	=item EV_PROTOTYPES	3715	=item EV_PROTOTYPES
2515		3716
2516	If defined to be C<0>, then F<ev.h> will not define any function	3717	If defined to be C<0>, then F<ev.h> will not define any function
2517	prototypes, but still define all the structs and other symbols. This is	3718	prototypes, but still define all the structs and other symbols. This is
…		…
2538	When doing priority-based operations, libev usually has to linearly search	3739	When doing priority-based operations, libev usually has to linearly search
2539	all the priorities, so having many of them (hundreds) uses a lot of space	3740	all the priorities, so having many of them (hundreds) uses a lot of space
2540	and time, so using the defaults of five priorities (-2 .. +2) is usually	3741	and time, so using the defaults of five priorities (-2 .. +2) is usually
2541	fine.	3742	fine.
2542		3743
2543	If your embedding app does not need any priorities, defining these both to	3744	If your embedding application does not need any priorities, defining these
2544	C<0> will save some memory and cpu.	3745	both to C<0> will save some memory and CPU.
2545		3746
2546	=item EV_PERIODIC_ENABLE	3747	=item EV_PERIODIC_ENABLE
2547		3748
2548	If undefined or defined to be C<1>, then periodic timers are supported. If	3749	If undefined or defined to be C<1>, then periodic timers are supported. If
2549	defined to be C<0>, then they are not. Disabling them saves a few kB of	3750	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2556	code.	3757	code.
2557		3758
2558	=item EV_EMBED_ENABLE	3759	=item EV_EMBED_ENABLE
2559		3760
2560	If undefined or defined to be C<1>, then embed watchers are supported. If	3761	If undefined or defined to be C<1>, then embed watchers are supported. If
2561	defined to be C<0>, then they are not.	3762	defined to be C<0>, then they are not. Embed watchers rely on most other
		3763	watcher types, which therefore must not be disabled.
2562		3764
2563	=item EV_STAT_ENABLE	3765	=item EV_STAT_ENABLE
2564		3766
2565	If undefined or defined to be C<1>, then stat watchers are supported. If	3767	If undefined or defined to be C<1>, then stat watchers are supported. If
2566	defined to be C<0>, then they are not.	3768	defined to be C<0>, then they are not.
…		…
2568	=item EV_FORK_ENABLE	3770	=item EV_FORK_ENABLE
2569		3771
2570	If undefined or defined to be C<1>, then fork watchers are supported. If	3772	If undefined or defined to be C<1>, then fork watchers are supported. If
2571	defined to be C<0>, then they are not.	3773	defined to be C<0>, then they are not.
2572		3774
		3775	=item EV_ASYNC_ENABLE
		3776
		3777	If undefined or defined to be C<1>, then async watchers are supported. If
		3778	defined to be C<0>, then they are not.
		3779
2573	=item EV_MINIMAL	3780	=item EV_MINIMAL
2574		3781
2575	If you need to shave off some kilobytes of code at the expense of some	3782	If you need to shave off some kilobytes of code at the expense of some
2576	speed, define this symbol to C<1>. Currently only used for gcc to override	3783	speed (but with the full API), define this symbol to C<1>. Currently this
2577	some inlining decisions, saves roughly 30% codesize of amd64.	3784	is used to override some inlining decisions, saves roughly 30% code size
		3785	on amd64. It also selects a much smaller 2-heap for timer management over
		3786	the default 4-heap.
		3787
		3788	You can save even more by disabling watcher types you do not need
		3789	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
		3790	(C<-DNDEBUG>) will usually reduce code size a lot.
		3791
		3792	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
		3793	provide a bare-bones event library. See C<ev.h> for details on what parts
		3794	of the API are still available, and do not complain if this subset changes
		3795	over time.
2578		3796
2579	=item EV_PID_HASHSIZE	3797	=item EV_PID_HASHSIZE
2580		3798
2581	C<ev_child> watchers use a small hash table to distribute workload by	3799	C<ev_child> watchers use a small hash table to distribute workload by
2582	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3800	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2589	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3807	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2590	usually more than enough. If you need to manage thousands of C<ev_stat>	3808	usually more than enough. If you need to manage thousands of C<ev_stat>
2591	watchers you might want to increase this value (I<must> be a power of	3809	watchers you might want to increase this value (I<must> be a power of
2592	two).	3810	two).
2593		3811
		3812	=item EV_USE_4HEAP
		3813
		3814	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3815	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
		3816	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
		3817	faster performance with many (thousands) of watchers.
		3818
		3819	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3820	(disabled).
		3821
		3822	=item EV_HEAP_CACHE_AT
		3823
		3824	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3825	timer and periodics heaps, libev can cache the timestamp (I<at>) within
		3826	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3827	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3828	but avoids random read accesses on heap changes. This improves performance
		3829	noticeably with many (hundreds) of watchers.
		3830
		3831	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3832	(disabled).
		3833
		3834	=item EV_VERIFY
		3835
		3836	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3837	be done: If set to C<0>, no internal verification code will be compiled
		3838	in. If set to C<1>, then verification code will be compiled in, but not
		3839	called. If set to C<2>, then the internal verification code will be
		3840	called once per loop, which can slow down libev. If set to C<3>, then the
		3841	verification code will be called very frequently, which will slow down
		3842	libev considerably.
		3843
		3844	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3845	C<0>.
		3846
2594	=item EV_COMMON	3847	=item EV_COMMON
2595		3848
2596	By default, all watchers have a C<void *data> member. By redefining	3849	By default, all watchers have a C<void *data> member. By redefining
2597	this macro to a something else you can include more and other types of	3850	this macro to a something else you can include more and other types of
2598	members. You have to define it each time you include one of the files,	3851	members. You have to define it each time you include one of the files,
2599	though, and it must be identical each time.	3852	though, and it must be identical each time.
2600		3853
2601	For example, the perl EV module uses something like this:	3854	For example, the perl EV module uses something like this:
2602		3855
2603	#define EV_COMMON \	3856	#define EV_COMMON \
2604	SV *self; /* contains this struct */ \	3857	SV *self; /* contains this struct */ \
2605	SV *cb_sv, *fh /* note no trailing ";" */	3858	SV *cb_sv, *fh /* note no trailing ";" */
2606		3859
2607	=item EV_CB_DECLARE (type)	3860	=item EV_CB_DECLARE (type)
2608		3861
2609	=item EV_CB_INVOKE (watcher, revents)	3862	=item EV_CB_INVOKE (watcher, revents)
2610		3863
…		…
2615	definition and a statement, respectively. See the F<ev.h> header file for	3868	definition and a statement, respectively. See the F<ev.h> header file for
2616	their default definitions. One possible use for overriding these is to	3869	their default definitions. One possible use for overriding these is to
2617	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3870	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2618	method calls instead of plain function calls in C++.	3871	method calls instead of plain function calls in C++.
2619		3872
		3873	=back
		3874
2620	=head2 EXPORTED API SYMBOLS	3875	=head2 EXPORTED API SYMBOLS
2621		3876
2622	If you need to re-export the API (e.g. via a dll) and you need a list of	3877	If you need to re-export the API (e.g. via a DLL) and you need a list of
2623	exported symbols, you can use the provided F<Symbol.*> files which list	3878	exported symbols, you can use the provided F<Symbol.*> files which list
2624	all public symbols, one per line:	3879	all public symbols, one per line:
2625		3880
2626	Symbols.ev for libev proper	3881	Symbols.ev for libev proper
2627	Symbols.event for the libevent emulation	3882	Symbols.event for the libevent emulation
2628		3883
2629	This can also be used to rename all public symbols to avoid clashes with	3884	This can also be used to rename all public symbols to avoid clashes with
2630	multiple versions of libev linked together (which is obviously bad in	3885	multiple versions of libev linked together (which is obviously bad in
2631	itself, but sometimes it is inconvinient to avoid this).	3886	itself, but sometimes it is inconvenient to avoid this).
2632		3887
2633	A sed command like this will create wrapper C<#define>'s that you need to	3888	A sed command like this will create wrapper C<#define>'s that you need to
2634	include before including F<ev.h>:	3889	include before including F<ev.h>:
2635		3890
2636	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3891	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
2653	file.	3908	file.
2654		3909
2655	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3910	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2656	that everybody includes and which overrides some configure choices:	3911	that everybody includes and which overrides some configure choices:
2657		3912
2658	#define EV_MINIMAL 1	3913	#define EV_MINIMAL 1
2659	#define EV_USE_POLL 0	3914	#define EV_USE_POLL 0
2660	#define EV_MULTIPLICITY 0	3915	#define EV_MULTIPLICITY 0
2661	#define EV_PERIODIC_ENABLE 0	3916	#define EV_PERIODIC_ENABLE 0
2662	#define EV_STAT_ENABLE 0	3917	#define EV_STAT_ENABLE 0
2663	#define EV_FORK_ENABLE 0	3918	#define EV_FORK_ENABLE 0
2664	#define EV_CONFIG_H <config.h>	3919	#define EV_CONFIG_H <config.h>
2665	#define EV_MINPRI 0	3920	#define EV_MINPRI 0
2666	#define EV_MAXPRI 0	3921	#define EV_MAXPRI 0
2667		3922
2668	#include "ev++.h"	3923	#include "ev++.h"
2669		3924
2670	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3925	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2671		3926
2672	#include "ev_cpp.h"	3927	#include "ev_cpp.h"
2673	#include "ev.c"	3928	#include "ev.c"
2674		3929
		3930	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
2675		3931
		3932	=head2 THREADS AND COROUTINES
		3933
		3934	=head3 THREADS
		3935
		3936	All libev functions are reentrant and thread-safe unless explicitly
		3937	documented otherwise, but libev implements no locking itself. This means
		3938	that you can use as many loops as you want in parallel, as long as there
		3939	are no concurrent calls into any libev function with the same loop
		3940	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		3941	of course): libev guarantees that different event loops share no data
		3942	structures that need any locking.
		3943
		3944	Or to put it differently: calls with different loop parameters can be done
		3945	concurrently from multiple threads, calls with the same loop parameter
		3946	must be done serially (but can be done from different threads, as long as
		3947	only one thread ever is inside a call at any point in time, e.g. by using
		3948	a mutex per loop).
		3949
		3950	Specifically to support threads (and signal handlers), libev implements
		3951	so-called C<ev_async> watchers, which allow some limited form of
		3952	concurrency on the same event loop, namely waking it up "from the
		3953	outside".
		3954
		3955	If you want to know which design (one loop, locking, or multiple loops
		3956	without or something else still) is best for your problem, then I cannot
		3957	help you, but here is some generic advice:
		3958
		3959	=over 4
		3960
		3961	=item * most applications have a main thread: use the default libev loop
		3962	in that thread, or create a separate thread running only the default loop.
		3963
		3964	This helps integrating other libraries or software modules that use libev
		3965	themselves and don't care/know about threading.
		3966
		3967	=item * one loop per thread is usually a good model.
		3968
		3969	Doing this is almost never wrong, sometimes a better-performance model
		3970	exists, but it is always a good start.
		3971
		3972	=item * other models exist, such as the leader/follower pattern, where one
		3973	loop is handed through multiple threads in a kind of round-robin fashion.
		3974
		3975	Choosing a model is hard - look around, learn, know that usually you can do
		3976	better than you currently do :-)
		3977
		3978	=item * often you need to talk to some other thread which blocks in the
		3979	event loop.
		3980
		3981	C<ev_async> watchers can be used to wake them up from other threads safely
		3982	(or from signal contexts...).
		3983
		3984	An example use would be to communicate signals or other events that only
		3985	work in the default loop by registering the signal watcher with the
		3986	default loop and triggering an C<ev_async> watcher from the default loop
		3987	watcher callback into the event loop interested in the signal.
		3988
		3989	=back
		3990
		3991	=head4 THREAD LOCKING EXAMPLE
		3992
		3993	Here is a fictitious example of how to run an event loop in a different
		3994	thread than where callbacks are being invoked and watchers are
		3995	created/added/removed.
		3996
		3997	For a real-world example, see the C<EV::Loop::Async> perl module,
		3998	which uses exactly this technique (which is suited for many high-level
		3999	languages).
		4000
		4001	The example uses a pthread mutex to protect the loop data, a condition
		4002	variable to wait for callback invocations, an async watcher to notify the
		4003	event loop thread and an unspecified mechanism to wake up the main thread.
		4004
		4005	First, you need to associate some data with the event loop:
		4006
		4007	typedef struct {
		4008	mutex_t lock; /* global loop lock */
		4009	ev_async async_w;
		4010	thread_t tid;
		4011	cond_t invoke_cv;
		4012	} userdata;
		4013
		4014	void prepare_loop (EV_P)
		4015	{
		4016	// for simplicity, we use a static userdata struct.
		4017	static userdata u;
		4018
		4019	ev_async_init (&u->async_w, async_cb);
		4020	ev_async_start (EV_A_ &u->async_w);
		4021
		4022	pthread_mutex_init (&u->lock, 0);
		4023	pthread_cond_init (&u->invoke_cv, 0);
		4024
		4025	// now associate this with the loop
		4026	ev_set_userdata (EV_A_ u);
		4027	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		4028	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		4029
		4030	// then create the thread running ev_loop
		4031	pthread_create (&u->tid, 0, l_run, EV_A);
		4032	}
		4033
		4034	The callback for the C<ev_async> watcher does nothing: the watcher is used
		4035	solely to wake up the event loop so it takes notice of any new watchers
		4036	that might have been added:
		4037
		4038	static void
		4039	async_cb (EV_P_ ev_async *w, int revents)
		4040	{
		4041	// just used for the side effects
		4042	}
		4043
		4044	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		4045	protecting the loop data, respectively.
		4046
		4047	static void
		4048	l_release (EV_P)
		4049	{
		4050	userdata *u = ev_userdata (EV_A);
		4051	pthread_mutex_unlock (&u->lock);
		4052	}
		4053
		4054	static void
		4055	l_acquire (EV_P)
		4056	{
		4057	userdata *u = ev_userdata (EV_A);
		4058	pthread_mutex_lock (&u->lock);
		4059	}
		4060
		4061	The event loop thread first acquires the mutex, and then jumps straight
		4062	into C<ev_loop>:
		4063
		4064	void *
		4065	l_run (void *thr_arg)
		4066	{
		4067	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		4068
		4069	l_acquire (EV_A);
		4070	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		4071	ev_loop (EV_A_ 0);
		4072	l_release (EV_A);
		4073
		4074	return 0;
		4075	}
		4076
		4077	Instead of invoking all pending watchers, the C<l_invoke> callback will
		4078	signal the main thread via some unspecified mechanism (signals? pipe
		4079	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		4080	have been called (in a while loop because a) spurious wakeups are possible
		4081	and b) skipping inter-thread-communication when there are no pending
		4082	watchers is very beneficial):
		4083
		4084	static void
		4085	l_invoke (EV_P)
		4086	{
		4087	userdata *u = ev_userdata (EV_A);
		4088
		4089	while (ev_pending_count (EV_A))
		4090	{
		4091	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		4092	pthread_cond_wait (&u->invoke_cv, &u->lock);
		4093	}
		4094	}
		4095
		4096	Now, whenever the main thread gets told to invoke pending watchers, it
		4097	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		4098	thread to continue:
		4099
		4100	static void
		4101	real_invoke_pending (EV_P)
		4102	{
		4103	userdata *u = ev_userdata (EV_A);
		4104
		4105	pthread_mutex_lock (&u->lock);
		4106	ev_invoke_pending (EV_A);
		4107	pthread_cond_signal (&u->invoke_cv);
		4108	pthread_mutex_unlock (&u->lock);
		4109	}
		4110
		4111	Whenever you want to start/stop a watcher or do other modifications to an
		4112	event loop, you will now have to lock:
		4113
		4114	ev_timer timeout_watcher;
		4115	userdata *u = ev_userdata (EV_A);
		4116
		4117	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		4118
		4119	pthread_mutex_lock (&u->lock);
		4120	ev_timer_start (EV_A_ &timeout_watcher);
		4121	ev_async_send (EV_A_ &u->async_w);
		4122	pthread_mutex_unlock (&u->lock);
		4123
		4124	Note that sending the C<ev_async> watcher is required because otherwise
		4125	an event loop currently blocking in the kernel will have no knowledge
		4126	about the newly added timer. By waking up the loop it will pick up any new
		4127	watchers in the next event loop iteration.
		4128
		4129	=head3 COROUTINES
		4130
		4131	Libev is very accommodating to coroutines ("cooperative threads"):
		4132	libev fully supports nesting calls to its functions from different
		4133	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		4134	different coroutines, and switch freely between both coroutines running
		4135	the loop, as long as you don't confuse yourself). The only exception is
		4136	that you must not do this from C<ev_periodic> reschedule callbacks.
		4137
		4138	Care has been taken to ensure that libev does not keep local state inside
		4139	C<ev_loop>, and other calls do not usually allow for coroutine switches as
		4140	they do not call any callbacks.
		4141
		4142	=head2 COMPILER WARNINGS
		4143
		4144	Depending on your compiler and compiler settings, you might get no or a
		4145	lot of warnings when compiling libev code. Some people are apparently
		4146	scared by this.
		4147
		4148	However, these are unavoidable for many reasons. For one, each compiler
		4149	has different warnings, and each user has different tastes regarding
		4150	warning options. "Warn-free" code therefore cannot be a goal except when
		4151	targeting a specific compiler and compiler-version.
		4152
		4153	Another reason is that some compiler warnings require elaborate
		4154	workarounds, or other changes to the code that make it less clear and less
		4155	maintainable.
		4156
		4157	And of course, some compiler warnings are just plain stupid, or simply
		4158	wrong (because they don't actually warn about the condition their message
		4159	seems to warn about). For example, certain older gcc versions had some
		4160	warnings that resulted an extreme number of false positives. These have
		4161	been fixed, but some people still insist on making code warn-free with
		4162	such buggy versions.
		4163
		4164	While libev is written to generate as few warnings as possible,
		4165	"warn-free" code is not a goal, and it is recommended not to build libev
		4166	with any compiler warnings enabled unless you are prepared to cope with
		4167	them (e.g. by ignoring them). Remember that warnings are just that:
		4168	warnings, not errors, or proof of bugs.
		4169
		4170
		4171	=head2 VALGRIND
		4172
		4173	Valgrind has a special section here because it is a popular tool that is
		4174	highly useful. Unfortunately, valgrind reports are very hard to interpret.
		4175
		4176	If you think you found a bug (memory leak, uninitialised data access etc.)
		4177	in libev, then check twice: If valgrind reports something like:
		4178
		4179	==2274== definitely lost: 0 bytes in 0 blocks.
		4180	==2274== possibly lost: 0 bytes in 0 blocks.
		4181	==2274== still reachable: 256 bytes in 1 blocks.
		4182
		4183	Then there is no memory leak, just as memory accounted to global variables
		4184	is not a memleak - the memory is still being referenced, and didn't leak.
		4185
		4186	Similarly, under some circumstances, valgrind might report kernel bugs
		4187	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		4188	although an acceptable workaround has been found here), or it might be
		4189	confused.
		4190
		4191	Keep in mind that valgrind is a very good tool, but only a tool. Don't
		4192	make it into some kind of religion.
		4193
		4194	If you are unsure about something, feel free to contact the mailing list
		4195	with the full valgrind report and an explanation on why you think this
		4196	is a bug in libev (best check the archives, too :). However, don't be
		4197	annoyed when you get a brisk "this is no bug" answer and take the chance
		4198	of learning how to interpret valgrind properly.
		4199
		4200	If you need, for some reason, empty reports from valgrind for your project
		4201	I suggest using suppression lists.
		4202
		4203
		4204	=head1 PORTABILITY NOTES
		4205
		4206	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4207
		4208	Win32 doesn't support any of the standards (e.g. POSIX) that libev
		4209	requires, and its I/O model is fundamentally incompatible with the POSIX
		4210	model. Libev still offers limited functionality on this platform in
		4211	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
		4212	descriptors. This only applies when using Win32 natively, not when using
		4213	e.g. cygwin.
		4214
		4215	Lifting these limitations would basically require the full
		4216	re-implementation of the I/O system. If you are into these kinds of
		4217	things, then note that glib does exactly that for you in a very portable
		4218	way (note also that glib is the slowest event library known to man).
		4219
		4220	There is no supported compilation method available on windows except
		4221	embedding it into other applications.
		4222
		4223	Sensible signal handling is officially unsupported by Microsoft - libev
		4224	tries its best, but under most conditions, signals will simply not work.
		4225
		4226	Not a libev limitation but worth mentioning: windows apparently doesn't
		4227	accept large writes: instead of resulting in a partial write, windows will
		4228	either accept everything or return C<ENOBUFS> if the buffer is too large,
		4229	so make sure you only write small amounts into your sockets (less than a
		4230	megabyte seems safe, but this apparently depends on the amount of memory
		4231	available).
		4232
		4233	Due to the many, low, and arbitrary limits on the win32 platform and
		4234	the abysmal performance of winsockets, using a large number of sockets
		4235	is not recommended (and not reasonable). If your program needs to use
		4236	more than a hundred or so sockets, then likely it needs to use a totally
		4237	different implementation for windows, as libev offers the POSIX readiness
		4238	notification model, which cannot be implemented efficiently on windows
		4239	(due to Microsoft monopoly games).
		4240
		4241	A typical way to use libev under windows is to embed it (see the embedding
		4242	section for details) and use the following F<evwrap.h> header file instead
		4243	of F<ev.h>:
		4244
		4245	#define EV_STANDALONE /* keeps ev from requiring config.h */
		4246	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		4247
		4248	#include "ev.h"
		4249
		4250	And compile the following F<evwrap.c> file into your project (make sure
		4251	you do I<not> compile the F<ev.c> or any other embedded source files!):
		4252
		4253	#include "evwrap.h"
		4254	#include "ev.c"
		4255
		4256	=over 4
		4257
		4258	=item The winsocket select function
		4259
		4260	The winsocket C<select> function doesn't follow POSIX in that it
		4261	requires socket I<handles> and not socket I<file descriptors> (it is
		4262	also extremely buggy). This makes select very inefficient, and also
		4263	requires a mapping from file descriptors to socket handles (the Microsoft
		4264	C runtime provides the function C<_open_osfhandle> for this). See the
		4265	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		4266	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
		4267
		4268	The configuration for a "naked" win32 using the Microsoft runtime
		4269	libraries and raw winsocket select is:
		4270
		4271	#define EV_USE_SELECT 1
		4272	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
		4273
		4274	Note that winsockets handling of fd sets is O(n), so you can easily get a
		4275	complexity in the O(n²) range when using win32.
		4276
		4277	=item Limited number of file descriptors
		4278
		4279	Windows has numerous arbitrary (and low) limits on things.
		4280
		4281	Early versions of winsocket's select only supported waiting for a maximum
		4282	of C<64> handles (probably owning to the fact that all windows kernels
		4283	can only wait for C<64> things at the same time internally; Microsoft
		4284	recommends spawning a chain of threads and wait for 63 handles and the
		4285	previous thread in each. Sounds great!).
		4286
		4287	Newer versions support more handles, but you need to define C<FD_SETSIZE>
		4288	to some high number (e.g. C<2048>) before compiling the winsocket select
		4289	call (which might be in libev or elsewhere, for example, perl and many
		4290	other interpreters do their own select emulation on windows).
		4291
		4292	Another limit is the number of file descriptors in the Microsoft runtime
		4293	libraries, which by default is C<64> (there must be a hidden I<64>
		4294	fetish or something like this inside Microsoft). You can increase this
		4295	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
		4296	(another arbitrary limit), but is broken in many versions of the Microsoft
		4297	runtime libraries. This might get you to about C<512> or C<2048> sockets
		4298	(depending on windows version and/or the phase of the moon). To get more,
		4299	you need to wrap all I/O functions and provide your own fd management, but
		4300	the cost of calling select (O(n²)) will likely make this unworkable.
		4301
		4302	=back
		4303
		4304	=head2 PORTABILITY REQUIREMENTS
		4305
		4306	In addition to a working ISO-C implementation and of course the
		4307	backend-specific APIs, libev relies on a few additional extensions:
		4308
		4309	=over 4
		4310
		4311	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		4312	calling conventions regardless of C<ev_watcher_type *>.
		4313
		4314	Libev assumes not only that all watcher pointers have the same internal
		4315	structure (guaranteed by POSIX but not by ISO C for example), but it also
		4316	assumes that the same (machine) code can be used to call any watcher
		4317	callback: The watcher callbacks have different type signatures, but libev
		4318	calls them using an C<ev_watcher *> internally.
		4319
		4320	=item C<sig_atomic_t volatile> must be thread-atomic as well
		4321
		4322	The type C<sig_atomic_t volatile> (or whatever is defined as
		4323	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
		4324	threads. This is not part of the specification for C<sig_atomic_t>, but is
		4325	believed to be sufficiently portable.
		4326
		4327	=item C<sigprocmask> must work in a threaded environment
		4328
		4329	Libev uses C<sigprocmask> to temporarily block signals. This is not
		4330	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		4331	pthread implementations will either allow C<sigprocmask> in the "main
		4332	thread" or will block signals process-wide, both behaviours would
		4333	be compatible with libev. Interaction between C<sigprocmask> and
		4334	C<pthread_sigmask> could complicate things, however.
		4335
		4336	The most portable way to handle signals is to block signals in all threads
		4337	except the initial one, and run the default loop in the initial thread as
		4338	well.
		4339
		4340	=item C<long> must be large enough for common memory allocation sizes
		4341
		4342	To improve portability and simplify its API, libev uses C<long> internally
		4343	instead of C<size_t> when allocating its data structures. On non-POSIX
		4344	systems (Microsoft...) this might be unexpectedly low, but is still at
		4345	least 31 bits everywhere, which is enough for hundreds of millions of
		4346	watchers.
		4347
		4348	=item C<double> must hold a time value in seconds with enough accuracy
		4349
		4350	The type C<double> is used to represent timestamps. It is required to
		4351	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		4352	enough for at least into the year 4000. This requirement is fulfilled by
		4353	implementations implementing IEEE 754, which is basically all existing
		4354	ones. With IEEE 754 doubles, you get microsecond accuracy until at least
		4355	2200.
		4356
		4357	=back
		4358
		4359	If you know of other additional requirements drop me a note.
		4360
		4361
2676	=head1 COMPLEXITIES	4362	=head1 ALGORITHMIC COMPLEXITIES
2677		4363
2678	In this section the complexities of (many of) the algorithms used inside	4364	In this section the complexities of (many of) the algorithms used inside
2679	libev will be explained. For complexity discussions about backends see the	4365	libev will be documented. For complexity discussions about backends see
2680	documentation for C<ev_default_init>.	4366	the documentation for C<ev_default_init>.
2681		4367
2682	All of the following are about amortised time: If an array needs to be	4368	All of the following are about amortised time: If an array needs to be
2683	extended, libev needs to realloc and move the whole array, but this	4369	extended, libev needs to realloc and move the whole array, but this
2684	happens asymptotically never with higher number of elements, so O(1) might	4370	happens asymptotically rarer with higher number of elements, so O(1) might
2685	mean it might do a lengthy realloc operation in rare cases, but on average	4371	mean that libev does a lengthy realloc operation in rare cases, but on
2686	it is much faster and asymptotically approaches constant time.	4372	average it is much faster and asymptotically approaches constant time.
2687		4373
2688	=over 4	4374	=over 4
2689		4375
2690	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	4376	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2691		4377
2692	This means that, when you have a watcher that triggers in one hour and	4378	This means that, when you have a watcher that triggers in one hour and
2693	there are 100 watchers that would trigger before that then inserting will	4379	there are 100 watchers that would trigger before that, then inserting will
2694	have to skip roughly seven (C<ld 100>) of these watchers.	4380	have to skip roughly seven (C<ld 100>) of these watchers.
2695		4381
2696	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	4382	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2697		4383
2698	That means that changing a timer costs less than removing/adding them	4384	That means that changing a timer costs less than removing/adding them,
2699	as only the relative motion in the event queue has to be paid for.	4385	as only the relative motion in the event queue has to be paid for.
2700		4386
2701	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	4387	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2702		4388
2703	These just add the watcher into an array or at the head of a list.	4389	These just add the watcher into an array or at the head of a list.
2704		4390
2705	=item Stopping check/prepare/idle watchers: O(1)	4391	=item Stopping check/prepare/idle/fork/async watchers: O(1)
2706		4392
2707	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	4393	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2708		4394
2709	These watchers are stored in lists then need to be walked to find the	4395	These watchers are stored in lists, so they need to be walked to find the
2710	correct watcher to remove. The lists are usually short (you don't usually	4396	correct watcher to remove. The lists are usually short (you don't usually
2711	have many watchers waiting for the same fd or signal).	4397	have many watchers waiting for the same fd or signal: one is typical, two
		4398	is rare).
2712		4399
2713	=item Finding the next timer in each loop iteration: O(1)	4400	=item Finding the next timer in each loop iteration: O(1)
2714		4401
2715	By virtue of using a binary heap, the next timer is always found at the	4402	By virtue of using a binary or 4-heap, the next timer is always found at a
2716	beginning of the storage array.	4403	fixed position in the storage array.
2717		4404
2718	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	4405	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2719		4406
2720	A change means an I/O watcher gets started or stopped, which requires	4407	A change means an I/O watcher gets started or stopped, which requires
2721	libev to recalculate its status (and possibly tell the kernel, depending	4408	libev to recalculate its status (and possibly tell the kernel, depending
2722	on backend and wether C<ev_io_set> was used).	4409	on backend and whether C<ev_io_set> was used).
2723		4410
2724	=item Activating one watcher (putting it into the pending state): O(1)	4411	=item Activating one watcher (putting it into the pending state): O(1)
2725		4412
2726	=item Priority handling: O(number_of_priorities)	4413	=item Priority handling: O(number_of_priorities)
2727		4414
2728	Priorities are implemented by allocating some space for each	4415	Priorities are implemented by allocating some space for each
2729	priority. When doing priority-based operations, libev usually has to	4416	priority. When doing priority-based operations, libev usually has to
2730	linearly search all the priorities, but starting/stopping and activating	4417	linearly search all the priorities, but starting/stopping and activating
2731	watchers becomes O(1) w.r.t. prioritiy handling.	4418	watchers becomes O(1) with respect to priority handling.
		4419
		4420	=item Sending an ev_async: O(1)
		4421
		4422	=item Processing ev_async_send: O(number_of_async_watchers)
		4423
		4424	=item Processing signals: O(max_signal_number)
		4425
		4426	Sending involves a system call I<iff> there were no other C<ev_async_send>
		4427	calls in the current loop iteration. Checking for async and signal events
		4428	involves iterating over all running async watchers or all signal numbers.
2732		4429
2733	=back	4430	=back
2734		4431
2735		4432
		4433	=head1 GLOSSARY
		4434
		4435	=over 4
		4436
		4437	=item active
		4438
		4439	A watcher is active as long as it has been started (has been attached to
		4440	an event loop) but not yet stopped (disassociated from the event loop).
		4441
		4442	=item application
		4443
		4444	In this document, an application is whatever is using libev.
		4445
		4446	=item callback
		4447
		4448	The address of a function that is called when some event has been
		4449	detected. Callbacks are being passed the event loop, the watcher that
		4450	received the event, and the actual event bitset.
		4451
		4452	=item callback invocation
		4453
		4454	The act of calling the callback associated with a watcher.
		4455
		4456	=item event
		4457
		4458	A change of state of some external event, such as data now being available
		4459	for reading on a file descriptor, time having passed or simply not having
		4460	any other events happening anymore.
		4461
		4462	In libev, events are represented as single bits (such as C<EV_READ> or
		4463	C<EV_TIMEOUT>).
		4464
		4465	=item event library
		4466
		4467	A software package implementing an event model and loop.
		4468
		4469	=item event loop
		4470
		4471	An entity that handles and processes external events and converts them
		4472	into callback invocations.
		4473
		4474	=item event model
		4475
		4476	The model used to describe how an event loop handles and processes
		4477	watchers and events.
		4478
		4479	=item pending
		4480
		4481	A watcher is pending as soon as the corresponding event has been detected,
		4482	and stops being pending as soon as the watcher will be invoked or its
		4483	pending status is explicitly cleared by the application.
		4484
		4485	A watcher can be pending, but not active. Stopping a watcher also clears
		4486	its pending status.
		4487
		4488	=item real time
		4489
		4490	The physical time that is observed. It is apparently strictly monotonic :)
		4491
		4492	=item wall-clock time
		4493
		4494	The time and date as shown on clocks. Unlike real time, it can actually
		4495	be wrong and jump forwards and backwards, e.g. when the you adjust your
		4496	clock.
		4497
		4498	=item watcher
		4499
		4500	A data structure that describes interest in certain events. Watchers need
		4501	to be started (attached to an event loop) before they can receive events.
		4502
		4503	=item watcher invocation
		4504
		4505	The act of calling the callback associated with a watcher.
		4506
		4507	=back
		4508
2736	=head1 AUTHOR	4509	=head1 AUTHOR
2737		4510
2738	Marc Lehmann <libev@schmorp.de>.	4511	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
2739		4512

Diff Legend

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