ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.134 by root, Sat Mar 8 07:04:56 2008 UTC vs.
Revision 1.189 by root, Tue Sep 30 19:33:33 2008 UTC

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

Diff Legend

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