ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.46 by root, Mon Nov 26 10:20:43 2007 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	=head1 DESCRIPTION	9	=head2 EXAMPLE PROGRAM
		10
		11	// a single header file is required
		12	#include <ev.h>
		13
		14	#include <stdio.h> // for puts
		15
		16	// every watcher type has its own typedef'd struct
		17	// with the name ev_TYPE
		18	ev_io stdin_watcher;
		19	ev_timer timeout_watcher;
		20
		21	// all watcher callbacks have a similar signature
		22	// this callback is called when data is readable on stdin
		23	static void
		24	stdin_cb (EV_P_ ev_io *w, int revents)
		25	{
		26	puts ("stdin ready");
		27	// for one-shot events, one must manually stop the watcher
		28	// with its corresponding stop function.
		29	ev_io_stop (EV_A_ w);
		30
		31	// this causes all nested ev_loop's to stop iterating
		32	ev_unloop (EV_A_ EVUNLOOP_ALL);
		33	}
		34
		35	// another callback, this time for a time-out
		36	static void
		37	timeout_cb (EV_P_ ev_timer *w, int revents)
		38	{
		39	puts ("timeout");
		40	// this causes the innermost ev_loop to stop iterating
		41	ev_unloop (EV_A_ EVUNLOOP_ONE);
		42	}
		43
		44	int
		45	main (void)
		46	{
		47	// use the default event loop unless you have special needs
		48	struct ev_loop *loop = ev_default_loop (0);
		49
		50	// initialise an io watcher, then start it
		51	// this one will watch for stdin to become readable
		52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
		53	ev_io_start (loop, &stdin_watcher);
		54
		55	// initialise a timer watcher, then start it
		56	// simple non-repeating 5.5 second timeout
		57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		58	ev_timer_start (loop, &timeout_watcher);
		59
		60	// now wait for events to arrive
		61	ev_loop (loop, 0);
		62
		63	// unloop was called, so exit
		64	return 0;
		65	}
		66
		67	=head1 ABOUT THIS DOCUMENT
		68
		69	This document documents the libev software package.
		70
		71	The newest version of this document is also available as an html-formatted
		72	web page you might find easier to navigate when reading it for the first
		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
10		84
11	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
12	file descriptor being readable or a timeout occuring), and it will manage	86	file descriptor being readable or a timeout occurring), and it will manage
13	these event sources and provide your program with events.	87	these event sources and provide your program with events.
14		88
15	To do this, it must take more or less complete control over your process	89	To do this, it must take more or less complete control over your process
16	(or thread) by executing the I<event loop> handler, and will then	90	(or thread) by executing the I<event loop> handler, and will then
17	communicate events via a callback mechanism.	91	communicate events via a callback mechanism.
…		…
19	You register interest in certain events by registering so-called I<event	93	You register interest in certain events by registering so-called I<event
20	watchers>, which are relatively small C structures you initialise with the	94	watchers>, which are relatively small C structures you initialise with the
21	details of the event, and then hand it over to libev by I<starting> the	95	details of the event, and then hand it over to libev by I<starting> the
22	watcher.	96	watcher.
23		97
24	=head1 FEATURES	98	=head2 FEATURES
25		99
26	Libev supports select, poll, the linux-specific epoll and the bsd-specific	100	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
27	kqueue mechanisms for file descriptor events, relative timers, absolute	101	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
28	timers with customised rescheduling, signal events, process status change	102	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
29	events (related to SIGCHLD), and event watchers dealing with the event	103	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30	loop mechanism itself (idle, prepare and check watchers). It also is quite	104	with customised rescheduling (C<ev_periodic>), synchronous signals
		105	(C<ev_signal>), process status change events (C<ev_child>), and event
		106	watchers dealing with the event loop mechanism itself (C<ev_idle>,
		107	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		108	file watchers (C<ev_stat>) and even limited support for fork events
		109	(C<ev_fork>).
		110
		111	It also is quite fast (see this
31	fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing	112	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
32	it to libevent for example).	113	for example).
33		114
34	=head1 CONVENTIONS	115	=head2 CONVENTIONS
35		116
36	Libev is very configurable. In this manual the default configuration	117	Libev is very configurable. In this manual the default (and most common)
37	will be described, which supports multiple event loops. For more info	118	configuration will be described, which supports multiple event loops. For
38	about various configuration options please have a look at the file	119	more info about various configuration options please have a look at
39	F<README.embed> in the libev distribution. If libev was configured without	120	B<EMBED> section in this manual. If libev was configured without support
40	support for multiple event loops, then all functions taking an initial	121	for multiple event loops, then all functions taking an initial argument of
41	argument of name C<loop> (which is always of type C<struct ev_loop *>)	122	name C<loop> (which is always of type C<ev_loop *>) will not have
42	will not have this argument.	123	this argument.
43		124
44	=head1 TIME REPRESENTATION	125	=head2 TIME REPRESENTATION
45		126
46	Libev represents time as a single floating point number, representing the	127	Libev represents time as a single floating point number, representing
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	128	the (fractional) number of seconds since the (POSIX) epoch (somewhere
48	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
49	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
50	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
51	it, you should treat it as such.	132	on it, you should treat it as some floating point value. Unlike the name
		133	component C<stamp> might indicate, it is also used for time differences
		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.
52		155
53		156
54	=head1 GLOBAL FUNCTIONS	157	=head1 GLOBAL FUNCTIONS
55		158
56	These functions can be called anytime, even before initialising the	159	These functions can be called anytime, even before initialising the
…		…
62		165
63	Returns the current time as libev would use it. Please note that the	166	Returns the current time as libev would use it. Please note that the
64	C<ev_now> function is usually faster and also often returns the timestamp	167	C<ev_now> function is usually faster and also often returns the timestamp
65	you actually want to know.	168	you actually want to know.
66		169
		170	=item ev_sleep (ev_tstamp interval)
		171
		172	Sleep for the given interval: The current thread will be blocked until
		173	either it is interrupted or the given time interval has passed. Basically
		174	this is a sub-second-resolution C<sleep ()>.
		175
67	=item int ev_version_major ()	176	=item int ev_version_major ()
68		177
69	=item int ev_version_minor ()	178	=item int ev_version_minor ()
70		179
71	You can find out the major and minor version numbers of the library	180	You can find out the major and minor ABI version numbers of the library
72	you linked against by calling the functions C<ev_version_major> and	181	you linked against by calling the functions C<ev_version_major> and
73	C<ev_version_minor>. If you want, you can compare against the global	182	C<ev_version_minor>. If you want, you can compare against the global
74	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	183	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
75	version of the library your program was compiled against.	184	version of the library your program was compiled against.
76		185
		186	These version numbers refer to the ABI version of the library, not the
		187	release version.
		188
77	Usually, it's a good idea to terminate if the major versions mismatch,	189	Usually, it's a good idea to terminate if the major versions mismatch,
78	as this indicates an incompatible change. Minor versions are usually	190	as this indicates an incompatible change. Minor versions are usually
79	compatible to older versions, so a larger minor version alone is usually	191	compatible to older versions, so a larger minor version alone is usually
80	not a problem.	192	not a problem.
81		193
82	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
83	version:	195	version.
84		196
85	assert (("libev version mismatch",	197	assert (("libev version mismatch",
86	ev_version_major () == EV_VERSION_MAJOR	198	ev_version_major () == EV_VERSION_MAJOR
87	&& ev_version_minor () >= EV_VERSION_MINOR));	199	&& ev_version_minor () >= EV_VERSION_MINOR));
88		200
89	=item unsigned int ev_supported_backends ()	201	=item unsigned int ev_supported_backends ()
90		202
91	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_*>
92	value) compiled into this binary of libev (independent of their	204	value) compiled into this binary of libev (independent of their
…		…
94	a description of the set values.	206	a description of the set values.
95		207
96	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
97	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
98		210
99	assert (("sorry, no epoll, no sex",	211	assert (("sorry, no epoll, no sex",
100	ev_supported_backends () & EVBACKEND_EPOLL));	212	ev_supported_backends () & EVBACKEND_EPOLL));
101		213
102	=item unsigned int ev_recommended_backends ()	214	=item unsigned int ev_recommended_backends ()
103		215
104	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
105	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
106	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
107	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
108	(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
109	libev will probe for if you specify no backends explicitly.	221	libev will probe for if you specify no backends explicitly.
110		222
111	=item unsigned int ev_embeddable_backends ()	223	=item unsigned int ev_embeddable_backends ()
112		224
…		…
116	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	228	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
117	recommended ones.	229	recommended ones.
118		230
119	See the description of C<ev_embed> watchers for more info.	231	See the description of C<ev_embed> watchers for more info.
120		232
121	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	233	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
122		234
123	Sets the allocation function to use (the prototype is similar to the	235	Sets the allocation function to use (the prototype is similar - the
124	realloc C function, the semantics are identical). It is used to allocate	236	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
125	and free memory (no surprises here). If it returns zero when memory	237	used to allocate and free memory (no surprises here). If it returns zero
126	needs to be allocated, the library might abort or take some potentially	238	when memory needs to be allocated (C<size != 0>), the library might abort
127	destructive action. The default is your system realloc function.	239	or take some potentially destructive action.
		240
		241	Since some systems (at least OpenBSD and Darwin) fail to implement
		242	correct C<realloc> semantics, libev will use a wrapper around the system
		243	C<realloc> and C<free> functions by default.
128		244
129	You could override this function in high-availability programs to, say,	245	You could override this function in high-availability programs to, say,
130	free some memory if it cannot allocate memory, to use a special allocator,	246	free some memory if it cannot allocate memory, to use a special allocator,
131	or even to sleep a while and retry until some memory is available.	247	or even to sleep a while and retry until some memory is available.
132		248
133	Example: replace the libev allocator with one that waits a bit and then	249	Example: Replace the libev allocator with one that waits a bit and then
134	retries: better than mine).	250	retries (example requires a standards-compliant C<realloc>).
135		251
136	static void *	252	static void *
137	persistent_realloc (void *ptr, long size)	253	persistent_realloc (void *ptr, size_t size)
138	{	254	{
139	for (;;)	255	for (;;)
140	{	256	{
141	void *newptr = realloc (ptr, size);	257	void *newptr = realloc (ptr, size);
142		258
…		…
148	}	264	}
149		265
150	...	266	...
151	ev_set_allocator (persistent_realloc);	267	ev_set_allocator (persistent_realloc);
152		268
153	=item ev_set_syserr_cb (void (*cb)(const char *msg));	269	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
154		270
155	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
156	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
157	indicating the system call or subsystem causing the problem. If this	273	indicating the system call or subsystem causing the problem. If this
158	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
159	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
160	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
161	(such as abort).	277	(such as abort).
162		278
163	Example: do the same thing as libev does internally:	279	Example: This is basically the same thing that libev does internally, too.
164		280
165	static void	281	static void
166	fatal_error (const char *msg)	282	fatal_error (const char *msg)
167	{	283	{
168	perror (msg);	284	perror (msg);
…		…
174		290
175	=back	291	=back
176		292
177	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	293	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
178		294
179	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>
180	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>
181	events, and dynamically created loops which do not.	297	I<function>).
182		298
183	If you use threads, a common model is to run the default event loop	299	The library knows two types of such loops, the I<default> loop, which
184	in your main thread (or in a separate thread) and for each thread you	300	supports signals and child events, and dynamically created loops which do
185	create, you also create another event loop. Libev itself does no locking	301	not.
186	whatsoever, so if you mix calls to the same event loop in different
187	threads, make sure you lock (this is usually a bad idea, though, even if
188	done correctly, because it's hideous and inefficient).
189		302
190	=over 4	303	=over 4
191		304
192	=item struct ev_loop *ev_default_loop (unsigned int flags)	305	=item struct ev_loop *ev_default_loop (unsigned int flags)
193		306
…		…
197	flags. If that is troubling you, check C<ev_backend ()> afterwards).	310	flags. If that is troubling you, check C<ev_backend ()> afterwards).
198		311
199	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
200	function.	313	function.
201		314
		315	Note that this function is I<not> thread-safe, so if you want to use it
		316	from multiple threads, you have to lock (note also that this is unlikely,
		317	as loops cannot be shared easily between threads anyway).
		318
		319	The default loop is the only loop that can handle C<ev_signal> and
		320	C<ev_child> watchers, and to do this, it always registers a handler
		321	for C<SIGCHLD>. If this is a problem for your application you can either
		322	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
		323	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
		324	C<ev_default_init>.
		325
202	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
203	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	327	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
204		328
205	The following flags are supported:	329	The following flags are supported:
206		330
…		…
211	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
212	thing, believe me).	336	thing, believe me).
213		337
214	=item C<EVFLAG_NOENV>	338	=item C<EVFLAG_NOENV>
215		339
216	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
217	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
218	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	342	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
219	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
220	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
221	around bugs.	345	around bugs.
222		346
		347	=item C<EVFLAG_FORKCHECK>
		348
		349	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		350	a fork, you can also make libev check for a fork in each iteration by
		351	enabling this flag.
		352
		353	This works by calling C<getpid ()> on every iteration of the loop,
		354	and thus this might slow down your event loop if you do a lot of loop
		355	iterations and little real work, but is usually not noticeable (on my
		356	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
		357	without a system call and thus I<very> fast, but my GNU/Linux system also has
		358	C<pthread_atfork> which is even faster).
		359
		360	The big advantage of this flag is that you can forget about fork (and
		361	forget about forgetting to tell libev about forking) when you use this
		362	flag.
		363
		364	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
		365	environment variable.
		366
223	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	367	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
224		368
225	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
226	libev tries to roll its own fd_set with no limits on the number of fds,	370	libev tries to roll its own fd_set with no limits on the number of fds,
227	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
228	using this backend. It doesn't scale too well (O(highest_fd)), but its usually	372	using this backend. It doesn't scale too well (O(highest_fd)), but its
229	the fastest backend for a low number of fds.	373	usually the fastest backend for a low number of (low-numbered :) fds.
		374
		375	To get good performance out of this backend you need a high amount of
		376	parallelism (most of the file descriptors should be busy). If you are
		377	writing a server, you should C<accept ()> in a loop to accept as many
		378	connections as possible during one iteration. You might also want to have
		379	a look at C<ev_set_io_collect_interval ()> to increase the amount of
		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).
230		385
231	=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)
232		387
233	And this is your standard poll(2) backend. It's more complicated than	388	And this is your standard poll(2) backend. It's more complicated
234	select, but handles sparse fds better and has no artificial limit on the	389	than select, but handles sparse fds better and has no artificial
235	number of fds you can use (except it will slow down considerably with a	390	limit on the number of fds you can use (except it will slow down
236	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).	391	considerably with a lot of inactive fds). It scales similarly to select,
		392	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
		393	performance tips.
		394
		395	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		396	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
237		397
238	=item C<EVBACKEND_EPOLL> (value 4, Linux)	398	=item C<EVBACKEND_EPOLL> (value 4, Linux)
239		399
240	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,
241	but it scales phenomenally better. While poll and select usually scale like	401	but it scales phenomenally better. While poll and select usually scale
242	O(total_fds) where n is the total number of fds (or the highest fd), epoll scales	402	like O(total_fds) where n is the total number of fds (or the highest fd),
243	either O(1) or O(active_fds).	403	epoll scales either O(1) or O(active_fds).
244		404
		405	The epoll mechanism deserves honorable mention as the most misdesigned
		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.
		421
245	While stopping and starting an I/O watcher in the same iteration will	422	While stopping, setting and starting an I/O watcher in the same iteration
246	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
247	(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
248	best to avoid that. Also, dup()ed file descriptors might not work very	425	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
249	well if you register events for both fds.	426	file descriptors might not work very well if you register events for both
		427	file descriptors.
250		428
251	Please note that epoll sometimes generates spurious notifications, so you	429	Best performance from this backend is achieved by not unregistering all
252	need to use non-blocking I/O or other means to avoid blocking when no data	430	watchers for a file descriptor until it has been closed, if possible,
253	(or space) is available.	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.
		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
		441	While nominally embeddable in other event loops, this feature is broken in
		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>.
254		446
255	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	447	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
256		448
257	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
258	was broken on all BSDs except NetBSD (usually it doesn't work with	450	was broken on all BSDs except NetBSD (usually it doesn't work reliably
259	anything but sockets and pipes, except on Darwin, where of course its	451	with anything but sockets and pipes, except on Darwin, where of course
260	completely useless). For this reason its 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
261	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
262	C<EVBACKEND_KQUEUE>).	456	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		457	system like NetBSD.
		458
		459	You still can embed kqueue into a normal poll or select backend and use it
		460	only for sockets (after having made sure that sockets work with kqueue on
		461	the target platform). See C<ev_embed> watchers for more info.
