ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.130 by root, Wed Feb 6 18:34:24 2008 UTC vs.
Revision 1.218 by root, Thu Nov 20 00:35:10 2008 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	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>) and, did I mention it,
392	sockets.	466	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
534	=item ev_loop (loop, int flags)	639	=item ev_loop (loop, int flags)
535		640
536	Finally, this is it, the event handler. This function usually is called	641	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	642	after you initialised all your watchers and you want to start handling
538	events.	643	events.
…		…
540	If the flags argument is specified as C<0>, it will not return until	645	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.	646	either no event watchers are active anymore or C<ev_unloop> was called.
542		647
543	Please note that an explicit C<ev_unloop> is usually better than	648	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	649	relying on all watchers to be stopped when deciding when a program has
545	finished (especially in interactive programs), but having a program that	650	finished (especially in interactive programs), but having a program
546	automatically loops as long as it has to and no longer by virtue of	651	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.	652	of relying on its watchers stopping correctly, that is truly a thing of
		653	beauty.
548		654
549	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	655	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	656	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.	657	process in case there are no events and will return after one iteration of
		658	the loop.
552		659
553	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	660	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	661	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	662	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	663	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	664	user-registered callback will be called), and will return after one
		665	iteration of the loop.
		666
		667	This is useful if you are waiting for some external event in conjunction
		668	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	669	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.	670	usually a better approach for this kind of thing.
560		671
561	Here are the gory details of what C<ev_loop> does:	672	Here are the gory details of what C<ev_loop> does:
562		673
563	- Before the first iteration, call any pending watchers.	674	- Before the first iteration, call any pending watchers.
564	* If EVFLAG_FORKCHECK was used, check for a fork.	675	* If EVFLAG_FORKCHECK was used, check for a fork.
565	- If a fork was detected, queue and call all fork watchers.	676	- If a fork was detected (by any means), queue and call all fork watchers.
566	- Queue and call all prepare watchers.	677	- Queue and call all prepare watchers.
567	- If we have been forked, recreate the kernel state.	678	- If we have been forked, detach and recreate the kernel state
		679	as to not disturb the other process.
568	- Update the kernel state with all outstanding changes.	680	- Update the kernel state with all outstanding changes.
569	- Update the "event loop time".	681	- Update the "event loop time" (ev_now ()).
570	- Calculate for how long to sleep or block, if at all	682	- Calculate for how long to sleep or block, if at all
571	(active idle watchers, EVLOOP_NONBLOCK or not having	683	(active idle watchers, EVLOOP_NONBLOCK or not having
572	any active watchers at all will result in not sleeping).	684	any active watchers at all will result in not sleeping).
573	- Sleep if the I/O and timer collect interval say so.	685	- Sleep if the I/O and timer collect interval say so.
574	- Block the process, waiting for any events.	686	- Block the process, waiting for any events.
575	- Queue all outstanding I/O (fd) events.	687	- Queue all outstanding I/O (fd) events.
576	- Update the "event loop time" and do time jump handling.	688	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
577	- Queue all outstanding timers.	689	- Queue all expired timers.
578	- Queue all outstanding periodics.	690	- Queue all expired periodics.
579	- If no events are pending now, queue all idle watchers.	691	- Unless any events are pending now, queue all idle watchers.
580	- Queue all check watchers.	692	- Queue all check watchers.
581	- Call all queued watchers in reverse order (i.e. check watchers first).	693	- 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	694	Signals and child watchers are implemented as I/O watchers, and will
583	be handled here by queueing them when their watcher gets executed.	695	be handled here by queueing them when their watcher gets executed.
584	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	696	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
…		…
589	anymore.	701	anymore.
590		702
591	... queue jobs here, make sure they register event watchers as long	703	... 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..)	704	... as they still have work to do (even an idle watcher will do..)
593	ev_loop (my_loop, 0);	705	ev_loop (my_loop, 0);
594	... jobs done. yeah!	706	... jobs done or somebody called unloop. yeah!
595		707
596	=item ev_unloop (loop, how)	708	=item ev_unloop (loop, how)
597		709
598	Can be used to make a call to C<ev_loop> return early (but only after it	710	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	711	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	712	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.	713	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
602		714
603	This "unloop state" will be cleared when entering C<ev_loop> again.	715	This "unloop state" will be cleared when entering C<ev_loop> again.
604		716
		717	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		718
605	=item ev_ref (loop)	719	=item ev_ref (loop)
606		720
607	=item ev_unref (loop)	721	=item ev_unref (loop)
608		722
609	Ref/unref can be used to add or remove a reference count on the event	723	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	724	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	725	count is nonzero, C<ev_loop> will not return on its own.
		726
612	a watcher you never unregister that should not keep C<ev_loop> from	727	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	728	from returning, call ev_unref() after starting, and ev_ref() before
		729	stopping it.
		730
614	example, libev itself uses this for its internal signal pipe: It is not	731	As an example, libev itself uses this for its internal signal pipe: It is
615	visible to the libev user and should not keep C<ev_loop> from exiting if	732	not visible to the libev user and should not keep C<ev_loop> from exiting
616	no event watchers registered by it are active. It is also an excellent	733	if no event watchers registered by it are active. It is also an excellent
617	way to do this for generic recurring timers or from within third-party	734	way to do this for generic recurring timers or from within third-party
618	libraries. Just remember to I<unref after start> and I<ref before stop>	735	libraries. Just remember to I<unref after start> and I<ref before stop>
619	(but only if the watcher wasn't active before, or was active before,	736	(but only if the watcher wasn't active before, or was active before,
620	respectively).	737	respectively).
621		738
622	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	739	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
623	running when nothing else is active.	740	running when nothing else is active.
624		741
625	struct ev_signal exitsig;	742	ev_signal exitsig;
626	ev_signal_init (&exitsig, sig_cb, SIGINT);	743	ev_signal_init (&exitsig, sig_cb, SIGINT);
627	ev_signal_start (loop, &exitsig);	744	ev_signal_start (loop, &exitsig);
628	evf_unref (loop);	745	evf_unref (loop);
629		746
630	Example: For some weird reason, unregister the above signal handler again.	747	Example: For some weird reason, unregister the above signal handler again.
631		748
632	ev_ref (loop);	749	ev_ref (loop);
633	ev_signal_stop (loop, &exitsig);	750	ev_signal_stop (loop, &exitsig);
634		751
635	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	752	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
636		753
637	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	754	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
638		755
639	These advanced functions influence the time that libev will spend waiting	756	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	757	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.	758	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		759	latency.
642		760
643	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	761	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	762	allows libev to delay invocation of I/O and timer/periodic callbacks
645	increase efficiency of loop iterations.	763	to increase efficiency of loop iterations (or to increase power-saving
		764	opportunities).
646		765
647	The background is that sometimes your program runs just fast enough to	766	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	767	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	768	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	769	events, especially with backends like C<select ()> which have a high
651	overhead for the actual polling but can deliver many events at once.	770	overhead for the actual polling but can deliver many events at once.
652		771
653	By setting a higher I<io collect interval> you allow libev to spend more	772	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,	773	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	775	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.	776	introduce an additional C<ev_sleep ()> call into most loop iterations.
658		777
659	Likewise, by setting a higher I<timeout collect interval> you allow libev	778	Likewise, by setting a higher I<timeout collect interval> you allow libev
660	to spend more time collecting timeouts, at the expense of increased	779	to spend more time collecting timeouts, at the expense of increased
661	latency (the watcher callback will be called later). C<ev_io> watchers	780	latency/jitter/inexactness (the watcher callback will be called
662	will not be affected. Setting this to a non-null value will not introduce	781	later). C<ev_io> watchers will not be affected. Setting this to a non-null
663	any overhead in libev.	782	value will not introduce any overhead in libev.
664		783
665	Many (busy) programs can usually benefit by setting the io collect	784	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	785	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	786	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>,	787	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.	788	as this approaches the timing granularity of most systems.
		789
		790	Setting the I<timeout collect interval> can improve the opportunity for
		791	saving power, as the program will "bundle" timer callback invocations that
		792	are "near" in time together, by delaying some, thus reducing the number of
		793	times the process sleeps and wakes up again. Another useful technique to
		794	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
		795	they fire on, say, one-second boundaries only.
		796
		797	=item ev_loop_verify (loop)
		798
		799	This function only does something when C<EV_VERIFY> support has been
		800	compiled in, which is the default for non-minimal builds. It tries to go
		801	through all internal structures and checks them for validity. If anything
		802	is found to be inconsistent, it will print an error message to standard
		803	error and call C<abort ()>.
		804
		805	This can be used to catch bugs inside libev itself: under normal
		806	circumstances, this function will never abort as of course libev keeps its
		807	data structures consistent.
670		808
671	=back	809	=back
672		810
673		811
674	=head1 ANATOMY OF A WATCHER	812	=head1 ANATOMY OF A WATCHER
		813
		814	In the following description, uppercase C<TYPE> in names stands for the
		815	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		816	watchers and C<ev_io_start> for I/O watchers.
675		817
676	A watcher is a structure that you create and register to record your	818	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	819	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:	820	become readable, you would create an C<ev_io> watcher for that:
679		821
680	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	822	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
681	{	823	{
682	ev_io_stop (w);	824	ev_io_stop (w);
683	ev_unloop (loop, EVUNLOOP_ALL);	825	ev_unloop (loop, EVUNLOOP_ALL);
684	}	826	}
685		827
686	struct ev_loop *loop = ev_default_loop (0);	828	struct ev_loop *loop = ev_default_loop (0);
		829
687	struct ev_io stdin_watcher;	830	ev_io stdin_watcher;
		831
688	ev_init (&stdin_watcher, my_cb);	832	ev_init (&stdin_watcher, my_cb);
689	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	833	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
690	ev_io_start (loop, &stdin_watcher);	834	ev_io_start (loop, &stdin_watcher);
		835
691	ev_loop (loop, 0);	836	ev_loop (loop, 0);
692		837
693	As you can see, you are responsible for allocating the memory for your	838	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,	839	watcher structures (and it is I<usually> a bad idea to do this on the
695	although this can sometimes be quite valid).	840	stack).
		841
		842	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		843	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
696		844
697	Each watcher structure must be initialised by a call to C<ev_init	845	Each watcher structure must be initialised by a call to C<ev_init
698	(watcher *, callback)>, which expects a callback to be provided. This	846	(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	847	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	848	watchers, each time the event loop detects that the file descriptor given
701	is readable and/or writable).	849	is readable and/or writable).
702		850
703	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	851	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	852	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	853	is also a macro to combine initialisation and setting in one call: C<<
706	(watcher *, callback, ...) >>.	854	ev_TYPE_init (watcher *, callback, ...) >>.
707		855
708	To make the watcher actually watch out for events, you have to start it	856	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	857	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	858	*) >>), and you can stop watching for events at any time by calling the
711	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	859	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
712		860
713	As long as your watcher is active (has been started but not stopped) you	861	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	862	must not touch the values stored in it. Most specifically you must never
715	reinitialise it or call its C<set> macro.	863	reinitialise it or call its C<ev_TYPE_set> macro.
716		864
717	Each and every callback receives the event loop pointer as first, the	865	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	866	registered watcher structure as second, and a bitset of received events as
719	third argument.	867	third argument.
720		868
…		…
780		928
781	The given async watcher has been asynchronously notified (see C<ev_async>).	929	The given async watcher has been asynchronously notified (see C<ev_async>).
782		930
783	=item C<EV_ERROR>	931	=item C<EV_ERROR>
784		932
785	An unspecified error has occured, the watcher has been stopped. This might	933	An unspecified error has occurred, the watcher has been stopped. This might
786	happen because the watcher could not be properly started because libev	934	happen because the watcher could not be properly started because libev
787	ran out of memory, a file descriptor was found to be closed or any other	935	ran out of memory, a file descriptor was found to be closed or any other
		936	problem. Libev considers these application bugs.
		937
788	problem. You best act on it by reporting the problem and somehow coping	938	You best act on it by reporting the problem and somehow coping with the
789	with the watcher being stopped.	939	watcher being stopped. Note that well-written programs should not receive
		940	an error ever, so when your watcher receives it, this usually indicates a
		941	bug in your program.
790		942
791	Libev will usually signal a few "dummy" events together with an error,	943	Libev will usually signal a few "dummy" events together with an error, for
792	for example it might indicate that a fd is readable or writable, and if	944	example it might indicate that a fd is readable or writable, and if your
793	your callbacks is well-written it can just attempt the operation and cope	945	callbacks is well-written it can just attempt the operation and cope with
794	with the error from read() or write(). This will not work in multithreaded	946	the error from read() or write(). This will not work in multi-threaded
795	programs, though, so beware.	947	programs, though, as the fd could already be closed and reused for another
		948	thing, so beware.
796		949
797	=back	950	=back
798		951
799	=head2 GENERIC WATCHER FUNCTIONS	952	=head2 GENERIC WATCHER FUNCTIONS
800
801	In the following description, C<TYPE> stands for the watcher type,
802	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
803		953
804	=over 4	954	=over 4
805		955
806	=item C<ev_init> (ev_TYPE *watcher, callback)	956	=item C<ev_init> (ev_TYPE *watcher, callback)
807		957
…		…
813	which rolls both calls into one.	963	which rolls both calls into one.
814		964
815	You can reinitialise a watcher at any time as long as it has been stopped	965	You can reinitialise a watcher at any time as long as it has been stopped
816	(or never started) and there are no pending events outstanding.	966	(or never started) and there are no pending events outstanding.
817		967
818	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	968	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
819	int revents)>.	969	int revents)>.
		970
		971	Example: Initialise an C<ev_io> watcher in two steps.
		972
		973	ev_io w;
		974	ev_init (&w, my_cb);
		975	ev_io_set (&w, STDIN_FILENO, EV_READ);
820		976
821	=item C<ev_TYPE_set> (ev_TYPE *, [args])	977	=item C<ev_TYPE_set> (ev_TYPE *, [args])
822		978
823	This macro initialises the type-specific parts of a watcher. You need to	979	This macro initialises the type-specific parts of a watcher. You need to
824	call C<ev_init> at least once before you call this macro, but you can	980	call C<ev_init> at least once before you call this macro, but you can
…		…
827	difference to the C<ev_init> macro).	983	difference to the C<ev_init> macro).
828		984
829	Although some watcher types do not have type-specific arguments	985	Although some watcher types do not have type-specific arguments
830	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	986	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
831		987
		988	See C<ev_init>, above, for an example.
		989
832	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	990	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
833		991
834	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	992	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
835	calls into a single call. This is the most convinient method to initialise	993	calls into a single call. This is the most convenient method to initialise
836	a watcher. The same limitations apply, of course.	994	a watcher. The same limitations apply, of course.
		995
		996	Example: Initialise and set an C<ev_io> watcher in one step.
		997
		998	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
837		999
838	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1000	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
839		1001
840	Starts (activates) the given watcher. Only active watchers will receive	1002	Starts (activates) the given watcher. Only active watchers will receive
841	events. If the watcher is already active nothing will happen.	1003	events. If the watcher is already active nothing will happen.
842		1004
		1005	Example: Start the C<ev_io> watcher that is being abused as example in this
		1006	whole section.
		1007
		1008	ev_io_start (EV_DEFAULT_UC, &w);
		1009
843	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1010	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
844		1011
845	Stops the given watcher again (if active) and clears the pending	1012	Stops the given watcher if active, and clears the pending status (whether
		1013	the watcher was active or not).
		1014
846	status. It is possible that stopped watchers are pending (for example,	1015	It is possible that stopped watchers are pending - for example,
847	non-repeating timers are being stopped when they become pending), but	1016	non-repeating timers are being stopped when they become pending - but
848	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	1017	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
849	you want to free or reuse the memory used by the watcher it is therefore a	1018	pending. If you want to free or reuse the memory used by the watcher it is
850	good idea to always call its C<ev_TYPE_stop> function.	1019	therefore a good idea to always call its C<ev_TYPE_stop> function.
851		1020
852	=item bool ev_is_active (ev_TYPE *watcher)	1021	=item bool ev_is_active (ev_TYPE *watcher)
853		1022
854	Returns a true value iff the watcher is active (i.e. it has been started	1023	Returns a true value iff the watcher is active (i.e. it has been started
855	and not yet been stopped). As long as a watcher is active you must not modify	1024	and not yet been stopped). As long as a watcher is active you must not modify
…		…
897	The default priority used by watchers when no priority has been set is	1066	The default priority used by watchers when no priority has been set is
898	always C<0>, which is supposed to not be too high and not be too low :).	1067	always C<0>, which is supposed to not be too high and not be too low :).
899		1068
900	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1069	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
901	fine, as long as you do not mind that the priority value you query might	1070	fine, as long as you do not mind that the priority value you query might
902	or might not have been adjusted to be within valid range.	1071	or might not have been clamped to the valid range.
903		1072
904	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1073	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
905		1074
906	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1075	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
907	C<loop> nor C<revents> need to be valid as long as the watcher callback	1076	C<loop> nor C<revents> need to be valid as long as the watcher callback
908	can deal with that fact.	1077	can deal with that fact, as both are simply passed through to the
		1078	callback.
909		1079
910	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1080	=item int ev_clear_pending (loop, ev_TYPE *watcher)
911		1081
912	If the watcher is pending, this function returns clears its pending status	1082	If the watcher is pending, this function clears its pending status and
913	and returns its C<revents> bitset (as if its callback was invoked). If the	1083	returns its C<revents> bitset (as if its callback was invoked). If the
914	watcher isn't pending it does nothing and returns C<0>.	1084	watcher isn't pending it does nothing and returns C<0>.
915		1085
		1086	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1087	callback to be invoked, which can be accomplished with this function.
		1088
916	=back	1089	=back
917		1090
918		1091
919	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1092	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
920		1093
921	Each watcher has, by default, a member C<void *data> that you can change	1094	Each watcher has, by default, a member C<void *data> that you can change
922	and read at any time, libev will completely ignore it. This can be used	1095	and read at any time: libev will completely ignore it. This can be used
923	to associate arbitrary data with your watcher. If you need more data and	1096	to associate arbitrary data with your watcher. If you need more data and
924	don't want to allocate memory and store a pointer to it in that data	1097	don't want to allocate memory and store a pointer to it in that data
925	member, you can also "subclass" the watcher type and provide your own	1098	member, you can also "subclass" the watcher type and provide your own
926	data:	1099	data:
927		1100
928	struct my_io	1101	struct my_io
929	{	1102	{
930	struct ev_io io;	1103	ev_io io;
931	int otherfd;	1104	int otherfd;
932	void *somedata;	1105	void *somedata;
933	struct whatever *mostinteresting;	1106	struct whatever *mostinteresting;
934	}	1107	};
		1108
		1109	...
		1110	struct my_io w;
		1111	ev_io_init (&w.io, my_cb, fd, EV_READ);
