ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.158 by root, Wed May 21 12:51:38 2008 UTC vs.
Revision 1.239 by root, Tue Apr 21 14:14:19 2009 UTC

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

Diff Legend

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