ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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