ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.94 by root, Fri Dec 21 04:38:45 2007 UTC vs.
Revision 1.426 by root, Sat Feb 23 23:06:40 2013 UTC

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

Diff Legend

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