ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.168 by root, Mon Jun 9 14:31:36 2008 UTC

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

Diff Legend

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