ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.235 by root, Thu Apr 16 07:50:39 2009 UTC

…		…
2		2
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
		11	// a single header file is required
11	#include <ev.h>	12	#include <ev.h>
12		13
		14	#include <stdio.h> // for puts
		15
		16	// every watcher type has its own typedef'd struct
		17	// with the name ev_TYPE
13	ev_io stdin_watcher;	18	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
15		20
16	/* called when data readable on stdin */	21	// all watcher callbacks have a similar signature
		22	// this callback is called when data is readable on stdin
17	static void	23	static void
18	stdin_cb (EV_P_ struct ev_io *w, int revents)	24	stdin_cb (EV_P_ ev_io *w, int revents)
19	{	25	{
20	/* puts ("stdin ready"); */	26	puts ("stdin ready");
21	ev_io_stop (EV_A_ w); /* just a syntax example */	27	// for one-shot events, one must manually stop the watcher
22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */	28	// with its corresponding stop function.
		29	ev_io_stop (EV_A_ w);
		30
		31	// this causes all nested ev_loop's to stop iterating
		32	ev_unloop (EV_A_ EVUNLOOP_ALL);
23	}	33	}
24		34
		35	// another callback, this time for a time-out
25	static void	36	static void
26	timeout_cb (EV_P_ struct ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
27	{	38	{
28	/* puts ("timeout"); */	39	puts ("timeout");
29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */	40	// this causes the innermost ev_loop to stop iterating
		41	ev_unloop (EV_A_ EVUNLOOP_ONE);
30	}	42	}
31		43
32	int	44	int
33	main (void)	45	main (void)
34	{	46	{
		47	// use the default event loop unless you have special needs
35	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = ev_default_loop (0);
36		49
37	/* initialise an io watcher, then start it */	50	// initialise an io watcher, then start it
		51	// this one will watch for stdin to become readable
38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
40		54
		55	// initialise a timer watcher, then start it
41	/* simple non-repeating 5.5 second timeout */	56	// simple non-repeating 5.5 second timeout
42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
44		59
45	/* loop till timeout or data ready */	60	// now wait for events to arrive
46	ev_loop (loop, 0);	61	ev_loop (loop, 0);
47		62
		63	// unloop was called, so exit
48	return 0;	64	return 0;
49	}	65	}
50		66
51	=head1 DESCRIPTION	67	=head1 DESCRIPTION
52		68
53	The newest version of this document is also available as a html-formatted	69	The newest version of this document is also available as an html-formatted
54	web page you might find easier to navigate when reading it for the first	70	web page you might find easier to navigate when reading it for the first
55	time: L<http://cvs.schmorp.de/libev/ev.html>.	71	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
56		72
57	Libev is an event loop: you register interest in certain events (such as a	73	Libev is an event loop: you register interest in certain events (such as a
58	file descriptor being readable or a timeout occurring), and it will manage	74	file descriptor being readable or a timeout occurring), and it will manage
59	these event sources and provide your program with events.	75	these event sources and provide your program with events.
60		76
…		…
84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	100	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85	for example).	101	for example).
86		102
87	=head2 CONVENTIONS	103	=head2 CONVENTIONS
88		104
89	Libev is very configurable. In this manual the default configuration will	105	Libev is very configurable. In this manual the default (and most common)
90	be described, which supports multiple event loops. For more info about	106	configuration will be described, which supports multiple event loops. For
91	various configuration options please have a look at B<EMBED> section in	107	more info about various configuration options please have a look at
92	this manual. If libev was configured without support for multiple event	108	B<EMBED> section in this manual. If libev was configured without support
93	loops, then all functions taking an initial argument of name C<loop>	109	for multiple event loops, then all functions taking an initial argument of
94	(which is always of type C<struct ev_loop *>) will not have this argument.	110	name C<loop> (which is always of type C<ev_loop *>) will not have
		111	this argument.
95		112
96	=head2 TIME REPRESENTATION	113	=head2 TIME REPRESENTATION
97		114
98	Libev represents time as a single floating point number, representing the	115	Libev represents time as a single floating point number, representing the
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	116	(fractional) number of seconds since the (POSIX) epoch (somewhere near
100	the beginning of 1970, details are complicated, don't ask). This type is	117	the beginning of 1970, details are complicated, don't ask). This type is
101	called C<ev_tstamp>, which is what you should use too. It usually aliases	118	called C<ev_tstamp>, which is what you should use too. It usually aliases
102	to the C<double> type in C, and when you need to do any calculations on	119	to the C<double> type in C, and when you need to do any calculations on
103	it, you should treat it as some floatingpoint value. Unlike the name	120	it, you should treat it as some floating point value. Unlike the name
104	component C<stamp> might indicate, it is also used for time differences	121	component C<stamp> might indicate, it is also used for time differences
105	throughout libev.	122	throughout libev.
		123
		124	=head1 ERROR HANDLING
		125
		126	Libev knows three classes of errors: operating system errors, usage errors
		127	and internal errors (bugs).
		128
		129	When libev catches an operating system error it cannot handle (for example
		130	a system call indicating a condition libev cannot fix), it calls the callback
		131	set via C<ev_set_syserr_cb>, which is supposed to fix the problem or
		132	abort. The default is to print a diagnostic message and to call C<abort
		133	()>.
		134
		135	When libev detects a usage error such as a negative timer interval, then
		136	it will print a diagnostic message and abort (via the C<assert> mechanism,
		137	so C<NDEBUG> will disable this checking): these are programming errors in
		138	the libev caller and need to be fixed there.
		139
		140	Libev also has a few internal error-checking C<assert>ions, and also has
		141	extensive consistency checking code. These do not trigger under normal
		142	circumstances, as they indicate either a bug in libev or worse.
		143
106		144
107	=head1 GLOBAL FUNCTIONS	145	=head1 GLOBAL FUNCTIONS
108		146
109	These functions can be called anytime, even before initialising the	147	These functions can be called anytime, even before initialising the
110	library in any way.	148	library in any way.
…		…
119		157
120	=item ev_sleep (ev_tstamp interval)	158	=item ev_sleep (ev_tstamp interval)
121		159
122	Sleep for the given interval: The current thread will be blocked until	160	Sleep for the given interval: The current thread will be blocked until
123	either it is interrupted or the given time interval has passed. Basically	161	either it is interrupted or the given time interval has passed. Basically
124	this is a subsecond-resolution C<sleep ()>.	162	this is a sub-second-resolution C<sleep ()>.
125		163
126	=item int ev_version_major ()	164	=item int ev_version_major ()
127		165
128	=item int ev_version_minor ()	166	=item int ev_version_minor ()
129		167
…		…
142	not a problem.	180	not a problem.
143		181
144	Example: Make sure we haven't accidentally been linked against the wrong	182	Example: Make sure we haven't accidentally been linked against the wrong
145	version.	183	version.
146		184
147	assert (("libev version mismatch",	185	assert (("libev version mismatch",
148	ev_version_major () == EV_VERSION_MAJOR	186	ev_version_major () == EV_VERSION_MAJOR
149	&& ev_version_minor () >= EV_VERSION_MINOR));	187	&& ev_version_minor () >= EV_VERSION_MINOR));
150		188
151	=item unsigned int ev_supported_backends ()	189	=item unsigned int ev_supported_backends ()
152		190
153	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	191	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
154	value) compiled into this binary of libev (independent of their	192	value) compiled into this binary of libev (independent of their
…		…
156	a description of the set values.	194	a description of the set values.
157		195
158	Example: make sure we have the epoll method, because yeah this is cool and	196	Example: make sure we have the epoll method, because yeah this is cool and
159	a must have and can we have a torrent of it please!!!11	197	a must have and can we have a torrent of it please!!!11
160		198
161	assert (("sorry, no epoll, no sex",	199	assert (("sorry, no epoll, no sex",
162	ev_supported_backends () & EVBACKEND_EPOLL));	200	ev_supported_backends () & EVBACKEND_EPOLL));
163		201
164	=item unsigned int ev_recommended_backends ()	202	=item unsigned int ev_recommended_backends ()
165		203
166	Return the set of all backends compiled into this binary of libev and also	204	Return the set of all backends compiled into this binary of libev and also
167	recommended for this platform. This set is often smaller than the one	205	recommended for this platform. This set is often smaller than the one
168	returned by C<ev_supported_backends>, as for example kqueue is broken on	206	returned by C<ev_supported_backends>, as for example kqueue is broken on
169	most BSDs and will not be autodetected unless you explicitly request it	207	most BSDs and will not be auto-detected unless you explicitly request it
170	(assuming you know what you are doing). This is the set of backends that	208	(assuming you know what you are doing). This is the set of backends that
171	libev will probe for if you specify no backends explicitly.	209	libev will probe for if you specify no backends explicitly.
172		210
173	=item unsigned int ev_embeddable_backends ()	211	=item unsigned int ev_embeddable_backends ()
174		212
…		…
178	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	216	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
179	recommended ones.	217	recommended ones.
180		218
181	See the description of C<ev_embed> watchers for more info.	219	See the description of C<ev_embed> watchers for more info.
182		220
183	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	221	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
184		222
185	Sets the allocation function to use (the prototype is similar - the	223	Sets the allocation function to use (the prototype is similar - the
186	semantics is identical - to the realloc C function). It is used to	224	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
187	allocate and free memory (no surprises here). If it returns zero when	225	used to allocate and free memory (no surprises here). If it returns zero
188	memory needs to be allocated, the library might abort or take some	226	when memory needs to be allocated (C<size != 0>), the library might abort
189	potentially destructive action. The default is your system realloc	227	or take some potentially destructive action.
190	function.	228
		229	Since some systems (at least OpenBSD and Darwin) fail to implement
		230	correct C<realloc> semantics, libev will use a wrapper around the system
		231	C<realloc> and C<free> functions by default.
191		232
192	You could override this function in high-availability programs to, say,	233	You could override this function in high-availability programs to, say,
193	free some memory if it cannot allocate memory, to use a special allocator,	234	free some memory if it cannot allocate memory, to use a special allocator,
194	or even to sleep a while and retry until some memory is available.	235	or even to sleep a while and retry until some memory is available.
195		236
196	Example: Replace the libev allocator with one that waits a bit and then	237	Example: Replace the libev allocator with one that waits a bit and then
197	retries).	238	retries (example requires a standards-compliant C<realloc>).
198		239
199	static void *	240	static void *
200	persistent_realloc (void *ptr, size_t size)	241	persistent_realloc (void *ptr, size_t size)
201	{	242	{
202	for (;;)	243	for (;;)
…		…
211	}	252	}
212		253
213	...	254	...
214	ev_set_allocator (persistent_realloc);	255	ev_set_allocator (persistent_realloc);
215		256
216	=item ev_set_syserr_cb (void (*cb)(const char *msg));	257	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
217		258
218	Set the callback function to call on a retryable syscall error (such	259	Set the callback function to call on a retryable system call error (such
219	as failed select, poll, epoll_wait). The message is a printable string	260	as failed select, poll, epoll_wait). The message is a printable string
220	indicating the system call or subsystem causing the problem. If this	261	indicating the system call or subsystem causing the problem. If this
221	callback is set, then libev will expect it to remedy the sitution, no	262	callback is set, then libev will expect it to remedy the situation, no
222	matter what, when it returns. That is, libev will generally retry the	263	matter what, when it returns. That is, libev will generally retry the
223	requested operation, or, if the condition doesn't go away, do bad stuff	264	requested operation, or, if the condition doesn't go away, do bad stuff
224	(such as abort).	265	(such as abort).
225		266
226	Example: This is basically the same thing that libev does internally, too.	267	Example: This is basically the same thing that libev does internally, too.
…		…
237		278
238	=back	279	=back
239		280
240	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	281	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
241		282
242	An event loop is described by a C<struct ev_loop *>. The library knows two	283	An event loop is described by a C<struct ev_loop *> (the C<struct>
243	types of such loops, the I<default> loop, which supports signals and child	284	is I<not> optional in this case, as there is also an C<ev_loop>
244	events, and dynamically created loops which do not.	285	I<function>).
245		286
246	If you use threads, a common model is to run the default event loop	287	The library knows two types of such loops, the I<default> loop, which
247	in your main thread (or in a separate thread) and for each thread you	288	supports signals and child events, and dynamically created loops which do
248	create, you also create another event loop. Libev itself does no locking	289	not.
249	whatsoever, so if you mix calls to the same event loop in different
250	threads, make sure you lock (this is usually a bad idea, though, even if
251	done correctly, because it's hideous and inefficient).
252		290
253	=over 4	291	=over 4
254		292
255	=item struct ev_loop *ev_default_loop (unsigned int flags)	293	=item struct ev_loop *ev_default_loop (unsigned int flags)
256		294
…		…
260	flags. If that is troubling you, check C<ev_backend ()> afterwards).	298	flags. If that is troubling you, check C<ev_backend ()> afterwards).
261		299
262	If you don't know what event loop to use, use the one returned from this	300	If you don't know what event loop to use, use the one returned from this
263	function.	301	function.
264		302
		303	Note that this function is I<not> thread-safe, so if you want to use it
		304	from multiple threads, you have to lock (note also that this is unlikely,
		305	as loops cannot be shared easily between threads anyway).
		306
265	The default loop is the only loop that can handle C<ev_signal> and	307	The default loop is the only loop that can handle C<ev_signal> and
266	C<ev_child> watchers, and to do this, it always registers a handler	308	C<ev_child> watchers, and to do this, it always registers a handler
267	for C<SIGCHLD>. If this is a problem for your app you can either	309	for C<SIGCHLD>. If this is a problem for your application you can either
268	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	310	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
269	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	311	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
270	C<ev_default_init>.	312	C<ev_default_init>.
271		313
272	The flags argument can be used to specify special behaviour or specific	314	The flags argument can be used to specify special behaviour or specific
…		…
281	The default flags value. Use this if you have no clue (it's the right	323	The default flags value. Use this if you have no clue (it's the right
282	thing, believe me).	324	thing, believe me).
283		325
284	=item C<EVFLAG_NOENV>	326	=item C<EVFLAG_NOENV>
285		327
286	If this flag bit is ored into the flag value (or the program runs setuid	328	If this flag bit is or'ed into the flag value (or the program runs setuid
287	or setgid) then libev will I<not> look at the environment variable	329	or setgid) then libev will I<not> look at the environment variable
288	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	330	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
289	override the flags completely if it is found in the environment. This is	331	override the flags completely if it is found in the environment. This is
290	useful to try out specific backends to test their performance, or to work	332	useful to try out specific backends to test their performance, or to work
291	around bugs.	333	around bugs.
…		…
297	enabling this flag.	339	enabling this flag.
298		340
299	This works by calling C<getpid ()> on every iteration of the loop,	341	This works by calling C<getpid ()> on every iteration of the loop,
300	and thus this might slow down your event loop if you do a lot of loop	342	and thus this might slow down your event loop if you do a lot of loop
301	iterations and little real work, but is usually not noticeable (on my	343	iterations and little real work, but is usually not noticeable (on my
302	Linux system for example, C<getpid> is actually a simple 5-insn sequence	344	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
303	without a syscall and thus I<very> fast, but my Linux system also has	345	without a system call and thus I<very> fast, but my GNU/Linux system also has
304	C<pthread_atfork> which is even faster).	346	C<pthread_atfork> which is even faster).
305		347
306	The big advantage of this flag is that you can forget about fork (and	348	The big advantage of this flag is that you can forget about fork (and
307	forget about forgetting to tell libev about forking) when you use this	349	forget about forgetting to tell libev about forking) when you use this
308	flag.	350	flag.
309		351
310	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>	352	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
311	environment variable.	353	environment variable.
312		354
313	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	355	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
314		356
315	This is your standard select(2) backend. Not I<completely> standard, as	357	This is your standard select(2) backend. Not I<completely> standard, as
…		…
317	but if that fails, expect a fairly low limit on the number of fds when	359	but if that fails, expect a fairly low limit on the number of fds when
318	using this backend. It doesn't scale too well (O(highest_fd)), but its	360	using this backend. It doesn't scale too well (O(highest_fd)), but its
319	usually the fastest backend for a low number of (low-numbered :) fds.	361	usually the fastest backend for a low number of (low-numbered :) fds.
320		362
321	To get good performance out of this backend you need a high amount of	363	To get good performance out of this backend you need a high amount of
322	parallelity (most of the file descriptors should be busy). If you are	364	parallelism (most of the file descriptors should be busy). If you are
323	writing a server, you should C<accept ()> in a loop to accept as many	365	writing a server, you should C<accept ()> in a loop to accept as many
324	connections as possible during one iteration. You might also want to have	366	connections as possible during one iteration. You might also want to have
325	a look at C<ev_set_io_collect_interval ()> to increase the amount of	367	a look at C<ev_set_io_collect_interval ()> to increase the amount of
326	readyness notifications you get per iteration.	368	readiness notifications you get per iteration.
		369
		370	This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
		371	C<writefds> set (and to work around Microsoft Windows bugs, also onto the
		372	C<exceptfds> set on that platform).
327		373
328	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	374	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
329		375
330	And this is your standard poll(2) backend. It's more complicated	376	And this is your standard poll(2) backend. It's more complicated
331	than select, but handles sparse fds better and has no artificial	377	than select, but handles sparse fds better and has no artificial
332	limit on the number of fds you can use (except it will slow down	378	limit on the number of fds you can use (except it will slow down
333	considerably with a lot of inactive fds). It scales similarly to select,	379	considerably with a lot of inactive fds). It scales similarly to select,
334	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for	380	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
335	performance tips.	381	performance tips.
336		382
		383	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		384	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
		385
337	=item C<EVBACKEND_EPOLL> (value 4, Linux)	386	=item C<EVBACKEND_EPOLL> (value 4, Linux)
338		387
339	For few fds, this backend is a bit little slower than poll and select,	388	For few fds, this backend is a bit little slower than poll and select,
340	but it scales phenomenally better. While poll and select usually scale	389	but it scales phenomenally better. While poll and select usually scale
341	like O(total_fds) where n is the total number of fds (or the highest fd),	390	like O(total_fds) where n is the total number of fds (or the highest fd),
342	epoll scales either O(1) or O(active_fds). The epoll design has a number	391	epoll scales either O(1) or O(active_fds).
343	of shortcomings, such as silently dropping events in some hard-to-detect	392
344	cases and rewiring a syscall per fd change, no fork support and bad	393	The epoll mechanism deserves honorable mention as the most misdesigned
345	support for dup.	394	of the more advanced event mechanisms: mere annoyances include silently
		395	dropping file descriptors, requiring a system call per change per file
		396	descriptor (and unnecessary guessing of parameters), problems with dup and
		397	so on. The biggest issue is fork races, however - if a program forks then
		398	I<both> parent and child process have to recreate the epoll set, which can
		399	take considerable time (one syscall per file descriptor) and is of course
		400	hard to detect.
		401
		402	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		403	of course I<doesn't>, and epoll just loves to report events for totally
		404	I<different> file descriptors (even already closed ones, so one cannot
		405	even remove them from the set) than registered in the set (especially
		406	on SMP systems). Libev tries to counter these spurious notifications by
		407	employing an additional generation counter and comparing that against the
		408	events to filter out spurious ones, recreating the set when required.
