ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.198 by root, Thu Oct 23 06:30:48 2008 UTC vs.
Revision 1.434 by root, Tue May 6 13:24:39 2014 UTC

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

Diff Legend

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