263		462
264	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
265	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
266	course). While starting and stopping an I/O watcher does not cause an	465	course). While stopping, setting and starting an I/O watcher does never
267	extra syscall as with epoll, it still adds up to four event changes per	466	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
268	incident, so its best to avoid that.	467	two event changes per incident. Support for C<fork ()> is very bad (but
		468	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		469	cases
		470
		471	This backend usually performs well under most conditions.
		472
		473	While nominally embeddable in other event loops, this doesn't work
		474	everywhere, so you might need to test for this. And since it is broken
		475	almost everywhere, you should only use it when you have a lot of sockets
		476	(for which it usually works), by embedding it into another event loop
		477	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
		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>.
269		483
270	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	484	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
271		485
272	This is not implemented yet (and might never be).	486	This is not implemented yet (and might never be, unless you send me an
		487	implementation). According to reports, C</dev/poll> only supports sockets
		488	and is not embeddable, which would limit the usefulness of this backend
		489	immensely.
273		490
274	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	491	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
275		492
276	This uses the Solaris 10 port mechanism. As with everything on Solaris,	493	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
277	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)).
278		495
279	Please note that solaris ports can result in a lot of spurious	496	Please note that Solaris event ports can deliver a lot of spurious
280	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
281	blocking when no data (or space) is available.	498	blocking when no data (or space) is available.
		499
		500	While this backend scales well, it requires one system call per active
		501	file descriptor per loop iteration. For small and medium numbers of file
		502	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
		503	might perform better.
		504
		505	On the positive side, with the exception of the spurious readiness
		506	notifications, this backend actually performed fully to specification
		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>.
282		512
283	=item C<EVBACKEND_ALL>	513	=item C<EVBACKEND_ALL>
284		514
285	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
286	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
287	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	517	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
288		518
		519	It is definitely not recommended to use this flag.
		520
289	=back	521	=back
290		522
291	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
292	backends will be tried (in the reverse order as given here). If none are	524	backends will be tried (in the reverse order as listed here). If none are
293	specified, most compiled-in backend will be tried, usually in reverse	525	specified, all backends in C<ev_recommended_backends ()> will be tried.
294	order of their flag values :)
295		526
296	The most typical usage is like this:	527	Example: This is the most typical usage.
297		528
298	if (!ev_default_loop (0))	529	if (!ev_default_loop (0))
299	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	530	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
300		531
301	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
302	environment settings to be taken into account:	533	environment settings to be taken into account:
303		534
304	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	535	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
305		536
306	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
307	available (warning, breaks stuff, best use only with your own private	538	used if available (warning, breaks stuff, best use only with your own
308	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):
309		541
310	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	542	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
311		543
312	=item struct ev_loop *ev_loop_new (unsigned int flags)	544	=item struct ev_loop *ev_loop_new (unsigned int flags)
313		545
314	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
315	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
316	handle signal and child watchers, and attempts to do so will be greeted by	548	handle signal and child watchers, and attempts to do so will be greeted by
317	undefined behaviour (or a failed assertion if assertions are enabled).	549	undefined behaviour (or a failed assertion if assertions are enabled).
318		550
		551	Note that this function I<is> thread-safe, and the recommended way to use
		552	libev with threads is indeed to create one loop per thread, and using the
		553	default loop in the "main" or "initial" thread.
		554
319	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.
320		556
321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	557	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
322	if (!epoller)	558	if (!epoller)
323	fatal ("no epoll found here, maybe it hides under your chair");	559	fatal ("no epoll found here, maybe it hides under your chair");
324		560
325	=item ev_default_destroy ()	561	=item ev_default_destroy ()
326		562
327	Destroys the default loop again (frees all memory and kernel state	563	Destroys the default loop again (frees all memory and kernel state
328	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
329	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
330	responsibility to either stop all watchers cleanly yoursef I<before>	566	responsibility to either stop all watchers cleanly yourself I<before>
331	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
332	the easiest thing, youc na just ignore the watchers and/or C<free ()> them	568	the easiest thing, you can just ignore the watchers and/or C<free ()> them
333	for example).	569	for example).
		570
		571	Note that certain global state, such as signal state (and installed signal
		572	handlers), will not be freed by this function, and related watchers (such
		573	as signal and child watchers) would need to be stopped manually.
		574
		575	In general it is not advisable to call this function except in the
		576	rare occasion where you really need to free e.g. the signal handling
		577	pipe fds. If you need dynamically allocated loops it is better to use
		578	C<ev_loop_new> and C<ev_loop_destroy>).
334		579
335	=item ev_loop_destroy (loop)	580	=item ev_loop_destroy (loop)
336		581
337	Like C<ev_default_destroy>, but destroys an event loop created by an	582	Like C<ev_default_destroy>, but destroys an event loop created by an
338	earlier call to C<ev_loop_new>.	583	earlier call to C<ev_loop_new>.
339		584
340	=item ev_default_fork ()	585	=item ev_default_fork ()
341		586
		587	This function sets a flag that causes subsequent C<ev_loop> iterations
342	This function reinitialises the kernel state for backends that have	588	to reinitialise the kernel state for backends that have one. Despite the
343	one. Despite the name, you can call it anytime, but it makes most sense	589	name, you can call it anytime, but it makes most sense after forking, in
344	after forking, in either the parent or child process (or both, but that	590	the child process (or both child and parent, but that again makes little
345	again makes little sense).	591	sense). You I<must> call it in the child before using any of the libev
		592	functions, and it will only take effect at the next C<ev_loop> iteration.
346		593
347	You I<must> call this function in the child process after forking if and	594	On the other hand, you only need to call this function in the child
348	only if you want to use the event library in both processes. If you just	595	process if and only if you want to use the event library in the child. If
349	fork+exec, you don't have to call it.	596	you just fork+exec, you don't have to call it at all.
350		597
351	The function itself is quite fast and it's usually not a problem to call	598	The function itself is quite fast and it's usually not a problem to call
352	it just in case after a fork. To make this easy, the function will fit in	599	it just in case after a fork. To make this easy, the function will fit in
353	quite nicely into a call to C<pthread_atfork>:	600	quite nicely into a call to C<pthread_atfork>:
354		601
355	pthread_atfork (0, 0, ev_default_fork);	602	pthread_atfork (0, 0, ev_default_fork);
356		603
357	At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
358	without calling this function, so if you force one of those backends you
359	do not need to care.
360
361	=item ev_loop_fork (loop)	604	=item ev_loop_fork (loop)
362		605
363	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
364	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
365	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.
		610
		611	=item int ev_is_default_loop (loop)
		612
		613	Returns true when the given loop is, in fact, the default loop, and false
		614	otherwise.
		615
		616	=item unsigned int ev_loop_count (loop)
		617
		618	Returns the count of loop iterations for the loop, which is identical to
		619	the number of times libev did poll for new events. It starts at C<0> and
		620	happily wraps around with enough iterations.
		621
		622	This value can sometimes be useful as a generation counter of sorts (it
		623	"ticks" the number of loop iterations), as it roughly corresponds with
		624	C<ev_prepare> and C<ev_check> calls.
366		625
367	=item unsigned int ev_backend (loop)	626	=item unsigned int ev_backend (loop)
368		627
369	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	628	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
370	use.	629	use.
…		…
373		632
374	Returns the current "event loop time", which is the time the event loop	633	Returns the current "event loop time", which is the time the event loop
375	received events and started processing them. This timestamp does not	634	received events and started processing them. This timestamp does not
376	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
377	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
378	event occuring (or more correctly, libev finding out about it).	637	event occurring (or more correctly, libev finding out about it).
		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>).
379		676
380	=item ev_loop (loop, int flags)	677	=item ev_loop (loop, int flags)
381		678
382	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
383	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
…		…
386	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
387	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.
388		685
389	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
390	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
391	finished (especially in interactive programs), but having a program that	688	finished (especially in interactive programs), but having a program
392	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
393	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.
394		692
395	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
396	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
397	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.
398		697
399	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
400	neccessary) and will handle those and any outstanding ones. It will block	699	necessary) and will handle those and any already outstanding ones. It
401	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
402	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
403	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
404	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
405	usually a better approach for this kind of thing.	708	usually a better approach for this kind of thing.
406		709
407	Here are the gory details of what C<ev_loop> does:	710	Here are the gory details of what C<ev_loop> does:
408		711
409	* If there are no active watchers (reference count is zero), return.	712	- Before the first iteration, call any pending watchers.
410	- Queue prepare watchers and then call all outstanding watchers.	713	* If EVFLAG_FORKCHECK was used, check for a fork.
		714	- If a fork was detected (by any means), queue and call all fork watchers.
		715	- Queue and call all prepare watchers.
411	- 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.
412	- Update the kernel state with all outstanding changes.	718	- Update the kernel state with all outstanding changes.
413	- Update the "event loop time".	719	- Update the "event loop time" (ev_now ()).
414	- Calculate for how long to block.	720	- Calculate for how long to sleep or block, if at all
		721	(active idle watchers, EVLOOP_NONBLOCK or not having
		722	any active watchers at all will result in not sleeping).
		723	- Sleep if the I/O and timer collect interval say so.
415	- Block the process, waiting for any events.	724	- Block the process, waiting for any events.
416	- Queue all outstanding I/O (fd) events.	725	- Queue all outstanding I/O (fd) events.
417	- Update the "event loop time" and do time jump handling.	726	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
418	- Queue all outstanding timers.	727	- Queue all expired timers.
419	- Queue all outstanding periodics.	728	- Queue all expired periodics.
420	- If no events are pending now, queue all idle watchers.	729	- Unless any events are pending now, queue all idle watchers.
421	- Queue all check watchers.	730	- Queue all check watchers.
422	- 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).
423	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
424	be handled here by queueing them when their watcher gets executed.	733	be handled here by queueing them when their watcher gets executed.
425	- 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
426	were used, return, otherwise continue with step *.	735	were used, or there are no active watchers, return, otherwise
		736	continue with step *.
427		737
428	Example: queue some jobs and then loop until no events are outsanding	738	Example: Queue some jobs and then loop until no events are outstanding
429	anymore.	739	anymore.
430		740
431	... queue jobs here, make sure they register event watchers as long	741	... queue jobs here, make sure they register event watchers as long
432	... 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..)
433	ev_loop (my_loop, 0);	743	ev_loop (my_loop, 0);
434	... jobs done. yeah!	744	... jobs done or somebody called unloop. yeah!
435		745
436	=item ev_unloop (loop, how)	746	=item ev_unloop (loop, how)
437		747
438	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
439	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
440	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
441	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.
442		752
		753	This "unloop state" will be cleared when entering C<ev_loop> again.
		754
		755	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		756
443	=item ev_ref (loop)	757	=item ev_ref (loop)
444		758
445	=item ev_unref (loop)	759	=item ev_unref (loop)
446		760
447	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
448	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
449	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
450	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>
451	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
452	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
453	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
454	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
455	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
456	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
		774	before stop> (but only if the watcher wasn't active before, or was active
		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).
457		778
458	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>
459	running when nothing else is active.	780	running when nothing else is active.
460		781
461	struct dv_signal exitsig;	782	ev_signal exitsig;
462	ev_signal_init (&exitsig, sig_cb, SIGINT);	783	ev_signal_init (&exitsig, sig_cb, SIGINT);
463	ev_signal_start (myloop, &exitsig);	784	ev_signal_start (loop, &exitsig);
464	evf_unref (myloop);	785	evf_unref (loop);
465		786
466	Example: for some weird reason, unregister the above signal handler again.	787	Example: For some weird reason, unregister the above signal handler again.
467		788
468	ev_ref (myloop);	789	ev_ref (loop);
469	ev_signal_stop (myloop, &exitsig);	790	ev_signal_stop (loop, &exitsig);
		791
		792	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
		793
		794	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
		795
		796	These advanced functions influence the time that libev will spend waiting
		797	for events. Both time intervals are by default C<0>, meaning that libev
		798	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		799	latency.
		800
		801	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
		802	allows libev to delay invocation of I/O and timer/periodic callbacks
		803	to increase efficiency of loop iterations (or to increase power-saving
		804	opportunities).
		805
		806	The idea is that sometimes your program runs just fast enough to handle
		807	one (or very few) event(s) per loop iteration. While this makes the
		808	program responsive, it also wastes a lot of CPU time to poll for new
		809	events, especially with backends like C<select ()> which have a high
		810	overhead for the actual polling but can deliver many events at once.
		811
		812	By setting a higher I<io collect interval> you allow libev to spend more
		813	time collecting I/O events, so you can handle more events per iteration,
		814	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
		815	C<ev_timer>) will be not affected. Setting this to a non-null value will
		816	introduce an additional C<ev_sleep ()> call into most loop iterations.
		817
		818	Likewise, by setting a higher I<timeout collect interval> you allow libev
		819	to spend more time collecting timeouts, at the expense of increased
		820	latency/jitter/inexactness (the watcher callback will be called
		821	later). C<ev_io> watchers will not be affected. Setting this to a non-null
		822	value will not introduce any overhead in libev.
		823
		824	Many (busy) programs can usually benefit by setting the I/O collect
		825	interval to a value near C<0.1> or so, which is often enough for
		826	interactive servers (of course not for games), likewise for timeouts. It
		827	usually doesn't make much sense to set it to a lower value than C<0.01>,
		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.
470		848
471	=back	849	=back
472		850
473		851
474	=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.
475		857
476	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
477	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
478	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:
479		861
480	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)
481	{	863	{
482	ev_io_stop (w);	864	ev_io_stop (w);
483	ev_unloop (loop, EVUNLOOP_ALL);	865	ev_unloop (loop, EVUNLOOP_ALL);
484	}	866	}
485		867
486	struct ev_loop *loop = ev_default_loop (0);	868	struct ev_loop *loop = ev_default_loop (0);
		869
487	struct ev_io stdin_watcher;	870	ev_io stdin_watcher;
		871
488	ev_init (&stdin_watcher, my_cb);	872	ev_init (&stdin_watcher, my_cb);
489	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	873	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
490	ev_io_start (loop, &stdin_watcher);	874	ev_io_start (loop, &stdin_watcher);
		875
491	ev_loop (loop, 0);	876	ev_loop (loop, 0);
492		877
493	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
494	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
495	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).
496		884
497	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
498	(watcher *, callback)>, which expects a callback to be provided. This	886	(watcher *, callback)>, which expects a callback to be provided. This
499	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
500	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
501	is readable and/or writable).	889	is readable and/or writable).
502		890
503	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 *, ...) >>
504	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
505	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<<
506	(watcher *, callback, ...) >>.	894	ev_TYPE_init (watcher *, callback, ...) >>.
507		895
508	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
509	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
510	*) >>), 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
511	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	899	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
512		900
513	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
514	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
515	reinitialise it or call its C<set> macro.	903	reinitialise it or call its C<ev_TYPE_set> macro.
516		904
517	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
518	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
519	third argument.	907	third argument.
520		908
…		…
544	The signal specified in the C<ev_signal> watcher has been received by a thread.	932	The signal specified in the C<ev_signal> watcher has been received by a thread.
545		933
546	=item C<EV_CHILD>	934	=item C<EV_CHILD>
547		935
548	The pid specified in the C<ev_child> watcher has received a status change.	936	The pid specified in the C<ev_child> watcher has received a status change.
		937
		938	=item C<EV_STAT>
		939
		940	The path specified in the C<ev_stat> watcher changed its attributes somehow.
549		941
550	=item C<EV_IDLE>	942	=item C<EV_IDLE>
551		943
552	The C<ev_idle> watcher has determined that you have nothing better to do.	944	The C<ev_idle> watcher has determined that you have nothing better to do.
553		945
…		…
561	received events. Callbacks of both watcher types can start and stop as	953	received events. Callbacks of both watcher types can start and stop as
562	many watchers as they want, and all of them will be taken into account	954	many watchers as they want, and all of them will be taken into account
563	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	955	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
564	C<ev_loop> from blocking).	956	C<ev_loop> from blocking).
565		957
		958	=item C<EV_EMBED>
		959
		960	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		961
		962	=item C<EV_FORK>
		963
		964	The event loop has been resumed in the child process after fork (see
		965	C<ev_fork>).
		966
		967	=item C<EV_ASYNC>
		968
		969	The given async watcher has been asynchronously notified (see C<ev_async>).
		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
566	=item C<EV_ERROR>	976	=item C<EV_ERROR>
567		977
568	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
569	happen because the watcher could not be properly started because libev	979	happen because the watcher could not be properly started because libev
570	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
571	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
572	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.
573		987
574	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
575	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
576	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
577	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
578	programs, though, so beware.	992	programs, though, as the fd could already be closed and reused for another
		993	thing, so beware.