935		1112
936	And since your callback will be called with a pointer to the watcher, you	1113	And since your callback will be called with a pointer to the watcher, you
937	can cast it back to your own type:	1114	can cast it back to your own type:
938		1115
939	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1116	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
940	{	1117	{
941	struct my_io *w = (struct my_io *)w_;	1118	struct my_io *w = (struct my_io *)w_;
942	...	1119	...
943	}	1120	}
944		1121
945	More interesting and less C-conformant ways of casting your callback type	1122	More interesting and less C-conformant ways of casting your callback type
946	instead have been omitted.	1123	instead have been omitted.
947		1124
948	Another common scenario is having some data structure with multiple	1125	Another common scenario is to use some data structure with multiple
949	watchers:	1126	embedded watchers:
950		1127
951	struct my_biggy	1128	struct my_biggy
952	{	1129	{
953	int some_data;	1130	int some_data;
954	ev_timer t1;	1131	ev_timer t1;
955	ev_timer t2;	1132	ev_timer t2;
956	}	1133	}
957		1134
958	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1135	In this case getting the pointer to C<my_biggy> is a bit more
959	you need to use C<offsetof>:	1136	complicated: Either you store the address of your C<my_biggy> struct
		1137	in the C<data> member of the watcher (for woozies), or you need to use
		1138	some pointer arithmetic using C<offsetof> inside your watchers (for real
		1139	programmers):
960		1140
961	#include <stddef.h>	1141	#include <stddef.h>
962		1142
963	static void	1143	static void
964	t1_cb (EV_P_ struct ev_timer *w, int revents)	1144	t1_cb (EV_P_ ev_timer *w, int revents)
965	{	1145	{
966	struct my_biggy big = (struct my_biggy *	1146	struct my_biggy big = (struct my_biggy *
967	(((char *)w) - offsetof (struct my_biggy, t1));	1147	(((char *)w) - offsetof (struct my_biggy, t1));
968	}	1148	}
969		1149
970	static void	1150	static void
971	t2_cb (EV_P_ struct ev_timer *w, int revents)	1151	t2_cb (EV_P_ ev_timer *w, int revents)
972	{	1152	{
973	struct my_biggy big = (struct my_biggy *	1153	struct my_biggy big = (struct my_biggy *
974	(((char *)w) - offsetof (struct my_biggy, t2));	1154	(((char *)w) - offsetof (struct my_biggy, t2));
975	}	1155	}
976		1156
977		1157
978	=head1 WATCHER TYPES	1158	=head1 WATCHER TYPES
979		1159
980	This section describes each watcher in detail, but will not repeat	1160	This section describes each watcher in detail, but will not repeat
…		…
1004	In general you can register as many read and/or write event watchers per	1184	In general you can register as many read and/or write event watchers per
1005	fd as you want (as long as you don't confuse yourself). Setting all file	1185	fd as you want (as long as you don't confuse yourself). Setting all file
1006	descriptors to non-blocking mode is also usually a good idea (but not	1186	descriptors to non-blocking mode is also usually a good idea (but not
1007	required if you know what you are doing).	1187	required if you know what you are doing).
1008		1188
1009	If you must do this, then force the use of a known-to-be-good backend	1189	If you cannot use non-blocking mode, then force the use of a
1010	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1190	known-to-be-good backend (at the time of this writing, this includes only
1011	C<EVBACKEND_POLL>).	1191	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1012		1192
1013	Another thing you have to watch out for is that it is quite easy to	1193	Another thing you have to watch out for is that it is quite easy to
1014	receive "spurious" readyness notifications, that is your callback might	1194	receive "spurious" readiness notifications, that is your callback might
1015	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1195	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1016	because there is no data. Not only are some backends known to create a	1196	because there is no data. Not only are some backends known to create a
1017	lot of those (for example solaris ports), it is very easy to get into	1197	lot of those (for example Solaris ports), it is very easy to get into
1018	this situation even with a relatively standard program structure. Thus	1198	this situation even with a relatively standard program structure. Thus
1019	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1199	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1020	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1200	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1021		1201
1022	If you cannot run the fd in non-blocking mode (for example you should not	1202	If you cannot run the fd in non-blocking mode (for example you should
1023	play around with an Xlib connection), then you have to seperately re-test	1203	not play around with an Xlib connection), then you have to separately
1024	whether a file descriptor is really ready with a known-to-be good interface	1204	re-test whether a file descriptor is really ready with a known-to-be good
1025	such as poll (fortunately in our Xlib example, Xlib already does this on	1205	interface such as poll (fortunately in our Xlib example, Xlib already
1026	its own, so its quite safe to use).	1206	does this on its own, so its quite safe to use). Some people additionally
		1207	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1208	indefinitely.
		1209
		1210	But really, best use non-blocking mode.
1027		1211
1028	=head3 The special problem of disappearing file descriptors	1212	=head3 The special problem of disappearing file descriptors
1029		1213
1030	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1214	Some backends (e.g. kqueue, epoll) need to be told about closing a file
1031	descriptor (either by calling C<close> explicitly or by any other means,	1215	descriptor (either due to calling C<close> explicitly or any other means,
1032	such as C<dup>). The reason is that you register interest in some file	1216	such as C<dup2>). The reason is that you register interest in some file
1033	descriptor, but when it goes away, the operating system will silently drop	1217	descriptor, but when it goes away, the operating system will silently drop
1034	this interest. If another file descriptor with the same number then is	1218	this interest. If another file descriptor with the same number then is
1035	registered with libev, there is no efficient way to see that this is, in	1219	registered with libev, there is no efficient way to see that this is, in
1036	fact, a different file descriptor.	1220	fact, a different file descriptor.
1037		1221
…		…
1066	To support fork in your programs, you either have to call	1250	To support fork in your programs, you either have to call
1067	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1251	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1068	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1252	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1069	C<EVBACKEND_POLL>.	1253	C<EVBACKEND_POLL>.
1070		1254
		1255	=head3 The special problem of SIGPIPE
		1256
		1257	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
		1258	when writing to a pipe whose other end has been closed, your program gets
		1259	sent a SIGPIPE, which, by default, aborts your program. For most programs
		1260	this is sensible behaviour, for daemons, this is usually undesirable.
		1261
		1262	So when you encounter spurious, unexplained daemon exits, make sure you
		1263	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1264	somewhere, as that would have given you a big clue).
		1265
1071		1266
1072	=head3 Watcher-Specific Functions	1267	=head3 Watcher-Specific Functions
1073		1268
1074	=over 4	1269	=over 4
1075		1270
1076	=item ev_io_init (ev_io *, callback, int fd, int events)	1271	=item ev_io_init (ev_io *, callback, int fd, int events)
1077		1272
1078	=item ev_io_set (ev_io *, int fd, int events)	1273	=item ev_io_set (ev_io *, int fd, int events)
1079		1274
1080	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1275	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1081	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1276	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1082	C<EV_READ | EV_WRITE> to receive the given events.	1277	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1083		1278
1084	=item int fd [read-only]	1279	=item int fd [read-only]
1085		1280
1086	The file descriptor being watched.	1281	The file descriptor being watched.
1087		1282
…		…
1095		1290
1096	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1291	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1097	readable, but only once. Since it is likely line-buffered, you could	1292	readable, but only once. Since it is likely line-buffered, you could
1098	attempt to read a whole line in the callback.	1293	attempt to read a whole line in the callback.
1099		1294
1100	static void	1295	static void
1101	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1296	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1102	{	1297	{
1103	ev_io_stop (loop, w);	1298	ev_io_stop (loop, w);
1104	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1299	.. read from stdin here (or from w->fd) and handle any I/O errors
1105	}	1300	}
1106		1301
1107	...	1302	...
1108	struct ev_loop *loop = ev_default_init (0);	1303	struct ev_loop *loop = ev_default_init (0);
1109	struct ev_io stdin_readable;	1304	ev_io stdin_readable;
1110	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1305	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1111	ev_io_start (loop, &stdin_readable);	1306	ev_io_start (loop, &stdin_readable);
1112	ev_loop (loop, 0);	1307	ev_loop (loop, 0);
1113		1308
1114		1309
1115	=head2 C<ev_timer> - relative and optionally repeating timeouts	1310	=head2 C<ev_timer> - relative and optionally repeating timeouts
1116		1311
1117	Timer watchers are simple relative timers that generate an event after a	1312	Timer watchers are simple relative timers that generate an event after a
1118	given time, and optionally repeating in regular intervals after that.	1313	given time, and optionally repeating in regular intervals after that.
1119		1314
1120	The timers are based on real time, that is, if you register an event that	1315	The timers are based on real time, that is, if you register an event that
1121	times out after an hour and you reset your system clock to last years	1316	times out after an hour and you reset your system clock to January last
1122	time, it will still time out after (roughly) and hour. "Roughly" because	1317	year, it will still time out after (roughly) one hour. "Roughly" because
1123	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1318	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1124	monotonic clock option helps a lot here).	1319	monotonic clock option helps a lot here).
		1320
		1321	The callback is guaranteed to be invoked only I<after> its timeout has
		1322	passed, but if multiple timers become ready during the same loop iteration
		1323	then order of execution is undefined.
		1324
		1325	=head3 Be smart about timeouts
		1326
		1327	Many real-world problems involve some kind of timeout, usually for error
		1328	recovery. A typical example is an HTTP request - if the other side hangs,
		1329	you want to raise some error after a while.
		1330
		1331	What follows are some ways to handle this problem, from obvious and
		1332	inefficient to smart and efficient.
		1333
		1334	In the following, a 60 second activity timeout is assumed - a timeout that
		1335	gets reset to 60 seconds each time there is activity (e.g. each time some
		1336	data or other life sign was received).
		1337
		1338	=over 4
		1339
		1340	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1341
		1342	This is the most obvious, but not the most simple way: In the beginning,
		1343	start the watcher:
		1344
		1345	ev_timer_init (timer, callback, 60., 0.);
		1346	ev_timer_start (loop, timer);
		1347
		1348	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1349	and start it again:
		1350
		1351	ev_timer_stop (loop, timer);
		1352	ev_timer_set (timer, 60., 0.);
		1353	ev_timer_start (loop, timer);
		1354
		1355	This is relatively simple to implement, but means that each time there is
		1356	some activity, libev will first have to remove the timer from its internal
		1357	data structure and then add it again. Libev tries to be fast, but it's
		1358	still not a constant-time operation.
		1359
		1360	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1361
		1362	This is the easiest way, and involves using C<ev_timer_again> instead of
		1363	C<ev_timer_start>.
		1364
		1365	To implement this, configure an C<ev_timer> with a C<repeat> value
		1366	of C<60> and then call C<ev_timer_again> at start and each time you
		1367	successfully read or write some data. If you go into an idle state where
		1368	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1369	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1370
		1371	That means you can ignore both the C<ev_timer_start> function and the
		1372	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1373	member and C<ev_timer_again>.
		1374
		1375	At start:
		1376
		1377	ev_timer_init (timer, callback);
		1378	timer->repeat = 60.;
		1379	ev_timer_again (loop, timer);
		1380
		1381	Each time there is some activity:
		1382
		1383	ev_timer_again (loop, timer);
		1384
		1385	It is even possible to change the time-out on the fly, regardless of
		1386	whether the watcher is active or not:
		1387
		1388	timer->repeat = 30.;
		1389	ev_timer_again (loop, timer);
		1390
		1391	This is slightly more efficient then stopping/starting the timer each time
		1392	you want to modify its timeout value, as libev does not have to completely
		1393	remove and re-insert the timer from/into its internal data structure.
		1394
		1395	It is, however, even simpler than the "obvious" way to do it.
		1396
		1397	=item 3. Let the timer time out, but then re-arm it as required.
		1398
		1399	This method is more tricky, but usually most efficient: Most timeouts are
		1400	relatively long compared to the intervals between other activity - in
		1401	our example, within 60 seconds, there are usually many I/O events with
		1402	associated activity resets.
		1403
		1404	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1405	but remember the time of last activity, and check for a real timeout only
		1406	within the callback:
		1407
		1408	ev_tstamp last_activity; // time of last activity
		1409
		1410	static void
		1411	callback (EV_P_ ev_timer *w, int revents)
		1412	{
		1413	ev_tstamp now = ev_now (EV_A);
		1414	ev_tstamp timeout = last_activity + 60.;
		1415
		1416	// if last_activity + 60. is older than now, we did time out
		1417	if (timeout < now)
		1418	{
		1419	// timeout occured, take action
		1420	}
		1421	else
		1422	{
		1423	// callback was invoked, but there was some activity, re-arm
		1424	// the watcher to fire in last_activity + 60, which is
		1425	// guaranteed to be in the future, so "again" is positive:
		1426	w->repeat = timeout - now;
		1427	ev_timer_again (EV_A_ w);
		1428	}
		1429	}
		1430
		1431	To summarise the callback: first calculate the real timeout (defined
		1432	as "60 seconds after the last activity"), then check if that time has
		1433	been reached, which means something I<did>, in fact, time out. Otherwise
		1434	the callback was invoked too early (C<timeout> is in the future), so
		1435	re-schedule the timer to fire at that future time, to see if maybe we have
		1436	a timeout then.
		1437
		1438	Note how C<ev_timer_again> is used, taking advantage of the
		1439	C<ev_timer_again> optimisation when the timer is already running.
		1440
		1441	This scheme causes more callback invocations (about one every 60 seconds
		1442	minus half the average time between activity), but virtually no calls to
		1443	libev to change the timeout.
		1444
		1445	To start the timer, simply initialise the watcher and set C<last_activity>
		1446	to the current time (meaning we just have some activity :), then call the
		1447	callback, which will "do the right thing" and start the timer:
		1448
		1449	ev_timer_init (timer, callback);
		1450	last_activity = ev_now (loop);
		1451	callback (loop, timer, EV_TIMEOUT);
		1452
		1453	And when there is some activity, simply store the current time in
		1454	C<last_activity>, no libev calls at all:
		1455
		1456	last_actiivty = ev_now (loop);
		1457
		1458	This technique is slightly more complex, but in most cases where the
		1459	time-out is unlikely to be triggered, much more efficient.
		1460
		1461	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1462	callback :) - just change the timeout and invoke the callback, which will
		1463	fix things for you.
		1464
		1465	=item 4. Wee, just use a double-linked list for your timeouts.
		1466
		1467	If there is not one request, but many thousands (millions...), all
		1468	employing some kind of timeout with the same timeout value, then one can
		1469	do even better:
		1470
		1471	When starting the timeout, calculate the timeout value and put the timeout
		1472	at the I<end> of the list.
		1473
		1474	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1475	the list is expected to fire (for example, using the technique #3).
		1476
		1477	When there is some activity, remove the timer from the list, recalculate
		1478	the timeout, append it to the end of the list again, and make sure to
		1479	update the C<ev_timer> if it was taken from the beginning of the list.
		1480
		1481	This way, one can manage an unlimited number of timeouts in O(1) time for
		1482	starting, stopping and updating the timers, at the expense of a major
		1483	complication, and having to use a constant timeout. The constant timeout
		1484	ensures that the list stays sorted.
		1485
		1486	=back
		1487
		1488	So which method the best?
		1489
		1490	Method #2 is a simple no-brain-required solution that is adequate in most
		1491	situations. Method #3 requires a bit more thinking, but handles many cases
		1492	better, and isn't very complicated either. In most case, choosing either
		1493	one is fine, with #3 being better in typical situations.
		1494
		1495	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1496	rather complicated, but extremely efficient, something that really pays
		1497	off after the first million or so of active timers, i.e. it's usually
		1498	overkill :)
		1499
		1500	=head3 The special problem of time updates
		1501
		1502	Establishing the current time is a costly operation (it usually takes at
		1503	least two system calls): EV therefore updates its idea of the current
		1504	time only before and after C<ev_loop> collects new events, which causes a
		1505	growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1506	lots of events in one iteration.
1125		1507
1126	The relative timeouts are calculated relative to the C<ev_now ()>	1508	The relative timeouts are calculated relative to the C<ev_now ()>
1127	time. This is usually the right thing as this timestamp refers to the time	1509	time. This is usually the right thing as this timestamp refers to the time
1128	of the event triggering whatever timeout you are modifying/starting. If	1510	of the event triggering whatever timeout you are modifying/starting. If
1129	you suspect event processing to be delayed and you I<need> to base the timeout	1511	you suspect event processing to be delayed and you I<need> to base the
1130	on the current time, use something like this to adjust for this:	1512	timeout on the current time, use something like this to adjust for this:
1131		1513
1132	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1514	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1133		1515
1134	The callback is guarenteed to be invoked only when its timeout has passed,	1516	If the event loop is suspended for a long time, you can also force an
1135	but if multiple timers become ready during the same loop iteration then	1517	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1136	order of execution is undefined.	1518	()>.
1137		1519
1138	=head3 Watcher-Specific Functions and Data Members	1520	=head3 Watcher-Specific Functions and Data Members
1139		1521
1140	=over 4	1522	=over 4
1141		1523
1142	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1524	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1143		1525
1144	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1526	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1145		1527
1146	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1528	Configure the timer to trigger after C<after> seconds. If C<repeat>
1147	C<0.>, then it will automatically be stopped. If it is positive, then the	1529	is C<0.>, then it will automatically be stopped once the timeout is
1148	timer will automatically be configured to trigger again C<repeat> seconds	1530	reached. If it is positive, then the timer will automatically be
1149	later, again, and again, until stopped manually.	1531	configured to trigger again C<repeat> seconds later, again, and again,
		1532	until stopped manually.
