ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.58 by root, Wed Nov 28 11:31:34 2007 UTC vs.
Revision 1.185 by root, Tue Sep 23 09:13:59 2008 UTC

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

Diff Legend

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