579		994
580	=back	995	=back
581		996
582	=head2 GENERIC WATCHER FUNCTIONS	997	=head2 GENERIC WATCHER FUNCTIONS
583
584	In the following description, C<TYPE> stands for the watcher type,
585	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
586		998
587	=over 4	999	=over 4
588		1000
589	=item C<ev_init> (ev_TYPE *watcher, callback)	1001	=item C<ev_init> (ev_TYPE *watcher, callback)
590		1002
…		…
596	which rolls both calls into one.	1008	which rolls both calls into one.
597		1009
598	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
599	(or never started) and there are no pending events outstanding.	1011	(or never started) and there are no pending events outstanding.
600		1012
601	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,
602	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);
603		1021
604	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1022	=item C<ev_TYPE_set> (ev_TYPE *, [args])
605		1023
606	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
607	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
…		…
610	difference to the C<ev_init> macro).	1028	difference to the C<ev_init> macro).
611		1029
612	Although some watcher types do not have type-specific arguments	1030	Although some watcher types do not have type-specific arguments
613	(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.
614		1032
		1033	See C<ev_init>, above, for an example.
		1034
615	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	1035	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
616		1036
617	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
618	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
619	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);
620		1044
621	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1045	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
622		1046
623	Starts (activates) the given watcher. Only active watchers will receive	1047	Starts (activates) the given watcher. Only active watchers will receive
624	events. If the watcher is already active nothing will happen.	1048	events. If the watcher is already active nothing will happen.
625		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
626	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1055	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
627		1056
628	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
629	status. It is possible that stopped watchers are pending (for example,	1060	It is possible that stopped watchers are pending - for example,
630	non-repeating timers are being stopped when they become pending), but	1061	non-repeating timers are being stopped when they become pending - but
631	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
632	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
633	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.
634		1065
635	=item bool ev_is_active (ev_TYPE *watcher)	1066	=item bool ev_is_active (ev_TYPE *watcher)
636		1067
637	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
638	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
…		…
641	=item bool ev_is_pending (ev_TYPE *watcher)	1072	=item bool ev_is_pending (ev_TYPE *watcher)
642		1073
643	Returns a true value iff the watcher is pending, (i.e. it has outstanding	1074	Returns a true value iff the watcher is pending, (i.e. it has outstanding
644	events but its callback has not yet been invoked). As long as a watcher	1075	events but its callback has not yet been invoked). As long as a watcher
645	is pending (but not active) you must not call an init function on it (but	1076	is pending (but not active) you must not call an init function on it (but
646	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	1077	C<ev_TYPE_set> is safe), you must not change its priority, and you must
647	libev (e.g. you cnanot C<free ()> it).	1078	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		1079	it).
648		1080
649	=item callback = ev_cb (ev_TYPE *watcher)	1081	=item callback ev_cb (ev_TYPE *watcher)
650		1082
651	Returns the callback currently set on the watcher.	1083	Returns the callback currently set on the watcher.
652		1084
653	=item ev_cb_set (ev_TYPE *watcher, callback)	1085	=item ev_cb_set (ev_TYPE *watcher, callback)
654		1086
655	Change the callback. You can change the callback at virtually any time	1087	Change the callback. You can change the callback at virtually any time
656	(modulo threads).	1088	(modulo threads).
657		1089
		1090	=item ev_set_priority (ev_TYPE *watcher, priority)
		1091
		1092	=item int ev_priority (ev_TYPE *watcher)
		1093
		1094	Set and query the priority of the watcher. The priority is a small
		1095	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		1096	(default: C<-2>). Pending watchers with higher priority will be invoked
		1097	before watchers with lower priority, but priority will not keep watchers
		1098	from being executed (except for C<ev_idle> watchers).
		1099
		1100	If you need to suppress invocation when higher priority events are pending
		1101	you need to look at C<ev_idle> watchers, which provide this functionality.
		1102
		1103	You I<must not> change the priority of a watcher as long as it is active or
		1104	pending.
		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
		1110	The default priority used by watchers when no priority has been set is
		1111	always C<0>, which is supposed to not be too high and not be too low :).
		1112
		1113	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
		1114	priorities.
		1115
		1116	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		1117
		1118	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		1119	C<loop> nor C<revents> need to be valid as long as the watcher callback
		1120	can deal with that fact, as both are simply passed through to the
		1121	callback.
		1122
		1123	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		1124
		1125	If the watcher is pending, this function clears its pending status and
		1126	returns its C<revents> bitset (as if its callback was invoked). If the
		1127	watcher isn't pending it does nothing and returns C<0>.
		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
658	=back	1132	=back
659		1133
660		1134
661	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1135	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
662		1136
663	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
664	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
665	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
666	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
667	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
668	data:	1142	data:
669		1143
670	struct my_io	1144	struct my_io
671	{	1145	{
672	struct ev_io io;	1146	ev_io io;
673	int otherfd;	1147	int otherfd;
674	void *somedata;	1148	void *somedata;
675	struct whatever *mostinteresting;	1149	struct whatever *mostinteresting;
676	}	1150	};
		1151
		1152	...
		1153	struct my_io w;
		1154	ev_io_init (&w.io, my_cb, fd, EV_READ);
677		1155
678	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
679	can cast it back to your own type:	1157	can cast it back to your own type:
680		1158
681	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)
682	{	1160	{
683	struct my_io *w = (struct my_io *)w_;	1161	struct my_io *w = (struct my_io *)w_;
684	...	1162	...
685	}	1163	}
686		1164
687	More interesting and less C-conformant ways of catsing your callback type	1165	More interesting and less C-conformant ways of casting your callback type
688	have been omitted....	1166	instead have been omitted.
		1167
		1168	Another common scenario is to use some data structure with multiple
		1169	embedded watchers:
		1170
		1171	struct my_biggy
		1172	{
		1173	int some_data;
		1174	ev_timer t1;
		1175	ev_timer t2;
		1176	}
		1177
		1178	In this case getting the pointer to C<my_biggy> is a bit more
		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):
		1183
		1184	#include <stddef.h>
		1185
		1186	static void
		1187	t1_cb (EV_P_ ev_timer *w, int revents)
		1188	{
		1189	struct my_biggy big = (struct my_biggy *
		1190	(((char *)w) - offsetof (struct my_biggy, t1));
		1191	}
		1192
		1193	static void
		1194	t2_cb (EV_P_ ev_timer *w, int revents)
		1195	{
		1196	struct my_biggy big = (struct my_biggy *
		1197	(((char *)w) - offsetof (struct my_biggy, t2));
		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.
689		1302
690		1303
691	=head1 WATCHER TYPES	1304	=head1 WATCHER TYPES
692		1305
693	This section describes each watcher in detail, but will not repeat	1306	This section describes each watcher in detail, but will not repeat
694	information given in the last section.	1307	information given in the last section. Any initialisation/set macros,
		1308	functions and members specific to the watcher type are explained.
		1309
		1310	Members are additionally marked with either I<[read-only]>, meaning that,
		1311	while the watcher is active, you can look at the member and expect some
		1312	sensible content, but you must not modify it (you can modify it while the
		1313	watcher is stopped to your hearts content), or I<[read-write]>, which
		1314	means you can expect it to have some sensible content while the watcher
		1315	is active, but you can also modify it. Modifying it may not do something
		1316	sensible or take immediate effect (or do anything at all), but libev will
		1317	not crash or malfunction in any way.
695		1318
696		1319
697	=head2 C<ev_io> - is this file descriptor readable or writable?	1320	=head2 C<ev_io> - is this file descriptor readable or writable?
698		1321
699	I/O watchers check whether a file descriptor is readable or writable	1322	I/O watchers check whether a file descriptor is readable or writable
…		…
707	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
708	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
709	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
710	required if you know what you are doing).	1333	required if you know what you are doing).
711		1334
712	You have to be careful with dup'ed file descriptors, though. Some backends	1335	If you cannot use non-blocking mode, then force the use of a
713	(the linux epoll backend is a notable example) cannot handle dup'ed file	1336	known-to-be-good backend (at the time of this writing, this includes only
714	descriptors correctly if you register interest in two or more fds pointing	1337	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
715	to the same underlying file/socket/etc. description (that is, they share	1338	descriptors for which non-blocking operation makes no sense (such as
716	the same underlying "file open").	1339	files) - libev doesn't guarentee any specific behaviour in that case.
717
718	If you must do this, then force the use of a known-to-be-good backend
719	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
720	C<EVBACKEND_POLL>).
721		1340
722	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
723	receive "spurious" readyness notifications, that is your callback might	1342	receive "spurious" readiness notifications, that is your callback might
724	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
725	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
726	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
727	this situation even with a relatively standard program structure. Thus	1346	this situation even with a relatively standard program structure. Thus
728	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
729	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.
730		1349
731	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
732	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
733	wether 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
734	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
735	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.
		1359
		1360	=head3 The special problem of disappearing file descriptors
		1361
		1362	Some backends (e.g. kqueue, epoll) need to be told about closing a file
		1363	descriptor (either due to calling C<close> explicitly or any other means,
		1364	such as C<dup2>). The reason is that you register interest in some file
		1365	descriptor, but when it goes away, the operating system will silently drop
		1366	this interest. If another file descriptor with the same number then is
		1367	registered with libev, there is no efficient way to see that this is, in
		1368	fact, a different file descriptor.
		1369
		1370	To avoid having to explicitly tell libev about such cases, libev follows
		1371	the following policy: Each time C<ev_io_set> is being called, libev
		1372	will assume that this is potentially a new file descriptor, otherwise
		1373	it is assumed that the file descriptor stays the same. That means that
		1374	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		1375	descriptor even if the file descriptor number itself did not change.
		1376
		1377	This is how one would do it normally anyway, the important point is that
		1378	the libev application should not optimise around libev but should leave
		1379	optimisations to libev.
		1380
		1381	=head3 The special problem of dup'ed file descriptors
		1382
		1383	Some backends (e.g. epoll), cannot register events for file descriptors,
		1384	but only events for the underlying file descriptions. That means when you
		1385	have C<dup ()>'ed file descriptors or weirder constellations, and register
		1386	events for them, only one file descriptor might actually receive events.
		1387
		1388	There is no workaround possible except not registering events
		1389	for potentially C<dup ()>'ed file descriptors, or to resort to
		1390	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
		1391
		1392	=head3 The special problem of fork
		1393
		1394	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
		1395	useless behaviour. Libev fully supports fork, but needs to be told about
		1396	it in the child.
		1397
		1398	To support fork in your programs, you either have to call
		1399	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
		1400	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
		1401	C<EVBACKEND_POLL>.
		1402
		1403	=head3 The special problem of SIGPIPE
		1404
		1405	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
		1406	when writing to a pipe whose other end has been closed, your program gets
		1407	sent a SIGPIPE, which, by default, aborts your program. For most programs
		1408	this is sensible behaviour, for daemons, this is usually undesirable.
		1409
		1410	So when you encounter spurious, unexplained daemon exits, make sure you
		1411	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1412	somewhere, as that would have given you a big clue).
		1413
		1414
		1415	=head3 Watcher-Specific Functions
736		1416
737	=over 4	1417	=over 4
738		1418
739	=item ev_io_init (ev_io *, callback, int fd, int events)	1419	=item ev_io_init (ev_io *, callback, int fd, int events)
740		1420
741	=item ev_io_set (ev_io *, int fd, int events)	1421	=item ev_io_set (ev_io *, int fd, int events)
742		1422
743	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
744	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
745	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.
		1426
		1427	=item int fd [read-only]
		1428
		1429	The file descriptor being watched.
		1430
		1431	=item int events [read-only]
		1432
		1433	The events being watched.
746		1434
747	=back	1435	=back
748		1436
		1437	=head3 Examples
		1438
749	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
750	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
751	attempt to read a whole line in the callback:	1441	attempt to read a whole line in the callback.
752		1442
753	static void	1443	static void
754	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)
755	{	1445	{
756	ev_io_stop (loop, w);	1446	ev_io_stop (loop, w);
757	.. 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
758	}	1448	}
759		1449
760	...	1450	...
761	struct ev_loop *loop = ev_default_init (0);	1451	struct ev_loop *loop = ev_default_init (0);
762	struct ev_io stdin_readable;	1452	ev_io stdin_readable;
763	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);
764	ev_io_start (loop, &stdin_readable);	1454	ev_io_start (loop, &stdin_readable);
765	ev_loop (loop, 0);	1455	ev_loop (loop, 0);
766		1456
767		1457
768	=head2 C<ev_timer> - relative and optionally repeating timeouts	1458	=head2 C<ev_timer> - relative and optionally repeating timeouts
769		1459
770	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
771	given time, and optionally repeating in regular intervals after that.	1461	given time, and optionally repeating in regular intervals after that.
772		1462
773	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
774	times out after an hour and you reset your system clock to last years	1464	times out after an hour and you reset your system clock to January last
775	time, it will still time out after (roughly) and hour. "Roughly" because	1465	year, it will still time out after (roughly) one hour. "Roughly" because
776	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1466	detecting time jumps is hard, and some inaccuracies are unavoidable (the
777	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.
778		1657
779	The relative timeouts are calculated relative to the C<ev_now ()>	1658	The relative timeouts are calculated relative to the C<ev_now ()>
780	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
781	of the event triggering whatever timeout you are modifying/starting. If	1660	of the event triggering whatever timeout you are modifying/starting. If
782	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
783	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:
784		1663
785	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1664	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
786		1665
787	The callback is guarenteed to be invoked only when its timeout has passed,	1666	If the event loop is suspended for a long time, you can also force an
788	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
789	order of execution is undefined.	1668	()>.
		1669
		1670	=head3 Watcher-Specific Functions and Data Members
790		1671
791	=over 4	1672	=over 4
792		1673
793	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1674	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
794		1675
795	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1676	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
796		1677
797	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1678	Configure the timer to trigger after C<after> seconds. If C<repeat>
798	C<0.>, then it will automatically be stopped. If it is positive, then the	1679	is C<0.>, then it will automatically be stopped once the timeout is
799	timer will automatically be configured to trigger again C<repeat> seconds	1680	reached. If it is positive, then the timer will automatically be
800	later, again, and again, until stopped manually.	1681	configured to trigger again C<repeat> seconds later, again, and again,
		1682	until stopped manually.
801		1683
802	The timer itself will do a best-effort at avoiding drift, that is, if you	1684	The timer itself will do a best-effort at avoiding drift, that is, if
803	configure a timer to trigger every 10 seconds, then it will trigger at	1685	you configure a timer to trigger every 10 seconds, then it will normally
804	exactly 10 second intervals. If, however, your program cannot keep up with	1686	trigger at exactly 10 second intervals. If, however, your program cannot
805	the timer (because it takes longer than those 10 seconds to do stuff) the	1687	keep up with the timer (because it takes longer than those 10 seconds to
806	timer will not fire more than once per event loop iteration.	1688	do stuff) the timer will not fire more than once per event loop iteration.
807		1689
808	=item ev_timer_again (loop)	1690	=item ev_timer_again (loop, ev_timer *)
809		1691
810	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
811	repeating. The exact semantics are:	1693	repeating. The exact semantics are:
812		1694
		1695	If the timer is pending, its pending status is cleared.
		1696
813	If the timer is started but nonrepeating, stop it.	1697	If the timer is started but non-repeating, stop it (as if it timed out).
814		1698
815	If the timer is repeating, either start it if necessary (with the repeat	1699	If the timer is repeating, either start it if necessary (with the
816	value), or reset the running timer to the repeat value.	1700	C<repeat> value), or reset the running timer to the C<repeat> value.
817		1701
818	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
819	example: Imagine you have a tcp connection and you want a so-called idle	1703	usage example.
820	timeout, that is, you want to be called when there have been, say, 60	1704
821	seconds of inactivity on the socket. The easiest way to do this is to	1705	=item ev_tstamp repeat [read-write]
822	configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each	1706
823	time you successfully read or write some data. If you go into an idle	1707	The current C<repeat> value. Will be used each time the watcher times out
824	state where you do not expect data to travel on the socket, you can stop	1708	or C<ev_timer_again> is called, and determines the next timeout (if any),
825	the timer, and again will automatically restart it if need be.	1709	which is also when any modifications are taken into account.
826		1710
827	=back	1711	=back
828		1712
		1713	=head3 Examples
		1714
829	Example: create a timer that fires after 60 seconds.	1715	Example: Create a timer that fires after 60 seconds.
830		1716
831	static void	1717	static void
832	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)
833	{	1719	{
834	.. one minute over, w is actually stopped right here	1720	.. one minute over, w is actually stopped right here
835	}	1721	}
836		1722
837	struct ev_timer mytimer;	1723	ev_timer mytimer;
838	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1724	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
839	ev_timer_start (loop, &mytimer);	1725	ev_timer_start (loop, &mytimer);
840		1726
841	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
842	inactivity.	1728	inactivity.
843		1729
844	static void	1730	static void
845	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1731	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
846	{	1732	{
847	.. ten seconds without any activity	1733	.. ten seconds without any activity
848	}	1734	}
849		1735
850	struct ev_timer mytimer;	1736	ev_timer mytimer;
851	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 */
852	ev_timer_again (&mytimer); /* start timer */	1738	ev_timer_again (&mytimer); /* start timer */
853	ev_loop (loop, 0);	1739	ev_loop (loop, 0);
854		1740
855	// 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":
856	// reset the timeout to start ticking again at 10 seconds	1742	// reset the timeout to start ticking again at 10 seconds
857	ev_timer_again (&mytimer);	1743	ev_timer_again (&mytimer);
858		1744
859		1745
860	=head2 C<ev_periodic> - to cron or not to cron?	1746	=head2 C<ev_periodic> - to cron or not to cron?
861		1747
862	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
863	(and unfortunately a bit complex).	1749	(and unfortunately a bit complex).
864		1750
865	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
866	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
867	to trigger "at" 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
868	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
869	+ 10.>) and then reset your system clock to the last year, then it will	1755	time, and time jumps are not uncommon (e.g. when you adjust your
870	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1756	wrist-watch).
871	roughly 10 seconds later and of course not if you reset your system time
872	again).
873		1757
874	They can also be used to implement vastly more complex timers, such as	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
		1766	C<ev_periodic> watchers can also be used to implement vastly more complex
