ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.157 by root, Tue May 20 23:49:41 2008 UTC vs.
Revision 1.351 by root, Mon Jan 10 14:24:26 2011 UTC

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

Diff Legend

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