ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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