875	triggering an event on eahc midnight, local time.	1767	timers, such as triggering an event on each "midnight, local time", or
		1768	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1769	those cannot react to time jumps.
876		1770
877	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
878	time (C<at>) has been passed, but if multiple periodic timers become ready	1772	point in time where it is supposed to trigger has passed. If multiple
879	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).
		1776
		1777	=head3 Watcher-Specific Functions and Data Members
880		1778
881	=over 4	1779	=over 4
882		1780
883	=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)
884		1782
885	=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)
886		1784
887	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
888	operation, and we will explain them from simplest to complex:	1786	operation, and we will explain them from simplest to most complex:
889		1787
890	=over 4	1788	=over 4
891		1789
892	=item * absolute timer (interval = reschedule_cb = 0)	1790	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
893		1791
894	In this configuration the watcher triggers an event at the wallclock time	1792	In this configuration the watcher triggers an event after the wall clock
895	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1793	time C<offset> has passed. It will not repeat and will not adjust when a
896	that is, if it is to be run at January 1st 2011 then it will run when the	1794	time jump occurs, that is, if it is to be run at January 1st 2011 then it
897	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.
898		1797
899	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1798	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
900		1799
901	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
902	C<at + N * interval> time (for some integer N) and then repeat, regardless	1801	C<offset + N * interval> time (for some integer N, which can also be
903	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.
904		1804
905	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
906	time:	1806	system clock, for example, here is an C<ev_periodic> that triggers each
		1807	hour, on the hour (with respect to UTC):
907		1808
908	ev_periodic_set (&periodic, 0., 3600., 0);	1809	ev_periodic_set (&periodic, 0., 3600., 0);
909		1810
910	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,
911	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
912	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
913	by 3600.	1814	by 3600.
914		1815
915	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
916	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
917	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.
918		1819
		1820	For numerical stability it is preferable that the C<offset> value is near
		1821	C<ev_now ()> (the current time), but there is no range requirement for
		1822	this value, and in fact is often specified as zero.
		1823
		1824	Note also that there is an upper limit to how often a timer can fire (CPU
		1825	speed for example), so if C<interval> is very small then timing stability
		1826	will of course deteriorate. Libev itself tries to be exact to be about one
		1827	millisecond (if the OS supports it and the machine is fast enough).
		1828
919	=item * manual reschedule mode (reschedule_cb = callback)	1829	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
920		1830
921	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
922	ignored. Instead, each time the periodic watcher gets scheduled, the	1832	ignored. Instead, each time the periodic watcher gets scheduled, the
923	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
924	current time as second argument.	1834	current time as second argument.
925		1835
926	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,
927	ever, or make any event loop modifications>. If you need to stop it,	1837	or make ANY other event loop modifications whatsoever, unless explicitly
928	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1838	allowed by documentation here>.
929	starting a prepare watcher).
930		1839
		1840	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1841	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1842	only event loop modification you are allowed to do).
		1843
931	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1844	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
932	ev_tstamp now)>, e.g.:	1845	*w, ev_tstamp now)>, e.g.:
933		1846
		1847	static ev_tstamp
934	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1848	my_rescheduler (ev_periodic *w, ev_tstamp now)
935	{	1849	{
936	return now + 60.;	1850	return now + 60.;
937	}	1851	}
938		1852
939	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
940	(that is, the lowest time value larger than to the second argument). It	1854	(that is, the lowest time value larger than to the second argument). It
941	will usually be called just before the callback will be triggered, but	1855	will usually be called just before the callback will be triggered, but
942	might be called at other times, too.	1856	might be called at other times, too.
943		1857
944	NOTE: I<< This callback must always return a time that is later than the	1858	NOTE: I<< This callback must always return a time that is higher than or
945	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1859	equal to the passed C<now> value >>.
946		1860
947	This can be used to create very complex timers, such as a timer that	1861	This can be used to create very complex timers, such as a timer that
948	triggers on each midnight, local time. To do this, you would calculate the	1862	triggers on "next midnight, local time". To do this, you would calculate the
949	next midnight after C<now> and return the timestamp value for this. How	1863	next midnight after C<now> and return the timestamp value for this. How
950	you do this is, again, up to you (but it is not trivial, which is the main	1864	you do this is, again, up to you (but it is not trivial, which is the main
951	reason I omitted it as an example).	1865	reason I omitted it as an example).
952		1866
953	=back	1867	=back
…		…
957	Simply stops and restarts the periodic watcher again. This is only useful	1871	Simply stops and restarts the periodic watcher again. This is only useful
958	when you changed some parameters or the reschedule callback would return	1872	when you changed some parameters or the reschedule callback would return
959	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
960	program when the crontabs have changed).	1874	program when the crontabs have changed).
961		1875
		1876	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1877
		1878	When active, returns the absolute time that the watcher is supposed
		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.
		1882
		1883	=item ev_tstamp offset [read-write]
		1884
		1885	When repeating, this contains the offset value, otherwise this is the
		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).
		1888
		1889	Can be modified any time, but changes only take effect when the periodic
		1890	timer fires or C<ev_periodic_again> is being called.
		1891
		1892	=item ev_tstamp interval [read-write]
		1893
		1894	The current interval value. Can be modified any time, but changes only
		1895	take effect when the periodic timer fires or C<ev_periodic_again> is being
		1896	called.
		1897
		1898	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
		1899
		1900	The current reschedule callback, or C<0>, if this functionality is
		1901	switched off. Can be changed any time, but changes only take effect when
		1902	the periodic timer fires or C<ev_periodic_again> is being called.
		1903
962	=back	1904	=back
963		1905
		1906	=head3 Examples
		1907
964	Example: call a callback every hour, or, more precisely, whenever the	1908	Example: Call a callback every hour, or, more precisely, whenever the
965	system clock is divisible by 3600. The callback invocation times have	1909	system time is divisible by 3600. The callback invocation times have
966	potentially a lot of jittering, but good long-term stability.	1910	potentially a lot of jitter, but good long-term stability.
967		1911
968	static void	1912	static void
969	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1913	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
970	{	1914	{
971	... 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)
972	}	1916	}
973		1917
974	struct ev_periodic hourly_tick;	1918	ev_periodic hourly_tick;
975	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1919	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
976	ev_periodic_start (loop, &hourly_tick);	1920	ev_periodic_start (loop, &hourly_tick);
977		1921
978	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:
979		1923
980	#include <math.h>	1924	#include <math.h>
981		1925
982	static ev_tstamp	1926	static ev_tstamp
983	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1927	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
984	{	1928	{
985	return fmod (now, 3600.) + 3600.;	1929	return now + (3600. - fmod (now, 3600.));
986	}	1930	}
987		1931
988	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);
989		1933
990	Example: call a callback every hour, starting now:	1934	Example: Call a callback every hour, starting now:
991		1935
992	struct ev_periodic hourly_tick;	1936	ev_periodic hourly_tick;
993	ev_periodic_init (&hourly_tick, clock_cb,	1937	ev_periodic_init (&hourly_tick, clock_cb,
994	fmod (ev_now (loop), 3600.), 3600., 0);	1938	fmod (ev_now (loop), 3600.), 3600., 0);
995	ev_periodic_start (loop, &hourly_tick);	1939	ev_periodic_start (loop, &hourly_tick);
996		1940
997		1941
998	=head2 C<ev_signal> - signal me when a signal gets signalled!	1942	=head2 C<ev_signal> - signal me when a signal gets signalled!
999		1943
1000	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
1001	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
1002	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
1003	normal event processing, like any other event.	1947	normal event processing, like any other event.
1004		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
1005	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
1006	first watcher gets started will libev actually register a signal watcher	1954	first watcher gets started will libev actually register a signal handler
1007	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
1008	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
1009	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
1010	SIG_DFL (regardless of what it was set to before).	1958	signal handler to SIG_DFL (regardless of what it was set to before).
		1959
		1960	If possible and supported, libev will install its handlers with
		1961	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
		1962	interrupted. If you have a problem with system calls getting interrupted by
		1963	signals you can block all signals in an C<ev_check> watcher and unblock
		1964	them in an C<ev_prepare> watcher.
		1965
		1966	=head3 Watcher-Specific Functions and Data Members
1011		1967
1012	=over 4	1968	=over 4
1013		1969
1014	=item ev_signal_init (ev_signal *, callback, int signum)	1970	=item ev_signal_init (ev_signal *, callback, int signum)
1015		1971
1016	=item ev_signal_set (ev_signal *, int signum)	1972	=item ev_signal_set (ev_signal *, int signum)
1017		1973
1018	Configures the watcher to trigger on the given signal number (usually one	1974	Configures the watcher to trigger on the given signal number (usually one
1019	of the C<SIGxxx> constants).	1975	of the C<SIGxxx> constants).
1020		1976
		1977	=item int signum [read-only]
		1978
		1979	The signal the watcher watches out for.
		1980
1021	=back	1981	=back
1022		1982
		1983	=head3 Examples
		1984
		1985	Example: Try to exit cleanly on SIGINT.
		1986
		1987	static void
		1988	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
		1989	{
		1990	ev_unloop (loop, EVUNLOOP_ALL);
		1991	}
		1992
		1993	ev_signal signal_watcher;
		1994	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1995	ev_signal_start (loop, &signal_watcher);
		1996
1023		1997
1024	=head2 C<ev_child> - watch out for process status changes	1998	=head2 C<ev_child> - watch out for process status changes
1025		1999
1026	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
1027	some child status changes (most typically when a child of yours dies).	2001	some child status changes (most typically when a child of yours dies or
		2002	exits). It is permissible to install a child watcher I<after> the child
		2003	has been forked (which implies it might have already exited), as long
		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.
		2008
		2009	Only the default event loop is capable of handling signals, and therefore
		2010	you can only register child watchers in the default event loop.
		2011
		2012	=head3 Process Interaction
		2013
		2014	Libev grabs C<SIGCHLD> as soon as the default event loop is
		2015	initialised. This is necessary to guarantee proper behaviour even if
		2016	the first child watcher is started after the child exits. The occurrence
		2017	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		2018	synchronously as part of the event loop processing. Libev always reaps all
		2019	children, even ones not watched.
		2020
		2021	=head3 Overriding the Built-In Processing
		2022
		2023	Libev offers no special support for overriding the built-in child
		2024	processing, but if your application collides with libev's default child
		2025	handler, you can override it easily by installing your own handler for
		2026	C<SIGCHLD> after initialising the default loop, and making sure the
		2027	default loop never gets destroyed. You are encouraged, however, to use an
		2028	event-based approach to child reaping and thus use libev's support for
		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.
		2037
		2038	=head3 Watcher-Specific Functions and Data Members
1028		2039
1029	=over 4	2040	=over 4
1030		2041
1031	=item ev_child_init (ev_child *, callback, int pid)	2042	=item ev_child_init (ev_child *, callback, int pid, int trace)
1032		2043
1033	=item ev_child_set (ev_child *, int pid)	2044	=item ev_child_set (ev_child *, int pid, int trace)
1034		2045
1035	Configures the watcher to wait for status changes of process C<pid> (or	2046	Configures the watcher to wait for status changes of process C<pid> (or
1036	I<any> process if C<pid> is specified as C<0>). The callback can look	2047	I<any> process if C<pid> is specified as C<0>). The callback can look
1037	at the C<rstatus> member of the C<ev_child> watcher structure to see	2048	at the C<rstatus> member of the C<ev_child> watcher structure to see
1038	the status word (use the macros from C<sys/wait.h> and see your systems	2049	the status word (use the macros from C<sys/wait.h> and see your systems
1039	C<waitpid> documentation). The C<rpid> member contains the pid of the	2050	C<waitpid> documentation). The C<rpid> member contains the pid of the
1040	process causing the status change.	2051	process causing the status change. C<trace> must be either C<0> (only
		2052	activate the watcher when the process terminates) or C<1> (additionally
		2053	activate the watcher when the process is stopped or continued).
		2054
		2055	=item int pid [read-only]
		2056
		2057	The process id this watcher watches out for, or C<0>, meaning any process id.
		2058
		2059	=item int rpid [read-write]
		2060
		2061	The process id that detected a status change.
		2062
		2063	=item int rstatus [read-write]
		2064
		2065	The process exit/trace status caused by C<rpid> (see your systems
		2066	C<waitpid> and C<sys/wait.h> documentation for details).
1041		2067
1042	=back	2068	=back
1043		2069
1044	Example: try to exit cleanly on SIGINT and SIGTERM.	2070	=head3 Examples
1045		2071
		2072	Example: C<fork()> a new process and install a child handler to wait for
		2073	its completion.
		2074
		2075	ev_child cw;
		2076
1046	static void	2077	static void
1047	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	2078	child_cb (EV_P_ ev_child *w, int revents)
1048	{	2079	{
1049	ev_unloop (loop, EVUNLOOP_ALL);	2080	ev_child_stop (EV_A_ w);
		2081	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1050	}	2082	}
