ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.307 by root, Thu Oct 21 02:33:08 2010 UTC

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

Diff Legend

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