ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.160 by root, Thu May 22 03:06:58 2008 UTC vs.
Revision 1.450 by root, Mon Jun 24 00:04:26 2019 UTC

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

Diff Legend

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