1051		2083
1052	struct ev_signal signal_watcher;	2084	pid_t pid = fork ();
1053	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2085
1054	ev_signal_start (loop, &sigint_cb);	2086	if (pid < 0)
		2087	// error
		2088	else if (pid == 0)
		2089	{
		2090	// the forked child executes here
		2091	exit (1);
		2092	}
		2093	else
		2094	{
		2095	ev_child_init (&cw, child_cb, pid, 0);
		2096	ev_child_start (EV_DEFAULT_ &cw);
		2097	}
		2098
		2099
		2100	=head2 C<ev_stat> - did the file attributes just change?
		2101
		2102	This watches a file system path for attribute changes. That is, it calls
		2103	C<stat> on that path in regular intervals (or when the OS says it changed)
		2104	and sees if it changed compared to the last time, invoking the callback if
		2105	it did.
		2106
		2107	The path does not need to exist: changing from "path exists" to "path does
		2108	not exist" is a status change like any other. The condition "path does not
		2109	exist" (or more correctly "path cannot be stat'ed") is signified by the
		2110	C<st_nlink> field being zero (which is otherwise always forced to be at
		2111	least one) and all the other fields of the stat buffer having unspecified
		2112	contents.
		2113
		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
		2116	your working directory changes, then the behaviour is undefined.
		2117
		2118	Since there is no portable change notification interface available, the
		2119	portable implementation simply calls C<stat(2)> regularly on the path
		2120	to see if it changed somehow. You can specify a recommended polling
		2121	interval for this case. If you specify a polling interval of C<0> (highly
		2122	recommended!) then a I<suitable, unspecified default> value will be used
		2123	(which you can expect to be around five seconds, although this might
		2124	change dynamically). Libev will also impose a minimum interval which is
		2125	currently around C<0.1>, but that's usually overkill.
		2126
		2127	This watcher type is not meant for massive numbers of stat watchers,
		2128	as even with OS-supported change notifications, this can be
		2129	resource-intensive.
		2130
		2131	At the time of this writing, the only OS-specific interface implemented
		2132	is the Linux inotify interface (implementing kqueue support is left as an
		2133	exercise for the reader. Note, however, that the author sees no way of
		2134	implementing C<ev_stat> semantics with kqueue, except as a hint).
		2135
		2136	=head3 ABI Issues (Largefile Support)
		2137
		2138	Libev by default (unless the user overrides this) uses the default
		2139	compilation environment, which means that on systems with large file
		2140	support disabled by default, you get the 32 bit version of the stat
		2141	structure. When using the library from programs that change the ABI to
		2142	use 64 bit file offsets the programs will fail. In that case you have to
		2143	compile libev with the same flags to get binary compatibility. This is
		2144	obviously the case with any flags that change the ABI, but the problem is
		2145	most noticeably displayed with ev_stat and large file support.
		2146
		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.
		2152
		2153	=head3 Inotify and Kqueue
		2154
		2155	When C<inotify (7)> support has been compiled into libev and present at
		2156	runtime, it will be used to speed up change detection where possible. The
		2157	inotify descriptor will be created lazily when the first C<ev_stat>
		2158	watcher is being started.
		2159
		2160	Inotify presence does not change the semantics of C<ev_stat> watchers
		2161	except that changes might be detected earlier, and in some cases, to avoid
		2162	making regular C<stat> calls. Even in the presence of inotify support
		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.
		2168
		2169	There is no support for kqueue, as apparently it cannot be used to
		2170	implement this functionality, due to the requirement of having a file
		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.
		2191
		2192	=head3 The special problem of stat time resolution
		2193
		2194	The C<stat ()> system call only supports full-second resolution portably,
		2195	and even on systems where the resolution is higher, most file systems
		2196	still only support whole seconds.
		2197
		2198	That means that, if the time is the only thing that changes, you can
		2199	easily miss updates: on the first update, C<ev_stat> detects a change and
		2200	calls your callback, which does something. When there is another update
		2201	within the same second, C<ev_stat> will be unable to detect unless the
		2202	stat data does change in other ways (e.g. file size).
		2203
		2204	The solution to this is to delay acting on a change for slightly more
		2205	than a second (or till slightly after the next full second boundary), using
		2206	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
		2207	ev_timer_again (loop, w)>).
		2208
		2209	The C<.02> offset is added to work around small timing inconsistencies
		2210	of some operating systems (where the second counter of the current time
		2211	might be be delayed. One such system is the Linux kernel, where a call to
		2212	C<gettimeofday> might return a timestamp with a full second later than
		2213	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		2214	update file times then there will be a small window where the kernel uses
		2215	the previous second to update file times but libev might already execute
		2216	the timer callback).
		2217
		2218	=head3 Watcher-Specific Functions and Data Members
		2219
		2220	=over 4
		2221
		2222	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
		2223
		2224	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
		2225
		2226	Configures the watcher to wait for status changes of the given
		2227	C<path>. The C<interval> is a hint on how quickly a change is expected to
		2228	be detected and should normally be specified as C<0> to let libev choose
		2229	a suitable value. The memory pointed to by C<path> must point to the same
		2230	path for as long as the watcher is active.
		2231
		2232	The callback will receive an C<EV_STAT> event when a change was detected,
		2233	relative to the attributes at the time the watcher was started (or the
		2234	last change was detected).
		2235
		2236	=item ev_stat_stat (loop, ev_stat *)
		2237
		2238	Updates the stat buffer immediately with new values. If you change the
		2239	watched path in your callback, you could call this function to avoid
		2240	detecting this change (while introducing a race condition if you are not
		2241	the only one changing the path). Can also be useful simply to find out the
		2242	new values.
		2243
		2244	=item ev_statdata attr [read-only]
		2245
		2246	The most-recently detected attributes of the file. Although the type is
		2247	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
		2248	suitable for your system, but you can only rely on the POSIX-standardised
		2249	members to be present. If the C<st_nlink> member is C<0>, then there was
		2250	some error while C<stat>ing the file.
		2251
		2252	=item ev_statdata prev [read-only]
		2253
		2254	The previous attributes of the file. The callback gets invoked whenever
		2255	C<prev> != C<attr>, or, more precisely, one or more of these members
		2256	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		2257	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
		2258
		2259	=item ev_tstamp interval [read-only]
		2260
		2261	The specified interval.
		2262
		2263	=item const char *path [read-only]
		2264
		2265	The file system path that is being watched.
		2266
		2267	=back
		2268
		2269	=head3 Examples
		2270
		2271	Example: Watch C</etc/passwd> for attribute changes.
		2272
		2273	static void
		2274	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
		2275	{
		2276	/* /etc/passwd changed in some way */
		2277	if (w->attr.st_nlink)
		2278	{
		2279	printf ("passwd current size %ld\n", (long)w->attr.st_size);
		2280	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
		2281	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
		2282	}
		2283	else
		2284	/* you shalt not abuse printf for puts */
		2285	puts ("wow, /etc/passwd is not there, expect problems. "
		2286	"if this is windows, they already arrived\n");
		2287	}
		2288
		2289	...
		2290	ev_stat passwd;
		2291
		2292	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
		2293	ev_stat_start (loop, &passwd);
		2294
		2295	Example: Like above, but additionally use a one-second delay so we do not
		2296	miss updates (however, frequent updates will delay processing, too, so
		2297	one might do the work both on C<ev_stat> callback invocation I<and> on
		2298	C<ev_timer> callback invocation).
		2299
		2300	static ev_stat passwd;
		2301	static ev_timer timer;
		2302
		2303	static void
		2304	timer_cb (EV_P_ ev_timer *w, int revents)
		2305	{
		2306	ev_timer_stop (EV_A_ w);
		2307
		2308	/* now it's one second after the most recent passwd change */
		2309	}
		2310
		2311	static void
		2312	stat_cb (EV_P_ ev_stat *w, int revents)
		2313	{
		2314	/* reset the one-second timer */
		2315	ev_timer_again (EV_A_ &timer);
		2316	}
		2317
		2318	...
		2319	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
		2320	ev_stat_start (loop, &passwd);
		2321	ev_timer_init (&timer, timer_cb, 0., 1.02);
1055		2322
1056		2323
1057	=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...
1058		2325
1059	Idle watchers trigger events when there are no other events are pending	2326	Idle watchers trigger events when no other events of the same or higher
1060	(prepare, check and other idle watchers do not count). That is, as long	2327	priority are pending (prepare, check and other idle watchers do not count
1061	as your process is busy handling sockets or timeouts (or even signals,	2328	as receiving "events").
1062	imagine) it will not be triggered. But when your process is idle all idle	2329
1063	watchers are being called again and again, once per event loop iteration -	2330	That is, as long as your process is busy handling sockets or timeouts
		2331	(or even signals, imagine) of the same or higher priority it will not be
		2332	triggered. But when your process is idle (or only lower-priority watchers
		2333	are pending), the idle watchers are being called once per event loop
1064	until stopped, that is, or your process receives more events and becomes	2334	iteration - until stopped, that is, or your process receives more events
1065	busy.	2335	and becomes busy again with higher priority stuff.
1066		2336
1067	The most noteworthy effect is that as long as any idle watchers are	2337	The most noteworthy effect is that as long as any idle watchers are
1068	active, the process will not block when waiting for new events.	2338	active, the process will not block when waiting for new events.
1069		2339
1070	Apart from keeping your process non-blocking (which is a useful	2340	Apart from keeping your process non-blocking (which is a useful
1071	effect on its own sometimes), idle watchers are a good place to do	2341	effect on its own sometimes), idle watchers are a good place to do
1072	"pseudo-background processing", or delay processing stuff to after the	2342	"pseudo-background processing", or delay processing stuff to after the
1073	event loop has handled all outstanding events.	2343	event loop has handled all outstanding events.
1074		2344
		2345	=head3 Watcher-Specific Functions and Data Members
		2346
1075	=over 4	2347	=over 4
1076		2348
1077	=item ev_idle_init (ev_signal *, callback)	2349	=item ev_idle_init (ev_idle *, callback)
1078		2350
1079	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
1080	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,
1081	believe me.	2353	believe me.
1082		2354
1083	=back	2355	=back
1084		2356
		2357	=head3 Examples
		2358
1085	Example: dynamically allocate an C<ev_idle>, start it, and in the	2359	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1086	callback, free it. Alos, use no error checking, as usual.	2360	callback, free it. Also, use no error checking, as usual.
1087		2361
1088	static void	2362	static void
1089	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2363	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1090	{	2364	{
1091	free (w);	2365	free (w);
1092	// now do something you wanted to do when the program has	2366	// now do something you wanted to do when the program has
1093	// no longer asnything immediate to do.	2367	// no longer anything immediate to do.
1094	}	2368	}
1095		2369
1096	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2370	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1097	ev_idle_init (idle_watcher, idle_cb);	2371	ev_idle_init (idle_watcher, idle_cb);
1098	ev_idle_start (loop, idle_cb);	2372	ev_idle_start (loop, idle_cb);
1099		2373
1100		2374
1101	=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!
1102		2376
1103	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:
1104	prepare watchers get invoked before the process blocks and check watchers	2378	prepare watchers get invoked before the process blocks and check watchers
1105	afterwards.	2379	afterwards.
1106		2380
1107	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
1108	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>
…		…
1111	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,
1112	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
1113	called in pairs bracketing the blocking call.	2387	called in pairs bracketing the blocking call.
1114		2388
1115	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
1116	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
1117	variable changes, implement your own watchers, integrate net-snmp or a	2391	variable changes, implement your own watchers, integrate net-snmp or a
1118	coroutine library and lots more. They are also occasionally useful if	2392	coroutine library and lots more. They are also occasionally useful if
1119	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,
1120	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>
1121	watcher).	2395	watcher).
1122		2396
1123	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
1124	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
1125	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
1126	provide just this functionality). Then, in the check watcher you check for	2400	libraries provide exactly this functionality). Then, in the check watcher,
1127	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
1128	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
1129	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
1130	because you never know, you know?).	2404	nevertheless, because you never know, you know?).
1131		2405
1132	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
1133	coroutines into libev programs, by yielding to other active coroutines	2407	coroutines into libev programs, by yielding to other active coroutines
1134	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
1135	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
1136	with priority higher than or equal to the event loop and one coroutine	2410	with priority higher than or equal to the event loop and one coroutine
1137	of lower priority, but only once, using idle watchers to keep the event	2411	of lower priority, but only once, using idle watchers to keep the event
1138	loop from blocking if lower-priority coroutines are active, thus mapping	2412	loop from blocking if lower-priority coroutines are active, thus mapping
1139	low-priority coroutines to idle/background tasks).	2413	low-priority coroutines to idle/background tasks).
1140		2414
		2415	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		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
		2419	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
		2420	activate ("feed") events into libev. While libev fully supports this, they
		2421	might get executed before other C<ev_check> watchers did their job. As
		2422	C<ev_check> watchers are often used to embed other (non-libev) event
		2423	loops those other event loops might be in an unusable state until their
		2424	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
		2425	others).
		2426
		2427	=head3 Watcher-Specific Functions and Data Members
		2428
1141	=over 4	2429	=over 4
1142		2430
1143	=item ev_prepare_init (ev_prepare *, callback)	2431	=item ev_prepare_init (ev_prepare *, callback)
1144		2432
1145	=item ev_check_init (ev_check *, callback)	2433	=item ev_check_init (ev_check *, callback)
1146		2434
1147	Initialises and configures the prepare or check watcher - they have no	2435	Initialises and configures the prepare or check watcher - they have no
1148	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>
1149	macros, but using them is utterly, utterly and completely pointless.	2437	macros, but using them is utterly, utterly, utterly and completely
		2438	pointless.
1150		2439
1151	=back	2440	=back
1152		2441
1153	Example: To include a library such as adns, you would add IO watchers	2442	=head3 Examples
1154	and a timeout watcher in a prepare handler, as required by libadns, and	2443
		2444	There are a number of principal ways to embed other event loops or modules
		2445	into libev. Here are some ideas on how to include libadns into libev
		2446	(there is a Perl module named C<EV::ADNS> that does this, which you could
		2447	use as a working example. Another Perl module named C<EV::Glib> embeds a
		2448	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
		2449	Glib event loop).
		2450
		2451	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1155	in a check watcher, destroy them and call into libadns. What follows is	2452	and in a check watcher, destroy them and call into libadns. What follows
1156	pseudo-code only of course:	2453	is pseudo-code only of course. This requires you to either use a low
		2454	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		2455	the callbacks for the IO/timeout watchers might not have been called yet.
1157		2456
1158	static ev_io iow [nfd];	2457	static ev_io iow [nfd];
1159	static ev_timer tw;	2458	static ev_timer tw;
1160		2459
1161	static void	2460	static void
1162	io_cb (ev_loop *loop, ev_io *w, int revents)	2461	io_cb (struct ev_loop *loop, ev_io *w, int revents)
1163	{	2462	{
1164	// set the relevant poll flags
1165	// could also call adns_processreadable etc. here
1166	struct pollfd *fd = (struct pollfd *)w->data;
1167	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1168	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1169	}	2463	}
1170		2464
1171	// create io watchers for each fd and a timer before blocking	2465	// create io watchers for each fd and a timer before blocking
1172	static void	2466	static void
1173	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2467	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1174	{	2468	{
1175	int timeout = 3600000;truct pollfd fds [nfd];	2469	int timeout = 3600000;
		2470	struct pollfd fds [nfd];
1176	// actual code will need to loop here and realloc etc.	2471	// actual code will need to loop here and realloc etc.
1177	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2472	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1178		2473
1179	/* 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 */
1180	ev_timer_init (&tw, 0, timeout * 1e-3);	2475	ev_timer_init (&tw, 0, timeout * 1e-3);
1181	ev_timer_start (loop, &tw);	2476	ev_timer_start (loop, &tw);
1182		2477
1183	// create on ev_io per pollfd	2478	// create one ev_io per pollfd
1184	for (int i = 0; i < nfd; ++i)	2479	for (int i = 0; i < nfd; ++i)
1185	{	2480	{
1186	ev_io_init (iow + i, io_cb, fds [i].fd,	2481	ev_io_init (iow + i, io_cb, fds [i].fd,
1187	((fds [i].events & POLLIN ? EV_READ : 0)	2482	((fds [i].events & POLLIN ? EV_READ : 0)
1188	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2483	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1189		2484
1190	fds [i].revents = 0;	2485	fds [i].revents = 0;
1191	iow [i].data = fds + i;
1192	ev_io_start (loop, iow + i);	2486	ev_io_start (loop, iow + i);
1193	}	2487	}
1194	}	2488	}
1195		2489
1196	// stop all watchers after blocking	2490	// stop all watchers after blocking
1197	static void	2491	static void
1198	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2492	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
1199	{	2493	{
1200	ev_timer_stop (loop, &tw);	2494	ev_timer_stop (loop, &tw);
1201		2495
1202	for (int i = 0; i < nfd; ++i)	2496	for (int i = 0; i < nfd; ++i)
		2497	{
		2498	// set the relevant poll flags
		2499	// could also call adns_processreadable etc. here
		2500	struct pollfd *fd = fds + i;
		2501	int revents = ev_clear_pending (iow + i);
		2502	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
		2503	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
		2504
		2505	// now stop the watcher
1203	ev_io_stop (loop, iow + i);	2506	ev_io_stop (loop, iow + i);
		2507	}
1204		2508
1205	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2509	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1206	}	2510	}
		2511
		2512	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		2513	in the prepare watcher and would dispose of the check watcher.
		2514
		2515	Method 3: If the module to be embedded supports explicit event
		2516	notification (libadns does), you can also make use of the actual watcher
		2517	callbacks, and only destroy/create the watchers in the prepare watcher.
		2518
		2519	static void
		2520	timer_cb (EV_P_ ev_timer *w, int revents)
		2521	{
		2522	adns_state ads = (adns_state)w->data;
		2523	update_now (EV_A);
		2524
		2525	adns_processtimeouts (ads, &tv_now);
		2526	}
		2527
		2528	static void
		2529	io_cb (EV_P_ ev_io *w, int revents)
		2530	{
		2531	adns_state ads = (adns_state)w->data;
		2532	update_now (EV_A);
		2533
		2534	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		2535	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		2536	}
		2537
		2538	// do not ever call adns_afterpoll
		2539
		2540	Method 4: Do not use a prepare or check watcher because the module you
		2541	want to embed is not flexible enough to support it. Instead, you can
		2542	override their poll function. The drawback with this solution is that the
		2543	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
		2544	this approach, effectively embedding EV as a client into the horrible
		2545	libglib event loop.
		2546
		2547	static gint
		2548	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		2549	{
		2550	int got_events = 0;
		2551
		2552	for (n = 0; n < nfds; ++n)
		2553	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		2554
		2555	if (timeout >= 0)
		2556	// create/start timer
		2557
		2558	// poll
		2559	ev_loop (EV_A_ 0);
		2560
		2561	// stop timer again
		2562	if (timeout >= 0)
		2563	ev_timer_stop (EV_A_ &to);
		2564
		2565	// stop io watchers again - their callbacks should have set
		2566	for (n = 0; n < nfds; ++n)
		2567	ev_io_stop (EV_A_ iow [n]);
		2568
		2569	return got_events;
		2570	}
1207		2571
1208		2572
1209	=head2 C<ev_embed> - when one backend isn't enough...	2573	=head2 C<ev_embed> - when one backend isn't enough...
1210		2574
1211	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
…		…
1217	prioritise I/O.	2581	prioritise I/O.
1218		2582
1219	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
1220	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
1221	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
1222	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
1223	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
1224	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
1225	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 :)
1226		2591
1227	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
1228	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),
1229	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
1230	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
1231	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.
1232		2597
1233	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
1234	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
1235	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
1236	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
1237	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
1238	to C<0>, in which case the embed watcher will automatically execute the	2603	to give the embedded loop strictly lower priority for example).
1239	embedded loop sweep.
1240		2604
1241	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
1242	callback will be invoked whenever some events have been handled. You can	2606	will automatically execute the embedded loop sweep whenever necessary.
1243	set the callback to C<0> to avoid having to specify one if you are not
1244	interested in that.
1245		2607
1246	Also, there have not currently been made special provisions for forking:	2608	Fork detection will be handled transparently while the C<ev_embed> watcher
1247	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
1248	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
1249	yourself.	2611	C<ev_loop_fork> on the embedded loop.
1250		2612
1251	Unfortunately, not all backends are embeddable, only the ones returned by	2613	Unfortunately, not all backends are embeddable: only the ones returned by
1252	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2614	C<ev_embeddable_backends> are, which, unfortunately, does not include any
1253	portable one.	2615	portable one.
1254		2616
1255	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
1256	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
1257	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
1258	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.
1259		2621
1260	struct ev_loop *loop_hi = ev_default_init (0);	2622	=head3 C<ev_embed> and fork
1261	struct ev_loop *loop_lo = 0;
1262	struct ev_embed embed;
1263
1264	// see if there is a chance of getting one that works
1265	// (remember that a flags value of 0 means autodetection)
1266	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
1267	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
1268	: 0;
1269		2623
1270	// if we got one, then embed it, otherwise default to loop_hi	2624	While the C<ev_embed> watcher is running, forks in the embedding loop will
1271	if (loop_lo)	2625	automatically be applied to the embedded loop as well, so no special
1272	{	2626	fork handling is required in that case. When the watcher is not running,
1273	ev_embed_init (&embed, 0, loop_lo);	2627	however, it is still the task of the libev user to call C<ev_loop_fork ()>
1274	ev_embed_start (loop_hi, &embed);	2628	as applicable.
1275	}	2629
1276	else	2630	=head3 Watcher-Specific Functions and Data Members
1277	loop_lo = loop_hi;
1278		2631
1279	=over 4	2632	=over 4
1280		2633
1281	=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)
1282		2635
…		…
1284		2637
1285	Configures the watcher to embed the given loop, which must be	2638	Configures the watcher to embed the given loop, which must be
1286	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
1287	invoked automatically, otherwise it is the responsibility of the callback	2640	invoked automatically, otherwise it is the responsibility of the callback
1288	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,
1289	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).
1290		2643
1291	=item ev_embed_sweep (loop, ev_embed *)	2644	=item ev_embed_sweep (loop, ev_embed *)
1292		2645
1293	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
1294	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
1295	apropriate way for embedded loops.	2648	appropriate way for embedded loops.
		2649
		2650	=item struct ev_loop *other [read-only]
		2651
		2652	The embedded event loop.