346		409
347	While stopping, setting and starting an I/O watcher in the same iteration	410	While stopping, setting and starting an I/O watcher in the same iteration
348	will result in some caching, there is still a syscall per such incident	411	will result in some caching, there is still a system call per such
349	(because the fd could point to a different file description now), so its	412	incident (because the same I<file descriptor> could point to a different
350	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	413	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
351	very well if you register events for both fds.	414	file descriptors might not work very well if you register events for both
352		415	file descriptors.
353	Please note that epoll sometimes generates spurious notifications, so you
354	need to use non-blocking I/O or other means to avoid blocking when no data
355	(or space) is available.
356		416
357	Best performance from this backend is achieved by not unregistering all	417	Best performance from this backend is achieved by not unregistering all
358	watchers for a file descriptor until it has been closed, if possible, i.e.	418	watchers for a file descriptor until it has been closed, if possible,
359	keep at least one watcher active per fd at all times.	419	i.e. keep at least one watcher active per fd at all times. Stopping and
		420	starting a watcher (without re-setting it) also usually doesn't cause
		421	extra overhead. A fork can both result in spurious notifications as well
		422	as in libev having to destroy and recreate the epoll object, which can
		423	take considerable time and thus should be avoided.
360		424
		425	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		426	faster than epoll for maybe up to a hundred file descriptors, depending on
		427	the usage. So sad.
		428
361	While nominally embeddeble in other event loops, this feature is broken in	429	While nominally embeddable in other event loops, this feature is broken in
362	all kernel versions tested so far.	430	all kernel versions tested so far.
		431
		432	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		433	C<EVBACKEND_POLL>.
363		434
364	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	435	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
365		436
366	Kqueue deserves special mention, as at the time of this writing, it	437	Kqueue deserves special mention, as at the time of this writing, it
367	was broken on all BSDs except NetBSD (usually it doesn't work reliably	438	was broken on all BSDs except NetBSD (usually it doesn't work reliably
368	with anything but sockets and pipes, except on Darwin, where of course	439	with anything but sockets and pipes, except on Darwin, where of course
369	it's completely useless). For this reason it's not being "autodetected"	440	it's completely useless). Unlike epoll, however, whose brokenness
		441	is by design, these kqueue bugs can (and eventually will) be fixed
		442	without API changes to existing programs. For this reason it's not being
370	unless you explicitly specify it explicitly in the flags (i.e. using	443	"auto-detected" unless you explicitly specify it in the flags (i.e. using
371	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	444	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
372	system like NetBSD.	445	system like NetBSD.
373		446
374	You still can embed kqueue into a normal poll or select backend and use it	447	You still can embed kqueue into a normal poll or select backend and use it
375	only for sockets (after having made sure that sockets work with kqueue on	448	only for sockets (after having made sure that sockets work with kqueue on
376	the target platform). See C<ev_embed> watchers for more info.	449	the target platform). See C<ev_embed> watchers for more info.
377		450
378	It scales in the same way as the epoll backend, but the interface to the	451	It scales in the same way as the epoll backend, but the interface to the
379	kernel is more efficient (which says nothing about its actual speed, of	452	kernel is more efficient (which says nothing about its actual speed, of
380	course). While stopping, setting and starting an I/O watcher does never	453	course). While stopping, setting and starting an I/O watcher does never
381	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to	454	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
382	two event changes per incident, support for C<fork ()> is very bad and it	455	two event changes per incident. Support for C<fork ()> is very bad (but
383	drops fds silently in similarly hard-to-detect cases.	456	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		457	cases
384		458
385	This backend usually performs well under most conditions.	459	This backend usually performs well under most conditions.
386		460
387	While nominally embeddable in other event loops, this doesn't work	461	While nominally embeddable in other event loops, this doesn't work
388	everywhere, so you might need to test for this. And since it is broken	462	everywhere, so you might need to test for this. And since it is broken
389	almost everywhere, you should only use it when you have a lot of sockets	463	almost everywhere, you should only use it when you have a lot of sockets
390	(for which it usually works), by embedding it into another event loop	464	(for which it usually works), by embedding it into another event loop
391	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for	465	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
392	sockets.	466	also broken on OS X)) and, did I mention it, using it only for sockets.
		467
		468	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
		469	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
		470	C<NOTE_EOF>.
393		471
394	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	472	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
395		473
396	This is not implemented yet (and might never be, unless you send me an	474	This is not implemented yet (and might never be, unless you send me an
397	implementation). According to reports, C</dev/poll> only supports sockets	475	implementation). According to reports, C</dev/poll> only supports sockets
…		…
401	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	479	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
402		480
403	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	481	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
404	it's really slow, but it still scales very well (O(active_fds)).	482	it's really slow, but it still scales very well (O(active_fds)).
405		483
406	Please note that solaris event ports can deliver a lot of spurious	484	Please note that Solaris event ports can deliver a lot of spurious
407	notifications, so you need to use non-blocking I/O or other means to avoid	485	notifications, so you need to use non-blocking I/O or other means to avoid
408	blocking when no data (or space) is available.	486	blocking when no data (or space) is available.
409		487
410	While this backend scales well, it requires one system call per active	488	While this backend scales well, it requires one system call per active
411	file descriptor per loop iteration. For small and medium numbers of file	489	file descriptor per loop iteration. For small and medium numbers of file
412	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	490	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
413	might perform better.	491	might perform better.
414		492
415	On the positive side, ignoring the spurious readyness notifications, this	493	On the positive side, with the exception of the spurious readiness
416	backend actually performed to specification in all tests and is fully	494	notifications, this backend actually performed fully to specification
417	embeddable, which is a rare feat among the OS-specific backends.	495	in all tests and is fully embeddable, which is a rare feat among the
		496	OS-specific backends (I vastly prefer correctness over speed hacks).
		497
		498	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		499	C<EVBACKEND_POLL>.
418		500
419	=item C<EVBACKEND_ALL>	501	=item C<EVBACKEND_ALL>
420		502
421	Try all backends (even potentially broken ones that wouldn't be tried	503	Try all backends (even potentially broken ones that wouldn't be tried
422	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	504	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
…		…
424		506
425	It is definitely not recommended to use this flag.	507	It is definitely not recommended to use this flag.
426		508
427	=back	509	=back
428		510
429	If one or more of these are ored into the flags value, then only these	511	If one or more of these are or'ed into the flags value, then only these
430	backends will be tried (in the reverse order as listed here). If none are	512	backends will be tried (in the reverse order as listed here). If none are
431	specified, all backends in C<ev_recommended_backends ()> will be tried.	513	specified, all backends in C<ev_recommended_backends ()> will be tried.
432		514
433	The most typical usage is like this:	515	Example: This is the most typical usage.
434		516
435	if (!ev_default_loop (0))	517	if (!ev_default_loop (0))
436	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	518	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
437		519
438	Restrict libev to the select and poll backends, and do not allow	520	Example: Restrict libev to the select and poll backends, and do not allow
439	environment settings to be taken into account:	521	environment settings to be taken into account:
440		522
441	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	523	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
442		524
443	Use whatever libev has to offer, but make sure that kqueue is used if	525	Example: Use whatever libev has to offer, but make sure that kqueue is
444	available (warning, breaks stuff, best use only with your own private	526	used if available (warning, breaks stuff, best use only with your own
445	event loop and only if you know the OS supports your types of fds):	527	private event loop and only if you know the OS supports your types of
		528	fds):
446		529
447	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	530	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
448		531
449	=item struct ev_loop *ev_loop_new (unsigned int flags)	532	=item struct ev_loop *ev_loop_new (unsigned int flags)
450		533
451	Similar to C<ev_default_loop>, but always creates a new event loop that is	534	Similar to C<ev_default_loop>, but always creates a new event loop that is
452	always distinct from the default loop. Unlike the default loop, it cannot	535	always distinct from the default loop. Unlike the default loop, it cannot
453	handle signal and child watchers, and attempts to do so will be greeted by	536	handle signal and child watchers, and attempts to do so will be greeted by
454	undefined behaviour (or a failed assertion if assertions are enabled).	537	undefined behaviour (or a failed assertion if assertions are enabled).
455		538
		539	Note that this function I<is> thread-safe, and the recommended way to use
		540	libev with threads is indeed to create one loop per thread, and using the
		541	default loop in the "main" or "initial" thread.
		542
456	Example: Try to create a event loop that uses epoll and nothing else.	543	Example: Try to create a event loop that uses epoll and nothing else.
457		544
458	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	545	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
459	if (!epoller)	546	if (!epoller)
460	fatal ("no epoll found here, maybe it hides under your chair");	547	fatal ("no epoll found here, maybe it hides under your chair");
461		548
462	=item ev_default_destroy ()	549	=item ev_default_destroy ()
463		550
464	Destroys the default loop again (frees all memory and kernel state	551	Destroys the default loop again (frees all memory and kernel state
465	etc.). None of the active event watchers will be stopped in the normal	552	etc.). None of the active event watchers will be stopped in the normal
466	sense, so e.g. C<ev_is_active> might still return true. It is your	553	sense, so e.g. C<ev_is_active> might still return true. It is your
467	responsibility to either stop all watchers cleanly yoursef I<before>	554	responsibility to either stop all watchers cleanly yourself I<before>
468	calling this function, or cope with the fact afterwards (which is usually	555	calling this function, or cope with the fact afterwards (which is usually
469	the easiest thing, you can just ignore the watchers and/or C<free ()> them	556	the easiest thing, you can just ignore the watchers and/or C<free ()> them
470	for example).	557	for example).
471		558
472	Note that certain global state, such as signal state, will not be freed by	559	Note that certain global state, such as signal state (and installed signal
473	this function, and related watchers (such as signal and child watchers)	560	handlers), will not be freed by this function, and related watchers (such
474	would need to be stopped manually.	561	as signal and child watchers) would need to be stopped manually.
475		562
476	In general it is not advisable to call this function except in the	563	In general it is not advisable to call this function except in the
477	rare occasion where you really need to free e.g. the signal handling	564	rare occasion where you really need to free e.g. the signal handling
478	pipe fds. If you need dynamically allocated loops it is better to use	565	pipe fds. If you need dynamically allocated loops it is better to use
479	C<ev_loop_new> and C<ev_loop_destroy>).	566	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
504		591
505	=item ev_loop_fork (loop)	592	=item ev_loop_fork (loop)
506		593
507	Like C<ev_default_fork>, but acts on an event loop created by	594	Like C<ev_default_fork>, but acts on an event loop created by
508	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	595	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
509	after fork, and how you do this is entirely your own problem.	596	after fork that you want to re-use in the child, and how you do this is
		597	entirely your own problem.
		598
		599	=item int ev_is_default_loop (loop)
		600
		601	Returns true when the given loop is, in fact, the default loop, and false
		602	otherwise.
510		603
511	=item unsigned int ev_loop_count (loop)	604	=item unsigned int ev_loop_count (loop)
512		605
513	Returns the count of loop iterations for the loop, which is identical to	606	Returns the count of loop iterations for the loop, which is identical to
514	the number of times libev did poll for new events. It starts at C<0> and	607	the number of times libev did poll for new events. It starts at C<0> and
…		…
529	received events and started processing them. This timestamp does not	622	received events and started processing them. This timestamp does not
530	change as long as callbacks are being processed, and this is also the base	623	change as long as callbacks are being processed, and this is also the base
531	time used for relative timers. You can treat it as the timestamp of the	624	time used for relative timers. You can treat it as the timestamp of the
532	event occurring (or more correctly, libev finding out about it).	625	event occurring (or more correctly, libev finding out about it).
533		626
		627	=item ev_now_update (loop)
		628
		629	Establishes the current time by querying the kernel, updating the time
		630	returned by C<ev_now ()> in the progress. This is a costly operation and
		631	is usually done automatically within C<ev_loop ()>.
		632
		633	This function is rarely useful, but when some event callback runs for a
		634	very long time without entering the event loop, updating libev's idea of
		635	the current time is a good idea.
		636
		637	See also "The special problem of time updates" in the C<ev_timer> section.
		638
		639	=item ev_suspend (loop)
		640
		641	=item ev_resume (loop)
		642
		643	These two functions suspend and resume a loop, for use when the loop is
		644	not used for a while and timeouts should not be processed.
		645
		646	A typical use case would be an interactive program such as a game: When
		647	the user presses C<^Z> to suspend the game and resumes it an hour later it
		648	would be best to handle timeouts as if no time had actually passed while
		649	the program was suspended. This can be achieved by calling C<ev_suspend>
		650	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		651	C<ev_resume> directly afterwards to resume timer processing.
		652
		653	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		654	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		655	will be rescheduled (that is, they will lose any events that would have
		656	occured while suspended).
		657
		658	After calling C<ev_suspend> you B<must not> call I<any> function on the
		659	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		660	without a previous call to C<ev_suspend>.
		661
		662	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		663	event loop time (see C<ev_now_update>).
		664
534	=item ev_loop (loop, int flags)	665	=item ev_loop (loop, int flags)
535		666
536	Finally, this is it, the event handler. This function usually is called	667	Finally, this is it, the event handler. This function usually is called
537	after you initialised all your watchers and you want to start handling	668	after you initialised all your watchers and you want to start handling
538	events.	669	events.
…		…
540	If the flags argument is specified as C<0>, it will not return until	671	If the flags argument is specified as C<0>, it will not return until
541	either no event watchers are active anymore or C<ev_unloop> was called.	672	either no event watchers are active anymore or C<ev_unloop> was called.
542		673
543	Please note that an explicit C<ev_unloop> is usually better than	674	Please note that an explicit C<ev_unloop> is usually better than
544	relying on all watchers to be stopped when deciding when a program has	675	relying on all watchers to be stopped when deciding when a program has
545	finished (especially in interactive programs), but having a program that	676	finished (especially in interactive programs), but having a program
546	automatically loops as long as it has to and no longer by virtue of	677	that automatically loops as long as it has to and no longer by virtue
547	relying on its watchers stopping correctly is a thing of beauty.	678	of relying on its watchers stopping correctly, that is truly a thing of
		679	beauty.
548		680
549	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	681	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
550	those events and any outstanding ones, but will not block your process in	682	those events and any already outstanding ones, but will not block your
551	case there are no events and will return after one iteration of the loop.	683	process in case there are no events and will return after one iteration of
		684	the loop.
552		685
553	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	686	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
554	neccessary) and will handle those and any outstanding ones. It will block	687	necessary) and will handle those and any already outstanding ones. It
555	your process until at least one new event arrives, and will return after	688	will block your process until at least one new event arrives (which could
556	one iteration of the loop. This is useful if you are waiting for some	689	be an event internal to libev itself, so there is no guarantee that a
557	external event in conjunction with something not expressible using other	690	user-registered callback will be called), and will return after one
		691	iteration of the loop.
		692
		693	This is useful if you are waiting for some external event in conjunction
		694	with something not expressible using other libev watchers (i.e. "roll your
558	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	695	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
559	usually a better approach for this kind of thing.	696	usually a better approach for this kind of thing.
560		697
561	Here are the gory details of what C<ev_loop> does:	698	Here are the gory details of what C<ev_loop> does:
562		699
563	- Before the first iteration, call any pending watchers.	700	- Before the first iteration, call any pending watchers.
564	* If EVFLAG_FORKCHECK was used, check for a fork.	701	* If EVFLAG_FORKCHECK was used, check for a fork.
565	- If a fork was detected, queue and call all fork watchers.	702	- If a fork was detected (by any means), queue and call all fork watchers.
566	- Queue and call all prepare watchers.	703	- Queue and call all prepare watchers.
567	- If we have been forked, recreate the kernel state.	704	- If we have been forked, detach and recreate the kernel state
		705	as to not disturb the other process.
568	- Update the kernel state with all outstanding changes.	706	- Update the kernel state with all outstanding changes.
569	- Update the "event loop time".	707	- Update the "event loop time" (ev_now ()).
570	- Calculate for how long to sleep or block, if at all	708	- Calculate for how long to sleep or block, if at all
571	(active idle watchers, EVLOOP_NONBLOCK or not having	709	(active idle watchers, EVLOOP_NONBLOCK or not having
572	any active watchers at all will result in not sleeping).	710	any active watchers at all will result in not sleeping).
573	- Sleep if the I/O and timer collect interval say so.	711	- Sleep if the I/O and timer collect interval say so.
574	- Block the process, waiting for any events.	712	- Block the process, waiting for any events.
575	- Queue all outstanding I/O (fd) events.	713	- Queue all outstanding I/O (fd) events.
576	- Update the "event loop time" and do time jump handling.	714	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
577	- Queue all outstanding timers.	715	- Queue all expired timers.
578	- Queue all outstanding periodics.	716	- Queue all expired periodics.
579	- If no events are pending now, queue all idle watchers.	717	- Unless any events are pending now, queue all idle watchers.
580	- Queue all check watchers.	718	- Queue all check watchers.
581	- Call all queued watchers in reverse order (i.e. check watchers first).	719	- Call all queued watchers in reverse order (i.e. check watchers first).
582	Signals and child watchers are implemented as I/O watchers, and will	720	Signals and child watchers are implemented as I/O watchers, and will
583	be handled here by queueing them when their watcher gets executed.	721	be handled here by queueing them when their watcher gets executed.
584	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	722	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
…		…
589	anymore.	727	anymore.
590		728
591	... queue jobs here, make sure they register event watchers as long	729	... queue jobs here, make sure they register event watchers as long
592	... as they still have work to do (even an idle watcher will do..)	730	... as they still have work to do (even an idle watcher will do..)
593	ev_loop (my_loop, 0);	731	ev_loop (my_loop, 0);
594	... jobs done. yeah!	732	... jobs done or somebody called unloop. yeah!
595		733
596	=item ev_unloop (loop, how)	734	=item ev_unloop (loop, how)
597		735
598	Can be used to make a call to C<ev_loop> return early (but only after it	736	Can be used to make a call to C<ev_loop> return early (but only after it
599	has processed all outstanding events). The C<how> argument must be either	737	has processed all outstanding events). The C<how> argument must be either
600	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	738	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
601	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	739	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
602		740
603	This "unloop state" will be cleared when entering C<ev_loop> again.	741	This "unloop state" will be cleared when entering C<ev_loop> again.
604		742
		743	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		744
605	=item ev_ref (loop)	745	=item ev_ref (loop)
606		746
607	=item ev_unref (loop)	747	=item ev_unref (loop)
608		748
609	Ref/unref can be used to add or remove a reference count on the event	749	Ref/unref can be used to add or remove a reference count on the event
610	loop: Every watcher keeps one reference, and as long as the reference	750	loop: Every watcher keeps one reference, and as long as the reference
611	count is nonzero, C<ev_loop> will not return on its own. If you have	751	count is nonzero, C<ev_loop> will not return on its own.
		752
612	a watcher you never unregister that should not keep C<ev_loop> from	753	If you have a watcher you never unregister that should not keep C<ev_loop>
613	returning, ev_unref() after starting, and ev_ref() before stopping it. For	754	from returning, call ev_unref() after starting, and ev_ref() before
		755	stopping it.
		756
614	example, libev itself uses this for its internal signal pipe: It is not	757	As an example, libev itself uses this for its internal signal pipe: It
615	visible to the libev user and should not keep C<ev_loop> from exiting if	758	is not visible to the libev user and should not keep C<ev_loop> from
616	no event watchers registered by it are active. It is also an excellent	759	exiting if no event watchers registered by it are active. It is also an
617	way to do this for generic recurring timers or from within third-party	760	excellent way to do this for generic recurring timers or from within
618	libraries. Just remember to I<unref after start> and I<ref before stop>	761	third-party libraries. Just remember to I<unref after start> and I<ref
619	(but only if the watcher wasn't active before, or was active before,	762	before stop> (but only if the watcher wasn't active before, or was active
620	respectively).	763	before, respectively. Note also that libev might stop watchers itself
		764	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		765	in the callback).
621		766
622	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	767	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
623	running when nothing else is active.	768	running when nothing else is active.
624		769
625	struct ev_signal exitsig;	770	ev_signal exitsig;
626	ev_signal_init (&exitsig, sig_cb, SIGINT);	771	ev_signal_init (&exitsig, sig_cb, SIGINT);
627	ev_signal_start (loop, &exitsig);	772	ev_signal_start (loop, &exitsig);
628	evf_unref (loop);	773	evf_unref (loop);
629		774
630	Example: For some weird reason, unregister the above signal handler again.	775	Example: For some weird reason, unregister the above signal handler again.
631		776
632	ev_ref (loop);	777	ev_ref (loop);
633	ev_signal_stop (loop, &exitsig);	778	ev_signal_stop (loop, &exitsig);
634		779
635	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	780	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
636		781
637	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	782	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
638		783
639	These advanced functions influence the time that libev will spend waiting	784	These advanced functions influence the time that libev will spend waiting
640	for events. Both are by default C<0>, meaning that libev will try to	785	for events. Both time intervals are by default C<0>, meaning that libev
641	invoke timer/periodic callbacks and I/O callbacks with minimum latency.	786	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		787	latency.
642		788
643	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	789	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
644	allows libev to delay invocation of I/O and timer/periodic callbacks to	790	allows libev to delay invocation of I/O and timer/periodic callbacks
645	increase efficiency of loop iterations.	791	to increase efficiency of loop iterations (or to increase power-saving
		792	opportunities).
646		793
647	The background is that sometimes your program runs just fast enough to	794	The idea is that sometimes your program runs just fast enough to handle
648	handle one (or very few) event(s) per loop iteration. While this makes	795	one (or very few) event(s) per loop iteration. While this makes the
649	the program responsive, it also wastes a lot of CPU time to poll for new	796	program responsive, it also wastes a lot of CPU time to poll for new
650	events, especially with backends like C<select ()> which have a high	797	events, especially with backends like C<select ()> which have a high
651	overhead for the actual polling but can deliver many events at once.	798	overhead for the actual polling but can deliver many events at once.
652		799
653	By setting a higher I<io collect interval> you allow libev to spend more	800	By setting a higher I<io collect interval> you allow libev to spend more
654	time collecting I/O events, so you can handle more events per iteration,	801	time collecting I/O events, so you can handle more events per iteration,
…		…
656	C<ev_timer>) will be not affected. Setting this to a non-null value will	803	C<ev_timer>) will be not affected. Setting this to a non-null value will
657	introduce an additional C<ev_sleep ()> call into most loop iterations.	804	introduce an additional C<ev_sleep ()> call into most loop iterations.
658		805
659	Likewise, by setting a higher I<timeout collect interval> you allow libev	806	Likewise, by setting a higher I<timeout collect interval> you allow libev
660	to spend more time collecting timeouts, at the expense of increased	807	to spend more time collecting timeouts, at the expense of increased
661	latency (the watcher callback will be called later). C<ev_io> watchers	808	latency/jitter/inexactness (the watcher callback will be called
662	will not be affected. Setting this to a non-null value will not introduce	809	later). C<ev_io> watchers will not be affected. Setting this to a non-null
663	any overhead in libev.	810	value will not introduce any overhead in libev.
664		811
665	Many (busy) programs can usually benefit by setting the io collect	812	Many (busy) programs can usually benefit by setting the I/O collect
666	interval to a value near C<0.1> or so, which is often enough for	813	interval to a value near C<0.1> or so, which is often enough for
667	interactive servers (of course not for games), likewise for timeouts. It	814	interactive servers (of course not for games), likewise for timeouts. It
668	usually doesn't make much sense to set it to a lower value than C<0.01>,	815	usually doesn't make much sense to set it to a lower value than C<0.01>,
669	as this approsaches the timing granularity of most systems.	816	as this approaches the timing granularity of most systems.
		817
		818	Setting the I<timeout collect interval> can improve the opportunity for
		819	saving power, as the program will "bundle" timer callback invocations that
		820	are "near" in time together, by delaying some, thus reducing the number of
		821	times the process sleeps and wakes up again. Another useful technique to
		822	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
		823	they fire on, say, one-second boundaries only.
		824
		825	=item ev_loop_verify (loop)
		826
		827	This function only does something when C<EV_VERIFY> support has been
		828	compiled in, which is the default for non-minimal builds. It tries to go
		829	through all internal structures and checks them for validity. If anything
		830	is found to be inconsistent, it will print an error message to standard
		831	error and call C<abort ()>.
		832
		833	This can be used to catch bugs inside libev itself: under normal
		834	circumstances, this function will never abort as of course libev keeps its
		835	data structures consistent.
670		836
671	=back	837	=back
672		838
673		839
674	=head1 ANATOMY OF A WATCHER	840	=head1 ANATOMY OF A WATCHER
		841
		842	In the following description, uppercase C<TYPE> in names stands for the
		843	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		844	watchers and C<ev_io_start> for I/O watchers.
675		845
676	A watcher is a structure that you create and register to record your	846	A watcher is a structure that you create and register to record your
677	interest in some event. For instance, if you want to wait for STDIN to	847	interest in some event. For instance, if you want to wait for STDIN to
678	become readable, you would create an C<ev_io> watcher for that:	848	become readable, you would create an C<ev_io> watcher for that:
679		849
680	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	850	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
681	{	851	{
682	ev_io_stop (w);	852	ev_io_stop (w);
683	ev_unloop (loop, EVUNLOOP_ALL);	853	ev_unloop (loop, EVUNLOOP_ALL);
684	}	854	}
685		855
686	struct ev_loop *loop = ev_default_loop (0);	856	struct ev_loop *loop = ev_default_loop (0);
		857
687	struct ev_io stdin_watcher;	858	ev_io stdin_watcher;
		859
688	ev_init (&stdin_watcher, my_cb);	860	ev_init (&stdin_watcher, my_cb);
689	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	861	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
690	ev_io_start (loop, &stdin_watcher);	862	ev_io_start (loop, &stdin_watcher);
		863
691	ev_loop (loop, 0);	864	ev_loop (loop, 0);
692		865
693	As you can see, you are responsible for allocating the memory for your	866	As you can see, you are responsible for allocating the memory for your
694	watcher structures (and it is usually a bad idea to do this on the stack,	867	watcher structures (and it is I<usually> a bad idea to do this on the
695	although this can sometimes be quite valid).	868	stack).
		869
		870	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		871	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
696		872
697	Each watcher structure must be initialised by a call to C<ev_init	873	Each watcher structure must be initialised by a call to C<ev_init
698	(watcher *, callback)>, which expects a callback to be provided. This	874	(watcher *, callback)>, which expects a callback to be provided. This
699	callback gets invoked each time the event occurs (or, in the case of io	875	callback gets invoked each time the event occurs (or, in the case of I/O
700	watchers, each time the event loop detects that the file descriptor given	876	watchers, each time the event loop detects that the file descriptor given
701	is readable and/or writable).	877	is readable and/or writable).
702		878
703	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	879	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
704	with arguments specific to this watcher type. There is also a macro	880	macro to configure it, with arguments specific to the watcher type. There
705	to combine initialisation and setting in one call: C<< ev_<type>_init	881	is also a macro to combine initialisation and setting in one call: C<<
706	(watcher *, callback, ...) >>.	882	ev_TYPE_init (watcher *, callback, ...) >>.
707		883
708	To make the watcher actually watch out for events, you have to start it	884	To make the watcher actually watch out for events, you have to start it
709	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	885	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
710	*) >>), and you can stop watching for events at any time by calling the	886	*) >>), and you can stop watching for events at any time by calling the
711	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	887	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
712		888
713	As long as your watcher is active (has been started but not stopped) you	889	As long as your watcher is active (has been started but not stopped) you
714	must not touch the values stored in it. Most specifically you must never	890	must not touch the values stored in it. Most specifically you must never
715	reinitialise it or call its C<set> macro.	891	reinitialise it or call its C<ev_TYPE_set> macro.
716		892
717	Each and every callback receives the event loop pointer as first, the	893	Each and every callback receives the event loop pointer as first, the
718	registered watcher structure as second, and a bitset of received events as	894	registered watcher structure as second, and a bitset of received events as
719	third argument.	895	third argument.
720		896
…		…
774	=item C<EV_FORK>	950	=item C<EV_FORK>
775		951
776	The event loop has been resumed in the child process after fork (see	952	The event loop has been resumed in the child process after fork (see
777	C<ev_fork>).	953	C<ev_fork>).
778		954
		955	=item C<EV_ASYNC>
		956
		957	The given async watcher has been asynchronously notified (see C<ev_async>).
		958
		959	=item C<EV_CUSTOM>
		960
		961	Not ever sent (or otherwise used) by libev itself, but can be freely used
		962	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		963
779	=item C<EV_ERROR>	964	=item C<EV_ERROR>
780		965
781	An unspecified error has occured, the watcher has been stopped. This might	966	An unspecified error has occurred, the watcher has been stopped. This might
782	happen because the watcher could not be properly started because libev	967	happen because the watcher could not be properly started because libev
783	ran out of memory, a file descriptor was found to be closed or any other	968	ran out of memory, a file descriptor was found to be closed or any other
		969	problem. Libev considers these application bugs.
		970
784	problem. You best act on it by reporting the problem and somehow coping	971	You best act on it by reporting the problem and somehow coping with the
785	with the watcher being stopped.	972	watcher being stopped. Note that well-written programs should not receive
		973	an error ever, so when your watcher receives it, this usually indicates a
		974	bug in your program.
786		975
787	Libev will usually signal a few "dummy" events together with an error,	976	Libev will usually signal a few "dummy" events together with an error, for
788	for example it might indicate that a fd is readable or writable, and if	977	example it might indicate that a fd is readable or writable, and if your
789	your callbacks is well-written it can just attempt the operation and cope	978	callbacks is well-written it can just attempt the operation and cope with
790	with the error from read() or write(). This will not work in multithreaded	979	the error from read() or write(). This will not work in multi-threaded
791	programs, though, so beware.	980	programs, though, as the fd could already be closed and reused for another
		981	thing, so beware.
792		982
793	=back	983	=back
794		984
795	=head2 GENERIC WATCHER FUNCTIONS	985	=head2 GENERIC WATCHER FUNCTIONS
796
797	In the following description, C<TYPE> stands for the watcher type,
798	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
799		986
800	=over 4	987	=over 4
801		988
802	=item C<ev_init> (ev_TYPE *watcher, callback)	989	=item C<ev_init> (ev_TYPE *watcher, callback)
803		990
…		…
809	which rolls both calls into one.	996	which rolls both calls into one.
810		997
811	You can reinitialise a watcher at any time as long as it has been stopped	998	You can reinitialise a watcher at any time as long as it has been stopped
812	(or never started) and there are no pending events outstanding.	999	(or never started) and there are no pending events outstanding.
813		1000
814	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	1001	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
815	int revents)>.	1002	int revents)>.
		1003
		1004	Example: Initialise an C<ev_io> watcher in two steps.
		1005
		1006	ev_io w;
		1007	ev_init (&w, my_cb);
		1008	ev_io_set (&w, STDIN_FILENO, EV_READ);
