ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.137 by root, Sun Mar 16 16:42:56 2008 UTC vs.
Revision 1.178 by root, Sat Sep 13 18:25:50 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	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
14	// every watcher type has its own typedef'd struct	14	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	15	// with the name ev_<type>
16	ev_io stdin_watcher;	16	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	17	ev_timer timeout_watcher;
18		18
19	// all watcher callbacks have a similar signature	19	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	20	// this callback is called when data is readable on stdin
21	static void	21	static void
22	stdin_cb (EV_P_ struct ev_io *w, int revents)	22	stdin_cb (EV_P_ struct ev_io *w, int revents)
23	{	23	{
24	puts ("stdin ready");	24	puts ("stdin ready");
25	// for one-shot events, one must manually stop the watcher	25	// for one-shot events, one must manually stop the watcher
26	// with its corresponding stop function.	26	// with its corresponding stop function.
27	ev_io_stop (EV_A_ w);	27	ev_io_stop (EV_A_ w);
28		28
29	// this causes all nested ev_loop's to stop iterating	29	// this causes all nested ev_loop's to stop iterating
30	ev_unloop (EV_A_ EVUNLOOP_ALL);	30	ev_unloop (EV_A_ EVUNLOOP_ALL);
31	}	31	}
32		32
33	// another callback, this time for a time-out	33	// another callback, this time for a time-out
34	static void	34	static void
35	timeout_cb (EV_P_ struct ev_timer *w, int revents)	35	timeout_cb (EV_P_ struct ev_timer *w, int revents)
36	{	36	{
37	puts ("timeout");	37	puts ("timeout");
38	// this causes the innermost ev_loop to stop iterating	38	// this causes the innermost ev_loop to stop iterating
39	ev_unloop (EV_A_ EVUNLOOP_ONE);	39	ev_unloop (EV_A_ EVUNLOOP_ONE);
40	}	40	}
41		41
42	int	42	int
43	main (void)	43	main (void)
44	{	44	{
45	// use the default event loop unless you have special needs	45	// use the default event loop unless you have special needs
46	struct ev_loop *loop = ev_default_loop (0);	46	struct ev_loop *loop = ev_default_loop (0);
47		47
48	// 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	49	// this one will watch for stdin to become readable
50	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);
51	ev_io_start (loop, &stdin_watcher);	51	ev_io_start (loop, &stdin_watcher);
52		52
53	// initialise a timer watcher, then start it	53	// initialise a timer watcher, then start it
54	// simple non-repeating 5.5 second timeout	54	// simple non-repeating 5.5 second timeout
55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
56	ev_timer_start (loop, &timeout_watcher);	56	ev_timer_start (loop, &timeout_watcher);
57		57
58	// now wait for events to arrive	58	// now wait for events to arrive
59	ev_loop (loop, 0);	59	ev_loop (loop, 0);
60		60
61	// unloop was called, so exit	61	// unloop was called, so exit
62	return 0;	62	return 0;
63	}	63	}
64		64
65	=head1 DESCRIPTION	65	=head1 DESCRIPTION
66		66
67	The newest version of this document is also available as an html-formatted	67	The newest version of this document is also available as an html-formatted
68	web page you might find easier to navigate when reading it for the first	68	web page you might find easier to navigate when reading it for the first
69	time: L<http://cvs.schmorp.de/libev/ev.html>.	69	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
70		70
71	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
72	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
73	these event sources and provide your program with events.	73	these event sources and provide your program with events.
74		74
…		…
113	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
114	(fractional) number of seconds since the (POSIX) epoch (somewhere near	114	(fractional) number of seconds since the (POSIX) epoch (somewhere near
115	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
116	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
117	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
118	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
119	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
120	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
121		142
122	=head1 GLOBAL FUNCTIONS	143	=head1 GLOBAL FUNCTIONS
123		144
124	These functions can be called anytime, even before initialising the	145	These functions can be called anytime, even before initialising the
125	library in any way.	146	library in any way.
…		…
134		155
135	=item ev_sleep (ev_tstamp interval)	156	=item ev_sleep (ev_tstamp interval)
136		157
137	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
138	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
139	this is a subsecond-resolution C<sleep ()>.	160	this is a sub-second-resolution C<sleep ()>.
140		161
141	=item int ev_version_major ()	162	=item int ev_version_major ()
142		163
143	=item int ev_version_minor ()	164	=item int ev_version_minor ()
144		165
…		…
157	not a problem.	178	not a problem.
158		179
159	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
160	version.	181	version.
161		182
162	assert (("libev version mismatch",	183	assert (("libev version mismatch",
163	ev_version_major () == EV_VERSION_MAJOR	184	ev_version_major () == EV_VERSION_MAJOR
164	&& ev_version_minor () >= EV_VERSION_MINOR));	185	&& ev_version_minor () >= EV_VERSION_MINOR));
165		186
166	=item unsigned int ev_supported_backends ()	187	=item unsigned int ev_supported_backends ()
167		188
168	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_*>
169	value) compiled into this binary of libev (independent of their	190	value) compiled into this binary of libev (independent of their
…		…
171	a description of the set values.	192	a description of the set values.
172		193
173	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
174	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
175		196
176	assert (("sorry, no epoll, no sex",	197	assert (("sorry, no epoll, no sex",
177	ev_supported_backends () & EVBACKEND_EPOLL));	198	ev_supported_backends () & EVBACKEND_EPOLL));
178		199
179	=item unsigned int ev_recommended_backends ()	200	=item unsigned int ev_recommended_backends ()
180		201
181	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
182	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
183	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
184	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
185	(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
186	libev will probe for if you specify no backends explicitly.	207	libev will probe for if you specify no backends explicitly.
187		208
188	=item unsigned int ev_embeddable_backends ()	209	=item unsigned int ev_embeddable_backends ()
189		210
…		…
196	See the description of C<ev_embed> watchers for more info.	217	See the description of C<ev_embed> watchers for more info.
197		218
198	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	219	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
199		220
200	Sets the allocation function to use (the prototype is similar - the	221	Sets the allocation function to use (the prototype is similar - the
201	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
202	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
203	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
204	potentially destructive action. The default is your system realloc	225	or take some potentially destructive action.
205	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.
206		230
207	You could override this function in high-availability programs to, say,	231	You could override this function in high-availability programs to, say,
208	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,
209	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.
210		234
211	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
212	retries).	236	retries (example requires a standards-compliant C<realloc>).
213		237
214	static void *	238	static void *
215	persistent_realloc (void *ptr, size_t size)	239	persistent_realloc (void *ptr, size_t size)
216	{	240	{
217	for (;;)	241	for (;;)
…		…
228	...	252	...
229	ev_set_allocator (persistent_realloc);	253	ev_set_allocator (persistent_realloc);
230		254
231	=item ev_set_syserr_cb (void (*cb)(const char *msg));	255	=item ev_set_syserr_cb (void (*cb)(const char *msg));
232		256
233	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
234	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
235	indicating the system call or subsystem causing the problem. If this	259	indicating the system call or subsystem causing the problem. If this
236	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
237	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
238	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
239	(such as abort).	263	(such as abort).
240		264
241	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.
…		…
255	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
256		280
257	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
258	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
259	events, and dynamically created loops which do not.	283	events, and dynamically created loops which do not.
260
261	If you use threads, a common model is to run the default event loop
262	in your main thread (or in a separate thread) and for each thread you
263	create, you also create another event loop. Libev itself does no locking
264	whatsoever, so if you mix calls to the same event loop in different
265	threads, make sure you lock (this is usually a bad idea, though, even if
266	done correctly, because it's hideous and inefficient).
267		284
268	=over 4	285	=over 4
269		286
270	=item struct ev_loop *ev_default_loop (unsigned int flags)	287	=item struct ev_loop *ev_default_loop (unsigned int flags)
271		288
…		…
275	flags. If that is troubling you, check C<ev_backend ()> afterwards).	292	flags. If that is troubling you, check C<ev_backend ()> afterwards).
276		293
277	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
278	function.	295	function.
279		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
280	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
281	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
282	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
283	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
284	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	305	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
285	C<ev_default_init>.	306	C<ev_default_init>.
286		307
287	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
…		…
296	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
297	thing, believe me).	318	thing, believe me).
298		319
299	=item C<EVFLAG_NOENV>	320	=item C<EVFLAG_NOENV>
300		321
301	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
302	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
303	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	324	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
304	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
305	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
306	around bugs.	327	around bugs.
…		…
313		334
314	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,
315	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
316	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
317	GNU/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
318	without a syscall and thus I<very> fast, but my GNU/Linux system also has	339	without a system call and thus I<very> fast, but my GNU/Linux system also has
319	C<pthread_atfork> which is even faster).	340	C<pthread_atfork> which is even faster).
320		341
321	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
322	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
323	flag.	344	flag.
324		345
325	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>
326	environment variable.	347	environment variable.
327		348
328	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	349	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
329		350
330	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
…		…
332	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
333	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
334	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.
335		356
336	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
337	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
338	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
339	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
340	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
341	readyness notifications you get per iteration.	362	readiness notifications you get per iteration.
342		363
343	=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)
344		365
345	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
346	than select, but handles sparse fds better and has no artificial	367	than select, but handles sparse fds better and has no artificial
…		…
354	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,
355	but it scales phenomenally better. While poll and select usually scale	376	but it scales phenomenally better. While poll and select usually scale
356	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),
357	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
358	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
359	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
360	support for dup.	381	support for dup.
361		382
362	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
363	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
364	(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
365	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
366	very well if you register events for both fds.	387	very well if you register events for both fds.
367		388
368	Please note that epoll sometimes generates spurious notifications, so you	389	Please note that epoll sometimes generates spurious notifications, so you
…		…
371		392
372	Best performance from this backend is achieved by not unregistering all	393	Best performance from this backend is achieved by not unregistering all
373	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.
374	keep at least one watcher active per fd at all times.	395	keep at least one watcher active per fd at all times.
375		396
376	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
377	all kernel versions tested so far.	398	all kernel versions tested so far.
378		399
379	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	400	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
380		401
381	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
382	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
383	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
384	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"
385	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
386	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)
387	system like NetBSD.	408	system like NetBSD.
388		409
389	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
…		…
391	the target platform). See C<ev_embed> watchers for more info.	412	the target platform). See C<ev_embed> watchers for more info.
392		413
393	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
394	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
395	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
396	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
397	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
398	drops fds silently in similarly hard-to-detect cases.	419	drops fds silently in similarly hard-to-detect cases.
399		420
400	This backend usually performs well under most conditions.	421	This backend usually performs well under most conditions.
401		422
…		…
416	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	437	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
417		438
418	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,
419	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)).
420		441
421	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
422	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
423	blocking when no data (or space) is available.	444	blocking when no data (or space) is available.
424		445
425	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
426	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
427	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	448	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
428	might perform better.	449	might perform better.
429		450
430	On the positive side, ignoring the spurious readyness notifications, this	451	On the positive side, ignoring the spurious readiness notifications, this
431	backend actually performed to specification in all tests and is fully	452	backend actually performed to specification in all tests and is fully
432	embeddable, which is a rare feat among the OS-specific backends.	453	embeddable, which is a rare feat among the OS-specific backends.
433		454
434	=item C<EVBACKEND_ALL>	455	=item C<EVBACKEND_ALL>
435		456
…		…
439		460
440	It is definitely not recommended to use this flag.	461	It is definitely not recommended to use this flag.
441		462
442	=back	463	=back
443		464
444	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
445	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
446	specified, all backends in C<ev_recommended_backends ()> will be tried.	467	specified, all backends in C<ev_recommended_backends ()> will be tried.
447		468
448	The most typical usage is like this:	469	The most typical usage is like this:
449		470
450	if (!ev_default_loop (0))	471	if (!ev_default_loop (0))
451	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	472	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
452		473
453	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
454	environment settings to be taken into account:	475	environment settings to be taken into account:
455		476
456	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	477	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
457		478
458	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
459	available (warning, breaks stuff, best use only with your own private	480	available (warning, breaks stuff, best use only with your own private
460	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):
461		482
462	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	483	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
463		484
464	=item struct ev_loop *ev_loop_new (unsigned int flags)	485	=item struct ev_loop *ev_loop_new (unsigned int flags)
465		486
466	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
467	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
468	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
469	undefined behaviour (or a failed assertion if assertions are enabled).	490	undefined behaviour (or a failed assertion if assertions are enabled).
470		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
471	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.
472		497
473	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	498	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
474	if (!epoller)	499	if (!epoller)
475	fatal ("no epoll found here, maybe it hides under your chair");	500	fatal ("no epoll found here, maybe it hides under your chair");
476		501
477	=item ev_default_destroy ()	502	=item ev_default_destroy ()
478		503
479	Destroys the default loop again (frees all memory and kernel state	504	Destroys the default loop again (frees all memory and kernel state
480	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
481	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
482	responsibility to either stop all watchers cleanly yoursef I<before>	507	responsibility to either stop all watchers cleanly yourself I<before>
483	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
484	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
485	for example).	510	for example).
486		511
487	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
…		…
548	received events and started processing them. This timestamp does not	573	received events and started processing them. This timestamp does not
549	change as long as callbacks are being processed, and this is also the base	574	change as long as callbacks are being processed, and this is also the base
550	time used for relative timers. You can treat it as the timestamp of the	575	time used for relative timers. You can treat it as the timestamp of the
551	event occurring (or more correctly, libev finding out about it).	576	event occurring (or more correctly, libev finding out about it).
552		577
		578	=item ev_now_update (loop)
		579
		580	Establishes the current time by querying the kernel, updating the time
		581	returned by C<ev_now ()> in the progress. This is a costly operation and
		582	is usually done automatically within C<ev_loop ()>.
		583
		584	This function is rarely useful, but when some event callback runs for a
		585	very long time without entering the event loop, updating libev's idea of
		586	the current time is a good idea.
		587
		588	See also "The special problem of time updates" in the C<ev_timer> section.
		589
553	=item ev_loop (loop, int flags)	590	=item ev_loop (loop, int flags)
554		591
555	Finally, this is it, the event handler. This function usually is called	592	Finally, this is it, the event handler. This function usually is called
556	after you initialised all your watchers and you want to start handling	593	after you initialised all your watchers and you want to start handling
557	events.	594	events.
…		…
568	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	605	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
569	those events and any outstanding ones, but will not block your process in	606	those events and any outstanding ones, but will not block your process in
570	case there are no events and will return after one iteration of the loop.	607	case there are no events and will return after one iteration of the loop.
571		608
572	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	609	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
573	neccessary) and will handle those and any outstanding ones. It will block	610	necessary) and will handle those and any outstanding ones. It will block
574	your process until at least one new event arrives, and will return after	611	your process until at least one new event arrives, and will return after
575	one iteration of the loop. This is useful if you are waiting for some	612	one iteration of the loop. This is useful if you are waiting for some
576	external event in conjunction with something not expressible using other	613	external event in conjunction with something not expressible using other
577	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	614	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
578	usually a better approach for this kind of thing.	615	usually a better approach for this kind of thing.
579		616
580	Here are the gory details of what C<ev_loop> does:	617	Here are the gory details of what C<ev_loop> does:
581		618
582	- Before the first iteration, call any pending watchers.	619	- Before the first iteration, call any pending watchers.
583	* If EVFLAG_FORKCHECK was used, check for a fork.	620	* If EVFLAG_FORKCHECK was used, check for a fork.
584	- If a fork was detected, queue and call all fork watchers.	621	- If a fork was detected (by any means), queue and call all fork watchers.
585	- Queue and call all prepare watchers.	622	- Queue and call all prepare watchers.
586	- If we have been forked, recreate the kernel state.	623	- If we have been forked, detach and recreate the kernel state
		624	as to not disturb the other process.