1296		2653
1297	=back	2654	=back
1298		2655
		2656	=head3 Examples
		2657
		2658	Example: Try to get an embeddable event loop and embed it into the default
		2659	event loop. If that is not possible, use the default loop. The default
		2660	loop is stored in C<loop_hi>, while the embeddable loop is stored in
		2661	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
		2662	used).
		2663
		2664	struct ev_loop *loop_hi = ev_default_init (0);
		2665	struct ev_loop *loop_lo = 0;
		2666	ev_embed embed;
		2667
		2668	// see if there is a chance of getting one that works
		2669	// (remember that a flags value of 0 means autodetection)
		2670	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
		2671	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
		2672	: 0;
		2673
		2674	// if we got one, then embed it, otherwise default to loop_hi
		2675	if (loop_lo)
		2676	{
		2677	ev_embed_init (&embed, 0, loop_lo);
		2678	ev_embed_start (loop_hi, &embed);
		2679	}
		2680	else
		2681	loop_lo = loop_hi;
		2682
		2683	Example: Check if kqueue is available but not recommended and create
		2684	a kqueue backend for use with sockets (which usually work with any
		2685	kqueue implementation). Store the kqueue/socket-only event loop in
		2686	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
		2687
		2688	struct ev_loop *loop = ev_default_init (0);
		2689	struct ev_loop *loop_socket = 0;
		2690	ev_embed embed;
		2691
		2692	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
		2693	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
		2694	{
		2695	ev_embed_init (&embed, 0, loop_socket);
		2696	ev_embed_start (loop, &embed);
		2697	}
		2698
		2699	if (!loop_socket)
		2700	loop_socket = loop;
		2701
		2702	// now use loop_socket for all sockets, and loop for everything else
		2703
		2704
		2705	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		2706
		2707	Fork watchers are called when a C<fork ()> was detected (usually because
		2708	whoever is a good citizen cared to tell libev about it by calling
		2709	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		2710	event loop blocks next and before C<ev_check> watchers are being called,
		2711	and only in the child after the fork. If whoever good citizen calling
		2712	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		2713	handlers will be invoked, too, of course.
		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
		2748	=head3 Watcher-Specific Functions and Data Members
		2749
		2750	=over 4
		2751
		2752	=item ev_fork_init (ev_signal *, callback)
		2753
		2754	Initialises and configures the fork watcher - it has no parameters of any
		2755	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
		2756	believe me.
		2757
		2758	=back
		2759
		2760
		2761	=head2 C<ev_async> - how to wake up another event loop
		2762
		2763	In general, you cannot use an C<ev_loop> from multiple threads or other
		2764	asynchronous sources such as signal handlers (as opposed to multiple event
		2765	loops - those are of course safe to use in different threads).
		2766
		2767	Sometimes, however, you need to wake up another event loop you do not
		2768	control, for example because it belongs to another thread. This is what
		2769	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2770	can signal it by calling C<ev_async_send>, which is thread- and signal
		2771	safe.
		2772
		2773	This functionality is very similar to C<ev_signal> watchers, as signals,
		2774	too, are asynchronous in nature, and signals, too, will be compressed
		2775	(i.e. the number of callback invocations may be less than the number of
		2776	C<ev_async_sent> calls).
		2777
		2778	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2779	just the default loop.
		2780
		2781	=head3 Queueing
		2782
		2783	C<ev_async> does not support queueing of data in any way. The reason
		2784	is that the author does not know of a simple (or any) algorithm for a
		2785	multiple-writer-single-reader queue that works in all cases and doesn't
		2786	need elaborate support such as pthreads.
		2787
		2788	That means that if you want to queue data, you have to provide your own
		2789	queue. But at least I can tell you how to implement locking around your
		2790	queue:
		2791
		2792	=over 4
		2793
		2794	=item queueing from a signal handler context
		2795
		2796	To implement race-free queueing, you simply add to the queue in the signal
		2797	handler but you block the signal handler in the watcher callback. Here is
		2798	an example that does that for some fictitious SIGUSR1 handler:
		2799
		2800	static ev_async mysig;
		2801
		2802	static void
		2803	sigusr1_handler (void)
		2804	{
		2805	sometype data;
		2806
		2807	// no locking etc.
		2808	queue_put (data);
		2809	ev_async_send (EV_DEFAULT_ &mysig);
		2810	}
		2811
		2812	static void
		2813	mysig_cb (EV_P_ ev_async *w, int revents)
		2814	{
		2815	sometype data;
		2816	sigset_t block, prev;
		2817
		2818	sigemptyset (&block);
		2819	sigaddset (&block, SIGUSR1);
		2820	sigprocmask (SIG_BLOCK, &block, &prev);
		2821
		2822	while (queue_get (&data))
		2823	process (data);
		2824
		2825	if (sigismember (&prev, SIGUSR1)
		2826	sigprocmask (SIG_UNBLOCK, &block, 0);
		2827	}
		2828
		2829	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2830	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2831	either...).
		2832
		2833	=item queueing from a thread context
		2834
		2835	The strategy for threads is different, as you cannot (easily) block
		2836	threads but you can easily preempt them, so to queue safely you need to
		2837	employ a traditional mutex lock, such as in this pthread example:
		2838
		2839	static ev_async mysig;
		2840	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2841
		2842	static void
		2843	otherthread (void)
		2844	{
		2845	// only need to lock the actual queueing operation
		2846	pthread_mutex_lock (&mymutex);
		2847	queue_put (data);
		2848	pthread_mutex_unlock (&mymutex);
		2849
		2850	ev_async_send (EV_DEFAULT_ &mysig);
		2851	}
		2852
		2853	static void
		2854	mysig_cb (EV_P_ ev_async *w, int revents)
		2855	{
		2856	pthread_mutex_lock (&mymutex);
		2857
		2858	while (queue_get (&data))
		2859	process (data);
		2860
		2861	pthread_mutex_unlock (&mymutex);
		2862	}
		2863
		2864	=back
		2865
		2866
		2867	=head3 Watcher-Specific Functions and Data Members
		2868
		2869	=over 4
		2870
		2871	=item ev_async_init (ev_async *, callback)
		2872
		2873	Initialises and configures the async watcher - it has no parameters of any
		2874	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
		2875	trust me.
		2876
		2877	=item ev_async_send (loop, ev_async *)
		2878
		2879	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		2880	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		2881	C<ev_feed_event>, this call is safe to do from other threads, signal or
		2882	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
		2883	section below on what exactly this means).
		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
		2890	This call incurs the overhead of a system call only once per event loop
		2891	iteration, so while the overhead might be noticeable, it doesn't apply to
		2892	repeated calls to C<ev_async_send> for the same event loop.
		2893
		2894	=item bool = ev_async_pending (ev_async *)
		2895
		2896	Returns a non-zero value when C<ev_async_send> has been called on the
		2897	watcher but the event has not yet been processed (or even noted) by the
		2898	event loop.
		2899
		2900	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2901	the loop iterates next and checks for the watcher to have become active,
		2902	it will reset the flag again. C<ev_async_pending> can be used to very
		2903	quickly check whether invoking the loop might be a good idea.
		2904
		2905	Not that this does I<not> check whether the watcher itself is 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.
		2909
		2910	=back
		2911
1299		2912
1300	=head1 OTHER FUNCTIONS	2913	=head1 OTHER FUNCTIONS
1301		2914
1302	There are some other functions of possible interest. Described. Here. Now.	2915	There are some other functions of possible interest. Described. Here. Now.
1303		2916
1304	=over 4	2917	=over 4
1305		2918
1306	=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)
1307		2920
1308	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
1309	callback on whichever event happens first and automatically stop both	2922	callback on whichever event happens first and automatically stops both
1310	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
1311	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
1312	more watchers yourself.	2925	more watchers yourself.
1313		2926
1314	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
1315	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
1316	C<events> set will be craeted and started.	2929	the given C<fd> and C<events> set will be created and started.
1317		2930
1318	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
1319	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
1320	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.
1321	dubious value.
1322		2934
1323	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
1324	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
1325	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>
1326	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.
1327		2941
		2942	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
		2943
1328	static void stdin_ready (int revents, void *arg)	2944	static void stdin_ready (int revents, void *arg)
1329	{	2945	{
1330	if (revents & EV_TIMEOUT)
1331	/* doh, nothing entered */;
1332	else if (revents & EV_READ)	2946	if (revents & EV_READ)
1333	/* 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 */;
1334	}	2950	}
1335		2951
1336	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2952	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
1337		2953
1338	=item ev_feed_event (ev_loop *, watcher *, int revents)	2954	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
1339		2955
1340	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
1341	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
1342	initialised but not necessarily started event watcher).	2958	initialised but not necessarily started event watcher).
1343		2959
1344	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2960	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
1345		2961
1346	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
1347	the given events it.	2963	the given events it.
1348		2964
1349	=item ev_feed_signal_event (ev_loop *loop, int signum)	2965	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
1350		2966
1351	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
1352	loop!).	2968	loop!).
1353		2969
1354	=back	2970	=back
1355		2971
1356		2972
…		…
1372		2988
1373	=item * Priorities are not currently supported. Initialising priorities	2989	=item * Priorities are not currently supported. Initialising priorities
1374	will fail and all watchers will have the same priority, even though there	2990	will fail and all watchers will have the same priority, even though there
1375	is an ev_pri field.	2991	is an ev_pri field.
1376		2992
		2993	=item * In libevent, the last base created gets the signals, in libev, the
		2994	first base created (== the default loop) gets the signals.
		2995
1377	=item * Other members are not supported.	2996	=item * Other members are not supported.
1378		2997
1379	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2998	=item * The libev emulation is I<not> ABI compatible to libevent, you need
1380	to use the libev header file and library.	2999	to use the libev header file and library.
1381		3000
1382	=back	3001	=back
1383		3002
1384	=head1 C++ SUPPORT	3003	=head1 C++ SUPPORT
1385		3004
1386	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
1387	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
1388	the callback model to a model using method callbacks on objects.	3007	the callback model to a model using method callbacks on objects.
1389		3008
1390	To use it,	3009	To use it,
1391		3010
1392	#include <ev++.h>	3011	#include <ev++.h>
1393		3012
1394	(it is not installed by default). This automatically includes F<ev.h>	3013	This automatically includes F<ev.h> and puts all of its definitions (many
1395	and puts all of its definitions (many of them macros) into the global	3014	of them macros) into the global namespace. All C++ specific things are
1396	namespace. All C++ specific things are put into the C<ev> namespace.	3015	put into the C<ev> namespace. It should support all the same embedding
		3016	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1397		3017
1398	It should support all the same embedding options as F<ev.h>, most notably	3018	Care has been taken to keep the overhead low. The only data member the C++
1399	C<EV_MULTIPLICITY>.	3019	classes add (compared to plain C-style watchers) is the event loop pointer
		3020	that the watcher is associated with (or no additional members at all if
		3021	you disable C<EV_MULTIPLICITY> when embedding libev).
		3022
		3023	Currently, functions, and static and non-static member functions can be
		3024	used as callbacks. Other types should be easy to add as long as they only
		3025	need one additional pointer for context. If you need support for other
		3026	types of functors please contact the author (preferably after implementing
		3027	it).
1400		3028
1401	Here is a list of things available in the C<ev> namespace:	3029	Here is a list of things available in the C<ev> namespace:
1402		3030
1403	=over 4	3031	=over 4
1404		3032
…		…
1420		3048
1421	All of those classes have these methods:	3049	All of those classes have these methods:
1422		3050
1423	=over 4	3051	=over 4
1424		3052
1425	=item ev::TYPE::TYPE (object *, object::method *)	3053	=item ev::TYPE::TYPE ()
1426		3054
1427	=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)	3055	=item ev::TYPE::TYPE (struct ev_loop *)
1428		3056
1429	=item ev::TYPE::~TYPE	3057	=item ev::TYPE::~TYPE
1430		3058
1431	The constructor takes a pointer to an object and a method pointer to	3059	The constructor (optionally) takes an event loop to associate the watcher
1432	the event handler callback to call in this class. The constructor calls	3060	with. If it is omitted, it will use C<EV_DEFAULT>.
1433	C<ev_init> for you, which means you have to call the C<set> method	3061
1434	before starting it. If you do not specify a loop then the constructor	3062	The constructor calls C<ev_init> for you, which means you have to call the
1435	automatically associates the default loop with this watcher.	3063	C<set> method before starting it.
		3064
		3065	It will not set a callback, however: You have to call the templated C<set>
		3066	method to set a callback before you can start the watcher.
		3067
		3068	(The reason why you have to use a method is a limitation in C++ which does
		3069	not allow explicit template arguments for constructors).
1436		3070
1437	The destructor automatically stops the watcher if it is active.	3071	The destructor automatically stops the watcher if it is active.
		3072
		3073	=item w->set<class, &class::method> (object *)
		3074
		3075	This method sets the callback method to call. The method has to have a
		3076	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		3077	first argument and the C<revents> as second. The object must be given as
		3078	parameter and is stored in the C<data> member of the watcher.
		3079
		3080	This method synthesizes efficient thunking code to call your method from
		3081	the C callback that libev requires. If your compiler can inline your
		3082	callback (i.e. it is visible to it at the place of the C<set> call and
		3083	your compiler is good :), then the method will be fully inlined into the
		3084	thunking function, making it as fast as a direct C callback.
		3085
		3086	Example: simple class declaration and watcher initialisation
		3087
		3088	struct myclass
		3089	{
		3090	void io_cb (ev::io &w, int revents) { }
		3091	}
		3092
		3093	myclass obj;
		3094	ev::io iow;
		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);
		3126
		3127	=item w->set<function> (void *data = 0)
		3128
		3129	Also sets a callback, but uses a static method or plain function as
		3130	callback. The optional C<data> argument will be stored in the watcher's
		3131	C<data> member and is free for you to use.
		3132
		3133	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		3134
		3135	See the method-C<set> above for more details.
		3136
		3137	Example: Use a plain function as callback.
		3138
		3139	static void io_cb (ev::io &w, int revents) { }
		3140	iow.set <io_cb> ();
1438		3141
1439	=item w->set (struct ev_loop *)	3142	=item w->set (struct ev_loop *)
1440		3143
1441	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
1442	do this when the watcher is inactive (and not pending either).	3145	do this when the watcher is inactive (and not pending either).
1443		3146
1444	=item w->set ([args])	3147	=item w->set ([arguments])
1445		3148
1446	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
1447	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
1448	automatically stopped and restarted.	3151	automatically stopped and restarted when reconfiguring it with this
		3152	method.
1449		3153
1450	=item w->start ()	3154	=item w->start ()
1451		3155
1452	Starts the watcher. Note that there is no C<loop> argument as the	3156	Starts the watcher. Note that there is no C<loop> argument, as the
1453	constructor already takes the loop.	3157	constructor already stores the event loop.
1454		3158
1455	=item w->stop ()	3159	=item w->stop ()
1456		3160
1457	Stops the watcher if it is active. Again, no C<loop> argument.	3161	Stops the watcher if it is active. Again, no C<loop> argument.
1458		3162
1459	=item w->again () C<ev::timer>, C<ev::periodic> only	3163	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1460		3164
1461	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	3165	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1462	C<ev_TYPE_again> function.	3166	C<ev_TYPE_again> function.
1463		3167
1464	=item w->sweep () C<ev::embed> only	3168	=item w->sweep () (C<ev::embed> only)
1465		3169
1466	Invokes C<ev_embed_sweep>.	3170	Invokes C<ev_embed_sweep>.
		3171
		3172	=item w->update () (C<ev::stat> only)
		3173
		3174	Invokes C<ev_stat_stat>.
