ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.131 by root, Tue Feb 19 17:09:28 2008 UTC vs.
Revision 1.226 by root, Wed Mar 4 12:51:37 2009 UTC

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

Diff Legend

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