587	- Update the kernel state with all outstanding changes.	625	- Update the kernel state with all outstanding changes.
588	- Update the "event loop time".	626	- Update the "event loop time" (ev_now ()).
589	- Calculate for how long to sleep or block, if at all	627	- Calculate for how long to sleep or block, if at all
590	(active idle watchers, EVLOOP_NONBLOCK or not having	628	(active idle watchers, EVLOOP_NONBLOCK or not having
591	any active watchers at all will result in not sleeping).	629	any active watchers at all will result in not sleeping).
592	- Sleep if the I/O and timer collect interval say so.	630	- Sleep if the I/O and timer collect interval say so.
593	- Block the process, waiting for any events.	631	- Block the process, waiting for any events.
594	- Queue all outstanding I/O (fd) events.	632	- Queue all outstanding I/O (fd) events.
595	- Update the "event loop time" and do time jump handling.	633	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
596	- Queue all outstanding timers.	634	- Queue all outstanding timers.
597	- Queue all outstanding periodics.	635	- Queue all outstanding periodics.
598	- If no events are pending now, queue all idle watchers.	636	- Unless any events are pending now, queue all idle watchers.
599	- Queue all check watchers.	637	- Queue all check watchers.
600	- Call all queued watchers in reverse order (i.e. check watchers first).	638	- Call all queued watchers in reverse order (i.e. check watchers first).
601	Signals and child watchers are implemented as I/O watchers, and will	639	Signals and child watchers are implemented as I/O watchers, and will
602	be handled here by queueing them when their watcher gets executed.	640	be handled here by queueing them when their watcher gets executed.
603	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	641	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
…		…
608	anymore.	646	anymore.
609		647
610	... queue jobs here, make sure they register event watchers as long	648	... queue jobs here, make sure they register event watchers as long
611	... as they still have work to do (even an idle watcher will do..)	649	... as they still have work to do (even an idle watcher will do..)
612	ev_loop (my_loop, 0);	650	ev_loop (my_loop, 0);
613	... jobs done. yeah!	651	... jobs done or somebody called unloop. yeah!
614		652
615	=item ev_unloop (loop, how)	653	=item ev_unloop (loop, how)
616		654
617	Can be used to make a call to C<ev_loop> return early (but only after it	655	Can be used to make a call to C<ev_loop> return early (but only after it
618	has processed all outstanding events). The C<how> argument must be either	656	has processed all outstanding events). The C<how> argument must be either
…		…
639	respectively).	677	respectively).
640		678
641	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	679	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
642	running when nothing else is active.	680	running when nothing else is active.
643		681
644	struct ev_signal exitsig;	682	struct ev_signal exitsig;
645	ev_signal_init (&exitsig, sig_cb, SIGINT);	683	ev_signal_init (&exitsig, sig_cb, SIGINT);
646	ev_signal_start (loop, &exitsig);	684	ev_signal_start (loop, &exitsig);
647	evf_unref (loop);	685	evf_unref (loop);
648		686
649	Example: For some weird reason, unregister the above signal handler again.	687	Example: For some weird reason, unregister the above signal handler again.
650		688
651	ev_ref (loop);	689	ev_ref (loop);
652	ev_signal_stop (loop, &exitsig);	690	ev_signal_stop (loop, &exitsig);
653		691
654	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	692	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
655		693
656	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	694	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
657		695
658	These advanced functions influence the time that libev will spend waiting	696	These advanced functions influence the time that libev will spend waiting
659	for events. Both are by default C<0>, meaning that libev will try to	697	for events. Both time intervals are by default C<0>, meaning that libev
660	invoke timer/periodic callbacks and I/O callbacks with minimum latency.	698	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		699	latency.
661		700
662	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	701	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
663	allows libev to delay invocation of I/O and timer/periodic callbacks to	702	allows libev to delay invocation of I/O and timer/periodic callbacks
664	increase efficiency of loop iterations.	703	to increase efficiency of loop iterations (or to increase power-saving
		704	opportunities).
665		705
666	The background is that sometimes your program runs just fast enough to	706	The background is that sometimes your program runs just fast enough to
667	handle one (or very few) event(s) per loop iteration. While this makes	707	handle one (or very few) event(s) per loop iteration. While this makes
668	the program responsive, it also wastes a lot of CPU time to poll for new	708	the program responsive, it also wastes a lot of CPU time to poll for new
669	events, especially with backends like C<select ()> which have a high	709	events, especially with backends like C<select ()> which have a high
…		…
679	to spend more time collecting timeouts, at the expense of increased	719	to spend more time collecting timeouts, at the expense of increased
680	latency (the watcher callback will be called later). C<ev_io> watchers	720	latency (the watcher callback will be called later). C<ev_io> watchers
681	will not be affected. Setting this to a non-null value will not introduce	721	will not be affected. Setting this to a non-null value will not introduce
682	any overhead in libev.	722	any overhead in libev.
683		723
684	Many (busy) programs can usually benefit by setting the io collect	724	Many (busy) programs can usually benefit by setting the I/O collect
685	interval to a value near C<0.1> or so, which is often enough for	725	interval to a value near C<0.1> or so, which is often enough for
686	interactive servers (of course not for games), likewise for timeouts. It	726	interactive servers (of course not for games), likewise for timeouts. It
687	usually doesn't make much sense to set it to a lower value than C<0.01>,	727	usually doesn't make much sense to set it to a lower value than C<0.01>,
688	as this approsaches the timing granularity of most systems.	728	as this approaches the timing granularity of most systems.
		729
		730	Setting the I<timeout collect interval> can improve the opportunity for
		731	saving power, as the program will "bundle" timer callback invocations that
		732	are "near" in time together, by delaying some, thus reducing the number of
		733	times the process sleeps and wakes up again. Another useful technique to
		734	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
		735	they fire on, say, one-second boundaries only.
		736
		737	=item ev_loop_verify (loop)
		738
		739	This function only does something when C<EV_VERIFY> support has been
		740	compiled in. It tries to go through all internal structures and checks
		741	them for validity. If anything is found to be inconsistent, it will print
		742	an error message to standard error and call C<abort ()>.
		743
		744	This can be used to catch bugs inside libev itself: under normal
		745	circumstances, this function will never abort as of course libev keeps its
		746	data structures consistent.
689		747
690	=back	748	=back
691		749
692		750
693	=head1 ANATOMY OF A WATCHER	751	=head1 ANATOMY OF A WATCHER
694		752
695	A watcher is a structure that you create and register to record your	753	A watcher is a structure that you create and register to record your
696	interest in some event. For instance, if you want to wait for STDIN to	754	interest in some event. For instance, if you want to wait for STDIN to
697	become readable, you would create an C<ev_io> watcher for that:	755	become readable, you would create an C<ev_io> watcher for that:
698		756
699	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	757	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)
700	{	758	{
701	ev_io_stop (w);	759	ev_io_stop (w);
702	ev_unloop (loop, EVUNLOOP_ALL);	760	ev_unloop (loop, EVUNLOOP_ALL);
703	}	761	}
704		762
705	struct ev_loop *loop = ev_default_loop (0);	763	struct ev_loop *loop = ev_default_loop (0);
706	struct ev_io stdin_watcher;	764	struct ev_io stdin_watcher;
707	ev_init (&stdin_watcher, my_cb);	765	ev_init (&stdin_watcher, my_cb);
708	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	766	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
709	ev_io_start (loop, &stdin_watcher);	767	ev_io_start (loop, &stdin_watcher);
710	ev_loop (loop, 0);	768	ev_loop (loop, 0);
711		769
712	As you can see, you are responsible for allocating the memory for your	770	As you can see, you are responsible for allocating the memory for your
713	watcher structures (and it is usually a bad idea to do this on the stack,	771	watcher structures (and it is usually a bad idea to do this on the stack,
714	although this can sometimes be quite valid).	772	although this can sometimes be quite valid).
715		773
716	Each watcher structure must be initialised by a call to C<ev_init	774	Each watcher structure must be initialised by a call to C<ev_init
717	(watcher *, callback)>, which expects a callback to be provided. This	775	(watcher *, callback)>, which expects a callback to be provided. This
718	callback gets invoked each time the event occurs (or, in the case of io	776	callback gets invoked each time the event occurs (or, in the case of I/O
719	watchers, each time the event loop detects that the file descriptor given	777	watchers, each time the event loop detects that the file descriptor given
720	is readable and/or writable).	778	is readable and/or writable).
721		779
722	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	780	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro
723	with arguments specific to this watcher type. There is also a macro	781	with arguments specific to this watcher type. There is also a macro
…		…
799		857
800	The given async watcher has been asynchronously notified (see C<ev_async>).	858	The given async watcher has been asynchronously notified (see C<ev_async>).
801		859
802	=item C<EV_ERROR>	860	=item C<EV_ERROR>
803		861
804	An unspecified error has occured, the watcher has been stopped. This might	862	An unspecified error has occurred, the watcher has been stopped. This might
805	happen because the watcher could not be properly started because libev	863	happen because the watcher could not be properly started because libev
806	ran out of memory, a file descriptor was found to be closed or any other	864	ran out of memory, a file descriptor was found to be closed or any other
807	problem. You best act on it by reporting the problem and somehow coping	865	problem. You best act on it by reporting the problem and somehow coping
808	with the watcher being stopped.	866	with the watcher being stopped.
809		867
810	Libev will usually signal a few "dummy" events together with an error,	868	Libev will usually signal a few "dummy" events together with an error,
811	for example it might indicate that a fd is readable or writable, and if	869	for example it might indicate that a fd is readable or writable, and if
812	your callbacks is well-written it can just attempt the operation and cope	870	your callbacks is well-written it can just attempt the operation and cope
813	with the error from read() or write(). This will not work in multithreaded	871	with the error from read() or write(). This will not work in multi-threaded
814	programs, though, so beware.	872	programs, though, so beware.
815		873
816	=back	874	=back
817		875
818	=head2 GENERIC WATCHER FUNCTIONS	876	=head2 GENERIC WATCHER FUNCTIONS
…		…
848	Although some watcher types do not have type-specific arguments	906	Although some watcher types do not have type-specific arguments
849	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	907	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
850		908
851	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	909	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
852		910
853	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	911	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
854	calls into a single call. This is the most convinient method to initialise	912	calls into a single call. This is the most convenient method to initialise
855	a watcher. The same limitations apply, of course.	913	a watcher. The same limitations apply, of course.
856		914
857	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	915	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
858		916
859	Starts (activates) the given watcher. Only active watchers will receive	917	Starts (activates) the given watcher. Only active watchers will receive
…		…
942	to associate arbitrary data with your watcher. If you need more data and	1000	to associate arbitrary data with your watcher. If you need more data and
943	don't want to allocate memory and store a pointer to it in that data	1001	don't want to allocate memory and store a pointer to it in that data
944	member, you can also "subclass" the watcher type and provide your own	1002	member, you can also "subclass" the watcher type and provide your own
945	data:	1003	data:
946		1004
947	struct my_io	1005	struct my_io
948	{	1006	{
949	struct ev_io io;	1007	struct ev_io io;
950	int otherfd;	1008	int otherfd;
951	void *somedata;	1009	void *somedata;
952	struct whatever *mostinteresting;	1010	struct whatever *mostinteresting;
953	}	1011	};
		1012
		1013	...
		1014	struct my_io w;
		1015	ev_io_init (&w.io, my_cb, fd, EV_READ);
954		1016
955	And since your callback will be called with a pointer to the watcher, you	1017	And since your callback will be called with a pointer to the watcher, you
956	can cast it back to your own type:	1018	can cast it back to your own type:
957		1019
958	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1020	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
959	{	1021	{
960	struct my_io *w = (struct my_io *)w_;	1022	struct my_io *w = (struct my_io *)w_;
961	...	1023	...
962	}	1024	}
963		1025
964	More interesting and less C-conformant ways of casting your callback type	1026	More interesting and less C-conformant ways of casting your callback type
965	instead have been omitted.	1027	instead have been omitted.
966		1028
967	Another common scenario is having some data structure with multiple	1029	Another common scenario is to use some data structure with multiple
968	watchers:	1030	embedded watchers:
969		1031
970	struct my_biggy	1032	struct my_biggy
971	{	1033	{
972	int some_data;	1034	int some_data;
973	ev_timer t1;	1035	ev_timer t1;
974	ev_timer t2;	1036	ev_timer t2;
975	}	1037	}
976		1038
977	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1039	In this case getting the pointer to C<my_biggy> is a bit more
978	you need to use C<offsetof>:	1040	complicated: Either you store the address of your C<my_biggy> struct
		1041	in the C<data> member of the watcher, or you need to use some pointer
		1042	arithmetic using C<offsetof> inside your watchers:
979		1043
980	#include <stddef.h>	1044	#include <stddef.h>
981		1045
982	static void	1046	static void
983	t1_cb (EV_P_ struct ev_timer *w, int revents)	1047	t1_cb (EV_P_ struct ev_timer *w, int revents)
984	{	1048	{
985	struct my_biggy big = (struct my_biggy *	1049	struct my_biggy big = (struct my_biggy *
986	(((char *)w) - offsetof (struct my_biggy, t1));	1050	(((char *)w) - offsetof (struct my_biggy, t1));
987	}	1051	}
988		1052
989	static void	1053	static void
990	t2_cb (EV_P_ struct ev_timer *w, int revents)	1054	t2_cb (EV_P_ struct ev_timer *w, int revents)
991	{	1055	{
992	struct my_biggy big = (struct my_biggy *	1056	struct my_biggy big = (struct my_biggy *
993	(((char *)w) - offsetof (struct my_biggy, t2));	1057	(((char *)w) - offsetof (struct my_biggy, t2));
994	}	1058	}
995		1059
996		1060
997	=head1 WATCHER TYPES	1061	=head1 WATCHER TYPES
998		1062
999	This section describes each watcher in detail, but will not repeat	1063	This section describes each watcher in detail, but will not repeat
…		…
1028	If you must do this, then force the use of a known-to-be-good backend	1092	If you must do this, then force the use of a known-to-be-good backend
1029	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1093	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
1030	C<EVBACKEND_POLL>).	1094	C<EVBACKEND_POLL>).
1031		1095
1032	Another thing you have to watch out for is that it is quite easy to	1096	Another thing you have to watch out for is that it is quite easy to
1033	receive "spurious" readyness notifications, that is your callback might	1097	receive "spurious" readiness notifications, that is your callback might
1034	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1098	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1035	because there is no data. Not only are some backends known to create a	1099	because there is no data. Not only are some backends known to create a
1036	lot of those (for example solaris ports), it is very easy to get into	1100	lot of those (for example Solaris ports), it is very easy to get into
1037	this situation even with a relatively standard program structure. Thus	1101	this situation even with a relatively standard program structure. Thus
1038	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1102	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1039	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1103	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1040		1104
1041	If you cannot run the fd in non-blocking mode (for example you should not	1105	If you cannot run the fd in non-blocking mode (for example you should not
1042	play around with an Xlib connection), then you have to seperately re-test	1106	play around with an Xlib connection), then you have to separately re-test
1043	whether a file descriptor is really ready with a known-to-be good interface	1107	whether a file descriptor is really ready with a known-to-be good interface
1044	such as poll (fortunately in our Xlib example, Xlib already does this on	1108	such as poll (fortunately in our Xlib example, Xlib already does this on
1045	its own, so its quite safe to use).	1109	its own, so its quite safe to use).
1046		1110
1047	=head3 The special problem of disappearing file descriptors	1111	=head3 The special problem of disappearing file descriptors
…		…
1085	To support fork in your programs, you either have to call	1149	To support fork in your programs, you either have to call
1086	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1150	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1087	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1151	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1088	C<EVBACKEND_POLL>.	1152	C<EVBACKEND_POLL>.
1089		1153
		1154	=head3 The special problem of SIGPIPE
		1155
		1156	While not really specific to libev, it is easy to forget about SIGPIPE:
		1157	when writing to a pipe whose other end has been closed, your program gets
		1158	send a SIGPIPE, which, by default, aborts your program. For most programs
		1159	this is sensible behaviour, for daemons, this is usually undesirable.
		1160
		1161	So when you encounter spurious, unexplained daemon exits, make sure you
		1162	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1163	somewhere, as that would have given you a big clue).
		1164
1090		1165
1091	=head3 Watcher-Specific Functions	1166	=head3 Watcher-Specific Functions
1092		1167
1093	=over 4	1168	=over 4
1094		1169
1095	=item ev_io_init (ev_io *, callback, int fd, int events)	1170	=item ev_io_init (ev_io *, callback, int fd, int events)
1096		1171
1097	=item ev_io_set (ev_io *, int fd, int events)	1172	=item ev_io_set (ev_io *, int fd, int events)
1098		1173
1099	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1174	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1100	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1175	receive events for and events is either C<EV_READ>, C<EV_WRITE> or
1101	C<EV_READ | EV_WRITE> to receive the given events.	1176	C<EV_READ | EV_WRITE> to receive the given events.
1102		1177
1103	=item int fd [read-only]	1178	=item int fd [read-only]
1104		1179
1105	The file descriptor being watched.	1180	The file descriptor being watched.
…		…
1114		1189
1115	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1190	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1116	readable, but only once. Since it is likely line-buffered, you could	1191	readable, but only once. Since it is likely line-buffered, you could
1117	attempt to read a whole line in the callback.	1192	attempt to read a whole line in the callback.
1118		1193
1119	static void	1194	static void
1120	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1195	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1121	{	1196	{
1122	ev_io_stop (loop, w);	1197	ev_io_stop (loop, w);
1123	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1198	.. read from stdin here (or from w->fd) and haqndle any I/O errors
1124	}	1199	}
1125		1200
1126	...	1201	...
1127	struct ev_loop *loop = ev_default_init (0);	1202	struct ev_loop *loop = ev_default_init (0);
1128	struct ev_io stdin_readable;	1203	struct ev_io stdin_readable;
1129	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1204	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1130	ev_io_start (loop, &stdin_readable);	1205	ev_io_start (loop, &stdin_readable);
1131	ev_loop (loop, 0);	1206	ev_loop (loop, 0);
1132		1207
1133		1208
1134	=head2 C<ev_timer> - relative and optionally repeating timeouts	1209	=head2 C<ev_timer> - relative and optionally repeating timeouts
1135		1210
1136	Timer watchers are simple relative timers that generate an event after a	1211	Timer watchers are simple relative timers that generate an event after a
1137	given time, and optionally repeating in regular intervals after that.	1212	given time, and optionally repeating in regular intervals after that.
1138		1213
1139	The timers are based on real time, that is, if you register an event that	1214	The timers are based on real time, that is, if you register an event that
1140	times out after an hour and you reset your system clock to last years	1215	times out after an hour and you reset your system clock to January last
1141	time, it will still time out after (roughly) and hour. "Roughly" because	1216	year, it will still time out after (roughly) and hour. "Roughly" because
1142	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1217	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1143	monotonic clock option helps a lot here).	1218	monotonic clock option helps a lot here).
		1219
		1220	The callback is guaranteed to be invoked only after its timeout has passed,
		1221	but if multiple timers become ready during the same loop iteration then
		1222	order of execution is undefined.
		1223
		1224	=head3 The special problem of time updates
		1225
		1226	Establishing the current time is a costly operation (it usually takes at
		1227	least two system calls): EV therefore updates its idea of the current
		1228	time only before and after C<ev_loop> polls for new events, which causes
		1229	a growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1230	lots of events.