1150		1533
1151	The timer itself will do a best-effort at avoiding drift, that is, if you	1534	The timer itself will do a best-effort at avoiding drift, that is, if
1152	configure a timer to trigger every 10 seconds, then it will trigger at	1535	you configure a timer to trigger every 10 seconds, then it will normally
1153	exactly 10 second intervals. If, however, your program cannot keep up with	1536	trigger at exactly 10 second intervals. If, however, your program cannot
1154	the timer (because it takes longer than those 10 seconds to do stuff) the	1537	keep up with the timer (because it takes longer than those 10 seconds to
1155	timer will not fire more than once per event loop iteration.	1538	do stuff) the timer will not fire more than once per event loop iteration.
1156		1539
1157	=item ev_timer_again (loop)	1540	=item ev_timer_again (loop, ev_timer *)
1158		1541
1159	This will act as if the timer timed out and restart it again if it is	1542	This will act as if the timer timed out and restart it again if it is
1160	repeating. The exact semantics are:	1543	repeating. The exact semantics are:
1161		1544
1162	If the timer is pending, its pending status is cleared.	1545	If the timer is pending, its pending status is cleared.
1163		1546
1164	If the timer is started but nonrepeating, stop it (as if it timed out).	1547	If the timer is started but non-repeating, stop it (as if it timed out).
1165		1548
1166	If the timer is repeating, either start it if necessary (with the	1549	If the timer is repeating, either start it if necessary (with the
1167	C<repeat> value), or reset the running timer to the C<repeat> value.	1550	C<repeat> value), or reset the running timer to the C<repeat> value.
1168		1551
1169	This sounds a bit complicated, but here is a useful and typical	1552	This sounds a bit complicated, see "Be smart about timeouts", above, for a
1170	example: Imagine you have a tcp connection and you want a so-called idle	1553	usage example.
1171	timeout, that is, you want to be called when there have been, say, 60
1172	seconds of inactivity on the socket. The easiest way to do this is to
1173	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1174	C<ev_timer_again> each time you successfully read or write some data. If
1175	you go into an idle state where you do not expect data to travel on the
1176	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1177	automatically restart it if need be.
1178
1179	That means you can ignore the C<after> value and C<ev_timer_start>
1180	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1181
1182	ev_timer_init (timer, callback, 0., 5.);
1183	ev_timer_again (loop, timer);
1184	...
1185	timer->again = 17.;
1186	ev_timer_again (loop, timer);
1187	...
1188	timer->again = 10.;
1189	ev_timer_again (loop, timer);
1190
1191	This is more slightly efficient then stopping/starting the timer each time
1192	you want to modify its timeout value.
1193		1554
1194	=item ev_tstamp repeat [read-write]	1555	=item ev_tstamp repeat [read-write]
1195		1556
1196	The current C<repeat> value. Will be used each time the watcher times out	1557	The current C<repeat> value. Will be used each time the watcher times out
1197	or C<ev_timer_again> is called and determines the next timeout (if any),	1558	or C<ev_timer_again> is called, and determines the next timeout (if any),
1198	which is also when any modifications are taken into account.	1559	which is also when any modifications are taken into account.
1199		1560
1200	=back	1561	=back
1201		1562
1202	=head3 Examples	1563	=head3 Examples
1203		1564
1204	Example: Create a timer that fires after 60 seconds.	1565	Example: Create a timer that fires after 60 seconds.
1205		1566
1206	static void	1567	static void
1207	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1568	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1208	{	1569	{
1209	.. one minute over, w is actually stopped right here	1570	.. one minute over, w is actually stopped right here
1210	}	1571	}
1211		1572
1212	struct ev_timer mytimer;	1573	ev_timer mytimer;
1213	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1574	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1214	ev_timer_start (loop, &mytimer);	1575	ev_timer_start (loop, &mytimer);
1215		1576
1216	Example: Create a timeout timer that times out after 10 seconds of	1577	Example: Create a timeout timer that times out after 10 seconds of
1217	inactivity.	1578	inactivity.
1218		1579
1219	static void	1580	static void
1220	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1581	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1221	{	1582	{
1222	.. ten seconds without any activity	1583	.. ten seconds without any activity
1223	}	1584	}
1224		1585
1225	struct ev_timer mytimer;	1586	ev_timer mytimer;
1226	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1587	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1227	ev_timer_again (&mytimer); /* start timer */	1588	ev_timer_again (&mytimer); /* start timer */
1228	ev_loop (loop, 0);	1589	ev_loop (loop, 0);
1229		1590
1230	// and in some piece of code that gets executed on any "activity":	1591	// and in some piece of code that gets executed on any "activity":
1231	// reset the timeout to start ticking again at 10 seconds	1592	// reset the timeout to start ticking again at 10 seconds
1232	ev_timer_again (&mytimer);	1593	ev_timer_again (&mytimer);
1233		1594
1234		1595
1235	=head2 C<ev_periodic> - to cron or not to cron?	1596	=head2 C<ev_periodic> - to cron or not to cron?
1236		1597
1237	Periodic watchers are also timers of a kind, but they are very versatile	1598	Periodic watchers are also timers of a kind, but they are very versatile
1238	(and unfortunately a bit complex).	1599	(and unfortunately a bit complex).
1239		1600
1240	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1601	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1241	but on wallclock time (absolute time). You can tell a periodic watcher	1602	but on wall clock time (absolute time). You can tell a periodic watcher
1242	to trigger "at" some specific point in time. For example, if you tell a	1603	to trigger after some specific point in time. For example, if you tell a
1243	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1604	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()
1244	+ 10.>) and then reset your system clock to the last year, then it will	1605	+ 10.>, that is, an absolute time not a delay) and then reset your system
		1606	clock to January of the previous year, then it will take more than year
1245	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1607	to trigger the event (unlike an C<ev_timer>, which would still trigger
1246	roughly 10 seconds later).	1608	roughly 10 seconds later as it uses a relative timeout).
1247		1609
1248	They can also be used to implement vastly more complex timers, such as	1610	C<ev_periodic>s can also be used to implement vastly more complex timers,
1249	triggering an event on each midnight, local time or other, complicated,	1611	such as triggering an event on each "midnight, local time", or other
1250	rules.	1612	complicated rules.
1251		1613
1252	As with timers, the callback is guarenteed to be invoked only when the	1614	As with timers, the callback is guaranteed to be invoked only when the
1253	time (C<at>) has been passed, but if multiple periodic timers become ready	1615	time (C<at>) has passed, but if multiple periodic timers become ready
1254	during the same loop iteration then order of execution is undefined.	1616	during the same loop iteration, then order of execution is undefined.
1255		1617
1256	=head3 Watcher-Specific Functions and Data Members	1618	=head3 Watcher-Specific Functions and Data Members
1257		1619
1258	=over 4	1620	=over 4
1259		1621
1260	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1622	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1261		1623
1262	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1624	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
1263		1625
1264	Lots of arguments, lets sort it out... There are basically three modes of	1626	Lots of arguments, lets sort it out... There are basically three modes of
1265	operation, and we will explain them from simplest to complex:	1627	operation, and we will explain them from simplest to most complex:
1266		1628
1267	=over 4	1629	=over 4
1268		1630
1269	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1631	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1270		1632
1271	In this configuration the watcher triggers an event at the wallclock time	1633	In this configuration the watcher triggers an event after the wall clock
1272	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1634	time C<at> has passed. It will not repeat and will not adjust when a time
1273	that is, if it is to be run at January 1st 2011 then it will run when the	1635	jump occurs, that is, if it is to be run at January 1st 2011 then it will
1274	system time reaches or surpasses this time.	1636	only run when the system clock reaches or surpasses this time.
1275		1637
1276	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1638	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1277		1639
1278	In this mode the watcher will always be scheduled to time out at the next	1640	In this mode the watcher will always be scheduled to time out at the next
1279	C<at + N * interval> time (for some integer N, which can also be negative)	1641	C<at + N * interval> time (for some integer N, which can also be negative)
1280	and then repeat, regardless of any time jumps.	1642	and then repeat, regardless of any time jumps.
1281		1643
1282	This can be used to create timers that do not drift with respect to system	1644	This can be used to create timers that do not drift with respect to the
1283	time:	1645	system clock, for example, here is a C<ev_periodic> that triggers each
		1646	hour, on the hour:
1284		1647
1285	ev_periodic_set (&periodic, 0., 3600., 0);	1648	ev_periodic_set (&periodic, 0., 3600., 0);
1286		1649
1287	This doesn't mean there will always be 3600 seconds in between triggers,	1650	This doesn't mean there will always be 3600 seconds in between triggers,
1288	but only that the the callback will be called when the system time shows a	1651	but only that the callback will be called when the system time shows a
1289	full hour (UTC), or more correctly, when the system time is evenly divisible	1652	full hour (UTC), or more correctly, when the system time is evenly divisible
1290	by 3600.	1653	by 3600.
1291		1654
1292	Another way to think about it (for the mathematically inclined) is that	1655	Another way to think about it (for the mathematically inclined) is that
1293	C<ev_periodic> will try to run the callback in this mode at the next possible	1656	C<ev_periodic> will try to run the callback in this mode at the next possible
1294	time where C<time = at (mod interval)>, regardless of any time jumps.	1657	time where C<time = at (mod interval)>, regardless of any time jumps.
1295		1658
1296	For numerical stability it is preferable that the C<at> value is near	1659	For numerical stability it is preferable that the C<at> value is near
1297	C<ev_now ()> (the current time), but there is no range requirement for	1660	C<ev_now ()> (the current time), but there is no range requirement for
1298	this value.	1661	this value, and in fact is often specified as zero.
		1662
		1663	Note also that there is an upper limit to how often a timer can fire (CPU
		1664	speed for example), so if C<interval> is very small then timing stability
		1665	will of course deteriorate. Libev itself tries to be exact to be about one
		1666	millisecond (if the OS supports it and the machine is fast enough).
1299		1667
1300	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1668	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1301		1669
1302	In this mode the values for C<interval> and C<at> are both being	1670	In this mode the values for C<interval> and C<at> are both being
1303	ignored. Instead, each time the periodic watcher gets scheduled, the	1671	ignored. Instead, each time the periodic watcher gets scheduled, the
1304	reschedule callback will be called with the watcher as first, and the	1672	reschedule callback will be called with the watcher as first, and the
1305	current time as second argument.	1673	current time as second argument.
1306		1674
1307	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1675	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1308	ever, or make any event loop modifications>. If you need to stop it,	1676	ever, or make ANY event loop modifications whatsoever>.
1309	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1310	starting an C<ev_prepare> watcher, which is legal).
1311		1677
		1678	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1679	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1680	only event loop modification you are allowed to do).
		1681
1312	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1682	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1313	ev_tstamp now)>, e.g.:	1683	*w, ev_tstamp now)>, e.g.:
1314		1684
		1685	static ev_tstamp
1315	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1686	my_rescheduler (ev_periodic *w, ev_tstamp now)
1316	{	1687	{
1317	return now + 60.;	1688	return now + 60.;
1318	}	1689	}
1319		1690
1320	It must return the next time to trigger, based on the passed time value	1691	It must return the next time to trigger, based on the passed time value
1321	(that is, the lowest time value larger than to the second argument). It	1692	(that is, the lowest time value larger than to the second argument). It
1322	will usually be called just before the callback will be triggered, but	1693	will usually be called just before the callback will be triggered, but
1323	might be called at other times, too.	1694	might be called at other times, too.
1324		1695
1325	NOTE: I<< This callback must always return a time that is later than the	1696	NOTE: I<< This callback must always return a time that is higher than or
1326	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1697	equal to the passed C<now> value >>.
1327		1698
1328	This can be used to create very complex timers, such as a timer that	1699	This can be used to create very complex timers, such as a timer that
1329	triggers on each midnight, local time. To do this, you would calculate the	1700	triggers on "next midnight, local time". To do this, you would calculate the
1330	next midnight after C<now> and return the timestamp value for this. How	1701	next midnight after C<now> and return the timestamp value for this. How
1331	you do this is, again, up to you (but it is not trivial, which is the main	1702	you do this is, again, up to you (but it is not trivial, which is the main
1332	reason I omitted it as an example).	1703	reason I omitted it as an example).
1333		1704
1334	=back	1705	=back
…		…
1338	Simply stops and restarts the periodic watcher again. This is only useful	1709	Simply stops and restarts the periodic watcher again. This is only useful
1339	when you changed some parameters or the reschedule callback would return	1710	when you changed some parameters or the reschedule callback would return
1340	a different time than the last time it was called (e.g. in a crond like	1711	a different time than the last time it was called (e.g. in a crond like
1341	program when the crontabs have changed).	1712	program when the crontabs have changed).
1342		1713
		1714	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1715
		1716	When active, returns the absolute time that the watcher is supposed to
		1717	trigger next.
		1718
1343	=item ev_tstamp offset [read-write]	1719	=item ev_tstamp offset [read-write]
1344		1720
1345	When repeating, this contains the offset value, otherwise this is the	1721	When repeating, this contains the offset value, otherwise this is the
1346	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1722	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1347		1723
…		…
1352		1728
1353	The current interval value. Can be modified any time, but changes only	1729	The current interval value. Can be modified any time, but changes only
1354	take effect when the periodic timer fires or C<ev_periodic_again> is being	1730	take effect when the periodic timer fires or C<ev_periodic_again> is being
1355	called.	1731	called.
1356		1732
1357	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1733	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1358		1734
1359	The current reschedule callback, or C<0>, if this functionality is	1735	The current reschedule callback, or C<0>, if this functionality is
1360	switched off. Can be changed any time, but changes only take effect when	1736	switched off. Can be changed any time, but changes only take effect when
1361	the periodic timer fires or C<ev_periodic_again> is being called.	1737	the periodic timer fires or C<ev_periodic_again> is being called.
1362		1738
1363	=item ev_tstamp at [read-only]
1364
1365	When active, contains the absolute time that the watcher is supposed to
1366	trigger next.
1367
1368	=back	1739	=back
1369		1740
1370	=head3 Examples	1741	=head3 Examples
1371		1742
1372	Example: Call a callback every hour, or, more precisely, whenever the	1743	Example: Call a callback every hour, or, more precisely, whenever the
1373	system clock is divisible by 3600. The callback invocation times have	1744	system time is divisible by 3600. The callback invocation times have
1374	potentially a lot of jittering, but good long-term stability.	1745	potentially a lot of jitter, but good long-term stability.
1375		1746
1376	static void	1747	static void
1377	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1748	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1378	{	1749	{
1379	... its now a full hour (UTC, or TAI or whatever your clock follows)	1750	... its now a full hour (UTC, or TAI or whatever your clock follows)
1380	}	1751	}
1381		1752
1382	struct ev_periodic hourly_tick;	1753	ev_periodic hourly_tick;
1383	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1754	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1384	ev_periodic_start (loop, &hourly_tick);	1755	ev_periodic_start (loop, &hourly_tick);
1385		1756
1386	Example: The same as above, but use a reschedule callback to do it:	1757	Example: The same as above, but use a reschedule callback to do it:
1387		1758
1388	#include <math.h>	1759	#include <math.h>
1389		1760
1390	static ev_tstamp	1761	static ev_tstamp
1391	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1762	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1392	{	1763	{
1393	return fmod (now, 3600.) + 3600.;	1764	return now + (3600. - fmod (now, 3600.));
1394	}	1765	}
1395		1766
1396	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1767	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1397		1768
1398	Example: Call a callback every hour, starting now:	1769	Example: Call a callback every hour, starting now:
1399		1770
1400	struct ev_periodic hourly_tick;	1771	ev_periodic hourly_tick;
1401	ev_periodic_init (&hourly_tick, clock_cb,	1772	ev_periodic_init (&hourly_tick, clock_cb,
1402	fmod (ev_now (loop), 3600.), 3600., 0);	1773	fmod (ev_now (loop), 3600.), 3600., 0);
1403	ev_periodic_start (loop, &hourly_tick);	1774	ev_periodic_start (loop, &hourly_tick);
1404		1775
1405		1776
1406	=head2 C<ev_signal> - signal me when a signal gets signalled!	1777	=head2 C<ev_signal> - signal me when a signal gets signalled!
1407		1778
1408	Signal watchers will trigger an event when the process receives a specific	1779	Signal watchers will trigger an event when the process receives a specific
1409	signal one or more times. Even though signals are very asynchronous, libev	1780	signal one or more times. Even though signals are very asynchronous, libev
1410	will try it's best to deliver signals synchronously, i.e. as part of the	1781	will try it's best to deliver signals synchronously, i.e. as part of the
1411	normal event processing, like any other event.	1782	normal event processing, like any other event.
1412		1783
		1784	If you want signals asynchronously, just use C<sigaction> as you would
		1785	do without libev and forget about sharing the signal. You can even use
		1786	C<ev_async> from a signal handler to synchronously wake up an event loop.
		1787
1413	You can configure as many watchers as you like per signal. Only when the	1788	You can configure as many watchers as you like per signal. Only when the
1414	first watcher gets started will libev actually register a signal watcher	1789	first watcher gets started will libev actually register a signal handler
1415	with the kernel (thus it coexists with your own signal handlers as long	1790	with the kernel (thus it coexists with your own signal handlers as long as
1416	as you don't register any with libev). Similarly, when the last signal	1791	you don't register any with libev for the same signal). Similarly, when
1417	watcher for a signal is stopped libev will reset the signal handler to	1792	the last signal watcher for a signal is stopped, libev will reset the
1418	SIG_DFL (regardless of what it was set to before).	1793	signal handler to SIG_DFL (regardless of what it was set to before).
		1794
		1795	If possible and supported, libev will install its handlers with
		1796	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
		1797	interrupted. If you have a problem with system calls getting interrupted by
		1798	signals you can block all signals in an C<ev_check> watcher and unblock
		1799	them in an C<ev_prepare> watcher.
1419		1800
1420	=head3 Watcher-Specific Functions and Data Members	1801	=head3 Watcher-Specific Functions and Data Members
1421		1802
1422	=over 4	1803	=over 4
1423		1804
…		…
1432		1813
1433	The signal the watcher watches out for.	1814	The signal the watcher watches out for.
1434		1815
1435	=back	1816	=back
1436		1817
		1818	=head3 Examples
		1819
		1820	Example: Try to exit cleanly on SIGINT.
		1821
		1822	static void
		1823	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
		1824	{
		1825	ev_unloop (loop, EVUNLOOP_ALL);
		1826	}
		1827
		1828	ev_signal signal_watcher;
		1829	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1830	ev_signal_start (loop, &signal_watcher);
		1831
1437		1832
1438	=head2 C<ev_child> - watch out for process status changes	1833	=head2 C<ev_child> - watch out for process status changes
1439		1834
1440	Child watchers trigger when your process receives a SIGCHLD in response to	1835	Child watchers trigger when your process receives a SIGCHLD in response to
1441	some child status changes (most typically when a child of yours dies).	1836	some child status changes (most typically when a child of yours dies or
		1837	exits). It is permissible to install a child watcher I<after> the child
		1838	has been forked (which implies it might have already exited), as long
		1839	as the event loop isn't entered (or is continued from a watcher), i.e.,
		1840	forking and then immediately registering a watcher for the child is fine,
		1841	but forking and registering a watcher a few event loop iterations later is
		1842	not.
		1843
		1844	Only the default event loop is capable of handling signals, and therefore
		1845	you can only register child watchers in the default event loop.
		1846
		1847	=head3 Process Interaction
		1848
		1849	Libev grabs C<SIGCHLD> as soon as the default event loop is
		1850	initialised. This is necessary to guarantee proper behaviour even if
		1851	the first child watcher is started after the child exits. The occurrence
		1852	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		1853	synchronously as part of the event loop processing. Libev always reaps all
		1854	children, even ones not watched.
		1855
		1856	=head3 Overriding the Built-In Processing
		1857
		1858	Libev offers no special support for overriding the built-in child
		1859	processing, but if your application collides with libev's default child
		1860	handler, you can override it easily by installing your own handler for
		1861	C<SIGCHLD> after initialising the default loop, and making sure the
		1862	default loop never gets destroyed. You are encouraged, however, to use an
		1863	event-based approach to child reaping and thus use libev's support for
		1864	that, so other libev users can use C<ev_child> watchers freely.
		1865
		1866	=head3 Stopping the Child Watcher
		1867
		1868	Currently, the child watcher never gets stopped, even when the
		1869	child terminates, so normally one needs to stop the watcher in the
		1870	callback. Future versions of libev might stop the watcher automatically
		1871	when a child exit is detected.
1442		1872
1443	=head3 Watcher-Specific Functions and Data Members	1873	=head3 Watcher-Specific Functions and Data Members
1444		1874
1445	=over 4	1875	=over 4
1446		1876
…		…
1472		1902
1473	=back	1903	=back
1474		1904
1475	=head3 Examples	1905	=head3 Examples
1476		1906
1477	Example: Try to exit cleanly on SIGINT and SIGTERM.	1907	Example: C<fork()> a new process and install a child handler to wait for
		1908	its completion.
1478		1909
		1910	ev_child cw;
		1911
1479	static void	1912	static void
1480	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1913	child_cb (EV_P_ ev_child *w, int revents)
1481	{	1914	{
1482	ev_unloop (loop, EVUNLOOP_ALL);	1915	ev_child_stop (EV_A_ w);
		1916	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1483	}	1917	}
1484		1918
1485	struct ev_signal signal_watcher;	1919	pid_t pid = fork ();
1486	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1920
1487	ev_signal_start (loop, &sigint_cb);	1921	if (pid < 0)
		1922	// error
		1923	else if (pid == 0)
		1924	{
		1925	// the forked child executes here
		1926	exit (1);
		1927	}
		1928	else
		1929	{
		1930	ev_child_init (&cw, child_cb, pid, 0);
		1931	ev_child_start (EV_DEFAULT_ &cw);
		1932	}
1488		1933
1489		1934
1490	=head2 C<ev_stat> - did the file attributes just change?	1935	=head2 C<ev_stat> - did the file attributes just change?
1491		1936
1492	This watches a filesystem path for attribute changes. That is, it calls	1937	This watches a file system path for attribute changes. That is, it calls
1493	C<stat> regularly (or when the OS says it changed) and sees if it changed	1938	C<stat> on that path in regular intervals (or when the OS says it changed)
1494	compared to the last time, invoking the callback if it did.	1939	and sees if it changed compared to the last time, invoking the callback if
		1940	it did.
1495		1941
1496	The path does not need to exist: changing from "path exists" to "path does	1942	The path does not need to exist: changing from "path exists" to "path does
1497	not exist" is a status change like any other. The condition "path does	1943	not exist" is a status change like any other. The condition "path does not
1498	not exist" is signified by the C<st_nlink> field being zero (which is	1944	exist" (or more correctly "path cannot be stat'ed") is signified by the
1499	otherwise always forced to be at least one) and all the other fields of	1945	C<st_nlink> field being zero (which is otherwise always forced to be at
1500	the stat buffer having unspecified contents.	1946	least one) and all the other fields of the stat buffer having unspecified
		1947	contents.