1467		3175
1468	=back	3176	=back
1469		3177
1470	=back	3178	=back
1471		3179
1472	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
1473	the constructor.	3181	the constructor.
1474		3182
1475	class myclass	3183	class myclass
1476	{	3184	{
1477	ev_io io; void io_cb (ev::io &w, int revents);	3185	ev::io io ; void io_cb (ev::io &w, int revents);
1478	ev_idle idle void idle_cb (ev::idle &w, int revents);	3186	ev::idle idle; void idle_cb (ev::idle &w, int revents);
1479		3187
1480	myclass ();	3188	myclass (int fd)
1481	}	3189	{
		3190	io .set <myclass, &myclass::io_cb > (this);
		3191	idle.set <myclass, &myclass::idle_cb> (this);
1482		3192
1483	myclass::myclass (int fd)
1484	: io (this, &myclass::io_cb),
1485	idle (this, &myclass::idle_cb)
1486	{
1487	io.start (fd, ev::READ);	3193	io.start (fd, ev::READ);
		3194	}
		3195	};
		3196
		3197
		3198	=head1 OTHER LANGUAGE BINDINGS
		3199
		3200	Libev does not offer other language bindings itself, but bindings for a
		3201	number of languages exist in the form of third-party packages. If you know
		3202	any interesting language binding in addition to the ones listed here, drop
		3203	me a note.
		3204
		3205	=over 4
		3206
		3207	=item Perl
		3208
		3209	The EV module implements the full libev API and is actually used to test
		3210	libev. EV is developed together with libev. Apart from the EV core module,
		3211	there are additional modules that implement libev-compatible interfaces
		3212	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
		3213	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3214	and C<EV::Glib>).
		3215
		3216	It can be found and installed via CPAN, its homepage is at
		3217	L<http://software.schmorp.de/pkg/EV>.
		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
		3224	=item Ruby
		3225
		3226	Tony Arcieri has written a ruby extension that offers access to a subset
		3227	of the libev API and adds file handle abstractions, asynchronous DNS and
		3228	more on top of it. It can be found via gem servers. Its homepage is at
		3229	L<http://rev.rubyforge.org/>.
		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
		3239	=item D
		3240
		3241	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		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/>.
		3248
		3249	=back
		3250
		3251
		3252	=head1 MACRO MAGIC
		3253
		3254	Libev can be compiled with a variety of options, the most fundamental
		3255	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
		3256	functions and callbacks have an initial C<struct ev_loop *> argument.
		3257
		3258	To make it easier to write programs that cope with either variant, the
		3259	following macros are defined:
		3260
		3261	=over 4
		3262
		3263	=item C<EV_A>, C<EV_A_>
		3264
		3265	This provides the loop I<argument> for functions, if one is required ("ev
		3266	loop argument"). The C<EV_A> form is used when this is the sole argument,
		3267	C<EV_A_> is used when other arguments are following. Example:
		3268
		3269	ev_unref (EV_A);
		3270	ev_timer_add (EV_A_ watcher);
		3271	ev_loop (EV_A_ 0);
		3272
		3273	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		3274	which is often provided by the following macro.
		3275
		3276	=item C<EV_P>, C<EV_P_>
		3277
		3278	This provides the loop I<parameter> for functions, if one is required ("ev
		3279	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		3280	C<EV_P_> is used when other parameters are following. Example:
		3281
		3282	// this is how ev_unref is being declared
		3283	static void ev_unref (EV_P);
		3284
		3285	// this is how you can declare your typical callback
		3286	static void cb (EV_P_ ev_timer *w, int revents)
		3287
		3288	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		3289	suitable for use with C<EV_A>.
		3290
		3291	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		3292
		3293	Similar to the other two macros, this gives you the value of the default
		3294	loop, if multiple loops are supported ("ev loop default").
		3295
		3296	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		3297
		3298	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		3299	default loop has been initialised (C<UC> == unchecked). Their behaviour
		3300	is undefined when the default loop has not been initialised by a previous
		3301	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		3302
		3303	It is often prudent to use C<EV_DEFAULT> when initialising the first
		3304	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
		3305
		3306	=back
		3307
		3308	Example: Declare and initialise a check watcher, utilising the above
		3309	macros so it will work regardless of whether multiple loops are supported
		3310	or not.
		3311
		3312	static void
		3313	check_cb (EV_P_ ev_timer *w, int revents)
		3314	{
		3315	ev_check_stop (EV_A_ w);
1488	}	3316	}
		3317
		3318	ev_check check;
		3319	ev_check_init (&check, check_cb);
		3320	ev_check_start (EV_DEFAULT_ &check);
		3321	ev_loop (EV_DEFAULT_ 0);
1489		3322
1490	=head1 EMBEDDING	3323	=head1 EMBEDDING
1491		3324
1492	Libev can (and often is) directly embedded into host	3325	Libev can (and often is) directly embedded into host
1493	applications. Examples of applications that embed it include the Deliantra	3326	applications. Examples of applications that embed it include the Deliantra
1494	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)	3327	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1495	and rxvt-unicode.	3328	and rxvt-unicode.
1496		3329
1497	The goal is to enable you to just copy the neecssary files into your	3330	The goal is to enable you to just copy the necessary files into your
1498	source directory without having to change even a single line in them, so	3331	source directory without having to change even a single line in them, so
1499	you can easily upgrade by simply copying (or having a checked-out copy of	3332	you can easily upgrade by simply copying (or having a checked-out copy of
1500	libev somewhere in your source tree).	3333	libev somewhere in your source tree).
1501		3334
1502	=head2 FILESETS	3335	=head2 FILESETS
1503		3336
1504	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
1505	in your app.	3338	in your application.
1506		3339
1507	=head3 CORE EVENT LOOP	3340	=head3 CORE EVENT LOOP
1508		3341
1509	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
1510	configuration (no autoconf):	3343	configuration (no autoconf):
1511		3344
1512	#define EV_STANDALONE 1	3345	#define EV_STANDALONE 1
1513	#include "ev.c"	3346	#include "ev.c"
1514		3347
1515	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
1516	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
1517	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
1518	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
1519	where you can put other configuration options):	3352	where you can put other configuration options):
1520		3353
1521	#define EV_STANDALONE 1	3354	#define EV_STANDALONE 1
1522	#include "ev.h"	3355	#include "ev.h"
1523		3356
1524	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++
1525	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
1526	as a bug).	3359	as a bug).
1527		3360
1528	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
1529	in your include path (e.g. in libev/ when using -Ilibev):	3362	in your include path (e.g. in libev/ when using -Ilibev):
1530		3363
1531	ev.h	3364	ev.h
1532	ev.c	3365	ev.c
1533	ev_vars.h	3366	ev_vars.h
1534	ev_wrap.h	3367	ev_wrap.h
1535		3368
1536	ev_win32.c required on win32 platforms only	3369	ev_win32.c required on win32 platforms only
1537		3370
1538	ev_select.c only when select backend is enabled (which is by default)	3371	ev_select.c only when select backend is enabled (which is enabled by default)
1539	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)
1540	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)
1541	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)
1542	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)
1543		3376
1544	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
1545	to compile this single file.	3378	to compile this single file.
1546		3379
1547	=head3 LIBEVENT COMPATIBILITY API	3380	=head3 LIBEVENT COMPATIBILITY API
1548		3381
1549	To include the libevent compatibility API, also include:	3382	To include the libevent compatibility API, also include:
1550		3383
1551	#include "event.c"	3384	#include "event.c"
1552		3385
1553	in the file including F<ev.c>, and:	3386	in the file including F<ev.c>, and:
1554		3387
1555	#include "event.h"	3388	#include "event.h"
1556		3389
1557	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>.
1558		3391
1559	You need the following additional files for this:	3392	You need the following additional files for this:
1560		3393
1561	event.h	3394	event.h
1562	event.c	3395	event.c
1563		3396
1564	=head3 AUTOCONF SUPPORT	3397	=head3 AUTOCONF SUPPORT
1565		3398
1566	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
1567	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
1568	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
1569	include F<config.h> and configure itself accordingly.	3402	include F<config.h> and configure itself accordingly.
1570		3403
1571	For this of course you need the m4 file:	3404	For this of course you need the m4 file:
1572		3405
1573	libev.m4	3406	libev.m4
1574		3407
1575	=head2 PREPROCESSOR SYMBOLS/MACROS	3408	=head2 PREPROCESSOR SYMBOLS/MACROS
1576		3409
1577	Libev can be configured via a variety of preprocessor symbols you have to define	3410	Libev can be configured via a variety of preprocessor symbols you have to
1578	before including any of its files. The default is not to build for multiplicity	3411	define before including any of its files. The default in the absence of
1579	and only include the select backend.	3412	autoconf is documented for every option.
1580		3413
1581	=over 4	3414	=over 4
1582		3415
1583	=item EV_STANDALONE	3416	=item EV_STANDALONE
1584		3417
…		…
1586	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
1587	implementations for some libevent functions (such as logging, which is not	3420	implementations for some libevent functions (such as logging, which is not
1588	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
1589	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.
1590		3423
		3424	In stanbdalone mode, libev will still try to automatically deduce the
		3425	configuration, but has to be more conservative.
		3426
1591	=item EV_USE_MONOTONIC	3427	=item EV_USE_MONOTONIC
1592		3428
1593	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
1594	monotonic clock option at both compiletime and runtime. Otherwise no use	3430	monotonic clock option at both compile time and runtime. Otherwise no
1595	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,
1596	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
1597	the functionality isn't available is safe, though, althoguh you have	3433	when the functionality isn't available is safe, though, although you have
1598	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>
1599	function is hiding in (often F<-lrt>).	3435	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
1600		3436
1601	=item EV_USE_REALTIME	3437	=item EV_USE_REALTIME
1602		3438
1603	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
1604	realtime clock option at compiletime (and assume its availability at	3440	real-time clock option at compile time (and assume its availability
1605	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
1606	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3442	option will be attempted. This effectively replaces C<gettimeofday>
1607	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries	3443	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
1608	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>).
		3458
		3459	=item EV_USE_NANOSLEEP
		3460
		3461	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
		3462	and will use it for delays. Otherwise it will use C<select ()>.
		3463
		3464	=item EV_USE_EVENTFD
		3465
		3466	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		3467	available and will probe for kernel support at runtime. This will improve
		3468	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		3469	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		3470	2.7 or newer, otherwise disabled.
1609		3471
1610	=item EV_USE_SELECT	3472	=item EV_USE_SELECT
1611		3473
1612	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
1613	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
1614	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
1615	will not be compiled in.	3477	will not be compiled in.
1616		3478
1617	=item EV_SELECT_USE_FD_SET	3479	=item EV_SELECT_USE_FD_SET
1618		3480
1619	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>
1620	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
1621	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
1622	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
1623	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
1624	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,
1625	influence the size of the C<fd_set> used.	3487	configures the maximum size of the C<fd_set>.
1626		3488
1627	=item EV_SELECT_IS_WINSOCKET	3489	=item EV_SELECT_IS_WINSOCKET
1628		3490
1629	When defined to C<1>, the select backend will assume that	3491	When defined to C<1>, the select backend will assume that
1630	select/socket/connect etc. don't understand file descriptors but	3492	select/socket/connect etc. don't understand file descriptors but
…		…
1632	be used is the winsock select). This means that it will call	3494	be used is the winsock select). This means that it will call
1633	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	3495	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
1634	it is assumed that all these functions actually work on fds, even	3496	it is assumed that all these functions actually work on fds, even
1635	on win32. Should not be defined on non-win32 platforms.	3497	on win32. Should not be defined on non-win32 platforms.
1636		3498
		3499	=item EV_FD_TO_WIN32_HANDLE
		3500
		3501	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
		3502	file descriptors to socket handles. When not defining this symbol (the
		3503	default), then libev will call C<_get_osfhandle>, which is usually
		3504	correct. In some cases, programs use their own file descriptor management,
		3505	in which case they can provide this function to map fds to socket handles.
		3506
1637	=item EV_USE_POLL	3507	=item EV_USE_POLL
1638		3508
1639	If defined to be C<1>, libev will compile in support for the C<poll>(2)	3509	If defined to be C<1>, libev will compile in support for the C<poll>(2)
1640	backend. Otherwise it will be enabled on non-win32 platforms. It	3510	backend. Otherwise it will be enabled on non-win32 platforms. It
1641	takes precedence over select.	3511	takes precedence over select.
1642		3512
1643	=item EV_USE_EPOLL	3513	=item EV_USE_EPOLL
1644		3514
1645	If defined to be C<1>, libev will compile in support for the Linux	3515	If defined to be C<1>, libev will compile in support for the Linux
1646	C<epoll>(7) backend. Its availability will be detected at runtime,	3516	C<epoll>(7) backend. Its availability will be detected at runtime,
1647	otherwise another method will be used as fallback. This is the	3517	otherwise another method will be used as fallback. This is the preferred
1648	preferred backend for GNU/Linux systems.	3518	backend for GNU/Linux systems. If undefined, it will be enabled if the
		3519	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
1649		3520
1650	=item EV_USE_KQUEUE	3521	=item EV_USE_KQUEUE
1651		3522
1652	If defined to be C<1>, libev will compile in support for the BSD style	3523	If defined to be C<1>, libev will compile in support for the BSD style
1653	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	3524	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
1666	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
1667	backend for Solaris 10 systems.	3538	backend for Solaris 10 systems.
1668		3539
1669	=item EV_USE_DEVPOLL	3540	=item EV_USE_DEVPOLL
1670		3541
1671	reserved for future expansion, works like the USE symbols above.	3542	Reserved for future expansion, works like the USE symbols above.
		3543
		3544	=item EV_USE_INOTIFY
		3545
		3546	If defined to be C<1>, libev will compile in support for the Linux inotify
		3547	interface to speed up C<ev_stat> watchers. Its actual availability will
		3548	be detected at runtime. If undefined, it will be enabled if the headers
		3549	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		3550
		3551	=item EV_ATOMIC_T
		3552
		3553	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		3554	access is atomic with respect to other threads or signal contexts. No such
		3555	type is easily found in the C language, so you can provide your own type
		3556	that you know is safe for your purposes. It is used both for signal handler "locking"
		3557	as well as for signal and thread safety in C<ev_async> watchers.
		3558
		3559	In the absence of this define, libev will use C<sig_atomic_t volatile>
		3560	(from F<signal.h>), which is usually good enough on most platforms.
1672		3561
1673	=item EV_H	3562	=item EV_H
1674		3563
1675	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
1676	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	3565	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
1677	can be used to virtually rename the F<ev.h> header file in case of conflicts.	3566	used to virtually rename the F<ev.h> header file in case of conflicts.
1678		3567
1679	=item EV_CONFIG_H	3568	=item EV_CONFIG_H
1680		3569
1681	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	3570	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
1682	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	3571	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
1683	C<EV_H>, above.	3572	C<EV_H>, above.
1684		3573
1685	=item EV_EVENT_H	3574	=item EV_EVENT_H
1686		3575
1687	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	3576	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
1688	of how the F<event.h> header can be found.	3577	of how the F<event.h> header can be found, the default is C<"event.h">.
1689		3578
1690	=item EV_PROTOTYPES	3579	=item EV_PROTOTYPES
1691		3580
1692	If defined to be C<0>, then F<ev.h> will not define any function	3581	If defined to be C<0>, then F<ev.h> will not define any function
1693	prototypes, but still define all the structs and other symbols. This is	3582	prototypes, but still define all the structs and other symbols. This is
…		…
1700	will have the C<struct ev_loop *> as first argument, and you can create	3589	will have the C<struct ev_loop *> as first argument, and you can create
1701	additional independent event loops. Otherwise there will be no support	3590	additional independent event loops. Otherwise there will be no support
1702	for multiple event loops and there is no first event loop pointer	3591	for multiple event loops and there is no first event loop pointer
1703	argument. Instead, all functions act on the single default loop.	3592	argument. Instead, all functions act on the single default loop.
1704		3593
		3594	=item EV_MINPRI
		3595
		3596	=item EV_MAXPRI
		3597
		3598	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		3599	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		3600	provide for more priorities by overriding those symbols (usually defined
		3601	to be C<-2> and C<2>, respectively).
		3602
		3603	When doing priority-based operations, libev usually has to linearly search
		3604	all the priorities, so having many of them (hundreds) uses a lot of space
		3605	and time, so using the defaults of five priorities (-2 .. +2) is usually
		3606	fine.
		3607
		3608	If your embedding application does not need any priorities, defining these
		3609	both to C<0> will save some memory and CPU.
		3610
1705	=item EV_PERIODICS	3611	=item EV_PERIODIC_ENABLE
1706		3612
1707	If undefined or defined to be C<1>, then periodic timers are supported,	3613	If undefined or defined to be C<1>, then periodic timers are supported. If
1708	otherwise not. This saves a few kb of code.	3614	defined to be C<0>, then they are not. Disabling them saves a few kB of
		3615	code.
		3616
		3617	=item EV_IDLE_ENABLE
		3618
		3619	If undefined or defined to be C<1>, then idle watchers are supported. If
		3620	defined to be C<0>, then they are not. Disabling them saves a few kB of
		3621	code.
		3622
		3623	=item EV_EMBED_ENABLE
		3624
		3625	If undefined or defined to be C<1>, then embed watchers are supported. If
		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.
		3628
		3629	=item EV_STAT_ENABLE
		3630
		3631	If undefined or defined to be C<1>, then stat watchers are supported. If
		3632	defined to be C<0>, then they are not.
		3633
		3634	=item EV_FORK_ENABLE
		3635
		3636	If undefined or defined to be C<1>, then fork watchers are supported. If
		3637	defined to be C<0>, then they are not.
		3638
		3639	=item EV_ASYNC_ENABLE
		3640
		3641	If undefined or defined to be C<1>, then async watchers are supported. If
		3642	defined to be C<0>, then they are not.
		3643
		3644	=item EV_MINIMAL
		3645
		3646	If you need to shave off some kilobytes of code at the expense of some
		3647	speed, define this symbol to C<1>. Currently this is used to override some
		3648	inlining decisions, saves roughly 30% code size on amd64. It also selects a
		3649	much smaller 2-heap for timer management over the default 4-heap.
		3650
		3651	=item EV_PID_HASHSIZE
		3652
		3653	C<ev_child> watchers use a small hash table to distribute workload by
		3654	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		3655	than enough. If you need to manage thousands of children you might want to
		3656	increase this value (I<must> be a power of two).
		3657
		3658	=item EV_INOTIFY_HASHSIZE
		3659
		3660	C<ev_stat> watchers use a small hash table to distribute workload by
		3661	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		3662	usually more than enough. If you need to manage thousands of C<ev_stat>
		3663	watchers you might want to increase this value (I<must> be a power of
		3664	two).
		3665
		3666	=item EV_USE_4HEAP
		3667
		3668	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3669	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
		3670	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
		3671	faster performance with many (thousands) of watchers.
		3672
		3673	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3674	(disabled).
		3675
		3676	=item EV_HEAP_CACHE_AT
		3677
		3678	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3679	timer and periodics heaps, libev can cache the timestamp (I<at>) within
		3680	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3681	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3682	but avoids random read accesses on heap changes. This improves performance
		3683	noticeably with many (hundreds) of watchers.
		3684
		3685	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		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>.
1709		3700
1710	=item EV_COMMON	3701	=item EV_COMMON
1711		3702
1712	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
1713	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
1714	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,
1715	though, and it must be identical each time.	3706	though, and it must be identical each time.
1716		3707
1717	For example, the perl EV module uses something like this:	3708	For example, the perl EV module uses something like this:
1718		3709
1719	#define EV_COMMON \	3710	#define EV_COMMON \
1720	SV *self; /* contains this struct */ \	3711	SV *self; /* contains this struct */ \
1721	SV *cb_sv, *fh /* note no trailing ";" */	3712	SV *cb_sv, *fh /* note no trailing ";" */
1722		3713
1723	=item EV_CB_DECLARE (type)	3714	=item EV_CB_DECLARE (type)
1724		3715
1725	=item EV_CB_INVOKE (watcher, revents)	3716	=item EV_CB_INVOKE (watcher, revents)
1726		3717
1727	=item ev_set_cb (ev, cb)	3718	=item ev_set_cb (ev, cb)
1728		3719
1729	Can be used to change the callback member declaration in each watcher,	3720	Can be used to change the callback member declaration in each watcher,
1730	and the way callbacks are invoked and set. Must expand to a struct member	3721	and the way callbacks are invoked and set. Must expand to a struct member
1731	definition and a statement, respectively. See the F<ev.v> header file for	3722	definition and a statement, respectively. See the F<ev.h> header file for
1732	their default definitions. One possible use for overriding these is to	3723	their default definitions. One possible use for overriding these is to
1733	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
1734	method calls instead of plain function calls in C++.	3725	method calls instead of plain function calls in C++.
		3726
		3727	=back
		3728
		3729	=head2 EXPORTED API SYMBOLS
		3730
		3731	If you need to re-export the API (e.g. via a DLL) and you need a list of
		3732	exported symbols, you can use the provided F<Symbol.*> files which list
		3733	all public symbols, one per line:
		3734
		3735	Symbols.ev for libev proper
		3736	Symbols.event for the libevent emulation
		3737
		3738	This can also be used to rename all public symbols to avoid clashes with
		3739	multiple versions of libev linked together (which is obviously bad in
		3740	itself, but sometimes it is inconvenient to avoid this).
		3741
		3742	A sed command like this will create wrapper C<#define>'s that you need to
		3743	include before including F<ev.h>:
		3744
		3745	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
		3746
		3747	This would create a file F<wrap.h> which essentially looks like this:
		3748
		3749	#define ev_backend myprefix_ev_backend
		3750	#define ev_check_start myprefix_ev_check_start
		3751	#define ev_check_stop myprefix_ev_check_stop
		3752	...
1735		3753
1736	=head2 EXAMPLES	3754	=head2 EXAMPLES
1737		3755
1738	For a real-world example of a program the includes libev	3756	For a real-world example of a program the includes libev
1739	verbatim, you can have a look at the EV perl module	3757	verbatim, you can have a look at the EV perl module
…		…
1742	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	3760	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
1743	will be compiled. It is pretty complex because it provides its own header	3761	will be compiled. It is pretty complex because it provides its own header
1744	file.	3762	file.
1745		3763
1746	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
1747	that everybody includes and which overrides some autoconf choices:	3765	that everybody includes and which overrides some configure choices:
1748		3766
		3767	#define EV_MINIMAL 1
1749	#define EV_USE_POLL 0	3768	#define EV_USE_POLL 0
1750	#define EV_MULTIPLICITY 0	3769	#define EV_MULTIPLICITY 0
1751	#define EV_PERIODICS 0	3770	#define EV_PERIODIC_ENABLE 0
		3771	#define EV_STAT_ENABLE 0
		3772	#define EV_FORK_ENABLE 0
1752	#define EV_CONFIG_H <config.h>	3773	#define EV_CONFIG_H <config.h>
		3774	#define EV_MINPRI 0
		3775	#define EV_MAXPRI 0
1753		3776
1754	#include "ev++.h"	3777	#include "ev++.h"
1755		3778
1756	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:
1757		3780
1758	#include "ev_cpp.h"	3781	#include "ev_cpp.h"
1759	#include "ev.c"	3782	#include "ev.c"
1760		3783
		3784	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
1761		3785
		3786	=head2 THREADS AND COROUTINES
		3787
		3788	=head3 THREADS
		3789
		3790	All libev functions are reentrant and thread-safe unless explicitly
		3791	documented otherwise, but libev implements no locking itself. This means
		3792	that you can use as many loops as you want in parallel, as long as there
		3793	are no concurrent calls into any libev function with the same loop
		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.
		3797
		3798	Or to put it differently: calls with different loop parameters can be done
		3799	concurrently from multiple threads, calls with the same loop parameter
		3800	must be done serially (but can be done from different threads, as long as
		3801	only one thread ever is inside a call at any point in time, e.g. by using
		3802	a mutex per loop).
		3803
		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
		3811	help you, but here is some generic advice:
		3812
		3813	=over 4
		3814
		3815	=item * most applications have a main thread: use the default libev loop
		3816	in that thread, or create a separate thread running only the default loop.
		3817
		3818	This helps integrating other libraries or software modules that use libev
		3819	themselves and don't care/know about threading.
		3820
		3821	=item * one loop per thread is usually a good model.
		3822
		3823	Doing this is almost never wrong, sometimes a better-performance model
		3824	exists, but it is always a good start.
		3825
		3826	=item * other models exist, such as the leader/follower pattern, where one
		3827	loop is handed through multiple threads in a kind of round-robin fashion.
		3828
		3829	Choosing a model is hard - look around, learn, know that usually you can do
		3830	better than you currently do :-)
		3831
		3832	=item * often you need to talk to some other thread which blocks in the
		3833	event loop.
		3834
		3835	C<ev_async> watchers can be used to wake them up from other threads safely
		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.
		3842
		3843	=back
		3844
		3845	=head3 COROUTINES
		3846
		3847	Libev is very accommodating to coroutines ("cooperative threads"):
		3848	libev fully supports nesting calls to its functions from different
		3849	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3850	different coroutines, and switch freely between both coroutines running the
		3851	loop, as long as you don't confuse yourself). The only exception is that
		3852	you must not do this from C<ev_periodic> reschedule callbacks.
		3853
		3854	Care has been taken to ensure that libev does not keep local state inside
		3855	C<ev_loop>, and other calls do not usually allow for coroutine switches as
		3856	they do not call any callbacks.
		3857
		3858	=head2 COMPILER WARNINGS
		3859
		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.
		3863
		3864	However, these are unavoidable for many reasons. For one, each compiler
		3865	has different warnings, and each user has different tastes regarding
		3866	warning options. "Warn-free" code therefore cannot be a goal except when
		3867	targeting a specific compiler and compiler-version.
		3868
		3869	Another reason is that some compiler warnings require elaborate
		3870	workarounds, or other changes to the code that make it less clear and less
		3871	maintainable.
		3872
		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.
		3879
		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.
		3885
		3886
		3887	=head2 VALGRIND
		3888
		3889	Valgrind has a special section here because it is a popular tool that is
		3890	highly useful. Unfortunately, valgrind reports are very hard to interpret.
		3891
		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:
		3894
		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.
		3898
		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.
		3901
		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.
		3906
		3907	Keep in mind that valgrind is a very good tool, but only a tool. Don't
		3908	make it into some kind of religion.
		3909
		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.
		3915
		3916	If you need, for some reason, empty reports from valgrind for your project
		3917	I suggest using suppression lists.
		3918
		3919
		3920	=head1 PORTABILITY NOTES
		3921
		3922	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		3923
		3924	Win32 doesn't support any of the standards (e.g. POSIX) that libev
		3925	requires, and its I/O model is fundamentally incompatible with the POSIX
		3926	model. Libev still offers limited functionality on this platform in
		3927	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
		3928	descriptors. This only applies when using Win32 natively, not when using
		3929	e.g. cygwin.
		3930
		3931	Lifting these limitations would basically require the full
		3932	re-implementation of the I/O system. If you are into these kinds of
		3933	things, then note that glib does exactly that for you in a very portable
		3934	way (note also that glib is the slowest event library known to man).
		3935
		3936	There is no supported compilation method available on windows except
		3937	embedding it into other applications.
		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
		3946	Due to the many, low, and arbitrary limits on the win32 platform and
		3947	the abysmal performance of winsockets, using a large number of sockets
		3948	is not recommended (and not reasonable). If your program needs to use
		3949	more than a hundred or so sockets, then likely it needs to use a totally
		3950	different implementation for windows, as libev offers the POSIX readiness
		3951	notification model, which cannot be implemented efficiently on windows
		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"
		3968
		3969	=over 4
		3970
		3971	=item The winsocket select function
		3972
		3973	The winsocket C<select> function doesn't follow POSIX in that it
		3974	requires socket I<handles> and not socket I<file descriptors> (it is
		3975	also extremely buggy). This makes select very inefficient, and also
		3976	requires a mapping from file descriptors to socket handles (the Microsoft
		3977	C runtime provides the function C<_open_osfhandle> for this). See the
		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.
		3980
		3981	The configuration for a "naked" win32 using the Microsoft runtime
		3982	libraries and raw winsocket select is:
		3983
		3984	#define EV_USE_SELECT 1
		3985	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
		3986
		3987	Note that winsockets handling of fd sets is O(n), so you can easily get a
		3988	complexity in the O(n²) range when using win32.
		3989
		3990	=item Limited number of file descriptors
		3991
		3992	Windows has numerous arbitrary (and low) limits on things.
		3993
		3994	Early versions of winsocket's select only supported waiting for a maximum
		3995	of C<64> handles (probably owning to the fact that all windows kernels
		3996	can only wait for C<64> things at the same time internally; Microsoft
		3997	recommends spawning a chain of threads and wait for 63 handles and the
		3998	previous thread in each. Great).
		3999
		4000	Newer versions support more handles, but you need to define C<FD_SETSIZE>
		4001	to some high number (e.g. C<2048>) before compiling the winsocket select
		4002	call (which might be in libev or elsewhere, for example, perl does its own
		4003	select emulation on windows).
		4004
		4005	Another limit is the number of file descriptors in the Microsoft runtime
		4006	libraries, which by default is C<64> (there must be a hidden I<64> fetish
		4007	or something like this inside Microsoft). You can increase this by calling
		4008	C<_setmaxstdio>, which can increase this limit to C<2048> (another
		4009	arbitrary limit), but is broken in many versions of the Microsoft runtime
		4010	libraries.
		4011
		4012	This might get you to about C<512> or C<2048> sockets (depending on
		4013	windows version and/or the phase of the moon). To get more, you need to
		4014	wrap all I/O functions and provide your own fd management, but the cost of
		4015	calling select (O(n²)) will likely make this unworkable.
		4016
		4017	=back
		4018
		4019	=head2 PORTABILITY REQUIREMENTS
		4020
		4021	In addition to a working ISO-C implementation and of course the
		4022	backend-specific APIs, libev relies on a few additional extensions:
		4023
		4024	=over 4
		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
		4035	=item C<sig_atomic_t volatile> must be thread-atomic as well
		4036
		4037	The type C<sig_atomic_t volatile> (or whatever is defined as
		4038	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
		4039	threads. This is not part of the specification for C<sig_atomic_t>, but is
		4040	believed to be sufficiently portable.
		4041
		4042	=item C<sigprocmask> must work in a threaded environment
		4043
		4044	Libev uses C<sigprocmask> to temporarily block signals. This is not
		4045	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		4046	pthread implementations will either allow C<sigprocmask> in the "main
		4047	thread" or will block signals process-wide, both behaviours would
		4048	be compatible with libev. Interaction between C<sigprocmask> and
		4049	C<pthread_sigmask> could complicate things, however.
		4050
		4051	The most portable way to handle signals is to block signals in all threads
		4052	except the initial one, and run the default loop in the initial thread as
		4053	well.
		4054
		4055	=item C<long> must be large enough for common memory allocation sizes
		4056
		4057	To improve portability and simplify its API, libev uses C<long> internally
		4058	instead of C<size_t> when allocating its data structures. On non-POSIX
		4059	systems (Microsoft...) this might be unexpectedly low, but is still at
		4060	least 31 bits everywhere, which is enough for hundreds of millions of
		4061	watchers.
		4062
		4063	=item C<double> must hold a time value in seconds with enough accuracy
		4064
		4065	The type C<double> is used to represent timestamps. It is required to
		4066	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		4067	enough for at least into the year 4000. This requirement is fulfilled by
		4068	implementations implementing IEEE 754 (basically all existing ones).
		4069
		4070	=back
		4071
		4072	If you know of other additional requirements drop me a note.
		4073
		4074
1762	=head1 COMPLEXITIES	4075	=head1 ALGORITHMIC COMPLEXITIES
1763		4076
1764	In this section the complexities of (many of) the algorithms used inside	4077	In this section the complexities of (many of) the algorithms used inside
1765	libev will be explained. For complexity discussions about backends see the	4078	libev will be documented. For complexity discussions about backends see
1766	documentation for C<ev_default_init>.	4079	the documentation for C<ev_default_init>.
		4080
		4081	All of the following are about amortised time: If an array needs to be
		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.
1767		4086
1768	=over 4	4087	=over 4
1769		4088
1770	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	4089	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
1771		4090
		4091	This means that, when you have a watcher that triggers in one hour and
		4092	there are 100 watchers that would trigger before that, then inserting will
		4093	have to skip roughly seven (C<ld 100>) of these watchers.
		4094
1772	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	4095	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
1773		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
1774	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	4100	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
1775		4101
		4102	These just add the watcher into an array or at the head of a list.
		4103
1776	=item Stopping check/prepare/idle watchers: O(1)	4104	=item Stopping check/prepare/idle/fork/async watchers: O(1)
1777		4105
1778	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	4106	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
1779		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
1780	=item Finding the next timer per loop iteration: O(1)	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.
1781		4117
1782	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	4118	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
1783		4119
1784	=item Activating one watcher: O(1)	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.
1785		4142
1786	=back	4143	=back
1787		4144
1788		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
		4221
1789	=head1 AUTHOR	4222	=head1 AUTHOR
1790		4223
1791	Marc Lehmann <libev@schmorp.de>.	4224	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
1792		4225

Diff Legend

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