ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.114 by root, Mon Dec 31 01:31:30 2007 UTC vs.
Revision 1.347 by sf-exg, Wed Nov 10 19:50:09 2010 UTC

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

Diff Legend

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