816		1009
817	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1010	=item C<ev_TYPE_set> (ev_TYPE *, [args])
818		1011
819	This macro initialises the type-specific parts of a watcher. You need to	1012	This macro initialises the type-specific parts of a watcher. You need to
820	call C<ev_init> at least once before you call this macro, but you can	1013	call C<ev_init> at least once before you call this macro, but you can
…		…
823	difference to the C<ev_init> macro).	1016	difference to the C<ev_init> macro).
824		1017
825	Although some watcher types do not have type-specific arguments	1018	Although some watcher types do not have type-specific arguments
826	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	1019	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
827		1020
		1021	See C<ev_init>, above, for an example.
		1022
828	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	1023	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
829		1024
830	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	1025	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
831	calls into a single call. This is the most convinient method to initialise	1026	calls into a single call. This is the most convenient method to initialise
832	a watcher. The same limitations apply, of course.	1027	a watcher. The same limitations apply, of course.
		1028
		1029	Example: Initialise and set an C<ev_io> watcher in one step.
		1030
		1031	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
833		1032
834	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1033	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
835		1034
836	Starts (activates) the given watcher. Only active watchers will receive	1035	Starts (activates) the given watcher. Only active watchers will receive
837	events. If the watcher is already active nothing will happen.	1036	events. If the watcher is already active nothing will happen.
838		1037
		1038	Example: Start the C<ev_io> watcher that is being abused as example in this
		1039	whole section.
		1040
		1041	ev_io_start (EV_DEFAULT_UC, &w);
		1042
839	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1043	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
840		1044
841	Stops the given watcher again (if active) and clears the pending	1045	Stops the given watcher if active, and clears the pending status (whether
		1046	the watcher was active or not).
		1047
842	status. It is possible that stopped watchers are pending (for example,	1048	It is possible that stopped watchers are pending - for example,
843	non-repeating timers are being stopped when they become pending), but	1049	non-repeating timers are being stopped when they become pending - but
844	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	1050	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
845	you want to free or reuse the memory used by the watcher it is therefore a	1051	pending. If you want to free or reuse the memory used by the watcher it is
846	good idea to always call its C<ev_TYPE_stop> function.	1052	therefore a good idea to always call its C<ev_TYPE_stop> function.
847		1053
848	=item bool ev_is_active (ev_TYPE *watcher)	1054	=item bool ev_is_active (ev_TYPE *watcher)
849		1055
850	Returns a true value iff the watcher is active (i.e. it has been started	1056	Returns a true value iff the watcher is active (i.e. it has been started
851	and not yet been stopped). As long as a watcher is active you must not modify	1057	and not yet been stopped). As long as a watcher is active you must not modify
…		…
877	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1083	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
878	(default: C<-2>). Pending watchers with higher priority will be invoked	1084	(default: C<-2>). Pending watchers with higher priority will be invoked
879	before watchers with lower priority, but priority will not keep watchers	1085	before watchers with lower priority, but priority will not keep watchers
880	from being executed (except for C<ev_idle> watchers).	1086	from being executed (except for C<ev_idle> watchers).
881		1087
882	This means that priorities are I<only> used for ordering callback
883	invocation after new events have been received. This is useful, for
884	example, to reduce latency after idling, or more often, to bind two
885	watchers on the same event and make sure one is called first.
886
887	If you need to suppress invocation when higher priority events are pending	1088	If you need to suppress invocation when higher priority events are pending
888	you need to look at C<ev_idle> watchers, which provide this functionality.	1089	you need to look at C<ev_idle> watchers, which provide this functionality.
889		1090
890	You I<must not> change the priority of a watcher as long as it is active or	1091	You I<must not> change the priority of a watcher as long as it is active or
891	pending.	1092	pending.
892		1093
		1094	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1095	fine, as long as you do not mind that the priority value you query might
		1096	or might not have been clamped to the valid range.
		1097
893	The default priority used by watchers when no priority has been set is	1098	The default priority used by watchers when no priority has been set is
894	always C<0>, which is supposed to not be too high and not be too low :).	1099	always C<0>, which is supposed to not be too high and not be too low :).
895		1100
896	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1101	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
897	fine, as long as you do not mind that the priority value you query might	1102	priorities.
898	or might not have been adjusted to be within valid range.
899		1103
900	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1104	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
901		1105
902	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1106	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
903	C<loop> nor C<revents> need to be valid as long as the watcher callback	1107	C<loop> nor C<revents> need to be valid as long as the watcher callback
904	can deal with that fact.	1108	can deal with that fact, as both are simply passed through to the
		1109	callback.
905		1110
906	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1111	=item int ev_clear_pending (loop, ev_TYPE *watcher)
907		1112
908	If the watcher is pending, this function returns clears its pending status	1113	If the watcher is pending, this function clears its pending status and
909	and returns its C<revents> bitset (as if its callback was invoked). If the	1114	returns its C<revents> bitset (as if its callback was invoked). If the
910	watcher isn't pending it does nothing and returns C<0>.	1115	watcher isn't pending it does nothing and returns C<0>.
911		1116
		1117	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1118	callback to be invoked, which can be accomplished with this function.
		1119
912	=back	1120	=back
913		1121
914		1122
915	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1123	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
916		1124
917	Each watcher has, by default, a member C<void *data> that you can change	1125	Each watcher has, by default, a member C<void *data> that you can change
918	and read at any time, libev will completely ignore it. This can be used	1126	and read at any time: libev will completely ignore it. This can be used
919	to associate arbitrary data with your watcher. If you need more data and	1127	to associate arbitrary data with your watcher. If you need more data and
920	don't want to allocate memory and store a pointer to it in that data	1128	don't want to allocate memory and store a pointer to it in that data
921	member, you can also "subclass" the watcher type and provide your own	1129	member, you can also "subclass" the watcher type and provide your own
922	data:	1130	data:
923		1131
924	struct my_io	1132	struct my_io
925	{	1133	{
926	struct ev_io io;	1134	ev_io io;
927	int otherfd;	1135	int otherfd;
928	void *somedata;	1136	void *somedata;
929	struct whatever *mostinteresting;	1137	struct whatever *mostinteresting;
930	}	1138	};
		1139
		1140	...
		1141	struct my_io w;
		1142	ev_io_init (&w.io, my_cb, fd, EV_READ);
931		1143
932	And since your callback will be called with a pointer to the watcher, you	1144	And since your callback will be called with a pointer to the watcher, you
933	can cast it back to your own type:	1145	can cast it back to your own type:
934		1146
935	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1147	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
936	{	1148	{
937	struct my_io *w = (struct my_io *)w_;	1149	struct my_io *w = (struct my_io *)w_;
938	...	1150	...
939	}	1151	}
940		1152
941	More interesting and less C-conformant ways of casting your callback type	1153	More interesting and less C-conformant ways of casting your callback type
942	instead have been omitted.	1154	instead have been omitted.
943		1155
944	Another common scenario is having some data structure with multiple	1156	Another common scenario is to use some data structure with multiple
945	watchers:	1157	embedded watchers:
946		1158
947	struct my_biggy	1159	struct my_biggy
948	{	1160	{
949	int some_data;	1161	int some_data;
950	ev_timer t1;	1162	ev_timer t1;
951	ev_timer t2;	1163	ev_timer t2;
952	}	1164	}
953		1165
954	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1166	In this case getting the pointer to C<my_biggy> is a bit more
955	you need to use C<offsetof>:	1167	complicated: Either you store the address of your C<my_biggy> struct
		1168	in the C<data> member of the watcher (for woozies), or you need to use
		1169	some pointer arithmetic using C<offsetof> inside your watchers (for real
		1170	programmers):
956		1171
957	#include <stddef.h>	1172	#include <stddef.h>
958		1173
959	static void	1174	static void
960	t1_cb (EV_P_ struct ev_timer *w, int revents)	1175	t1_cb (EV_P_ ev_timer *w, int revents)
961	{	1176	{
962	struct my_biggy big = (struct my_biggy *	1177	struct my_biggy big = (struct my_biggy *
963	(((char *)w) - offsetof (struct my_biggy, t1));	1178	(((char *)w) - offsetof (struct my_biggy, t1));
964	}	1179	}
965		1180
966	static void	1181	static void
967	t2_cb (EV_P_ struct ev_timer *w, int revents)	1182	t2_cb (EV_P_ ev_timer *w, int revents)
968	{	1183	{
969	struct my_biggy big = (struct my_biggy *	1184	struct my_biggy big = (struct my_biggy *
970	(((char *)w) - offsetof (struct my_biggy, t2));	1185	(((char *)w) - offsetof (struct my_biggy, t2));
971	}	1186	}
		1187
		1188	=head2 WATCHER PRIORITY MODELS
		1189
		1190	Many event loops support I<watcher priorities>, which are usually small
		1191	integers that influence the ordering of event callback invocation
		1192	between watchers in some way, all else being equal.
		1193
		1194	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1195	description for the more technical details such as the actual priority
		1196	range.
		1197
		1198	There are two common ways how these these priorities are being interpreted
		1199	by event loops:
		1200
		1201	In the more common lock-out model, higher priorities "lock out" invocation
		1202	of lower priority watchers, which means as long as higher priority
		1203	watchers receive events, lower priority watchers are not being invoked.
		1204
		1205	The less common only-for-ordering model uses priorities solely to order
		1206	callback invocation within a single event loop iteration: Higher priority
		1207	watchers are invoked before lower priority ones, but they all get invoked
		1208	before polling for new events.
		1209
		1210	Libev uses the second (only-for-ordering) model for all its watchers
		1211	except for idle watchers (which use the lock-out model).
		1212
		1213	The rationale behind this is that implementing the lock-out model for
		1214	watchers is not well supported by most kernel interfaces, and most event
		1215	libraries will just poll for the same events again and again as long as
		1216	their callbacks have not been executed, which is very inefficient in the
		1217	common case of one high-priority watcher locking out a mass of lower
		1218	priority ones.
		1219
		1220	Static (ordering) priorities are most useful when you have two or more
		1221	watchers handling the same resource: a typical usage example is having an
		1222	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1223	timeouts. Under load, data might be received while the program handles
		1224	other jobs, but since timers normally get invoked first, the timeout
		1225	handler will be executed before checking for data. In that case, giving
		1226	the timer a lower priority than the I/O watcher ensures that I/O will be
		1227	handled first even under adverse conditions (which is usually, but not
		1228	always, what you want).
		1229
		1230	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1231	will only be executed when no same or higher priority watchers have
		1232	received events, they can be used to implement the "lock-out" model when
		1233	required.
		1234
		1235	For example, to emulate how many other event libraries handle priorities,
		1236	you can associate an C<ev_idle> watcher to each such watcher, and in
		1237	the normal watcher callback, you just start the idle watcher. The real
		1238	processing is done in the idle watcher callback. This causes libev to
		1239	continously poll and process kernel event data for the watcher, but when
		1240	the lock-out case is known to be rare (which in turn is rare :), this is
		1241	workable.
		1242
		1243	Usually, however, the lock-out model implemented that way will perform
		1244	miserably under the type of load it was designed to handle. In that case,
		1245	it might be preferable to stop the real watcher before starting the
		1246	idle watcher, so the kernel will not have to process the event in case
		1247	the actual processing will be delayed for considerable time.
		1248
		1249	Here is an example of an I/O watcher that should run at a strictly lower
		1250	priority than the default, and which should only process data when no
		1251	other events are pending:
		1252
		1253	ev_idle idle; // actual processing watcher
		1254	ev_io io; // actual event watcher
		1255
		1256	static void
		1257	io_cb (EV_P_ ev_io *w, int revents)
		1258	{
		1259	// stop the I/O watcher, we received the event, but
		1260	// are not yet ready to handle it.
		1261	ev_io_stop (EV_A_ w);
		1262
		1263	// start the idle watcher to ahndle the actual event.
		1264	// it will not be executed as long as other watchers
		1265	// with the default priority are receiving events.
		1266	ev_idle_start (EV_A_ &idle);
		1267	}
		1268
		1269	static void
		1270	idle-cb (EV_P_ ev_idle *w, int revents)
		1271	{
		1272	// actual processing
		1273	read (STDIN_FILENO, ...);
		1274
		1275	// have to start the I/O watcher again, as
		1276	// we have handled the event
		1277	ev_io_start (EV_P_ &io);
		1278	}
		1279
		1280	// initialisation
		1281	ev_idle_init (&idle, idle_cb);
		1282	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1283	ev_io_start (EV_DEFAULT_ &io);
		1284
		1285	In the "real" world, it might also be beneficial to start a timer, so that
		1286	low-priority connections can not be locked out forever under load. This
		1287	enables your program to keep a lower latency for important connections
		1288	during short periods of high load, while not completely locking out less
		1289	important ones.
972		1290
973		1291
974	=head1 WATCHER TYPES	1292	=head1 WATCHER TYPES
975		1293
976	This section describes each watcher in detail, but will not repeat	1294	This section describes each watcher in detail, but will not repeat
…		…
1000	In general you can register as many read and/or write event watchers per	1318	In general you can register as many read and/or write event watchers per
1001	fd as you want (as long as you don't confuse yourself). Setting all file	1319	fd as you want (as long as you don't confuse yourself). Setting all file
1002	descriptors to non-blocking mode is also usually a good idea (but not	1320	descriptors to non-blocking mode is also usually a good idea (but not
1003	required if you know what you are doing).	1321	required if you know what you are doing).
1004		1322
1005	If you must do this, then force the use of a known-to-be-good backend	1323	If you cannot use non-blocking mode, then force the use of a
1006	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1324	known-to-be-good backend (at the time of this writing, this includes only
1007	C<EVBACKEND_POLL>).	1325	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1008		1326
1009	Another thing you have to watch out for is that it is quite easy to	1327	Another thing you have to watch out for is that it is quite easy to
1010	receive "spurious" readyness notifications, that is your callback might	1328	receive "spurious" readiness notifications, that is your callback might
1011	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1329	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1012	because there is no data. Not only are some backends known to create a	1330	because there is no data. Not only are some backends known to create a
1013	lot of those (for example solaris ports), it is very easy to get into	1331	lot of those (for example Solaris ports), it is very easy to get into
1014	this situation even with a relatively standard program structure. Thus	1332	this situation even with a relatively standard program structure. Thus
1015	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1333	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1016	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1334	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1017		1335
1018	If you cannot run the fd in non-blocking mode (for example you should not	1336	If you cannot run the fd in non-blocking mode (for example you should
1019	play around with an Xlib connection), then you have to seperately re-test	1337	not play around with an Xlib connection), then you have to separately
1020	whether a file descriptor is really ready with a known-to-be good interface	1338	re-test whether a file descriptor is really ready with a known-to-be good
1021	such as poll (fortunately in our Xlib example, Xlib already does this on	1339	interface such as poll (fortunately in our Xlib example, Xlib already
1022	its own, so its quite safe to use).	1340	does this on its own, so its quite safe to use). Some people additionally
		1341	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1342	indefinitely.
		1343
		1344	But really, best use non-blocking mode.
1023		1345
1024	=head3 The special problem of disappearing file descriptors	1346	=head3 The special problem of disappearing file descriptors
1025		1347
1026	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1348	Some backends (e.g. kqueue, epoll) need to be told about closing a file
1027	descriptor (either by calling C<close> explicitly or by any other means,	1349	descriptor (either due to calling C<close> explicitly or any other means,
1028	such as C<dup>). The reason is that you register interest in some file	1350	such as C<dup2>). The reason is that you register interest in some file
1029	descriptor, but when it goes away, the operating system will silently drop	1351	descriptor, but when it goes away, the operating system will silently drop
1030	this interest. If another file descriptor with the same number then is	1352	this interest. If another file descriptor with the same number then is
1031	registered with libev, there is no efficient way to see that this is, in	1353	registered with libev, there is no efficient way to see that this is, in
1032	fact, a different file descriptor.	1354	fact, a different file descriptor.
1033		1355
…		…
1062	To support fork in your programs, you either have to call	1384	To support fork in your programs, you either have to call
1063	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1385	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1064	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1386	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1065	C<EVBACKEND_POLL>.	1387	C<EVBACKEND_POLL>.
1066		1388
		1389	=head3 The special problem of SIGPIPE
		1390
		1391	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
		1392	when writing to a pipe whose other end has been closed, your program gets
		1393	sent a SIGPIPE, which, by default, aborts your program. For most programs
		1394	this is sensible behaviour, for daemons, this is usually undesirable.
		1395
		1396	So when you encounter spurious, unexplained daemon exits, make sure you
		1397	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1398	somewhere, as that would have given you a big clue).
		1399
1067		1400
1068	=head3 Watcher-Specific Functions	1401	=head3 Watcher-Specific Functions
1069		1402
1070	=over 4	1403	=over 4
1071		1404
1072	=item ev_io_init (ev_io *, callback, int fd, int events)	1405	=item ev_io_init (ev_io *, callback, int fd, int events)
1073		1406
1074	=item ev_io_set (ev_io *, int fd, int events)	1407	=item ev_io_set (ev_io *, int fd, int events)
1075		1408
1076	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1409	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1077	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1410	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1078	C<EV_READ | EV_WRITE> to receive the given events.	1411	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1079		1412
1080	=item int fd [read-only]	1413	=item int fd [read-only]
1081		1414
1082	The file descriptor being watched.	1415	The file descriptor being watched.
1083		1416
…		…
1091		1424
1092	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1425	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1093	readable, but only once. Since it is likely line-buffered, you could	1426	readable, but only once. Since it is likely line-buffered, you could
1094	attempt to read a whole line in the callback.	1427	attempt to read a whole line in the callback.
1095		1428
1096	static void	1429	static void
1097	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1430	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1098	{	1431	{
1099	ev_io_stop (loop, w);	1432	ev_io_stop (loop, w);
1100	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1433	.. read from stdin here (or from w->fd) and handle any I/O errors
1101	}	1434	}
1102		1435
1103	...	1436	...
1104	struct ev_loop *loop = ev_default_init (0);	1437	struct ev_loop *loop = ev_default_init (0);
1105	struct ev_io stdin_readable;	1438	ev_io stdin_readable;
1106	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1439	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1107	ev_io_start (loop, &stdin_readable);	1440	ev_io_start (loop, &stdin_readable);
1108	ev_loop (loop, 0);	1441	ev_loop (loop, 0);
1109		1442
1110		1443
1111	=head2 C<ev_timer> - relative and optionally repeating timeouts	1444	=head2 C<ev_timer> - relative and optionally repeating timeouts
1112		1445
1113	Timer watchers are simple relative timers that generate an event after a	1446	Timer watchers are simple relative timers that generate an event after a
1114	given time, and optionally repeating in regular intervals after that.	1447	given time, and optionally repeating in regular intervals after that.
1115		1448
1116	The timers are based on real time, that is, if you register an event that	1449	The timers are based on real time, that is, if you register an event that
1117	times out after an hour and you reset your system clock to last years	1450	times out after an hour and you reset your system clock to January last
1118	time, it will still time out after (roughly) and hour. "Roughly" because	1451	year, it will still time out after (roughly) one hour. "Roughly" because
1119	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1452	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1120	monotonic clock option helps a lot here).	1453	monotonic clock option helps a lot here).
		1454
		1455	The callback is guaranteed to be invoked only I<after> its timeout has
		1456	passed. If multiple timers become ready during the same loop iteration
		1457	then the ones with earlier time-out values are invoked before ones with
		1458	later time-out values (but this is no longer true when a callback calls
		1459	C<ev_loop> recursively).
		1460
		1461	=head3 Be smart about timeouts
		1462
		1463	Many real-world problems involve some kind of timeout, usually for error
		1464	recovery. A typical example is an HTTP request - if the other side hangs,
		1465	you want to raise some error after a while.
		1466
		1467	What follows are some ways to handle this problem, from obvious and
		1468	inefficient to smart and efficient.
		1469
		1470	In the following, a 60 second activity timeout is assumed - a timeout that
		1471	gets reset to 60 seconds each time there is activity (e.g. each time some
		1472	data or other life sign was received).
		1473
		1474	=over 4
		1475
		1476	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1477
		1478	This is the most obvious, but not the most simple way: In the beginning,
		1479	start the watcher:
		1480
		1481	ev_timer_init (timer, callback, 60., 0.);
		1482	ev_timer_start (loop, timer);
		1483
		1484	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1485	and start it again:
		1486
		1487	ev_timer_stop (loop, timer);
		1488	ev_timer_set (timer, 60., 0.);
		1489	ev_timer_start (loop, timer);
		1490
		1491	This is relatively simple to implement, but means that each time there is
		1492	some activity, libev will first have to remove the timer from its internal
		1493	data structure and then add it again. Libev tries to be fast, but it's
		1494	still not a constant-time operation.
		1495
		1496	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1497
		1498	This is the easiest way, and involves using C<ev_timer_again> instead of
		1499	C<ev_timer_start>.
		1500
		1501	To implement this, configure an C<ev_timer> with a C<repeat> value
		1502	of C<60> and then call C<ev_timer_again> at start and each time you
		1503	successfully read or write some data. If you go into an idle state where
		1504	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1505	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1506
		1507	That means you can ignore both the C<ev_timer_start> function and the
		1508	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1509	member and C<ev_timer_again>.
		1510
		1511	At start:
		1512
		1513	ev_timer_init (timer, callback);
		1514	timer->repeat = 60.;
		1515	ev_timer_again (loop, timer);
		1516
		1517	Each time there is some activity:
		1518
		1519	ev_timer_again (loop, timer);
		1520
		1521	It is even possible to change the time-out on the fly, regardless of
		1522	whether the watcher is active or not:
		1523
		1524	timer->repeat = 30.;
		1525	ev_timer_again (loop, timer);
		1526
		1527	This is slightly more efficient then stopping/starting the timer each time
		1528	you want to modify its timeout value, as libev does not have to completely
		1529	remove and re-insert the timer from/into its internal data structure.
		1530
		1531	It is, however, even simpler than the "obvious" way to do it.
		1532
		1533	=item 3. Let the timer time out, but then re-arm it as required.
		1534
		1535	This method is more tricky, but usually most efficient: Most timeouts are
		1536	relatively long compared to the intervals between other activity - in
		1537	our example, within 60 seconds, there are usually many I/O events with
		1538	associated activity resets.
		1539
		1540	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1541	but remember the time of last activity, and check for a real timeout only
		1542	within the callback:
		1543
		1544	ev_tstamp last_activity; // time of last activity
		1545
		1546	static void
		1547	callback (EV_P_ ev_timer *w, int revents)
		1548	{
		1549	ev_tstamp now = ev_now (EV_A);
		1550	ev_tstamp timeout = last_activity + 60.;
		1551
		1552	// if last_activity + 60. is older than now, we did time out
		1553	if (timeout < now)
		1554	{
		1555	// timeout occured, take action
		1556	}
		1557	else
		1558	{
		1559	// callback was invoked, but there was some activity, re-arm
		1560	// the watcher to fire in last_activity + 60, which is
		1561	// guaranteed to be in the future, so "again" is positive:
		1562	w->repeat = timeout - now;
		1563	ev_timer_again (EV_A_ w);
		1564	}
		1565	}
		1566
		1567	To summarise the callback: first calculate the real timeout (defined
		1568	as "60 seconds after the last activity"), then check if that time has
		1569	been reached, which means something I<did>, in fact, time out. Otherwise
		1570	the callback was invoked too early (C<timeout> is in the future), so
		1571	re-schedule the timer to fire at that future time, to see if maybe we have
		1572	a timeout then.
		1573
		1574	Note how C<ev_timer_again> is used, taking advantage of the
		1575	C<ev_timer_again> optimisation when the timer is already running.
		1576
		1577	This scheme causes more callback invocations (about one every 60 seconds
		1578	minus half the average time between activity), but virtually no calls to
		1579	libev to change the timeout.
		1580
		1581	To start the timer, simply initialise the watcher and set C<last_activity>
		1582	to the current time (meaning we just have some activity :), then call the
		1583	callback, which will "do the right thing" and start the timer:
		1584
		1585	ev_timer_init (timer, callback);
		1586	last_activity = ev_now (loop);
		1587	callback (loop, timer, EV_TIMEOUT);
		1588
		1589	And when there is some activity, simply store the current time in
		1590	C<last_activity>, no libev calls at all:
		1591
		1592	last_actiivty = ev_now (loop);
		1593
		1594	This technique is slightly more complex, but in most cases where the
		1595	time-out is unlikely to be triggered, much more efficient.
		1596
		1597	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1598	callback :) - just change the timeout and invoke the callback, which will
		1599	fix things for you.
		1600
		1601	=item 4. Wee, just use a double-linked list for your timeouts.
		1602
		1603	If there is not one request, but many thousands (millions...), all
		1604	employing some kind of timeout with the same timeout value, then one can
		1605	do even better:
		1606
		1607	When starting the timeout, calculate the timeout value and put the timeout
		1608	at the I<end> of the list.
		1609
		1610	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1611	the list is expected to fire (for example, using the technique #3).
		1612
		1613	When there is some activity, remove the timer from the list, recalculate
		1614	the timeout, append it to the end of the list again, and make sure to
		1615	update the C<ev_timer> if it was taken from the beginning of the list.
		1616
		1617	This way, one can manage an unlimited number of timeouts in O(1) time for
		1618	starting, stopping and updating the timers, at the expense of a major
		1619	complication, and having to use a constant timeout. The constant timeout
		1620	ensures that the list stays sorted.
		1621
		1622	=back
		1623
		1624	So which method the best?
		1625
		1626	Method #2 is a simple no-brain-required solution that is adequate in most
		1627	situations. Method #3 requires a bit more thinking, but handles many cases
		1628	better, and isn't very complicated either. In most case, choosing either
		1629	one is fine, with #3 being better in typical situations.
		1630
		1631	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1632	rather complicated, but extremely efficient, something that really pays
		1633	off after the first million or so of active timers, i.e. it's usually
		1634	overkill :)
		1635
		1636	=head3 The special problem of time updates
		1637
		1638	Establishing the current time is a costly operation (it usually takes at
		1639	least two system calls): EV therefore updates its idea of the current
		1640	time only before and after C<ev_loop> collects new events, which causes a
		1641	growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1642	lots of events in one iteration.