1144		1231
1145	The relative timeouts are calculated relative to the C<ev_now ()>	1232	The relative timeouts are calculated relative to the C<ev_now ()>
1146	time. This is usually the right thing as this timestamp refers to the time	1233	time. This is usually the right thing as this timestamp refers to the time
1147	of the event triggering whatever timeout you are modifying/starting. If	1234	of the event triggering whatever timeout you are modifying/starting. If
1148	you suspect event processing to be delayed and you I<need> to base the timeout	1235	you suspect event processing to be delayed and you I<need> to base the
1149	on the current time, use something like this to adjust for this:	1236	timeout on the current time, use something like this to adjust for this:
1150		1237
1151	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1238	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1152		1239
1153	The callback is guarenteed to be invoked only when its timeout has passed,	1240	If the event loop is suspended for a long time, you can also force an
1154	but if multiple timers become ready during the same loop iteration then	1241	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1155	order of execution is undefined.	1242	()>.
1156		1243
1157	=head3 Watcher-Specific Functions and Data Members	1244	=head3 Watcher-Specific Functions and Data Members
1158		1245
1159	=over 4	1246	=over 4
1160		1247
1161	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1248	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1162		1249
1163	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1250	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1164		1251
1165	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1252	Configure the timer to trigger after C<after> seconds. If C<repeat>
1166	C<0.>, then it will automatically be stopped. If it is positive, then the	1253	is C<0.>, then it will automatically be stopped once the timeout is
1167	timer will automatically be configured to trigger again C<repeat> seconds	1254	reached. If it is positive, then the timer will automatically be
1168	later, again, and again, until stopped manually.	1255	configured to trigger again C<repeat> seconds later, again, and again,
		1256	until stopped manually.
1169		1257
1170	The timer itself will do a best-effort at avoiding drift, that is, if you	1258	The timer itself will do a best-effort at avoiding drift, that is, if
1171	configure a timer to trigger every 10 seconds, then it will trigger at	1259	you configure a timer to trigger every 10 seconds, then it will normally
1172	exactly 10 second intervals. If, however, your program cannot keep up with	1260	trigger at exactly 10 second intervals. If, however, your program cannot
1173	the timer (because it takes longer than those 10 seconds to do stuff) the	1261	keep up with the timer (because it takes longer than those 10 seconds to
1174	timer will not fire more than once per event loop iteration.	1262	do stuff) the timer will not fire more than once per event loop iteration.
1175		1263
1176	=item ev_timer_again (loop, ev_timer *)	1264	=item ev_timer_again (loop, ev_timer *)
1177		1265
1178	This will act as if the timer timed out and restart it again if it is	1266	This will act as if the timer timed out and restart it again if it is
1179	repeating. The exact semantics are:	1267	repeating. The exact semantics are:
1180		1268
1181	If the timer is pending, its pending status is cleared.	1269	If the timer is pending, its pending status is cleared.
1182		1270
1183	If the timer is started but nonrepeating, stop it (as if it timed out).	1271	If the timer is started but non-repeating, stop it (as if it timed out).
1184		1272
1185	If the timer is repeating, either start it if necessary (with the	1273	If the timer is repeating, either start it if necessary (with the
1186	C<repeat> value), or reset the running timer to the C<repeat> value.	1274	C<repeat> value), or reset the running timer to the C<repeat> value.
1187		1275
1188	This sounds a bit complicated, but here is a useful and typical	1276	This sounds a bit complicated, but here is a useful and typical
1189	example: Imagine you have a tcp connection and you want a so-called idle	1277	example: Imagine you have a TCP connection and you want a so-called idle
1190	timeout, that is, you want to be called when there have been, say, 60	1278	timeout, that is, you want to be called when there have been, say, 60
1191	seconds of inactivity on the socket. The easiest way to do this is to	1279	seconds of inactivity on the socket. The easiest way to do this is to
1192	configure an C<ev_timer> with a C<repeat> value of C<60> and then call	1280	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1193	C<ev_timer_again> each time you successfully read or write some data. If	1281	C<ev_timer_again> each time you successfully read or write some data. If
1194	you go into an idle state where you do not expect data to travel on the	1282	you go into an idle state where you do not expect data to travel on the
…		…
1220		1308
1221	=head3 Examples	1309	=head3 Examples
1222		1310
1223	Example: Create a timer that fires after 60 seconds.	1311	Example: Create a timer that fires after 60 seconds.
1224		1312
1225	static void	1313	static void
1226	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1314	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1227	{	1315	{
1228	.. one minute over, w is actually stopped right here	1316	.. one minute over, w is actually stopped right here
1229	}	1317	}
1230		1318
1231	struct ev_timer mytimer;	1319	struct ev_timer mytimer;
1232	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1320	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1233	ev_timer_start (loop, &mytimer);	1321	ev_timer_start (loop, &mytimer);
1234		1322
1235	Example: Create a timeout timer that times out after 10 seconds of	1323	Example: Create a timeout timer that times out after 10 seconds of
1236	inactivity.	1324	inactivity.
1237		1325
1238	static void	1326	static void
1239	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1327	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1240	{	1328	{
1241	.. ten seconds without any activity	1329	.. ten seconds without any activity
1242	}	1330	}
1243		1331
1244	struct ev_timer mytimer;	1332	struct ev_timer mytimer;
1245	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1333	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1246	ev_timer_again (&mytimer); /* start timer */	1334	ev_timer_again (&mytimer); /* start timer */
1247	ev_loop (loop, 0);	1335	ev_loop (loop, 0);
1248		1336
1249	// and in some piece of code that gets executed on any "activity":	1337	// and in some piece of code that gets executed on any "activity":
1250	// reset the timeout to start ticking again at 10 seconds	1338	// reset the timeout to start ticking again at 10 seconds
1251	ev_timer_again (&mytimer);	1339	ev_timer_again (&mytimer);
1252		1340
1253		1341
1254	=head2 C<ev_periodic> - to cron or not to cron?	1342	=head2 C<ev_periodic> - to cron or not to cron?
1255		1343
1256	Periodic watchers are also timers of a kind, but they are very versatile	1344	Periodic watchers are also timers of a kind, but they are very versatile
1257	(and unfortunately a bit complex).	1345	(and unfortunately a bit complex).
1258		1346
1259	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1347	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1260	but on wallclock time (absolute time). You can tell a periodic watcher	1348	but on wall clock time (absolute time). You can tell a periodic watcher
1261	to trigger "at" some specific point in time. For example, if you tell a	1349	to trigger after some specific point in time. For example, if you tell a
1262	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1350	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()
1263	+ 10.>) and then reset your system clock to the last year, then it will	1351	+ 10.>, that is, an absolute time not a delay) and then reset your system
		1352	clock to January of the previous year, then it will take more than year
1264	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1353	to trigger the event (unlike an C<ev_timer>, which would still trigger
1265	roughly 10 seconds later).	1354	roughly 10 seconds later as it uses a relative timeout).
1266		1355
1267	They can also be used to implement vastly more complex timers, such as	1356	C<ev_periodic>s can also be used to implement vastly more complex timers,
1268	triggering an event on each midnight, local time or other, complicated,	1357	such as triggering an event on each "midnight, local time", or other
1269	rules.	1358	complicated, rules.
1270		1359
1271	As with timers, the callback is guarenteed to be invoked only when the	1360	As with timers, the callback is guaranteed to be invoked only when the
1272	time (C<at>) has been passed, but if multiple periodic timers become ready	1361	time (C<at>) has passed, but if multiple periodic timers become ready
1273	during the same loop iteration then order of execution is undefined.	1362	during the same loop iteration then order of execution is undefined.
1274		1363
1275	=head3 Watcher-Specific Functions and Data Members	1364	=head3 Watcher-Specific Functions and Data Members
1276		1365
1277	=over 4	1366	=over 4
…		…
1285		1374
1286	=over 4	1375	=over 4
1287		1376
1288	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1377	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1289		1378
1290	In this configuration the watcher triggers an event at the wallclock time	1379	In this configuration the watcher triggers an event after the wall clock
1291	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1380	time C<at> has passed and doesn't repeat. It will not adjust when a time
1292	that is, if it is to be run at January 1st 2011 then it will run when the	1381	jump occurs, that is, if it is to be run at January 1st 2011 then it will
1293	system time reaches or surpasses this time.	1382	run when the system time reaches or surpasses this time.
1294		1383
1295	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1384	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1296		1385
1297	In this mode the watcher will always be scheduled to time out at the next	1386	In this mode the watcher will always be scheduled to time out at the next
1298	C<at + N * interval> time (for some integer N, which can also be negative)	1387	C<at + N * interval> time (for some integer N, which can also be negative)
1299	and then repeat, regardless of any time jumps.	1388	and then repeat, regardless of any time jumps.
1300		1389
1301	This can be used to create timers that do not drift with respect to system	1390	This can be used to create timers that do not drift with respect to system
1302	time:	1391	time, for example, here is a C<ev_periodic> that triggers each hour, on
		1392	the hour:
1303		1393
1304	ev_periodic_set (&periodic, 0., 3600., 0);	1394	ev_periodic_set (&periodic, 0., 3600., 0);
1305		1395
1306	This doesn't mean there will always be 3600 seconds in between triggers,	1396	This doesn't mean there will always be 3600 seconds in between triggers,
1307	but only that the the callback will be called when the system time shows a	1397	but only that the callback will be called when the system time shows a
1308	full hour (UTC), or more correctly, when the system time is evenly divisible	1398	full hour (UTC), or more correctly, when the system time is evenly divisible
1309	by 3600.	1399	by 3600.
1310		1400
1311	Another way to think about it (for the mathematically inclined) is that	1401	Another way to think about it (for the mathematically inclined) is that
1312	C<ev_periodic> will try to run the callback in this mode at the next possible	1402	C<ev_periodic> will try to run the callback in this mode at the next possible
1313	time where C<time = at (mod interval)>, regardless of any time jumps.	1403	time where C<time = at (mod interval)>, regardless of any time jumps.
1314		1404
1315	For numerical stability it is preferable that the C<at> value is near	1405	For numerical stability it is preferable that the C<at> value is near
1316	C<ev_now ()> (the current time), but there is no range requirement for	1406	C<ev_now ()> (the current time), but there is no range requirement for
1317	this value.	1407	this value, and in fact is often specified as zero.
		1408
		1409	Note also that there is an upper limit to how often a timer can fire (CPU
		1410	speed for example), so if C<interval> is very small then timing stability
		1411	will of course deteriorate. Libev itself tries to be exact to be about one
		1412	millisecond (if the OS supports it and the machine is fast enough).
1318		1413
1319	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1414	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1320		1415
1321	In this mode the values for C<interval> and C<at> are both being	1416	In this mode the values for C<interval> and C<at> are both being
1322	ignored. Instead, each time the periodic watcher gets scheduled, the	1417	ignored. Instead, each time the periodic watcher gets scheduled, the
1323	reschedule callback will be called with the watcher as first, and the	1418	reschedule callback will be called with the watcher as first, and the
1324	current time as second argument.	1419	current time as second argument.
1325		1420
1326	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1421	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1327	ever, or make any event loop modifications>. If you need to stop it,	1422	ever, or make ANY event loop modifications whatsoever>.
1328	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1329	starting an C<ev_prepare> watcher, which is legal).
1330		1423
		1424	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1425	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1426	only event loop modification you are allowed to do).
		1427
1331	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1428	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic
1332	ev_tstamp now)>, e.g.:	1429	*w, ev_tstamp now)>, e.g.:
1333		1430
1334	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1431	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1335	{	1432	{
1336	return now + 60.;	1433	return now + 60.;
1337	}	1434	}
…		…
1339	It must return the next time to trigger, based on the passed time value	1436	It must return the next time to trigger, based on the passed time value
1340	(that is, the lowest time value larger than to the second argument). It	1437	(that is, the lowest time value larger than to the second argument). It
1341	will usually be called just before the callback will be triggered, but	1438	will usually be called just before the callback will be triggered, but
1342	might be called at other times, too.	1439	might be called at other times, too.
1343		1440
1344	NOTE: I<< This callback must always return a time that is later than the	1441	NOTE: I<< This callback must always return a time that is higher than or
1345	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1442	equal to the passed C<now> value >>.
1346		1443
1347	This can be used to create very complex timers, such as a timer that	1444	This can be used to create very complex timers, such as a timer that
1348	triggers on each midnight, local time. To do this, you would calculate the	1445	triggers on "next midnight, local time". To do this, you would calculate the
1349	next midnight after C<now> and return the timestamp value for this. How	1446	next midnight after C<now> and return the timestamp value for this. How
1350	you do this is, again, up to you (but it is not trivial, which is the main	1447	you do this is, again, up to you (but it is not trivial, which is the main
1351	reason I omitted it as an example).	1448	reason I omitted it as an example).
1352		1449
1353	=back	1450	=back
…		…
1357	Simply stops and restarts the periodic watcher again. This is only useful	1454	Simply stops and restarts the periodic watcher again. This is only useful
1358	when you changed some parameters or the reschedule callback would return	1455	when you changed some parameters or the reschedule callback would return
1359	a different time than the last time it was called (e.g. in a crond like	1456	a different time than the last time it was called (e.g. in a crond like
1360	program when the crontabs have changed).	1457	program when the crontabs have changed).
1361		1458
		1459	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1460
		1461	When active, returns the absolute time that the watcher is supposed to
		1462	trigger next.
		1463
