ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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