1501		1948
1502	The path I<should> be absolute and I<must not> end in a slash. If it is	1949	The path I<must not> end in a slash or contain special components such as
		1950	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1503	relative and your working directory changes, the behaviour is undefined.	1951	your working directory changes, then the behaviour is undefined.
1504		1952
1505	Since there is no standard to do this, the portable implementation simply	1953	Since there is no portable change notification interface available, the
1506	calls C<stat (2)> regularly on the path to see if it changed somehow. You	1954	portable implementation simply calls C<stat(2)> regularly on the path
1507	can specify a recommended polling interval for this case. If you specify	1955	to see if it changed somehow. You can specify a recommended polling
1508	a polling interval of C<0> (highly recommended!) then a I<suitable,	1956	interval for this case. If you specify a polling interval of C<0> (highly
1509	unspecified default> value will be used (which you can expect to be around	1957	recommended!) then a I<suitable, unspecified default> value will be used
1510	five seconds, although this might change dynamically). Libev will also	1958	(which you can expect to be around five seconds, although this might
1511	impose a minimum interval which is currently around C<0.1>, but thats	1959	change dynamically). Libev will also impose a minimum interval which is
1512	usually overkill.	1960	currently around C<0.1>, but that's usually overkill.
1513		1961
1514	This watcher type is not meant for massive numbers of stat watchers,	1962	This watcher type is not meant for massive numbers of stat watchers,
1515	as even with OS-supported change notifications, this can be	1963	as even with OS-supported change notifications, this can be
1516	resource-intensive.	1964	resource-intensive.
1517		1965
1518	At the time of this writing, only the Linux inotify interface is	1966	At the time of this writing, the only OS-specific interface implemented
1519	implemented (implementing kqueue support is left as an exercise for the	1967	is the Linux inotify interface (implementing kqueue support is left as an
1520	reader). Inotify will be used to give hints only and should not change the	1968	exercise for the reader. Note, however, that the author sees no way of
1521	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1969	implementing C<ev_stat> semantics with kqueue, except as a hint).
1522	to fall back to regular polling again even with inotify, but changes are
1523	usually detected immediately, and if the file exists there will be no
1524	polling.
1525		1970
1526	=head3 Inotify	1971	=head3 ABI Issues (Largefile Support)
1527		1972
		1973	Libev by default (unless the user overrides this) uses the default
		1974	compilation environment, which means that on systems with large file
		1975	support disabled by default, you get the 32 bit version of the stat
		1976	structure. When using the library from programs that change the ABI to
		1977	use 64 bit file offsets the programs will fail. In that case you have to
		1978	compile libev with the same flags to get binary compatibility. This is
		1979	obviously the case with any flags that change the ABI, but the problem is
		1980	most noticeably displayed with ev_stat and large file support.
		1981
		1982	The solution for this is to lobby your distribution maker to make large
		1983	file interfaces available by default (as e.g. FreeBSD does) and not
		1984	optional. Libev cannot simply switch on large file support because it has
		1985	to exchange stat structures with application programs compiled using the
		1986	default compilation environment.
		1987
		1988	=head3 Inotify and Kqueue
		1989
1528	When C<inotify (7)> support has been compiled into libev (generally only	1990	When C<inotify (7)> support has been compiled into libev and present at
1529	available on Linux) and present at runtime, it will be used to speed up	1991	runtime, it will be used to speed up change detection where possible. The
1530	change detection where possible. The inotify descriptor will be created lazily	1992	inotify descriptor will be created lazily when the first C<ev_stat>
1531	when the first C<ev_stat> watcher is being started.	1993	watcher is being started.
1532		1994
1533	Inotify presense does not change the semantics of C<ev_stat> watchers	1995	Inotify presence does not change the semantics of C<ev_stat> watchers
1534	except that changes might be detected earlier, and in some cases, to avoid	1996	except that changes might be detected earlier, and in some cases, to avoid
1535	making regular C<stat> calls. Even in the presense of inotify support	1997	making regular C<stat> calls. Even in the presence of inotify support
1536	there are many cases where libev has to resort to regular C<stat> polling.	1998	there are many cases where libev has to resort to regular C<stat> polling,
		1999	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2000	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2001	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2002	xfs are fully working) libev usually gets away without polling.
1537		2003
1538	(There is no support for kqueue, as apparently it cannot be used to	2004	There is no support for kqueue, as apparently it cannot be used to
1539	implement this functionality, due to the requirement of having a file	2005	implement this functionality, due to the requirement of having a file
1540	descriptor open on the object at all times).	2006	descriptor open on the object at all times, and detecting renames, unlinks
		2007	etc. is difficult.
		2008
		2009	=head3 C<stat ()> is a synchronous operation
		2010
		2011	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2012	the process. The exception are C<ev_stat> watchers - those call C<stat
		2013	()>, which is a synchronous operation.
		2014
		2015	For local paths, this usually doesn't matter: unless the system is very
		2016	busy or the intervals between stat's are large, a stat call will be fast,
		2017	as the path data is suually in memory already (except when starting the
		2018	watcher).
		2019
		2020	For networked file systems, calling C<stat ()> can block an indefinite
		2021	time due to network issues, and even under good conditions, a stat call
		2022	often takes multiple milliseconds.
		2023
		2024	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2025	paths, although this is fully supported by libev.
1541		2026
1542	=head3 The special problem of stat time resolution	2027	=head3 The special problem of stat time resolution
1543		2028
1544	The C<stat ()> syscall only supports full-second resolution portably, and	2029	The C<stat ()> system call only supports full-second resolution portably,
1545	even on systems where the resolution is higher, many filesystems still	2030	and even on systems where the resolution is higher, most file systems
1546	only support whole seconds.	2031	still only support whole seconds.
1547		2032
1548	That means that, if the time is the only thing that changes, you might	2033	That means that, if the time is the only thing that changes, you can
1549	miss updates: on the first update, C<ev_stat> detects a change and calls	2034	easily miss updates: on the first update, C<ev_stat> detects a change and
1550	your callback, which does something. When there is another update within	2035	calls your callback, which does something. When there is another update
1551	the same second, C<ev_stat> will be unable to detect it.	2036	within the same second, C<ev_stat> will be unable to detect unless the
		2037	stat data does change in other ways (e.g. file size).
1552		2038
1553	The solution to this is to delay acting on a change for a second (or till	2039	The solution to this is to delay acting on a change for slightly more
1554	the next second boundary), using a roughly one-second delay C<ev_timer>	2040	than a second (or till slightly after the next full second boundary), using
1555	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	2041	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1556	is added to work around small timing inconsistencies of some operating	2042	ev_timer_again (loop, w)>).
1557	systems.	2043
		2044	The C<.02> offset is added to work around small timing inconsistencies
		2045	of some operating systems (where the second counter of the current time
		2046	might be be delayed. One such system is the Linux kernel, where a call to
		2047	C<gettimeofday> might return a timestamp with a full second later than
		2048	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		2049	update file times then there will be a small window where the kernel uses
		2050	the previous second to update file times but libev might already execute
		2051	the timer callback).
1558		2052
1559	=head3 Watcher-Specific Functions and Data Members	2053	=head3 Watcher-Specific Functions and Data Members
1560		2054
1561	=over 4	2055	=over 4
1562		2056
…		…
1568	C<path>. The C<interval> is a hint on how quickly a change is expected to	2062	C<path>. The C<interval> is a hint on how quickly a change is expected to
1569	be detected and should normally be specified as C<0> to let libev choose	2063	be detected and should normally be specified as C<0> to let libev choose
1570	a suitable value. The memory pointed to by C<path> must point to the same	2064	a suitable value. The memory pointed to by C<path> must point to the same
1571	path for as long as the watcher is active.	2065	path for as long as the watcher is active.
1572		2066
1573	The callback will be receive C<EV_STAT> when a change was detected,	2067	The callback will receive an C<EV_STAT> event when a change was detected,
1574	relative to the attributes at the time the watcher was started (or the	2068	relative to the attributes at the time the watcher was started (or the
1575	last change was detected).	2069	last change was detected).
1576		2070
1577	=item ev_stat_stat (ev_stat *)	2071	=item ev_stat_stat (loop, ev_stat *)
1578		2072
1579	Updates the stat buffer immediately with new values. If you change the	2073	Updates the stat buffer immediately with new values. If you change the
1580	watched path in your callback, you could call this fucntion to avoid	2074	watched path in your callback, you could call this function to avoid
1581	detecting this change (while introducing a race condition). Can also be	2075	detecting this change (while introducing a race condition if you are not
1582	useful simply to find out the new values.	2076	the only one changing the path). Can also be useful simply to find out the
		2077	new values.
1583		2078
1584	=item ev_statdata attr [read-only]	2079	=item ev_statdata attr [read-only]
1585		2080
1586	The most-recently detected attributes of the file. Although the type is of	2081	The most-recently detected attributes of the file. Although the type is
1587	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	2082	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1588	suitable for your system. If the C<st_nlink> member is C<0>, then there	2083	suitable for your system, but you can only rely on the POSIX-standardised
		2084	members to be present. If the C<st_nlink> member is C<0>, then there was
1589	was some error while C<stat>ing the file.	2085	some error while C<stat>ing the file.
1590		2086
1591	=item ev_statdata prev [read-only]	2087	=item ev_statdata prev [read-only]
1592		2088
1593	The previous attributes of the file. The callback gets invoked whenever	2089	The previous attributes of the file. The callback gets invoked whenever
1594	C<prev> != C<attr>.	2090	C<prev> != C<attr>, or, more precisely, one or more of these members
		2091	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		2092	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1595		2093
1596	=item ev_tstamp interval [read-only]	2094	=item ev_tstamp interval [read-only]
1597		2095
1598	The specified interval.	2096	The specified interval.
1599		2097
1600	=item const char *path [read-only]	2098	=item const char *path [read-only]
1601		2099
1602	The filesystem path that is being watched.	2100	The file system path that is being watched.
1603		2101
1604	=back	2102	=back
1605		2103
1606	=head3 Examples	2104	=head3 Examples
1607		2105
1608	Example: Watch C</etc/passwd> for attribute changes.	2106	Example: Watch C</etc/passwd> for attribute changes.
1609		2107
1610	static void	2108	static void
1611	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	2109	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1612	{	2110	{
1613	/* /etc/passwd changed in some way */	2111	/* /etc/passwd changed in some way */
1614	if (w->attr.st_nlink)	2112	if (w->attr.st_nlink)
1615	{	2113	{
1616	printf ("passwd current size %ld\n", (long)w->attr.st_size);	2114	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1617	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	2115	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1618	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	2116	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1619	}	2117	}
1620	else	2118	else
1621	/* you shalt not abuse printf for puts */	2119	/* you shalt not abuse printf for puts */
1622	puts ("wow, /etc/passwd is not there, expect problems. "	2120	puts ("wow, /etc/passwd is not there, expect problems. "
1623	"if this is windows, they already arrived\n");	2121	"if this is windows, they already arrived\n");
1624	}	2122	}
1625		2123
1626	...	2124	...
1627	ev_stat passwd;	2125	ev_stat passwd;
1628		2126
1629	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	2127	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1630	ev_stat_start (loop, &passwd);	2128	ev_stat_start (loop, &passwd);
1631		2129
1632	Example: Like above, but additionally use a one-second delay so we do not	2130	Example: Like above, but additionally use a one-second delay so we do not
1633	miss updates (however, frequent updates will delay processing, too, so	2131	miss updates (however, frequent updates will delay processing, too, so
1634	one might do the work both on C<ev_stat> callback invocation I<and> on	2132	one might do the work both on C<ev_stat> callback invocation I<and> on
1635	C<ev_timer> callback invocation).	2133	C<ev_timer> callback invocation).
1636		2134
1637	static ev_stat passwd;	2135	static ev_stat passwd;
1638	static ev_timer timer;	2136	static ev_timer timer;
1639		2137
1640	static void	2138	static void
1641	timer_cb (EV_P_ ev_timer *w, int revents)	2139	timer_cb (EV_P_ ev_timer *w, int revents)
1642	{	2140	{
1643	ev_timer_stop (EV_A_ w);	2141	ev_timer_stop (EV_A_ w);
1644		2142
1645	/* now it's one second after the most recent passwd change */	2143	/* now it's one second after the most recent passwd change */
1646	}	2144	}
1647		2145
1648	static void	2146	static void
1649	stat_cb (EV_P_ ev_stat *w, int revents)	2147	stat_cb (EV_P_ ev_stat *w, int revents)
1650	{	2148	{
1651	/* reset the one-second timer */	2149	/* reset the one-second timer */
1652	ev_timer_again (EV_A_ &timer);	2150	ev_timer_again (EV_A_ &timer);
1653	}	2151	}
1654		2152
1655	...	2153	...
1656	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	2154	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1657	ev_stat_start (loop, &passwd);	2155	ev_stat_start (loop, &passwd);
1658	ev_timer_init (&timer, timer_cb, 0., 1.01);	2156	ev_timer_init (&timer, timer_cb, 0., 1.02);
1659		2157
1660		2158
1661	=head2 C<ev_idle> - when you've got nothing better to do...	2159	=head2 C<ev_idle> - when you've got nothing better to do...
1662		2160
1663	Idle watchers trigger events when no other events of the same or higher	2161	Idle watchers trigger events when no other events of the same or higher
1664	priority are pending (prepare, check and other idle watchers do not	2162	priority are pending (prepare, check and other idle watchers do not count
1665	count).	2163	as receiving "events").
1666		2164
1667	That is, as long as your process is busy handling sockets or timeouts	2165	That is, as long as your process is busy handling sockets or timeouts
1668	(or even signals, imagine) of the same or higher priority it will not be	2166	(or even signals, imagine) of the same or higher priority it will not be
1669	triggered. But when your process is idle (or only lower-priority watchers	2167	triggered. But when your process is idle (or only lower-priority watchers
1670	are pending), the idle watchers are being called once per event loop	2168	are pending), the idle watchers are being called once per event loop
…		…
1694	=head3 Examples	2192	=head3 Examples
1695		2193
1696	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2194	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1697	callback, free it. Also, use no error checking, as usual.	2195	callback, free it. Also, use no error checking, as usual.
1698		2196
1699	static void	2197	static void
1700	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2198	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1701	{	2199	{
1702	free (w);	2200	free (w);
1703	// now do something you wanted to do when the program has	2201	// now do something you wanted to do when the program has
1704	// no longer anything immediate to do.	2202	// no longer anything immediate to do.
1705	}	2203	}
1706		2204
1707	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2205	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1708	ev_idle_init (idle_watcher, idle_cb);	2206	ev_idle_init (idle_watcher, idle_cb);
1709	ev_idle_start (loop, idle_cb);	2207	ev_idle_start (loop, idle_cb);
1710		2208
1711		2209
1712	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2210	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1713		2211
1714	Prepare and check watchers are usually (but not always) used in tandem:	2212	Prepare and check watchers are usually (but not always) used in pairs:
1715	prepare watchers get invoked before the process blocks and check watchers	2213	prepare watchers get invoked before the process blocks and check watchers
1716	afterwards.	2214	afterwards.
1717		2215
1718	You I<must not> call C<ev_loop> or similar functions that enter	2216	You I<must not> call C<ev_loop> or similar functions that enter
1719	the current event loop from either C<ev_prepare> or C<ev_check>	2217	the current event loop from either C<ev_prepare> or C<ev_check>
…		…
1722	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2220	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1723	C<ev_check> so if you have one watcher of each kind they will always be	2221	C<ev_check> so if you have one watcher of each kind they will always be
1724	called in pairs bracketing the blocking call.	2222	called in pairs bracketing the blocking call.
1725		2223
1726	Their main purpose is to integrate other event mechanisms into libev and	2224	Their main purpose is to integrate other event mechanisms into libev and
1727	their use is somewhat advanced. This could be used, for example, to track	2225	their use is somewhat advanced. They could be used, for example, to track
1728	variable changes, implement your own watchers, integrate net-snmp or a	2226	variable changes, implement your own watchers, integrate net-snmp or a
1729	coroutine library and lots more. They are also occasionally useful if	2227	coroutine library and lots more. They are also occasionally useful if
1730	you cache some data and want to flush it before blocking (for example,	2228	you cache some data and want to flush it before blocking (for example,
1731	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>	2229	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1732	watcher).	2230	watcher).
1733		2231
1734	This is done by examining in each prepare call which file descriptors need	2232	This is done by examining in each prepare call which file descriptors
1735	to be watched by the other library, registering C<ev_io> watchers for	2233	need to be watched by the other library, registering C<ev_io> watchers
1736	them and starting an C<ev_timer> watcher for any timeouts (many libraries	2234	for them and starting an C<ev_timer> watcher for any timeouts (many
1737	provide just this functionality). Then, in the check watcher you check for	2235	libraries provide exactly this functionality). Then, in the check watcher,
1738	any events that occured (by checking the pending status of all watchers	2236	you check for any events that occurred (by checking the pending status
1739	and stopping them) and call back into the library. The I/O and timer	2237	of all watchers and stopping them) and call back into the library. The
1740	callbacks will never actually be called (but must be valid nevertheless,	2238	I/O and timer callbacks will never actually be called (but must be valid
1741	because you never know, you know?).	2239	nevertheless, because you never know, you know?).
1742		2240
1743	As another example, the Perl Coro module uses these hooks to integrate	2241	As another example, the Perl Coro module uses these hooks to integrate
1744	coroutines into libev programs, by yielding to other active coroutines	2242	coroutines into libev programs, by yielding to other active coroutines
1745	during each prepare and only letting the process block if no coroutines	2243	during each prepare and only letting the process block if no coroutines
1746	are ready to run (it's actually more complicated: it only runs coroutines	2244	are ready to run (it's actually more complicated: it only runs coroutines
…		…
1749	loop from blocking if lower-priority coroutines are active, thus mapping	2247	loop from blocking if lower-priority coroutines are active, thus mapping
1750	low-priority coroutines to idle/background tasks).	2248	low-priority coroutines to idle/background tasks).
1751		2249
1752	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2250	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1753	priority, to ensure that they are being run before any other watchers	2251	priority, to ensure that they are being run before any other watchers
		2252	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2253