1362	=item ev_tstamp offset [read-write]	1464	=item ev_tstamp offset [read-write]
1363		1465
1364	When repeating, this contains the offset value, otherwise this is the	1466	When repeating, this contains the offset value, otherwise this is the
1365	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1467	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1366		1468
…		…
1377		1479
1378	The current reschedule callback, or C<0>, if this functionality is	1480	The current reschedule callback, or C<0>, if this functionality is
1379	switched off. Can be changed any time, but changes only take effect when	1481	switched off. Can be changed any time, but changes only take effect when
1380	the periodic timer fires or C<ev_periodic_again> is being called.	1482	the periodic timer fires or C<ev_periodic_again> is being called.
1381		1483
1382	=item ev_tstamp at [read-only]
1383
1384	When active, contains the absolute time that the watcher is supposed to
1385	trigger next.
1386
1387	=back	1484	=back
1388		1485
1389	=head3 Examples	1486	=head3 Examples
1390		1487
1391	Example: Call a callback every hour, or, more precisely, whenever the	1488	Example: Call a callback every hour, or, more precisely, whenever the
1392	system clock is divisible by 3600. The callback invocation times have	1489	system clock is divisible by 3600. The callback invocation times have
1393	potentially a lot of jittering, but good long-term stability.	1490	potentially a lot of jitter, but good long-term stability.
1394		1491
1395	static void	1492	static void
1396	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1493	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
1397	{	1494	{
1398	... its now a full hour (UTC, or TAI or whatever your clock follows)	1495	... its now a full hour (UTC, or TAI or whatever your clock follows)
1399	}	1496	}
1400		1497
1401	struct ev_periodic hourly_tick;	1498	struct ev_periodic hourly_tick;
1402	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1499	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1403	ev_periodic_start (loop, &hourly_tick);	1500	ev_periodic_start (loop, &hourly_tick);
1404		1501
1405	Example: The same as above, but use a reschedule callback to do it:	1502	Example: The same as above, but use a reschedule callback to do it:
1406		1503
1407	#include <math.h>	1504	#include <math.h>
1408		1505
1409	static ev_tstamp	1506	static ev_tstamp
1410	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1507	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
1411	{	1508	{
1412	return fmod (now, 3600.) + 3600.;	1509	return fmod (now, 3600.) + 3600.;
1413	}	1510	}
1414		1511
1415	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1512	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1416		1513
1417	Example: Call a callback every hour, starting now:	1514	Example: Call a callback every hour, starting now:
1418		1515
1419	struct ev_periodic hourly_tick;	1516	struct ev_periodic hourly_tick;
1420	ev_periodic_init (&hourly_tick, clock_cb,	1517	ev_periodic_init (&hourly_tick, clock_cb,
1421	fmod (ev_now (loop), 3600.), 3600., 0);	1518	fmod (ev_now (loop), 3600.), 3600., 0);
1422	ev_periodic_start (loop, &hourly_tick);	1519	ev_periodic_start (loop, &hourly_tick);
1423		1520
1424		1521
1425	=head2 C<ev_signal> - signal me when a signal gets signalled!	1522	=head2 C<ev_signal> - signal me when a signal gets signalled!
1426		1523
1427	Signal watchers will trigger an event when the process receives a specific	1524	Signal watchers will trigger an event when the process receives a specific
…		…
1435	as you don't register any with libev). Similarly, when the last signal	1532	as you don't register any with libev). Similarly, when the last signal
1436	watcher for a signal is stopped libev will reset the signal handler to	1533	watcher for a signal is stopped libev will reset the signal handler to
1437	SIG_DFL (regardless of what it was set to before).	1534	SIG_DFL (regardless of what it was set to before).
1438		1535
1439	If possible and supported, libev will install its handlers with	1536	If possible and supported, libev will install its handlers with
1440	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly	1537	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1441	interrupted. If you have a problem with syscalls getting interrupted by	1538	interrupted. If you have a problem with system calls getting interrupted by
1442	signals you can block all signals in an C<ev_check> watcher and unblock	1539	signals you can block all signals in an C<ev_check> watcher and unblock
1443	them in an C<ev_prepare> watcher.	1540	them in an C<ev_prepare> watcher.
1444		1541
1445	=head3 Watcher-Specific Functions and Data Members	1542	=head3 Watcher-Specific Functions and Data Members
1446		1543
…		…
1461		1558
1462	=head3 Examples	1559	=head3 Examples
1463		1560
1464	Example: Try to exit cleanly on SIGINT and SIGTERM.	1561	Example: Try to exit cleanly on SIGINT and SIGTERM.
1465		1562
1466	static void	1563	static void
1467	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1564	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1468	{	1565	{
1469	ev_unloop (loop, EVUNLOOP_ALL);	1566	ev_unloop (loop, EVUNLOOP_ALL);
1470	}	1567	}
1471		1568
1472	struct ev_signal signal_watcher;	1569	struct ev_signal signal_watcher;
1473	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1570	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1474	ev_signal_start (loop, &sigint_cb);	1571	ev_signal_start (loop, &sigint_cb);
1475		1572
1476		1573
1477	=head2 C<ev_child> - watch out for process status changes	1574	=head2 C<ev_child> - watch out for process status changes
1478		1575
1479	Child watchers trigger when your process receives a SIGCHLD in response to	1576	Child watchers trigger when your process receives a SIGCHLD in response to
…		…
1481	is permissible to install a child watcher I<after> the child has been	1578	is permissible to install a child watcher I<after> the child has been
1482	forked (which implies it might have already exited), as long as the event	1579	forked (which implies it might have already exited), as long as the event
1483	loop isn't entered (or is continued from a watcher).	1580	loop isn't entered (or is continued from a watcher).
1484		1581
1485	Only the default event loop is capable of handling signals, and therefore	1582	Only the default event loop is capable of handling signals, and therefore
1486	you can only rgeister child watchers in the default event loop.	1583	you can only register child watchers in the default event loop.
1487		1584
1488	=head3 Process Interaction	1585	=head3 Process Interaction
1489		1586
1490	Libev grabs C<SIGCHLD> as soon as the default event loop is	1587	Libev grabs C<SIGCHLD> as soon as the default event loop is
1491	initialised. This is necessary to guarantee proper behaviour even if	1588	initialised. This is necessary to guarantee proper behaviour even if
1492	the first child watcher is started after the child exits. The occurance	1589	the first child watcher is started after the child exits. The occurrence
1493	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	1590	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1494	synchronously as part of the event loop processing. Libev always reaps all	1591	synchronously as part of the event loop processing. Libev always reaps all
1495	children, even ones not watched.	1592	children, even ones not watched.
1496		1593
1497	=head3 Overriding the Built-In Processing	1594	=head3 Overriding the Built-In Processing
…		…
1501	handler, you can override it easily by installing your own handler for	1598	handler, you can override it easily by installing your own handler for
1502	C<SIGCHLD> after initialising the default loop, and making sure the	1599	C<SIGCHLD> after initialising the default loop, and making sure the
1503	default loop never gets destroyed. You are encouraged, however, to use an	1600	default loop never gets destroyed. You are encouraged, however, to use an
1504	event-based approach to child reaping and thus use libev's support for	1601	event-based approach to child reaping and thus use libev's support for
1505	that, so other libev users can use C<ev_child> watchers freely.	1602	that, so other libev users can use C<ev_child> watchers freely.
		1603
		1604	=head3 Stopping the Child Watcher
		1605
		1606	Currently, the child watcher never gets stopped, even when the
		1607	child terminates, so normally one needs to stop the watcher in the
		1608	callback. Future versions of libev might stop the watcher automatically
		1609	when a child exit is detected.
1506		1610
1507	=head3 Watcher-Specific Functions and Data Members	1611	=head3 Watcher-Specific Functions and Data Members
1508		1612
1509	=over 4	1613	=over 4
1510		1614
…		…
1539	=head3 Examples	1643	=head3 Examples
1540		1644
1541	Example: C<fork()> a new process and install a child handler to wait for	1645	Example: C<fork()> a new process and install a child handler to wait for
1542	its completion.	1646	its completion.
1543		1647
1544	ev_child cw;	1648	ev_child cw;
1545		1649
1546	static void	1650	static void
1547	child_cb (EV_P_ struct ev_child *w, int revents)	1651	child_cb (EV_P_ struct ev_child *w, int revents)
1548	{	1652	{
1549	ev_child_stop (EV_A_ w);	1653	ev_child_stop (EV_A_ w);
1550	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	1654	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1551	}	1655	}
1552		1656
1553	pid_t pid = fork ();	1657	pid_t pid = fork ();
1554		1658
1555	if (pid < 0)	1659	if (pid < 0)
1556	// error	1660	// error
1557	else if (pid == 0)	1661	else if (pid == 0)
1558	{	1662	{
1559	// the forked child executes here	1663	// the forked child executes here
1560	exit (1);	1664	exit (1);
1561	}	1665	}
1562	else	1666	else
1563	{	1667	{
1564	ev_child_init (&cw, child_cb, pid, 0);	1668	ev_child_init (&cw, child_cb, pid, 0);
1565	ev_child_start (EV_DEFAULT_ &cw);	1669	ev_child_start (EV_DEFAULT_ &cw);
1566	}	1670	}
1567		1671
1568		1672
1569	=head2 C<ev_stat> - did the file attributes just change?	1673	=head2 C<ev_stat> - did the file attributes just change?
1570		1674
1571	This watches a filesystem path for attribute changes. That is, it calls	1675	This watches a file system path for attribute changes. That is, it calls
1572	C<stat> regularly (or when the OS says it changed) and sees if it changed	1676	C<stat> regularly (or when the OS says it changed) and sees if it changed
1573	compared to the last time, invoking the callback if it did.	1677	compared to the last time, invoking the callback if it did.
1574		1678
1575	The path does not need to exist: changing from "path exists" to "path does	1679	The path does not need to exist: changing from "path exists" to "path does
1576	not exist" is a status change like any other. The condition "path does	1680	not exist" is a status change like any other. The condition "path does
…		…
1594	as even with OS-supported change notifications, this can be	1698	as even with OS-supported change notifications, this can be
1595	resource-intensive.	1699	resource-intensive.
1596		1700
1597	At the time of this writing, only the Linux inotify interface is	1701	At the time of this writing, only the Linux inotify interface is
1598	implemented (implementing kqueue support is left as an exercise for the	1702	implemented (implementing kqueue support is left as an exercise for the
		1703	reader, note, however, that the author sees no way of implementing ev_stat
1599	reader). Inotify will be used to give hints only and should not change the	1704	semantics with kqueue). Inotify will be used to give hints only and should
1600	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1705	not change the semantics of C<ev_stat> watchers, which means that libev
1601	to fall back to regular polling again even with inotify, but changes are	1706	sometimes needs to fall back to regular polling again even with inotify,
1602	usually detected immediately, and if the file exists there will be no	1707	but changes are usually detected immediately, and if the file exists there
1603	polling.	1708	will be no polling.
1604		1709
1605	=head3 ABI Issues (Largefile Support)	1710	=head3 ABI Issues (Largefile Support)
1606		1711
1607	Libev by default (unless the user overrides this) uses the default	1712	Libev by default (unless the user overrides this) uses the default
1608	compilation environment, which means that on systems with optionally	1713	compilation environment, which means that on systems with large file
1609	disabled large file support, you get the 32 bit version of the stat	1714	support disabled by default, you get the 32 bit version of the stat
1610	structure. When using the library from programs that change the ABI to	1715	structure. When using the library from programs that change the ABI to
1611	use 64 bit file offsets the programs will fail. In that case you have to	1716	use 64 bit file offsets the programs will fail. In that case you have to
1612	compile libev with the same flags to get binary compatibility. This is	1717	compile libev with the same flags to get binary compatibility. This is
1613	obviously the case with any flags that change the ABI, but the problem is	1718	obviously the case with any flags that change the ABI, but the problem is
1614	most noticably with ev_stat and largefile support.	1719	most noticeably disabled with ev_stat and large file support.
		1720
		1721	The solution for this is to lobby your distribution maker to make large
		1722	file interfaces available by default (as e.g. FreeBSD does) and not
		1723	optional. Libev cannot simply switch on large file support because it has
		1724	to exchange stat structures with application programs compiled using the
		1725	default compilation environment.
1615		1726
1616	=head3 Inotify	1727	=head3 Inotify
1617		1728
1618	When C<inotify (7)> support has been compiled into libev (generally only	1729	When C<inotify (7)> support has been compiled into libev (generally only
1619	available on Linux) and present at runtime, it will be used to speed up	1730	available on Linux) and present at runtime, it will be used to speed up
1620	change detection where possible. The inotify descriptor will be created lazily	1731	change detection where possible. The inotify descriptor will be created lazily
1621	when the first C<ev_stat> watcher is being started.	1732	when the first C<ev_stat> watcher is being started.
1622		1733
1623	Inotify presense does not change the semantics of C<ev_stat> watchers	1734	Inotify presence does not change the semantics of C<ev_stat> watchers
1624	except that changes might be detected earlier, and in some cases, to avoid	1735	except that changes might be detected earlier, and in some cases, to avoid
1625	making regular C<stat> calls. Even in the presense of inotify support	1736	making regular C<stat> calls. Even in the presence of inotify support
1626	there are many cases where libev has to resort to regular C<stat> polling.	1737	there are many cases where libev has to resort to regular C<stat> polling.
1627		1738
1628	(There is no support for kqueue, as apparently it cannot be used to	1739	(There is no support for kqueue, as apparently it cannot be used to
1629	implement this functionality, due to the requirement of having a file	1740	implement this functionality, due to the requirement of having a file
1630	descriptor open on the object at all times).	1741	descriptor open on the object at all times).
1631		1742
1632	=head3 The special problem of stat time resolution	1743	=head3 The special problem of stat time resolution
1633		1744
1634	The C<stat ()> syscall only supports full-second resolution portably, and	1745	The C<stat ()> system call only supports full-second resolution portably, and
1635	even on systems where the resolution is higher, many filesystems still	1746	even on systems where the resolution is higher, many file systems still
1636	only support whole seconds.	1747	only support whole seconds.
1637		1748
1638	That means that, if the time is the only thing that changes, you might	1749	That means that, if the time is the only thing that changes, you can
1639	miss updates: on the first update, C<ev_stat> detects a change and calls	1750	easily miss updates: on the first update, C<ev_stat> detects a change and
1640	your callback, which does something. When there is another update within	1751	calls your callback, which does something. When there is another update
1641	the same second, C<ev_stat> will be unable to detect it.	1752	within the same second, C<ev_stat> will be unable to detect it as the stat
		1753	data does not change.
1642		1754
1643	The solution to this is to delay acting on a change for a second (or till	1755	The solution to this is to delay acting on a change for slightly more
1644	the next second boundary), using a roughly one-second delay C<ev_timer>	1756	than a second (or till slightly after the next full second boundary), using
1645	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	1757	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1646	is added to work around small timing inconsistencies of some operating	1758	ev_timer_again (loop, w)>).
1647	systems.	1759
		1760	The C<.02> offset is added to work around small timing inconsistencies
		1761	of some operating systems (where the second counter of the current time
		1762	might be be delayed. One such system is the Linux kernel, where a call to
		1763	C<gettimeofday> might return a timestamp with a full second later than
		1764	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		1765	update file times then there will be a small window where the kernel uses
		1766	the previous second to update file times but libev might already execute
		1767	the timer callback).
1648		1768
1649	=head3 Watcher-Specific Functions and Data Members	1769	=head3 Watcher-Specific Functions and Data Members
1650		1770
1651	=over 4	1771	=over 4
1652		1772
…		…
1658	C<path>. The C<interval> is a hint on how quickly a change is expected to	1778	C<path>. The C<interval> is a hint on how quickly a change is expected to
1659	be detected and should normally be specified as C<0> to let libev choose	1779	be detected and should normally be specified as C<0> to let libev choose
1660	a suitable value. The memory pointed to by C<path> must point to the same	1780	a suitable value. The memory pointed to by C<path> must point to the same
1661	path for as long as the watcher is active.	1781	path for as long as the watcher is active.
1662		1782
1663	The callback will be receive C<EV_STAT> when a change was detected,	1783	The callback will receive C<EV_STAT> when a change was detected, relative
1664	relative to the attributes at the time the watcher was started (or the	1784	to the attributes at the time the watcher was started (or the last change
1665	last change was detected).	1785	was detected).
1666		1786
1667	=item ev_stat_stat (loop, ev_stat *)	1787	=item ev_stat_stat (loop, ev_stat *)
1668		1788
1669	Updates the stat buffer immediately with new values. If you change the	1789	Updates the stat buffer immediately with new values. If you change the
1670	watched path in your callback, you could call this fucntion to avoid	1790	watched path in your callback, you could call this function to avoid
1671	detecting this change (while introducing a race condition). Can also be	1791	detecting this change (while introducing a race condition if you are not
1672	useful simply to find out the new values.	1792	the only one changing the path). Can also be useful simply to find out the
		1793	new values.
1673		1794
1674	=item ev_statdata attr [read-only]	1795	=item ev_statdata attr [read-only]
1675		1796
1676	The most-recently detected attributes of the file. Although the type is of	1797	The most-recently detected attributes of the file. Although the type is
1677	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	1798	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1678	suitable for your system. If the C<st_nlink> member is C<0>, then there	1799	suitable for your system, but you can only rely on the POSIX-standardised
		1800	members to be present. If the C<st_nlink> member is C<0>, then there was
1679	was some error while C<stat>ing the file.	1801	some error while C<stat>ing the file.
1680		1802
1681	=item ev_statdata prev [read-only]	1803	=item ev_statdata prev [read-only]
1682		1804
1683	The previous attributes of the file. The callback gets invoked whenever	1805	The previous attributes of the file. The callback gets invoked whenever
1684	C<prev> != C<attr>.	1806	C<prev> != C<attr>, or, more precisely, one or more of these members
		1807	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		1808	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1685		1809