1121		1643
1122	The relative timeouts are calculated relative to the C<ev_now ()>	1644	The relative timeouts are calculated relative to the C<ev_now ()>
1123	time. This is usually the right thing as this timestamp refers to the time	1645	time. This is usually the right thing as this timestamp refers to the time
1124	of the event triggering whatever timeout you are modifying/starting. If	1646	of the event triggering whatever timeout you are modifying/starting. If
1125	you suspect event processing to be delayed and you I<need> to base the timeout	1647	you suspect event processing to be delayed and you I<need> to base the
1126	on the current time, use something like this to adjust for this:	1648	timeout on the current time, use something like this to adjust for this:
1127		1649
1128	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1650	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1129		1651
1130	The callback is guarenteed to be invoked only when its timeout has passed,	1652	If the event loop is suspended for a long time, you can also force an
1131	but if multiple timers become ready during the same loop iteration then	1653	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1132	order of execution is undefined.	1654	()>.
1133		1655
1134	=head3 Watcher-Specific Functions and Data Members	1656	=head3 Watcher-Specific Functions and Data Members
1135		1657
1136	=over 4	1658	=over 4
1137		1659
1138	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1660	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1139		1661
1140	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1662	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1141		1663
1142	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1664	Configure the timer to trigger after C<after> seconds. If C<repeat>
1143	C<0.>, then it will automatically be stopped. If it is positive, then the	1665	is C<0.>, then it will automatically be stopped once the timeout is
1144	timer will automatically be configured to trigger again C<repeat> seconds	1666	reached. If it is positive, then the timer will automatically be
1145	later, again, and again, until stopped manually.	1667	configured to trigger again C<repeat> seconds later, again, and again,
		1668	until stopped manually.
1146		1669
1147	The timer itself will do a best-effort at avoiding drift, that is, if you	1670	The timer itself will do a best-effort at avoiding drift, that is, if
1148	configure a timer to trigger every 10 seconds, then it will trigger at	1671	you configure a timer to trigger every 10 seconds, then it will normally
1149	exactly 10 second intervals. If, however, your program cannot keep up with	1672	trigger at exactly 10 second intervals. If, however, your program cannot
1150	the timer (because it takes longer than those 10 seconds to do stuff) the	1673	keep up with the timer (because it takes longer than those 10 seconds to
1151	timer will not fire more than once per event loop iteration.	1674	do stuff) the timer will not fire more than once per event loop iteration.
1152		1675
1153	=item ev_timer_again (loop)	1676	=item ev_timer_again (loop, ev_timer *)
1154		1677
1155	This will act as if the timer timed out and restart it again if it is	1678	This will act as if the timer timed out and restart it again if it is
1156	repeating. The exact semantics are:	1679	repeating. The exact semantics are:
1157		1680
1158	If the timer is pending, its pending status is cleared.	1681	If the timer is pending, its pending status is cleared.
1159		1682
1160	If the timer is started but nonrepeating, stop it (as if it timed out).	1683	If the timer is started but non-repeating, stop it (as if it timed out).
1161		1684
1162	If the timer is repeating, either start it if necessary (with the	1685	If the timer is repeating, either start it if necessary (with the
1163	C<repeat> value), or reset the running timer to the C<repeat> value.	1686	C<repeat> value), or reset the running timer to the C<repeat> value.
1164		1687
1165	This sounds a bit complicated, but here is a useful and typical	1688	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1166	example: Imagine you have a tcp connection and you want a so-called idle	1689	usage example.
1167	timeout, that is, you want to be called when there have been, say, 60
1168	seconds of inactivity on the socket. The easiest way to do this is to
1169	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1170	C<ev_timer_again> each time you successfully read or write some data. If
1171	you go into an idle state where you do not expect data to travel on the
1172	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1173	automatically restart it if need be.
1174
1175	That means you can ignore the C<after> value and C<ev_timer_start>
1176	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1177
1178	ev_timer_init (timer, callback, 0., 5.);
1179	ev_timer_again (loop, timer);
1180	...
1181	timer->again = 17.;
1182	ev_timer_again (loop, timer);
1183	...
1184	timer->again = 10.;
1185	ev_timer_again (loop, timer);
1186
1187	This is more slightly efficient then stopping/starting the timer each time
1188	you want to modify its timeout value.
1189		1690
1190	=item ev_tstamp repeat [read-write]	1691	=item ev_tstamp repeat [read-write]
1191		1692
1192	The current C<repeat> value. Will be used each time the watcher times out	1693	The current C<repeat> value. Will be used each time the watcher times out
1193	or C<ev_timer_again> is called and determines the next timeout (if any),	1694	or C<ev_timer_again> is called, and determines the next timeout (if any),
1194	which is also when any modifications are taken into account.	1695	which is also when any modifications are taken into account.
1195		1696
1196	=back	1697	=back
1197		1698
1198	=head3 Examples	1699	=head3 Examples
1199		1700
1200	Example: Create a timer that fires after 60 seconds.	1701	Example: Create a timer that fires after 60 seconds.
1201		1702
1202	static void	1703	static void
1203	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1704	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1204	{	1705	{
1205	.. one minute over, w is actually stopped right here	1706	.. one minute over, w is actually stopped right here
1206	}	1707	}
1207		1708
1208	struct ev_timer mytimer;	1709	ev_timer mytimer;
1209	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1710	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1210	ev_timer_start (loop, &mytimer);	1711	ev_timer_start (loop, &mytimer);
1211		1712
1212	Example: Create a timeout timer that times out after 10 seconds of	1713	Example: Create a timeout timer that times out after 10 seconds of
1213	inactivity.	1714	inactivity.
1214		1715
1215	static void	1716	static void
1216	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1717	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1217	{	1718	{
1218	.. ten seconds without any activity	1719	.. ten seconds without any activity
1219	}	1720	}
1220		1721
1221	struct ev_timer mytimer;	1722	ev_timer mytimer;
1222	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1723	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1223	ev_timer_again (&mytimer); /* start timer */	1724	ev_timer_again (&mytimer); /* start timer */
1224	ev_loop (loop, 0);	1725	ev_loop (loop, 0);
1225		1726
1226	// and in some piece of code that gets executed on any "activity":	1727	// and in some piece of code that gets executed on any "activity":
1227	// reset the timeout to start ticking again at 10 seconds	1728	// reset the timeout to start ticking again at 10 seconds
1228	ev_timer_again (&mytimer);	1729	ev_timer_again (&mytimer);
1229		1730
1230		1731
1231	=head2 C<ev_periodic> - to cron or not to cron?	1732	=head2 C<ev_periodic> - to cron or not to cron?
1232		1733
1233	Periodic watchers are also timers of a kind, but they are very versatile	1734	Periodic watchers are also timers of a kind, but they are very versatile
1234	(and unfortunately a bit complex).	1735	(and unfortunately a bit complex).
1235		1736
1236	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1737	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1237	but on wallclock time (absolute time). You can tell a periodic watcher	1738	relative time, the physical time that passes) but on wall clock time
1238	to trigger "at" some specific point in time. For example, if you tell a	1739	(absolute time, the thing you can read on your calender or clock). The
1239	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1740	difference is that wall clock time can run faster or slower than real
1240	+ 10.>) and then reset your system clock to the last year, then it will	1741	time, and time jumps are not uncommon (e.g. when you adjust your
1241	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1742	wrist-watch).
1242	roughly 10 seconds later).
1243		1743
1244	They can also be used to implement vastly more complex timers, such as	1744	You can tell a periodic watcher to trigger after some specific point
1245	triggering an event on each midnight, local time or other, complicated,	1745	in time: for example, if you tell a periodic watcher to trigger "in 10
1246	rules.	1746	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1747	not a delay) and then reset your system clock to January of the previous
		1748	year, then it will take a year or more to trigger the event (unlike an
		1749	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1750	it, as it uses a relative timeout).
1247		1751
		1752	C<ev_periodic> watchers can also be used to implement vastly more complex
		1753	timers, such as triggering an event on each "midnight, local time", or
		1754	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1755	those cannot react to time jumps.
		1756
1248	As with timers, the callback is guarenteed to be invoked only when the	1757	As with timers, the callback is guaranteed to be invoked only when the
1249	time (C<at>) has been passed, but if multiple periodic timers become ready	1758	point in time where it is supposed to trigger has passed. If multiple
1250	during the same loop iteration then order of execution is undefined.	1759	timers become ready during the same loop iteration then the ones with
		1760	earlier time-out values are invoked before ones with later time-out values
		1761	(but this is no longer true when a callback calls C<ev_loop> recursively).
1251		1762
1252	=head3 Watcher-Specific Functions and Data Members	1763	=head3 Watcher-Specific Functions and Data Members
1253		1764
1254	=over 4	1765	=over 4
1255		1766
1256	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1767	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1257		1768
1258	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1769	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1259		1770
1260	Lots of arguments, lets sort it out... There are basically three modes of	1771	Lots of arguments, let's sort it out... There are basically three modes of
1261	operation, and we will explain them from simplest to complex:	1772	operation, and we will explain them from simplest to most complex:
1262		1773
1263	=over 4	1774	=over 4
1264		1775
1265	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1776	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1266		1777
1267	In this configuration the watcher triggers an event at the wallclock time	1778	In this configuration the watcher triggers an event after the wall clock
1268	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1779	time C<offset> has passed. It will not repeat and will not adjust when a
1269	that is, if it is to be run at January 1st 2011 then it will run when the	1780	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1270	system time reaches or surpasses this time.	1781	will be stopped and invoked when the system clock reaches or surpasses
		1782	this point in time.
1271		1783
1272	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1784	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1273		1785
1274	In this mode the watcher will always be scheduled to time out at the next	1786	In this mode the watcher will always be scheduled to time out at the next
1275	C<at + N * interval> time (for some integer N, which can also be negative)	1787	C<offset + N * interval> time (for some integer N, which can also be
1276	and then repeat, regardless of any time jumps.	1788	negative) and then repeat, regardless of any time jumps. The C<offset>
		1789	argument is merely an offset into the C<interval> periods.
1277		1790
1278	This can be used to create timers that do not drift with respect to system	1791	This can be used to create timers that do not drift with respect to the
1279	time:	1792	system clock, for example, here is an C<ev_periodic> that triggers each
		1793	hour, on the hour (with respect to UTC):
1280		1794
1281	ev_periodic_set (&periodic, 0., 3600., 0);	1795	ev_periodic_set (&periodic, 0., 3600., 0);
1282		1796
1283	This doesn't mean there will always be 3600 seconds in between triggers,	1797	This doesn't mean there will always be 3600 seconds in between triggers,
1284	but only that the the callback will be called when the system time shows a	1798	but only that the callback will be called when the system time shows a
1285	full hour (UTC), or more correctly, when the system time is evenly divisible	1799	full hour (UTC), or more correctly, when the system time is evenly divisible
1286	by 3600.	1800	by 3600.
1287		1801
1288	Another way to think about it (for the mathematically inclined) is that	1802	Another way to think about it (for the mathematically inclined) is that
1289	C<ev_periodic> will try to run the callback in this mode at the next possible	1803	C<ev_periodic> will try to run the callback in this mode at the next possible
1290	time where C<time = at (mod interval)>, regardless of any time jumps.	1804	time where C<time = offset (mod interval)>, regardless of any time jumps.
1291		1805
1292	For numerical stability it is preferable that the C<at> value is near	1806	For numerical stability it is preferable that the C<offset> value is near
1293	C<ev_now ()> (the current time), but there is no range requirement for	1807	C<ev_now ()> (the current time), but there is no range requirement for
1294	this value.	1808	this value, and in fact is often specified as zero.
1295		1809
		1810	Note also that there is an upper limit to how often a timer can fire (CPU
		1811	speed for example), so if C<interval> is very small then timing stability
		1812	will of course deteriorate. Libev itself tries to be exact to be about one
		1813	millisecond (if the OS supports it and the machine is fast enough).
		1814
1296	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1815	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1297		1816
1298	In this mode the values for C<interval> and C<at> are both being	1817	In this mode the values for C<interval> and C<offset> are both being
1299	ignored. Instead, each time the periodic watcher gets scheduled, the	1818	ignored. Instead, each time the periodic watcher gets scheduled, the
1300	reschedule callback will be called with the watcher as first, and the	1819	reschedule callback will be called with the watcher as first, and the
1301	current time as second argument.	1820	current time as second argument.
1302		1821
1303	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1822	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1304	ever, or make any event loop modifications>. If you need to stop it,	1823	or make ANY other event loop modifications whatsoever, unless explicitly
1305	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1824	allowed by documentation here>.
1306	starting an C<ev_prepare> watcher, which is legal).
1307		1825
		1826	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1827	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1828	only event loop modification you are allowed to do).
		1829
1308	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1830	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1309	ev_tstamp now)>, e.g.:	1831	*w, ev_tstamp now)>, e.g.:
1310		1832
		1833	static ev_tstamp
1311	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1834	my_rescheduler (ev_periodic *w, ev_tstamp now)
1312	{	1835	{
1313	return now + 60.;	1836	return now + 60.;
1314	}	1837	}
1315		1838
1316	It must return the next time to trigger, based on the passed time value	1839	It must return the next time to trigger, based on the passed time value
1317	(that is, the lowest time value larger than to the second argument). It	1840	(that is, the lowest time value larger than to the second argument). It
1318	will usually be called just before the callback will be triggered, but	1841	will usually be called just before the callback will be triggered, but
1319	might be called at other times, too.	1842	might be called at other times, too.
1320		1843
1321	NOTE: I<< This callback must always return a time that is later than the	1844	NOTE: I<< This callback must always return a time that is higher than or
1322	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1845	equal to the passed C<now> value >>.
1323		1846
1324	This can be used to create very complex timers, such as a timer that	1847	This can be used to create very complex timers, such as a timer that
1325	triggers on each midnight, local time. To do this, you would calculate the	1848	triggers on "next midnight, local time". To do this, you would calculate the
1326	next midnight after C<now> and return the timestamp value for this. How	1849	next midnight after C<now> and return the timestamp value for this. How
1327	you do this is, again, up to you (but it is not trivial, which is the main	1850	you do this is, again, up to you (but it is not trivial, which is the main
1328	reason I omitted it as an example).	1851	reason I omitted it as an example).
1329		1852
1330	=back	1853	=back
…		…
1334	Simply stops and restarts the periodic watcher again. This is only useful	1857	Simply stops and restarts the periodic watcher again. This is only useful
1335	when you changed some parameters or the reschedule callback would return	1858	when you changed some parameters or the reschedule callback would return
1336	a different time than the last time it was called (e.g. in a crond like	1859	a different time than the last time it was called (e.g. in a crond like
1337	program when the crontabs have changed).	1860	program when the crontabs have changed).
1338		1861
		1862	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1863
		1864	When active, returns the absolute time that the watcher is supposed
		1865	to trigger next. This is not the same as the C<offset> argument to
		1866	C<ev_periodic_set>, but indeed works even in interval and manual
		1867	rescheduling modes.
		1868
1339	=item ev_tstamp offset [read-write]	1869	=item ev_tstamp offset [read-write]
1340		1870
1341	When repeating, this contains the offset value, otherwise this is the	1871	When repeating, this contains the offset value, otherwise this is the
1342	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1872	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1873	although libev might modify this value for better numerical stability).
1343		1874
1344	Can be modified any time, but changes only take effect when the periodic	1875	Can be modified any time, but changes only take effect when the periodic
1345	timer fires or C<ev_periodic_again> is being called.	1876	timer fires or C<ev_periodic_again> is being called.
1346		1877
1347	=item ev_tstamp interval [read-write]	1878	=item ev_tstamp interval [read-write]
1348		1879
1349	The current interval value. Can be modified any time, but changes only	1880	The current interval value. Can be modified any time, but changes only
1350	take effect when the periodic timer fires or C<ev_periodic_again> is being	1881	take effect when the periodic timer fires or C<ev_periodic_again> is being
1351	called.	1882	called.
1352		1883
1353	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1884	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1354		1885
1355	The current reschedule callback, or C<0>, if this functionality is	1886	The current reschedule callback, or C<0>, if this functionality is
1356	switched off. Can be changed any time, but changes only take effect when	1887	switched off. Can be changed any time, but changes only take effect when
1357	the periodic timer fires or C<ev_periodic_again> is being called.	1888	the periodic timer fires or C<ev_periodic_again> is being called.
1358		1889
1359	=item ev_tstamp at [read-only]
1360
1361	When active, contains the absolute time that the watcher is supposed to
1362	trigger next.
1363
1364	=back	1890	=back
1365		1891
1366	=head3 Examples	1892	=head3 Examples
1367		1893
1368	Example: Call a callback every hour, or, more precisely, whenever the	1894	Example: Call a callback every hour, or, more precisely, whenever the
1369	system clock is divisible by 3600. The callback invocation times have	1895	system time is divisible by 3600. The callback invocation times have
1370	potentially a lot of jittering, but good long-term stability.	1896	potentially a lot of jitter, but good long-term stability.
1371		1897
1372	static void	1898	static void
1373	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1899	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1374	{	1900	{
1375	... its now a full hour (UTC, or TAI or whatever your clock follows)	1901	... its now a full hour (UTC, or TAI or whatever your clock follows)
1376	}	1902	}
1377		1903
1378	struct ev_periodic hourly_tick;	1904	ev_periodic hourly_tick;
1379	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1905	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1380	ev_periodic_start (loop, &hourly_tick);	1906	ev_periodic_start (loop, &hourly_tick);
1381		1907
1382	Example: The same as above, but use a reschedule callback to do it:	1908	Example: The same as above, but use a reschedule callback to do it:
1383		1909
1384	#include <math.h>	1910	#include <math.h>
1385		1911
1386	static ev_tstamp	1912	static ev_tstamp
1387	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1913	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1388	{	1914	{
1389	return fmod (now, 3600.) + 3600.;	1915	return now + (3600. - fmod (now, 3600.));
1390	}	1916	}
1391		1917
1392	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1918	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1393		1919
1394	Example: Call a callback every hour, starting now:	1920	Example: Call a callback every hour, starting now:
1395		1921
1396	struct ev_periodic hourly_tick;	1922	ev_periodic hourly_tick;
1397	ev_periodic_init (&hourly_tick, clock_cb,	1923	ev_periodic_init (&hourly_tick, clock_cb,
1398	fmod (ev_now (loop), 3600.), 3600., 0);	1924	fmod (ev_now (loop), 3600.), 3600., 0);
1399	ev_periodic_start (loop, &hourly_tick);	1925	ev_periodic_start (loop, &hourly_tick);
1400		1926
1401		1927
1402	=head2 C<ev_signal> - signal me when a signal gets signalled!	1928	=head2 C<ev_signal> - signal me when a signal gets signalled!
1403		1929
1404	Signal watchers will trigger an event when the process receives a specific	1930	Signal watchers will trigger an event when the process receives a specific
1405	signal one or more times. Even though signals are very asynchronous, libev	1931	signal one or more times. Even though signals are very asynchronous, libev
1406	will try it's best to deliver signals synchronously, i.e. as part of the	1932	will try it's best to deliver signals synchronously, i.e. as part of the
1407	normal event processing, like any other event.	1933	normal event processing, like any other event.
1408		1934
		1935	If you want signals asynchronously, just use C<sigaction> as you would
		1936	do without libev and forget about sharing the signal. You can even use
		1937	C<ev_async> from a signal handler to synchronously wake up an event loop.
		1938
1409	You can configure as many watchers as you like per signal. Only when the	1939	You can configure as many watchers as you like per signal. Only when the
1410	first watcher gets started will libev actually register a signal watcher	1940	first watcher gets started will libev actually register a signal handler
1411	with the kernel (thus it coexists with your own signal handlers as long	1941	with the kernel (thus it coexists with your own signal handlers as long as
1412	as you don't register any with libev). Similarly, when the last signal	1942	you don't register any with libev for the same signal). Similarly, when
1413	watcher for a signal is stopped libev will reset the signal handler to	1943	the last signal watcher for a signal is stopped, libev will reset the
1414	SIG_DFL (regardless of what it was set to before).	1944	signal handler to SIG_DFL (regardless of what it was set to before).
		1945
		1946	If possible and supported, libev will install its handlers with
		1947	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
		1948	interrupted. If you have a problem with system calls getting interrupted by
		1949	signals you can block all signals in an C<ev_check> watcher and unblock
		1950	them in an C<ev_prepare> watcher.
1415		1951
1416	=head3 Watcher-Specific Functions and Data Members	1952	=head3 Watcher-Specific Functions and Data Members
1417		1953
1418	=over 4	1954	=over 4
1419		1955
…		…
1428		1964
1429	The signal the watcher watches out for.	1965	The signal the watcher watches out for.
1430		1966
1431	=back	1967	=back
1432		1968
		1969	=head3 Examples
		1970
		1971	Example: Try to exit cleanly on SIGINT.
		1972
		1973	static void
		1974	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
		1975	{
		1976	ev_unloop (loop, EVUNLOOP_ALL);
		1977	}
		1978
		1979	ev_signal signal_watcher;
		1980	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1981	ev_signal_start (loop, &signal_watcher);
		1982
1433		1983
1434	=head2 C<ev_child> - watch out for process status changes	1984	=head2 C<ev_child> - watch out for process status changes
1435		1985
1436	Child watchers trigger when your process receives a SIGCHLD in response to	1986	Child watchers trigger when your process receives a SIGCHLD in response to
1437	some child status changes (most typically when a child of yours dies).	1987	some child status changes (most typically when a child of yours dies or
		1988	exits). It is permissible to install a child watcher I<after> the child
		1989	has been forked (which implies it might have already exited), as long
		1990	as the event loop isn't entered (or is continued from a watcher), i.e.,
		1991	forking and then immediately registering a watcher for the child is fine,
		1992	but forking and registering a watcher a few event loop iterations later is
		1993	not.
		1994
		1995	Only the default event loop is capable of handling signals, and therefore
		1996	you can only register child watchers in the default event loop.
		1997
		1998	=head3 Process Interaction
		1999
		2000	Libev grabs C<SIGCHLD> as soon as the default event loop is
		2001	initialised. This is necessary to guarantee proper behaviour even if
		2002	the first child watcher is started after the child exits. The occurrence
		2003	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		2004	synchronously as part of the event loop processing. Libev always reaps all
		2005	children, even ones not watched.
		2006
		2007	=head3 Overriding the Built-In Processing
		2008
		2009	Libev offers no special support for overriding the built-in child
		2010	processing, but if your application collides with libev's default child
		2011	handler, you can override it easily by installing your own handler for
		2012	C<SIGCHLD> after initialising the default loop, and making sure the
		2013	default loop never gets destroyed. You are encouraged, however, to use an
		2014	event-based approach to child reaping and thus use libev's support for
		2015	that, so other libev users can use C<ev_child> watchers freely.
		2016
		2017	=head3 Stopping the Child Watcher
		2018
		2019	Currently, the child watcher never gets stopped, even when the
		2020	child terminates, so normally one needs to stop the watcher in the
		2021	callback. Future versions of libev might stop the watcher automatically
		2022	when a child exit is detected.
1438		2023
1439	=head3 Watcher-Specific Functions and Data Members	2024	=head3 Watcher-Specific Functions and Data Members
1440		2025
1441	=over 4	2026	=over 4
1442		2027
…		…
1468		2053
1469	=back	2054	=back
1470		2055
1471	=head3 Examples	2056	=head3 Examples
1472		2057
1473	Example: Try to exit cleanly on SIGINT and SIGTERM.	2058	Example: C<fork()> a new process and install a child handler to wait for
		2059	its completion.
1474		2060
		2061	ev_child cw;
		2062
1475	static void	2063	static void
1476	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	2064	child_cb (EV_P_ ev_child *w, int revents)
1477	{	2065	{
1478	ev_unloop (loop, EVUNLOOP_ALL);	2066	ev_child_stop (EV_A_ w);
		2067	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1479	}	2068	}
1480		2069
1481	struct ev_signal signal_watcher;	2070	pid_t pid = fork ();
1482	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2071
1483	ev_signal_start (loop, &sigint_cb);	2072	if (pid < 0)
		2073	// error
		2074	else if (pid == 0)
		2075	{
		2076	// the forked child executes here
		2077	exit (1);
		2078	}
		2079	else
		2080	{
		2081	ev_child_init (&cw, child_cb, pid, 0);
		2082	ev_child_start (EV_DEFAULT_ &cw);
		2083	}
1484		2084
1485		2085
1486	=head2 C<ev_stat> - did the file attributes just change?	2086	=head2 C<ev_stat> - did the file attributes just change?
1487		2087
1488	This watches a filesystem path for attribute changes. That is, it calls	2088	This watches a file system path for attribute changes. That is, it calls
1489	C<stat> regularly (or when the OS says it changed) and sees if it changed	2089	C<stat> on that path in regular intervals (or when the OS says it changed)
1490	compared to the last time, invoking the callback if it did.	2090	and sees if it changed compared to the last time, invoking the callback if
		2091	it did.
1491		2092
1492	The path does not need to exist: changing from "path exists" to "path does	2093	The path does not need to exist: changing from "path exists" to "path does
1493	not exist" is a status change like any other. The condition "path does	2094	not exist" is a status change like any other. The condition "path does not
1494	not exist" is signified by the C<st_nlink> field being zero (which is	2095	exist" (or more correctly "path cannot be stat'ed") is signified by the
1495	otherwise always forced to be at least one) and all the other fields of	2096	C<st_nlink> field being zero (which is otherwise always forced to be at
1496	the stat buffer having unspecified contents.	2097	least one) and all the other fields of the stat buffer having unspecified
		2098	contents.