1754	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2254	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1755	too) should not activate ("feed") events into libev. While libev fully	2255	activate ("feed") events into libev. While libev fully supports this, they
1756	supports this, they will be called before other C<ev_check> watchers	2256	might get executed before other C<ev_check> watchers did their job. As
1757	did their job. As C<ev_check> watchers are often used to embed other	2257	C<ev_check> watchers are often used to embed other (non-libev) event
1758	(non-libev) event loops those other event loops might be in an unusable	2258	loops those other event loops might be in an unusable state until their
1759	state until their C<ev_check> watcher ran (always remind yourself to	2259	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1760	coexist peacefully with others).	2260	others).
1761		2261
1762	=head3 Watcher-Specific Functions and Data Members	2262	=head3 Watcher-Specific Functions and Data Members
1763		2263
1764	=over 4	2264	=over 4
1765		2265
…		…
1767		2267
1768	=item ev_check_init (ev_check *, callback)	2268	=item ev_check_init (ev_check *, callback)
1769		2269
1770	Initialises and configures the prepare or check watcher - they have no	2270	Initialises and configures the prepare or check watcher - they have no
1771	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	2271	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1772	macros, but using them is utterly, utterly and completely pointless.	2272	macros, but using them is utterly, utterly, utterly and completely
		2273	pointless.
