ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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