1497		2099
1498	The path I<should> be absolute and I<must not> end in a slash. If it is	2100	The path I<must not> end in a slash or contain special components such as
		2101	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1499	relative and your working directory changes, the behaviour is undefined.	2102	your working directory changes, then the behaviour is undefined.
1500		2103
1501	Since there is no standard to do this, the portable implementation simply	2104	Since there is no portable change notification interface available, the
1502	calls C<stat (2)> regularly on the path to see if it changed somehow. You	2105	portable implementation simply calls C<stat(2)> regularly on the path
1503	can specify a recommended polling interval for this case. If you specify	2106	to see if it changed somehow. You can specify a recommended polling
1504	a polling interval of C<0> (highly recommended!) then a I<suitable,	2107	interval for this case. If you specify a polling interval of C<0> (highly
1505	unspecified default> value will be used (which you can expect to be around	2108	recommended!) then a I<suitable, unspecified default> value will be used
1506	five seconds, although this might change dynamically). Libev will also	2109	(which you can expect to be around five seconds, although this might
1507	impose a minimum interval which is currently around C<0.1>, but thats	2110	change dynamically). Libev will also impose a minimum interval which is
1508	usually overkill.	2111	currently around C<0.1>, but that's usually overkill.
1509		2112
1510	This watcher type is not meant for massive numbers of stat watchers,	2113	This watcher type is not meant for massive numbers of stat watchers,
1511	as even with OS-supported change notifications, this can be	2114	as even with OS-supported change notifications, this can be
1512	resource-intensive.	2115	resource-intensive.
1513		2116
1514	At the time of this writing, only the Linux inotify interface is	2117	At the time of this writing, the only OS-specific interface implemented
1515	implemented (implementing kqueue support is left as an exercise for the	2118	is the Linux inotify interface (implementing kqueue support is left as an
1516	reader). Inotify will be used to give hints only and should not change the	2119	exercise for the reader. Note, however, that the author sees no way of
1517	semantics of C<ev_stat> watchers, which means that libev sometimes needs	2120	implementing C<ev_stat> semantics with kqueue, except as a hint).
1518	to fall back to regular polling again even with inotify, but changes are
1519	usually detected immediately, and if the file exists there will be no
1520	polling.
1521		2121
1522	=head3 Inotify	2122	=head3 ABI Issues (Largefile Support)
1523		2123
		2124	Libev by default (unless the user overrides this) uses the default
		2125	compilation environment, which means that on systems with large file
		2126	support disabled by default, you get the 32 bit version of the stat
		2127	structure. When using the library from programs that change the ABI to
		2128	use 64 bit file offsets the programs will fail. In that case you have to
		2129	compile libev with the same flags to get binary compatibility. This is
		2130	obviously the case with any flags that change the ABI, but the problem is
		2131	most noticeably displayed with ev_stat and large file support.
		2132
		2133	The solution for this is to lobby your distribution maker to make large
		2134	file interfaces available by default (as e.g. FreeBSD does) and not
		2135	optional. Libev cannot simply switch on large file support because it has
		2136	to exchange stat structures with application programs compiled using the
		2137	default compilation environment.
		2138
		2139	=head3 Inotify and Kqueue
		2140
1524	When C<inotify (7)> support has been compiled into libev (generally only	2141	When C<inotify (7)> support has been compiled into libev and present at
1525	available on Linux) and present at runtime, it will be used to speed up	2142	runtime, it will be used to speed up change detection where possible. The
1526	change detection where possible. The inotify descriptor will be created lazily	2143	inotify descriptor will be created lazily when the first C<ev_stat>
1527	when the first C<ev_stat> watcher is being started.	2144	watcher is being started.
1528		2145
1529	Inotify presense does not change the semantics of C<ev_stat> watchers	2146	Inotify presence does not change the semantics of C<ev_stat> watchers
1530	except that changes might be detected earlier, and in some cases, to avoid	2147	except that changes might be detected earlier, and in some cases, to avoid
1531	making regular C<stat> calls. Even in the presense of inotify support	2148	making regular C<stat> calls. Even in the presence of inotify support
1532	there are many cases where libev has to resort to regular C<stat> polling.	2149	there are many cases where libev has to resort to regular C<stat> polling,
		2150	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2151	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2152	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2153	xfs are fully working) libev usually gets away without polling.
1533		2154
1534	(There is no support for kqueue, as apparently it cannot be used to	2155	There is no support for kqueue, as apparently it cannot be used to
1535	implement this functionality, due to the requirement of having a file	2156	implement this functionality, due to the requirement of having a file
1536	descriptor open on the object at all times).	2157	descriptor open on the object at all times, and detecting renames, unlinks
		2158	etc. is difficult.
		2159
		2160	=head3 C<stat ()> is a synchronous operation
		2161
		2162	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2163	the process. The exception are C<ev_stat> watchers - those call C<stat
		2164	()>, which is a synchronous operation.
		2165
		2166	For local paths, this usually doesn't matter: unless the system is very
		2167	busy or the intervals between stat's are large, a stat call will be fast,
		2168	as the path data is usually in memory already (except when starting the
		2169	watcher).
		2170
		2171	For networked file systems, calling C<stat ()> can block an indefinite
		2172	time due to network issues, and even under good conditions, a stat call
		2173	often takes multiple milliseconds.
		2174
		2175	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2176	paths, although this is fully supported by libev.
1537		2177
1538	=head3 The special problem of stat time resolution	2178	=head3 The special problem of stat time resolution
1539		2179
1540	The C<stat ()> syscall only supports full-second resolution portably, and	2180	The C<stat ()> system call only supports full-second resolution portably,
1541	even on systems where the resolution is higher, many filesystems still	2181	and even on systems where the resolution is higher, most file systems
1542	only support whole seconds.	2182	still only support whole seconds.
1543		2183
1544	That means that, if the time is the only thing that changes, you might	2184	That means that, if the time is the only thing that changes, you can
1545	miss updates: on the first update, C<ev_stat> detects a change and calls	2185	easily miss updates: on the first update, C<ev_stat> detects a change and
1546	your callback, which does something. When there is another update within	2186	calls your callback, which does something. When there is another update
1547	the same second, C<ev_stat> will be unable to detect it.	2187	within the same second, C<ev_stat> will be unable to detect unless the
		2188	stat data does change in other ways (e.g. file size).
1548		2189
1549	The solution to this is to delay acting on a change for a second (or till	2190	The solution to this is to delay acting on a change for slightly more
1550	the next second boundary), using a roughly one-second delay C<ev_timer>	2191	than a second (or till slightly after the next full second boundary), using
1551	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	2192	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1552	is added to work around small timing inconsistencies of some operating	2193	ev_timer_again (loop, w)>).
1553	systems.	2194
		2195	The C<.02> offset is added to work around small timing inconsistencies
		2196	of some operating systems (where the second counter of the current time
		2197	might be be delayed. One such system is the Linux kernel, where a call to
		2198	C<gettimeofday> might return a timestamp with a full second later than
		2199	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		2200	update file times then there will be a small window where the kernel uses
		2201	the previous second to update file times but libev might already execute
		2202	the timer callback).
1554		2203
1555	=head3 Watcher-Specific Functions and Data Members	2204	=head3 Watcher-Specific Functions and Data Members
1556		2205
1557	=over 4	2206	=over 4
1558		2207
…		…
1564	C<path>. The C<interval> is a hint on how quickly a change is expected to	2213	C<path>. The C<interval> is a hint on how quickly a change is expected to
1565	be detected and should normally be specified as C<0> to let libev choose	2214	be detected and should normally be specified as C<0> to let libev choose
1566	a suitable value. The memory pointed to by C<path> must point to the same	2215	a suitable value. The memory pointed to by C<path> must point to the same
1567	path for as long as the watcher is active.	2216	path for as long as the watcher is active.
1568		2217
1569	The callback will be receive C<EV_STAT> when a change was detected,	2218	The callback will receive an C<EV_STAT> event when a change was detected,
1570	relative to the attributes at the time the watcher was started (or the	2219	relative to the attributes at the time the watcher was started (or the
1571	last change was detected).	2220	last change was detected).
1572		2221
1573	=item ev_stat_stat (ev_stat *)	2222	=item ev_stat_stat (loop, ev_stat *)
1574		2223
1575	Updates the stat buffer immediately with new values. If you change the	2224	Updates the stat buffer immediately with new values. If you change the
1576	watched path in your callback, you could call this fucntion to avoid	2225	watched path in your callback, you could call this function to avoid
1577	detecting this change (while introducing a race condition). Can also be	2226	detecting this change (while introducing a race condition if you are not
1578	useful simply to find out the new values.	2227	the only one changing the path). Can also be useful simply to find out the
		2228	new values.
1579		2229
1580	=item ev_statdata attr [read-only]	2230	=item ev_statdata attr [read-only]
1581		2231
1582	The most-recently detected attributes of the file. Although the type is of	2232	The most-recently detected attributes of the file. Although the type is
1583	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	2233	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1584	suitable for your system. If the C<st_nlink> member is C<0>, then there	2234	suitable for your system, but you can only rely on the POSIX-standardised
		2235	members to be present. If the C<st_nlink> member is C<0>, then there was
1585	was some error while C<stat>ing the file.	2236	some error while C<stat>ing the file.
1586		2237
1587	=item ev_statdata prev [read-only]	2238	=item ev_statdata prev [read-only]
1588		2239
1589	The previous attributes of the file. The callback gets invoked whenever	2240	The previous attributes of the file. The callback gets invoked whenever
1590	C<prev> != C<attr>.	2241	C<prev> != C<attr>, or, more precisely, one or more of these members
		2242	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		2243	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1591		2244
1592	=item ev_tstamp interval [read-only]	2245	=item ev_tstamp interval [read-only]
1593		2246
1594	The specified interval.	2247	The specified interval.
1595		2248
1596	=item const char *path [read-only]	2249	=item const char *path [read-only]
1597		2250
1598	The filesystem path that is being watched.	2251	The file system path that is being watched.
1599		2252
1600	=back	2253	=back
1601		2254
1602	=head3 Examples	2255	=head3 Examples
1603		2256
1604	Example: Watch C</etc/passwd> for attribute changes.	2257	Example: Watch C</etc/passwd> for attribute changes.
1605		2258
1606	static void	2259	static void
1607	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	2260	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1608	{	2261	{
1609	/* /etc/passwd changed in some way */	2262	/* /etc/passwd changed in some way */
1610	if (w->attr.st_nlink)	2263	if (w->attr.st_nlink)
1611	{	2264	{
1612	printf ("passwd current size %ld\n", (long)w->attr.st_size);	2265	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1613	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	2266	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1614	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	2267	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1615	}	2268	}
1616	else	2269	else
1617	/* you shalt not abuse printf for puts */	2270	/* you shalt not abuse printf for puts */
1618	puts ("wow, /etc/passwd is not there, expect problems. "	2271	puts ("wow, /etc/passwd is not there, expect problems. "
1619	"if this is windows, they already arrived\n");	2272	"if this is windows, they already arrived\n");
1620	}	2273	}
1621		2274
1622	...	2275	...
1623	ev_stat passwd;	2276	ev_stat passwd;
1624		2277
1625	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	2278	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1626	ev_stat_start (loop, &passwd);	2279	ev_stat_start (loop, &passwd);
1627		2280
1628	Example: Like above, but additionally use a one-second delay so we do not	2281	Example: Like above, but additionally use a one-second delay so we do not
1629	miss updates (however, frequent updates will delay processing, too, so	2282	miss updates (however, frequent updates will delay processing, too, so
1630	one might do the work both on C<ev_stat> callback invocation I<and> on	2283	one might do the work both on C<ev_stat> callback invocation I<and> on
1631	C<ev_timer> callback invocation).	2284	C<ev_timer> callback invocation).
1632		2285
1633	static ev_stat passwd;	2286	static ev_stat passwd;
1634	static ev_timer timer;	2287	static ev_timer timer;
1635		2288
1636	static void	2289	static void
1637	timer_cb (EV_P_ ev_timer *w, int revents)	2290	timer_cb (EV_P_ ev_timer *w, int revents)
1638	{	2291	{
1639	ev_timer_stop (EV_A_ w);	2292	ev_timer_stop (EV_A_ w);
1640		2293
1641	/* now it's one second after the most recent passwd change */	2294	/* now it's one second after the most recent passwd change */
1642	}	2295	}
1643		2296
1644	static void	2297	static void
1645	stat_cb (EV_P_ ev_stat *w, int revents)	2298	stat_cb (EV_P_ ev_stat *w, int revents)
1646	{	2299	{
1647	/* reset the one-second timer */	2300	/* reset the one-second timer */
1648	ev_timer_again (EV_A_ &timer);	2301	ev_timer_again (EV_A_ &timer);
1649	}	2302	}
1650		2303
1651	...	2304	...
1652	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	2305	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1653	ev_stat_start (loop, &passwd);	2306	ev_stat_start (loop, &passwd);
1654	ev_timer_init (&timer, timer_cb, 0., 1.01);	2307	ev_timer_init (&timer, timer_cb, 0., 1.02);
1655		2308
1656		2309
1657	=head2 C<ev_idle> - when you've got nothing better to do...	2310	=head2 C<ev_idle> - when you've got nothing better to do...
1658		2311
1659	Idle watchers trigger events when no other events of the same or higher	2312	Idle watchers trigger events when no other events of the same or higher
1660	priority are pending (prepare, check and other idle watchers do not	2313	priority are pending (prepare, check and other idle watchers do not count
1661	count).	2314	as receiving "events").
1662		2315
1663	That is, as long as your process is busy handling sockets or timeouts	2316	That is, as long as your process is busy handling sockets or timeouts
1664	(or even signals, imagine) of the same or higher priority it will not be	2317	(or even signals, imagine) of the same or higher priority it will not be
1665	triggered. But when your process is idle (or only lower-priority watchers	2318	triggered. But when your process is idle (or only lower-priority watchers
1666	are pending), the idle watchers are being called once per event loop	2319	are pending), the idle watchers are being called once per event loop
…		…
1677		2330
1678	=head3 Watcher-Specific Functions and Data Members	2331	=head3 Watcher-Specific Functions and Data Members
1679		2332
1680	=over 4	2333	=over 4
1681		2334
1682	=item ev_idle_init (ev_signal *, callback)	2335	=item ev_idle_init (ev_idle *, callback)
1683		2336
1684	Initialises and configures the idle watcher - it has no parameters of any	2337	Initialises and configures the idle watcher - it has no parameters of any
1685	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2338	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1686	believe me.	2339	believe me.
1687		2340
…		…
1690	=head3 Examples	2343	=head3 Examples
1691		2344
1692	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2345	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1693	callback, free it. Also, use no error checking, as usual.	2346	callback, free it. Also, use no error checking, as usual.
1694		2347
1695	static void	2348	static void
1696	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2349	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1697	{	2350	{
1698	free (w);	2351	free (w);
1699	// now do something you wanted to do when the program has	2352	// now do something you wanted to do when the program has
1700	// no longer anything immediate to do.	2353	// no longer anything immediate to do.
1701	}	2354	}
1702		2355
1703	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2356	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1704	ev_idle_init (idle_watcher, idle_cb);	2357	ev_idle_init (idle_watcher, idle_cb);
1705	ev_idle_start (loop, idle_cb);	2358	ev_idle_start (loop, idle_cb);
1706		2359
1707		2360
1708	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2361	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1709		2362
1710	Prepare and check watchers are usually (but not always) used in tandem:	2363	Prepare and check watchers are usually (but not always) used in pairs:
1711	prepare watchers get invoked before the process blocks and check watchers	2364	prepare watchers get invoked before the process blocks and check watchers
1712	afterwards.	2365	afterwards.
1713		2366
1714	You I<must not> call C<ev_loop> or similar functions that enter	2367	You I<must not> call C<ev_loop> or similar functions that enter
1715	the current event loop from either C<ev_prepare> or C<ev_check>	2368	the current event loop from either C<ev_prepare> or C<ev_check>
…		…
1718	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2371	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1719	C<ev_check> so if you have one watcher of each kind they will always be	2372	C<ev_check> so if you have one watcher of each kind they will always be
1720	called in pairs bracketing the blocking call.	2373	called in pairs bracketing the blocking call.
1721		2374
1722	Their main purpose is to integrate other event mechanisms into libev and	2375	Their main purpose is to integrate other event mechanisms into libev and
1723	their use is somewhat advanced. This could be used, for example, to track	2376	their use is somewhat advanced. They could be used, for example, to track
1724	variable changes, implement your own watchers, integrate net-snmp or a	2377	variable changes, implement your own watchers, integrate net-snmp or a
1725	coroutine library and lots more. They are also occasionally useful if	2378	coroutine library and lots more. They are also occasionally useful if
1726	you cache some data and want to flush it before blocking (for example,	2379	you cache some data and want to flush it before blocking (for example,
1727	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>	2380	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1728	watcher).	2381	watcher).
1729		2382
1730	This is done by examining in each prepare call which file descriptors need	2383	This is done by examining in each prepare call which file descriptors
1731	to be watched by the other library, registering C<ev_io> watchers for	2384	need to be watched by the other library, registering C<ev_io> watchers
1732	them and starting an C<ev_timer> watcher for any timeouts (many libraries	2385	for them and starting an C<ev_timer> watcher for any timeouts (many
1733	provide just this functionality). Then, in the check watcher you check for	2386	libraries provide exactly this functionality). Then, in the check watcher,
1734	any events that occured (by checking the pending status of all watchers	2387	you check for any events that occurred (by checking the pending status
1735	and stopping them) and call back into the library. The I/O and timer	2388	of all watchers and stopping them) and call back into the library. The
1736	callbacks will never actually be called (but must be valid nevertheless,	2389	I/O and timer callbacks will never actually be called (but must be valid
1737	because you never know, you know?).	2390	nevertheless, because you never know, you know?).
1738		2391
1739	As another example, the Perl Coro module uses these hooks to integrate	2392	As another example, the Perl Coro module uses these hooks to integrate
1740	coroutines into libev programs, by yielding to other active coroutines	2393	coroutines into libev programs, by yielding to other active coroutines
1741	during each prepare and only letting the process block if no coroutines	2394	during each prepare and only letting the process block if no coroutines
1742	are ready to run (it's actually more complicated: it only runs coroutines	2395	are ready to run (it's actually more complicated: it only runs coroutines
…		…
1745	loop from blocking if lower-priority coroutines are active, thus mapping	2398	loop from blocking if lower-priority coroutines are active, thus mapping
1746	low-priority coroutines to idle/background tasks).	2399	low-priority coroutines to idle/background tasks).
1747		2400
1748	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2401	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1749	priority, to ensure that they are being run before any other watchers	2402	priority, to ensure that they are being run before any other watchers
		2403	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2404
1750	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2405	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1751	too) should not activate ("feed") events into libev. While libev fully	2406	activate ("feed") events into libev. While libev fully supports this, they
1752	supports this, they will be called before other C<ev_check> watchers	2407	might get executed before other C<ev_check> watchers did their job. As
1753	did their job. As C<ev_check> watchers are often used to embed other	2408	C<ev_check> watchers are often used to embed other (non-libev) event
1754	(non-libev) event loops those other event loops might be in an unusable	2409	loops those other event loops might be in an unusable state until their
1755	state until their C<ev_check> watcher ran (always remind yourself to	2410	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1756	coexist peacefully with others).	2411	others).
1757		2412
1758	=head3 Watcher-Specific Functions and Data Members	2413	=head3 Watcher-Specific Functions and Data Members
1759		2414
1760	=over 4	2415	=over 4
1761		2416
…		…
1763		2418
1764	=item ev_check_init (ev_check *, callback)	2419	=item ev_check_init (ev_check *, callback)
1765		2420
1766	Initialises and configures the prepare or check watcher - they have no	2421	Initialises and configures the prepare or check watcher - they have no
1767	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	2422	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1768	macros, but using them is utterly, utterly and completely pointless.	2423	macros, but using them is utterly, utterly, utterly and completely
		2424	pointless.
