ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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