1686	=item ev_tstamp interval [read-only]	1810	=item ev_tstamp interval [read-only]
1687		1811
1688	The specified interval.	1812	The specified interval.
1689		1813
1690	=item const char *path [read-only]	1814	=item const char *path [read-only]
1691		1815
1692	The filesystem path that is being watched.	1816	The file system path that is being watched.
1693		1817
1694	=back	1818	=back
1695		1819
1696	=head3 Examples	1820	=head3 Examples
1697		1821
1698	Example: Watch C</etc/passwd> for attribute changes.	1822	Example: Watch C</etc/passwd> for attribute changes.
1699		1823
1700	static void	1824	static void
1701	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	1825	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1702	{	1826	{
1703	/* /etc/passwd changed in some way */	1827	/* /etc/passwd changed in some way */
1704	if (w->attr.st_nlink)	1828	if (w->attr.st_nlink)
1705	{	1829	{
1706	printf ("passwd current size %ld\n", (long)w->attr.st_size);	1830	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1707	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	1831	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1708	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	1832	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1709	}	1833	}
1710	else	1834	else
1711	/* you shalt not abuse printf for puts */	1835	/* you shalt not abuse printf for puts */
1712	puts ("wow, /etc/passwd is not there, expect problems. "	1836	puts ("wow, /etc/passwd is not there, expect problems. "
1713	"if this is windows, they already arrived\n");	1837	"if this is windows, they already arrived\n");
1714	}	1838	}
1715		1839
1716	...	1840	...
1717	ev_stat passwd;	1841	ev_stat passwd;
1718		1842
1719	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	1843	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1720	ev_stat_start (loop, &passwd);	1844	ev_stat_start (loop, &passwd);
1721		1845
1722	Example: Like above, but additionally use a one-second delay so we do not	1846	Example: Like above, but additionally use a one-second delay so we do not
1723	miss updates (however, frequent updates will delay processing, too, so	1847	miss updates (however, frequent updates will delay processing, too, so
1724	one might do the work both on C<ev_stat> callback invocation I<and> on	1848	one might do the work both on C<ev_stat> callback invocation I<and> on
1725	C<ev_timer> callback invocation).	1849	C<ev_timer> callback invocation).
1726		1850
1727	static ev_stat passwd;	1851	static ev_stat passwd;
1728	static ev_timer timer;	1852	static ev_timer timer;
1729		1853
1730	static void	1854	static void
1731	timer_cb (EV_P_ ev_timer *w, int revents)	1855	timer_cb (EV_P_ ev_timer *w, int revents)
1732	{	1856	{
1733	ev_timer_stop (EV_A_ w);	1857	ev_timer_stop (EV_A_ w);
1734		1858
1735	/* now it's one second after the most recent passwd change */	1859	/* now it's one second after the most recent passwd change */
1736	}	1860	}
1737		1861
1738	static void	1862	static void
1739	stat_cb (EV_P_ ev_stat *w, int revents)	1863	stat_cb (EV_P_ ev_stat *w, int revents)
1740	{	1864	{
1741	/* reset the one-second timer */	1865	/* reset the one-second timer */
1742	ev_timer_again (EV_A_ &timer);	1866	ev_timer_again (EV_A_ &timer);
1743	}	1867	}
1744		1868
1745	...	1869	...
1746	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	1870	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1747	ev_stat_start (loop, &passwd);	1871	ev_stat_start (loop, &passwd);
1748	ev_timer_init (&timer, timer_cb, 0., 1.01);	1872	ev_timer_init (&timer, timer_cb, 0., 1.02);
1749		1873
1750		1874
1751	=head2 C<ev_idle> - when you've got nothing better to do...	1875	=head2 C<ev_idle> - when you've got nothing better to do...
1752		1876
1753	Idle watchers trigger events when no other events of the same or higher	1877	Idle watchers trigger events when no other events of the same or higher
…		…
1784	=head3 Examples	1908	=head3 Examples
1785		1909
1786	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	1910	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1787	callback, free it. Also, use no error checking, as usual.	1911	callback, free it. Also, use no error checking, as usual.
1788		1912
1789	static void	1913	static void
1790	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1914	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1791	{	1915	{
1792	free (w);	1916	free (w);
1793	// now do something you wanted to do when the program has	1917	// now do something you wanted to do when the program has
1794	// no longer anything immediate to do.	1918	// no longer anything immediate to do.
1795	}	1919	}
1796		1920
1797	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1921	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1798	ev_idle_init (idle_watcher, idle_cb);	1922	ev_idle_init (idle_watcher, idle_cb);
1799	ev_idle_start (loop, idle_cb);	1923	ev_idle_start (loop, idle_cb);
1800		1924
1801		1925
1802	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	1926	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1803		1927
1804	Prepare and check watchers are usually (but not always) used in tandem:	1928	Prepare and check watchers are usually (but not always) used in tandem:
…		…
1823		1947
1824	This is done by examining in each prepare call which file descriptors need	1948	This is done by examining in each prepare call which file descriptors need
1825	to be watched by the other library, registering C<ev_io> watchers for	1949	to be watched by the other library, registering C<ev_io> watchers for
1826	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1950	them and starting an C<ev_timer> watcher for any timeouts (many libraries
1827	provide just this functionality). Then, in the check watcher you check for	1951	provide just this functionality). Then, in the check watcher you check for
1828	any events that occured (by checking the pending status of all watchers	1952	any events that occurred (by checking the pending status of all watchers
1829	and stopping them) and call back into the library. The I/O and timer	1953	and stopping them) and call back into the library. The I/O and timer
1830	callbacks will never actually be called (but must be valid nevertheless,	1954	callbacks will never actually be called (but must be valid nevertheless,
1831	because you never know, you know?).	1955	because you never know, you know?).
1832		1956
1833	As another example, the Perl Coro module uses these hooks to integrate	1957	As another example, the Perl Coro module uses these hooks to integrate
…		…
1841		1965
1842	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	1966	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1843	priority, to ensure that they are being run before any other watchers	1967	priority, to ensure that they are being run before any other watchers
1844	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	1968	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1845	too) should not activate ("feed") events into libev. While libev fully	1969	too) should not activate ("feed") events into libev. While libev fully
1846	supports this, they will be called before other C<ev_check> watchers	1970	supports this, they might get executed before other C<ev_check> watchers
1847	did their job. As C<ev_check> watchers are often used to embed other	1971	did their job. As C<ev_check> watchers are often used to embed other
1848	(non-libev) event loops those other event loops might be in an unusable	1972	(non-libev) event loops those other event loops might be in an unusable
1849	state until their C<ev_check> watcher ran (always remind yourself to	1973	state until their C<ev_check> watcher ran (always remind yourself to
1850	coexist peacefully with others).	1974	coexist peacefully with others).
1851		1975
…		…
1866	=head3 Examples	1990	=head3 Examples
1867		1991
1868	There are a number of principal ways to embed other event loops or modules	1992	There are a number of principal ways to embed other event loops or modules
1869	into libev. Here are some ideas on how to include libadns into libev	1993	into libev. Here are some ideas on how to include libadns into libev
1870	(there is a Perl module named C<EV::ADNS> that does this, which you could	1994	(there is a Perl module named C<EV::ADNS> that does this, which you could
1871	use for an actually working example. Another Perl module named C<EV::Glib>	1995	use as a working example. Another Perl module named C<EV::Glib> embeds a
1872	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	1996	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1873	into the Glib event loop).	1997	Glib event loop).
1874		1998
1875	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	1999	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1876	and in a check watcher, destroy them and call into libadns. What follows	2000	and in a check watcher, destroy them and call into libadns. What follows
1877	is pseudo-code only of course. This requires you to either use a low	2001	is pseudo-code only of course. This requires you to either use a low
1878	priority for the check watcher or use C<ev_clear_pending> explicitly, as	2002	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1879	the callbacks for the IO/timeout watchers might not have been called yet.	2003	the callbacks for the IO/timeout watchers might not have been called yet.
1880		2004
1881	static ev_io iow [nfd];	2005	static ev_io iow [nfd];
1882	static ev_timer tw;	2006	static ev_timer tw;
1883		2007
1884	static void	2008	static void
1885	io_cb (ev_loop *loop, ev_io *w, int revents)	2009	io_cb (ev_loop *loop, ev_io *w, int revents)
1886	{	2010	{
1887	}	2011	}
1888		2012
1889	// create io watchers for each fd and a timer before blocking	2013	// create io watchers for each fd and a timer before blocking
1890	static void	2014	static void
1891	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2015	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1892	{	2016	{
1893	int timeout = 3600000;	2017	int timeout = 3600000;
1894	struct pollfd fds [nfd];	2018	struct pollfd fds [nfd];
1895	// actual code will need to loop here and realloc etc.	2019	// actual code will need to loop here and realloc etc.
1896	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2020	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1897		2021
1898	/* the callback is illegal, but won't be called as we stop during check */	2022	/* the callback is illegal, but won't be called as we stop during check */
1899	ev_timer_init (&tw, 0, timeout * 1e-3);	2023	ev_timer_init (&tw, 0, timeout * 1e-3);
1900	ev_timer_start (loop, &tw);	2024	ev_timer_start (loop, &tw);
1901		2025
1902	// create one ev_io per pollfd	2026	// create one ev_io per pollfd
1903	for (int i = 0; i < nfd; ++i)	2027	for (int i = 0; i < nfd; ++i)
1904	{	2028	{
1905	ev_io_init (iow + i, io_cb, fds [i].fd,	2029	ev_io_init (iow + i, io_cb, fds [i].fd,
1906	((fds [i].events & POLLIN ? EV_READ : 0)	2030	((fds [i].events & POLLIN ? EV_READ : 0)
1907	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2031	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1908		2032
1909	fds [i].revents = 0;	2033	fds [i].revents = 0;
1910	ev_io_start (loop, iow + i);	2034	ev_io_start (loop, iow + i);
1911	}	2035	}
1912	}	2036	}
1913		2037
1914	// stop all watchers after blocking	2038	// stop all watchers after blocking
1915	static void	2039	static void
1916	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2040	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1917	{	2041	{
1918	ev_timer_stop (loop, &tw);	2042	ev_timer_stop (loop, &tw);
1919		2043
1920	for (int i = 0; i < nfd; ++i)	2044	for (int i = 0; i < nfd; ++i)
1921	{	2045	{
1922	// set the relevant poll flags	2046	// set the relevant poll flags
1923	// could also call adns_processreadable etc. here	2047	// could also call adns_processreadable etc. here
1924	struct pollfd *fd = fds + i;	2048	struct pollfd *fd = fds + i;
1925	int revents = ev_clear_pending (iow + i);	2049	int revents = ev_clear_pending (iow + i);
1926	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2050	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1927	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2051	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1928		2052
1929	// now stop the watcher	2053	// now stop the watcher
1930	ev_io_stop (loop, iow + i);	2054	ev_io_stop (loop, iow + i);
1931	}	2055	}
1932		2056
1933	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2057	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1934	}	2058	}
1935		2059
1936	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2060	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1937	in the prepare watcher and would dispose of the check watcher.	2061	in the prepare watcher and would dispose of the check watcher.
1938		2062
1939	Method 3: If the module to be embedded supports explicit event	2063	Method 3: If the module to be embedded supports explicit event
1940	notification (adns does), you can also make use of the actual watcher	2064	notification (libadns does), you can also make use of the actual watcher
1941	callbacks, and only destroy/create the watchers in the prepare watcher.	2065	callbacks, and only destroy/create the watchers in the prepare watcher.
1942		2066
1943	static void	2067	static void
1944	timer_cb (EV_P_ ev_timer *w, int revents)	2068	timer_cb (EV_P_ ev_timer *w, int revents)
1945	{	2069	{
1946	adns_state ads = (adns_state)w->data;	2070	adns_state ads = (adns_state)w->data;
1947	update_now (EV_A);	2071	update_now (EV_A);
1948		2072
1949	adns_processtimeouts (ads, &tv_now);	2073	adns_processtimeouts (ads, &tv_now);
1950	}	2074	}
1951		2075
1952	static void	2076	static void
1953	io_cb (EV_P_ ev_io *w, int revents)	2077	io_cb (EV_P_ ev_io *w, int revents)
1954	{	2078	{
1955	adns_state ads = (adns_state)w->data;	2079	adns_state ads = (adns_state)w->data;
1956	update_now (EV_A);	2080	update_now (EV_A);
1957		2081
1958	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2082	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1959	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2083	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1960	}	2084	}
1961		2085
1962	// do not ever call adns_afterpoll	2086	// do not ever call adns_afterpoll
1963		2087
1964	Method 4: Do not use a prepare or check watcher because the module you	2088	Method 4: Do not use a prepare or check watcher because the module you
1965	want to embed is too inflexible to support it. Instead, youc na override	2089	want to embed is too inflexible to support it. Instead, you can override
1966	their poll function. The drawback with this solution is that the main	2090	their poll function. The drawback with this solution is that the main
1967	loop is now no longer controllable by EV. The C<Glib::EV> module does	2091	loop is now no longer controllable by EV. The C<Glib::EV> module does
1968	this.	2092	this.
1969		2093
1970	static gint	2094	static gint
1971	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2095	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1972	{	2096	{
1973	int got_events = 0;	2097	int got_events = 0;
1974		2098
1975	for (n = 0; n < nfds; ++n)	2099	for (n = 0; n < nfds; ++n)
1976	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2100	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1977		2101
1978	if (timeout >= 0)	2102	if (timeout >= 0)
1979	// create/start timer	2103	// create/start timer
1980		2104
1981	// poll	2105	// poll
1982	ev_loop (EV_A_ 0);	2106	ev_loop (EV_A_ 0);
1983		2107
1984	// stop timer again	2108	// stop timer again
1985	if (timeout >= 0)	2109	if (timeout >= 0)
1986	ev_timer_stop (EV_A_ &to);	2110	ev_timer_stop (EV_A_ &to);
1987		2111
1988	// stop io watchers again - their callbacks should have set	2112	// stop io watchers again - their callbacks should have set
1989	for (n = 0; n < nfds; ++n)	2113	for (n = 0; n < nfds; ++n)
1990	ev_io_stop (EV_A_ iow [n]);	2114	ev_io_stop (EV_A_ iow [n]);
1991		2115
1992	return got_events;	2116	return got_events;
1993	}	2117	}
1994		2118
1995		2119
1996	=head2 C<ev_embed> - when one backend isn't enough...	2120	=head2 C<ev_embed> - when one backend isn't enough...
1997		2121
1998	This is a rather advanced watcher type that lets you embed one event loop	2122	This is a rather advanced watcher type that lets you embed one event loop
…		…
2054		2178
2055	Configures the watcher to embed the given loop, which must be	2179	Configures the watcher to embed the given loop, which must be
2056	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2180	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2057	invoked automatically, otherwise it is the responsibility of the callback	2181	invoked automatically, otherwise it is the responsibility of the callback
2058	to invoke it (it will continue to be called until the sweep has been done,	2182	to invoke it (it will continue to be called until the sweep has been done,
2059	if you do not want thta, you need to temporarily stop the embed watcher).	2183	if you do not want that, you need to temporarily stop the embed watcher).
2060		2184
2061	=item ev_embed_sweep (loop, ev_embed *)	2185	=item ev_embed_sweep (loop, ev_embed *)
2062		2186
2063	Make a single, non-blocking sweep over the embedded loop. This works	2187	Make a single, non-blocking sweep over the embedded loop. This works
2064	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2188	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
2065	apropriate way for embedded loops.	2189	appropriate way for embedded loops.
2066		2190
2067	=item struct ev_loop *other [read-only]	2191	=item struct ev_loop *other [read-only]
2068		2192
2069	The embedded event loop.	2193	The embedded event loop.
2070		2194
…		…
2072		2196
2073	=head3 Examples	2197	=head3 Examples
2074		2198
2075	Example: Try to get an embeddable event loop and embed it into the default	2199	Example: Try to get an embeddable event loop and embed it into the default
2076	event loop. If that is not possible, use the default loop. The default	2200	event loop. If that is not possible, use the default loop. The default
2077	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2201	loop is stored in C<loop_hi>, while the embeddable loop is stored in
2078	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2202	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2079	used).	2203	used).
2080		2204
2081	struct ev_loop *loop_hi = ev_default_init (0);	2205	struct ev_loop *loop_hi = ev_default_init (0);
2082	struct ev_loop *loop_lo = 0;	2206	struct ev_loop *loop_lo = 0;
2083	struct ev_embed embed;	2207	struct ev_embed embed;
2084		2208
2085	// see if there is a chance of getting one that works	2209	// see if there is a chance of getting one that works
2086	// (remember that a flags value of 0 means autodetection)	2210	// (remember that a flags value of 0 means autodetection)
2087	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2211	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2088	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2212	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2089	: 0;	2213	: 0;
2090		2214
2091	// if we got one, then embed it, otherwise default to loop_hi	2215	// if we got one, then embed it, otherwise default to loop_hi
2092	if (loop_lo)	2216	if (loop_lo)
2093	{	2217	{
2094	ev_embed_init (&embed, 0, loop_lo);	2218	ev_embed_init (&embed, 0, loop_lo);
2095	ev_embed_start (loop_hi, &embed);	2219	ev_embed_start (loop_hi, &embed);
2096	}	2220	}
2097	else	2221	else
2098	loop_lo = loop_hi;	2222	loop_lo = loop_hi;
2099		2223
2100	Example: Check if kqueue is available but not recommended and create	2224	Example: Check if kqueue is available but not recommended and create
2101	a kqueue backend for use with sockets (which usually work with any	2225	a kqueue backend for use with sockets (which usually work with any
2102	kqueue implementation). Store the kqueue/socket-only event loop in	2226	kqueue implementation). Store the kqueue/socket-only event loop in
2103	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2227	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2104		2228
2105	struct ev_loop *loop = ev_default_init (0);	2229	struct ev_loop *loop = ev_default_init (0);
2106	struct ev_loop *loop_socket = 0;	2230	struct ev_loop *loop_socket = 0;
2107	struct ev_embed embed;	2231	struct ev_embed embed;
2108		2232
2109	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2233	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2110	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2234	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2111	{	2235	{
2112	ev_embed_init (&embed, 0, loop_socket);	2236	ev_embed_init (&embed, 0, loop_socket);
2113	ev_embed_start (loop, &embed);	2237	ev_embed_start (loop, &embed);
2114	}	2238	}
2115		2239
2116	if (!loop_socket)	2240	if (!loop_socket)
2117	loop_socket = loop;	2241	loop_socket = loop;
2118		2242
2119	// now use loop_socket for all sockets, and loop for everything else	2243	// now use loop_socket for all sockets, and loop for everything else
2120		2244
2121		2245
2122	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2246	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2123		2247
2124	Fork watchers are called when a C<fork ()> was detected (usually because	2248	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2177		2301
2178	=item queueing from a signal handler context	2302	=item queueing from a signal handler context
2179		2303
2180	To implement race-free queueing, you simply add to the queue in the signal	2304	To implement race-free queueing, you simply add to the queue in the signal
2181	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2305	handler but you block the signal handler in the watcher callback. Here is an example that does that for
2182	some fictitiuous SIGUSR1 handler:	2306	some fictitious SIGUSR1 handler:
2183		2307
2184	static ev_async mysig;	2308	static ev_async mysig;
2185		2309
2186	static void	2310	static void
2187	sigusr1_handler (void)	2311	sigusr1_handler (void)
…		…
2261	=item ev_async_send (loop, ev_async *)	2385	=item ev_async_send (loop, ev_async *)
2262		2386
2263	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2387	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2264	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2388	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2265	C<ev_feed_event>, this call is safe to do in other threads, signal or	2389	C<ev_feed_event>, this call is safe to do in other threads, signal or
2266	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding	2390	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2267	section below on what exactly this means).	2391	section below on what exactly this means).
2268		2392
2269	This call incurs the overhead of a syscall only once per loop iteration,	2393	This call incurs the overhead of a system call only once per loop iteration,
2270	so while the overhead might be noticable, it doesn't apply to repeated	2394	so while the overhead might be noticeable, it doesn't apply to repeated
2271	calls to C<ev_async_send>.	2395	calls to C<ev_async_send>.
		2396
		2397	=item bool = ev_async_pending (ev_async *)
		2398
		2399	Returns a non-zero value when C<ev_async_send> has been called on the
		2400	watcher but the event has not yet been processed (or even noted) by the
		2401	event loop.
		2402
		2403	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2404	the loop iterates next and checks for the watcher to have become active,
		2405	it will reset the flag again. C<ev_async_pending> can be used to very
		2406	quickly check whether invoking the loop might be a good idea.
		2407
		2408	Not that this does I<not> check whether the watcher itself is pending, only
		2409	whether it has been requested to make this watcher pending.
2272		2410
2273	=back	2411	=back
2274		2412
2275		2413
2276	=head1 OTHER FUNCTIONS	2414	=head1 OTHER FUNCTIONS
…		…
2287	or timeout without having to allocate/configure/start/stop/free one or	2425	or timeout without having to allocate/configure/start/stop/free one or
2288	more watchers yourself.	2426	more watchers yourself.
2289		2427
2290	If C<fd> is less than 0, then no I/O watcher will be started and events	2428	If C<fd> is less than 0, then no I/O watcher will be started and events
2291	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2429	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
2292	C<events> set will be craeted and started.	2430	C<events> set will be created and started.
2293		2431
2294	If C<timeout> is less than 0, then no timeout watcher will be	2432	If C<timeout> is less than 0, then no timeout watcher will be
2295	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2433	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2296	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2434	repeat = 0) will be started. While C<0> is a valid timeout, it is of
2297	dubious value.	2435	dubious value.
…		…
2299	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2437	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2300	passed an C<revents> set like normal event callbacks (a combination of	2438	passed an C<revents> set like normal event callbacks (a combination of
2301	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2439	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2302	value passed to C<ev_once>:	2440	value passed to C<ev_once>:
2303		2441
2304	static void stdin_ready (int revents, void *arg)	2442	static void stdin_ready (int revents, void *arg)
2305	{	2443	{
2306	if (revents & EV_TIMEOUT)	2444	if (revents & EV_TIMEOUT)
2307	/* doh, nothing entered */;	2445	/* doh, nothing entered */;
2308	else if (revents & EV_READ)	2446	else if (revents & EV_READ)
2309	/* stdin might have data for us, joy! */;	2447	/* stdin might have data for us, joy! */;
2310	}	2448	}
2311		2449
2312	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2450	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2313		2451
2314	=item ev_feed_event (ev_loop *, watcher *, int revents)	2452	=item ev_feed_event (ev_loop *, watcher *, int revents)
2315		2453
2316	Feeds the given event set into the event loop, as if the specified event	2454	Feeds the given event set into the event loop, as if the specified event
2317	had happened for the specified watcher (which must be a pointer to an	2455	had happened for the specified watcher (which must be a pointer to an
…		…
2322	Feed an event on the given fd, as if a file descriptor backend detected	2460	Feed an event on the given fd, as if a file descriptor backend detected
2323	the given events it.	2461	the given events it.
2324		2462
2325	=item ev_feed_signal_event (ev_loop *loop, int signum)	2463	=item ev_feed_signal_event (ev_loop *loop, int signum)
2326		2464
2327	Feed an event as if the given signal occured (C<loop> must be the default	2465	Feed an event as if the given signal occurred (C<loop> must be the default
2328	loop!).	2466	loop!).
2329		2467
2330	=back	2468	=back
2331		2469
2332		2470
…		…
2348		2486
2349	=item * Priorities are not currently supported. Initialising priorities	2487	=item * Priorities are not currently supported. Initialising priorities
2350	will fail and all watchers will have the same priority, even though there	2488	will fail and all watchers will have the same priority, even though there
2351	is an ev_pri field.	2489	is an ev_pri field.
2352		2490
		2491	=item * In libevent, the last base created gets the signals, in libev, the
		2492	first base created (== the default loop) gets the signals.
		2493
2353	=item * Other members are not supported.	2494	=item * Other members are not supported.
2354		2495
2355	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2496	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2356	to use the libev header file and library.	2497	to use the libev header file and library.
2357		2498
2358	=back	2499	=back
2359		2500
2360	=head1 C++ SUPPORT	2501	=head1 C++ SUPPORT
2361		2502
2362	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2503	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2363	you to use some convinience methods to start/stop watchers and also change	2504	you to use some convenience methods to start/stop watchers and also change
2364	the callback model to a model using method callbacks on objects.	2505	the callback model to a model using method callbacks on objects.
2365		2506
2366	To use it,	2507	To use it,
2367		2508
2368	#include <ev++.h>	2509	#include <ev++.h>
2369		2510
2370	This automatically includes F<ev.h> and puts all of its definitions (many	2511	This automatically includes F<ev.h> and puts all of its definitions (many
2371	of them macros) into the global namespace. All C++ specific things are	2512	of them macros) into the global namespace. All C++ specific things are
2372	put into the C<ev> namespace. It should support all the same embedding	2513	put into the C<ev> namespace. It should support all the same embedding
2373	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2514	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2440	your compiler is good :), then the method will be fully inlined into the	2581	your compiler is good :), then the method will be fully inlined into the
2441	thunking function, making it as fast as a direct C callback.	2582	thunking function, making it as fast as a direct C callback.
2442		2583
2443	Example: simple class declaration and watcher initialisation	2584	Example: simple class declaration and watcher initialisation
2444		2585
2445	struct myclass	2586	struct myclass
2446	{	2587	{
2447	void io_cb (ev::io &w, int revents) { }	2588	void io_cb (ev::io &w, int revents) { }
2448	}	2589	}
2449		2590
2450	myclass obj;	2591	myclass obj;
2451	ev::io iow;	2592	ev::io iow;
2452	iow.set <myclass, &myclass::io_cb> (&obj);	2593	iow.set <myclass, &myclass::io_cb> (&obj);
2453		2594
2454	=item w->set<function> (void *data = 0)	2595	=item w->set<function> (void *data = 0)
2455		2596
2456	Also sets a callback, but uses a static method or plain function as	2597	Also sets a callback, but uses a static method or plain function as
2457	callback. The optional C<data> argument will be stored in the watcher's	2598	callback. The optional C<data> argument will be stored in the watcher's
…		…
2461		2602
2462	See the method-C<set> above for more details.	2603	See the method-C<set> above for more details.
2463		2604
2464	Example:	2605	Example:
2465		2606
2466	static void io_cb (ev::io &w, int revents) { }	2607	static void io_cb (ev::io &w, int revents) { }
2467	iow.set <io_cb> ();	2608	iow.set <io_cb> ();
2468		2609
2469	=item w->set (struct ev_loop *)	2610	=item w->set (struct ev_loop *)
2470		2611
2471	Associates a different C<struct ev_loop> with this watcher. You can only	2612	Associates a different C<struct ev_loop> with this watcher. You can only
2472	do this when the watcher is inactive (and not pending either).	2613	do this when the watcher is inactive (and not pending either).
2473		2614
2474	=item w->set ([args])	2615	=item w->set ([arguments])
2475		2616
2476	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2617	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2477	called at least once. Unlike the C counterpart, an active watcher gets	2618	called at least once. Unlike the C counterpart, an active watcher gets
2478	automatically stopped and restarted when reconfiguring it with this	2619	automatically stopped and restarted when reconfiguring it with this
2479	method.	2620	method.
2480		2621
2481	=item w->start ()	2622	=item w->start ()
…		…
2505	=back	2646	=back
2506		2647
2507	Example: Define a class with an IO and idle watcher, start one of them in	2648	Example: Define a class with an IO and idle watcher, start one of them in
2508	the constructor.	2649	the constructor.
2509		2650
2510	class myclass	2651	class myclass
2511	{	2652	{
2512	ev::io io; void io_cb (ev::io &w, int revents);	2653	ev::io io; void io_cb (ev::io &w, int revents);
2513	ev:idle idle void idle_cb (ev::idle &w, int revents);	2654	ev:idle idle void idle_cb (ev::idle &w, int revents);
2514		2655
2515	myclass (int fd)	2656	myclass (int fd)
2516	{	2657	{
2517	io .set <myclass, &myclass::io_cb > (this);	2658	io .set <myclass, &myclass::io_cb > (this);
2518	idle.set <myclass, &myclass::idle_cb> (this);	2659	idle.set <myclass, &myclass::idle_cb> (this);
2519		2660
2520	io.start (fd, ev::READ);	2661	io.start (fd, ev::READ);
2521	}	2662	}
2522	};	2663	};
2523		2664
2524		2665
2525	=head1 OTHER LANGUAGE BINDINGS	2666	=head1 OTHER LANGUAGE BINDINGS
2526		2667
2527	Libev does not offer other language bindings itself, but bindings for a	2668	Libev does not offer other language bindings itself, but bindings for a
2528	numbe rof languages exist in the form of third-party packages. If you know	2669	number of languages exist in the form of third-party packages. If you know
2529	any interesting language binding in addition to the ones listed here, drop	2670	any interesting language binding in addition to the ones listed here, drop
2530	me a note.	2671	me a note.
2531		2672
2532	=over 4	2673	=over 4
2533		2674
…		…
2537	libev. EV is developed together with libev. Apart from the EV core module,	2678	libev. EV is developed together with libev. Apart from the EV core module,
2538	there are additional modules that implement libev-compatible interfaces	2679	there are additional modules that implement libev-compatible interfaces
2539	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	2680	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2540	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	2681	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2541		2682
2542	It can be found and installed via CPAN, its homepage is found at	2683	It can be found and installed via CPAN, its homepage is at
2543	L<http://software.schmorp.de/pkg/EV>.	2684	L<http://software.schmorp.de/pkg/EV>.
2544		2685
		2686	=item Python
		2687
		2688	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		2689	seems to be quite complete and well-documented. Note, however, that the
		2690	patch they require for libev is outright dangerous as it breaks the ABI
		2691	for everybody else, and therefore, should never be applied in an installed
		2692	libev (if python requires an incompatible ABI then it needs to embed
		2693	libev).
		2694
2545	=item Ruby	2695	=item Ruby
2546		2696
2547	Tony Arcieri has written a ruby extension that offers access to a subset	2697	Tony Arcieri has written a ruby extension that offers access to a subset
2548	of the libev API and adds filehandle abstractions, asynchronous DNS and	2698	of the libev API and adds file handle abstractions, asynchronous DNS and
2549	more on top of it. It can be found via gem servers. Its homepage is at	2699	more on top of it. It can be found via gem servers. Its homepage is at
2550	L<http://rev.rubyforge.org/>.	2700	L<http://rev.rubyforge.org/>.
2551		2701
2552	=item D	2702	=item D
2553		2703
2554	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	2704	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2555	be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.	2705	be found at L<http://proj.llucax.com.ar/wiki/evd>.
2556		2706
2557	=back	2707	=back
2558		2708
2559		2709
2560	=head1 MACRO MAGIC	2710	=head1 MACRO MAGIC
2561		2711
2562	Libev can be compiled with a variety of options, the most fundamantal	2712	Libev can be compiled with a variety of options, the most fundamental
2563	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	2713	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2564	functions and callbacks have an initial C<struct ev_loop *> argument.	2714	functions and callbacks have an initial C<struct ev_loop *> argument.
2565		2715
2566	To make it easier to write programs that cope with either variant, the	2716	To make it easier to write programs that cope with either variant, the
2567	following macros are defined:	2717	following macros are defined:
…		…
2572		2722
2573	This provides the loop I<argument> for functions, if one is required ("ev	2723	This provides the loop I<argument> for functions, if one is required ("ev
2574	loop argument"). The C<EV_A> form is used when this is the sole argument,	2724	loop argument"). The C<EV_A> form is used when this is the sole argument,
2575	C<EV_A_> is used when other arguments are following. Example:	2725	C<EV_A_> is used when other arguments are following. Example:
2576		2726
2577	ev_unref (EV_A);	2727	ev_unref (EV_A);
2578	ev_timer_add (EV_A_ watcher);	2728	ev_timer_add (EV_A_ watcher);
2579	ev_loop (EV_A_ 0);	2729	ev_loop (EV_A_ 0);
2580		2730
2581	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	2731	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2582	which is often provided by the following macro.	2732	which is often provided by the following macro.
2583		2733
2584	=item C<EV_P>, C<EV_P_>	2734	=item C<EV_P>, C<EV_P_>
2585		2735
2586	This provides the loop I<parameter> for functions, if one is required ("ev	2736	This provides the loop I<parameter> for functions, if one is required ("ev
2587	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	2737	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2588	C<EV_P_> is used when other parameters are following. Example:	2738	C<EV_P_> is used when other parameters are following. Example:
2589		2739
2590	// this is how ev_unref is being declared	2740	// this is how ev_unref is being declared
2591	static void ev_unref (EV_P);	2741	static void ev_unref (EV_P);
2592		2742
2593	// this is how you can declare your typical callback	2743	// this is how you can declare your typical callback
2594	static void cb (EV_P_ ev_timer *w, int revents)	2744	static void cb (EV_P_ ev_timer *w, int revents)
2595		2745
2596	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	2746	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2597	suitable for use with C<EV_A>.	2747	suitable for use with C<EV_A>.
2598		2748
2599	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	2749	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2600		2750
2601	Similar to the other two macros, this gives you the value of the default	2751	Similar to the other two macros, this gives you the value of the default
2602	loop, if multiple loops are supported ("ev loop default").	2752	loop, if multiple loops are supported ("ev loop default").
		2753
		2754	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		2755
		2756	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		2757	default loop has been initialised (C<UC> == unchecked). Their behaviour
		2758	is undefined when the default loop has not been initialised by a previous
		2759	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		2760
		2761	It is often prudent to use C<EV_DEFAULT> when initialising the first
		2762	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2603		2763
2604	=back	2764	=back
2605		2765
2606	Example: Declare and initialise a check watcher, utilising the above	2766	Example: Declare and initialise a check watcher, utilising the above
2607	macros so it will work regardless of whether multiple loops are supported	2767	macros so it will work regardless of whether multiple loops are supported
2608	or not.	2768	or not.
2609		2769
2610	static void	2770	static void
2611	check_cb (EV_P_ ev_timer *w, int revents)	2771	check_cb (EV_P_ ev_timer *w, int revents)
2612	{	2772	{
2613	ev_check_stop (EV_A_ w);	2773	ev_check_stop (EV_A_ w);
2614	}	2774	}
2615		2775
2616	ev_check check;	2776	ev_check check;
2617	ev_check_init (&check, check_cb);	2777	ev_check_init (&check, check_cb);
2618	ev_check_start (EV_DEFAULT_ &check);	2778	ev_check_start (EV_DEFAULT_ &check);
2619	ev_loop (EV_DEFAULT_ 0);	2779	ev_loop (EV_DEFAULT_ 0);
2620		2780
2621	=head1 EMBEDDING	2781	=head1 EMBEDDING
2622		2782
2623	Libev can (and often is) directly embedded into host	2783	Libev can (and often is) directly embedded into host
2624	applications. Examples of applications that embed it include the Deliantra	2784	applications. Examples of applications that embed it include the Deliantra
…		…
2631	libev somewhere in your source tree).	2791	libev somewhere in your source tree).
2632		2792
2633	=head2 FILESETS	2793	=head2 FILESETS
2634		2794
2635	Depending on what features you need you need to include one or more sets of files	2795	Depending on what features you need you need to include one or more sets of files
2636	in your app.	2796	in your application.
2637		2797
2638	=head3 CORE EVENT LOOP	2798	=head3 CORE EVENT LOOP
2639		2799
2640	To include only the libev core (all the C<ev_*> functions), with manual	2800	To include only the libev core (all the C<ev_*> functions), with manual
2641	configuration (no autoconf):	2801	configuration (no autoconf):
2642		2802
2643	#define EV_STANDALONE 1	2803	#define EV_STANDALONE 1
2644	#include "ev.c"	2804	#include "ev.c"
2645		2805
2646	This will automatically include F<ev.h>, too, and should be done in a	2806	This will automatically include F<ev.h>, too, and should be done in a
2647	single C source file only to provide the function implementations. To use	2807	single C source file only to provide the function implementations. To use
2648	it, do the same for F<ev.h> in all files wishing to use this API (best	2808	it, do the same for F<ev.h> in all files wishing to use this API (best
2649	done by writing a wrapper around F<ev.h> that you can include instead and	2809	done by writing a wrapper around F<ev.h> that you can include instead and
2650	where you can put other configuration options):	2810	where you can put other configuration options):
2651		2811
2652	#define EV_STANDALONE 1	2812	#define EV_STANDALONE 1
2653	#include "ev.h"	2813	#include "ev.h"
2654		2814
2655	Both header files and implementation files can be compiled with a C++	2815	Both header files and implementation files can be compiled with a C++
2656	compiler (at least, thats a stated goal, and breakage will be treated	2816	compiler (at least, thats a stated goal, and breakage will be treated
2657	as a bug).	2817	as a bug).
2658		2818
2659	You need the following files in your source tree, or in a directory	2819	You need the following files in your source tree, or in a directory
2660	in your include path (e.g. in libev/ when using -Ilibev):	2820	in your include path (e.g. in libev/ when using -Ilibev):
2661		2821
2662	ev.h	2822	ev.h
2663	ev.c	2823	ev.c
2664	ev_vars.h	2824	ev_vars.h
2665	ev_wrap.h	2825	ev_wrap.h
2666		2826
2667	ev_win32.c required on win32 platforms only	2827	ev_win32.c required on win32 platforms only
2668		2828
2669	ev_select.c only when select backend is enabled (which is enabled by default)	2829	ev_select.c only when select backend is enabled (which is enabled by default)
2670	ev_poll.c only when poll backend is enabled (disabled by default)	2830	ev_poll.c only when poll backend is enabled (disabled by default)
2671	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2831	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2672	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2832	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2673	ev_port.c only when the solaris port backend is enabled (disabled by default)	2833	ev_port.c only when the solaris port backend is enabled (disabled by default)
2674		2834
2675	F<ev.c> includes the backend files directly when enabled, so you only need	2835	F<ev.c> includes the backend files directly when enabled, so you only need
2676	to compile this single file.	2836	to compile this single file.
2677		2837
2678	=head3 LIBEVENT COMPATIBILITY API	2838	=head3 LIBEVENT COMPATIBILITY API
2679		2839
2680	To include the libevent compatibility API, also include:	2840	To include the libevent compatibility API, also include:
2681		2841
2682	#include "event.c"	2842	#include "event.c"
2683		2843
2684	in the file including F<ev.c>, and:	2844	in the file including F<ev.c>, and:
2685		2845
2686	#include "event.h"	2846	#include "event.h"
2687		2847
2688	in the files that want to use the libevent API. This also includes F<ev.h>.	2848	in the files that want to use the libevent API. This also includes F<ev.h>.
2689		2849
2690	You need the following additional files for this:	2850	You need the following additional files for this:
2691		2851
2692	event.h	2852	event.h
2693	event.c	2853	event.c
2694		2854
2695	=head3 AUTOCONF SUPPORT	2855	=head3 AUTOCONF SUPPORT
2696		2856
2697	Instead of using C<EV_STANDALONE=1> and providing your config in	2857	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2698	whatever way you want, you can also C<m4_include([libev.m4])> in your	2858	whatever way you want, you can also C<m4_include([libev.m4])> in your
2699	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	2859	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2700	include F<config.h> and configure itself accordingly.	2860	include F<config.h> and configure itself accordingly.
2701		2861
2702	For this of course you need the m4 file:	2862	For this of course you need the m4 file:
2703		2863
2704	libev.m4	2864	libev.m4
2705		2865
2706	=head2 PREPROCESSOR SYMBOLS/MACROS	2866	=head2 PREPROCESSOR SYMBOLS/MACROS
2707		2867
2708	Libev can be configured via a variety of preprocessor symbols you have to define	2868	Libev can be configured via a variety of preprocessor symbols you have to
2709	before including any of its files. The default is not to build for multiplicity	2869	define before including any of its files. The default in the absence of
2710	and only include the select backend.	2870	autoconf is noted for every option.
2711		2871
2712	=over 4	2872	=over 4
2713		2873
2714	=item EV_STANDALONE	2874	=item EV_STANDALONE
2715		2875
…		…
2720	F<event.h> that are not directly supported by the libev core alone.	2880	F<event.h> that are not directly supported by the libev core alone.
2721		2881
2722	=item EV_USE_MONOTONIC	2882	=item EV_USE_MONOTONIC
2723		2883
2724	If defined to be C<1>, libev will try to detect the availability of the	2884	If defined to be C<1>, libev will try to detect the availability of the
2725	monotonic clock option at both compiletime and runtime. Otherwise no use	2885	monotonic clock option at both compile time and runtime. Otherwise no use
2726	of the monotonic clock option will be attempted. If you enable this, you	2886	of the monotonic clock option will be attempted. If you enable this, you
2727	usually have to link against librt or something similar. Enabling it when	2887	usually have to link against librt or something similar. Enabling it when
2728	the functionality isn't available is safe, though, although you have	2888	the functionality isn't available is safe, though, although you have
2729	to make sure you link against any libraries where the C<clock_gettime>	2889	to make sure you link against any libraries where the C<clock_gettime>
2730	function is hiding in (often F<-lrt>).	2890	function is hiding in (often F<-lrt>).
2731		2891
2732	=item EV_USE_REALTIME	2892	=item EV_USE_REALTIME
2733		2893
2734	If defined to be C<1>, libev will try to detect the availability of the	2894	If defined to be C<1>, libev will try to detect the availability of the
2735	realtime clock option at compiletime (and assume its availability at	2895	real-time clock option at compile time (and assume its availability at
2736	runtime if successful). Otherwise no use of the realtime clock option will	2896	runtime if successful). Otherwise no use of the real-time clock option will
2737	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2897	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2738	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	2898	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2739	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	2899	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2740		2900
2741	=item EV_USE_NANOSLEEP	2901	=item EV_USE_NANOSLEEP
2742		2902
2743	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	2903	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2744	and will use it for delays. Otherwise it will use C<select ()>.	2904	and will use it for delays. Otherwise it will use C<select ()>.
2745		2905
		2906	=item EV_USE_EVENTFD
		2907
		2908	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		2909	available and will probe for kernel support at runtime. This will improve
		2910	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		2911	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		2912	2.7 or newer, otherwise disabled.
		2913
2746	=item EV_USE_SELECT	2914	=item EV_USE_SELECT
2747		2915
2748	If undefined or defined to be C<1>, libev will compile in support for the	2916	If undefined or defined to be C<1>, libev will compile in support for the
2749	C<select>(2) backend. No attempt at autodetection will be done: if no	2917	C<select>(2) backend. No attempt at auto-detection will be done: if no
2750	other method takes over, select will be it. Otherwise the select backend	2918	other method takes over, select will be it. Otherwise the select backend
2751	will not be compiled in.	2919	will not be compiled in.
2752		2920
2753	=item EV_SELECT_USE_FD_SET	2921	=item EV_SELECT_USE_FD_SET
2754		2922
2755	If defined to C<1>, then the select backend will use the system C<fd_set>	2923	If defined to C<1>, then the select backend will use the system C<fd_set>
2756	structure. This is useful if libev doesn't compile due to a missing	2924	structure. This is useful if libev doesn't compile due to a missing
2757	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	2925	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on
2758	exotic systems. This usually limits the range of file descriptors to some	2926	exotic systems. This usually limits the range of file descriptors to some
2759	low limit such as 1024 or might have other limitations (winsocket only	2927	low limit such as 1024 or might have other limitations (winsocket only
2760	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	2928	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
2761	influence the size of the C<fd_set> used.	2929	influence the size of the C<fd_set> used.
2762		2930
…		…
2786		2954
2787	=item EV_USE_EPOLL	2955	=item EV_USE_EPOLL
2788		2956
2789	If defined to be C<1>, libev will compile in support for the Linux	2957	If defined to be C<1>, libev will compile in support for the Linux
2790	C<epoll>(7) backend. Its availability will be detected at runtime,	2958	C<epoll>(7) backend. Its availability will be detected at runtime,
2791	otherwise another method will be used as fallback. This is the	2959	otherwise another method will be used as fallback. This is the preferred
2792	preferred backend for GNU/Linux systems.	2960	backend for GNU/Linux systems. If undefined, it will be enabled if the
		2961	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2793		2962
2794	=item EV_USE_KQUEUE	2963	=item EV_USE_KQUEUE
2795		2964
2796	If defined to be C<1>, libev will compile in support for the BSD style	2965	If defined to be C<1>, libev will compile in support for the BSD style
2797	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	2966	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2810	otherwise another method will be used as fallback. This is the preferred	2979	otherwise another method will be used as fallback. This is the preferred
2811	backend for Solaris 10 systems.	2980	backend for Solaris 10 systems.
2812		2981
2813	=item EV_USE_DEVPOLL	2982	=item EV_USE_DEVPOLL
2814		2983
2815	reserved for future expansion, works like the USE symbols above.	2984	Reserved for future expansion, works like the USE symbols above.
2816		2985
2817	=item EV_USE_INOTIFY	2986	=item EV_USE_INOTIFY
2818		2987
2819	If defined to be C<1>, libev will compile in support for the Linux inotify	2988	If defined to be C<1>, libev will compile in support for the Linux inotify
2820	interface to speed up C<ev_stat> watchers. Its actual availability will	2989	interface to speed up C<ev_stat> watchers. Its actual availability will
2821	be detected at runtime.	2990	be detected at runtime. If undefined, it will be enabled if the headers
		2991	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2822		2992
2823	=item EV_ATOMIC_T	2993	=item EV_ATOMIC_T
2824		2994
2825	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	2995	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2826	access is atomic with respect to other threads or signal contexts. No such	2996	access is atomic with respect to other threads or signal contexts. No such
2827	type is easily found in the C language, so you can provide your own type	2997	type is easily found in the C language, so you can provide your own type
2828	that you know is safe for your purposes. It is used both for signal handler "locking"	2998	that you know is safe for your purposes. It is used both for signal handler "locking"
2829	as well as for signal and thread safety in C<ev_async> watchers.	2999	as well as for signal and thread safety in C<ev_async> watchers.
2830		3000
2831	In the absense of this define, libev will use C<sig_atomic_t volatile>	3001	In the absence of this define, libev will use C<sig_atomic_t volatile>
2832	(from F<signal.h>), which is usually good enough on most platforms.	3002	(from F<signal.h>), which is usually good enough on most platforms.
2833		3003
2834	=item EV_H	3004	=item EV_H
2835		3005
2836	The name of the F<ev.h> header file used to include it. The default if	3006	The name of the F<ev.h> header file used to include it. The default if
…		…
2875	When doing priority-based operations, libev usually has to linearly search	3045	When doing priority-based operations, libev usually has to linearly search
2876	all the priorities, so having many of them (hundreds) uses a lot of space	3046	all the priorities, so having many of them (hundreds) uses a lot of space
2877	and time, so using the defaults of five priorities (-2 .. +2) is usually	3047	and time, so using the defaults of five priorities (-2 .. +2) is usually
2878	fine.	3048	fine.
2879		3049
2880	If your embedding app does not need any priorities, defining these both to	3050	If your embedding application does not need any priorities, defining these both to
2881	C<0> will save some memory and cpu.	3051	C<0> will save some memory and CPU.
2882		3052
2883	=item EV_PERIODIC_ENABLE	3053	=item EV_PERIODIC_ENABLE
2884		3054
2885	If undefined or defined to be C<1>, then periodic timers are supported. If	3055	If undefined or defined to be C<1>, then periodic timers are supported. If
2886	defined to be C<0>, then they are not. Disabling them saves a few kB of	3056	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2913	defined to be C<0>, then they are not.	3083	defined to be C<0>, then they are not.
2914		3084
2915	=item EV_MINIMAL	3085	=item EV_MINIMAL
2916		3086
2917	If you need to shave off some kilobytes of code at the expense of some	3087	If you need to shave off some kilobytes of code at the expense of some
2918	speed, define this symbol to C<1>. Currently only used for gcc to override	3088	speed, define this symbol to C<1>. Currently this is used to override some
2919	some inlining decisions, saves roughly 30% codesize of amd64.	3089	inlining decisions, saves roughly 30% code size on amd64. It also selects a
		3090	much smaller 2-heap for timer management over the default 4-heap.
2920		3091
2921	=item EV_PID_HASHSIZE	3092	=item EV_PID_HASHSIZE
2922		3093
2923	C<ev_child> watchers use a small hash table to distribute workload by	3094	C<ev_child> watchers use a small hash table to distribute workload by
2924	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3095	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2931	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3102	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2932	usually more than enough. If you need to manage thousands of C<ev_stat>	3103	usually more than enough. If you need to manage thousands of C<ev_stat>
2933	watchers you might want to increase this value (I<must> be a power of	3104	watchers you might want to increase this value (I<must> be a power of
2934	two).	3105	two).
2935		3106
		3107	=item EV_USE_4HEAP
		3108
		3109	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3110	timer and periodics heap, libev uses a 4-heap when this symbol is defined
		3111	to C<1>. The 4-heap uses more complicated (longer) code but has
		3112	noticeably faster performance with many (thousands) of watchers.
		3113
		3114	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3115	(disabled).
		3116
		3117	=item EV_HEAP_CACHE_AT
		3118
		3119	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3120	timer and periodics heap, libev can cache the timestamp (I<at>) within
		3121	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3122	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3123	but avoids random read accesses on heap changes. This improves performance
		3124	noticeably with with many (hundreds) of watchers.
		3125
		3126	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3127	(disabled).
		3128
		3129	=item EV_VERIFY
		3130
		3131	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3132	be done: If set to C<0>, no internal verification code will be compiled
		3133	in. If set to C<1>, then verification code will be compiled in, but not
		3134	called. If set to C<2>, then the internal verification code will be
		3135	called once per loop, which can slow down libev. If set to C<3>, then the
		3136	verification code will be called very frequently, which will slow down
		3137	libev considerably.
		3138
		3139	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3140	C<0.>
		3141
2936	=item EV_COMMON	3142	=item EV_COMMON
2937		3143
2938	By default, all watchers have a C<void *data> member. By redefining	3144	By default, all watchers have a C<void *data> member. By redefining
2939	this macro to a something else you can include more and other types of	3145	this macro to a something else you can include more and other types of
2940	members. You have to define it each time you include one of the files,	3146	members. You have to define it each time you include one of the files,
2941	though, and it must be identical each time.	3147	though, and it must be identical each time.
2942		3148
2943	For example, the perl EV module uses something like this:	3149	For example, the perl EV module uses something like this:
2944		3150
2945	#define EV_COMMON \	3151	#define EV_COMMON \
2946	SV *self; /* contains this struct */ \	3152	SV *self; /* contains this struct */ \
2947	SV *cb_sv, *fh /* note no trailing ";" */	3153	SV *cb_sv, *fh /* note no trailing ";" */
2948		3154
2949	=item EV_CB_DECLARE (type)	3155	=item EV_CB_DECLARE (type)
2950		3156
2951	=item EV_CB_INVOKE (watcher, revents)	3157	=item EV_CB_INVOKE (watcher, revents)
2952		3158
…		…
2959	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3165	avoid the C<struct ev_loop *> as first argument in all cases, or to use
2960	method calls instead of plain function calls in C++.	3166	method calls instead of plain function calls in C++.
2961		3167
2962	=head2 EXPORTED API SYMBOLS	3168	=head2 EXPORTED API SYMBOLS
2963		3169
2964	If you need to re-export the API (e.g. via a dll) and you need a list of	3170	If you need to re-export the API (e.g. via a DLL) and you need a list of
2965	exported symbols, you can use the provided F<Symbol.*> files which list	3171	exported symbols, you can use the provided F<Symbol.*> files which list
2966	all public symbols, one per line:	3172	all public symbols, one per line:
2967		3173
2968	Symbols.ev for libev proper	3174	Symbols.ev for libev proper
2969	Symbols.event for the libevent emulation	3175	Symbols.event for the libevent emulation
2970		3176
2971	This can also be used to rename all public symbols to avoid clashes with	3177	This can also be used to rename all public symbols to avoid clashes with
2972	multiple versions of libev linked together (which is obviously bad in	3178	multiple versions of libev linked together (which is obviously bad in
2973	itself, but sometimes it is inconvinient to avoid this).	3179	itself, but sometimes it is inconvenient to avoid this).
2974		3180
2975	A sed command like this will create wrapper C<#define>'s that you need to	3181	A sed command like this will create wrapper C<#define>'s that you need to
2976	include before including F<ev.h>:	3182	include before including F<ev.h>:
2977		3183
2978	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3184	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
2995	file.	3201	file.
2996		3202
2997	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3203	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2998	that everybody includes and which overrides some configure choices:	3204	that everybody includes and which overrides some configure choices:
2999		3205
3000	#define EV_MINIMAL 1	3206	#define EV_MINIMAL 1
3001	#define EV_USE_POLL 0	3207	#define EV_USE_POLL 0
3002	#define EV_MULTIPLICITY 0	3208	#define EV_MULTIPLICITY 0
3003	#define EV_PERIODIC_ENABLE 0	3209	#define EV_PERIODIC_ENABLE 0
3004	#define EV_STAT_ENABLE 0	3210	#define EV_STAT_ENABLE 0
3005	#define EV_FORK_ENABLE 0	3211	#define EV_FORK_ENABLE 0
3006	#define EV_CONFIG_H <config.h>	3212	#define EV_CONFIG_H <config.h>
3007	#define EV_MINPRI 0	3213	#define EV_MINPRI 0
3008	#define EV_MAXPRI 0	3214	#define EV_MAXPRI 0
3009		3215
3010	#include "ev++.h"	3216	#include "ev++.h"
3011		3217
3012	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3218	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3013		3219
3014	#include "ev_cpp.h"	3220	#include "ev_cpp.h"
3015	#include "ev.c"	3221	#include "ev.c"
		3222
		3223
		3224	=head1 THREADS AND COROUTINES
		3225
		3226	=head2 THREADS
		3227
		3228	Libev itself is completely thread-safe, but it uses no locking. This
		3229	means that you can use as many loops as you want in parallel, as long as
		3230	only one thread ever calls into one libev function with the same loop
		3231	parameter.
		3232
		3233	Or put differently: calls with different loop parameters can be done in
		3234	parallel from multiple threads, calls with the same loop parameter must be
		3235	done serially (but can be done from different threads, as long as only one
		3236	thread ever is inside a call at any point in time, e.g. by using a mutex
		3237	per loop).
		3238
		3239	If you want to know which design (one loop, locking, or multiple loops
		3240	without or something else still) is best for your problem, then I cannot
		3241	help you. I can give some generic advice however:
		3242
		3243	=over 4
		3244
		3245	=item * most applications have a main thread: use the default libev loop
		3246	in that thread, or create a separate thread running only the default loop.
		3247
		3248	This helps integrating other libraries or software modules that use libev
		3249	themselves and don't care/know about threading.
		3250
		3251	=item * one loop per thread is usually a good model.
		3252
		3253	Doing this is almost never wrong, sometimes a better-performance model
		3254	exists, but it is always a good start.
		3255
		3256	=item * other models exist, such as the leader/follower pattern, where one
		3257	loop is handed through multiple threads in a kind of round-robin fashion.
		3258
		3259	Choosing a model is hard - look around, learn, know that usually you can do
		3260	better than you currently do :-)
		3261
		3262	=item * often you need to talk to some other thread which blocks in the
		3263	event loop - C<ev_async> watchers can be used to wake them up from other
		3264	threads safely (or from signal contexts...).
		3265
		3266	=back
		3267
		3268	=head2 COROUTINES
		3269
		3270	Libev is much more accommodating to coroutines ("cooperative threads"):
		3271	libev fully supports nesting calls to it's functions from different
		3272	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3273	different coroutines and switch freely between both coroutines running the
		3274	loop, as long as you don't confuse yourself). The only exception is that
		3275	you must not do this from C<ev_periodic> reschedule callbacks.
		3276
		3277	Care has been invested into making sure that libev does not keep local
		3278	state inside C<ev_loop>, and other calls do not usually allow coroutine
		3279	switches.
3016		3280
3017		3281
3018	=head1 COMPLEXITIES	3282	=head1 COMPLEXITIES
3019		3283
3020	In this section the complexities of (many of) the algorithms used inside	3284	In this section the complexities of (many of) the algorithms used inside
…		…
3052	correct watcher to remove. The lists are usually short (you don't usually	3316	correct watcher to remove. The lists are usually short (you don't usually
3053	have many watchers waiting for the same fd or signal).	3317	have many watchers waiting for the same fd or signal).
3054		3318
3055	=item Finding the next timer in each loop iteration: O(1)	3319	=item Finding the next timer in each loop iteration: O(1)
3056		3320
3057	By virtue of using a binary heap, the next timer is always found at the	3321	By virtue of using a binary or 4-heap, the next timer is always found at a
3058	beginning of the storage array.	3322	fixed position in the storage array.
3059		3323
3060	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3324	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3061		3325
3062	A change means an I/O watcher gets started or stopped, which requires	3326	A change means an I/O watcher gets started or stopped, which requires
3063	libev to recalculate its status (and possibly tell the kernel, depending	3327	libev to recalculate its status (and possibly tell the kernel, depending
3064	on backend and wether C<ev_io_set> was used).	3328	on backend and whether C<ev_io_set> was used).
3065		3329
3066	=item Activating one watcher (putting it into the pending state): O(1)	3330	=item Activating one watcher (putting it into the pending state): O(1)
3067		3331
3068	=item Priority handling: O(number_of_priorities)	3332	=item Priority handling: O(number_of_priorities)
3069		3333
…		…
3076		3340
3077	=item Processing ev_async_send: O(number_of_async_watchers)	3341	=item Processing ev_async_send: O(number_of_async_watchers)
3078		3342
3079	=item Processing signals: O(max_signal_number)	3343	=item Processing signals: O(max_signal_number)
3080		3344
3081	Sending involves a syscall I<iff> there were no other C<ev_async_send>	3345	Sending involves a system call I<iff> there were no other C<ev_async_send>
3082	calls in the current loop iteration. Checking for async and signal events	3346	calls in the current loop iteration. Checking for async and signal events
3083	involves iterating over all running async watchers or all signal numbers.	3347	involves iterating over all running async watchers or all signal numbers.
3084		3348
3085	=back	3349	=back
3086		3350
3087		3351
3088	=head1 Win32 platform limitations and workarounds	3352	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3089		3353
3090	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3354	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3091	requires, and its I/O model is fundamentally incompatible with the POSIX	3355	requires, and its I/O model is fundamentally incompatible with the POSIX
3092	model. Libev still offers limited functionality on this platform in	3356	model. Libev still offers limited functionality on this platform in
3093	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3357	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3094	descriptors. This only applies when using Win32 natively, not when using	3358	descriptors. This only applies when using Win32 natively, not when using
3095	e.g. cygwin.	3359	e.g. cygwin.
3096		3360
		3361	Lifting these limitations would basically require the full
		3362	re-implementation of the I/O system. If you are into these kinds of
		3363	things, then note that glib does exactly that for you in a very portable
		3364	way (note also that glib is the slowest event library known to man).
		3365
3097	There is no supported compilation method available on windows except	3366	There is no supported compilation method available on windows except
3098	embedding it into other applications.	3367	embedding it into other applications.
3099		3368
		3369	Not a libev limitation but worth mentioning: windows apparently doesn't
		3370	accept large writes: instead of resulting in a partial write, windows will
		3371	either accept everything or return C<ENOBUFS> if the buffer is too large,
		3372	so make sure you only write small amounts into your sockets (less than a
		3373	megabyte seems safe, but thsi apparently depends on the amount of memory
		3374	available).
		3375
3100	Due to the many, low, and arbitrary limits on the win32 platform and the	3376	Due to the many, low, and arbitrary limits on the win32 platform and
3101	abysmal performance of winsockets, using a large number of sockets is not	3377	the abysmal performance of winsockets, using a large number of sockets
3102	recommended (and not reasonable). If your program needs to use more than	3378	is not recommended (and not reasonable). If your program needs to use
3103	a hundred or so sockets, then likely it needs to use a totally different	3379	more than a hundred or so sockets, then likely it needs to use a totally
3104	implementation for windows, as libev offers the POSIX model, which cannot	3380	different implementation for windows, as libev offers the POSIX readiness
3105	be implemented efficiently on windows (microsoft monopoly games).	3381	notification model, which cannot be implemented efficiently on windows
		3382	(Microsoft monopoly games).
		3383
		3384	A typical way to use libev under windows is to embed it (see the embedding
		3385	section for details) and use the following F<evwrap.h> header file instead
		3386	of F<ev.h>:
		3387
		3388	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3389	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3390
		3391	#include "ev.h"
		3392
		3393	And compile the following F<evwrap.c> file into your project (make sure
		3394	you do I<not> compile the F<ev.c> or any other embedded soruce files!):
		3395
		3396	#include "evwrap.h"
		3397	#include "ev.c"
3106		3398
3107	=over 4	3399	=over 4
3108		3400
3109	=item The winsocket select function	3401	=item The winsocket select function
3110		3402
3111	The winsocket C<select> function doesn't follow POSIX in that it requires	3403	The winsocket C<select> function doesn't follow POSIX in that it
3112	socket I<handles> and not socket I<file descriptors>. This makes select	3404	requires socket I<handles> and not socket I<file descriptors> (it is
3113	very inefficient, and also requires a mapping from file descriptors	3405	also extremely buggy). This makes select very inefficient, and also
3114	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3406	requires a mapping from file descriptors to socket handles (the Microsoft
3115	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3407	C runtime provides the function C<_open_osfhandle> for this). See the
3116	symbols for more info.	3408	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		3409	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
3117		3410
3118	The configuration for a "naked" win32 using the microsoft runtime	3411	The configuration for a "naked" win32 using the Microsoft runtime
3119	libraries and raw winsocket select is:	3412	libraries and raw winsocket select is:
3120		3413
3121	#define EV_USE_SELECT 1	3414	#define EV_USE_SELECT 1
3122	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3415	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3123		3416
3124	Note that winsockets handling of fd sets is O(n), so you can easily get a	3417	Note that winsockets handling of fd sets is O(n), so you can easily get a
3125	complexity in the O(n²) range when using win32.	3418	complexity in the O(n²) range when using win32.
3126		3419
3127	=item Limited number of file descriptors	3420	=item Limited number of file descriptors
3128		3421
3129	Windows has numerous arbitrary (and low) limits on things. Early versions	3422	Windows has numerous arbitrary (and low) limits on things.
3130	of winsocket's select only supported waiting for a max. of C<64> handles	3423
		3424	Early versions of winsocket's select only supported waiting for a maximum
3131	(probably owning to the fact that all windows kernels can only wait for	3425	of C<64> handles (probably owning to the fact that all windows kernels
3132	C<64> things at the same time internally; microsoft recommends spawning a	3426	can only wait for C<64> things at the same time internally; Microsoft
3133	chain of threads and wait for 63 handles and the previous thread in each).	3427	recommends spawning a chain of threads and wait for 63 handles and the
		3428	previous thread in each. Great).
3134		3429
3135	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3430	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3136	to some high number (e.g. C<2048>) before compiling the winsocket select	3431	to some high number (e.g. C<2048>) before compiling the winsocket select
3137	call (which might be in libev or elsewhere, for example, perl does its own	3432	call (which might be in libev or elsewhere, for example, perl does its own
3138	select emulation on windows).	3433	select emulation on windows).
3139		3434
3140	Another limit is the number of file descriptors in the microsoft runtime	3435	Another limit is the number of file descriptors in the Microsoft runtime
3141	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3436	libraries, which by default is C<64> (there must be a hidden I<64> fetish
3142	or something like this inside microsoft). You can increase this by calling	3437	or something like this inside Microsoft). You can increase this by calling
3143	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3438	C<_setmaxstdio>, which can increase this limit to C<2048> (another
3144	arbitrary limit), but is broken in many versions of the microsoft runtime	3439	arbitrary limit), but is broken in many versions of the Microsoft runtime
3145	libraries.	3440	libraries.
3146		3441
3147	This might get you to about C<512> or C<2048> sockets (depending on	3442	This might get you to about C<512> or C<2048> sockets (depending on
3148	windows version and/or the phase of the moon). To get more, you need to	3443	windows version and/or the phase of the moon). To get more, you need to
3149	wrap all I/O functions and provide your own fd management, but the cost of	3444	wrap all I/O functions and provide your own fd management, but the cost of
3150	calling select (O(n²)) will likely make this unworkable.	3445	calling select (O(n²)) will likely make this unworkable.
3151		3446
3152	=back	3447	=back
3153		3448
3154		3449
		3450	=head1 PORTABILITY REQUIREMENTS
		3451
		3452	In addition to a working ISO-C implementation, libev relies on a few
		3453	additional extensions:
		3454
		3455	=over 4
		3456
		3457	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3458	calling conventions regardless of C<ev_watcher_type *>.
		3459
		3460	Libev assumes not only that all watcher pointers have the same internal
		3461	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3462	assumes that the same (machine) code can be used to call any watcher
		3463	callback: The watcher callbacks have different type signatures, but libev
		3464	calls them using an C<ev_watcher *> internally.
		3465
		3466	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3467
		3468	The type C<sig_atomic_t volatile> (or whatever is defined as
		3469	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
		3470	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3471	believed to be sufficiently portable.
		3472
		3473	=item C<sigprocmask> must work in a threaded environment
		3474
		3475	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3476	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3477	pthread implementations will either allow C<sigprocmask> in the "main
		3478	thread" or will block signals process-wide, both behaviours would
		3479	be compatible with libev. Interaction between C<sigprocmask> and
		3480	C<pthread_sigmask> could complicate things, however.
		3481
		3482	The most portable way to handle signals is to block signals in all threads
		3483	except the initial one, and run the default loop in the initial thread as
		3484	well.
		3485
		3486	=item C<long> must be large enough for common memory allocation sizes
		3487
		3488	To improve portability and simplify using libev, libev uses C<long>
		3489	internally instead of C<size_t> when allocating its data structures. On
		3490	non-POSIX systems (Microsoft...) this might be unexpectedly low, but
		3491	is still at least 31 bits everywhere, which is enough for hundreds of
		3492	millions of watchers.
		3493
		3494	=item C<double> must hold a time value in seconds with enough accuracy
		3495
		3496	The type C<double> is used to represent timestamps. It is required to
		3497	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		3498	enough for at least into the year 4000. This requirement is fulfilled by
		3499	implementations implementing IEEE 754 (basically all existing ones).
		3500
		3501	=back
		3502
		3503	If you know of other additional requirements drop me a note.
		3504
		3505
		3506	=head1 COMPILER WARNINGS
		3507
		3508	Depending on your compiler and compiler settings, you might get no or a
		3509	lot of warnings when compiling libev code. Some people are apparently
		3510	scared by this.
		3511
		3512	However, these are unavoidable for many reasons. For one, each compiler
		3513	has different warnings, and each user has different tastes regarding
		3514	warning options. "Warn-free" code therefore cannot be a goal except when
		3515	targeting a specific compiler and compiler-version.
		3516
		3517	Another reason is that some compiler warnings require elaborate
		3518	workarounds, or other changes to the code that make it less clear and less
		3519	maintainable.
		3520
		3521	And of course, some compiler warnings are just plain stupid, or simply
		3522	wrong (because they don't actually warn about the condition their message
		3523	seems to warn about).
		3524
		3525	While libev is written to generate as few warnings as possible,
		3526	"warn-free" code is not a goal, and it is recommended not to build libev
		3527	with any compiler warnings enabled unless you are prepared to cope with
		3528	them (e.g. by ignoring them). Remember that warnings are just that:
		3529	warnings, not errors, or proof of bugs.
		3530
		3531
		3532	=head1 VALGRIND
		3533
		3534	Valgrind has a special section here because it is a popular tool that is
		3535	highly useful, but valgrind reports are very hard to interpret.
		3536
		3537	If you think you found a bug (memory leak, uninitialised data access etc.)
		3538	in libev, then check twice: If valgrind reports something like:
		3539
		3540	==2274== definitely lost: 0 bytes in 0 blocks.
		3541	==2274== possibly lost: 0 bytes in 0 blocks.
		3542	==2274== still reachable: 256 bytes in 1 blocks.
		3543
		3544	Then there is no memory leak. Similarly, under some circumstances,
		3545	valgrind might report kernel bugs as if it were a bug in libev, or it
		3546	might be confused (it is a very good tool, but only a tool).
		3547
		3548	If you are unsure about something, feel free to contact the mailing list
		3549	with the full valgrind report and an explanation on why you think this is
		3550	a bug in libev. However, don't be annoyed when you get a brisk "this is
		3551	no bug" answer and take the chance of learning how to interpret valgrind
		3552	properly.
		3553
		3554	If you need, for some reason, empty reports from valgrind for your project
		3555	I suggest using suppression lists.
		3556
		3557
3155	=head1 AUTHOR	3558	=head1 AUTHOR
3156		3559
3157	Marc Lehmann <libev@schmorp.de>.	3560	Marc Lehmann <libev@schmorp.de>.
3158		3561

Diff Legend

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