1769		2425
1770	=back	2426	=back
1771		2427
1772	=head3 Examples	2428	=head3 Examples
1773		2429
1774	There are a number of principal ways to embed other event loops or modules	2430	There are a number of principal ways to embed other event loops or modules
1775	into libev. Here are some ideas on how to include libadns into libev	2431	into libev. Here are some ideas on how to include libadns into libev
1776	(there is a Perl module named C<EV::ADNS> that does this, which you could	2432	(there is a Perl module named C<EV::ADNS> that does this, which you could
1777	use for an actually working example. Another Perl module named C<EV::Glib>	2433	use as a working example. Another Perl module named C<EV::Glib> embeds a
1778	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	2434	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1779	into the Glib event loop).	2435	Glib event loop).
1780		2436
1781	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	2437	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1782	and in a check watcher, destroy them and call into libadns. What follows	2438	and in a check watcher, destroy them and call into libadns. What follows
1783	is pseudo-code only of course. This requires you to either use a low	2439	is pseudo-code only of course. This requires you to either use a low
1784	priority for the check watcher or use C<ev_clear_pending> explicitly, as	2440	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1785	the callbacks for the IO/timeout watchers might not have been called yet.	2441	the callbacks for the IO/timeout watchers might not have been called yet.
1786		2442
1787	static ev_io iow [nfd];	2443	static ev_io iow [nfd];
1788	static ev_timer tw;	2444	static ev_timer tw;
1789		2445
1790	static void	2446	static void
1791	io_cb (ev_loop *loop, ev_io *w, int revents)	2447	io_cb (struct ev_loop *loop, ev_io *w, int revents)
1792	{	2448	{
1793	}	2449	}
1794		2450
1795	// create io watchers for each fd and a timer before blocking	2451	// create io watchers for each fd and a timer before blocking
1796	static void	2452	static void
1797	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2453	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1798	{	2454	{
1799	int timeout = 3600000;	2455	int timeout = 3600000;
1800	struct pollfd fds [nfd];	2456	struct pollfd fds [nfd];
1801	// actual code will need to loop here and realloc etc.	2457	// actual code will need to loop here and realloc etc.
1802	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2458	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1803		2459
1804	/* the callback is illegal, but won't be called as we stop during check */	2460	/* the callback is illegal, but won't be called as we stop during check */
1805	ev_timer_init (&tw, 0, timeout * 1e-3);	2461	ev_timer_init (&tw, 0, timeout * 1e-3);
1806	ev_timer_start (loop, &tw);	2462	ev_timer_start (loop, &tw);
1807		2463
1808	// create one ev_io per pollfd	2464	// create one ev_io per pollfd
1809	for (int i = 0; i < nfd; ++i)	2465	for (int i = 0; i < nfd; ++i)
1810	{	2466	{
1811	ev_io_init (iow + i, io_cb, fds [i].fd,	2467	ev_io_init (iow + i, io_cb, fds [i].fd,
1812	((fds [i].events & POLLIN ? EV_READ : 0)	2468	((fds [i].events & POLLIN ? EV_READ : 0)
1813	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2469	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1814		2470
1815	fds [i].revents = 0;	2471	fds [i].revents = 0;
1816	ev_io_start (loop, iow + i);	2472	ev_io_start (loop, iow + i);
1817	}	2473	}
1818	}	2474	}
1819		2475
1820	// stop all watchers after blocking	2476	// stop all watchers after blocking
1821	static void	2477	static void
1822	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2478	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
1823	{	2479	{
1824	ev_timer_stop (loop, &tw);	2480	ev_timer_stop (loop, &tw);
1825		2481
1826	for (int i = 0; i < nfd; ++i)	2482	for (int i = 0; i < nfd; ++i)
1827	{	2483	{
1828	// set the relevant poll flags	2484	// set the relevant poll flags
1829	// could also call adns_processreadable etc. here	2485	// could also call adns_processreadable etc. here
1830	struct pollfd *fd = fds + i;	2486	struct pollfd *fd = fds + i;
1831	int revents = ev_clear_pending (iow + i);	2487	int revents = ev_clear_pending (iow + i);
1832	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2488	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1833	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2489	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1834		2490
1835	// now stop the watcher	2491	// now stop the watcher
1836	ev_io_stop (loop, iow + i);	2492	ev_io_stop (loop, iow + i);
1837	}	2493	}
1838		2494
1839	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2495	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1840	}	2496	}
1841		2497
1842	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2498	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1843	in the prepare watcher and would dispose of the check watcher.	2499	in the prepare watcher and would dispose of the check watcher.
1844		2500
1845	Method 3: If the module to be embedded supports explicit event	2501	Method 3: If the module to be embedded supports explicit event
1846	notification (adns does), you can also make use of the actual watcher	2502	notification (libadns does), you can also make use of the actual watcher
1847	callbacks, and only destroy/create the watchers in the prepare watcher.	2503	callbacks, and only destroy/create the watchers in the prepare watcher.
1848		2504
1849	static void	2505	static void
1850	timer_cb (EV_P_ ev_timer *w, int revents)	2506	timer_cb (EV_P_ ev_timer *w, int revents)
1851	{	2507	{
1852	adns_state ads = (adns_state)w->data;	2508	adns_state ads = (adns_state)w->data;
1853	update_now (EV_A);	2509	update_now (EV_A);
1854		2510
1855	adns_processtimeouts (ads, &tv_now);	2511	adns_processtimeouts (ads, &tv_now);
1856	}	2512	}
1857		2513
1858	static void	2514	static void
1859	io_cb (EV_P_ ev_io *w, int revents)	2515	io_cb (EV_P_ ev_io *w, int revents)
1860	{	2516	{
1861	adns_state ads = (adns_state)w->data;	2517	adns_state ads = (adns_state)w->data;
1862	update_now (EV_A);	2518	update_now (EV_A);
1863		2519
1864	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2520	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1865	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2521	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1866	}	2522	}
1867		2523
1868	// do not ever call adns_afterpoll	2524	// do not ever call adns_afterpoll
1869		2525
1870	Method 4: Do not use a prepare or check watcher because the module you	2526	Method 4: Do not use a prepare or check watcher because the module you
1871	want to embed is too inflexible to support it. Instead, youc na override	2527	want to embed is not flexible enough to support it. Instead, you can
1872	their poll function. The drawback with this solution is that the main	2528	override their poll function. The drawback with this solution is that the
1873	loop is now no longer controllable by EV. The C<Glib::EV> module does	2529	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
1874	this.	2530	this approach, effectively embedding EV as a client into the horrible
		2531	libglib event loop.
1875		2532
1876	static gint	2533	static gint
1877	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2534	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1878	{	2535	{
1879	int got_events = 0;	2536	int got_events = 0;
1880		2537
1881	for (n = 0; n < nfds; ++n)	2538	for (n = 0; n < nfds; ++n)
1882	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2539	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1883		2540
1884	if (timeout >= 0)	2541	if (timeout >= 0)
1885	// create/start timer	2542	// create/start timer
1886		2543
1887	// poll	2544	// poll
1888	ev_loop (EV_A_ 0);	2545	ev_loop (EV_A_ 0);
1889		2546
1890	// stop timer again	2547	// stop timer again
1891	if (timeout >= 0)	2548	if (timeout >= 0)
1892	ev_timer_stop (EV_A_ &to);	2549	ev_timer_stop (EV_A_ &to);
1893		2550
1894	// stop io watchers again - their callbacks should have set	2551	// stop io watchers again - their callbacks should have set
1895	for (n = 0; n < nfds; ++n)	2552	for (n = 0; n < nfds; ++n)
1896	ev_io_stop (EV_A_ iow [n]);	2553	ev_io_stop (EV_A_ iow [n]);
1897		2554
1898	return got_events;	2555	return got_events;
1899	}	2556	}
1900		2557
1901		2558
1902	=head2 C<ev_embed> - when one backend isn't enough...	2559	=head2 C<ev_embed> - when one backend isn't enough...
1903		2560
1904	This is a rather advanced watcher type that lets you embed one event loop	2561	This is a rather advanced watcher type that lets you embed one event loop
…		…
1910	prioritise I/O.	2567	prioritise I/O.
1911		2568
1912	As an example for a bug workaround, the kqueue backend might only support	2569	As an example for a bug workaround, the kqueue backend might only support
1913	sockets on some platform, so it is unusable as generic backend, but you	2570	sockets on some platform, so it is unusable as generic backend, but you
1914	still want to make use of it because you have many sockets and it scales	2571	still want to make use of it because you have many sockets and it scales
1915	so nicely. In this case, you would create a kqueue-based loop and embed it	2572	so nicely. In this case, you would create a kqueue-based loop and embed
1916	into your default loop (which might use e.g. poll). Overall operation will	2573	it into your default loop (which might use e.g. poll). Overall operation
1917	be a bit slower because first libev has to poll and then call kevent, but	2574	will be a bit slower because first libev has to call C<poll> and then
1918	at least you can use both at what they are best.	2575	C<kevent>, but at least you can use both mechanisms for what they are
		2576	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
1919		2577
1920	As for prioritising I/O: rarely you have the case where some fds have	2578	As for prioritising I/O: under rare circumstances you have the case where
1921	to be watched and handled very quickly (with low latency), and even	2579	some fds have to be watched and handled very quickly (with low latency),
1922	priorities and idle watchers might have too much overhead. In this case	2580	and even priorities and idle watchers might have too much overhead. In
1923	you would put all the high priority stuff in one loop and all the rest in	2581	this case you would put all the high priority stuff in one loop and all
1924	a second one, and embed the second one in the first.	2582	the rest in a second one, and embed the second one in the first.
1925		2583
1926	As long as the watcher is active, the callback will be invoked every time	2584	As long as the watcher is active, the callback will be invoked every
1927	there might be events pending in the embedded loop. The callback must then	2585	time there might be events pending in the embedded loop. The callback
1928	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2586	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
1929	their callbacks (you could also start an idle watcher to give the embedded	2587	sweep and invoke their callbacks (the callback doesn't need to invoke the
1930	loop strictly lower priority for example). You can also set the callback	2588	C<ev_embed_sweep> function directly, it could also start an idle watcher
1931	to C<0>, in which case the embed watcher will automatically execute the	2589	to give the embedded loop strictly lower priority for example).
1932	embedded loop sweep.
1933		2590
1934	As long as the watcher is started it will automatically handle events. The	2591	You can also set the callback to C<0>, in which case the embed watcher
1935	callback will be invoked whenever some events have been handled. You can	2592	will automatically execute the embedded loop sweep whenever necessary.
1936	set the callback to C<0> to avoid having to specify one if you are not
1937	interested in that.
1938		2593
1939	Also, there have not currently been made special provisions for forking:	2594	Fork detection will be handled transparently while the C<ev_embed> watcher
1940	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2595	is active, i.e., the embedded loop will automatically be forked when the
1941	but you will also have to stop and restart any C<ev_embed> watchers	2596	embedding loop forks. In other cases, the user is responsible for calling
1942	yourself.	2597	C<ev_loop_fork> on the embedded loop.
1943		2598
1944	Unfortunately, not all backends are embeddable, only the ones returned by	2599	Unfortunately, not all backends are embeddable: only the ones returned by
1945	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2600	C<ev_embeddable_backends> are, which, unfortunately, does not include any
1946	portable one.	2601	portable one.
1947		2602
1948	So when you want to use this feature you will always have to be prepared	2603	So when you want to use this feature you will always have to be prepared
1949	that you cannot get an embeddable loop. The recommended way to get around	2604	that you cannot get an embeddable loop. The recommended way to get around
1950	this is to have a separate variables for your embeddable loop, try to	2605	this is to have a separate variables for your embeddable loop, try to
1951	create it, and if that fails, use the normal loop for everything.	2606	create it, and if that fails, use the normal loop for everything.
1952		2607
		2608	=head3 C<ev_embed> and fork
		2609
		2610	While the C<ev_embed> watcher is running, forks in the embedding loop will
		2611	automatically be applied to the embedded loop as well, so no special
		2612	fork handling is required in that case. When the watcher is not running,
		2613	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		2614	as applicable.
		2615
1953	=head3 Watcher-Specific Functions and Data Members	2616	=head3 Watcher-Specific Functions and Data Members
1954		2617
1955	=over 4	2618	=over 4
1956		2619
1957	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	2620	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
…		…
1960		2623
1961	Configures the watcher to embed the given loop, which must be	2624	Configures the watcher to embed the given loop, which must be
1962	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2625	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1963	invoked automatically, otherwise it is the responsibility of the callback	2626	invoked automatically, otherwise it is the responsibility of the callback
1964	to invoke it (it will continue to be called until the sweep has been done,	2627	to invoke it (it will continue to be called until the sweep has been done,
1965	if you do not want thta, you need to temporarily stop the embed watcher).	2628	if you do not want that, you need to temporarily stop the embed watcher).
1966		2629
1967	=item ev_embed_sweep (loop, ev_embed *)	2630	=item ev_embed_sweep (loop, ev_embed *)
1968		2631
1969	Make a single, non-blocking sweep over the embedded loop. This works	2632	Make a single, non-blocking sweep over the embedded loop. This works
1970	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2633	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1971	apropriate way for embedded loops.	2634	appropriate way for embedded loops.
1972		2635
1973	=item struct ev_loop *other [read-only]	2636	=item struct ev_loop *other [read-only]
1974		2637
1975	The embedded event loop.	2638	The embedded event loop.
1976		2639
…		…
1978		2641
1979	=head3 Examples	2642	=head3 Examples
1980		2643
1981	Example: Try to get an embeddable event loop and embed it into the default	2644	Example: Try to get an embeddable event loop and embed it into the default
1982	event loop. If that is not possible, use the default loop. The default	2645	event loop. If that is not possible, use the default loop. The default
1983	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2646	loop is stored in C<loop_hi>, while the embeddable loop is stored in
1984	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2647	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
1985	used).	2648	used).
1986		2649
1987	struct ev_loop *loop_hi = ev_default_init (0);	2650	struct ev_loop *loop_hi = ev_default_init (0);
1988	struct ev_loop *loop_lo = 0;	2651	struct ev_loop *loop_lo = 0;
1989	struct ev_embed embed;	2652	ev_embed embed;
1990		2653
1991	// see if there is a chance of getting one that works	2654	// see if there is a chance of getting one that works
1992	// (remember that a flags value of 0 means autodetection)	2655	// (remember that a flags value of 0 means autodetection)
1993	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2656	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1994	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2657	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1995	: 0;	2658	: 0;
1996		2659
1997	// if we got one, then embed it, otherwise default to loop_hi	2660	// if we got one, then embed it, otherwise default to loop_hi
1998	if (loop_lo)	2661	if (loop_lo)
1999	{	2662	{
2000	ev_embed_init (&embed, 0, loop_lo);	2663	ev_embed_init (&embed, 0, loop_lo);
2001	ev_embed_start (loop_hi, &embed);	2664	ev_embed_start (loop_hi, &embed);
2002	}	2665	}
2003	else	2666	else
2004	loop_lo = loop_hi;	2667	loop_lo = loop_hi;
2005		2668
2006	Example: Check if kqueue is available but not recommended and create	2669	Example: Check if kqueue is available but not recommended and create
2007	a kqueue backend for use with sockets (which usually work with any	2670	a kqueue backend for use with sockets (which usually work with any
2008	kqueue implementation). Store the kqueue/socket-only event loop in	2671	kqueue implementation). Store the kqueue/socket-only event loop in
2009	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2672	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2010		2673
2011	struct ev_loop *loop = ev_default_init (0);	2674	struct ev_loop *loop = ev_default_init (0);
2012	struct ev_loop *loop_socket = 0;	2675	struct ev_loop *loop_socket = 0;
2013	struct ev_embed embed;	2676	ev_embed embed;
2014		2677
2015	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2678	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2016	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2679	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2017	{	2680	{
2018	ev_embed_init (&embed, 0, loop_socket);	2681	ev_embed_init (&embed, 0, loop_socket);
2019	ev_embed_start (loop, &embed);	2682	ev_embed_start (loop, &embed);
2020	}	2683	}
2021		2684
2022	if (!loop_socket)	2685	if (!loop_socket)
2023	loop_socket = loop;	2686	loop_socket = loop;
2024		2687
2025	// now use loop_socket for all sockets, and loop for everything else	2688	// now use loop_socket for all sockets, and loop for everything else
2026		2689
2027		2690
2028	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2691	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2029		2692
2030	Fork watchers are called when a C<fork ()> was detected (usually because	2693	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2046	believe me.	2709	believe me.
2047		2710
2048	=back	2711	=back
2049		2712
2050		2713
		2714	=head2 C<ev_async> - how to wake up another event loop
		2715
		2716	In general, you cannot use an C<ev_loop> from multiple threads or other
		2717	asynchronous sources such as signal handlers (as opposed to multiple event
		2718	loops - those are of course safe to use in different threads).
		2719
		2720	Sometimes, however, you need to wake up another event loop you do not
		2721	control, for example because it belongs to another thread. This is what
		2722	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2723	can signal it by calling C<ev_async_send>, which is thread- and signal
		2724	safe.
		2725
		2726	This functionality is very similar to C<ev_signal> watchers, as signals,
		2727	too, are asynchronous in nature, and signals, too, will be compressed
		2728	(i.e. the number of callback invocations may be less than the number of
		2729	C<ev_async_sent> calls).
		2730
		2731	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2732	just the default loop.
		2733
		2734	=head3 Queueing
		2735
		2736	C<ev_async> does not support queueing of data in any way. The reason
		2737	is that the author does not know of a simple (or any) algorithm for a
		2738	multiple-writer-single-reader queue that works in all cases and doesn't
		2739	need elaborate support such as pthreads.
		2740
		2741	That means that if you want to queue data, you have to provide your own
		2742	queue. But at least I can tell you how to implement locking around your
		2743	queue:
		2744
		2745	=over 4
		2746
		2747	=item queueing from a signal handler context
		2748
		2749	To implement race-free queueing, you simply add to the queue in the signal
		2750	handler but you block the signal handler in the watcher callback. Here is
		2751	an example that does that for some fictitious SIGUSR1 handler:
		2752
		2753	static ev_async mysig;
		2754
		2755	static void
		2756	sigusr1_handler (void)
		2757	{
		2758	sometype data;
		2759
		2760	// no locking etc.
		2761	queue_put (data);
		2762	ev_async_send (EV_DEFAULT_ &mysig);
		2763	}
		2764
		2765	static void
		2766	mysig_cb (EV_P_ ev_async *w, int revents)
		2767	{
		2768	sometype data;
		2769	sigset_t block, prev;
		2770
		2771	sigemptyset (&block);
		2772	sigaddset (&block, SIGUSR1);
		2773	sigprocmask (SIG_BLOCK, &block, &prev);
		2774
		2775	while (queue_get (&data))
		2776	process (data);
		2777
		2778	if (sigismember (&prev, SIGUSR1)
		2779	sigprocmask (SIG_UNBLOCK, &block, 0);
		2780	}
		2781
		2782	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2783	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2784	either...).
		2785
		2786	=item queueing from a thread context
		2787
		2788	The strategy for threads is different, as you cannot (easily) block
		2789	threads but you can easily preempt them, so to queue safely you need to
		2790	employ a traditional mutex lock, such as in this pthread example:
		2791
		2792	static ev_async mysig;
		2793	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2794
		2795	static void
		2796	otherthread (void)
		2797	{
		2798	// only need to lock the actual queueing operation
		2799	pthread_mutex_lock (&mymutex);
		2800	queue_put (data);
		2801	pthread_mutex_unlock (&mymutex);
		2802
		2803	ev_async_send (EV_DEFAULT_ &mysig);
		2804	}
		2805
		2806	static void
		2807	mysig_cb (EV_P_ ev_async *w, int revents)
		2808	{
		2809	pthread_mutex_lock (&mymutex);
		2810
		2811	while (queue_get (&data))
		2812	process (data);
		2813
		2814	pthread_mutex_unlock (&mymutex);
		2815	}
		2816
		2817	=back
		2818
		2819
		2820	=head3 Watcher-Specific Functions and Data Members
		2821
		2822	=over 4
		2823
		2824	=item ev_async_init (ev_async *, callback)
		2825
		2826	Initialises and configures the async watcher - it has no parameters of any
		2827	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
		2828	trust me.
		2829
		2830	=item ev_async_send (loop, ev_async *)
		2831
		2832	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		2833	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		2834	C<ev_feed_event>, this call is safe to do from other threads, signal or
		2835	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
		2836	section below on what exactly this means).
		2837
		2838	Note that, as with other watchers in libev, multiple events might get
		2839	compressed into a single callback invocation (another way to look at this
		2840	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2841	reset when the event loop detects that).
		2842
		2843	This call incurs the overhead of a system call only once per event loop
		2844	iteration, so while the overhead might be noticeable, it doesn't apply to
		2845	repeated calls to C<ev_async_send> for the same event loop.
		2846
		2847	=item bool = ev_async_pending (ev_async *)
		2848
		2849	Returns a non-zero value when C<ev_async_send> has been called on the
		2850	watcher but the event has not yet been processed (or even noted) by the
		2851	event loop.
		2852
		2853	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2854	the loop iterates next and checks for the watcher to have become active,
		2855	it will reset the flag again. C<ev_async_pending> can be used to very
		2856	quickly check whether invoking the loop might be a good idea.
		2857
		2858	Not that this does I<not> check whether the watcher itself is pending,
		2859	only whether it has been requested to make this watcher pending: there
		2860	is a time window between the event loop checking and resetting the async
		2861	notification, and the callback being invoked.
		2862
		2863	=back
		2864
		2865
2051	=head1 OTHER FUNCTIONS	2866	=head1 OTHER FUNCTIONS
2052		2867
2053	There are some other functions of possible interest. Described. Here. Now.	2868	There are some other functions of possible interest. Described. Here. Now.
2054		2869
2055	=over 4	2870	=over 4
2056		2871
2057	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	2872	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2058		2873
2059	This function combines a simple timer and an I/O watcher, calls your	2874	This function combines a simple timer and an I/O watcher, calls your
2060	callback on whichever event happens first and automatically stop both	2875	callback on whichever event happens first and automatically stops both
2061	watchers. This is useful if you want to wait for a single event on an fd	2876	watchers. This is useful if you want to wait for a single event on an fd
2062	or timeout without having to allocate/configure/start/stop/free one or	2877	or timeout without having to allocate/configure/start/stop/free one or
2063	more watchers yourself.	2878	more watchers yourself.
2064		2879
2065	If C<fd> is less than 0, then no I/O watcher will be started and events	2880	If C<fd> is less than 0, then no I/O watcher will be started and the
2066	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2881	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2067	C<events> set will be craeted and started.	2882	the given C<fd> and C<events> set will be created and started.
2068		2883
2069	If C<timeout> is less than 0, then no timeout watcher will be	2884	If C<timeout> is less than 0, then no timeout watcher will be
2070	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2885	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2071	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2886	repeat = 0) will be started. C<0> is a valid timeout.
2072	dubious value.
2073		2887
2074	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2888	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2075	passed an C<revents> set like normal event callbacks (a combination of	2889	passed an C<revents> set like normal event callbacks (a combination of
2076	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2890	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2077	value passed to C<ev_once>:	2891	value passed to C<ev_once>. Note that it is possible to receive I<both>
		2892	a timeout and an io event at the same time - you probably should give io
		2893	events precedence.
2078		2894
		2895	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
		2896
2079	static void stdin_ready (int revents, void *arg)	2897	static void stdin_ready (int revents, void *arg)
2080	{	2898	{
2081	if (revents & EV_TIMEOUT)
2082	/* doh, nothing entered */;
2083	else if (revents & EV_READ)	2899	if (revents & EV_READ)
2084	/* stdin might have data for us, joy! */;	2900	/* stdin might have data for us, joy! */;
		2901	else if (revents & EV_TIMEOUT)
		2902	/* doh, nothing entered */;
2085	}	2903	}
2086		2904
2087	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2905	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2088		2906
2089	=item ev_feed_event (ev_loop *, watcher *, int revents)	2907	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2090		2908
2091	Feeds the given event set into the event loop, as if the specified event	2909	Feeds the given event set into the event loop, as if the specified event
2092	had happened for the specified watcher (which must be a pointer to an	2910	had happened for the specified watcher (which must be a pointer to an
2093	initialised but not necessarily started event watcher).	2911	initialised but not necessarily started event watcher).
2094		2912
2095	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2913	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2096		2914
2097	Feed an event on the given fd, as if a file descriptor backend detected	2915	Feed an event on the given fd, as if a file descriptor backend detected
2098	the given events it.	2916	the given events it.
2099		2917
2100	=item ev_feed_signal_event (ev_loop *loop, int signum)	2918	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2101		2919
2102	Feed an event as if the given signal occured (C<loop> must be the default	2920	Feed an event as if the given signal occurred (C<loop> must be the default
2103	loop!).	2921	loop!).
2104		2922
2105	=back	2923	=back
2106		2924
2107		2925
…		…
2123		2941
2124	=item * Priorities are not currently supported. Initialising priorities	2942	=item * Priorities are not currently supported. Initialising priorities
2125	will fail and all watchers will have the same priority, even though there	2943	will fail and all watchers will have the same priority, even though there
2126	is an ev_pri field.	2944	is an ev_pri field.
2127		2945
		2946	=item * In libevent, the last base created gets the signals, in libev, the
		2947	first base created (== the default loop) gets the signals.
		2948
2128	=item * Other members are not supported.	2949	=item * Other members are not supported.
2129		2950
2130	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2951	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2131	to use the libev header file and library.	2952	to use the libev header file and library.
2132		2953
2133	=back	2954	=back
2134		2955
2135	=head1 C++ SUPPORT	2956	=head1 C++ SUPPORT
2136		2957
2137	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2958	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2138	you to use some convinience methods to start/stop watchers and also change	2959	you to use some convenience methods to start/stop watchers and also change
2139	the callback model to a model using method callbacks on objects.	2960	the callback model to a model using method callbacks on objects.
2140		2961
2141	To use it,	2962	To use it,
2142		2963
2143	#include <ev++.h>	2964	#include <ev++.h>
2144		2965
2145	This automatically includes F<ev.h> and puts all of its definitions (many	2966	This automatically includes F<ev.h> and puts all of its definitions (many
2146	of them macros) into the global namespace. All C++ specific things are	2967	of them macros) into the global namespace. All C++ specific things are
2147	put into the C<ev> namespace. It should support all the same embedding	2968	put into the C<ev> namespace. It should support all the same embedding
2148	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2969	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2215	your compiler is good :), then the method will be fully inlined into the	3036	your compiler is good :), then the method will be fully inlined into the
2216	thunking function, making it as fast as a direct C callback.	3037	thunking function, making it as fast as a direct C callback.
2217		3038
2218	Example: simple class declaration and watcher initialisation	3039	Example: simple class declaration and watcher initialisation
2219		3040
2220	struct myclass	3041	struct myclass
2221	{	3042	{
2222	void io_cb (ev::io &w, int revents) { }	3043	void io_cb (ev::io &w, int revents) { }
2223	}	3044	}
2224		3045
2225	myclass obj;	3046	myclass obj;
2226	ev::io iow;	3047	ev::io iow;
2227	iow.set <myclass, &myclass::io_cb> (&obj);	3048	iow.set <myclass, &myclass::io_cb> (&obj);
		3049
		3050	=item w->set (object *)
		3051
		3052	This is an B<experimental> feature that might go away in a future version.
		3053
		3054	This is a variation of a method callback - leaving out the method to call
		3055	will default the method to C<operator ()>, which makes it possible to use
		3056	functor objects without having to manually specify the C<operator ()> all
		3057	the time. Incidentally, you can then also leave out the template argument
		3058	list.
		3059
		3060	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3061	int revents)>.
		3062
		3063	See the method-C<set> above for more details.
		3064
		3065	Example: use a functor object as callback.
		3066
		3067	struct myfunctor
		3068	{
		3069	void operator() (ev::io &w, int revents)
		3070	{
		3071	...
		3072	}
		3073	}
		3074
		3075	myfunctor f;
		3076
		3077	ev::io w;
		3078	w.set (&f);
