ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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