1773		2274
1774	=back	2275	=back
1775		2276
1776	=head3 Examples	2277	=head3 Examples
1777		2278
1778	There are a number of principal ways to embed other event loops or modules	2279	There are a number of principal ways to embed other event loops or modules
1779	into libev. Here are some ideas on how to include libadns into libev	2280	into libev. Here are some ideas on how to include libadns into libev
1780	(there is a Perl module named C<EV::ADNS> that does this, which you could	2281	(there is a Perl module named C<EV::ADNS> that does this, which you could
1781	use for an actually working example. Another Perl module named C<EV::Glib>	2282	use as a working example. Another Perl module named C<EV::Glib> embeds a
1782	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	2283	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1783	into the Glib event loop).	2284	Glib event loop).
1784		2285
1785	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	2286	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1786	and in a check watcher, destroy them and call into libadns. What follows	2287	and in a check watcher, destroy them and call into libadns. What follows
1787	is pseudo-code only of course. This requires you to either use a low	2288	is pseudo-code only of course. This requires you to either use a low
1788	priority for the check watcher or use C<ev_clear_pending> explicitly, as	2289	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1789	the callbacks for the IO/timeout watchers might not have been called yet.	2290	the callbacks for the IO/timeout watchers might not have been called yet.
1790		2291
1791	static ev_io iow [nfd];	2292	static ev_io iow [nfd];
1792	static ev_timer tw;	2293	static ev_timer tw;
1793		2294
1794	static void	2295	static void
1795	io_cb (ev_loop *loop, ev_io *w, int revents)	2296	io_cb (struct ev_loop *loop, ev_io *w, int revents)
1796	{	2297	{
1797	}	2298	}
1798		2299
1799	// create io watchers for each fd and a timer before blocking	2300	// create io watchers for each fd and a timer before blocking
1800	static void	2301	static void
1801	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2302	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1802	{	2303	{
1803	int timeout = 3600000;	2304	int timeout = 3600000;
1804	struct pollfd fds [nfd];	2305	struct pollfd fds [nfd];
1805	// actual code will need to loop here and realloc etc.	2306	// actual code will need to loop here and realloc etc.
1806	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2307	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1807		2308
1808	/* the callback is illegal, but won't be called as we stop during check */	2309	/* the callback is illegal, but won't be called as we stop during check */
1809	ev_timer_init (&tw, 0, timeout * 1e-3);	2310	ev_timer_init (&tw, 0, timeout * 1e-3);
1810	ev_timer_start (loop, &tw);	2311	ev_timer_start (loop, &tw);
1811		2312
1812	// create one ev_io per pollfd	2313	// create one ev_io per pollfd
1813	for (int i = 0; i < nfd; ++i)	2314	for (int i = 0; i < nfd; ++i)
1814	{	2315	{
1815	ev_io_init (iow + i, io_cb, fds [i].fd,	2316	ev_io_init (iow + i, io_cb, fds [i].fd,
1816	((fds [i].events & POLLIN ? EV_READ : 0)	2317	((fds [i].events & POLLIN ? EV_READ : 0)
1817	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2318	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1818		2319
1819	fds [i].revents = 0;	2320	fds [i].revents = 0;
1820	ev_io_start (loop, iow + i);	2321	ev_io_start (loop, iow + i);
1821	}	2322	}
1822	}	2323	}
1823		2324
1824	// stop all watchers after blocking	2325	// stop all watchers after blocking
1825	static void	2326	static void
1826	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2327	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
1827	{	2328	{
1828	ev_timer_stop (loop, &tw);	2329	ev_timer_stop (loop, &tw);
1829		2330
1830	for (int i = 0; i < nfd; ++i)	2331	for (int i = 0; i < nfd; ++i)
1831	{	2332	{
1832	// set the relevant poll flags	2333	// set the relevant poll flags
1833	// could also call adns_processreadable etc. here	2334	// could also call adns_processreadable etc. here
1834	struct pollfd *fd = fds + i;	2335	struct pollfd *fd = fds + i;
1835	int revents = ev_clear_pending (iow + i);	2336	int revents = ev_clear_pending (iow + i);
1836	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2337	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1837	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2338	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1838		2339
1839	// now stop the watcher	2340	// now stop the watcher
1840	ev_io_stop (loop, iow + i);	2341	ev_io_stop (loop, iow + i);
1841	}	2342	}
1842		2343
1843	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2344	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1844	}	2345	}
1845		2346
1846	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2347	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1847	in the prepare watcher and would dispose of the check watcher.	2348	in the prepare watcher and would dispose of the check watcher.
1848		2349
1849	Method 3: If the module to be embedded supports explicit event	2350	Method 3: If the module to be embedded supports explicit event
1850	notification (adns does), you can also make use of the actual watcher	2351	notification (libadns does), you can also make use of the actual watcher
1851	callbacks, and only destroy/create the watchers in the prepare watcher.	2352	callbacks, and only destroy/create the watchers in the prepare watcher.
1852		2353
1853	static void	2354	static void
1854	timer_cb (EV_P_ ev_timer *w, int revents)	2355	timer_cb (EV_P_ ev_timer *w, int revents)
1855	{	2356	{
1856	adns_state ads = (adns_state)w->data;	2357	adns_state ads = (adns_state)w->data;
1857	update_now (EV_A);	2358	update_now (EV_A);
1858		2359
1859	adns_processtimeouts (ads, &tv_now);	2360	adns_processtimeouts (ads, &tv_now);
1860	}	2361	}
1861		2362
1862	static void	2363	static void
1863	io_cb (EV_P_ ev_io *w, int revents)	2364	io_cb (EV_P_ ev_io *w, int revents)
1864	{	2365	{
1865	adns_state ads = (adns_state)w->data;	2366	adns_state ads = (adns_state)w->data;
1866	update_now (EV_A);	2367	update_now (EV_A);
1867		2368
1868	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2369	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1869	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2370	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1870	}	2371	}
1871		2372
1872	// do not ever call adns_afterpoll	2373	// do not ever call adns_afterpoll
1873		2374
1874	Method 4: Do not use a prepare or check watcher because the module you	2375	Method 4: Do not use a prepare or check watcher because the module you
1875	want to embed is too inflexible to support it. Instead, youc na override	2376	want to embed is not flexible enough to support it. Instead, you can
1876	their poll function. The drawback with this solution is that the main	2377	override their poll function. The drawback with this solution is that the
1877	loop is now no longer controllable by EV. The C<Glib::EV> module does	2378	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
1878	this.	2379	this approach, effectively embedding EV as a client into the horrible
		2380	libglib event loop.
1879		2381
1880	static gint	2382	static gint
1881	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2383	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1882	{	2384	{
1883	int got_events = 0;	2385	int got_events = 0;
1884		2386
1885	for (n = 0; n < nfds; ++n)	2387	for (n = 0; n < nfds; ++n)
1886	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2388	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1887		2389
1888	if (timeout >= 0)	2390	if (timeout >= 0)
1889	// create/start timer	2391	// create/start timer
1890		2392
1891	// poll	2393	// poll
1892	ev_loop (EV_A_ 0);	2394	ev_loop (EV_A_ 0);
1893		2395
1894	// stop timer again	2396	// stop timer again
1895	if (timeout >= 0)	2397	if (timeout >= 0)
1896	ev_timer_stop (EV_A_ &to);	2398	ev_timer_stop (EV_A_ &to);
1897		2399
1898	// stop io watchers again - their callbacks should have set	2400	// stop io watchers again - their callbacks should have set
1899	for (n = 0; n < nfds; ++n)	2401	for (n = 0; n < nfds; ++n)
1900	ev_io_stop (EV_A_ iow [n]);	2402	ev_io_stop (EV_A_ iow [n]);
1901		2403
1902	return got_events;	2404	return got_events;
1903	}	2405	}
1904		2406
1905		2407
1906	=head2 C<ev_embed> - when one backend isn't enough...	2408	=head2 C<ev_embed> - when one backend isn't enough...
1907		2409
1908	This is a rather advanced watcher type that lets you embed one event loop	2410	This is a rather advanced watcher type that lets you embed one event loop
…		…
1914	prioritise I/O.	2416	prioritise I/O.
1915		2417
1916	As an example for a bug workaround, the kqueue backend might only support	2418	As an example for a bug workaround, the kqueue backend might only support
1917	sockets on some platform, so it is unusable as generic backend, but you	2419	sockets on some platform, so it is unusable as generic backend, but you
1918	still want to make use of it because you have many sockets and it scales	2420	still want to make use of it because you have many sockets and it scales
1919	so nicely. In this case, you would create a kqueue-based loop and embed it	2421	so nicely. In this case, you would create a kqueue-based loop and embed
1920	into your default loop (which might use e.g. poll). Overall operation will	2422	it into your default loop (which might use e.g. poll). Overall operation
1921	be a bit slower because first libev has to poll and then call kevent, but	2423	will be a bit slower because first libev has to call C<poll> and then
1922	at least you can use both at what they are best.	2424	C<kevent>, but at least you can use both mechanisms for what they are
		2425	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
1923		2426
1924	As for prioritising I/O: rarely you have the case where some fds have	2427	As for prioritising I/O: under rare circumstances you have the case where
1925	to be watched and handled very quickly (with low latency), and even	2428	some fds have to be watched and handled very quickly (with low latency),
1926	priorities and idle watchers might have too much overhead. In this case	2429	and even priorities and idle watchers might have too much overhead. In
1927	you would put all the high priority stuff in one loop and all the rest in	2430	this case you would put all the high priority stuff in one loop and all
1928	a second one, and embed the second one in the first.	2431	the rest in a second one, and embed the second one in the first.
1929		2432
1930	As long as the watcher is active, the callback will be invoked every time	2433	As long as the watcher is active, the callback will be invoked every time
1931	there might be events pending in the embedded loop. The callback must then	2434	there might be events pending in the embedded loop. The callback must then
1932	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2435	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke
1933	their callbacks (you could also start an idle watcher to give the embedded	2436	their callbacks (you could also start an idle watcher to give the embedded
…		…
1941	interested in that.	2444	interested in that.
1942		2445
1943	Also, there have not currently been made special provisions for forking:	2446	Also, there have not currently been made special provisions for forking:
1944	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2447	when you fork, you not only have to call C<ev_loop_fork> on both loops,
1945	but you will also have to stop and restart any C<ev_embed> watchers	2448	but you will also have to stop and restart any C<ev_embed> watchers
1946	yourself.	2449	yourself - but you can use a fork watcher to handle this automatically,
		2450	and future versions of libev might do just that.
1947		2451
1948	Unfortunately, not all backends are embeddable, only the ones returned by	2452	Unfortunately, not all backends are embeddable: only the ones returned by
1949	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2453	C<ev_embeddable_backends> are, which, unfortunately, does not include any
1950	portable one.	2454	portable one.
1951		2455
1952	So when you want to use this feature you will always have to be prepared	2456	So when you want to use this feature you will always have to be prepared
1953	that you cannot get an embeddable loop. The recommended way to get around	2457	that you cannot get an embeddable loop. The recommended way to get around
1954	this is to have a separate variables for your embeddable loop, try to	2458	this is to have a separate variables for your embeddable loop, try to
1955	create it, and if that fails, use the normal loop for everything.	2459	create it, and if that fails, use the normal loop for everything.
1956		2460
		2461	=head3 C<ev_embed> and fork
		2462
		2463	While the C<ev_embed> watcher is running, forks in the embedding loop will
		2464	automatically be applied to the embedded loop as well, so no special
		2465	fork handling is required in that case. When the watcher is not running,
		2466	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		2467	as applicable.
		2468
1957	=head3 Watcher-Specific Functions and Data Members	2469	=head3 Watcher-Specific Functions and Data Members
1958		2470
1959	=over 4	2471	=over 4
1960		2472
1961	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	2473	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
…		…
1964		2476
1965	Configures the watcher to embed the given loop, which must be	2477	Configures the watcher to embed the given loop, which must be
1966	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2478	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1967	invoked automatically, otherwise it is the responsibility of the callback	2479	invoked automatically, otherwise it is the responsibility of the callback
1968	to invoke it (it will continue to be called until the sweep has been done,	2480	to invoke it (it will continue to be called until the sweep has been done,
1969	if you do not want thta, you need to temporarily stop the embed watcher).	2481	if you do not want that, you need to temporarily stop the embed watcher).
1970		2482
1971	=item ev_embed_sweep (loop, ev_embed *)	2483	=item ev_embed_sweep (loop, ev_embed *)
1972		2484
1973	Make a single, non-blocking sweep over the embedded loop. This works	2485	Make a single, non-blocking sweep over the embedded loop. This works
1974	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2486	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1975	apropriate way for embedded loops.	2487	appropriate way for embedded loops.
1976		2488
1977	=item struct ev_loop *other [read-only]	2489	=item struct ev_loop *other [read-only]
1978		2490
1979	The embedded event loop.	2491	The embedded event loop.
1980		2492
…		…
1982		2494
1983	=head3 Examples	2495	=head3 Examples
1984		2496
1985	Example: Try to get an embeddable event loop and embed it into the default	2497	Example: Try to get an embeddable event loop and embed it into the default
1986	event loop. If that is not possible, use the default loop. The default	2498	event loop. If that is not possible, use the default loop. The default
1987	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2499	loop is stored in C<loop_hi>, while the embeddable loop is stored in
1988	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2500	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
1989	used).	2501	used).
1990		2502
1991	struct ev_loop *loop_hi = ev_default_init (0);	2503	struct ev_loop *loop_hi = ev_default_init (0);
1992	struct ev_loop *loop_lo = 0;	2504	struct ev_loop *loop_lo = 0;
1993	struct ev_embed embed;	2505	ev_embed embed;
1994		2506
1995	// see if there is a chance of getting one that works	2507	// see if there is a chance of getting one that works
1996	// (remember that a flags value of 0 means autodetection)	2508	// (remember that a flags value of 0 means autodetection)
1997	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2509	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1998	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2510	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1999	: 0;	2511	: 0;
2000		2512
2001	// if we got one, then embed it, otherwise default to loop_hi	2513	// if we got one, then embed it, otherwise default to loop_hi
2002	if (loop_lo)	2514	if (loop_lo)
2003	{	2515	{
2004	ev_embed_init (&embed, 0, loop_lo);	2516	ev_embed_init (&embed, 0, loop_lo);
2005	ev_embed_start (loop_hi, &embed);	2517	ev_embed_start (loop_hi, &embed);
2006	}	2518	}
2007	else	2519	else
2008	loop_lo = loop_hi;	2520	loop_lo = loop_hi;
2009		2521
2010	Example: Check if kqueue is available but not recommended and create	2522	Example: Check if kqueue is available but not recommended and create
2011	a kqueue backend for use with sockets (which usually work with any	2523	a kqueue backend for use with sockets (which usually work with any
2012	kqueue implementation). Store the kqueue/socket-only event loop in	2524	kqueue implementation). Store the kqueue/socket-only event loop in
2013	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2525	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2014		2526
2015	struct ev_loop *loop = ev_default_init (0);	2527	struct ev_loop *loop = ev_default_init (0);
2016	struct ev_loop *loop_socket = 0;	2528	struct ev_loop *loop_socket = 0;
2017	struct ev_embed embed;	2529	ev_embed embed;
2018		2530
2019	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2531	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2020	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2532	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2021	{	2533	{
2022	ev_embed_init (&embed, 0, loop_socket);	2534	ev_embed_init (&embed, 0, loop_socket);
2023	ev_embed_start (loop, &embed);	2535	ev_embed_start (loop, &embed);
2024	}	2536	}
2025		2537
2026	if (!loop_socket)	2538	if (!loop_socket)
2027	loop_socket = loop;	2539	loop_socket = loop;
2028		2540
2029	// now use loop_socket for all sockets, and loop for everything else	2541	// now use loop_socket for all sockets, and loop for everything else
2030		2542
2031		2543
2032	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2544	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2033		2545
2034	Fork watchers are called when a C<fork ()> was detected (usually because	2546	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2078	is that the author does not know of a simple (or any) algorithm for a	2590	is that the author does not know of a simple (or any) algorithm for a
2079	multiple-writer-single-reader queue that works in all cases and doesn't	2591	multiple-writer-single-reader queue that works in all cases and doesn't
2080	need elaborate support such as pthreads.	2592	need elaborate support such as pthreads.
2081		2593
2082	That means that if you want to queue data, you have to provide your own	2594	That means that if you want to queue data, you have to provide your own
2083	queue. But at least I can tell you would implement locking around your	2595	queue. But at least I can tell you how to implement locking around your
2084	queue:	2596	queue:
2085		2597
2086	=over 4	2598	=over 4
2087		2599
2088	=item queueing from a signal handler context	2600	=item queueing from a signal handler context
2089		2601
2090	To implement race-free queueing, you simply add to the queue in the signal	2602	To implement race-free queueing, you simply add to the queue in the signal
2091	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2603	handler but you block the signal handler in the watcher callback. Here is
2092	some fictitiuous SIGUSR1 handler:	2604	an example that does that for some fictitious SIGUSR1 handler:
2093		2605
2094	static ev_async mysig;	2606	static ev_async mysig;
2095		2607
2096	static void	2608	static void
2097	sigusr1_handler (void)	2609	sigusr1_handler (void)
2098	{	2610	{
2099	sometype data;	2611	sometype data;
2100		2612
2101	// no locking etc.	2613	// no locking etc.
2102	queue_put (data);	2614	queue_put (data);
2103	ev_async_send (DEFAULT_ &mysig);	2615	ev_async_send (EV_DEFAULT_ &mysig);
2104	}	2616	}
2105		2617
2106	static void	2618	static void
2107	mysig_cb (EV_P_ ev_async *w, int revents)	2619	mysig_cb (EV_P_ ev_async *w, int revents)
2108	{	2620	{
…		…
2139	// only need to lock the actual queueing operation	2651	// only need to lock the actual queueing operation
2140	pthread_mutex_lock (&mymutex);	2652	pthread_mutex_lock (&mymutex);
2141	queue_put (data);	2653	queue_put (data);
2142	pthread_mutex_unlock (&mymutex);	2654	pthread_mutex_unlock (&mymutex);
2143		2655
2144	ev_async_send (DEFAULT_ &mysig);	2656	ev_async_send (EV_DEFAULT_ &mysig);
2145	}	2657	}
2146		2658
2147	static void	2659	static void
2148	mysig_cb (EV_P_ ev_async *w, int revents)	2660	mysig_cb (EV_P_ ev_async *w, int revents)
2149	{	2661	{
…		…
2163	=over 4	2675	=over 4
2164		2676
2165	=item ev_async_init (ev_async *, callback)	2677	=item ev_async_init (ev_async *, callback)
2166		2678
2167	Initialises and configures the async watcher - it has no parameters of any	2679	Initialises and configures the async watcher - it has no parameters of any
2168	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	2680	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2169	believe me.	2681	trust me.
2170		2682
2171	=item ev_async_send (loop, ev_async *)	2683	=item ev_async_send (loop, ev_async *)
2172		2684
2173	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2685	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2174	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2686	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2175	C<ev_feed_event>, this call is safe to do in other threads, signal or	2687	C<ev_feed_event>, this call is safe to do from other threads, signal or
2176	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding	2688	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2177	section below on what exactly this means).	2689	section below on what exactly this means).
2178		2690
2179	This call incurs the overhead of a syscall only once per loop iteration,	2691	This call incurs the overhead of a system call only once per loop iteration,
2180	so while the overhead might be noticable, it doesn't apply to repeated	2692	so while the overhead might be noticeable, it doesn't apply to repeated
2181	calls to C<ev_async_send>.	2693	calls to C<ev_async_send>.
2182		2694
		2695	=item bool = ev_async_pending (ev_async *)
		2696
		2697	Returns a non-zero value when C<ev_async_send> has been called on the
		2698	watcher but the event has not yet been processed (or even noted) by the
		2699	event loop.
		2700
		2701	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2702	the loop iterates next and checks for the watcher to have become active,
		2703	it will reset the flag again. C<ev_async_pending> can be used to very
		2704	quickly check whether invoking the loop might be a good idea.
		2705
		2706	Not that this does I<not> check whether the watcher itself is pending, only
		2707	whether it has been requested to make this watcher pending.
		2708
2183	=back	2709	=back
2184		2710
2185		2711
2186	=head1 OTHER FUNCTIONS	2712	=head1 OTHER FUNCTIONS
2187		2713
…		…
2190	=over 4	2716	=over 4
2191		2717
2192	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	2718	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2193		2719
2194	This function combines a simple timer and an I/O watcher, calls your	2720	This function combines a simple timer and an I/O watcher, calls your
2195	callback on whichever event happens first and automatically stop both	2721	callback on whichever event happens first and automatically stops both
2196	watchers. This is useful if you want to wait for a single event on an fd	2722	watchers. This is useful if you want to wait for a single event on an fd
2197	or timeout without having to allocate/configure/start/stop/free one or	2723	or timeout without having to allocate/configure/start/stop/free one or
2198	more watchers yourself.	2724	more watchers yourself.
2199		2725
2200	If C<fd> is less than 0, then no I/O watcher will be started and events	2726	If C<fd> is less than 0, then no I/O watcher will be started and the
2201	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2727	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2202	C<events> set will be craeted and started.	2728	the given C<fd> and C<events> set will be created and started.
2203		2729
2204	If C<timeout> is less than 0, then no timeout watcher will be	2730	If C<timeout> is less than 0, then no timeout watcher will be
2205	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2731	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2206	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2732	repeat = 0) will be started. C<0> is a valid timeout.
2207	dubious value.
2208		2733
2209	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2734	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2210	passed an C<revents> set like normal event callbacks (a combination of	2735	passed an C<revents> set like normal event callbacks (a combination of
2211	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2736	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2212	value passed to C<ev_once>:	2737	value passed to C<ev_once>. Note that it is possible to receive I<both>
		2738	a timeout and an io event at the same time - you probably should give io
		2739	events precedence.
2213		2740
		2741	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
		2742
2214	static void stdin_ready (int revents, void *arg)	2743	static void stdin_ready (int revents, void *arg)
2215	{	2744	{
2216	if (revents & EV_TIMEOUT)
2217	/* doh, nothing entered */;
2218	else if (revents & EV_READ)	2745	if (revents & EV_READ)
2219	/* stdin might have data for us, joy! */;	2746	/* stdin might have data for us, joy! */;
		2747	else if (revents & EV_TIMEOUT)
		2748	/* doh, nothing entered */;
2220	}	2749	}
2221		2750
2222	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2751	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2223		2752
2224	=item ev_feed_event (ev_loop *, watcher *, int revents)	2753	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2225		2754
2226	Feeds the given event set into the event loop, as if the specified event	2755	Feeds the given event set into the event loop, as if the specified event
2227	had happened for the specified watcher (which must be a pointer to an	2756	had happened for the specified watcher (which must be a pointer to an
2228	initialised but not necessarily started event watcher).	2757	initialised but not necessarily started event watcher).
2229		2758
2230	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2759	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2231		2760
2232	Feed an event on the given fd, as if a file descriptor backend detected	2761	Feed an event on the given fd, as if a file descriptor backend detected
2233	the given events it.	2762	the given events it.
2234		2763
2235	=item ev_feed_signal_event (ev_loop *loop, int signum)	2764	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2236		2765
2237	Feed an event as if the given signal occured (C<loop> must be the default	2766	Feed an event as if the given signal occurred (C<loop> must be the default
2238	loop!).	2767	loop!).
2239		2768
2240	=back	2769	=back
2241		2770
2242		2771
…		…
2258		2787
2259	=item * Priorities are not currently supported. Initialising priorities	2788	=item * Priorities are not currently supported. Initialising priorities
2260	will fail and all watchers will have the same priority, even though there	2789	will fail and all watchers will have the same priority, even though there
2261	is an ev_pri field.	2790	is an ev_pri field.
2262		2791
		2792	=item * In libevent, the last base created gets the signals, in libev, the
		2793	first base created (== the default loop) gets the signals.
		2794
2263	=item * Other members are not supported.	2795	=item * Other members are not supported.
2264		2796
2265	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2797	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2266	to use the libev header file and library.	2798	to use the libev header file and library.
2267		2799
2268	=back	2800	=back
2269		2801
2270	=head1 C++ SUPPORT	2802	=head1 C++ SUPPORT
2271		2803
2272	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2804	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2273	you to use some convinience methods to start/stop watchers and also change	2805	you to use some convenience methods to start/stop watchers and also change
2274	the callback model to a model using method callbacks on objects.	2806	the callback model to a model using method callbacks on objects.
2275		2807
2276	To use it,	2808	To use it,
2277		2809
2278	#include <ev++.h>	2810	#include <ev++.h>
2279		2811
2280	This automatically includes F<ev.h> and puts all of its definitions (many	2812	This automatically includes F<ev.h> and puts all of its definitions (many
2281	of them macros) into the global namespace. All C++ specific things are	2813	of them macros) into the global namespace. All C++ specific things are
2282	put into the C<ev> namespace. It should support all the same embedding	2814	put into the C<ev> namespace. It should support all the same embedding
2283	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2815	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2350	your compiler is good :), then the method will be fully inlined into the	2882	your compiler is good :), then the method will be fully inlined into the
2351	thunking function, making it as fast as a direct C callback.	2883	thunking function, making it as fast as a direct C callback.
2352		2884
2353	Example: simple class declaration and watcher initialisation	2885	Example: simple class declaration and watcher initialisation
2354		2886
2355	struct myclass	2887	struct myclass
2356	{	2888	{
2357	void io_cb (ev::io &w, int revents) { }	2889	void io_cb (ev::io &w, int revents) { }
2358	}	2890	}
2359		2891
2360	myclass obj;	2892	myclass obj;
2361	ev::io iow;	2893	ev::io iow;
2362	iow.set <myclass, &myclass::io_cb> (&obj);	2894	iow.set <myclass, &myclass::io_cb> (&obj);
2363		2895
2364	=item w->set<function> (void *data = 0)	2896	=item w->set<function> (void *data = 0)
2365		2897
2366	Also sets a callback, but uses a static method or plain function as	2898	Also sets a callback, but uses a static method or plain function as
2367	callback. The optional C<data> argument will be stored in the watcher's	2899	callback. The optional C<data> argument will be stored in the watcher's
…		…
2369		2901
2370	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	2902	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2371		2903
2372	See the method-C<set> above for more details.	2904	See the method-C<set> above for more details.
2373		2905
2374	Example:	2906	Example: Use a plain function as callback.
2375		2907
2376	static void io_cb (ev::io &w, int revents) { }	2908	static void io_cb (ev::io &w, int revents) { }
2377	iow.set <io_cb> ();	2909	iow.set <io_cb> ();
2378		2910
2379	=item w->set (struct ev_loop *)	2911	=item w->set (struct ev_loop *)
2380		2912
2381	Associates a different C<struct ev_loop> with this watcher. You can only	2913	Associates a different C<struct ev_loop> with this watcher. You can only
2382	do this when the watcher is inactive (and not pending either).	2914	do this when the watcher is inactive (and not pending either).
2383		2915
2384	=item w->set ([args])	2916	=item w->set ([arguments])
2385		2917
2386	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2918	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2387	called at least once. Unlike the C counterpart, an active watcher gets	2919	called at least once. Unlike the C counterpart, an active watcher gets
2388	automatically stopped and restarted when reconfiguring it with this	2920	automatically stopped and restarted when reconfiguring it with this
2389	method.	2921	method.
2390		2922
2391	=item w->start ()	2923	=item w->start ()
…		…
2415	=back	2947	=back
2416		2948
2417	Example: Define a class with an IO and idle watcher, start one of them in	2949	Example: Define a class with an IO and idle watcher, start one of them in
2418	the constructor.	2950	the constructor.
2419		2951
2420	class myclass	2952	class myclass
2421	{	2953	{
2422	ev::io io; void io_cb (ev::io &w, int revents);	2954	ev::io io ; void io_cb (ev::io &w, int revents);
2423	ev:idle idle void idle_cb (ev::idle &w, int revents);	2955	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2424		2956
2425	myclass (int fd)	2957	myclass (int fd)
2426	{	2958	{
2427	io .set <myclass, &myclass::io_cb > (this);	2959	io .set <myclass, &myclass::io_cb > (this);
2428	idle.set <myclass, &myclass::idle_cb> (this);	2960	idle.set <myclass, &myclass::idle_cb> (this);
2429		2961
2430	io.start (fd, ev::READ);	2962	io.start (fd, ev::READ);
2431	}	2963	}
2432	};	2964	};
		2965
		2966
		2967	=head1 OTHER LANGUAGE BINDINGS
		2968
		2969	Libev does not offer other language bindings itself, but bindings for a
		2970	number of languages exist in the form of third-party packages. If you know
		2971	any interesting language binding in addition to the ones listed here, drop
		2972	me a note.
		2973
		2974	=over 4
		2975
		2976	=item Perl
		2977
		2978	The EV module implements the full libev API and is actually used to test
		2979	libev. EV is developed together with libev. Apart from the EV core module,
		2980	there are additional modules that implement libev-compatible interfaces
		2981	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
		2982	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		2983	and C<EV::Glib>).
		2984
		2985	It can be found and installed via CPAN, its homepage is at
		2986	L<http://software.schmorp.de/pkg/EV>.
		2987
		2988	=item Python
		2989
		2990	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		2991	seems to be quite complete and well-documented. Note, however, that the
		2992	patch they require for libev is outright dangerous as it breaks the ABI
		2993	for everybody else, and therefore, should never be applied in an installed
		2994	libev (if python requires an incompatible ABI then it needs to embed
		2995	libev).
		2996
		2997	=item Ruby
		2998
		2999	Tony Arcieri has written a ruby extension that offers access to a subset
		3000	of the libev API and adds file handle abstractions, asynchronous DNS and
		3001	more on top of it. It can be found via gem servers. Its homepage is at
		3002	L<http://rev.rubyforge.org/>.
		3003
		3004	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3005	makes rev work even on mingw.
		3006
		3007	=item D
		3008
		3009	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		3010	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3011
		3012	=item Ocaml
		3013
		3014	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3015	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		3016
		3017	=back
2433		3018
2434		3019
2435	=head1 MACRO MAGIC	3020	=head1 MACRO MAGIC
2436		3021
2437	Libev can be compiled with a variety of options, the most fundamantal	3022	Libev can be compiled with a variety of options, the most fundamental
2438	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	3023	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2439	functions and callbacks have an initial C<struct ev_loop *> argument.	3024	functions and callbacks have an initial C<struct ev_loop *> argument.
2440		3025
2441	To make it easier to write programs that cope with either variant, the	3026	To make it easier to write programs that cope with either variant, the
2442	following macros are defined:	3027	following macros are defined:
…		…
2447		3032
2448	This provides the loop I<argument> for functions, if one is required ("ev	3033	This provides the loop I<argument> for functions, if one is required ("ev
2449	loop argument"). The C<EV_A> form is used when this is the sole argument,	3034	loop argument"). The C<EV_A> form is used when this is the sole argument,
2450	C<EV_A_> is used when other arguments are following. Example:	3035	C<EV_A_> is used when other arguments are following. Example:
2451		3036
2452	ev_unref (EV_A);	3037	ev_unref (EV_A);
2453	ev_timer_add (EV_A_ watcher);	3038	ev_timer_add (EV_A_ watcher);
2454	ev_loop (EV_A_ 0);	3039	ev_loop (EV_A_ 0);
2455		3040
2456	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3041	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2457	which is often provided by the following macro.	3042	which is often provided by the following macro.
2458		3043
2459	=item C<EV_P>, C<EV_P_>	3044	=item C<EV_P>, C<EV_P_>
2460		3045
2461	This provides the loop I<parameter> for functions, if one is required ("ev	3046	This provides the loop I<parameter> for functions, if one is required ("ev
2462	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	3047	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2463	C<EV_P_> is used when other parameters are following. Example:	3048	C<EV_P_> is used when other parameters are following. Example:
2464		3049
2465	// this is how ev_unref is being declared	3050	// this is how ev_unref is being declared
2466	static void ev_unref (EV_P);	3051	static void ev_unref (EV_P);
2467		3052
2468	// this is how you can declare your typical callback	3053	// this is how you can declare your typical callback
2469	static void cb (EV_P_ ev_timer *w, int revents)	3054	static void cb (EV_P_ ev_timer *w, int revents)
2470		3055
2471	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	3056	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2472	suitable for use with C<EV_A>.	3057	suitable for use with C<EV_A>.
2473		3058
2474	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	3059	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2475		3060
2476	Similar to the other two macros, this gives you the value of the default	3061	Similar to the other two macros, this gives you the value of the default
2477	loop, if multiple loops are supported ("ev loop default").	3062	loop, if multiple loops are supported ("ev loop default").
		3063
		3064	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		3065
		3066	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		3067	default loop has been initialised (C<UC> == unchecked). Their behaviour
		3068	is undefined when the default loop has not been initialised by a previous
		3069	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		3070
		3071	It is often prudent to use C<EV_DEFAULT> when initialising the first
		3072	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2478		3073
2479	=back	3074	=back
2480		3075
2481	Example: Declare and initialise a check watcher, utilising the above	3076	Example: Declare and initialise a check watcher, utilising the above
2482	macros so it will work regardless of whether multiple loops are supported	3077	macros so it will work regardless of whether multiple loops are supported
2483	or not.	3078	or not.
2484		3079
2485	static void	3080	static void
2486	check_cb (EV_P_ ev_timer *w, int revents)	3081	check_cb (EV_P_ ev_timer *w, int revents)
2487	{	3082	{
2488	ev_check_stop (EV_A_ w);	3083	ev_check_stop (EV_A_ w);
2489	}	3084	}
2490		3085
2491	ev_check check;	3086	ev_check check;
2492	ev_check_init (&check, check_cb);	3087	ev_check_init (&check, check_cb);
2493	ev_check_start (EV_DEFAULT_ &check);	3088	ev_check_start (EV_DEFAULT_ &check);
2494	ev_loop (EV_DEFAULT_ 0);	3089	ev_loop (EV_DEFAULT_ 0);
2495		3090
2496	=head1 EMBEDDING	3091	=head1 EMBEDDING
2497		3092
2498	Libev can (and often is) directly embedded into host	3093	Libev can (and often is) directly embedded into host
2499	applications. Examples of applications that embed it include the Deliantra	3094	applications. Examples of applications that embed it include the Deliantra
…		…
2506	libev somewhere in your source tree).	3101	libev somewhere in your source tree).
2507		3102
2508	=head2 FILESETS	3103	=head2 FILESETS
2509		3104
2510	Depending on what features you need you need to include one or more sets of files	3105	Depending on what features you need you need to include one or more sets of files
2511	in your app.	3106	in your application.
2512		3107
2513	=head3 CORE EVENT LOOP	3108	=head3 CORE EVENT LOOP
2514		3109
2515	To include only the libev core (all the C<ev_*> functions), with manual	3110	To include only the libev core (all the C<ev_*> functions), with manual
2516	configuration (no autoconf):	3111	configuration (no autoconf):
2517		3112
2518	#define EV_STANDALONE 1	3113	#define EV_STANDALONE 1
2519	#include "ev.c"	3114	#include "ev.c"
2520		3115
2521	This will automatically include F<ev.h>, too, and should be done in a	3116	This will automatically include F<ev.h>, too, and should be done in a
2522	single C source file only to provide the function implementations. To use	3117	single C source file only to provide the function implementations. To use
2523	it, do the same for F<ev.h> in all files wishing to use this API (best	3118	it, do the same for F<ev.h> in all files wishing to use this API (best
2524	done by writing a wrapper around F<ev.h> that you can include instead and	3119	done by writing a wrapper around F<ev.h> that you can include instead and
2525	where you can put other configuration options):	3120	where you can put other configuration options):
2526		3121
2527	#define EV_STANDALONE 1	3122	#define EV_STANDALONE 1
2528	#include "ev.h"	3123	#include "ev.h"
2529		3124
2530	Both header files and implementation files can be compiled with a C++	3125	Both header files and implementation files can be compiled with a C++
2531	compiler (at least, thats a stated goal, and breakage will be treated	3126	compiler (at least, that's a stated goal, and breakage will be treated
2532	as a bug).	3127	as a bug).
2533		3128
2534	You need the following files in your source tree, or in a directory	3129	You need the following files in your source tree, or in a directory
2535	in your include path (e.g. in libev/ when using -Ilibev):	3130	in your include path (e.g. in libev/ when using -Ilibev):
2536		3131
2537	ev.h	3132	ev.h
2538	ev.c	3133	ev.c
2539	ev_vars.h	3134	ev_vars.h
2540	ev_wrap.h	3135	ev_wrap.h
2541		3136
2542	ev_win32.c required on win32 platforms only	3137	ev_win32.c required on win32 platforms only
2543		3138
2544	ev_select.c only when select backend is enabled (which is enabled by default)	3139	ev_select.c only when select backend is enabled (which is enabled by default)
2545	ev_poll.c only when poll backend is enabled (disabled by default)	3140	ev_poll.c only when poll backend is enabled (disabled by default)
2546	ev_epoll.c only when the epoll backend is enabled (disabled by default)	3141	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2547	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	3142	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2548	ev_port.c only when the solaris port backend is enabled (disabled by default)	3143	ev_port.c only when the solaris port backend is enabled (disabled by default)
2549		3144
2550	F<ev.c> includes the backend files directly when enabled, so you only need	3145	F<ev.c> includes the backend files directly when enabled, so you only need
2551	to compile this single file.	3146	to compile this single file.
2552		3147
2553	=head3 LIBEVENT COMPATIBILITY API	3148	=head3 LIBEVENT COMPATIBILITY API
2554		3149
2555	To include the libevent compatibility API, also include:	3150	To include the libevent compatibility API, also include:
2556		3151
2557	#include "event.c"	3152	#include "event.c"
2558		3153
2559	in the file including F<ev.c>, and:	3154	in the file including F<ev.c>, and:
2560		3155
2561	#include "event.h"	3156	#include "event.h"
2562		3157
2563	in the files that want to use the libevent API. This also includes F<ev.h>.	3158	in the files that want to use the libevent API. This also includes F<ev.h>.
2564		3159
2565	You need the following additional files for this:	3160	You need the following additional files for this:
2566		3161
2567	event.h	3162	event.h
2568	event.c	3163	event.c
2569		3164
2570	=head3 AUTOCONF SUPPORT	3165	=head3 AUTOCONF SUPPORT
2571		3166
2572	Instead of using C<EV_STANDALONE=1> and providing your config in	3167	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2573	whatever way you want, you can also C<m4_include([libev.m4])> in your	3168	whatever way you want, you can also C<m4_include([libev.m4])> in your
2574	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	3169	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2575	include F<config.h> and configure itself accordingly.	3170	include F<config.h> and configure itself accordingly.
2576		3171
2577	For this of course you need the m4 file:	3172	For this of course you need the m4 file:
2578		3173
2579	libev.m4	3174	libev.m4
2580		3175
2581	=head2 PREPROCESSOR SYMBOLS/MACROS	3176	=head2 PREPROCESSOR SYMBOLS/MACROS
2582		3177
2583	Libev can be configured via a variety of preprocessor symbols you have to define	3178	Libev can be configured via a variety of preprocessor symbols you have to
2584	before including any of its files. The default is not to build for multiplicity	3179	define before including any of its files. The default in the absence of
2585	and only include the select backend.	3180	autoconf is documented for every option.
2586		3181
2587	=over 4	3182	=over 4
2588		3183
2589	=item EV_STANDALONE	3184	=item EV_STANDALONE
2590		3185
…		…
2592	keeps libev from including F<config.h>, and it also defines dummy	3187	keeps libev from including F<config.h>, and it also defines dummy
2593	implementations for some libevent functions (such as logging, which is not	3188	implementations for some libevent functions (such as logging, which is not
2594	supported). It will also not define any of the structs usually found in	3189	supported). It will also not define any of the structs usually found in
2595	F<event.h> that are not directly supported by the libev core alone.	3190	F<event.h> that are not directly supported by the libev core alone.
2596		3191
		3192	In stanbdalone mode, libev will still try to automatically deduce the
		3193	configuration, but has to be more conservative.
		3194
2597	=item EV_USE_MONOTONIC	3195	=item EV_USE_MONOTONIC
2598		3196
2599	If defined to be C<1>, libev will try to detect the availability of the	3197	If defined to be C<1>, libev will try to detect the availability of the
2600	monotonic clock option at both compiletime and runtime. Otherwise no use	3198	monotonic clock option at both compile time and runtime. Otherwise no
2601	of the monotonic clock option will be attempted. If you enable this, you	3199	use of the monotonic clock option will be attempted. If you enable this,
2602	usually have to link against librt or something similar. Enabling it when	3200	you usually have to link against librt or something similar. Enabling it
2603	the functionality isn't available is safe, though, although you have	3201	when the functionality isn't available is safe, though, although you have
2604	to make sure you link against any libraries where the C<clock_gettime>	3202	to make sure you link against any libraries where the C<clock_gettime>
2605	function is hiding in (often F<-lrt>).	3203	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2606		3204
2607	=item EV_USE_REALTIME	3205	=item EV_USE_REALTIME
2608		3206
2609	If defined to be C<1>, libev will try to detect the availability of the	3207	If defined to be C<1>, libev will try to detect the availability of the
2610	realtime clock option at compiletime (and assume its availability at	3208	real-time clock option at compile time (and assume its availability at
2611	runtime if successful). Otherwise no use of the realtime clock option will	3209	runtime if successful). Otherwise no use of the real-time clock option will
2612	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3210	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2613	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3211	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2614	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3212	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2615		3213
		3214	=item EV_USE_CLOCK_SYSCALL
		3215
		3216	If defined to be C<1>, libev will try to use a direct syscall instead
		3217	of calling the system-provided C<clock_gettime> function. This option
		3218	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3219	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3220	programs needlessly. Using a direct syscall is slightly slower, because
		3221	no optimised vdso implementation can be used, but avoids the pthread
		3222	dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or higher.
		3223
2616	=item EV_USE_NANOSLEEP	3224	=item EV_USE_NANOSLEEP
2617		3225
2618	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3226	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2619	and will use it for delays. Otherwise it will use C<select ()>.	3227	and will use it for delays. Otherwise it will use C<select ()>.
2620		3228
		3229	=item EV_USE_EVENTFD
		3230
		3231	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		3232	available and will probe for kernel support at runtime. This will improve
		3233	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		3234	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		3235	2.7 or newer, otherwise disabled.
		3236
2621	=item EV_USE_SELECT	3237	=item EV_USE_SELECT
2622		3238
2623	If undefined or defined to be C<1>, libev will compile in support for the	3239	If undefined or defined to be C<1>, libev will compile in support for the
2624	C<select>(2) backend. No attempt at autodetection will be done: if no	3240	C<select>(2) backend. No attempt at auto-detection will be done: if no
2625	other method takes over, select will be it. Otherwise the select backend	3241	other method takes over, select will be it. Otherwise the select backend
2626	will not be compiled in.	3242	will not be compiled in.
2627		3243
2628	=item EV_SELECT_USE_FD_SET	3244	=item EV_SELECT_USE_FD_SET
2629		3245
2630	If defined to C<1>, then the select backend will use the system C<fd_set>	3246	If defined to C<1>, then the select backend will use the system C<fd_set>
2631	structure. This is useful if libev doesn't compile due to a missing	3247	structure. This is useful if libev doesn't compile due to a missing
2632	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	3248	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
2633	exotic systems. This usually limits the range of file descriptors to some	3249	on exotic systems. This usually limits the range of file descriptors to
2634	low limit such as 1024 or might have other limitations (winsocket only	3250	some low limit such as 1024 or might have other limitations (winsocket
2635	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3251	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2636	influence the size of the C<fd_set> used.	3252	configures the maximum size of the C<fd_set>.
2637		3253
2638	=item EV_SELECT_IS_WINSOCKET	3254	=item EV_SELECT_IS_WINSOCKET
2639		3255
2640	When defined to C<1>, the select backend will assume that	3256	When defined to C<1>, the select backend will assume that
2641	select/socket/connect etc. don't understand file descriptors but	3257	select/socket/connect etc. don't understand file descriptors but
…		…
2661		3277
2662	=item EV_USE_EPOLL	3278	=item EV_USE_EPOLL
2663		3279
2664	If defined to be C<1>, libev will compile in support for the Linux	3280	If defined to be C<1>, libev will compile in support for the Linux
2665	C<epoll>(7) backend. Its availability will be detected at runtime,	3281	C<epoll>(7) backend. Its availability will be detected at runtime,
2666	otherwise another method will be used as fallback. This is the	3282	otherwise another method will be used as fallback. This is the preferred
2667	preferred backend for GNU/Linux systems.	3283	backend for GNU/Linux systems. If undefined, it will be enabled if the
		3284	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2668		3285
2669	=item EV_USE_KQUEUE	3286	=item EV_USE_KQUEUE
2670		3287
2671	If defined to be C<1>, libev will compile in support for the BSD style	3288	If defined to be C<1>, libev will compile in support for the BSD style
2672	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	3289	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2685	otherwise another method will be used as fallback. This is the preferred	3302	otherwise another method will be used as fallback. This is the preferred
2686	backend for Solaris 10 systems.	3303	backend for Solaris 10 systems.
2687		3304
2688	=item EV_USE_DEVPOLL	3305	=item EV_USE_DEVPOLL
2689		3306
2690	reserved for future expansion, works like the USE symbols above.	3307	Reserved for future expansion, works like the USE symbols above.
2691		3308
2692	=item EV_USE_INOTIFY	3309	=item EV_USE_INOTIFY
2693		3310
2694	If defined to be C<1>, libev will compile in support for the Linux inotify	3311	If defined to be C<1>, libev will compile in support for the Linux inotify
2695	interface to speed up C<ev_stat> watchers. Its actual availability will	3312	interface to speed up C<ev_stat> watchers. Its actual availability will
2696	be detected at runtime.	3313	be detected at runtime. If undefined, it will be enabled if the headers
		3314	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2697		3315
2698	=item EV_ATOMIC_T	3316	=item EV_ATOMIC_T
2699		3317
2700	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	3318	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2701	access is atomic with respect to other threads or signal contexts. No such	3319	access is atomic with respect to other threads or signal contexts. No such
2702	type is easily found in the C language, so you can provide your own type	3320	type is easily found in the C language, so you can provide your own type
2703	that you know is safe for your purposes. It is used both for signal handler "locking"	3321	that you know is safe for your purposes. It is used both for signal handler "locking"
2704	as well as for signal and thread safety in C<ev_async> watchers.	3322	as well as for signal and thread safety in C<ev_async> watchers.
2705		3323
2706	In the absense of this define, libev will use C<sig_atomic_t volatile>	3324	In the absence of this define, libev will use C<sig_atomic_t volatile>
2707	(from F<signal.h>), which is usually good enough on most platforms.	3325	(from F<signal.h>), which is usually good enough on most platforms.
2708		3326
2709	=item EV_H	3327	=item EV_H
2710		3328
2711	The name of the F<ev.h> header file used to include it. The default if	3329	The name of the F<ev.h> header file used to include it. The default if
…		…
2750	When doing priority-based operations, libev usually has to linearly search	3368	When doing priority-based operations, libev usually has to linearly search
2751	all the priorities, so having many of them (hundreds) uses a lot of space	3369	all the priorities, so having many of them (hundreds) uses a lot of space
2752	and time, so using the defaults of five priorities (-2 .. +2) is usually	3370	and time, so using the defaults of five priorities (-2 .. +2) is usually
2753	fine.	3371	fine.
2754		3372
2755	If your embedding app does not need any priorities, defining these both to	3373	If your embedding application does not need any priorities, defining these
2756	C<0> will save some memory and cpu.	3374	both to C<0> will save some memory and CPU.
2757		3375
2758	=item EV_PERIODIC_ENABLE	3376	=item EV_PERIODIC_ENABLE
2759		3377
2760	If undefined or defined to be C<1>, then periodic timers are supported. If	3378	If undefined or defined to be C<1>, then periodic timers are supported. If
2761	defined to be C<0>, then they are not. Disabling them saves a few kB of	3379	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2768	code.	3386	code.
2769		3387
2770	=item EV_EMBED_ENABLE	3388	=item EV_EMBED_ENABLE
2771		3389
2772	If undefined or defined to be C<1>, then embed watchers are supported. If	3390	If undefined or defined to be C<1>, then embed watchers are supported. If
2773	defined to be C<0>, then they are not.	3391	defined to be C<0>, then they are not. Embed watchers rely on most other
		3392	watcher types, which therefore must not be disabled.
2774		3393
2775	=item EV_STAT_ENABLE	3394	=item EV_STAT_ENABLE
2776		3395
2777	If undefined or defined to be C<1>, then stat watchers are supported. If	3396	If undefined or defined to be C<1>, then stat watchers are supported. If
2778	defined to be C<0>, then they are not.	3397	defined to be C<0>, then they are not.
…		…
2788	defined to be C<0>, then they are not.	3407	defined to be C<0>, then they are not.
2789		3408
2790	=item EV_MINIMAL	3409	=item EV_MINIMAL
2791		3410
2792	If you need to shave off some kilobytes of code at the expense of some	3411	If you need to shave off some kilobytes of code at the expense of some
2793	speed, define this symbol to C<1>. Currently only used for gcc to override	3412	speed, define this symbol to C<1>. Currently this is used to override some
2794	some inlining decisions, saves roughly 30% codesize of amd64.	3413	inlining decisions, saves roughly 30% code size on amd64. It also selects a
		3414	much smaller 2-heap for timer management over the default 4-heap.
2795		3415
2796	=item EV_PID_HASHSIZE	3416	=item EV_PID_HASHSIZE
2797		3417
2798	C<ev_child> watchers use a small hash table to distribute workload by	3418	C<ev_child> watchers use a small hash table to distribute workload by
2799	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3419	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2806	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3426	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2807	usually more than enough. If you need to manage thousands of C<ev_stat>	3427	usually more than enough. If you need to manage thousands of C<ev_stat>
2808	watchers you might want to increase this value (I<must> be a power of	3428	watchers you might want to increase this value (I<must> be a power of
2809	two).	3429	two).
2810		3430
		3431	=item EV_USE_4HEAP
		3432
		3433	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3434	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
		3435	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
		3436	faster performance with many (thousands) of watchers.
		3437
		3438	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3439	(disabled).
		3440
		3441	=item EV_HEAP_CACHE_AT
		3442
		3443	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3444	timer and periodics heaps, libev can cache the timestamp (I<at>) within
		3445	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3446	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3447	but avoids random read accesses on heap changes. This improves performance
		3448	noticeably with many (hundreds) of watchers.
		3449
		3450	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3451	(disabled).
		3452
		3453	=item EV_VERIFY
		3454
		3455	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3456	be done: If set to C<0>, no internal verification code will be compiled
		3457	in. If set to C<1>, then verification code will be compiled in, but not
		3458	called. If set to C<2>, then the internal verification code will be
		3459	called once per loop, which can slow down libev. If set to C<3>, then the
		3460	verification code will be called very frequently, which will slow down
		3461	libev considerably.
		3462
		3463	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3464	C<0>.
		3465
2811	=item EV_COMMON	3466	=item EV_COMMON
2812		3467
2813	By default, all watchers have a C<void *data> member. By redefining	3468	By default, all watchers have a C<void *data> member. By redefining
2814	this macro to a something else you can include more and other types of	3469	this macro to a something else you can include more and other types of
2815	members. You have to define it each time you include one of the files,	3470	members. You have to define it each time you include one of the files,
2816	though, and it must be identical each time.	3471	though, and it must be identical each time.
2817		3472
2818	For example, the perl EV module uses something like this:	3473	For example, the perl EV module uses something like this:
2819		3474
2820	#define EV_COMMON \	3475	#define EV_COMMON \
2821	SV *self; /* contains this struct */ \	3476	SV *self; /* contains this struct */ \
2822	SV *cb_sv, *fh /* note no trailing ";" */	3477	SV *cb_sv, *fh /* note no trailing ";" */
2823		3478
2824	=item EV_CB_DECLARE (type)	3479	=item EV_CB_DECLARE (type)
2825		3480
2826	=item EV_CB_INVOKE (watcher, revents)	3481	=item EV_CB_INVOKE (watcher, revents)
2827		3482
…		…
2832	definition and a statement, respectively. See the F<ev.h> header file for	3487	definition and a statement, respectively. See the F<ev.h> header file for
2833	their default definitions. One possible use for overriding these is to	3488	their default definitions. One possible use for overriding these is to
2834	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3489	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2835	method calls instead of plain function calls in C++.	3490	method calls instead of plain function calls in C++.
2836		3491
		3492	=back
		3493
2837	=head2 EXPORTED API SYMBOLS	3494	=head2 EXPORTED API SYMBOLS
2838		3495
2839	If you need to re-export the API (e.g. via a dll) and you need a list of	3496	If you need to re-export the API (e.g. via a DLL) and you need a list of
2840	exported symbols, you can use the provided F<Symbol.*> files which list	3497	exported symbols, you can use the provided F<Symbol.*> files which list
2841	all public symbols, one per line:	3498	all public symbols, one per line:
2842		3499
2843	Symbols.ev for libev proper	3500	Symbols.ev for libev proper
2844	Symbols.event for the libevent emulation	3501	Symbols.event for the libevent emulation
2845		3502
2846	This can also be used to rename all public symbols to avoid clashes with	3503	This can also be used to rename all public symbols to avoid clashes with
2847	multiple versions of libev linked together (which is obviously bad in	3504	multiple versions of libev linked together (which is obviously bad in
2848	itself, but sometimes it is inconvinient to avoid this).	3505	itself, but sometimes it is inconvenient to avoid this).
2849		3506
2850	A sed command like this will create wrapper C<#define>'s that you need to	3507	A sed command like this will create wrapper C<#define>'s that you need to
2851	include before including F<ev.h>:	3508	include before including F<ev.h>:
2852		3509
2853	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3510	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
2870	file.	3527	file.
2871		3528
2872	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3529	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2873	that everybody includes and which overrides some configure choices:	3530	that everybody includes and which overrides some configure choices:
2874		3531
2875	#define EV_MINIMAL 1	3532	#define EV_MINIMAL 1
2876	#define EV_USE_POLL 0	3533	#define EV_USE_POLL 0
2877	#define EV_MULTIPLICITY 0	3534	#define EV_MULTIPLICITY 0
2878	#define EV_PERIODIC_ENABLE 0	3535	#define EV_PERIODIC_ENABLE 0
2879	#define EV_STAT_ENABLE 0	3536	#define EV_STAT_ENABLE 0
2880	#define EV_FORK_ENABLE 0	3537	#define EV_FORK_ENABLE 0
2881	#define EV_CONFIG_H <config.h>	3538	#define EV_CONFIG_H <config.h>
2882	#define EV_MINPRI 0	3539	#define EV_MINPRI 0
2883	#define EV_MAXPRI 0	3540	#define EV_MAXPRI 0
2884		3541
2885	#include "ev++.h"	3542	#include "ev++.h"
2886		3543
2887	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3544	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2888		3545
2889	#include "ev_cpp.h"	3546	#include "ev_cpp.h"
2890	#include "ev.c"	3547	#include "ev.c"
2891		3548
		3549	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
2892		3550
2893	=head1 COMPLEXITIES	3551	=head2 THREADS AND COROUTINES
2894		3552
2895	In this section the complexities of (many of) the algorithms used inside	3553	=head3 THREADS
2896	libev will be explained. For complexity discussions about backends see the
2897	documentation for C<ev_default_init>.
2898		3554
2899	All of the following are about amortised time: If an array needs to be	3555	All libev functions are reentrant and thread-safe unless explicitly
2900	extended, libev needs to realloc and move the whole array, but this	3556	documented otherwise, but libev implements no locking itself. This means
2901	happens asymptotically never with higher number of elements, so O(1) might	3557	that you can use as many loops as you want in parallel, as long as there
2902	mean it might do a lengthy realloc operation in rare cases, but on average	3558	are no concurrent calls into any libev function with the same loop
2903	it is much faster and asymptotically approaches constant time.	3559	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		3560	of course): libev guarantees that different event loops share no data
		3561	structures that need any locking.
		3562
		3563	Or to put it differently: calls with different loop parameters can be done
		3564	concurrently from multiple threads, calls with the same loop parameter
		3565	must be done serially (but can be done from different threads, as long as
		3566	only one thread ever is inside a call at any point in time, e.g. by using
		3567	a mutex per loop).
		3568
		3569	Specifically to support threads (and signal handlers), libev implements
		3570	so-called C<ev_async> watchers, which allow some limited form of
		3571	concurrency on the same event loop, namely waking it up "from the
		3572	outside".
		3573
		3574	If you want to know which design (one loop, locking, or multiple loops
		3575	without or something else still) is best for your problem, then I cannot
		3576	help you, but here is some generic advice:
2904		3577
2905	=over 4	3578	=over 4
2906		3579
2907	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3580	=item * most applications have a main thread: use the default libev loop
		3581	in that thread, or create a separate thread running only the default loop.
2908		3582
2909	This means that, when you have a watcher that triggers in one hour and	3583	This helps integrating other libraries or software modules that use libev
2910	there are 100 watchers that would trigger before that then inserting will	3584	themselves and don't care/know about threading.
2911	have to skip roughly seven (C<ld 100>) of these watchers.
2912		3585
2913	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3586	=item * one loop per thread is usually a good model.
2914		3587
2915	That means that changing a timer costs less than removing/adding them	3588	Doing this is almost never wrong, sometimes a better-performance model
2916	as only the relative motion in the event queue has to be paid for.	3589	exists, but it is always a good start.
2917		3590
2918	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	3591	=item * other models exist, such as the leader/follower pattern, where one
		3592	loop is handed through multiple threads in a kind of round-robin fashion.
2919		3593
2920	These just add the watcher into an array or at the head of a list.	3594	Choosing a model is hard - look around, learn, know that usually you can do
		3595	better than you currently do :-)
2921		3596
2922	=item Stopping check/prepare/idle/fork/async watchers: O(1)	3597	=item * often you need to talk to some other thread which blocks in the
		3598	event loop.
2923		3599
2924	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3600	C<ev_async> watchers can be used to wake them up from other threads safely
		3601	(or from signal contexts...).
2925		3602
2926	These watchers are stored in lists then need to be walked to find the	3603	An example use would be to communicate signals or other events that only
2927	correct watcher to remove. The lists are usually short (you don't usually	3604	work in the default loop by registering the signal watcher with the
2928	have many watchers waiting for the same fd or signal).	3605	default loop and triggering an C<ev_async> watcher from the default loop
2929		3606	watcher callback into the event loop interested in the signal.
2930	=item Finding the next timer in each loop iteration: O(1)
2931
2932	By virtue of using a binary heap, the next timer is always found at the
2933	beginning of the storage array.
2934
2935	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2936
2937	A change means an I/O watcher gets started or stopped, which requires
2938	libev to recalculate its status (and possibly tell the kernel, depending
2939	on backend and wether C<ev_io_set> was used).
2940
2941	=item Activating one watcher (putting it into the pending state): O(1)
2942
2943	=item Priority handling: O(number_of_priorities)
2944
2945	Priorities are implemented by allocating some space for each
2946	priority. When doing priority-based operations, libev usually has to
2947	linearly search all the priorities, but starting/stopping and activating
2948	watchers becomes O(1) w.r.t. priority handling.
2949
2950	=item Sending an ev_async: O(1)
2951
2952	=item Processing ev_async_send: O(number_of_async_watchers)
2953
2954	=item Processing signals: O(max_signal_number)
2955
2956	Sending involves a syscall I<iff> there were no other C<ev_async_send>
2957	calls in the current loop iteration. Checking for async and signal events
2958	involves iterating over all running async watchers or all signal numbers.
2959		3607
2960	=back	3608	=back
2961		3609
		3610	=head3 COROUTINES
2962		3611
2963	=head1 Win32 platform limitations and workarounds	3612	Libev is very accommodating to coroutines ("cooperative threads"):
		3613	libev fully supports nesting calls to its functions from different
		3614	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3615	different coroutines, and switch freely between both coroutines running the
		3616	loop, as long as you don't confuse yourself). The only exception is that
		3617	you must not do this from C<ev_periodic> reschedule callbacks.
		3618
		3619	Care has been taken to ensure that libev does not keep local state inside
		3620	C<ev_loop>, and other calls do not usually allow for coroutine switches as
		3621	they do not call any callbacks.
		3622
		3623	=head2 COMPILER WARNINGS
		3624
		3625	Depending on your compiler and compiler settings, you might get no or a
		3626	lot of warnings when compiling libev code. Some people are apparently
		3627	scared by this.
		3628
		3629	However, these are unavoidable for many reasons. For one, each compiler
		3630	has different warnings, and each user has different tastes regarding
		3631	warning options. "Warn-free" code therefore cannot be a goal except when
		3632	targeting a specific compiler and compiler-version.
		3633
		3634	Another reason is that some compiler warnings require elaborate
		3635	workarounds, or other changes to the code that make it less clear and less
		3636	maintainable.
		3637
		3638	And of course, some compiler warnings are just plain stupid, or simply
		3639	wrong (because they don't actually warn about the condition their message
		3640	seems to warn about). For example, certain older gcc versions had some
		3641	warnings that resulted an extreme number of false positives. These have
		3642	been fixed, but some people still insist on making code warn-free with
		3643	such buggy versions.
		3644
		3645	While libev is written to generate as few warnings as possible,
		3646	"warn-free" code is not a goal, and it is recommended not to build libev
		3647	with any compiler warnings enabled unless you are prepared to cope with
		3648	them (e.g. by ignoring them). Remember that warnings are just that:
		3649	warnings, not errors, or proof of bugs.
		3650
		3651
		3652	=head2 VALGRIND
		3653
		3654	Valgrind has a special section here because it is a popular tool that is
		3655	highly useful. Unfortunately, valgrind reports are very hard to interpret.
		3656
		3657	If you think you found a bug (memory leak, uninitialised data access etc.)
		3658	in libev, then check twice: If valgrind reports something like:
		3659
		3660	==2274== definitely lost: 0 bytes in 0 blocks.
		3661	==2274== possibly lost: 0 bytes in 0 blocks.
		3662	==2274== still reachable: 256 bytes in 1 blocks.
		3663
		3664	Then there is no memory leak, just as memory accounted to global variables
		3665	is not a memleak - the memory is still being referenced, and didn't leak.
		3666
		3667	Similarly, under some circumstances, valgrind might report kernel bugs
		3668	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		3669	although an acceptable workaround has been found here), or it might be
		3670	confused.
		3671
		3672	Keep in mind that valgrind is a very good tool, but only a tool. Don't
		3673	make it into some kind of religion.
		3674
		3675	If you are unsure about something, feel free to contact the mailing list
		3676	with the full valgrind report and an explanation on why you think this
		3677	is a bug in libev (best check the archives, too :). However, don't be
		3678	annoyed when you get a brisk "this is no bug" answer and take the chance
		3679	of learning how to interpret valgrind properly.
		3680
		3681	If you need, for some reason, empty reports from valgrind for your project
		3682	I suggest using suppression lists.
		3683
		3684
		3685	=head1 PORTABILITY NOTES
		3686
		3687	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
2964		3688
2965	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3689	Win32 doesn't support any of the standards (e.g. POSIX) that libev
2966	requires, and its I/O model is fundamentally incompatible with the POSIX	3690	requires, and its I/O model is fundamentally incompatible with the POSIX
2967	model. Libev still offers limited functionality on this platform in	3691	model. Libev still offers limited functionality on this platform in
2968	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3692	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2969	descriptors. This only applies when using Win32 natively, not when using	3693	descriptors. This only applies when using Win32 natively, not when using
2970	e.g. cygwin.	3694	e.g. cygwin.
2971		3695
		3696	Lifting these limitations would basically require the full
		3697	re-implementation of the I/O system. If you are into these kinds of
		3698	things, then note that glib does exactly that for you in a very portable
		3699	way (note also that glib is the slowest event library known to man).
		3700
2972	There is no supported compilation method available on windows except	3701	There is no supported compilation method available on windows except
2973	embedding it into other applications.	3702	embedding it into other applications.
2974		3703
		3704	Not a libev limitation but worth mentioning: windows apparently doesn't
		3705	accept large writes: instead of resulting in a partial write, windows will
		3706	either accept everything or return C<ENOBUFS> if the buffer is too large,
		3707	so make sure you only write small amounts into your sockets (less than a
		3708	megabyte seems safe, but this apparently depends on the amount of memory
		3709	available).
		3710
2975	Due to the many, low, and arbitrary limits on the win32 platform and the	3711	Due to the many, low, and arbitrary limits on the win32 platform and
2976	abysmal performance of winsockets, using a large number of sockets is not	3712	the abysmal performance of winsockets, using a large number of sockets
2977	recommended (and not reasonable). If your program needs to use more than	3713	is not recommended (and not reasonable). If your program needs to use
2978	a hundred or so sockets, then likely it needs to use a totally different	3714	more than a hundred or so sockets, then likely it needs to use a totally
2979	implementation for windows, as libev offers the POSIX model, which cannot	3715	different implementation for windows, as libev offers the POSIX readiness
2980	be implemented efficiently on windows (microsoft monopoly games).	3716	notification model, which cannot be implemented efficiently on windows
		3717	(Microsoft monopoly games).
		3718
		3719	A typical way to use libev under windows is to embed it (see the embedding
		3720	section for details) and use the following F<evwrap.h> header file instead
		3721	of F<ev.h>:
		3722
		3723	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3724	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3725
		3726	#include "ev.h"
		3727
		3728	And compile the following F<evwrap.c> file into your project (make sure
		3729	you do I<not> compile the F<ev.c> or any other embedded source files!):
		3730
		3731	#include "evwrap.h"
		3732	#include "ev.c"
2981		3733
2982	=over 4	3734	=over 4
2983		3735
2984	=item The winsocket select function	3736	=item The winsocket select function
2985		3737
2986	The winsocket C<select> function doesn't follow POSIX in that it requires	3738	The winsocket C<select> function doesn't follow POSIX in that it
2987	socket I<handles> and not socket I<file descriptors>. This makes select	3739	requires socket I<handles> and not socket I<file descriptors> (it is
2988	very inefficient, and also requires a mapping from file descriptors	3740	also extremely buggy). This makes select very inefficient, and also
2989	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3741	requires a mapping from file descriptors to socket handles (the Microsoft
2990	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3742	C runtime provides the function C<_open_osfhandle> for this). See the
2991	symbols for more info.	3743	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		3744	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
2992		3745
2993	The configuration for a "naked" win32 using the microsoft runtime	3746	The configuration for a "naked" win32 using the Microsoft runtime
2994	libraries and raw winsocket select is:	3747	libraries and raw winsocket select is:
2995		3748
2996	#define EV_USE_SELECT 1	3749	#define EV_USE_SELECT 1
2997	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3750	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2998		3751
2999	Note that winsockets handling of fd sets is O(n), so you can easily get a	3752	Note that winsockets handling of fd sets is O(n), so you can easily get a
3000	complexity in the O(n²) range when using win32.	3753	complexity in the O(n²) range when using win32.
3001		3754
3002	=item Limited number of file descriptors	3755	=item Limited number of file descriptors
3003		3756
3004	Windows has numerous arbitrary (and low) limits on things. Early versions	3757	Windows has numerous arbitrary (and low) limits on things.
3005	of winsocket's select only supported waiting for a max. of C<64> handles	3758
		3759	Early versions of winsocket's select only supported waiting for a maximum
3006	(probably owning to the fact that all windows kernels can only wait for	3760	of C<64> handles (probably owning to the fact that all windows kernels
3007	C<64> things at the same time internally; microsoft recommends spawning a	3761	can only wait for C<64> things at the same time internally; Microsoft
3008	chain of threads and wait for 63 handles and the previous thread in each).	3762	recommends spawning a chain of threads and wait for 63 handles and the
		3763	previous thread in each. Great).
3009		3764
3010	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3765	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3011	to some high number (e.g. C<2048>) before compiling the winsocket select	3766	to some high number (e.g. C<2048>) before compiling the winsocket select
3012	call (which might be in libev or elsewhere, for example, perl does its own	3767	call (which might be in libev or elsewhere, for example, perl does its own
3013	select emulation on windows).	3768	select emulation on windows).
3014		3769
3015	Another limit is the number of file descriptors in the microsoft runtime	3770	Another limit is the number of file descriptors in the Microsoft runtime
3016	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3771	libraries, which by default is C<64> (there must be a hidden I<64> fetish
3017	or something like this inside microsoft). You can increase this by calling	3772	or something like this inside Microsoft). You can increase this by calling
3018	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3773	C<_setmaxstdio>, which can increase this limit to C<2048> (another
3019	arbitrary limit), but is broken in many versions of the microsoft runtime	3774	arbitrary limit), but is broken in many versions of the Microsoft runtime
3020	libraries.	3775	libraries.
3021		3776
3022	This might get you to about C<512> or C<2048> sockets (depending on	3777	This might get you to about C<512> or C<2048> sockets (depending on
3023	windows version and/or the phase of the moon). To get more, you need to	3778	windows version and/or the phase of the moon). To get more, you need to
3024	wrap all I/O functions and provide your own fd management, but the cost of	3779	wrap all I/O functions and provide your own fd management, but the cost of
3025	calling select (O(n²)) will likely make this unworkable.	3780	calling select (O(n²)) will likely make this unworkable.
3026		3781
3027	=back	3782	=back
3028		3783
		3784	=head2 PORTABILITY REQUIREMENTS
		3785
		3786	In addition to a working ISO-C implementation and of course the
		3787	backend-specific APIs, libev relies on a few additional extensions:
		3788
		3789	=over 4
		3790
		3791	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3792	calling conventions regardless of C<ev_watcher_type *>.
		3793
		3794	Libev assumes not only that all watcher pointers have the same internal
		3795	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3796	assumes that the same (machine) code can be used to call any watcher
		3797	callback: The watcher callbacks have different type signatures, but libev
		3798	calls them using an C<ev_watcher *> internally.
		3799
		3800	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3801
		3802	The type C<sig_atomic_t volatile> (or whatever is defined as
		3803	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
		3804	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3805	believed to be sufficiently portable.
		3806
		3807	=item C<sigprocmask> must work in a threaded environment
		3808
		3809	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3810	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3811	pthread implementations will either allow C<sigprocmask> in the "main
		3812	thread" or will block signals process-wide, both behaviours would
		3813	be compatible with libev. Interaction between C<sigprocmask> and
		3814	C<pthread_sigmask> could complicate things, however.
		3815
		3816	The most portable way to handle signals is to block signals in all threads
		3817	except the initial one, and run the default loop in the initial thread as
		3818	well.
		3819
		3820	=item C<long> must be large enough for common memory allocation sizes
		3821
		3822	To improve portability and simplify its API, libev uses C<long> internally
		3823	instead of C<size_t> when allocating its data structures. On non-POSIX
		3824	systems (Microsoft...) this might be unexpectedly low, but is still at
		3825	least 31 bits everywhere, which is enough for hundreds of millions of
		3826	watchers.
		3827
		3828	=item C<double> must hold a time value in seconds with enough accuracy
		3829
		3830	The type C<double> is used to represent timestamps. It is required to
		3831	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		3832	enough for at least into the year 4000. This requirement is fulfilled by
		3833	implementations implementing IEEE 754 (basically all existing ones).
		3834
		3835	=back
		3836
		3837	If you know of other additional requirements drop me a note.
		3838
		3839
		3840	=head1 ALGORITHMIC COMPLEXITIES
		3841
		3842	In this section the complexities of (many of) the algorithms used inside
		3843	libev will be documented. For complexity discussions about backends see
		3844	the documentation for C<ev_default_init>.
		3845
		3846	All of the following are about amortised time: If an array needs to be
		3847	extended, libev needs to realloc and move the whole array, but this
		3848	happens asymptotically rarer with higher number of elements, so O(1) might
		3849	mean that libev does a lengthy realloc operation in rare cases, but on
		3850	average it is much faster and asymptotically approaches constant time.
		3851
		3852	=over 4
		3853
		3854	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
		3855
		3856	This means that, when you have a watcher that triggers in one hour and
		3857	there are 100 watchers that would trigger before that, then inserting will
		3858	have to skip roughly seven (C<ld 100>) of these watchers.
		3859
		3860	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
		3861
		3862	That means that changing a timer costs less than removing/adding them,
		3863	as only the relative motion in the event queue has to be paid for.
		3864
		3865	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
		3866
		3867	These just add the watcher into an array or at the head of a list.
		3868
		3869	=item Stopping check/prepare/idle/fork/async watchers: O(1)
		3870
		3871	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		3872
		3873	These watchers are stored in lists, so they need to be walked to find the
		3874	correct watcher to remove. The lists are usually short (you don't usually
		3875	have many watchers waiting for the same fd or signal: one is typical, two
		3876	is rare).
		3877
		3878	=item Finding the next timer in each loop iteration: O(1)
		3879
		3880	By virtue of using a binary or 4-heap, the next timer is always found at a
		3881	fixed position in the storage array.
		3882
		3883	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		3884
		3885	A change means an I/O watcher gets started or stopped, which requires
		3886	libev to recalculate its status (and possibly tell the kernel, depending
		3887	on backend and whether C<ev_io_set> was used).
		3888
		3889	=item Activating one watcher (putting it into the pending state): O(1)
		3890
		3891	=item Priority handling: O(number_of_priorities)
		3892
		3893	Priorities are implemented by allocating some space for each
		3894	priority. When doing priority-based operations, libev usually has to
		3895	linearly search all the priorities, but starting/stopping and activating
		3896	watchers becomes O(1) with respect to priority handling.
		3897
		3898	=item Sending an ev_async: O(1)
		3899
		3900	=item Processing ev_async_send: O(number_of_async_watchers)
		3901
		3902	=item Processing signals: O(max_signal_number)
		3903
		3904	Sending involves a system call I<iff> there were no other C<ev_async_send>
		3905	calls in the current loop iteration. Checking for async and signal events
		3906	involves iterating over all running async watchers or all signal numbers.
		3907
		3908	=back
		3909
3029		3910
3030	=head1 AUTHOR	3911	=head1 AUTHOR
3031		3912
3032	Marc Lehmann <libev@schmorp.de>.	3913	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3033		3914

Diff Legend

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