ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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