ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.215 by root, Wed Nov 5 21:44:21 2008 UTC

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

Diff Legend

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