ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.140 by root, Wed Apr 2 06:34:51 2008 UTC vs.
Revision 1.455 by root, Wed Jun 26 00:01:46 2019 UTC

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

Diff Legend

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