2228		3079
2229	=item w->set<function> (void *data = 0)	3080	=item w->set<function> (void *data = 0)
2230		3081
2231	Also sets a callback, but uses a static method or plain function as	3082	Also sets a callback, but uses a static method or plain function as
2232	callback. The optional C<data> argument will be stored in the watcher's	3083	callback. The optional C<data> argument will be stored in the watcher's
…		…
2234		3085
2235	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	3086	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2236		3087
2237	See the method-C<set> above for more details.	3088	See the method-C<set> above for more details.
2238		3089
2239	Example:	3090	Example: Use a plain function as callback.
2240		3091
2241	static void io_cb (ev::io &w, int revents) { }	3092	static void io_cb (ev::io &w, int revents) { }
2242	iow.set <io_cb> ();	3093	iow.set <io_cb> ();
2243		3094
2244	=item w->set (struct ev_loop *)	3095	=item w->set (struct ev_loop *)
2245		3096
2246	Associates a different C<struct ev_loop> with this watcher. You can only	3097	Associates a different C<struct ev_loop> with this watcher. You can only
2247	do this when the watcher is inactive (and not pending either).	3098	do this when the watcher is inactive (and not pending either).
2248		3099
2249	=item w->set ([args])	3100	=item w->set ([arguments])
2250		3101
2251	Basically the same as C<ev_TYPE_set>, with the same args. Must be	3102	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2252	called at least once. Unlike the C counterpart, an active watcher gets	3103	called at least once. Unlike the C counterpart, an active watcher gets
2253	automatically stopped and restarted when reconfiguring it with this	3104	automatically stopped and restarted when reconfiguring it with this
2254	method.	3105	method.
2255		3106
2256	=item w->start ()	3107	=item w->start ()
…		…
2280	=back	3131	=back
2281		3132
2282	Example: Define a class with an IO and idle watcher, start one of them in	3133	Example: Define a class with an IO and idle watcher, start one of them in
2283	the constructor.	3134	the constructor.
2284		3135
2285	class myclass	3136	class myclass
2286	{	3137	{
2287	ev::io io; void io_cb (ev::io &w, int revents);	3138	ev::io io ; void io_cb (ev::io &w, int revents);
2288	ev:idle idle void idle_cb (ev::idle &w, int revents);	3139	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2289		3140
2290	myclass (int fd)	3141	myclass (int fd)
2291	{	3142	{
2292	io .set <myclass, &myclass::io_cb > (this);	3143	io .set <myclass, &myclass::io_cb > (this);
2293	idle.set <myclass, &myclass::idle_cb> (this);	3144	idle.set <myclass, &myclass::idle_cb> (this);
2294		3145
2295	io.start (fd, ev::READ);	3146	io.start (fd, ev::READ);
2296	}	3147	}
2297	};	3148	};
		3149
		3150
		3151	=head1 OTHER LANGUAGE BINDINGS
		3152
		3153	Libev does not offer other language bindings itself, but bindings for a
		3154	number of languages exist in the form of third-party packages. If you know
		3155	any interesting language binding in addition to the ones listed here, drop
		3156	me a note.
		3157
		3158	=over 4
		3159
		3160	=item Perl
		3161
		3162	The EV module implements the full libev API and is actually used to test
		3163	libev. EV is developed together with libev. Apart from the EV core module,
		3164	there are additional modules that implement libev-compatible interfaces
		3165	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
		3166	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3167	and C<EV::Glib>).
		3168
		3169	It can be found and installed via CPAN, its homepage is at
		3170	L<http://software.schmorp.de/pkg/EV>.
		3171
		3172	=item Python
		3173
		3174	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		3175	seems to be quite complete and well-documented.
		3176
		3177	=item Ruby
		3178
		3179	Tony Arcieri has written a ruby extension that offers access to a subset
		3180	of the libev API and adds file handle abstractions, asynchronous DNS and
		3181	more on top of it. It can be found via gem servers. Its homepage is at
		3182	L<http://rev.rubyforge.org/>.
		3183
		3184	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3185	makes rev work even on mingw.
		3186
		3187	=item Haskell
		3188
		3189	A haskell binding to libev is available at
		3190	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3191
		3192	=item D
		3193
		3194	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		3195	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3196
		3197	=item Ocaml
		3198
		3199	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3200	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		3201
		3202	=back
2298		3203
2299		3204
2300	=head1 MACRO MAGIC	3205	=head1 MACRO MAGIC
2301		3206
2302	Libev can be compiled with a variety of options, the most fundamantal	3207	Libev can be compiled with a variety of options, the most fundamental
2303	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	3208	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2304	functions and callbacks have an initial C<struct ev_loop *> argument.	3209	functions and callbacks have an initial C<struct ev_loop *> argument.
2305		3210
2306	To make it easier to write programs that cope with either variant, the	3211	To make it easier to write programs that cope with either variant, the
2307	following macros are defined:	3212	following macros are defined:
…		…
2312		3217
2313	This provides the loop I<argument> for functions, if one is required ("ev	3218	This provides the loop I<argument> for functions, if one is required ("ev
2314	loop argument"). The C<EV_A> form is used when this is the sole argument,	3219	loop argument"). The C<EV_A> form is used when this is the sole argument,
2315	C<EV_A_> is used when other arguments are following. Example:	3220	C<EV_A_> is used when other arguments are following. Example:
2316		3221
2317	ev_unref (EV_A);	3222	ev_unref (EV_A);
2318	ev_timer_add (EV_A_ watcher);	3223	ev_timer_add (EV_A_ watcher);
2319	ev_loop (EV_A_ 0);	3224	ev_loop (EV_A_ 0);
2320		3225
2321	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3226	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2322	which is often provided by the following macro.	3227	which is often provided by the following macro.
2323		3228
2324	=item C<EV_P>, C<EV_P_>	3229	=item C<EV_P>, C<EV_P_>
2325		3230
2326	This provides the loop I<parameter> for functions, if one is required ("ev	3231	This provides the loop I<parameter> for functions, if one is required ("ev
2327	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	3232	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2328	C<EV_P_> is used when other parameters are following. Example:	3233	C<EV_P_> is used when other parameters are following. Example:
2329		3234
2330	// this is how ev_unref is being declared	3235	// this is how ev_unref is being declared
2331	static void ev_unref (EV_P);	3236	static void ev_unref (EV_P);
2332		3237
2333	// this is how you can declare your typical callback	3238	// this is how you can declare your typical callback
2334	static void cb (EV_P_ ev_timer *w, int revents)	3239	static void cb (EV_P_ ev_timer *w, int revents)
2335		3240
2336	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	3241	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2337	suitable for use with C<EV_A>.	3242	suitable for use with C<EV_A>.
2338		3243
2339	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	3244	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2340		3245
2341	Similar to the other two macros, this gives you the value of the default	3246	Similar to the other two macros, this gives you the value of the default
2342	loop, if multiple loops are supported ("ev loop default").	3247	loop, if multiple loops are supported ("ev loop default").
		3248
		3249	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		3250
		3251	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		3252	default loop has been initialised (C<UC> == unchecked). Their behaviour
		3253	is undefined when the default loop has not been initialised by a previous
		3254	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		3255
		3256	It is often prudent to use C<EV_DEFAULT> when initialising the first
		3257	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2343		3258
2344	=back	3259	=back
2345		3260
2346	Example: Declare and initialise a check watcher, utilising the above	3261	Example: Declare and initialise a check watcher, utilising the above
2347	macros so it will work regardless of whether multiple loops are supported	3262	macros so it will work regardless of whether multiple loops are supported
2348	or not.	3263	or not.
2349		3264
2350	static void	3265	static void
2351	check_cb (EV_P_ ev_timer *w, int revents)	3266	check_cb (EV_P_ ev_timer *w, int revents)
2352	{	3267	{
2353	ev_check_stop (EV_A_ w);	3268	ev_check_stop (EV_A_ w);
2354	}	3269	}
2355		3270
2356	ev_check check;	3271	ev_check check;
2357	ev_check_init (&check, check_cb);	3272	ev_check_init (&check, check_cb);
2358	ev_check_start (EV_DEFAULT_ &check);	3273	ev_check_start (EV_DEFAULT_ &check);
2359	ev_loop (EV_DEFAULT_ 0);	3274	ev_loop (EV_DEFAULT_ 0);
2360		3275
2361	=head1 EMBEDDING	3276	=head1 EMBEDDING
2362		3277
2363	Libev can (and often is) directly embedded into host	3278	Libev can (and often is) directly embedded into host
2364	applications. Examples of applications that embed it include the Deliantra	3279	applications. Examples of applications that embed it include the Deliantra
…		…
2371	libev somewhere in your source tree).	3286	libev somewhere in your source tree).
2372		3287
2373	=head2 FILESETS	3288	=head2 FILESETS
2374		3289
2375	Depending on what features you need you need to include one or more sets of files	3290	Depending on what features you need you need to include one or more sets of files
2376	in your app.	3291	in your application.
2377		3292
2378	=head3 CORE EVENT LOOP	3293	=head3 CORE EVENT LOOP
2379		3294
2380	To include only the libev core (all the C<ev_*> functions), with manual	3295	To include only the libev core (all the C<ev_*> functions), with manual
2381	configuration (no autoconf):	3296	configuration (no autoconf):
2382		3297
2383	#define EV_STANDALONE 1	3298	#define EV_STANDALONE 1
2384	#include "ev.c"	3299	#include "ev.c"
2385		3300
2386	This will automatically include F<ev.h>, too, and should be done in a	3301	This will automatically include F<ev.h>, too, and should be done in a
2387	single C source file only to provide the function implementations. To use	3302	single C source file only to provide the function implementations. To use
2388	it, do the same for F<ev.h> in all files wishing to use this API (best	3303	it, do the same for F<ev.h> in all files wishing to use this API (best
2389	done by writing a wrapper around F<ev.h> that you can include instead and	3304	done by writing a wrapper around F<ev.h> that you can include instead and
2390	where you can put other configuration options):	3305	where you can put other configuration options):
2391		3306
2392	#define EV_STANDALONE 1	3307	#define EV_STANDALONE 1
2393	#include "ev.h"	3308	#include "ev.h"
2394		3309
2395	Both header files and implementation files can be compiled with a C++	3310	Both header files and implementation files can be compiled with a C++
2396	compiler (at least, thats a stated goal, and breakage will be treated	3311	compiler (at least, that's a stated goal, and breakage will be treated
2397	as a bug).	3312	as a bug).
2398		3313
2399	You need the following files in your source tree, or in a directory	3314	You need the following files in your source tree, or in a directory
2400	in your include path (e.g. in libev/ when using -Ilibev):	3315	in your include path (e.g. in libev/ when using -Ilibev):
2401		3316
2402	ev.h	3317	ev.h
2403	ev.c	3318	ev.c
2404	ev_vars.h	3319	ev_vars.h
2405	ev_wrap.h	3320	ev_wrap.h
2406		3321
2407	ev_win32.c required on win32 platforms only	3322	ev_win32.c required on win32 platforms only
2408		3323
2409	ev_select.c only when select backend is enabled (which is enabled by default)	3324	ev_select.c only when select backend is enabled (which is enabled by default)
2410	ev_poll.c only when poll backend is enabled (disabled by default)	3325	ev_poll.c only when poll backend is enabled (disabled by default)
2411	ev_epoll.c only when the epoll backend is enabled (disabled by default)	3326	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2412	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	3327	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2413	ev_port.c only when the solaris port backend is enabled (disabled by default)	3328	ev_port.c only when the solaris port backend is enabled (disabled by default)
2414		3329
2415	F<ev.c> includes the backend files directly when enabled, so you only need	3330	F<ev.c> includes the backend files directly when enabled, so you only need
2416	to compile this single file.	3331	to compile this single file.
2417		3332
2418	=head3 LIBEVENT COMPATIBILITY API	3333	=head3 LIBEVENT COMPATIBILITY API
2419		3334
2420	To include the libevent compatibility API, also include:	3335	To include the libevent compatibility API, also include:
2421		3336
2422	#include "event.c"	3337	#include "event.c"
2423		3338
2424	in the file including F<ev.c>, and:	3339	in the file including F<ev.c>, and:
2425		3340
2426	#include "event.h"	3341	#include "event.h"
2427		3342
2428	in the files that want to use the libevent API. This also includes F<ev.h>.	3343	in the files that want to use the libevent API. This also includes F<ev.h>.
2429		3344
2430	You need the following additional files for this:	3345	You need the following additional files for this:
2431		3346
2432	event.h	3347	event.h
2433	event.c	3348	event.c
2434		3349
2435	=head3 AUTOCONF SUPPORT	3350	=head3 AUTOCONF SUPPORT
2436		3351
2437	Instead of using C<EV_STANDALONE=1> and providing your config in	3352	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2438	whatever way you want, you can also C<m4_include([libev.m4])> in your	3353	whatever way you want, you can also C<m4_include([libev.m4])> in your
2439	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	3354	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2440	include F<config.h> and configure itself accordingly.	3355	include F<config.h> and configure itself accordingly.
2441		3356
2442	For this of course you need the m4 file:	3357	For this of course you need the m4 file:
2443		3358
2444	libev.m4	3359	libev.m4
2445		3360
2446	=head2 PREPROCESSOR SYMBOLS/MACROS	3361	=head2 PREPROCESSOR SYMBOLS/MACROS
2447		3362
2448	Libev can be configured via a variety of preprocessor symbols you have to define	3363	Libev can be configured via a variety of preprocessor symbols you have to
2449	before including any of its files. The default is not to build for multiplicity	3364	define before including any of its files. The default in the absence of
2450	and only include the select backend.	3365	autoconf is documented for every option.
2451		3366
2452	=over 4	3367	=over 4
2453		3368
2454	=item EV_STANDALONE	3369	=item EV_STANDALONE
2455		3370
…		…
2457	keeps libev from including F<config.h>, and it also defines dummy	3372	keeps libev from including F<config.h>, and it also defines dummy
2458	implementations for some libevent functions (such as logging, which is not	3373	implementations for some libevent functions (such as logging, which is not
2459	supported). It will also not define any of the structs usually found in	3374	supported). It will also not define any of the structs usually found in
2460	F<event.h> that are not directly supported by the libev core alone.	3375	F<event.h> that are not directly supported by the libev core alone.
2461		3376
		3377	In stanbdalone mode, libev will still try to automatically deduce the
		3378	configuration, but has to be more conservative.
		3379
2462	=item EV_USE_MONOTONIC	3380	=item EV_USE_MONOTONIC
2463		3381
2464	If defined to be C<1>, libev will try to detect the availability of the	3382	If defined to be C<1>, libev will try to detect the availability of the
2465	monotonic clock option at both compiletime and runtime. Otherwise no use	3383	monotonic clock option at both compile time and runtime. Otherwise no
2466	of the monotonic clock option will be attempted. If you enable this, you	3384	use of the monotonic clock option will be attempted. If you enable this,
2467	usually have to link against librt or something similar. Enabling it when	3385	you usually have to link against librt or something similar. Enabling it
2468	the functionality isn't available is safe, though, although you have	3386	when the functionality isn't available is safe, though, although you have
2469	to make sure you link against any libraries where the C<clock_gettime>	3387	to make sure you link against any libraries where the C<clock_gettime>
2470	function is hiding in (often F<-lrt>).	3388	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2471		3389
2472	=item EV_USE_REALTIME	3390	=item EV_USE_REALTIME
2473		3391
2474	If defined to be C<1>, libev will try to detect the availability of the	3392	If defined to be C<1>, libev will try to detect the availability of the
2475	realtime clock option at compiletime (and assume its availability at	3393	real-time clock option at compile time (and assume its availability
2476	runtime if successful). Otherwise no use of the realtime clock option will	3394	at runtime if successful). Otherwise no use of the real-time clock
2477	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3395	option will be attempted. This effectively replaces C<gettimeofday>
2478	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3396	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2479	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3397	correctness. See the note about libraries in the description of
		3398	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3399	C<EV_USE_CLOCK_SYSCALL>.
		3400
		3401	=item EV_USE_CLOCK_SYSCALL
		3402
		3403	If defined to be C<1>, libev will try to use a direct syscall instead
		3404	of calling the system-provided C<clock_gettime> function. This option
		3405	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3406	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3407	programs needlessly. Using a direct syscall is slightly slower (in
		3408	theory), because no optimised vdso implementation can be used, but avoids
		3409	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3410	higher, as it simplifies linking (no need for C<-lrt>).
2480		3411
2481	=item EV_USE_NANOSLEEP	3412	=item EV_USE_NANOSLEEP
2482		3413
2483	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3414	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2484	and will use it for delays. Otherwise it will use C<select ()>.	3415	and will use it for delays. Otherwise it will use C<select ()>.
2485		3416
		3417	=item EV_USE_EVENTFD
		3418
		3419	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		3420	available and will probe for kernel support at runtime. This will improve
		3421	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		3422	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		3423	2.7 or newer, otherwise disabled.
		3424
2486	=item EV_USE_SELECT	3425	=item EV_USE_SELECT
2487		3426
2488	If undefined or defined to be C<1>, libev will compile in support for the	3427	If undefined or defined to be C<1>, libev will compile in support for the
2489	C<select>(2) backend. No attempt at autodetection will be done: if no	3428	C<select>(2) backend. No attempt at auto-detection will be done: if no
2490	other method takes over, select will be it. Otherwise the select backend	3429	other method takes over, select will be it. Otherwise the select backend
2491	will not be compiled in.	3430	will not be compiled in.
2492		3431
2493	=item EV_SELECT_USE_FD_SET	3432	=item EV_SELECT_USE_FD_SET
2494		3433
2495	If defined to C<1>, then the select backend will use the system C<fd_set>	3434	If defined to C<1>, then the select backend will use the system C<fd_set>
2496	structure. This is useful if libev doesn't compile due to a missing	3435	structure. This is useful if libev doesn't compile due to a missing
2497	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	3436	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
2498	exotic systems. This usually limits the range of file descriptors to some	3437	on exotic systems. This usually limits the range of file descriptors to
2499	low limit such as 1024 or might have other limitations (winsocket only	3438	some low limit such as 1024 or might have other limitations (winsocket
2500	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3439	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2501	influence the size of the C<fd_set> used.	3440	configures the maximum size of the C<fd_set>.
2502		3441
2503	=item EV_SELECT_IS_WINSOCKET	3442	=item EV_SELECT_IS_WINSOCKET
2504		3443
2505	When defined to C<1>, the select backend will assume that	3444	When defined to C<1>, the select backend will assume that
2506	select/socket/connect etc. don't understand file descriptors but	3445	select/socket/connect etc. don't understand file descriptors but
…		…
2526		3465
2527	=item EV_USE_EPOLL	3466	=item EV_USE_EPOLL
2528		3467
2529	If defined to be C<1>, libev will compile in support for the Linux	3468	If defined to be C<1>, libev will compile in support for the Linux
2530	C<epoll>(7) backend. Its availability will be detected at runtime,	3469	C<epoll>(7) backend. Its availability will be detected at runtime,
2531	otherwise another method will be used as fallback. This is the	3470	otherwise another method will be used as fallback. This is the preferred
2532	preferred backend for GNU/Linux systems.	3471	backend for GNU/Linux systems. If undefined, it will be enabled if the
		3472	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2533		3473
2534	=item EV_USE_KQUEUE	3474	=item EV_USE_KQUEUE
2535		3475
2536	If defined to be C<1>, libev will compile in support for the BSD style	3476	If defined to be C<1>, libev will compile in support for the BSD style
2537	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	3477	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2550	otherwise another method will be used as fallback. This is the preferred	3490	otherwise another method will be used as fallback. This is the preferred
2551	backend for Solaris 10 systems.	3491	backend for Solaris 10 systems.
2552		3492
2553	=item EV_USE_DEVPOLL	3493	=item EV_USE_DEVPOLL
2554		3494
2555	reserved for future expansion, works like the USE symbols above.	3495	Reserved for future expansion, works like the USE symbols above.
2556		3496
2557	=item EV_USE_INOTIFY	3497	=item EV_USE_INOTIFY
2558		3498
2559	If defined to be C<1>, libev will compile in support for the Linux inotify	3499	If defined to be C<1>, libev will compile in support for the Linux inotify
2560	interface to speed up C<ev_stat> watchers. Its actual availability will	3500	interface to speed up C<ev_stat> watchers. Its actual availability will
2561	be detected at runtime.	3501	be detected at runtime. If undefined, it will be enabled if the headers
		3502	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		3503
		3504	=item EV_ATOMIC_T
		3505
		3506	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		3507	access is atomic with respect to other threads or signal contexts. No such
		3508	type is easily found in the C language, so you can provide your own type
		3509	that you know is safe for your purposes. It is used both for signal handler "locking"
		3510	as well as for signal and thread safety in C<ev_async> watchers.
		3511
		3512	In the absence of this define, libev will use C<sig_atomic_t volatile>
		3513	(from F<signal.h>), which is usually good enough on most platforms.
2562		3514
2563	=item EV_H	3515	=item EV_H
2564		3516
2565	The name of the F<ev.h> header file used to include it. The default if	3517	The name of the F<ev.h> header file used to include it. The default if
2566	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	3518	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
…		…
2604	When doing priority-based operations, libev usually has to linearly search	3556	When doing priority-based operations, libev usually has to linearly search
2605	all the priorities, so having many of them (hundreds) uses a lot of space	3557	all the priorities, so having many of them (hundreds) uses a lot of space
2606	and time, so using the defaults of five priorities (-2 .. +2) is usually	3558	and time, so using the defaults of five priorities (-2 .. +2) is usually
2607	fine.	3559	fine.
2608		3560
2609	If your embedding app does not need any priorities, defining these both to	3561	If your embedding application does not need any priorities, defining these
2610	C<0> will save some memory and cpu.	3562	both to C<0> will save some memory and CPU.
2611		3563
2612	=item EV_PERIODIC_ENABLE	3564	=item EV_PERIODIC_ENABLE
2613		3565
2614	If undefined or defined to be C<1>, then periodic timers are supported. If	3566	If undefined or defined to be C<1>, then periodic timers are supported. If
2615	defined to be C<0>, then they are not. Disabling them saves a few kB of	3567	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2622	code.	3574	code.
2623		3575
2624	=item EV_EMBED_ENABLE	3576	=item EV_EMBED_ENABLE
2625		3577
2626	If undefined or defined to be C<1>, then embed watchers are supported. If	3578	If undefined or defined to be C<1>, then embed watchers are supported. If
2627	defined to be C<0>, then they are not.	3579	defined to be C<0>, then they are not. Embed watchers rely on most other
		3580	watcher types, which therefore must not be disabled.
2628		3581
2629	=item EV_STAT_ENABLE	3582	=item EV_STAT_ENABLE
2630		3583
2631	If undefined or defined to be C<1>, then stat watchers are supported. If	3584	If undefined or defined to be C<1>, then stat watchers are supported. If
2632	defined to be C<0>, then they are not.	3585	defined to be C<0>, then they are not.
…		…
2634	=item EV_FORK_ENABLE	3587	=item EV_FORK_ENABLE
2635		3588
2636	If undefined or defined to be C<1>, then fork watchers are supported. If	3589	If undefined or defined to be C<1>, then fork watchers are supported. If
2637	defined to be C<0>, then they are not.	3590	defined to be C<0>, then they are not.
2638		3591
		3592	=item EV_ASYNC_ENABLE
		3593
		3594	If undefined or defined to be C<1>, then async watchers are supported. If
		3595	defined to be C<0>, then they are not.
		3596
2639	=item EV_MINIMAL	3597	=item EV_MINIMAL
2640		3598
2641	If you need to shave off some kilobytes of code at the expense of some	3599	If you need to shave off some kilobytes of code at the expense of some
2642	speed, define this symbol to C<1>. Currently only used for gcc to override	3600	speed, define this symbol to C<1>. Currently this is used to override some
2643	some inlining decisions, saves roughly 30% codesize of amd64.	3601	inlining decisions, saves roughly 30% code size on amd64. It also selects a
		3602	much smaller 2-heap for timer management over the default 4-heap.
2644		3603
2645	=item EV_PID_HASHSIZE	3604	=item EV_PID_HASHSIZE
2646		3605
2647	C<ev_child> watchers use a small hash table to distribute workload by	3606	C<ev_child> watchers use a small hash table to distribute workload by
2648	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3607	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2655	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3614	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2656	usually more than enough. If you need to manage thousands of C<ev_stat>	3615	usually more than enough. If you need to manage thousands of C<ev_stat>
2657	watchers you might want to increase this value (I<must> be a power of	3616	watchers you might want to increase this value (I<must> be a power of
2658	two).	3617	two).
2659		3618
		3619	=item EV_USE_4HEAP
		3620
		3621	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3622	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
		3623	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
		3624	faster performance with many (thousands) of watchers.
		3625
		3626	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3627	(disabled).
		3628
		3629	=item EV_HEAP_CACHE_AT
		3630
		3631	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3632	timer and periodics heaps, libev can cache the timestamp (I<at>) within
		3633	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3634	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3635	but avoids random read accesses on heap changes. This improves performance
		3636	noticeably with many (hundreds) of watchers.
		3637
		3638	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3639	(disabled).
		3640
		3641	=item EV_VERIFY
		3642
		3643	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3644	be done: If set to C<0>, no internal verification code will be compiled
		3645	in. If set to C<1>, then verification code will be compiled in, but not
		3646	called. If set to C<2>, then the internal verification code will be
		3647	called once per loop, which can slow down libev. If set to C<3>, then the
		3648	verification code will be called very frequently, which will slow down
		3649	libev considerably.
		3650
		3651	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3652	C<0>.
		3653
2660	=item EV_COMMON	3654	=item EV_COMMON
2661		3655
2662	By default, all watchers have a C<void *data> member. By redefining	3656	By default, all watchers have a C<void *data> member. By redefining
2663	this macro to a something else you can include more and other types of	3657	this macro to a something else you can include more and other types of
2664	members. You have to define it each time you include one of the files,	3658	members. You have to define it each time you include one of the files,
2665	though, and it must be identical each time.	3659	though, and it must be identical each time.
2666		3660
2667	For example, the perl EV module uses something like this:	3661	For example, the perl EV module uses something like this:
2668		3662
2669	#define EV_COMMON \	3663	#define EV_COMMON \
2670	SV *self; /* contains this struct */ \	3664	SV *self; /* contains this struct */ \
2671	SV *cb_sv, *fh /* note no trailing ";" */	3665	SV *cb_sv, *fh /* note no trailing ";" */
2672		3666
2673	=item EV_CB_DECLARE (type)	3667	=item EV_CB_DECLARE (type)
2674		3668
2675	=item EV_CB_INVOKE (watcher, revents)	3669	=item EV_CB_INVOKE (watcher, revents)
2676		3670
…		…
2681	definition and a statement, respectively. See the F<ev.h> header file for	3675	definition and a statement, respectively. See the F<ev.h> header file for
2682	their default definitions. One possible use for overriding these is to	3676	their default definitions. One possible use for overriding these is to
2683	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3677	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2684	method calls instead of plain function calls in C++.	3678	method calls instead of plain function calls in C++.
2685		3679
		3680	=back
		3681
2686	=head2 EXPORTED API SYMBOLS	3682	=head2 EXPORTED API SYMBOLS
2687		3683
2688	If you need to re-export the API (e.g. via a dll) and you need a list of	3684	If you need to re-export the API (e.g. via a DLL) and you need a list of
2689	exported symbols, you can use the provided F<Symbol.*> files which list	3685	exported symbols, you can use the provided F<Symbol.*> files which list
2690	all public symbols, one per line:	3686	all public symbols, one per line:
2691		3687
2692	Symbols.ev for libev proper	3688	Symbols.ev for libev proper
2693	Symbols.event for the libevent emulation	3689	Symbols.event for the libevent emulation
2694		3690
2695	This can also be used to rename all public symbols to avoid clashes with	3691	This can also be used to rename all public symbols to avoid clashes with
2696	multiple versions of libev linked together (which is obviously bad in	3692	multiple versions of libev linked together (which is obviously bad in
2697	itself, but sometimes it is inconvinient to avoid this).	3693	itself, but sometimes it is inconvenient to avoid this).
2698		3694
2699	A sed command like this will create wrapper C<#define>'s that you need to	3695	A sed command like this will create wrapper C<#define>'s that you need to
2700	include before including F<ev.h>:	3696	include before including F<ev.h>:
2701		3697
2702	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3698	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
2719	file.	3715	file.
2720		3716
2721	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3717	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2722	that everybody includes and which overrides some configure choices:	3718	that everybody includes and which overrides some configure choices:
2723		3719
2724	#define EV_MINIMAL 1	3720	#define EV_MINIMAL 1
2725	#define EV_USE_POLL 0	3721	#define EV_USE_POLL 0
2726	#define EV_MULTIPLICITY 0	3722	#define EV_MULTIPLICITY 0
2727	#define EV_PERIODIC_ENABLE 0	3723	#define EV_PERIODIC_ENABLE 0
2728	#define EV_STAT_ENABLE 0	3724	#define EV_STAT_ENABLE 0
2729	#define EV_FORK_ENABLE 0	3725	#define EV_FORK_ENABLE 0
2730	#define EV_CONFIG_H <config.h>	3726	#define EV_CONFIG_H <config.h>
2731	#define EV_MINPRI 0	3727	#define EV_MINPRI 0
2732	#define EV_MAXPRI 0	3728	#define EV_MAXPRI 0
2733		3729
2734	#include "ev++.h"	3730	#include "ev++.h"
2735		3731
2736	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3732	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2737		3733
2738	#include "ev_cpp.h"	3734	#include "ev_cpp.h"
2739	#include "ev.c"	3735	#include "ev.c"
2740		3736
		3737	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
2741		3738
2742	=head1 COMPLEXITIES	3739	=head2 THREADS AND COROUTINES
2743		3740
2744	In this section the complexities of (many of) the algorithms used inside	3741	=head3 THREADS
2745	libev will be explained. For complexity discussions about backends see the
2746	documentation for C<ev_default_init>.
2747		3742
2748	All of the following are about amortised time: If an array needs to be	3743	All libev functions are reentrant and thread-safe unless explicitly
2749	extended, libev needs to realloc and move the whole array, but this	3744	documented otherwise, but libev implements no locking itself. This means
2750	happens asymptotically never with higher number of elements, so O(1) might	3745	that you can use as many loops as you want in parallel, as long as there
2751	mean it might do a lengthy realloc operation in rare cases, but on average	3746	are no concurrent calls into any libev function with the same loop
2752	it is much faster and asymptotically approaches constant time.	3747	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		3748	of course): libev guarantees that different event loops share no data
		3749	structures that need any locking.
		3750
		3751	Or to put it differently: calls with different loop parameters can be done
		3752	concurrently from multiple threads, calls with the same loop parameter
		3753	must be done serially (but can be done from different threads, as long as
		3754	only one thread ever is inside a call at any point in time, e.g. by using
		3755	a mutex per loop).
		3756
		3757	Specifically to support threads (and signal handlers), libev implements
		3758	so-called C<ev_async> watchers, which allow some limited form of
		3759	concurrency on the same event loop, namely waking it up "from the
		3760	outside".
		3761
		3762	If you want to know which design (one loop, locking, or multiple loops
		3763	without or something else still) is best for your problem, then I cannot
		3764	help you, but here is some generic advice:
2753		3765
2754	=over 4	3766	=over 4
2755		3767
2756	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3768	=item * most applications have a main thread: use the default libev loop
		3769	in that thread, or create a separate thread running only the default loop.
2757		3770
2758	This means that, when you have a watcher that triggers in one hour and	3771	This helps integrating other libraries or software modules that use libev
2759	there are 100 watchers that would trigger before that then inserting will	3772	themselves and don't care/know about threading.
2760	have to skip roughly seven (C<ld 100>) of these watchers.
2761		3773
2762	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3774	=item * one loop per thread is usually a good model.
2763		3775
2764	That means that changing a timer costs less than removing/adding them	3776	Doing this is almost never wrong, sometimes a better-performance model
2765	as only the relative motion in the event queue has to be paid for.	3777	exists, but it is always a good start.
2766		3778
2767	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	3779	=item * other models exist, such as the leader/follower pattern, where one
		3780	loop is handed through multiple threads in a kind of round-robin fashion.
2768		3781
2769	These just add the watcher into an array or at the head of a list.	3782	Choosing a model is hard - look around, learn, know that usually you can do
		3783	better than you currently do :-)
