ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.355 by root, Tue Jan 11 01:41:56 2011 UTC

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

Diff Legend

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