ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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