2770		3784
2771	=item Stopping check/prepare/idle watchers: O(1)	3785	=item * often you need to talk to some other thread which blocks in the
		3786	event loop.
2772		3787
2773	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3788	C<ev_async> watchers can be used to wake them up from other threads safely
		3789	(or from signal contexts...).
2774		3790
2775	These watchers are stored in lists then need to be walked to find the	3791	An example use would be to communicate signals or other events that only
2776	correct watcher to remove. The lists are usually short (you don't usually	3792	work in the default loop by registering the signal watcher with the
2777	have many watchers waiting for the same fd or signal).	3793	default loop and triggering an C<ev_async> watcher from the default loop
2778		3794	watcher callback into the event loop interested in the signal.
2779	=item Finding the next timer in each loop iteration: O(1)
2780
2781	By virtue of using a binary heap, the next timer is always found at the
2782	beginning of the storage array.
2783
2784	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2785
2786	A change means an I/O watcher gets started or stopped, which requires
2787	libev to recalculate its status (and possibly tell the kernel, depending
2788	on backend and wether C<ev_io_set> was used).
2789
2790	=item Activating one watcher (putting it into the pending state): O(1)
2791
2792	=item Priority handling: O(number_of_priorities)
2793
2794	Priorities are implemented by allocating some space for each
2795	priority. When doing priority-based operations, libev usually has to
2796	linearly search all the priorities, but starting/stopping and activating
2797	watchers becomes O(1) w.r.t. prioritiy handling.
2798		3795
2799	=back	3796	=back
2800		3797
		3798	=head3 COROUTINES
2801		3799
2802	=head1 Win32 platform limitations and workarounds	3800	Libev is very accommodating to coroutines ("cooperative threads"):
		3801	libev fully supports nesting calls to its functions from different
		3802	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3803	different coroutines, and switch freely between both coroutines running the
		3804	loop, as long as you don't confuse yourself). The only exception is that
		3805	you must not do this from C<ev_periodic> reschedule callbacks.
		3806
		3807	Care has been taken to ensure that libev does not keep local state inside
		3808	C<ev_loop>, and other calls do not usually allow for coroutine switches as
		3809	they do not call any callbacks.
		3810
		3811	=head2 COMPILER WARNINGS
		3812
		3813	Depending on your compiler and compiler settings, you might get no or a
		3814	lot of warnings when compiling libev code. Some people are apparently
		3815	scared by this.
		3816
		3817	However, these are unavoidable for many reasons. For one, each compiler
		3818	has different warnings, and each user has different tastes regarding
		3819	warning options. "Warn-free" code therefore cannot be a goal except when
		3820	targeting a specific compiler and compiler-version.
		3821
		3822	Another reason is that some compiler warnings require elaborate
		3823	workarounds, or other changes to the code that make it less clear and less
		3824	maintainable.
		3825
		3826	And of course, some compiler warnings are just plain stupid, or simply
		3827	wrong (because they don't actually warn about the condition their message
		3828	seems to warn about). For example, certain older gcc versions had some
		3829	warnings that resulted an extreme number of false positives. These have
		3830	been fixed, but some people still insist on making code warn-free with
		3831	such buggy versions.
		3832
		3833	While libev is written to generate as few warnings as possible,
		3834	"warn-free" code is not a goal, and it is recommended not to build libev
		3835	with any compiler warnings enabled unless you are prepared to cope with
		3836	them (e.g. by ignoring them). Remember that warnings are just that:
		3837	warnings, not errors, or proof of bugs.
		3838
		3839
		3840	=head2 VALGRIND
		3841
		3842	Valgrind has a special section here because it is a popular tool that is
		3843	highly useful. Unfortunately, valgrind reports are very hard to interpret.
		3844
		3845	If you think you found a bug (memory leak, uninitialised data access etc.)
		3846	in libev, then check twice: If valgrind reports something like:
		3847
		3848	==2274== definitely lost: 0 bytes in 0 blocks.
		3849	==2274== possibly lost: 0 bytes in 0 blocks.
		3850	==2274== still reachable: 256 bytes in 1 blocks.
		3851
		3852	Then there is no memory leak, just as memory accounted to global variables
		3853	is not a memleak - the memory is still being referenced, and didn't leak.
		3854
		3855	Similarly, under some circumstances, valgrind might report kernel bugs
		3856	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		3857	although an acceptable workaround has been found here), or it might be
		3858	confused.
		3859
		3860	Keep in mind that valgrind is a very good tool, but only a tool. Don't
		3861	make it into some kind of religion.
		3862
		3863	If you are unsure about something, feel free to contact the mailing list
		3864	with the full valgrind report and an explanation on why you think this
		3865	is a bug in libev (best check the archives, too :). However, don't be
		3866	annoyed when you get a brisk "this is no bug" answer and take the chance
		3867	of learning how to interpret valgrind properly.
		3868
		3869	If you need, for some reason, empty reports from valgrind for your project
		3870	I suggest using suppression lists.
		3871
		3872
		3873	=head1 PORTABILITY NOTES
		3874
		3875	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
2803		3876
2804	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3877	Win32 doesn't support any of the standards (e.g. POSIX) that libev
2805	requires, and its I/O model is fundamentally incompatible with the POSIX	3878	requires, and its I/O model is fundamentally incompatible with the POSIX
2806	model. Libev still offers limited functionality on this platform in	3879	model. Libev still offers limited functionality on this platform in
2807	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3880	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2808	descriptors. This only applies when using Win32 natively, not when using	3881	descriptors. This only applies when using Win32 natively, not when using
2809	e.g. cygwin.	3882	e.g. cygwin.
2810		3883
		3884	Lifting these limitations would basically require the full
		3885	re-implementation of the I/O system. If you are into these kinds of
		3886	things, then note that glib does exactly that for you in a very portable
		3887	way (note also that glib is the slowest event library known to man).
		3888
2811	There is no supported compilation method available on windows except	3889	There is no supported compilation method available on windows except
2812	embedding it into other applications.	3890	embedding it into other applications.
2813		3891
		3892	Not a libev limitation but worth mentioning: windows apparently doesn't
		3893	accept large writes: instead of resulting in a partial write, windows will
		3894	either accept everything or return C<ENOBUFS> if the buffer is too large,
		3895	so make sure you only write small amounts into your sockets (less than a
		3896	megabyte seems safe, but this apparently depends on the amount of memory
		3897	available).
		3898
2814	Due to the many, low, and arbitrary limits on the win32 platform and the	3899	Due to the many, low, and arbitrary limits on the win32 platform and
2815	abysmal performance of winsockets, using a large number of sockets is not	3900	the abysmal performance of winsockets, using a large number of sockets
2816	recommended (and not reasonable). If your program needs to use more than	3901	is not recommended (and not reasonable). If your program needs to use
2817	a hundred or so sockets, then likely it needs to use a totally different	3902	more than a hundred or so sockets, then likely it needs to use a totally
2818	implementation for windows, as libev offers the POSIX model, which cannot	3903	different implementation for windows, as libev offers the POSIX readiness
2819	be implemented efficiently on windows (microsoft monopoly games).	3904	notification model, which cannot be implemented efficiently on windows
		3905	(Microsoft monopoly games).
		3906
		3907	A typical way to use libev under windows is to embed it (see the embedding
		3908	section for details) and use the following F<evwrap.h> header file instead
		3909	of F<ev.h>:
		3910
		3911	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3912	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3913
		3914	#include "ev.h"
		3915
		3916	And compile the following F<evwrap.c> file into your project (make sure
		3917	you do I<not> compile the F<ev.c> or any other embedded source files!):
		3918
		3919	#include "evwrap.h"
		3920	#include "ev.c"
2820		3921
2821	=over 4	3922	=over 4
2822		3923
2823	=item The winsocket select function	3924	=item The winsocket select function
2824		3925
2825	The winsocket C<select> function doesn't follow POSIX in that it requires	3926	The winsocket C<select> function doesn't follow POSIX in that it
2826	socket I<handles> and not socket I<file descriptors>. This makes select	3927	requires socket I<handles> and not socket I<file descriptors> (it is
2827	very inefficient, and also requires a mapping from file descriptors	3928	also extremely buggy). This makes select very inefficient, and also
2828	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3929	requires a mapping from file descriptors to socket handles (the Microsoft
2829	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3930	C runtime provides the function C<_open_osfhandle> for this). See the
2830	symbols for more info.	3931	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		3932	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
2831		3933
2832	The configuration for a "naked" win32 using the microsoft runtime	3934	The configuration for a "naked" win32 using the Microsoft runtime
2833	libraries and raw winsocket select is:	3935	libraries and raw winsocket select is:
2834		3936
2835	#define EV_USE_SELECT 1	3937	#define EV_USE_SELECT 1
2836	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3938	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2837		3939
2838	Note that winsockets handling of fd sets is O(n), so you can easily get a	3940	Note that winsockets handling of fd sets is O(n), so you can easily get a
2839	complexity in the O(n²) range when using win32.	3941	complexity in the O(n²) range when using win32.
2840		3942
2841	=item Limited number of file descriptors	3943	=item Limited number of file descriptors
2842		3944
2843	Windows has numerous arbitrary (and low) limits on things. Early versions	3945	Windows has numerous arbitrary (and low) limits on things.
2844	of winsocket's select only supported waiting for a max. of C<64> handles	3946
		3947	Early versions of winsocket's select only supported waiting for a maximum
2845	(probably owning to the fact that all windows kernels can only wait for	3948	of C<64> handles (probably owning to the fact that all windows kernels
2846	C<64> things at the same time internally; microsoft recommends spawning a	3949	can only wait for C<64> things at the same time internally; Microsoft
2847	chain of threads and wait for 63 handles and the previous thread in each).	3950	recommends spawning a chain of threads and wait for 63 handles and the
		3951	previous thread in each. Great).
2848		3952
2849	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3953	Newer versions support more handles, but you need to define C<FD_SETSIZE>
2850	to some high number (e.g. C<2048>) before compiling the winsocket select	3954	to some high number (e.g. C<2048>) before compiling the winsocket select
2851	call (which might be in libev or elsewhere, for example, perl does its own	3955	call (which might be in libev or elsewhere, for example, perl does its own
2852	select emulation on windows).	3956	select emulation on windows).
2853		3957
2854	Another limit is the number of file descriptors in the microsoft runtime	3958	Another limit is the number of file descriptors in the Microsoft runtime
2855	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3959	libraries, which by default is C<64> (there must be a hidden I<64> fetish
2856	or something like this inside microsoft). You can increase this by calling	3960	or something like this inside Microsoft). You can increase this by calling
2857	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3961	C<_setmaxstdio>, which can increase this limit to C<2048> (another
2858	arbitrary limit), but is broken in many versions of the microsoft runtime	3962	arbitrary limit), but is broken in many versions of the Microsoft runtime
2859	libraries.	3963	libraries.
2860		3964
2861	This might get you to about C<512> or C<2048> sockets (depending on	3965	This might get you to about C<512> or C<2048> sockets (depending on
2862	windows version and/or the phase of the moon). To get more, you need to	3966	windows version and/or the phase of the moon). To get more, you need to
2863	wrap all I/O functions and provide your own fd management, but the cost of	3967	wrap all I/O functions and provide your own fd management, but the cost of
2864	calling select (O(n²)) will likely make this unworkable.	3968	calling select (O(n²)) will likely make this unworkable.
2865		3969
2866	=back	3970	=back
2867		3971
		3972	=head2 PORTABILITY REQUIREMENTS
		3973
		3974	In addition to a working ISO-C implementation and of course the
		3975	backend-specific APIs, libev relies on a few additional extensions:
		3976
		3977	=over 4
		3978
		3979	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3980	calling conventions regardless of C<ev_watcher_type *>.
		3981
		3982	Libev assumes not only that all watcher pointers have the same internal
		3983	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3984	assumes that the same (machine) code can be used to call any watcher
		3985	callback: The watcher callbacks have different type signatures, but libev
		3986	calls them using an C<ev_watcher *> internally.
		3987
		3988	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3989
		3990	The type C<sig_atomic_t volatile> (or whatever is defined as
		3991	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
		3992	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3993	believed to be sufficiently portable.
		3994
		3995	=item C<sigprocmask> must work in a threaded environment
		3996
		3997	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3998	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3999	pthread implementations will either allow C<sigprocmask> in the "main
		4000	thread" or will block signals process-wide, both behaviours would
		4001	be compatible with libev. Interaction between C<sigprocmask> and
		4002	C<pthread_sigmask> could complicate things, however.
		4003
		4004	The most portable way to handle signals is to block signals in all threads
		4005	except the initial one, and run the default loop in the initial thread as
		4006	well.
		4007
		4008	=item C<long> must be large enough for common memory allocation sizes
		4009
		4010	To improve portability and simplify its API, libev uses C<long> internally
		4011	instead of C<size_t> when allocating its data structures. On non-POSIX
		4012	systems (Microsoft...) this might be unexpectedly low, but is still at
		4013	least 31 bits everywhere, which is enough for hundreds of millions of
		4014	watchers.
		4015
		4016	=item C<double> must hold a time value in seconds with enough accuracy
		4017
		4018	The type C<double> is used to represent timestamps. It is required to
		4019	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		4020	enough for at least into the year 4000. This requirement is fulfilled by
		4021	implementations implementing IEEE 754 (basically all existing ones).
		4022
		4023	=back
		4024
		4025	If you know of other additional requirements drop me a note.
		4026
		4027
		4028	=head1 ALGORITHMIC COMPLEXITIES
		4029
		4030	In this section the complexities of (many of) the algorithms used inside
		4031	libev will be documented. For complexity discussions about backends see
		4032	the documentation for C<ev_default_init>.
		4033
		4034	All of the following are about amortised time: If an array needs to be
		4035	extended, libev needs to realloc and move the whole array, but this
		4036	happens asymptotically rarer with higher number of elements, so O(1) might
		4037	mean that libev does a lengthy realloc operation in rare cases, but on
		4038	average it is much faster and asymptotically approaches constant time.
		4039
		4040	=over 4
		4041
		4042	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
		4043
		4044	This means that, when you have a watcher that triggers in one hour and
		4045	there are 100 watchers that would trigger before that, then inserting will
		4046	have to skip roughly seven (C<ld 100>) of these watchers.
		4047
		4048	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
		4049
		4050	That means that changing a timer costs less than removing/adding them,
		4051	as only the relative motion in the event queue has to be paid for.
		4052
		4053	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
		4054
		4055	These just add the watcher into an array or at the head of a list.
		4056
		4057	=item Stopping check/prepare/idle/fork/async watchers: O(1)
		4058
		4059	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		4060
		4061	These watchers are stored in lists, so they need to be walked to find the
		4062	correct watcher to remove. The lists are usually short (you don't usually
		4063	have many watchers waiting for the same fd or signal: one is typical, two
		4064	is rare).
		4065
		4066	=item Finding the next timer in each loop iteration: O(1)
		4067
		4068	By virtue of using a binary or 4-heap, the next timer is always found at a
		4069	fixed position in the storage array.
		4070
		4071	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		4072
		4073	A change means an I/O watcher gets started or stopped, which requires
		4074	libev to recalculate its status (and possibly tell the kernel, depending
		4075	on backend and whether C<ev_io_set> was used).
		4076
		4077	=item Activating one watcher (putting it into the pending state): O(1)
		4078
		4079	=item Priority handling: O(number_of_priorities)
		4080
		4081	Priorities are implemented by allocating some space for each
		4082	priority. When doing priority-based operations, libev usually has to
		4083	linearly search all the priorities, but starting/stopping and activating
		4084	watchers becomes O(1) with respect to priority handling.
		4085
		4086	=item Sending an ev_async: O(1)
		4087
		4088	=item Processing ev_async_send: O(number_of_async_watchers)
		4089
		4090	=item Processing signals: O(max_signal_number)
		4091
		4092	Sending involves a system call I<iff> there were no other C<ev_async_send>
		4093	calls in the current loop iteration. Checking for async and signal events
		4094	involves iterating over all running async watchers or all signal numbers.
		4095
		4096	=back
		4097
		4098
		4099	=head1 GLOSSARY
		4100
		4101	=over 4
		4102
		4103	=item active
		4104
		4105	A watcher is active as long as it has been started (has been attached to
		4106	an event loop) but not yet stopped (disassociated from the event loop).
		4107
		4108	=item application
		4109
		4110	In this document, an application is whatever is using libev.
		4111
		4112	=item callback
		4113
		4114	The address of a function that is called when some event has been
		4115	detected. Callbacks are being passed the event loop, the watcher that
		4116	received the event, and the actual event bitset.
		4117
		4118	=item callback invocation
		4119
		4120	The act of calling the callback associated with a watcher.
		4121
		4122	=item event
		4123
		4124	A change of state of some external event, such as data now being available
		4125	for reading on a file descriptor, time having passed or simply not having
		4126	any other events happening anymore.
		4127
		4128	In libev, events are represented as single bits (such as C<EV_READ> or
		4129	C<EV_TIMEOUT>).
		4130
		4131	=item event library
		4132
		4133	A software package implementing an event model and loop.
		4134
		4135	=item event loop
		4136
		4137	An entity that handles and processes external events and converts them
		4138	into callback invocations.
		4139
		4140	=item event model
		4141
		4142	The model used to describe how an event loop handles and processes
		4143	watchers and events.
		4144
		4145	=item pending
		4146
		4147	A watcher is pending as soon as the corresponding event has been detected,
		4148	and stops being pending as soon as the watcher will be invoked or its
		4149	pending status is explicitly cleared by the application.
		4150
		4151	A watcher can be pending, but not active. Stopping a watcher also clears
		4152	its pending status.
		4153
		4154	=item real time
		4155
		4156	The physical time that is observed. It is apparently strictly monotonic :)
		4157
		4158	=item wall-clock time
		4159
		4160	The time and date as shown on clocks. Unlike real time, it can actually
		4161	be wrong and jump forwards and backwards, e.g. when the you adjust your
		4162	clock.
		4163
		4164	=item watcher
		4165
		4166	A data structure that describes interest in certain events. Watchers need
		4167	to be started (attached to an event loop) before they can receive events.
		4168
		4169	=item watcher invocation
		4170
		4171	The act of calling the callback associated with a watcher.
		4172
		4173	=back
2868		4174
2869	=head1 AUTHOR	4175	=head1 AUTHOR
2870		4176
2871	Marc Lehmann <libev@schmorp.de>.	4177	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
2872		4178

Diff Legend

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