ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.160 by root, Thu May 22 03:06:58 2008 UTC vs.
Revision 1.276 by root, Tue Dec 29 13:11:00 2009 UTC

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

Diff Legend

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