ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.177 by root, Mon Sep 8 17:27:42 2008 UTC vs.
Revision 1.399 by root, Mon Apr 2 23:14:41 2012 UTC

…		…
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
		14	#include <stdio.h> // for puts
		15
14	// every watcher type has its own typedef'd struct	16	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	17	// with the name ev_TYPE
16	ev_io stdin_watcher;	18	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
18		20
19	// all watcher callbacks have a similar signature	21	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	22	// this callback is called when data is readable on stdin
21	static void	23	static void
22	stdin_cb (EV_P_ struct ev_io *w, int revents)	24	stdin_cb (EV_P_ ev_io *w, int revents)
23	{	25	{
24	puts ("stdin ready");	26	puts ("stdin ready");
25	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
26	// with its corresponding stop function.	28	// with its corresponding stop function.
27	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
28		30
29	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
30	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
31	}	33	}
32		34
33	// another callback, this time for a time-out	35	// another callback, this time for a time-out
34	static void	36	static void
35	timeout_cb (EV_P_ struct ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
36	{	38	{
37	puts ("timeout");	39	puts ("timeout");
38	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
39	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
40	}	42	}
41		43
42	int	44	int
43	main (void)	45	main (void)
44	{	46	{
45	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
46	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
47		49
48	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
49	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
51	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
54	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
56	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
57		59
58	// now wait for events to arrive	60	// now wait for events to arrive
59	ev_loop (loop, 0);	61	ev_run (loop, 0);
60		62
61	// unloop was called, so exit	63	// break was called, so exit
62	return 0;	64	return 0;
63	}	65	}
64		66
65	=head1 DESCRIPTION	67	=head1 ABOUT THIS DOCUMENT
		68
		69	This document documents the libev software package.
66		70
67	The newest version of this document is also available as an html-formatted	71	The newest version of this document is also available as an html-formatted
68	web page you might find easier to navigate when reading it for the first	72	web page you might find easier to navigate when reading it for the first
69	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.	73	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
		74
		75	While this document tries to be as complete as possible in documenting
		76	libev, its usage and the rationale behind its design, it is not a tutorial
		77	on event-based programming, nor will it introduce event-based programming
		78	with libev.
		79
		80	Familiarity with event based programming techniques in general is assumed
		81	throughout this document.
		82
		83	=head1 WHAT TO READ WHEN IN A HURRY
		84
		85	This manual tries to be very detailed, but unfortunately, this also makes
		86	it very long. If you just want to know the basics of libev, I suggest
		87	reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and
		88	look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and
		89	C<ev_timer> sections in L<WATCHER TYPES>.
		90
		91	=head1 ABOUT LIBEV
70		92
71	Libev is an event loop: you register interest in certain events (such as a	93	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	94	file descriptor being readable or a timeout occurring), and it will manage
73	these event sources and provide your program with events.	95	these event sources and provide your program with events.
74		96
…		…
84	=head2 FEATURES	106	=head2 FEATURES
85		107
86	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the	108	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
87	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	109	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
88	for file descriptor events (C<ev_io>), the Linux C<inotify> interface	110	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
89	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	111	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
90	with customised rescheduling (C<ev_periodic>), synchronous signals	112	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
91	(C<ev_signal>), process status change events (C<ev_child>), and event	113	timers (C<ev_timer>), absolute timers with customised rescheduling
92	watchers dealing with the event loop mechanism itself (C<ev_idle>,	114	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
93	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as	115	change events (C<ev_child>), and event watchers dealing with the event
94	file watchers (C<ev_stat>) and even limited support for fork events	116	loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
95	(C<ev_fork>).	117	C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
		118	limited support for fork events (C<ev_fork>).
96		119
97	It also is quite fast (see this	120	It also is quite fast (see this
98	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	121	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
99	for example).	122	for example).
100		123
…		…
108	name C<loop> (which is always of type C<struct ev_loop *>) will not have	131	name C<loop> (which is always of type C<struct ev_loop *>) will not have
109	this argument.	132	this argument.
110		133
111	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
112		135
113	Libev represents time as a single floating point number, representing the	136	Libev represents time as a single floating point number, representing
114	(fractional) number of seconds since the (POSIX) epoch (somewhere near	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
115	the beginning of 1970, details are complicated, don't ask). This type is	138	somewhere near the beginning of 1970, details are complicated, don't
116	called C<ev_tstamp>, which is what you should use too. It usually aliases	139	ask). This type is called C<ev_tstamp>, which is what you should use
117	to the C<double> type in C, and when you need to do any calculations on	140	too. It usually aliases to the C<double> type in C. When you need to do
118	it, you should treat it as some floating point value. Unlike the name	141	any calculations on it, you should treat it as some floating point value.
		142
119	component C<stamp> might indicate, it is also used for time differences	143	Unlike the name component C<stamp> might indicate, it is also used for
120	throughout libev.	144	time differences (e.g. delays) throughout libev.
121		145
122	=head1 ERROR HANDLING	146	=head1 ERROR HANDLING
123		147
124	Libev knows three classes of errors: operating system errors, usage errors	148	Libev knows three classes of errors: operating system errors, usage errors
125	and internal errors (bugs).	149	and internal errors (bugs).
…		…
149		173
150	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
151		175
152	Returns the current time as libev would use it. Please note that the	176	Returns the current time as libev would use it. Please note that the
153	C<ev_now> function is usually faster and also often returns the timestamp	177	C<ev_now> function is usually faster and also often returns the timestamp
154	you actually want to know.	178	you actually want to know. Also interesting is the combination of
		179	C<ev_now_update> and C<ev_now>.
155		180
156	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
157		182
158	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked
159	either it is interrupted or the given time interval has passed. Basically	184	until either it is interrupted or the given time interval has
		185	passed (approximately - it might return a bit earlier even if not
		186	interrupted). Returns immediately if C<< interval <= 0 >>.
		187
160	this is a sub-second-resolution C<sleep ()>.	188	Basically this is a sub-second-resolution C<sleep ()>.
		189
		190	The range of the C<interval> is limited - libev only guarantees to work
		191	with sleep times of up to one day (C<< interval <= 86400 >>).
161		192
162	=item int ev_version_major ()	193	=item int ev_version_major ()
163		194
164	=item int ev_version_minor ()	195	=item int ev_version_minor ()
165		196
…		…
176	as this indicates an incompatible change. Minor versions are usually	207	as this indicates an incompatible change. Minor versions are usually
177	compatible to older versions, so a larger minor version alone is usually	208	compatible to older versions, so a larger minor version alone is usually
178	not a problem.	209	not a problem.
179		210
180	Example: Make sure we haven't accidentally been linked against the wrong	211	Example: Make sure we haven't accidentally been linked against the wrong
181	version.	212	version (note, however, that this will not detect other ABI mismatches,
		213	such as LFS or reentrancy).
182		214
183	assert (("libev version mismatch",	215	assert (("libev version mismatch",
184	ev_version_major () == EV_VERSION_MAJOR	216	ev_version_major () == EV_VERSION_MAJOR
185	&& ev_version_minor () >= EV_VERSION_MINOR));	217	&& ev_version_minor () >= EV_VERSION_MINOR));
186		218
…		…
197	assert (("sorry, no epoll, no sex",	229	assert (("sorry, no epoll, no sex",
198	ev_supported_backends () & EVBACKEND_EPOLL));	230	ev_supported_backends () & EVBACKEND_EPOLL));
199		231
200	=item unsigned int ev_recommended_backends ()	232	=item unsigned int ev_recommended_backends ()
201		233
202	Return the set of all backends compiled into this binary of libev and also	234	Return the set of all backends compiled into this binary of libev and
203	recommended for this platform. This set is often smaller than the one	235	also recommended for this platform, meaning it will work for most file
		236	descriptor types. This set is often smaller than the one returned by
204	returned by C<ev_supported_backends>, as for example kqueue is broken on	237	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
205	most BSDs and will not be auto-detected unless you explicitly request it	238	and will not be auto-detected unless you explicitly request it (assuming
206	(assuming you know what you are doing). This is the set of backends that	239	you know what you are doing). This is the set of backends that libev will
207	libev will probe for if you specify no backends explicitly.	240	probe for if you specify no backends explicitly.
208		241
209	=item unsigned int ev_embeddable_backends ()	242	=item unsigned int ev_embeddable_backends ()
210		243
211	Returns the set of backends that are embeddable in other event loops. This	244	Returns the set of backends that are embeddable in other event loops. This
212	is the theoretical, all-platform, value. To find which backends	245	value is platform-specific but can include backends not available on the
213	might be supported on the current system, you would need to look at	246	current system. To find which embeddable backends might be supported on
214	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	247	the current system, you would need to look at C<ev_embeddable_backends ()
215	recommended ones.	248	& ev_supported_backends ()>, likewise for recommended ones.
216		249
217	See the description of C<ev_embed> watchers for more info.	250	See the description of C<ev_embed> watchers for more info.
218		251
219	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
220		253
…		…
250	}	283	}
251		284
252	...	285	...
253	ev_set_allocator (persistent_realloc);	286	ev_set_allocator (persistent_realloc);
254		287
255	=item ev_set_syserr_cb (void (*cb)(const char *msg));	288	=item ev_set_syserr_cb (void (*cb)(const char *msg))
256		289
257	Set the callback function to call on a retryable system call error (such	290	Set the callback function to call on a retryable system call error (such
258	as failed select, poll, epoll_wait). The message is a printable string	291	as failed select, poll, epoll_wait). The message is a printable string
259	indicating the system call or subsystem causing the problem. If this	292	indicating the system call or subsystem causing the problem. If this
260	callback is set, then libev will expect it to remedy the situation, no	293	callback is set, then libev will expect it to remedy the situation, no
…		…
272	}	305	}
273		306
274	...	307	...
275	ev_set_syserr_cb (fatal_error);	308	ev_set_syserr_cb (fatal_error);
276		309
		310	=item ev_feed_signal (int signum)
		311
		312	This function can be used to "simulate" a signal receive. It is completely
		313	safe to call this function at any time, from any context, including signal
		314	handlers or random threads.
		315
		316	Its main use is to customise signal handling in your process, especially
		317	in the presence of threads. For example, you could block signals
		318	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		319	creating any loops), and in one thread, use C<sigwait> or any other
		320	mechanism to wait for signals, then "deliver" them to libev by calling
		321	C<ev_feed_signal>.
		322
277	=back	323	=back
278		324
279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	325	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
280		326
281	An event loop is described by a C<struct ev_loop *>. The library knows two	327	An event loop is described by a C<struct ev_loop *> (the C<struct> is
282	types of such loops, the I<default> loop, which supports signals and child	328	I<not> optional in this case unless libev 3 compatibility is disabled, as
283	events, and dynamically created loops which do not.	329	libev 3 had an C<ev_loop> function colliding with the struct name).
		330
		331	The library knows two types of such loops, the I<default> loop, which
		332	supports child process events, and dynamically created event loops which
		333	do not.
284		334
285	=over 4	335	=over 4
286		336
287	=item struct ev_loop *ev_default_loop (unsigned int flags)	337	=item struct ev_loop *ev_default_loop (unsigned int flags)
288		338
289	This will initialise the default event loop if it hasn't been initialised	339	This returns the "default" event loop object, which is what you should
290	yet and return it. If the default loop could not be initialised, returns	340	normally use when you just need "the event loop". Event loop objects and
291	false. If it already was initialised it simply returns it (and ignores the	341	the C<flags> parameter are described in more detail in the entry for
292	flags. If that is troubling you, check C<ev_backend ()> afterwards).	342	C<ev_loop_new>.
		343
		344	If the default loop is already initialised then this function simply
		345	returns it (and ignores the flags. If that is troubling you, check
		346	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		347	flags, which should almost always be C<0>, unless the caller is also the
		348	one calling C<ev_run> or otherwise qualifies as "the main program".
293		349
294	If you don't know what event loop to use, use the one returned from this	350	If you don't know what event loop to use, use the one returned from this
295	function.	351	function (or via the C<EV_DEFAULT> macro).
296		352
297	Note that this function is I<not> thread-safe, so if you want to use it	353	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,	354	from multiple threads, you have to employ some kind of mutex (note also
299	as loops cannot bes hared easily between threads anyway).	355	that this case is unlikely, as loops cannot be shared easily between
		356	threads anyway).
300		357
301	The default loop is the only loop that can handle C<ev_signal> and	358	The default loop is the only loop that can handle C<ev_child> watchers,
302	C<ev_child> watchers, and to do this, it always registers a handler	359	and to do this, it always registers a handler for C<SIGCHLD>. If this is
303	for C<SIGCHLD>. If this is a problem for your application you can either	360	a problem for your application you can either create a dynamic loop with
304	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	361	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
305	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	362	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
306	C<ev_default_init>.	363
		364	Example: This is the most typical usage.
		365
		366	if (!ev_default_loop (0))
		367	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		368
		369	Example: Restrict libev to the select and poll backends, and do not allow
		370	environment settings to be taken into account:
		371
		372	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		373
		374	=item struct ev_loop *ev_loop_new (unsigned int flags)
		375
		376	This will create and initialise a new event loop object. If the loop
		377	could not be initialised, returns false.
		378
		379	This function is thread-safe, and one common way to use libev with
		380	threads is indeed to create one loop per thread, and using the default
		381	loop in the "main" or "initial" thread.
307		382
308	The flags argument can be used to specify special behaviour or specific	383	The flags argument can be used to specify special behaviour or specific
309	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	384	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
310		385
311	The following flags are supported:	386	The following flags are supported:
…		…
326	useful to try out specific backends to test their performance, or to work	401	useful to try out specific backends to test their performance, or to work
327	around bugs.	402	around bugs.
328		403
329	=item C<EVFLAG_FORKCHECK>	404	=item C<EVFLAG_FORKCHECK>
330		405
331	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after	406	Instead of calling C<ev_loop_fork> manually after a fork, you can also
332	a fork, you can also make libev check for a fork in each iteration by	407	make libev check for a fork in each iteration by enabling this flag.
333	enabling this flag.
334		408
335	This works by calling C<getpid ()> on every iteration of the loop,	409	This works by calling C<getpid ()> on every iteration of the loop,
336	and thus this might slow down your event loop if you do a lot of loop	410	and thus this might slow down your event loop if you do a lot of loop
337	iterations and little real work, but is usually not noticeable (on my	411	iterations and little real work, but is usually not noticeable (on my
338	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	412	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
…		…
344	flag.	418	flag.
345		419
346	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>	420	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
347	environment variable.	421	environment variable.
348		422
		423	=item C<EVFLAG_NOINOTIFY>
		424
		425	When this flag is specified, then libev will not attempt to use the
		426	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
		427	testing, this flag can be useful to conserve inotify file descriptors, as
		428	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
		429
		430	=item C<EVFLAG_SIGNALFD>
		431
		432	When this flag is specified, then libev will attempt to use the
		433	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
		434	delivers signals synchronously, which makes it both faster and might make
		435	it possible to get the queued signal data. It can also simplify signal
		436	handling with threads, as long as you properly block signals in your
		437	threads that are not interested in handling them.
		438
		439	Signalfd will not be used by default as this changes your signal mask, and
		440	there are a lot of shoddy libraries and programs (glib's threadpool for
		441	example) that can't properly initialise their signal masks.
		442
		443	=item C<EVFLAG_NOSIGMASK>
		444
		445	When this flag is specified, then libev will avoid to modify the signal
		446	mask. Specifically, this means you have to make sure signals are unblocked
		447	when you want to receive them.
		448
		449	This behaviour is useful when you want to do your own signal handling, or
		450	want to handle signals only in specific threads and want to avoid libev
		451	unblocking the signals.
		452
		453	It's also required by POSIX in a threaded program, as libev calls
		454	C<sigprocmask>, whose behaviour is officially unspecified.
		455
		456	This flag's behaviour will become the default in future versions of libev.
		457
349	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
350		459
351	This is your standard select(2) backend. Not I<completely> standard, as	460	This is your standard select(2) backend. Not I<completely> standard, as
352	libev tries to roll its own fd_set with no limits on the number of fds,	461	libev tries to roll its own fd_set with no limits on the number of fds,
353	but if that fails, expect a fairly low limit on the number of fds when	462	but if that fails, expect a fairly low limit on the number of fds when
…		…
359	writing a server, you should C<accept ()> in a loop to accept as many	468	writing a server, you should C<accept ()> in a loop to accept as many
360	connections as possible during one iteration. You might also want to have	469	connections as possible during one iteration. You might also want to have
361	a look at C<ev_set_io_collect_interval ()> to increase the amount of	470	a look at C<ev_set_io_collect_interval ()> to increase the amount of
362	readiness notifications you get per iteration.	471	readiness notifications you get per iteration.
363		472
		473	This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
		474	C<writefds> set (and to work around Microsoft Windows bugs, also onto the
		475	C<exceptfds> set on that platform).
		476
364	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	477	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
365		478
366	And this is your standard poll(2) backend. It's more complicated	479	And this is your standard poll(2) backend. It's more complicated
367	than select, but handles sparse fds better and has no artificial	480	than select, but handles sparse fds better and has no artificial
368	limit on the number of fds you can use (except it will slow down	481	limit on the number of fds you can use (except it will slow down
369	considerably with a lot of inactive fds). It scales similarly to select,	482	considerably with a lot of inactive fds). It scales similarly to select,
370	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for	483	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
371	performance tips.	484	performance tips.
372		485
		486	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		487	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
		488
373	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
374		490
		491	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		492	kernels).
		493
375	For few fds, this backend is a bit little slower than poll and select,	494	For few fds, this backend is a bit little slower than poll and select, but
376	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
377	like O(total_fds) where n is the total number of fds (or the highest fd),	496	O(total_fds) where total_fds is the total number of fds (or the highest
378	epoll scales either O(1) or O(active_fds). The epoll design has a number	497	fd), epoll scales either O(1) or O(active_fds).
379	of shortcomings, such as silently dropping events in some hard-to-detect	498
380	cases and requiring a system call per fd change, no fork support and bad	499	The epoll mechanism deserves honorable mention as the most misdesigned
381	support for dup.	500	of the more advanced event mechanisms: mere annoyances include silently
		501	dropping file descriptors, requiring a system call per change per file
		502	descriptor (and unnecessary guessing of parameters), problems with dup,
		503	returning before the timeout value, resulting in additional iterations
		504	(and only giving 5ms accuracy while select on the same platform gives
		505	0.1ms) and so on. The biggest issue is fork races, however - if a program
		506	forks then I<both> parent and child process have to recreate the epoll
		507	set, which can take considerable time (one syscall per file descriptor)
		508	and is of course hard to detect.
		509
		510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
		511	but of course I<doesn't>, and epoll just loves to report events for
		512	totally I<different> file descriptors (even already closed ones, so
		513	one cannot even remove them from the set) than registered in the set
		514	(especially on SMP systems). Libev tries to counter these spurious
		515	notifications by employing an additional generation counter and comparing
		516	that against the events to filter out spurious ones, recreating the set
		517	when required. Epoll also erroneously rounds down timeouts, but gives you
		518	no way to know when and by how much, so sometimes you have to busy-wait
		519	because epoll returns immediately despite a nonzero timeout. And last
		520	not least, it also refuses to work with some file descriptors which work
		521	perfectly fine with C<select> (files, many character devices...).
		522
		523	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		524	cobbled together in a hurry, no thought to design or interaction with
		525	others. Oh, the pain, will it ever stop...
382		526
383	While stopping, setting and starting an I/O watcher in the same iteration	527	While stopping, setting and starting an I/O watcher in the same iteration
384	will result in some caching, there is still a system call per such incident	528	will result in some caching, there is still a system call per such
385	(because the fd could point to a different file description now), so its	529	incident (because the same I<file descriptor> could point to a different
386	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	530	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
387	very well if you register events for both fds.	531	file descriptors might not work very well if you register events for both
388		532	file descriptors.
389	Please note that epoll sometimes generates spurious notifications, so you
390	need to use non-blocking I/O or other means to avoid blocking when no data
391	(or space) is available.
392		533
393	Best performance from this backend is achieved by not unregistering all	534	Best performance from this backend is achieved by not unregistering all
394	watchers for a file descriptor until it has been closed, if possible, i.e.	535	watchers for a file descriptor until it has been closed, if possible,
395	keep at least one watcher active per fd at all times.	536	i.e. keep at least one watcher active per fd at all times. Stopping and
		537	starting a watcher (without re-setting it) also usually doesn't cause
		538	extra overhead. A fork can both result in spurious notifications as well
		539	as in libev having to destroy and recreate the epoll object, which can
		540	take considerable time and thus should be avoided.
		541
		542	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		543	faster than epoll for maybe up to a hundred file descriptors, depending on
		544	the usage. So sad.
396		545
397	While nominally embeddable in other event loops, this feature is broken in	546	While nominally embeddable in other event loops, this feature is broken in
398	all kernel versions tested so far.	547	all kernel versions tested so far.
		548
		549	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		550	C<EVBACKEND_POLL>.
399		551
400	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	552	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
401		553
402	Kqueue deserves special mention, as at the time of this writing, it	554	Kqueue deserves special mention, as at the time of this writing, it
403	was broken on all BSDs except NetBSD (usually it doesn't work reliably	555	was broken on all BSDs except NetBSD (usually it doesn't work reliably
404	with anything but sockets and pipes, except on Darwin, where of course	556	with anything but sockets and pipes, except on Darwin, where of course
405	it's completely useless). For this reason it's not being "auto-detected"	557	it's completely useless). Unlike epoll, however, whose brokenness
		558	is by design, these kqueue bugs can (and eventually will) be fixed
		559	without API changes to existing programs. For this reason it's not being
406	unless you explicitly specify it explicitly in the flags (i.e. using	560	"auto-detected" unless you explicitly specify it in the flags (i.e. using
407	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	561	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
408	system like NetBSD.	562	system like NetBSD.
409		563
410	You still can embed kqueue into a normal poll or select backend and use it	564	You still can embed kqueue into a normal poll or select backend and use it
411	only for sockets (after having made sure that sockets work with kqueue on	565	only for sockets (after having made sure that sockets work with kqueue on
…		…
413		567
414	It scales in the same way as the epoll backend, but the interface to the	568	It scales in the same way as the epoll backend, but the interface to the
415	kernel is more efficient (which says nothing about its actual speed, of	569	kernel is more efficient (which says nothing about its actual speed, of
416	course). While stopping, setting and starting an I/O watcher does never	570	course). While stopping, setting and starting an I/O watcher does never
417	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	571	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
418	two event changes per incident, support for C<fork ()> is very bad and it	572	two event changes per incident. Support for C<fork ()> is very bad (you
		573	might have to leak fd's on fork, but it's more sane than epoll) and it
419	drops fds silently in similarly hard-to-detect cases.	574	drops fds silently in similarly hard-to-detect cases
420		575
421	This backend usually performs well under most conditions.	576	This backend usually performs well under most conditions.
422		577
423	While nominally embeddable in other event loops, this doesn't work	578	While nominally embeddable in other event loops, this doesn't work
424	everywhere, so you might need to test for this. And since it is broken	579	everywhere, so you might need to test for this. And since it is broken
425	almost everywhere, you should only use it when you have a lot of sockets	580	almost everywhere, you should only use it when you have a lot of sockets
426	(for which it usually works), by embedding it into another event loop	581	(for which it usually works), by embedding it into another event loop
427	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for	582	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
428	sockets.	583	also broken on OS X)) and, did I mention it, using it only for sockets.
		584
		585	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
		586	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
		587	C<NOTE_EOF>.
429		588
430	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	589	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
431		590
432	This is not implemented yet (and might never be, unless you send me an	591	This is not implemented yet (and might never be, unless you send me an
433	implementation). According to reports, C</dev/poll> only supports sockets	592	implementation). According to reports, C</dev/poll> only supports sockets
…		…
437	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	596	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
438		597
439	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	598	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
440	it's really slow, but it still scales very well (O(active_fds)).	599	it's really slow, but it still scales very well (O(active_fds)).
441		600
442	Please note that Solaris event ports can deliver a lot of spurious
443	notifications, so you need to use non-blocking I/O or other means to avoid
444	blocking when no data (or space) is available.
445
446	While this backend scales well, it requires one system call per active	601	While this backend scales well, it requires one system call per active
447	file descriptor per loop iteration. For small and medium numbers of file	602	file descriptor per loop iteration. For small and medium numbers of file
448	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	603	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
449	might perform better.	604	might perform better.
450		605
451	On the positive side, ignoring the spurious readiness notifications, this	606	On the positive side, this backend actually performed fully to
452	backend actually performed to specification in all tests and is fully	607	specification in all tests and is fully embeddable, which is a rare feat
453	embeddable, which is a rare feat among the OS-specific backends.	608	among the OS-specific backends (I vastly prefer correctness over speed
		609	hacks).
		610
		611	On the negative side, the interface is I<bizarre> - so bizarre that
		612	even sun itself gets it wrong in their code examples: The event polling
		613	function sometimes returns events to the caller even though an error
		614	occurred, but with no indication whether it has done so or not (yes, it's
		615	even documented that way) - deadly for edge-triggered interfaces where you
		616	absolutely have to know whether an event occurred or not because you have
		617	to re-arm the watcher.
		618
		619	Fortunately libev seems to be able to work around these idiocies.
		620
		621	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		622	C<EVBACKEND_POLL>.
454		623
455	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
456		625
457	Try all backends (even potentially broken ones that wouldn't be tried	626	Try all backends (even potentially broken ones that wouldn't be tried
458	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	627	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
459	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	628	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
460		629
461	It is definitely not recommended to use this flag.	630	It is definitely not recommended to use this flag, use whatever
		631	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		632	at all.
		633
		634	=item C<EVBACKEND_MASK>
		635
		636	Not a backend at all, but a mask to select all backend bits from a
		637	C<flags> value, in case you want to mask out any backends from a flags
		638	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
462		639
463	=back	640	=back
464		641
465	If one or more of these are or'ed into the flags value, then only these	642	If one or more of the backend flags are or'ed into the flags value,
466	backends will be tried (in the reverse order as listed here). If none are	643	then only these backends will be tried (in the reverse order as listed
467	specified, all backends in C<ev_recommended_backends ()> will be tried.	644	here). If none are specified, all backends in C<ev_recommended_backends
468		645	()> will be tried.
469	The most typical usage is like this:
470
471	if (!ev_default_loop (0))
472	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
473
474	Restrict libev to the select and poll backends, and do not allow
475	environment settings to be taken into account:
476
477	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
478
479	Use whatever libev has to offer, but make sure that kqueue is used if
480	available (warning, breaks stuff, best use only with your own private
481	event loop and only if you know the OS supports your types of fds):
482
483	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
484
485	=item struct ev_loop *ev_loop_new (unsigned int flags)
486
487	Similar to C<ev_default_loop>, but always creates a new event loop that is
488	always distinct from the default loop. Unlike the default loop, it cannot
489	handle signal and child watchers, and attempts to do so will be greeted by
490	undefined behaviour (or a failed assertion if assertions are enabled).
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		646
496	Example: Try to create a event loop that uses epoll and nothing else.	647	Example: Try to create a event loop that uses epoll and nothing else.
497		648
498	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	649	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
499	if (!epoller)	650	if (!epoller)
500	fatal ("no epoll found here, maybe it hides under your chair");	651	fatal ("no epoll found here, maybe it hides under your chair");
501		652
		653	Example: Use whatever libev has to offer, but make sure that kqueue is
		654	used if available.
		655
		656	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		657
502	=item ev_default_destroy ()	658	=item ev_loop_destroy (loop)
503		659
504	Destroys the default loop again (frees all memory and kernel state	660	Destroys an event loop object (frees all memory and kernel state
505	etc.). None of the active event watchers will be stopped in the normal	661	etc.). None of the active event watchers will be stopped in the normal
506	sense, so e.g. C<ev_is_active> might still return true. It is your	662	sense, so e.g. C<ev_is_active> might still return true. It is your
507	responsibility to either stop all watchers cleanly yourself I<before>	663	responsibility to either stop all watchers cleanly yourself I<before>
508	calling this function, or cope with the fact afterwards (which is usually	664	calling this function, or cope with the fact afterwards (which is usually
509	the easiest thing, you can just ignore the watchers and/or C<free ()> them	665	the easiest thing, you can just ignore the watchers and/or C<free ()> them
510	for example).	666	for example).
511		667
512	Note that certain global state, such as signal state, will not be freed by	668	Note that certain global state, such as signal state (and installed signal
513	this function, and related watchers (such as signal and child watchers)	669	handlers), will not be freed by this function, and related watchers (such
514	would need to be stopped manually.	670	as signal and child watchers) would need to be stopped manually.
515		671
516	In general it is not advisable to call this function except in the	672	This function is normally used on loop objects allocated by
517	rare occasion where you really need to free e.g. the signal handling	673	C<ev_loop_new>, but it can also be used on the default loop returned by
		674	C<ev_default_loop>, in which case it is not thread-safe.
		675
		676	Note that it is not advisable to call this function on the default loop
		677	except in the rare occasion where you really need to free its resources.
518	pipe fds. If you need dynamically allocated loops it is better to use	678	If you need dynamically allocated loops it is better to use C<ev_loop_new>
519	C<ev_loop_new> and C<ev_loop_destroy>).	679	and C<ev_loop_destroy>.
520		680
521	=item ev_loop_destroy (loop)	681	=item ev_loop_fork (loop)
522		682
523	Like C<ev_default_destroy>, but destroys an event loop created by an
524	earlier call to C<ev_loop_new>.
525
526	=item ev_default_fork ()
527
528	This function sets a flag that causes subsequent C<ev_loop> iterations	683	This function sets a flag that causes subsequent C<ev_run> iterations to
529	to reinitialise the kernel state for backends that have one. Despite the	684	reinitialise the kernel state for backends that have one. Despite the
530	name, you can call it anytime, but it makes most sense after forking, in	685	name, you can call it anytime, but it makes most sense after forking, in
531	the child process (or both child and parent, but that again makes little	686	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
532	sense). You I<must> call it in the child before using any of the libev	687	child before resuming or calling C<ev_run>.
533	functions, and it will only take effect at the next C<ev_loop> iteration.	688
		689	Again, you I<have> to call it on I<any> loop that you want to re-use after
		690	a fork, I<even if you do not plan to use the loop in the parent>. This is
		691	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		692	during fork.
534		693
535	On the other hand, you only need to call this function in the child	694	On the other hand, you only need to call this function in the child
536	process if and only if you want to use the event library in the child. If	695	process if and only if you want to use the event loop in the child. If
537	you just fork+exec, you don't have to call it at all.	696	you just fork+exec or create a new loop in the child, you don't have to
		697	call it at all (in fact, C<epoll> is so badly broken that it makes a
		698	difference, but libev will usually detect this case on its own and do a
		699	costly reset of the backend).
538		700
539	The function itself is quite fast and it's usually not a problem to call	701	The function itself is quite fast and it's usually not a problem to call
540	it just in case after a fork. To make this easy, the function will fit in	702	it just in case after a fork.
541	quite nicely into a call to C<pthread_atfork>:
542		703
		704	Example: Automate calling C<ev_loop_fork> on the default loop when
		705	using pthreads.
		706
		707	static void
		708	post_fork_child (void)
		709	{
		710	ev_loop_fork (EV_DEFAULT);
		711	}
		712
		713	...
543	pthread_atfork (0, 0, ev_default_fork);	714	pthread_atfork (0, 0, post_fork_child);
544
545	=item ev_loop_fork (loop)
546
547	Like C<ev_default_fork>, but acts on an event loop created by
548	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
549	after fork, and how you do this is entirely your own problem.
550		715
551	=item int ev_is_default_loop (loop)	716	=item int ev_is_default_loop (loop)
552		717
553	Returns true when the given loop actually is the default loop, false otherwise.	718	Returns true when the given loop is, in fact, the default loop, and false
		719	otherwise.
554		720
555	=item unsigned int ev_loop_count (loop)	721	=item unsigned int ev_iteration (loop)
556		722
557	Returns the count of loop iterations for the loop, which is identical to	723	Returns the current iteration count for the event loop, which is identical
558	the number of times libev did poll for new events. It starts at C<0> and	724	to the number of times libev did poll for new events. It starts at C<0>
559	happily wraps around with enough iterations.	725	and happily wraps around with enough iterations.
560		726
561	This value can sometimes be useful as a generation counter of sorts (it	727	This value can sometimes be useful as a generation counter of sorts (it
562	"ticks" the number of loop iterations), as it roughly corresponds with	728	"ticks" the number of loop iterations), as it roughly corresponds with
563	C<ev_prepare> and C<ev_check> calls.	729	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		730	prepare and check phases.
		731
		732	=item unsigned int ev_depth (loop)
		733
		734	Returns the number of times C<ev_run> was entered minus the number of
		735	times C<ev_run> was exited normally, in other words, the recursion depth.
		736
		737	Outside C<ev_run>, this number is zero. In a callback, this number is
		738	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
		739	in which case it is higher.
		740
		741	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
		742	throwing an exception etc.), doesn't count as "exit" - consider this
		743	as a hint to avoid such ungentleman-like behaviour unless it's really
		744	convenient, in which case it is fully supported.
564		745
565	=item unsigned int ev_backend (loop)	746	=item unsigned int ev_backend (loop)
566		747
567	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	748	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
568	use.	749	use.
…		…
577		758
578	=item ev_now_update (loop)	759	=item ev_now_update (loop)
579		760
580	Establishes the current time by querying the kernel, updating the time	761	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	762	returned by C<ev_now ()> in the progress. This is a costly operation and
582	is usually done automatically within C<ev_loop ()>.	763	is usually done automatically within C<ev_run ()>.
583		764
584	This function is rarely useful, but when some event callback runs for a	765	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	766	very long time without entering the event loop, updating libev's idea of
586	the current time is a good idea.	767	the current time is a good idea.
587		768
588	See also "The special problem of time updates" in the C<ev_timer> section.	769	See also L<The special problem of time updates> in the C<ev_timer> section.
589		770
		771	=item ev_suspend (loop)
		772
		773	=item ev_resume (loop)
		774
		775	These two functions suspend and resume an event loop, for use when the
		776	loop is not used for a while and timeouts should not be processed.
		777
		778	A typical use case would be an interactive program such as a game: When
		779	the user presses C<^Z> to suspend the game and resumes it an hour later it
		780	would be best to handle timeouts as if no time had actually passed while
		781	the program was suspended. This can be achieved by calling C<ev_suspend>
		782	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		783	C<ev_resume> directly afterwards to resume timer processing.
		784
		785	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		786	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		787	will be rescheduled (that is, they will lose any events that would have
		788	occurred while suspended).
		789
		790	After calling C<ev_suspend> you B<must not> call I<any> function on the
		791	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		792	without a previous call to C<ev_suspend>.
		793
		794	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		795	event loop time (see C<ev_now_update>).
		796
590	=item ev_loop (loop, int flags)	797	=item bool ev_run (loop, int flags)
591		798
592	Finally, this is it, the event handler. This function usually is called	799	Finally, this is it, the event handler. This function usually is called
593	after you initialised all your watchers and you want to start handling	800	after you have initialised all your watchers and you want to start
594	events.	801	handling events. It will ask the operating system for any new events, call
		802	the watcher callbacks, and then repeat the whole process indefinitely: This
		803	is why event loops are called I<loops>.
595		804
596	If the flags argument is specified as C<0>, it will not return until	805	If the flags argument is specified as C<0>, it will keep handling events
597	either no event watchers are active anymore or C<ev_unloop> was called.	806	until either no event watchers are active anymore or C<ev_break> was
		807	called.
598		808
		809	The return value is false if there are no more active watchers (which
		810	usually means "all jobs done" or "deadlock"), and true in all other cases
		811	(which usually means " you should call C<ev_run> again").
		812
599	Please note that an explicit C<ev_unloop> is usually better than	813	Please note that an explicit C<ev_break> is usually better than
600	relying on all watchers to be stopped when deciding when a program has	814	relying on all watchers to be stopped when deciding when a program has
601	finished (especially in interactive programs), but having a program that	815	finished (especially in interactive programs), but having a program
602	automatically loops as long as it has to and no longer by virtue of	816	that automatically loops as long as it has to and no longer by virtue
603	relying on its watchers stopping correctly is a thing of beauty.	817	of relying on its watchers stopping correctly, that is truly a thing of
		818	beauty.
604		819
		820	This function is I<mostly> exception-safe - you can break out of a
		821	C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		822	exception and so on. This does not decrement the C<ev_depth> value, nor
		823	will it clear any outstanding C<EVBREAK_ONE> breaks.
		824
605	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	825	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
606	those events and any outstanding ones, but will not block your process in	826	those events and any already outstanding ones, but will not wait and
607	case there are no events and will return after one iteration of the loop.	827	block your process in case there are no events and will return after one
		828	iteration of the loop. This is sometimes useful to poll and handle new
		829	events while doing lengthy calculations, to keep the program responsive.
608		830
609	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	831	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
610	necessary) and will handle those and any outstanding ones. It will block	832	necessary) and will handle those and any already outstanding ones. It
611	your process until at least one new event arrives, and will return after	833	will block your process until at least one new event arrives (which could
612	one iteration of the loop. This is useful if you are waiting for some	834	be an event internal to libev itself, so there is no guarantee that a
613	external event in conjunction with something not expressible using other	835	user-registered callback will be called), and will return after one
		836	iteration of the loop.
		837
		838	This is useful if you are waiting for some external event in conjunction
		839	with something not expressible using other libev watchers (i.e. "roll your
614	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	840	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
615	usually a better approach for this kind of thing.	841	usually a better approach for this kind of thing.
616		842
617	Here are the gory details of what C<ev_loop> does:	843	Here are the gory details of what C<ev_run> does (this is for your
		844	understanding, not a guarantee that things will work exactly like this in
		845	future versions):
618		846
		847	- Increment loop depth.
		848	- Reset the ev_break status.
619	- Before the first iteration, call any pending watchers.	849	- Before the first iteration, call any pending watchers.
		850	LOOP:
620	* If EVFLAG_FORKCHECK was used, check for a fork.	851	- If EVFLAG_FORKCHECK was used, check for a fork.
621	- If a fork was detected (by any means), queue and call all fork watchers.	852	- If a fork was detected (by any means), queue and call all fork watchers.
622	- Queue and call all prepare watchers.	853	- Queue and call all prepare watchers.
		854	- If ev_break was called, goto FINISH.
623	- If we have been forked, detach and recreate the kernel state	855	- If we have been forked, detach and recreate the kernel state
624	as to not disturb the other process.	856	as to not disturb the other process.
625	- Update the kernel state with all outstanding changes.	857	- Update the kernel state with all outstanding changes.
626	- Update the "event loop time" (ev_now ()).	858	- Update the "event loop time" (ev_now ()).
627	- Calculate for how long to sleep or block, if at all	859	- Calculate for how long to sleep or block, if at all
628	(active idle watchers, EVLOOP_NONBLOCK or not having	860	(active idle watchers, EVRUN_NOWAIT or not having
629	any active watchers at all will result in not sleeping).	861	any active watchers at all will result in not sleeping).
630	- Sleep if the I/O and timer collect interval say so.	862	- Sleep if the I/O and timer collect interval say so.
		863	- Increment loop iteration counter.
631	- Block the process, waiting for any events.	864	- Block the process, waiting for any events.
632	- Queue all outstanding I/O (fd) events.	865	- Queue all outstanding I/O (fd) events.
633	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	866	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
634	- Queue all outstanding timers.	867	- Queue all expired timers.
635	- Queue all outstanding periodics.	868	- Queue all expired periodics.
636	- Unless any events are pending now, queue all idle watchers.	869	- Queue all idle watchers with priority higher than that of pending events.
637	- Queue all check watchers.	870	- Queue all check watchers.
638	- Call all queued watchers in reverse order (i.e. check watchers first).	871	- Call all queued watchers in reverse order (i.e. check watchers first).
639	Signals and child watchers are implemented as I/O watchers, and will	872	Signals and child watchers are implemented as I/O watchers, and will
640	be handled here by queueing them when their watcher gets executed.	873	be handled here by queueing them when their watcher gets executed.
641	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	874	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
642	were used, or there are no active watchers, return, otherwise	875	were used, or there are no active watchers, goto FINISH, otherwise
643	continue with step *.	876	continue with step LOOP.
		877	FINISH:
		878	- Reset the ev_break status iff it was EVBREAK_ONE.
		879	- Decrement the loop depth.
		880	- Return.
644		881
645	Example: Queue some jobs and then loop until no events are outstanding	882	Example: Queue some jobs and then loop until no events are outstanding
646	anymore.	883	anymore.
647		884
648	... queue jobs here, make sure they register event watchers as long	885	... queue jobs here, make sure they register event watchers as long
649	... as they still have work to do (even an idle watcher will do..)	886	... as they still have work to do (even an idle watcher will do..)
650	ev_loop (my_loop, 0);	887	ev_run (my_loop, 0);
651	... jobs done or somebody called unloop. yeah!	888	... jobs done or somebody called break. yeah!
652		889
653	=item ev_unloop (loop, how)	890	=item ev_break (loop, how)
654		891
655	Can be used to make a call to C<ev_loop> return early (but only after it	892	Can be used to make a call to C<ev_run> return early (but only after it
656	has processed all outstanding events). The C<how> argument must be either	893	has processed all outstanding events). The C<how> argument must be either
657	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	894	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
658	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	895	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
659		896
660	This "unloop state" will be cleared when entering C<ev_loop> again.	897	This "break state" will be cleared on the next call to C<ev_run>.
		898
		899	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		900	which case it will have no effect.
661		901
662	=item ev_ref (loop)	902	=item ev_ref (loop)
663		903
664	=item ev_unref (loop)	904	=item ev_unref (loop)
665		905
666	Ref/unref can be used to add or remove a reference count on the event	906	Ref/unref can be used to add or remove a reference count on the event
667	loop: Every watcher keeps one reference, and as long as the reference	907	loop: Every watcher keeps one reference, and as long as the reference
668	count is nonzero, C<ev_loop> will not return on its own. If you have	908	count is nonzero, C<ev_run> will not return on its own.
669	a watcher you never unregister that should not keep C<ev_loop> from	909
670	returning, ev_unref() after starting, and ev_ref() before stopping it. For	910	This is useful when you have a watcher that you never intend to
		911	unregister, but that nevertheless should not keep C<ev_run> from
		912	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
		913	before stopping it.
		914
671	example, libev itself uses this for its internal signal pipe: It is not	915	As an example, libev itself uses this for its internal signal pipe: It
672	visible to the libev user and should not keep C<ev_loop> from exiting if	916	is not visible to the libev user and should not keep C<ev_run> from
673	no event watchers registered by it are active. It is also an excellent	917	exiting if no event watchers registered by it are active. It is also an
674	way to do this for generic recurring timers or from within third-party	918	excellent way to do this for generic recurring timers or from within
675	libraries. Just remember to I<unref after start> and I<ref before stop>	919	third-party libraries. Just remember to I<unref after start> and I<ref
676	(but only if the watcher wasn't active before, or was active before,	920	before stop> (but only if the watcher wasn't active before, or was active
677	respectively).	921	before, respectively. Note also that libev might stop watchers itself
		922	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		923	in the callback).
678		924
679	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	925	Example: Create a signal watcher, but keep it from keeping C<ev_run>
680	running when nothing else is active.	926	running when nothing else is active.
681		927
682	struct ev_signal exitsig;	928	ev_signal exitsig;
683	ev_signal_init (&exitsig, sig_cb, SIGINT);	929	ev_signal_init (&exitsig, sig_cb, SIGINT);
684	ev_signal_start (loop, &exitsig);	930	ev_signal_start (loop, &exitsig);
685	evf_unref (loop);	931	ev_unref (loop);
686		932
687	Example: For some weird reason, unregister the above signal handler again.	933	Example: For some weird reason, unregister the above signal handler again.
688		934
689	ev_ref (loop);	935	ev_ref (loop);
690	ev_signal_stop (loop, &exitsig);	936	ev_signal_stop (loop, &exitsig);
…		…
701	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	947	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
702	allows libev to delay invocation of I/O and timer/periodic callbacks	948	allows libev to delay invocation of I/O and timer/periodic callbacks
703	to increase efficiency of loop iterations (or to increase power-saving	949	to increase efficiency of loop iterations (or to increase power-saving
704	opportunities).	950	opportunities).
705		951
706	The background is that sometimes your program runs just fast enough to	952	The idea is that sometimes your program runs just fast enough to handle
707	handle one (or very few) event(s) per loop iteration. While this makes	953	one (or very few) event(s) per loop iteration. While this makes the
708	the program responsive, it also wastes a lot of CPU time to poll for new	954	program responsive, it also wastes a lot of CPU time to poll for new
709	events, especially with backends like C<select ()> which have a high	955	events, especially with backends like C<select ()> which have a high
710	overhead for the actual polling but can deliver many events at once.	956	overhead for the actual polling but can deliver many events at once.
711		957
712	By setting a higher I<io collect interval> you allow libev to spend more	958	By setting a higher I<io collect interval> you allow libev to spend more
713	time collecting I/O events, so you can handle more events per iteration,	959	time collecting I/O events, so you can handle more events per iteration,
714	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	960	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
715	C<ev_timer>) will be not affected. Setting this to a non-null value will	961	C<ev_timer>) will not be affected. Setting this to a non-null value will
716	introduce an additional C<ev_sleep ()> call into most loop iterations.	962	introduce an additional C<ev_sleep ()> call into most loop iterations. The
		963	sleep time ensures that libev will not poll for I/O events more often then
		964	once per this interval, on average (as long as the host time resolution is
		965	good enough).
717		966
718	Likewise, by setting a higher I<timeout collect interval> you allow libev	967	Likewise, by setting a higher I<timeout collect interval> you allow libev
719	to spend more time collecting timeouts, at the expense of increased	968	to spend more time collecting timeouts, at the expense of increased
720	latency (the watcher callback will be called later). C<ev_io> watchers	969	latency/jitter/inexactness (the watcher callback will be called
721	will not be affected. Setting this to a non-null value will not introduce	970	later). C<ev_io> watchers will not be affected. Setting this to a non-null
722	any overhead in libev.	971	value will not introduce any overhead in libev.
723		972
724	Many (busy) programs can usually benefit by setting the I/O collect	973	Many (busy) programs can usually benefit by setting the I/O collect
725	interval to a value near C<0.1> or so, which is often enough for	974	interval to a value near C<0.1> or so, which is often enough for
726	interactive servers (of course not for games), likewise for timeouts. It	975	interactive servers (of course not for games), likewise for timeouts. It
727	usually doesn't make much sense to set it to a lower value than C<0.01>,	976	usually doesn't make much sense to set it to a lower value than C<0.01>,
728	as this approaches the timing granularity of most systems.	977	as this approaches the timing granularity of most systems. Note that if
		978	you do transactions with the outside world and you can't increase the
		979	parallelity, then this setting will limit your transaction rate (if you
		980	need to poll once per transaction and the I/O collect interval is 0.01,
		981	then you can't do more than 100 transactions per second).
729		982
730	Setting the I<timeout collect interval> can improve the opportunity for	983	Setting the I<timeout collect interval> can improve the opportunity for
731	saving power, as the program will "bundle" timer callback invocations that	984	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	985	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	986	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	987	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
735	they fire on, say, one-second boundaries only.	988	they fire on, say, one-second boundaries only.
736		989
		990	Example: we only need 0.1s timeout granularity, and we wish not to poll
		991	more often than 100 times per second:
		992
		993	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
		994	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
		995
		996	=item ev_invoke_pending (loop)
		997
		998	This call will simply invoke all pending watchers while resetting their
		999	pending state. Normally, C<ev_run> does this automatically when required,
		1000	but when overriding the invoke callback this call comes handy. This
		1001	function can be invoked from a watcher - this can be useful for example
		1002	when you want to do some lengthy calculation and want to pass further
		1003	event handling to another thread (you still have to make sure only one
		1004	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
		1005
		1006	=item int ev_pending_count (loop)
		1007
		1008	Returns the number of pending watchers - zero indicates that no watchers
		1009	are pending.
		1010
		1011	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
		1012
		1013	This overrides the invoke pending functionality of the loop: Instead of
		1014	invoking all pending watchers when there are any, C<ev_run> will call
		1015	this callback instead. This is useful, for example, when you want to
		1016	invoke the actual watchers inside another context (another thread etc.).
		1017
		1018	If you want to reset the callback, use C<ev_invoke_pending> as new
		1019	callback.
		1020
		1021	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
		1022
		1023	Sometimes you want to share the same loop between multiple threads. This
		1024	can be done relatively simply by putting mutex_lock/unlock calls around
		1025	each call to a libev function.
		1026
		1027	However, C<ev_run> can run an indefinite time, so it is not feasible
		1028	to wait for it to return. One way around this is to wake up the event
		1029	loop via C<ev_break> and C<ev_async_send>, another way is to set these
		1030	I<release> and I<acquire> callbacks on the loop.
		1031
		1032	When set, then C<release> will be called just before the thread is
		1033	suspended waiting for new events, and C<acquire> is called just
		1034	afterwards.
		1035
		1036	Ideally, C<release> will just call your mutex_unlock function, and
		1037	C<acquire> will just call the mutex_lock function again.
		1038
		1039	While event loop modifications are allowed between invocations of
		1040	C<release> and C<acquire> (that's their only purpose after all), no
		1041	modifications done will affect the event loop, i.e. adding watchers will
		1042	have no effect on the set of file descriptors being watched, or the time
		1043	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
		1044	to take note of any changes you made.
		1045
		1046	In theory, threads executing C<ev_run> will be async-cancel safe between
		1047	invocations of C<release> and C<acquire>.
		1048
		1049	See also the locking example in the C<THREADS> section later in this
		1050	document.
		1051
		1052	=item ev_set_userdata (loop, void *data)
		1053
		1054	=item void *ev_userdata (loop)
		1055
		1056	Set and retrieve a single C<void *> associated with a loop. When
		1057	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
		1058	C<0>.
		1059
		1060	These two functions can be used to associate arbitrary data with a loop,
		1061	and are intended solely for the C<invoke_pending_cb>, C<release> and
		1062	C<acquire> callbacks described above, but of course can be (ab-)used for
		1063	any other purpose as well.
		1064
737	=item ev_loop_verify (loop)	1065	=item ev_verify (loop)
738		1066
739	This function only does something when C<EV_VERIFY> support has been	1067	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	1068	compiled in, which is the default for non-minimal builds. It tries to go
741	them for validity. If anything is found to be inconsistent, it will print	1069	through all internal structures and checks them for validity. If anything
742	an error message to standard error and call C<abort ()>.	1070	is found to be inconsistent, it will print an error message to standard
		1071	error and call C<abort ()>.
743		1072
744	This can be used to catch bugs inside libev itself: under normal	1073	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	1074	circumstances, this function will never abort as of course libev keeps its
746	data structures consistent.	1075	data structures consistent.
747		1076
748	=back	1077	=back
749		1078
750		1079
751	=head1 ANATOMY OF A WATCHER	1080	=head1 ANATOMY OF A WATCHER
752		1081
		1082	In the following description, uppercase C<TYPE> in names stands for the
		1083	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		1084	watchers and C<ev_io_start> for I/O watchers.
		1085
753	A watcher is a structure that you create and register to record your	1086	A watcher is an opaque structure that you allocate and register to record
754	interest in some event. For instance, if you want to wait for STDIN to	1087	your interest in some event. To make a concrete example, imagine you want
755	become readable, you would create an C<ev_io> watcher for that:	1088	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1089	for that:
756		1090
757	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1091	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
758	{	1092	{
759	ev_io_stop (w);	1093	ev_io_stop (w);
760	ev_unloop (loop, EVUNLOOP_ALL);	1094	ev_break (loop, EVBREAK_ALL);
761	}	1095	}
762		1096
763	struct ev_loop *loop = ev_default_loop (0);	1097	struct ev_loop *loop = ev_default_loop (0);
		1098
764	struct ev_io stdin_watcher;	1099	ev_io stdin_watcher;
		1100
765	ev_init (&stdin_watcher, my_cb);	1101	ev_init (&stdin_watcher, my_cb);
766	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1102	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
767	ev_io_start (loop, &stdin_watcher);	1103	ev_io_start (loop, &stdin_watcher);
		1104
768	ev_loop (loop, 0);	1105	ev_run (loop, 0);
769		1106
770	As you can see, you are responsible for allocating the memory for your	1107	As you can see, you are responsible for allocating the memory for your
771	watcher structures (and it is usually a bad idea to do this on the stack,	1108	watcher structures (and it is I<usually> a bad idea to do this on the
772	although this can sometimes be quite valid).	1109	stack).
773		1110
		1111	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		1112	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
		1113
774	Each watcher structure must be initialised by a call to C<ev_init	1114	Each watcher structure must be initialised by a call to C<ev_init (watcher
775	(watcher *, callback)>, which expects a callback to be provided. This	1115	*, callback)>, which expects a callback to be provided. This callback is
776	callback gets invoked each time the event occurs (or, in the case of I/O	1116	invoked each time the event occurs (or, in the case of I/O watchers, each
777	watchers, each time the event loop detects that the file descriptor given	1117	time the event loop detects that the file descriptor given is readable
778	is readable and/or writable).	1118	and/or writable).
779		1119
780	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	1120	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
781	with arguments specific to this watcher type. There is also a macro	1121	macro to configure it, with arguments specific to the watcher type. There
782	to combine initialisation and setting in one call: C<< ev_<type>_init	1122	is also a macro to combine initialisation and setting in one call: C<<
783	(watcher *, callback, ...) >>.	1123	ev_TYPE_init (watcher *, callback, ...) >>.
784		1124
785	To make the watcher actually watch out for events, you have to start it	1125	To make the watcher actually watch out for events, you have to start it
786	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	1126	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
787	*) >>), and you can stop watching for events at any time by calling the	1127	*) >>), and you can stop watching for events at any time by calling the
788	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	1128	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
789		1129
790	As long as your watcher is active (has been started but not stopped) you	1130	As long as your watcher is active (has been started but not stopped) you
791	must not touch the values stored in it. Most specifically you must never	1131	must not touch the values stored in it. Most specifically you must never
792	reinitialise it or call its C<set> macro.	1132	reinitialise it or call its C<ev_TYPE_set> macro.
793		1133
794	Each and every callback receives the event loop pointer as first, the	1134	Each and every callback receives the event loop pointer as first, the
795	registered watcher structure as second, and a bitset of received events as	1135	registered watcher structure as second, and a bitset of received events as
796	third argument.	1136	third argument.
797		1137
…		…
806	=item C<EV_WRITE>	1146	=item C<EV_WRITE>
807		1147
808	The file descriptor in the C<ev_io> watcher has become readable and/or	1148	The file descriptor in the C<ev_io> watcher has become readable and/or
809	writable.	1149	writable.
810		1150
811	=item C<EV_TIMEOUT>	1151	=item C<EV_TIMER>
812		1152
813	The C<ev_timer> watcher has timed out.	1153	The C<ev_timer> watcher has timed out.
814		1154
815	=item C<EV_PERIODIC>	1155	=item C<EV_PERIODIC>
816		1156
…		…
834		1174
835	=item C<EV_PREPARE>	1175	=item C<EV_PREPARE>
836		1176
837	=item C<EV_CHECK>	1177	=item C<EV_CHECK>
838		1178
839	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1179	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
840	to gather new events, and all C<ev_check> watchers are invoked just after	1180	to gather new events, and all C<ev_check> watchers are invoked just after
841	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1181	C<ev_run> has gathered them, but before it invokes any callbacks for any
842	received events. Callbacks of both watcher types can start and stop as	1182	received events. Callbacks of both watcher types can start and stop as
843	many watchers as they want, and all of them will be taken into account	1183	many watchers as they want, and all of them will be taken into account
844	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1184	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
845	C<ev_loop> from blocking).	1185	C<ev_run> from blocking).
846		1186
847	=item C<EV_EMBED>	1187	=item C<EV_EMBED>
848		1188
849	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1189	The embedded event loop specified in the C<ev_embed> watcher needs attention.
850		1190
851	=item C<EV_FORK>	1191	=item C<EV_FORK>
852		1192
853	The event loop has been resumed in the child process after fork (see	1193	The event loop has been resumed in the child process after fork (see
854	C<ev_fork>).	1194	C<ev_fork>).
855		1195
		1196	=item C<EV_CLEANUP>
		1197
		1198	The event loop is about to be destroyed (see C<ev_cleanup>).
		1199
856	=item C<EV_ASYNC>	1200	=item C<EV_ASYNC>
857		1201
858	The given async watcher has been asynchronously notified (see C<ev_async>).	1202	The given async watcher has been asynchronously notified (see C<ev_async>).
		1203
		1204	=item C<EV_CUSTOM>
		1205
		1206	Not ever sent (or otherwise used) by libev itself, but can be freely used
		1207	by libev users to signal watchers (e.g. via C<ev_feed_event>).
859		1208
860	=item C<EV_ERROR>	1209	=item C<EV_ERROR>
861		1210
862	An unspecified error has occurred, the watcher has been stopped. This might	1211	An unspecified error has occurred, the watcher has been stopped. This might
863	happen because the watcher could not be properly started because libev	1212	happen because the watcher could not be properly started because libev
864	ran out of memory, a file descriptor was found to be closed or any other	1213	ran out of memory, a file descriptor was found to be closed or any other
		1214	problem. Libev considers these application bugs.
		1215
865	problem. You best act on it by reporting the problem and somehow coping	1216	You best act on it by reporting the problem and somehow coping with the
866	with the watcher being stopped.	1217	watcher being stopped. Note that well-written programs should not receive
		1218	an error ever, so when your watcher receives it, this usually indicates a
		1219	bug in your program.
867		1220
868	Libev will usually signal a few "dummy" events together with an error,	1221	Libev will usually signal a few "dummy" events together with an error, for
869	for example it might indicate that a fd is readable or writable, and if	1222	example it might indicate that a fd is readable or writable, and if your
870	your callbacks is well-written it can just attempt the operation and cope	1223	callbacks is well-written it can just attempt the operation and cope with
871	with the error from read() or write(). This will not work in multi-threaded	1224	the error from read() or write(). This will not work in multi-threaded
872	programs, though, so beware.	1225	programs, though, as the fd could already be closed and reused for another
		1226	thing, so beware.
873		1227
874	=back	1228	=back
875		1229
876	=head2 GENERIC WATCHER FUNCTIONS	1230	=head2 GENERIC WATCHER FUNCTIONS
877
878	In the following description, C<TYPE> stands for the watcher type,
879	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
880		1231
881	=over 4	1232	=over 4
882		1233
883	=item C<ev_init> (ev_TYPE *watcher, callback)	1234	=item C<ev_init> (ev_TYPE *watcher, callback)
884		1235
…		…
890	which rolls both calls into one.	1241	which rolls both calls into one.
891		1242
892	You can reinitialise a watcher at any time as long as it has been stopped	1243	You can reinitialise a watcher at any time as long as it has been stopped
893	(or never started) and there are no pending events outstanding.	1244	(or never started) and there are no pending events outstanding.
894		1245
895	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	1246	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
896	int revents)>.	1247	int revents)>.
897		1248
		1249	Example: Initialise an C<ev_io> watcher in two steps.
		1250
		1251	ev_io w;
		1252	ev_init (&w, my_cb);
		1253	ev_io_set (&w, STDIN_FILENO, EV_READ);
		1254
898	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1255	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
899		1256
900	This macro initialises the type-specific parts of a watcher. You need to	1257	This macro initialises the type-specific parts of a watcher. You need to
901	call C<ev_init> at least once before you call this macro, but you can	1258	call C<ev_init> at least once before you call this macro, but you can
902	call C<ev_TYPE_set> any number of times. You must not, however, call this	1259	call C<ev_TYPE_set> any number of times. You must not, however, call this
903	macro on a watcher that is active (it can be pending, however, which is a	1260	macro on a watcher that is active (it can be pending, however, which is a
904	difference to the C<ev_init> macro).	1261	difference to the C<ev_init> macro).
905		1262
906	Although some watcher types do not have type-specific arguments	1263	Although some watcher types do not have type-specific arguments
907	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	1264	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
908		1265
		1266	See C<ev_init>, above, for an example.
		1267
909	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	1268	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
910		1269
911	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	1270	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
912	calls into a single call. This is the most convenient method to initialise	1271	calls into a single call. This is the most convenient method to initialise
913	a watcher. The same limitations apply, of course.	1272	a watcher. The same limitations apply, of course.
914		1273
		1274	Example: Initialise and set an C<ev_io> watcher in one step.
		1275
		1276	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
		1277
915	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1278	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
916		1279
917	Starts (activates) the given watcher. Only active watchers will receive	1280	Starts (activates) the given watcher. Only active watchers will receive
918	events. If the watcher is already active nothing will happen.	1281	events. If the watcher is already active nothing will happen.
919		1282
		1283	Example: Start the C<ev_io> watcher that is being abused as example in this
		1284	whole section.
		1285
		1286	ev_io_start (EV_DEFAULT_UC, &w);
		1287
920	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1288	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
921		1289
922	Stops the given watcher again (if active) and clears the pending	1290	Stops the given watcher if active, and clears the pending status (whether
		1291	the watcher was active or not).
		1292
923	status. It is possible that stopped watchers are pending (for example,	1293	It is possible that stopped watchers are pending - for example,
924	non-repeating timers are being stopped when they become pending), but	1294	non-repeating timers are being stopped when they become pending - but
925	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	1295	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
926	you want to free or reuse the memory used by the watcher it is therefore a	1296	pending. If you want to free or reuse the memory used by the watcher it is
927	good idea to always call its C<ev_TYPE_stop> function.	1297	therefore a good idea to always call its C<ev_TYPE_stop> function.
928		1298
929	=item bool ev_is_active (ev_TYPE *watcher)	1299	=item bool ev_is_active (ev_TYPE *watcher)
930		1300
931	Returns a true value iff the watcher is active (i.e. it has been started	1301	Returns a true value iff the watcher is active (i.e. it has been started
932	and not yet been stopped). As long as a watcher is active you must not modify	1302	and not yet been stopped). As long as a watcher is active you must not modify
…		…
948	=item ev_cb_set (ev_TYPE *watcher, callback)	1318	=item ev_cb_set (ev_TYPE *watcher, callback)
949		1319
950	Change the callback. You can change the callback at virtually any time	1320	Change the callback. You can change the callback at virtually any time
951	(modulo threads).	1321	(modulo threads).
952		1322
953	=item ev_set_priority (ev_TYPE *watcher, priority)	1323	=item ev_set_priority (ev_TYPE *watcher, int priority)
954		1324
955	=item int ev_priority (ev_TYPE *watcher)	1325	=item int ev_priority (ev_TYPE *watcher)
956		1326
957	Set and query the priority of the watcher. The priority is a small	1327	Set and query the priority of the watcher. The priority is a small
958	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1328	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
959	(default: C<-2>). Pending watchers with higher priority will be invoked	1329	(default: C<-2>). Pending watchers with higher priority will be invoked
960	before watchers with lower priority, but priority will not keep watchers	1330	before watchers with lower priority, but priority will not keep watchers
961	from being executed (except for C<ev_idle> watchers).	1331	from being executed (except for C<ev_idle> watchers).
962		1332
963	This means that priorities are I<only> used for ordering callback
964	invocation after new events have been received. This is useful, for
965	example, to reduce latency after idling, or more often, to bind two
966	watchers on the same event and make sure one is called first.
967
968	If you need to suppress invocation when higher priority events are pending	1333	If you need to suppress invocation when higher priority events are pending
969	you need to look at C<ev_idle> watchers, which provide this functionality.	1334	you need to look at C<ev_idle> watchers, which provide this functionality.
970		1335
971	You I<must not> change the priority of a watcher as long as it is active or	1336	You I<must not> change the priority of a watcher as long as it is active or
972	pending.	1337	pending.
973		1338
		1339	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1340	fine, as long as you do not mind that the priority value you query might
		1341	or might not have been clamped to the valid range.
		1342
974	The default priority used by watchers when no priority has been set is	1343	The default priority used by watchers when no priority has been set is
975	always C<0>, which is supposed to not be too high and not be too low :).	1344	always C<0>, which is supposed to not be too high and not be too low :).
976		1345
977	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1346	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
978	fine, as long as you do not mind that the priority value you query might	1347	priorities.
979	or might not have been adjusted to be within valid range.
980		1348
981	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1349	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
982		1350
983	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1351	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
984	C<loop> nor C<revents> need to be valid as long as the watcher callback	1352	C<loop> nor C<revents> need to be valid as long as the watcher callback
985	can deal with that fact.	1353	can deal with that fact, as both are simply passed through to the
		1354	callback.
986		1355
987	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1356	=item int ev_clear_pending (loop, ev_TYPE *watcher)
988		1357
989	If the watcher is pending, this function returns clears its pending status	1358	If the watcher is pending, this function clears its pending status and
990	and returns its C<revents> bitset (as if its callback was invoked). If the	1359	returns its C<revents> bitset (as if its callback was invoked). If the
991	watcher isn't pending it does nothing and returns C<0>.	1360	watcher isn't pending it does nothing and returns C<0>.
992		1361
		1362	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1363	callback to be invoked, which can be accomplished with this function.
		1364
		1365	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1366
		1367	Feeds the given event set into the event loop, as if the specified event
		1368	had happened for the specified watcher (which must be a pointer to an
		1369	initialised but not necessarily started event watcher). Obviously you must
		1370	not free the watcher as long as it has pending events.
		1371
		1372	Stopping the watcher, letting libev invoke it, or calling
		1373	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1374	not started in the first place.
		1375
		1376	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1377	functions that do not need a watcher.
		1378
993	=back	1379	=back
994		1380
		1381	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1382	OWN COMPOSITE WATCHERS> idioms.
995		1383
996	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1384	=head2 WATCHER STATES
997		1385
998	Each watcher has, by default, a member C<void *data> that you can change	1386	There are various watcher states mentioned throughout this manual -
999	and read at any time, libev will completely ignore it. This can be used	1387	active, pending and so on. In this section these states and the rules to
1000	to associate arbitrary data with your watcher. If you need more data and	1388	transition between them will be described in more detail - and while these
1001	don't want to allocate memory and store a pointer to it in that data	1389	rules might look complicated, they usually do "the right thing".
1002	member, you can also "subclass" the watcher type and provide your own
1003	data:
1004		1390
1005	struct my_io	1391	=over 4
		1392
		1393	=item initialiased
		1394
		1395	Before a watcher can be registered with the event loop it has to be
		1396	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1397	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1398
		1399	In this state it is simply some block of memory that is suitable for
		1400	use in an event loop. It can be moved around, freed, reused etc. at
		1401	will - as long as you either keep the memory contents intact, or call
		1402	C<ev_TYPE_init> again.
		1403
		1404	=item started/running/active
		1405
		1406	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1407	property of the event loop, and is actively waiting for events. While in
		1408	this state it cannot be accessed (except in a few documented ways), moved,
		1409	freed or anything else - the only legal thing is to keep a pointer to it,
		1410	and call libev functions on it that are documented to work on active watchers.
		1411
		1412	=item pending
		1413
		1414	If a watcher is active and libev determines that an event it is interested
		1415	in has occurred (such as a timer expiring), it will become pending. It will
		1416	stay in this pending state until either it is stopped or its callback is
		1417	about to be invoked, so it is not normally pending inside the watcher
		1418	callback.
		1419
		1420	The watcher might or might not be active while it is pending (for example,
		1421	an expired non-repeating timer can be pending but no longer active). If it
		1422	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1423	but it is still property of the event loop at this time, so cannot be
		1424	moved, freed or reused. And if it is active the rules described in the
		1425	previous item still apply.
		1426
		1427	It is also possible to feed an event on a watcher that is not active (e.g.
		1428	via C<ev_feed_event>), in which case it becomes pending without being
		1429	active.
		1430
		1431	=item stopped
		1432
		1433	A watcher can be stopped implicitly by libev (in which case it might still
		1434	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1435	latter will clear any pending state the watcher might be in, regardless
		1436	of whether it was active or not, so stopping a watcher explicitly before
		1437	freeing it is often a good idea.
		1438
		1439	While stopped (and not pending) the watcher is essentially in the
		1440	initialised state, that is, it can be reused, moved, modified in any way
		1441	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1442	it again).
		1443
		1444	=back
		1445
		1446	=head2 WATCHER PRIORITY MODELS
		1447
		1448	Many event loops support I<watcher priorities>, which are usually small
		1449	integers that influence the ordering of event callback invocation
		1450	between watchers in some way, all else being equal.
		1451
		1452	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1453	description for the more technical details such as the actual priority
		1454	range.
		1455
		1456	There are two common ways how these these priorities are being interpreted
		1457	by event loops:
		1458
		1459	In the more common lock-out model, higher priorities "lock out" invocation
		1460	of lower priority watchers, which means as long as higher priority
		1461	watchers receive events, lower priority watchers are not being invoked.
		1462
		1463	The less common only-for-ordering model uses priorities solely to order
		1464	callback invocation within a single event loop iteration: Higher priority
		1465	watchers are invoked before lower priority ones, but they all get invoked
		1466	before polling for new events.
		1467
		1468	Libev uses the second (only-for-ordering) model for all its watchers
		1469	except for idle watchers (which use the lock-out model).
		1470
		1471	The rationale behind this is that implementing the lock-out model for
		1472	watchers is not well supported by most kernel interfaces, and most event
		1473	libraries will just poll for the same events again and again as long as
		1474	their callbacks have not been executed, which is very inefficient in the
		1475	common case of one high-priority watcher locking out a mass of lower
		1476	priority ones.
		1477
		1478	Static (ordering) priorities are most useful when you have two or more
		1479	watchers handling the same resource: a typical usage example is having an
		1480	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1481	timeouts. Under load, data might be received while the program handles
		1482	other jobs, but since timers normally get invoked first, the timeout
		1483	handler will be executed before checking for data. In that case, giving
		1484	the timer a lower priority than the I/O watcher ensures that I/O will be
		1485	handled first even under adverse conditions (which is usually, but not
		1486	always, what you want).
		1487
		1488	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1489	will only be executed when no same or higher priority watchers have
		1490	received events, they can be used to implement the "lock-out" model when
		1491	required.
		1492
		1493	For example, to emulate how many other event libraries handle priorities,
		1494	you can associate an C<ev_idle> watcher to each such watcher, and in
		1495	the normal watcher callback, you just start the idle watcher. The real
		1496	processing is done in the idle watcher callback. This causes libev to
		1497	continuously poll and process kernel event data for the watcher, but when
		1498	the lock-out case is known to be rare (which in turn is rare :), this is
		1499	workable.
		1500
		1501	Usually, however, the lock-out model implemented that way will perform
		1502	miserably under the type of load it was designed to handle. In that case,
		1503	it might be preferable to stop the real watcher before starting the
		1504	idle watcher, so the kernel will not have to process the event in case
		1505	the actual processing will be delayed for considerable time.
		1506
		1507	Here is an example of an I/O watcher that should run at a strictly lower
		1508	priority than the default, and which should only process data when no
		1509	other events are pending:
		1510
		1511	ev_idle idle; // actual processing watcher
		1512	ev_io io; // actual event watcher
		1513
		1514	static void
		1515	io_cb (EV_P_ ev_io *w, int revents)
1006	{	1516	{
1007	struct ev_io io;	1517	// stop the I/O watcher, we received the event, but
1008	int otherfd;	1518	// are not yet ready to handle it.
1009	void *somedata;	1519	ev_io_stop (EV_A_ w);
1010	struct whatever *mostinteresting;	1520
		1521	// start the idle watcher to handle the actual event.
		1522	// it will not be executed as long as other watchers
		1523	// with the default priority are receiving events.
		1524	ev_idle_start (EV_A_ &idle);
1011	}	1525	}
1012		1526
1013	And since your callback will be called with a pointer to the watcher, you	1527	static void
1014	can cast it back to your own type:	1528	idle_cb (EV_P_ ev_idle *w, int revents)
1015
1016	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)
1017	{	1529	{
1018	struct my_io *w = (struct my_io *)w_;	1530	// actual processing
1019	...	1531	read (STDIN_FILENO, ...);
		1532
		1533	// have to start the I/O watcher again, as
		1534	// we have handled the event
		1535	ev_io_start (EV_P_ &io);
1020	}	1536	}
1021		1537
1022	More interesting and less C-conformant ways of casting your callback type	1538	// initialisation
1023	instead have been omitted.	1539	ev_idle_init (&idle, idle_cb);
		1540	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1541	ev_io_start (EV_DEFAULT_ &io);
1024		1542
1025	Another common scenario is having some data structure with multiple	1543	In the "real" world, it might also be beneficial to start a timer, so that
1026	watchers:	1544	low-priority connections can not be locked out forever under load. This
1027		1545	enables your program to keep a lower latency for important connections
1028	struct my_biggy	1546	during short periods of high load, while not completely locking out less
1029	{	1547	important ones.
1030	int some_data;
1031	ev_timer t1;
1032	ev_timer t2;
1033	}
1034
1035	In this case getting the pointer to C<my_biggy> is a bit more complicated,
1036	you need to use C<offsetof>:
1037
1038	#include <stddef.h>
1039
1040	static void
1041	t1_cb (EV_P_ struct ev_timer *w, int revents)
1042	{
1043	struct my_biggy big = (struct my_biggy *
1044	(((char *)w) - offsetof (struct my_biggy, t1));
1045	}
1046
1047	static void
1048	t2_cb (EV_P_ struct ev_timer *w, int revents)
1049	{
1050	struct my_biggy big = (struct my_biggy *
1051	(((char *)w) - offsetof (struct my_biggy, t2));
1052	}
1053		1548
1054		1549
1055	=head1 WATCHER TYPES	1550	=head1 WATCHER TYPES
1056		1551
1057	This section describes each watcher in detail, but will not repeat	1552	This section describes each watcher in detail, but will not repeat
…		…
1081	In general you can register as many read and/or write event watchers per	1576	In general you can register as many read and/or write event watchers per
1082	fd as you want (as long as you don't confuse yourself). Setting all file	1577	fd as you want (as long as you don't confuse yourself). Setting all file
1083	descriptors to non-blocking mode is also usually a good idea (but not	1578	descriptors to non-blocking mode is also usually a good idea (but not
1084	required if you know what you are doing).	1579	required if you know what you are doing).
1085		1580
1086	If you must do this, then force the use of a known-to-be-good backend
1087	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
1088	C<EVBACKEND_POLL>).
1089
1090	Another thing you have to watch out for is that it is quite easy to	1581	Another thing you have to watch out for is that it is quite easy to
1091	receive "spurious" readiness notifications, that is your callback might	1582	receive "spurious" readiness notifications, that is, your callback might
1092	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1583	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1093	because there is no data. Not only are some backends known to create a	1584	because there is no data. It is very easy to get into this situation even
1094	lot of those (for example Solaris ports), it is very easy to get into	1585	with a relatively standard program structure. Thus it is best to always
1095	this situation even with a relatively standard program structure. Thus	1586	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1096	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1097	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1587	preferable to a program hanging until some data arrives.
1098		1588
1099	If you cannot run the fd in non-blocking mode (for example you should not	1589	If you cannot run the fd in non-blocking mode (for example you should
1100	play around with an Xlib connection), then you have to separately re-test	1590	not play around with an Xlib connection), then you have to separately
1101	whether a file descriptor is really ready with a known-to-be good interface	1591	re-test whether a file descriptor is really ready with a known-to-be good
1102	such as poll (fortunately in our Xlib example, Xlib already does this on	1592	interface such as poll (fortunately in the case of Xlib, it already does
1103	its own, so its quite safe to use).	1593	this on its own, so its quite safe to use). Some people additionally
		1594	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1595	indefinitely.
		1596
		1597	But really, best use non-blocking mode.
1104		1598
1105	=head3 The special problem of disappearing file descriptors	1599	=head3 The special problem of disappearing file descriptors
1106		1600
1107	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1601	Some backends (e.g. kqueue, epoll) need to be told about closing a file
1108	descriptor (either by calling C<close> explicitly or by any other means,	1602	descriptor (either due to calling C<close> explicitly or any other means,
1109	such as C<dup>). The reason is that you register interest in some file	1603	such as C<dup2>). The reason is that you register interest in some file
1110	descriptor, but when it goes away, the operating system will silently drop	1604	descriptor, but when it goes away, the operating system will silently drop
1111	this interest. If another file descriptor with the same number then is	1605	this interest. If another file descriptor with the same number then is
1112	registered with libev, there is no efficient way to see that this is, in	1606	registered with libev, there is no efficient way to see that this is, in
1113	fact, a different file descriptor.	1607	fact, a different file descriptor.
1114		1608
…		…
1132		1626
1133	There is no workaround possible except not registering events	1627	There is no workaround possible except not registering events
1134	for potentially C<dup ()>'ed file descriptors, or to resort to	1628	for potentially C<dup ()>'ed file descriptors, or to resort to
1135	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1629	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1136		1630
		1631	=head3 The special problem of files
		1632
		1633	Many people try to use C<select> (or libev) on file descriptors
		1634	representing files, and expect it to become ready when their program
		1635	doesn't block on disk accesses (which can take a long time on their own).
		1636
		1637	However, this cannot ever work in the "expected" way - you get a readiness
		1638	notification as soon as the kernel knows whether and how much data is
		1639	there, and in the case of open files, that's always the case, so you
		1640	always get a readiness notification instantly, and your read (or possibly
		1641	write) will still block on the disk I/O.
		1642
		1643	Another way to view it is that in the case of sockets, pipes, character
		1644	devices and so on, there is another party (the sender) that delivers data
		1645	on its own, but in the case of files, there is no such thing: the disk
		1646	will not send data on its own, simply because it doesn't know what you
		1647	wish to read - you would first have to request some data.
		1648
		1649	Since files are typically not-so-well supported by advanced notification
		1650	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1651	to files, even though you should not use it. The reason for this is
		1652	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1653	usually a tty, often a pipe, but also sometimes files or special devices
		1654	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1655	F</dev/urandom>), and even though the file might better be served with
		1656	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1657	it "just works" instead of freezing.
		1658
		1659	So avoid file descriptors pointing to files when you know it (e.g. use
		1660	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1661	when you rarely read from a file instead of from a socket, and want to
		1662	reuse the same code path.
		1663
1137	=head3 The special problem of fork	1664	=head3 The special problem of fork
1138		1665
1139	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1666	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1140	useless behaviour. Libev fully supports fork, but needs to be told about	1667	useless behaviour. Libev fully supports fork, but needs to be told about
1141	it in the child.	1668	it in the child if you want to continue to use it in the child.
1142		1669
1143	To support fork in your programs, you either have to call	1670	To support fork in your child processes, you have to call C<ev_loop_fork
1144	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1671	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1145	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1672	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1146	C<EVBACKEND_POLL>.
1147		1673
1148	=head3 The special problem of SIGPIPE	1674	=head3 The special problem of SIGPIPE
1149		1675
1150	While not really specific to libev, it is easy to forget about SIGPIPE:	1676	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1151	when writing to a pipe whose other end has been closed, your program gets	1677	when writing to a pipe whose other end has been closed, your program gets
1152	send a SIGPIPE, which, by default, aborts your program. For most programs	1678	sent a SIGPIPE, which, by default, aborts your program. For most programs
1153	this is sensible behaviour, for daemons, this is usually undesirable.	1679	this is sensible behaviour, for daemons, this is usually undesirable.
1154		1680
1155	So when you encounter spurious, unexplained daemon exits, make sure you	1681	So when you encounter spurious, unexplained daemon exits, make sure you
1156	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1682	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1157	somewhere, as that would have given you a big clue).	1683	somewhere, as that would have given you a big clue).
1158		1684
		1685	=head3 The special problem of accept()ing when you can't
		1686
		1687	Many implementations of the POSIX C<accept> function (for example,
		1688	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1689	connection from the pending queue in all error cases.
		1690
		1691	For example, larger servers often run out of file descriptors (because
		1692	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1693	rejecting the connection, leading to libev signalling readiness on
		1694	the next iteration again (the connection still exists after all), and
		1695	typically causing the program to loop at 100% CPU usage.
		1696
		1697	Unfortunately, the set of errors that cause this issue differs between
		1698	operating systems, there is usually little the app can do to remedy the
		1699	situation, and no known thread-safe method of removing the connection to
		1700	cope with overload is known (to me).
		1701
		1702	One of the easiest ways to handle this situation is to just ignore it
		1703	- when the program encounters an overload, it will just loop until the
		1704	situation is over. While this is a form of busy waiting, no OS offers an
		1705	event-based way to handle this situation, so it's the best one can do.
		1706
		1707	A better way to handle the situation is to log any errors other than
		1708	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1709	messages, and continue as usual, which at least gives the user an idea of
		1710	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1711	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1712	usage.
		1713
		1714	If your program is single-threaded, then you could also keep a dummy file
		1715	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1716	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1717	close that fd, and create a new dummy fd. This will gracefully refuse
		1718	clients under typical overload conditions.
		1719
		1720	The last way to handle it is to simply log the error and C<exit>, as
		1721	is often done with C<malloc> failures, but this results in an easy
		1722	opportunity for a DoS attack.
1159		1723
1160	=head3 Watcher-Specific Functions	1724	=head3 Watcher-Specific Functions
1161		1725
1162	=over 4	1726	=over 4
1163		1727
1164	=item ev_io_init (ev_io *, callback, int fd, int events)	1728	=item ev_io_init (ev_io *, callback, int fd, int events)
1165		1729
1166	=item ev_io_set (ev_io *, int fd, int events)	1730	=item ev_io_set (ev_io *, int fd, int events)
1167		1731
1168	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1732	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1169	receive events for and events is either C<EV_READ>, C<EV_WRITE> or	1733	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1170	C<EV_READ | EV_WRITE> to receive the given events.	1734	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1171		1735
1172	=item int fd [read-only]	1736	=item int fd [read-only]
1173		1737
1174	The file descriptor being watched.	1738	The file descriptor being watched.
1175		1739
…		…
1184	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1748	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1185	readable, but only once. Since it is likely line-buffered, you could	1749	readable, but only once. Since it is likely line-buffered, you could
1186	attempt to read a whole line in the callback.	1750	attempt to read a whole line in the callback.
1187		1751
1188	static void	1752	static void
1189	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1753	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1190	{	1754	{
1191	ev_io_stop (loop, w);	1755	ev_io_stop (loop, w);
1192	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1756	.. read from stdin here (or from w->fd) and handle any I/O errors
1193	}	1757	}
1194		1758
1195	...	1759	...
1196	struct ev_loop *loop = ev_default_init (0);	1760	struct ev_loop *loop = ev_default_init (0);
1197	struct ev_io stdin_readable;	1761	ev_io stdin_readable;
1198	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1762	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1199	ev_io_start (loop, &stdin_readable);	1763	ev_io_start (loop, &stdin_readable);
1200	ev_loop (loop, 0);	1764	ev_run (loop, 0);
1201		1765
1202		1766
1203	=head2 C<ev_timer> - relative and optionally repeating timeouts	1767	=head2 C<ev_timer> - relative and optionally repeating timeouts
1204		1768
1205	Timer watchers are simple relative timers that generate an event after a	1769	Timer watchers are simple relative timers that generate an event after a
1206	given time, and optionally repeating in regular intervals after that.	1770	given time, and optionally repeating in regular intervals after that.
1207		1771
1208	The timers are based on real time, that is, if you register an event that	1772	The timers are based on real time, that is, if you register an event that
1209	times out after an hour and you reset your system clock to January last	1773	times out after an hour and you reset your system clock to January last
1210	year, it will still time out after (roughly) and hour. "Roughly" because	1774	year, it will still time out after (roughly) one hour. "Roughly" because
1211	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1775	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1212	monotonic clock option helps a lot here).	1776	monotonic clock option helps a lot here).
1213		1777
1214	The callback is guaranteed to be invoked only after its timeout has passed,	1778	The callback is guaranteed to be invoked only I<after> its timeout has
1215	but if multiple timers become ready during the same loop iteration then	1779	passed (not I<at>, so on systems with very low-resolution clocks this
1216	order of execution is undefined.	1780	might introduce a small delay, see "the special problem of being too
		1781	early", below). If multiple timers become ready during the same loop
		1782	iteration then the ones with earlier time-out values are invoked before
		1783	ones of the same priority with later time-out values (but this is no
		1784	longer true when a callback calls C<ev_run> recursively).
		1785
		1786	=head3 Be smart about timeouts
		1787
		1788	Many real-world problems involve some kind of timeout, usually for error
		1789	recovery. A typical example is an HTTP request - if the other side hangs,
		1790	you want to raise some error after a while.
		1791
		1792	What follows are some ways to handle this problem, from obvious and
		1793	inefficient to smart and efficient.
		1794
		1795	In the following, a 60 second activity timeout is assumed - a timeout that
		1796	gets reset to 60 seconds each time there is activity (e.g. each time some
		1797	data or other life sign was received).
		1798
		1799	=over 4
		1800
		1801	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1802
		1803	This is the most obvious, but not the most simple way: In the beginning,
		1804	start the watcher:
		1805
		1806	ev_timer_init (timer, callback, 60., 0.);
		1807	ev_timer_start (loop, timer);
		1808
		1809	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1810	and start it again:
		1811
		1812	ev_timer_stop (loop, timer);
		1813	ev_timer_set (timer, 60., 0.);
		1814	ev_timer_start (loop, timer);
		1815
		1816	This is relatively simple to implement, but means that each time there is
		1817	some activity, libev will first have to remove the timer from its internal
		1818	data structure and then add it again. Libev tries to be fast, but it's
		1819	still not a constant-time operation.
		1820
		1821	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1822
		1823	This is the easiest way, and involves using C<ev_timer_again> instead of
		1824	C<ev_timer_start>.
		1825
		1826	To implement this, configure an C<ev_timer> with a C<repeat> value
		1827	of C<60> and then call C<ev_timer_again> at start and each time you
		1828	successfully read or write some data. If you go into an idle state where
		1829	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1830	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1831
		1832	That means you can ignore both the C<ev_timer_start> function and the
		1833	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1834	member and C<ev_timer_again>.
		1835
		1836	At start:
		1837
		1838	ev_init (timer, callback);
		1839	timer->repeat = 60.;
		1840	ev_timer_again (loop, timer);
		1841
		1842	Each time there is some activity:
		1843
		1844	ev_timer_again (loop, timer);
		1845
		1846	It is even possible to change the time-out on the fly, regardless of
		1847	whether the watcher is active or not:
		1848
		1849	timer->repeat = 30.;
		1850	ev_timer_again (loop, timer);
		1851
		1852	This is slightly more efficient then stopping/starting the timer each time
		1853	you want to modify its timeout value, as libev does not have to completely
		1854	remove and re-insert the timer from/into its internal data structure.
		1855
		1856	It is, however, even simpler than the "obvious" way to do it.
		1857
		1858	=item 3. Let the timer time out, but then re-arm it as required.
		1859
		1860	This method is more tricky, but usually most efficient: Most timeouts are
		1861	relatively long compared to the intervals between other activity - in
		1862	our example, within 60 seconds, there are usually many I/O events with
		1863	associated activity resets.
		1864
		1865	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1866	but remember the time of last activity, and check for a real timeout only
		1867	within the callback:
		1868
		1869	ev_tstamp timeout = 60.;
		1870	ev_tstamp last_activity; // time of last activity
		1871	ev_timer timer;
		1872
		1873	static void
		1874	callback (EV_P_ ev_timer *w, int revents)
		1875	{
		1876	// calculate when the timeout would happen
		1877	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
		1878
		1879	// if negative, it means we the timeout already occured
		1880	if (after < 0.)
		1881	{
		1882	// timeout occurred, take action
		1883	}
		1884	else
		1885	{
		1886	// callback was invoked, but there was some recent
		1887	// activity. simply restart the timer to time out
		1888	// after "after" seconds, which is the earliest time
		1889	// the timeout can occur.
		1890	ev_timer_set (w, after, 0.);
		1891	ev_timer_start (EV_A_ w);
		1892	}
		1893	}
		1894
		1895	To summarise the callback: first calculate in how many seconds the
		1896	timeout will occur (by calculating the absolute time when it would occur,
		1897	C<last_activity + timeout>, and subtracting the current time, C<ev_now
		1898	(EV_A)> from that).
		1899
		1900	If this value is negative, then we are already past the timeout, i.e. we
		1901	timed out, and need to do whatever is needed in this case.
		1902
		1903	Otherwise, we now the earliest time at which the timeout would trigger,
		1904	and simply start the timer with this timeout value.
		1905
		1906	In other words, each time the callback is invoked it will check whether
		1907	the timeout cocured. If not, it will simply reschedule itself to check
		1908	again at the earliest time it could time out. Rinse. Repeat.
		1909
		1910	This scheme causes more callback invocations (about one every 60 seconds
		1911	minus half the average time between activity), but virtually no calls to
		1912	libev to change the timeout.
		1913
		1914	To start the machinery, simply initialise the watcher and set
		1915	C<last_activity> to the current time (meaning there was some activity just
		1916	now), then call the callback, which will "do the right thing" and start
		1917	the timer:
		1918
		1919	last_activity = ev_now (EV_A);
		1920	ev_init (&timer, callback);
		1921	callback (EV_A_ &timer, 0);
		1922
		1923	When there is some activity, simply store the current time in
		1924	C<last_activity>, no libev calls at all:
		1925
		1926	if (activity detected)
		1927	last_activity = ev_now (EV_A);
		1928
		1929	When your timeout value changes, then the timeout can be changed by simply
		1930	providing a new value, stopping the timer and calling the callback, which
		1931	will agaion do the right thing (for example, time out immediately :).
		1932
		1933	timeout = new_value;
		1934	ev_timer_stop (EV_A_ &timer);
		1935	callback (EV_A_ &timer, 0);
		1936
		1937	This technique is slightly more complex, but in most cases where the
		1938	time-out is unlikely to be triggered, much more efficient.
		1939
		1940	=item 4. Wee, just use a double-linked list for your timeouts.
		1941
		1942	If there is not one request, but many thousands (millions...), all
		1943	employing some kind of timeout with the same timeout value, then one can
		1944	do even better:
		1945
		1946	When starting the timeout, calculate the timeout value and put the timeout
		1947	at the I<end> of the list.
		1948
		1949	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1950	the list is expected to fire (for example, using the technique #3).
		1951
		1952	When there is some activity, remove the timer from the list, recalculate
		1953	the timeout, append it to the end of the list again, and make sure to
		1954	update the C<ev_timer> if it was taken from the beginning of the list.
		1955
		1956	This way, one can manage an unlimited number of timeouts in O(1) time for
		1957	starting, stopping and updating the timers, at the expense of a major
		1958	complication, and having to use a constant timeout. The constant timeout
		1959	ensures that the list stays sorted.
		1960
		1961	=back
		1962
		1963	So which method the best?
		1964
		1965	Method #2 is a simple no-brain-required solution that is adequate in most
		1966	situations. Method #3 requires a bit more thinking, but handles many cases
		1967	better, and isn't very complicated either. In most case, choosing either
		1968	one is fine, with #3 being better in typical situations.
		1969
		1970	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1971	rather complicated, but extremely efficient, something that really pays
		1972	off after the first million or so of active timers, i.e. it's usually
		1973	overkill :)
		1974
		1975	=head3 The special problem of being too early
		1976
		1977	If you ask a timer to call your callback after three seconds, then
		1978	you expect it to be invoked after three seconds - but of course, this
		1979	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1980	guaranteed to any precision by libev - imagine somebody suspending the
		1981	process with a STOP signal for a few hours for example.
		1982
		1983	So, libev tries to invoke your callback as soon as possible I<after> the
		1984	delay has occurred, but cannot guarantee this.
		1985
		1986	A less obvious failure mode is calling your callback too early: many event
		1987	loops compare timestamps with a "elapsed delay >= requested delay", but
		1988	this can cause your callback to be invoked much earlier than you would
		1989	expect.
		1990
		1991	To see why, imagine a system with a clock that only offers full second
		1992	resolution (think windows if you can't come up with a broken enough OS
		1993	yourself). If you schedule a one-second timer at the time 500.9, then the
		1994	event loop will schedule your timeout to elapse at a system time of 500
		1995	(500.9 truncated to the resolution) + 1, or 501.
		1996
		1997	If an event library looks at the timeout 0.1s later, it will see "501 >=
		1998	501" and invoke the callback 0.1s after it was started, even though a
		1999	one-second delay was requested - this is being "too early", despite best
		2000	intentions.
		2001
		2002	This is the reason why libev will never invoke the callback if the elapsed
		2003	delay equals the requested delay, but only when the elapsed delay is
		2004	larger than the requested delay. In the example above, libev would only invoke
		2005	the callback at system time 502, or 1.1s after the timer was started.
		2006
		2007	So, while libev cannot guarantee that your callback will be invoked
		2008	exactly when requested, it I<can> and I<does> guarantee that the requested
		2009	delay has actually elapsed, or in other words, it always errs on the "too
		2010	late" side of things.
1217		2011
1218	=head3 The special problem of time updates	2012	=head3 The special problem of time updates
1219		2013
1220	Establishing the current time is a costly operation (it usually takes at	2014	Establishing the current time is a costly operation (it usually takes
1221	least two system calls): EV therefore updates its idea of the current	2015	at least one system call): EV therefore updates its idea of the current
1222	time only before and after C<ev_loop> polls for new events, which causes	2016	time only before and after C<ev_run> collects new events, which causes a
1223	a growing difference between C<ev_now ()> and C<ev_time ()> when handling	2017	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1224	lots of events.	2018	lots of events in one iteration.
1225		2019
1226	The relative timeouts are calculated relative to the C<ev_now ()>	2020	The relative timeouts are calculated relative to the C<ev_now ()>
1227	time. This is usually the right thing as this timestamp refers to the time	2021	time. This is usually the right thing as this timestamp refers to the time
1228	of the event triggering whatever timeout you are modifying/starting. If	2022	of the event triggering whatever timeout you are modifying/starting. If
1229	you suspect event processing to be delayed and you I<need> to base the	2023	you suspect event processing to be delayed and you I<need> to base the
…		…
1233		2027
1234	If the event loop is suspended for a long time, you can also force an	2028	If the event loop is suspended for a long time, you can also force an
1235	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2029	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1236	()>.	2030	()>.
1237		2031
		2032	=head3 The special problem of unsynchronised clocks
		2033
		2034	Modern systems have a variety of clocks - libev itself uses the normal
		2035	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2036	jumps).
		2037
		2038	Neither of these clocks is synchronised with each other or any other clock
		2039	on the system, so C<ev_time ()> might return a considerably different time
		2040	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2041	a call to C<gettimeofday> might return a second count that is one higher
		2042	than a directly following call to C<time>.
		2043
		2044	The moral of this is to only compare libev-related timestamps with
		2045	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2046	a second or so.
		2047
		2048	One more problem arises due to this lack of synchronisation: if libev uses
		2049	the system monotonic clock and you compare timestamps from C<ev_time>
		2050	or C<ev_now> from when you started your timer and when your callback is
		2051	invoked, you will find that sometimes the callback is a bit "early".
		2052
		2053	This is because C<ev_timer>s work in real time, not wall clock time, so
		2054	libev makes sure your callback is not invoked before the delay happened,
		2055	I<measured according to the real time>, not the system clock.
		2056
		2057	If your timeouts are based on a physical timescale (e.g. "time out this
		2058	connection after 100 seconds") then this shouldn't bother you as it is
		2059	exactly the right behaviour.
		2060
		2061	If you want to compare wall clock/system timestamps to your timers, then
		2062	you need to use C<ev_periodic>s, as these are based on the wall clock
		2063	time, where your comparisons will always generate correct results.
		2064
		2065	=head3 The special problems of suspended animation
		2066
		2067	When you leave the server world it is quite customary to hit machines that
		2068	can suspend/hibernate - what happens to the clocks during such a suspend?
		2069
		2070	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		2071	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		2072	to run until the system is suspended, but they will not advance while the
		2073	system is suspended. That means, on resume, it will be as if the program
		2074	was frozen for a few seconds, but the suspend time will not be counted
		2075	towards C<ev_timer> when a monotonic clock source is used. The real time
		2076	clock advanced as expected, but if it is used as sole clocksource, then a
		2077	long suspend would be detected as a time jump by libev, and timers would
		2078	be adjusted accordingly.
		2079
		2080	I would not be surprised to see different behaviour in different between
		2081	operating systems, OS versions or even different hardware.
		2082
		2083	The other form of suspend (job control, or sending a SIGSTOP) will see a
		2084	time jump in the monotonic clocks and the realtime clock. If the program
		2085	is suspended for a very long time, and monotonic clock sources are in use,
		2086	then you can expect C<ev_timer>s to expire as the full suspension time
		2087	will be counted towards the timers. When no monotonic clock source is in
		2088	use, then libev will again assume a timejump and adjust accordingly.
		2089
		2090	It might be beneficial for this latter case to call C<ev_suspend>
		2091	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		2092	deterministic behaviour in this case (you can do nothing against
		2093	C<SIGSTOP>).
		2094
1238	=head3 Watcher-Specific Functions and Data Members	2095	=head3 Watcher-Specific Functions and Data Members
1239		2096
1240	=over 4	2097	=over 4
1241		2098
1242	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2099	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1255	keep up with the timer (because it takes longer than those 10 seconds to	2112	keep up with the timer (because it takes longer than those 10 seconds to
1256	do stuff) the timer will not fire more than once per event loop iteration.	2113	do stuff) the timer will not fire more than once per event loop iteration.
1257		2114
1258	=item ev_timer_again (loop, ev_timer *)	2115	=item ev_timer_again (loop, ev_timer *)
1259		2116
1260	This will act as if the timer timed out and restart it again if it is	2117	This will act as if the timer timed out, and restarts it again if it is
1261	repeating. The exact semantics are:	2118	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2119	timeout to the C<repeat> value and calling C<ev_timer_start>.
1262		2120
		2121	The exact semantics are as in the following rules, all of which will be
		2122	applied to the watcher:
		2123
		2124	=over 4
		2125
1263	If the timer is pending, its pending status is cleared.	2126	=item If the timer is pending, the pending status is always cleared.
1264		2127
1265	If the timer is started but non-repeating, stop it (as if it timed out).	2128	=item If the timer is started but non-repeating, stop it (as if it timed
		2129	out, without invoking it).
1266		2130
1267	If the timer is repeating, either start it if necessary (with the	2131	=item If the timer is repeating, make the C<repeat> value the new timeout
1268	C<repeat> value), or reset the running timer to the C<repeat> value.	2132	and start the timer, if necessary.
1269		2133
1270	This sounds a bit complicated, but here is a useful and typical	2134	=back
1271	example: Imagine you have a TCP connection and you want a so-called idle
1272	timeout, that is, you want to be called when there have been, say, 60
1273	seconds of inactivity on the socket. The easiest way to do this is to
1274	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1275	C<ev_timer_again> each time you successfully read or write some data. If
1276	you go into an idle state where you do not expect data to travel on the
1277	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1278	automatically restart it if need be.
1279		2135
1280	That means you can ignore the C<after> value and C<ev_timer_start>	2136	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1281	altogether and only ever use the C<repeat> value and C<ev_timer_again>:	2137	usage example.
1282		2138
1283	ev_timer_init (timer, callback, 0., 5.);	2139	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1284	ev_timer_again (loop, timer);
1285	...
1286	timer->again = 17.;
1287	ev_timer_again (loop, timer);
1288	...
1289	timer->again = 10.;
1290	ev_timer_again (loop, timer);
1291		2140
1292	This is more slightly efficient then stopping/starting the timer each time	2141	Returns the remaining time until a timer fires. If the timer is active,
1293	you want to modify its timeout value.	2142	then this time is relative to the current event loop time, otherwise it's
		2143	the timeout value currently configured.
		2144
		2145	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		2146	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
		2147	will return C<4>. When the timer expires and is restarted, it will return
		2148	roughly C<7> (likely slightly less as callback invocation takes some time,
		2149	too), and so on.
1294		2150
1295	=item ev_tstamp repeat [read-write]	2151	=item ev_tstamp repeat [read-write]
1296		2152
1297	The current C<repeat> value. Will be used each time the watcher times out	2153	The current C<repeat> value. Will be used each time the watcher times out
1298	or C<ev_timer_again> is called and determines the next timeout (if any),	2154	or C<ev_timer_again> is called, and determines the next timeout (if any),
1299	which is also when any modifications are taken into account.	2155	which is also when any modifications are taken into account.
1300		2156
1301	=back	2157	=back
1302		2158
1303	=head3 Examples	2159	=head3 Examples
1304		2160
1305	Example: Create a timer that fires after 60 seconds.	2161	Example: Create a timer that fires after 60 seconds.
1306		2162
1307	static void	2163	static void
1308	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	2164	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1309	{	2165	{
1310	.. one minute over, w is actually stopped right here	2166	.. one minute over, w is actually stopped right here
1311	}	2167	}
1312		2168
1313	struct ev_timer mytimer;	2169	ev_timer mytimer;
1314	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	2170	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1315	ev_timer_start (loop, &mytimer);	2171	ev_timer_start (loop, &mytimer);
1316		2172
1317	Example: Create a timeout timer that times out after 10 seconds of	2173	Example: Create a timeout timer that times out after 10 seconds of
1318	inactivity.	2174	inactivity.
1319		2175
1320	static void	2176	static void
1321	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	2177	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1322	{	2178	{
1323	.. ten seconds without any activity	2179	.. ten seconds without any activity
1324	}	2180	}
1325		2181
1326	struct ev_timer mytimer;	2182	ev_timer mytimer;
1327	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2183	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1328	ev_timer_again (&mytimer); /* start timer */	2184	ev_timer_again (&mytimer); /* start timer */
1329	ev_loop (loop, 0);	2185	ev_run (loop, 0);
1330		2186
1331	// and in some piece of code that gets executed on any "activity":	2187	// and in some piece of code that gets executed on any "activity":
1332	// reset the timeout to start ticking again at 10 seconds	2188	// reset the timeout to start ticking again at 10 seconds
1333	ev_timer_again (&mytimer);	2189	ev_timer_again (&mytimer);
1334		2190
…		…
1336	=head2 C<ev_periodic> - to cron or not to cron?	2192	=head2 C<ev_periodic> - to cron or not to cron?
1337		2193
1338	Periodic watchers are also timers of a kind, but they are very versatile	2194	Periodic watchers are also timers of a kind, but they are very versatile
1339	(and unfortunately a bit complex).	2195	(and unfortunately a bit complex).
1340		2196
1341	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	2197	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1342	but on wall clock time (absolute time). You can tell a periodic watcher	2198	relative time, the physical time that passes) but on wall clock time
1343	to trigger after some specific point in time. For example, if you tell a	2199	(absolute time, the thing you can read on your calender or clock). The
1344	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()	2200	difference is that wall clock time can run faster or slower than real
1345	+ 10.>, that is, an absolute time not a delay) and then reset your system	2201	time, and time jumps are not uncommon (e.g. when you adjust your
1346	clock to January of the previous year, then it will take more than year	2202	wrist-watch).
1347	to trigger the event (unlike an C<ev_timer>, which would still trigger
1348	roughly 10 seconds later as it uses a relative timeout).
1349		2203
		2204	You can tell a periodic watcher to trigger after some specific point
		2205	in time: for example, if you tell a periodic watcher to trigger "in 10
		2206	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		2207	not a delay) and then reset your system clock to January of the previous
		2208	year, then it will take a year or more to trigger the event (unlike an
		2209	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		2210	it, as it uses a relative timeout).
		2211
1350	C<ev_periodic>s can also be used to implement vastly more complex timers,	2212	C<ev_periodic> watchers can also be used to implement vastly more complex
1351	such as triggering an event on each "midnight, local time", or other	2213	timers, such as triggering an event on each "midnight, local time", or
1352	complicated, rules.	2214	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		2215	those cannot react to time jumps.
1353		2216
1354	As with timers, the callback is guaranteed to be invoked only when the	2217	As with timers, the callback is guaranteed to be invoked only when the
1355	time (C<at>) has passed, but if multiple periodic timers become ready	2218	point in time where it is supposed to trigger has passed. If multiple
1356	during the same loop iteration then order of execution is undefined.	2219	timers become ready during the same loop iteration then the ones with
		2220	earlier time-out values are invoked before ones with later time-out values
		2221	(but this is no longer true when a callback calls C<ev_run> recursively).
1357		2222
1358	=head3 Watcher-Specific Functions and Data Members	2223	=head3 Watcher-Specific Functions and Data Members
1359		2224
1360	=over 4	2225	=over 4
1361		2226
1362	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	2227	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1363		2228
1364	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	2229	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1365		2230
1366	Lots of arguments, lets sort it out... There are basically three modes of	2231	Lots of arguments, let's sort it out... There are basically three modes of
1367	operation, and we will explain them from simplest to complex:	2232	operation, and we will explain them from simplest to most complex:
1368		2233
1369	=over 4	2234	=over 4
1370		2235
1371	=item * absolute timer (at = time, interval = reschedule_cb = 0)	2236	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1372		2237
1373	In this configuration the watcher triggers an event after the wall clock	2238	In this configuration the watcher triggers an event after the wall clock
1374	time C<at> has passed and doesn't repeat. It will not adjust when a time	2239	time C<offset> has passed. It will not repeat and will not adjust when a
1375	jump occurs, that is, if it is to be run at January 1st 2011 then it will	2240	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1376	run when the system time reaches or surpasses this time.	2241	will be stopped and invoked when the system clock reaches or surpasses
		2242	this point in time.
1377		2243
1378	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	2244	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1379		2245
1380	In this mode the watcher will always be scheduled to time out at the next	2246	In this mode the watcher will always be scheduled to time out at the next
1381	C<at + N * interval> time (for some integer N, which can also be negative)	2247	C<offset + N * interval> time (for some integer N, which can also be
1382	and then repeat, regardless of any time jumps.	2248	negative) and then repeat, regardless of any time jumps. The C<offset>
		2249	argument is merely an offset into the C<interval> periods.
1383		2250
1384	This can be used to create timers that do not drift with respect to system	2251	This can be used to create timers that do not drift with respect to the
1385	time, for example, here is a C<ev_periodic> that triggers each hour, on	2252	system clock, for example, here is an C<ev_periodic> that triggers each
1386	the hour:	2253	hour, on the hour (with respect to UTC):
1387		2254
1388	ev_periodic_set (&periodic, 0., 3600., 0);	2255	ev_periodic_set (&periodic, 0., 3600., 0);
1389		2256
1390	This doesn't mean there will always be 3600 seconds in between triggers,	2257	This doesn't mean there will always be 3600 seconds in between triggers,
1391	but only that the callback will be called when the system time shows a	2258	but only that the callback will be called when the system time shows a
1392	full hour (UTC), or more correctly, when the system time is evenly divisible	2259	full hour (UTC), or more correctly, when the system time is evenly divisible
1393	by 3600.	2260	by 3600.
1394		2261
1395	Another way to think about it (for the mathematically inclined) is that	2262	Another way to think about it (for the mathematically inclined) is that
1396	C<ev_periodic> will try to run the callback in this mode at the next possible	2263	C<ev_periodic> will try to run the callback in this mode at the next possible
1397	time where C<time = at (mod interval)>, regardless of any time jumps.	2264	time where C<time = offset (mod interval)>, regardless of any time jumps.
1398		2265
1399	For numerical stability it is preferable that the C<at> value is near	2266	The C<interval> I<MUST> be positive, and for numerical stability, the
1400	C<ev_now ()> (the current time), but there is no range requirement for	2267	interval value should be higher than C<1/8192> (which is around 100
1401	this value, and in fact is often specified as zero.	2268	microseconds) and C<offset> should be higher than C<0> and should have
		2269	at most a similar magnitude as the current time (say, within a factor of
		2270	ten). Typical values for offset are, in fact, C<0> or something between
		2271	C<0> and C<interval>, which is also the recommended range.
1402		2272
1403	Note also that there is an upper limit to how often a timer can fire (CPU	2273	Note also that there is an upper limit to how often a timer can fire (CPU
1404	speed for example), so if C<interval> is very small then timing stability	2274	speed for example), so if C<interval> is very small then timing stability
1405	will of course deteriorate. Libev itself tries to be exact to be about one	2275	will of course deteriorate. Libev itself tries to be exact to be about one
1406	millisecond (if the OS supports it and the machine is fast enough).	2276	millisecond (if the OS supports it and the machine is fast enough).
1407		2277
1408	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	2278	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1409		2279
1410	In this mode the values for C<interval> and C<at> are both being	2280	In this mode the values for C<interval> and C<offset> are both being
1411	ignored. Instead, each time the periodic watcher gets scheduled, the	2281	ignored. Instead, each time the periodic watcher gets scheduled, the
1412	reschedule callback will be called with the watcher as first, and the	2282	reschedule callback will be called with the watcher as first, and the
1413	current time as second argument.	2283	current time as second argument.
1414		2284
1415	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	2285	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1416	ever, or make ANY event loop modifications whatsoever>.	2286	or make ANY other event loop modifications whatsoever, unless explicitly
		2287	allowed by documentation here>.
1417		2288
1418	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	2289	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1419	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the	2290	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1420	only event loop modification you are allowed to do).	2291	only event loop modification you are allowed to do).
1421		2292
1422	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic	2293	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1423	*w, ev_tstamp now)>, e.g.:	2294	*w, ev_tstamp now)>, e.g.:
1424		2295
		2296	static ev_tstamp
1425	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	2297	my_rescheduler (ev_periodic *w, ev_tstamp now)
1426	{	2298	{
1427	return now + 60.;	2299	return now + 60.;
1428	}	2300	}
1429		2301
1430	It must return the next time to trigger, based on the passed time value	2302	It must return the next time to trigger, based on the passed time value
…		…
1450	a different time than the last time it was called (e.g. in a crond like	2322	a different time than the last time it was called (e.g. in a crond like
1451	program when the crontabs have changed).	2323	program when the crontabs have changed).
1452		2324
1453	=item ev_tstamp ev_periodic_at (ev_periodic *)	2325	=item ev_tstamp ev_periodic_at (ev_periodic *)
1454		2326
1455	When active, returns the absolute time that the watcher is supposed to	2327	When active, returns the absolute time that the watcher is supposed
1456	trigger next.	2328	to trigger next. This is not the same as the C<offset> argument to
		2329	C<ev_periodic_set>, but indeed works even in interval and manual
		2330	rescheduling modes.
1457		2331
1458	=item ev_tstamp offset [read-write]	2332	=item ev_tstamp offset [read-write]
1459		2333
1460	When repeating, this contains the offset value, otherwise this is the	2334	When repeating, this contains the offset value, otherwise this is the
1461	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	2335	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		2336	although libev might modify this value for better numerical stability).
1462		2337
1463	Can be modified any time, but changes only take effect when the periodic	2338	Can be modified any time, but changes only take effect when the periodic
1464	timer fires or C<ev_periodic_again> is being called.	2339	timer fires or C<ev_periodic_again> is being called.
1465		2340
1466	=item ev_tstamp interval [read-write]	2341	=item ev_tstamp interval [read-write]
1467		2342
1468	The current interval value. Can be modified any time, but changes only	2343	The current interval value. Can be modified any time, but changes only
1469	take effect when the periodic timer fires or C<ev_periodic_again> is being	2344	take effect when the periodic timer fires or C<ev_periodic_again> is being
1470	called.	2345	called.
1471		2346
1472	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	2347	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1473		2348
1474	The current reschedule callback, or C<0>, if this functionality is	2349	The current reschedule callback, or C<0>, if this functionality is
1475	switched off. Can be changed any time, but changes only take effect when	2350	switched off. Can be changed any time, but changes only take effect when
1476	the periodic timer fires or C<ev_periodic_again> is being called.	2351	the periodic timer fires or C<ev_periodic_again> is being called.
1477		2352
1478	=back	2353	=back
1479		2354
1480	=head3 Examples	2355	=head3 Examples
1481		2356
1482	Example: Call a callback every hour, or, more precisely, whenever the	2357	Example: Call a callback every hour, or, more precisely, whenever the
1483	system clock is divisible by 3600. The callback invocation times have	2358	system time is divisible by 3600. The callback invocation times have
1484	potentially a lot of jitter, but good long-term stability.	2359	potentially a lot of jitter, but good long-term stability.
1485		2360
1486	static void	2361	static void
1487	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	2362	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1488	{	2363	{
1489	... its now a full hour (UTC, or TAI or whatever your clock follows)	2364	... its now a full hour (UTC, or TAI or whatever your clock follows)
1490	}	2365	}
1491		2366
1492	struct ev_periodic hourly_tick;	2367	ev_periodic hourly_tick;
1493	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	2368	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1494	ev_periodic_start (loop, &hourly_tick);	2369	ev_periodic_start (loop, &hourly_tick);
1495		2370
1496	Example: The same as above, but use a reschedule callback to do it:	2371	Example: The same as above, but use a reschedule callback to do it:
1497		2372
1498	#include <math.h>	2373	#include <math.h>
1499		2374
1500	static ev_tstamp	2375	static ev_tstamp
1501	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	2376	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1502	{	2377	{
1503	return fmod (now, 3600.) + 3600.;	2378	return now + (3600. - fmod (now, 3600.));
1504	}	2379	}
1505		2380
1506	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	2381	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1507		2382
1508	Example: Call a callback every hour, starting now:	2383	Example: Call a callback every hour, starting now:
1509		2384
1510	struct ev_periodic hourly_tick;	2385	ev_periodic hourly_tick;
1511	ev_periodic_init (&hourly_tick, clock_cb,	2386	ev_periodic_init (&hourly_tick, clock_cb,
1512	fmod (ev_now (loop), 3600.), 3600., 0);	2387	fmod (ev_now (loop), 3600.), 3600., 0);
1513	ev_periodic_start (loop, &hourly_tick);	2388	ev_periodic_start (loop, &hourly_tick);
1514		2389
1515		2390
1516	=head2 C<ev_signal> - signal me when a signal gets signalled!	2391	=head2 C<ev_signal> - signal me when a signal gets signalled!
1517		2392
1518	Signal watchers will trigger an event when the process receives a specific	2393	Signal watchers will trigger an event when the process receives a specific
1519	signal one or more times. Even though signals are very asynchronous, libev	2394	signal one or more times. Even though signals are very asynchronous, libev
1520	will try it's best to deliver signals synchronously, i.e. as part of the	2395	will try its best to deliver signals synchronously, i.e. as part of the
1521	normal event processing, like any other event.	2396	normal event processing, like any other event.
1522		2397
		2398	If you want signals to be delivered truly asynchronously, just use
		2399	C<sigaction> as you would do without libev and forget about sharing
		2400	the signal. You can even use C<ev_async> from a signal handler to
		2401	synchronously wake up an event loop.
		2402
1523	You can configure as many watchers as you like per signal. Only when the	2403	You can configure as many watchers as you like for the same signal, but
		2404	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2405	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2406	C<SIGINT> in both the default loop and another loop at the same time. At
		2407	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2408
1524	first watcher gets started will libev actually register a signal watcher	2409	When the first watcher gets started will libev actually register something
1525	with the kernel (thus it coexists with your own signal handlers as long	2410	with the kernel (thus it coexists with your own signal handlers as long as
1526	as you don't register any with libev). Similarly, when the last signal	2411	you don't register any with libev for the same signal).
1527	watcher for a signal is stopped libev will reset the signal handler to
1528	SIG_DFL (regardless of what it was set to before).
1529		2412
1530	If possible and supported, libev will install its handlers with	2413	If possible and supported, libev will install its handlers with
1531	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2414	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1532	interrupted. If you have a problem with system calls getting interrupted by	2415	not be unduly interrupted. If you have a problem with system calls getting
1533	signals you can block all signals in an C<ev_check> watcher and unblock	2416	interrupted by signals you can block all signals in an C<ev_check> watcher
1534	them in an C<ev_prepare> watcher.	2417	and unblock them in an C<ev_prepare> watcher.
		2418
		2419	=head3 The special problem of inheritance over fork/execve/pthread_create
		2420
		2421	Both the signal mask (C<sigprocmask>) and the signal disposition
		2422	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2423	stopping it again), that is, libev might or might not block the signal,
		2424	and might or might not set or restore the installed signal handler (but
		2425	see C<EVFLAG_NOSIGMASK>).
		2426
		2427	While this does not matter for the signal disposition (libev never
		2428	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2429	C<execve>), this matters for the signal mask: many programs do not expect
		2430	certain signals to be blocked.
		2431
		2432	This means that before calling C<exec> (from the child) you should reset
		2433	the signal mask to whatever "default" you expect (all clear is a good
		2434	choice usually).
		2435
		2436	The simplest way to ensure that the signal mask is reset in the child is
		2437	to install a fork handler with C<pthread_atfork> that resets it. That will
		2438	catch fork calls done by libraries (such as the libc) as well.
		2439
		2440	In current versions of libev, the signal will not be blocked indefinitely
		2441	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2442	the window of opportunity for problems, it will not go away, as libev
		2443	I<has> to modify the signal mask, at least temporarily.
		2444
		2445	So I can't stress this enough: I<If you do not reset your signal mask when
		2446	you expect it to be empty, you have a race condition in your code>. This
		2447	is not a libev-specific thing, this is true for most event libraries.
		2448
		2449	=head3 The special problem of threads signal handling
		2450
		2451	POSIX threads has problematic signal handling semantics, specifically,
		2452	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2453	threads in a process block signals, which is hard to achieve.
		2454
		2455	When you want to use sigwait (or mix libev signal handling with your own
		2456	for the same signals), you can tackle this problem by globally blocking
		2457	all signals before creating any threads (or creating them with a fully set
		2458	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2459	loops. Then designate one thread as "signal receiver thread" which handles
		2460	these signals. You can pass on any signals that libev might be interested
		2461	in by calling C<ev_feed_signal>.
1535		2462
1536	=head3 Watcher-Specific Functions and Data Members	2463	=head3 Watcher-Specific Functions and Data Members
1537		2464
1538	=over 4	2465	=over 4
1539		2466
…		…
1550		2477
1551	=back	2478	=back
1552		2479
1553	=head3 Examples	2480	=head3 Examples
1554		2481
1555	Example: Try to exit cleanly on SIGINT and SIGTERM.	2482	Example: Try to exit cleanly on SIGINT.
1556		2483
1557	static void	2484	static void
1558	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	2485	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1559	{	2486	{
1560	ev_unloop (loop, EVUNLOOP_ALL);	2487	ev_break (loop, EVBREAK_ALL);
1561	}	2488	}
1562		2489
1563	struct ev_signal signal_watcher;	2490	ev_signal signal_watcher;
1564	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2491	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1565	ev_signal_start (loop, &sigint_cb);	2492	ev_signal_start (loop, &signal_watcher);
1566		2493
1567		2494
1568	=head2 C<ev_child> - watch out for process status changes	2495	=head2 C<ev_child> - watch out for process status changes
1569		2496
1570	Child watchers trigger when your process receives a SIGCHLD in response to	2497	Child watchers trigger when your process receives a SIGCHLD in response to
1571	some child status changes (most typically when a child of yours dies). It	2498	some child status changes (most typically when a child of yours dies or
1572	is permissible to install a child watcher I<after> the child has been	2499	exits). It is permissible to install a child watcher I<after> the child
1573	forked (which implies it might have already exited), as long as the event	2500	has been forked (which implies it might have already exited), as long
1574	loop isn't entered (or is continued from a watcher).	2501	as the event loop isn't entered (or is continued from a watcher), i.e.,
		2502	forking and then immediately registering a watcher for the child is fine,
		2503	but forking and registering a watcher a few event loop iterations later or
		2504	in the next callback invocation is not.
1575		2505
1576	Only the default event loop is capable of handling signals, and therefore	2506	Only the default event loop is capable of handling signals, and therefore
1577	you can only register child watchers in the default event loop.	2507	you can only register child watchers in the default event loop.
1578		2508
		2509	Due to some design glitches inside libev, child watchers will always be
		2510	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2511	libev)
		2512
1579	=head3 Process Interaction	2513	=head3 Process Interaction
1580		2514
1581	Libev grabs C<SIGCHLD> as soon as the default event loop is	2515	Libev grabs C<SIGCHLD> as soon as the default event loop is
1582	initialised. This is necessary to guarantee proper behaviour even if	2516	initialised. This is necessary to guarantee proper behaviour even if the
1583	the first child watcher is started after the child exits. The occurrence	2517	first child watcher is started after the child exits. The occurrence
1584	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2518	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1585	synchronously as part of the event loop processing. Libev always reaps all	2519	synchronously as part of the event loop processing. Libev always reaps all
1586	children, even ones not watched.	2520	children, even ones not watched.
1587		2521
1588	=head3 Overriding the Built-In Processing	2522	=head3 Overriding the Built-In Processing
…		…
1598	=head3 Stopping the Child Watcher	2532	=head3 Stopping the Child Watcher
1599		2533
1600	Currently, the child watcher never gets stopped, even when the	2534	Currently, the child watcher never gets stopped, even when the
1601	child terminates, so normally one needs to stop the watcher in the	2535	child terminates, so normally one needs to stop the watcher in the
1602	callback. Future versions of libev might stop the watcher automatically	2536	callback. Future versions of libev might stop the watcher automatically
1603	when a child exit is detected.	2537	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2538	problem).
1604		2539
1605	=head3 Watcher-Specific Functions and Data Members	2540	=head3 Watcher-Specific Functions and Data Members
1606		2541
1607	=over 4	2542	=over 4
1608		2543
…		…
1640	its completion.	2575	its completion.
1641		2576
1642	ev_child cw;	2577	ev_child cw;
1643		2578
1644	static void	2579	static void
1645	child_cb (EV_P_ struct ev_child *w, int revents)	2580	child_cb (EV_P_ ev_child *w, int revents)
1646	{	2581	{
1647	ev_child_stop (EV_A_ w);	2582	ev_child_stop (EV_A_ w);
1648	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	2583	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1649	}	2584	}
1650		2585
…		…
1665		2600
1666		2601
1667	=head2 C<ev_stat> - did the file attributes just change?	2602	=head2 C<ev_stat> - did the file attributes just change?
1668		2603
1669	This watches a file system path for attribute changes. That is, it calls	2604	This watches a file system path for attribute changes. That is, it calls
1670	C<stat> regularly (or when the OS says it changed) and sees if it changed	2605	C<stat> on that path in regular intervals (or when the OS says it changed)
1671	compared to the last time, invoking the callback if it did.	2606	and sees if it changed compared to the last time, invoking the callback if
		2607	it did.
1672		2608
1673	The path does not need to exist: changing from "path exists" to "path does	2609	The path does not need to exist: changing from "path exists" to "path does
1674	not exist" is a status change like any other. The condition "path does	2610	not exist" is a status change like any other. The condition "path does not
1675	not exist" is signified by the C<st_nlink> field being zero (which is	2611	exist" (or more correctly "path cannot be stat'ed") is signified by the
1676	otherwise always forced to be at least one) and all the other fields of	2612	C<st_nlink> field being zero (which is otherwise always forced to be at
1677	the stat buffer having unspecified contents.	2613	least one) and all the other fields of the stat buffer having unspecified
		2614	contents.
1678		2615
1679	The path I<should> be absolute and I<must not> end in a slash. If it is	2616	The path I<must not> end in a slash or contain special components such as
		2617	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1680	relative and your working directory changes, the behaviour is undefined.	2618	your working directory changes, then the behaviour is undefined.
1681		2619
1682	Since there is no standard to do this, the portable implementation simply	2620	Since there is no portable change notification interface available, the
1683	calls C<stat (2)> regularly on the path to see if it changed somehow. You	2621	portable implementation simply calls C<stat(2)> regularly on the path
1684	can specify a recommended polling interval for this case. If you specify	2622	to see if it changed somehow. You can specify a recommended polling
1685	a polling interval of C<0> (highly recommended!) then a I<suitable,	2623	interval for this case. If you specify a polling interval of C<0> (highly
1686	unspecified default> value will be used (which you can expect to be around	2624	recommended!) then a I<suitable, unspecified default> value will be used
1687	five seconds, although this might change dynamically). Libev will also	2625	(which you can expect to be around five seconds, although this might
1688	impose a minimum interval which is currently around C<0.1>, but thats	2626	change dynamically). Libev will also impose a minimum interval which is
1689	usually overkill.	2627	currently around C<0.1>, but that's usually overkill.
1690		2628
1691	This watcher type is not meant for massive numbers of stat watchers,	2629	This watcher type is not meant for massive numbers of stat watchers,
1692	as even with OS-supported change notifications, this can be	2630	as even with OS-supported change notifications, this can be
1693	resource-intensive.	2631	resource-intensive.
1694		2632
1695	At the time of this writing, only the Linux inotify interface is	2633	At the time of this writing, the only OS-specific interface implemented
1696	implemented (implementing kqueue support is left as an exercise for the	2634	is the Linux inotify interface (implementing kqueue support is left as an
1697	reader, note, however, that the author sees no way of implementing ev_stat	2635	exercise for the reader. Note, however, that the author sees no way of
1698	semantics with kqueue). Inotify will be used to give hints only and should	2636	implementing C<ev_stat> semantics with kqueue, except as a hint).
1699	not change the semantics of C<ev_stat> watchers, which means that libev
1700	sometimes needs to fall back to regular polling again even with inotify,
1701	but changes are usually detected immediately, and if the file exists there
1702	will be no polling.
1703		2637
1704	=head3 ABI Issues (Largefile Support)	2638	=head3 ABI Issues (Largefile Support)
1705		2639
1706	Libev by default (unless the user overrides this) uses the default	2640	Libev by default (unless the user overrides this) uses the default
1707	compilation environment, which means that on systems with large file	2641	compilation environment, which means that on systems with large file
1708	support disabled by default, you get the 32 bit version of the stat	2642	support disabled by default, you get the 32 bit version of the stat
1709	structure. When using the library from programs that change the ABI to	2643	structure. When using the library from programs that change the ABI to
1710	use 64 bit file offsets the programs will fail. In that case you have to	2644	use 64 bit file offsets the programs will fail. In that case you have to
1711	compile libev with the same flags to get binary compatibility. This is	2645	compile libev with the same flags to get binary compatibility. This is
1712	obviously the case with any flags that change the ABI, but the problem is	2646	obviously the case with any flags that change the ABI, but the problem is
1713	most noticeably disabled with ev_stat and large file support.	2647	most noticeably displayed with ev_stat and large file support.
1714		2648
1715	The solution for this is to lobby your distribution maker to make large	2649	The solution for this is to lobby your distribution maker to make large
1716	file interfaces available by default (as e.g. FreeBSD does) and not	2650	file interfaces available by default (as e.g. FreeBSD does) and not
1717	optional. Libev cannot simply switch on large file support because it has	2651	optional. Libev cannot simply switch on large file support because it has
1718	to exchange stat structures with application programs compiled using the	2652	to exchange stat structures with application programs compiled using the
1719	default compilation environment.	2653	default compilation environment.
1720		2654
1721	=head3 Inotify	2655	=head3 Inotify and Kqueue
1722		2656
1723	When C<inotify (7)> support has been compiled into libev (generally only	2657	When C<inotify (7)> support has been compiled into libev and present at
1724	available on Linux) and present at runtime, it will be used to speed up	2658	runtime, it will be used to speed up change detection where possible. The
1725	change detection where possible. The inotify descriptor will be created lazily	2659	inotify descriptor will be created lazily when the first C<ev_stat>
1726	when the first C<ev_stat> watcher is being started.	2660	watcher is being started.
1727		2661
1728	Inotify presence does not change the semantics of C<ev_stat> watchers	2662	Inotify presence does not change the semantics of C<ev_stat> watchers
1729	except that changes might be detected earlier, and in some cases, to avoid	2663	except that changes might be detected earlier, and in some cases, to avoid
1730	making regular C<stat> calls. Even in the presence of inotify support	2664	making regular C<stat> calls. Even in the presence of inotify support
1731	there are many cases where libev has to resort to regular C<stat> polling.	2665	there are many cases where libev has to resort to regular C<stat> polling,
		2666	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2667	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2668	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2669	xfs are fully working) libev usually gets away without polling.
1732		2670
1733	(There is no support for kqueue, as apparently it cannot be used to	2671	There is no support for kqueue, as apparently it cannot be used to
1734	implement this functionality, due to the requirement of having a file	2672	implement this functionality, due to the requirement of having a file
1735	descriptor open on the object at all times).	2673	descriptor open on the object at all times, and detecting renames, unlinks
		2674	etc. is difficult.
		2675
		2676	=head3 C<stat ()> is a synchronous operation
		2677
		2678	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2679	the process. The exception are C<ev_stat> watchers - those call C<stat
		2680	()>, which is a synchronous operation.
		2681
		2682	For local paths, this usually doesn't matter: unless the system is very
		2683	busy or the intervals between stat's are large, a stat call will be fast,
		2684	as the path data is usually in memory already (except when starting the
		2685	watcher).
		2686
		2687	For networked file systems, calling C<stat ()> can block an indefinite
		2688	time due to network issues, and even under good conditions, a stat call
		2689	often takes multiple milliseconds.
		2690
		2691	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2692	paths, although this is fully supported by libev.
1736		2693
1737	=head3 The special problem of stat time resolution	2694	=head3 The special problem of stat time resolution
1738		2695
1739	The C<stat ()> system call only supports full-second resolution portably, and	2696	The C<stat ()> system call only supports full-second resolution portably,
1740	even on systems where the resolution is higher, many file systems still	2697	and even on systems where the resolution is higher, most file systems
1741	only support whole seconds.	2698	still only support whole seconds.
1742		2699
1743	That means that, if the time is the only thing that changes, you can	2700	That means that, if the time is the only thing that changes, you can
1744	easily miss updates: on the first update, C<ev_stat> detects a change and	2701	easily miss updates: on the first update, C<ev_stat> detects a change and
1745	calls your callback, which does something. When there is another update	2702	calls your callback, which does something. When there is another update
1746	within the same second, C<ev_stat> will be unable to detect it as the stat	2703	within the same second, C<ev_stat> will be unable to detect unless the
1747	data does not change.	2704	stat data does change in other ways (e.g. file size).
1748		2705
1749	The solution to this is to delay acting on a change for slightly more	2706	The solution to this is to delay acting on a change for slightly more
1750	than a second (or till slightly after the next full second boundary), using	2707	than a second (or till slightly after the next full second boundary), using
1751	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);	2708	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1752	ev_timer_again (loop, w)>).	2709	ev_timer_again (loop, w)>).
…		…
1772	C<path>. The C<interval> is a hint on how quickly a change is expected to	2729	C<path>. The C<interval> is a hint on how quickly a change is expected to
1773	be detected and should normally be specified as C<0> to let libev choose	2730	be detected and should normally be specified as C<0> to let libev choose
1774	a suitable value. The memory pointed to by C<path> must point to the same	2731	a suitable value. The memory pointed to by C<path> must point to the same
1775	path for as long as the watcher is active.	2732	path for as long as the watcher is active.
1776		2733
1777	The callback will receive C<EV_STAT> when a change was detected, relative	2734	The callback will receive an C<EV_STAT> event when a change was detected,
1778	to the attributes at the time the watcher was started (or the last change	2735	relative to the attributes at the time the watcher was started (or the
1779	was detected).	2736	last change was detected).
1780		2737
1781	=item ev_stat_stat (loop, ev_stat *)	2738	=item ev_stat_stat (loop, ev_stat *)
1782		2739
1783	Updates the stat buffer immediately with new values. If you change the	2740	Updates the stat buffer immediately with new values. If you change the
1784	watched path in your callback, you could call this function to avoid	2741	watched path in your callback, you could call this function to avoid
…		…
1867		2824
1868		2825
1869	=head2 C<ev_idle> - when you've got nothing better to do...	2826	=head2 C<ev_idle> - when you've got nothing better to do...
1870		2827
1871	Idle watchers trigger events when no other events of the same or higher	2828	Idle watchers trigger events when no other events of the same or higher
1872	priority are pending (prepare, check and other idle watchers do not	2829	priority are pending (prepare, check and other idle watchers do not count
1873	count).	2830	as receiving "events").
1874		2831
1875	That is, as long as your process is busy handling sockets or timeouts	2832	That is, as long as your process is busy handling sockets or timeouts
1876	(or even signals, imagine) of the same or higher priority it will not be	2833	(or even signals, imagine) of the same or higher priority it will not be
1877	triggered. But when your process is idle (or only lower-priority watchers	2834	triggered. But when your process is idle (or only lower-priority watchers
1878	are pending), the idle watchers are being called once per event loop	2835	are pending), the idle watchers are being called once per event loop
…		…
1889		2846
1890	=head3 Watcher-Specific Functions and Data Members	2847	=head3 Watcher-Specific Functions and Data Members
1891		2848
1892	=over 4	2849	=over 4
1893		2850
1894	=item ev_idle_init (ev_signal *, callback)	2851	=item ev_idle_init (ev_idle *, callback)
1895		2852
1896	Initialises and configures the idle watcher - it has no parameters of any	2853	Initialises and configures the idle watcher - it has no parameters of any
1897	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2854	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1898	believe me.	2855	believe me.
1899		2856
…		…
1903		2860
1904	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2861	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1905	callback, free it. Also, use no error checking, as usual.	2862	callback, free it. Also, use no error checking, as usual.
1906		2863
1907	static void	2864	static void
1908	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2865	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1909	{	2866	{
1910	free (w);	2867	free (w);
1911	// now do something you wanted to do when the program has	2868	// now do something you wanted to do when the program has
1912	// no longer anything immediate to do.	2869	// no longer anything immediate to do.
1913	}	2870	}
1914		2871
1915	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2872	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1916	ev_idle_init (idle_watcher, idle_cb);	2873	ev_idle_init (idle_watcher, idle_cb);
1917	ev_idle_start (loop, idle_cb);	2874	ev_idle_start (loop, idle_watcher);
1918		2875
1919		2876
1920	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2877	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1921		2878
1922	Prepare and check watchers are usually (but not always) used in tandem:	2879	Prepare and check watchers are usually (but not always) used in pairs:
1923	prepare watchers get invoked before the process blocks and check watchers	2880	prepare watchers get invoked before the process blocks and check watchers
1924	afterwards.	2881	afterwards.
1925		2882
1926	You I<must not> call C<ev_loop> or similar functions that enter	2883	You I<must not> call C<ev_run> or similar functions that enter
1927	the current event loop from either C<ev_prepare> or C<ev_check>	2884	the current event loop from either C<ev_prepare> or C<ev_check>
1928	watchers. Other loops than the current one are fine, however. The	2885	watchers. Other loops than the current one are fine, however. The
1929	rationale behind this is that you do not need to check for recursion in	2886	rationale behind this is that you do not need to check for recursion in
1930	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2887	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1931	C<ev_check> so if you have one watcher of each kind they will always be	2888	C<ev_check> so if you have one watcher of each kind they will always be
1932	called in pairs bracketing the blocking call.	2889	called in pairs bracketing the blocking call.
1933		2890
1934	Their main purpose is to integrate other event mechanisms into libev and	2891	Their main purpose is to integrate other event mechanisms into libev and
1935	their use is somewhat advanced. This could be used, for example, to track	2892	their use is somewhat advanced. They could be used, for example, to track
1936	variable changes, implement your own watchers, integrate net-snmp or a	2893	variable changes, implement your own watchers, integrate net-snmp or a
1937	coroutine library and lots more. They are also occasionally useful if	2894	coroutine library and lots more. They are also occasionally useful if
1938	you cache some data and want to flush it before blocking (for example,	2895	you cache some data and want to flush it before blocking (for example,
1939	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>	2896	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1940	watcher).	2897	watcher).
1941		2898
1942	This is done by examining in each prepare call which file descriptors need	2899	This is done by examining in each prepare call which file descriptors
1943	to be watched by the other library, registering C<ev_io> watchers for	2900	need to be watched by the other library, registering C<ev_io> watchers
1944	them and starting an C<ev_timer> watcher for any timeouts (many libraries	2901	for them and starting an C<ev_timer> watcher for any timeouts (many
1945	provide just this functionality). Then, in the check watcher you check for	2902	libraries provide exactly this functionality). Then, in the check watcher,
1946	any events that occurred (by checking the pending status of all watchers	2903	you check for any events that occurred (by checking the pending status
1947	and stopping them) and call back into the library. The I/O and timer	2904	of all watchers and stopping them) and call back into the library. The
1948	callbacks will never actually be called (but must be valid nevertheless,	2905	I/O and timer callbacks will never actually be called (but must be valid
1949	because you never know, you know?).	2906	nevertheless, because you never know, you know?).
1950		2907
1951	As another example, the Perl Coro module uses these hooks to integrate	2908	As another example, the Perl Coro module uses these hooks to integrate
1952	coroutines into libev programs, by yielding to other active coroutines	2909	coroutines into libev programs, by yielding to other active coroutines
1953	during each prepare and only letting the process block if no coroutines	2910	during each prepare and only letting the process block if no coroutines
1954	are ready to run (it's actually more complicated: it only runs coroutines	2911	are ready to run (it's actually more complicated: it only runs coroutines
…		…
1957	loop from blocking if lower-priority coroutines are active, thus mapping	2914	loop from blocking if lower-priority coroutines are active, thus mapping
1958	low-priority coroutines to idle/background tasks).	2915	low-priority coroutines to idle/background tasks).
1959		2916
1960	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2917	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1961	priority, to ensure that they are being run before any other watchers	2918	priority, to ensure that they are being run before any other watchers
		2919	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2920
1962	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2921	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1963	too) should not activate ("feed") events into libev. While libev fully	2922	activate ("feed") events into libev. While libev fully supports this, they
1964	supports this, they might get executed before other C<ev_check> watchers	2923	might get executed before other C<ev_check> watchers did their job. As
1965	did their job. As C<ev_check> watchers are often used to embed other	2924	C<ev_check> watchers are often used to embed other (non-libev) event
1966	(non-libev) event loops those other event loops might be in an unusable	2925	loops those other event loops might be in an unusable state until their
1967	state until their C<ev_check> watcher ran (always remind yourself to	2926	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1968	coexist peacefully with others).	2927	others).
1969		2928
1970	=head3 Watcher-Specific Functions and Data Members	2929	=head3 Watcher-Specific Functions and Data Members
1971		2930
1972	=over 4	2931	=over 4
1973		2932
…		…
1975		2934
1976	=item ev_check_init (ev_check *, callback)	2935	=item ev_check_init (ev_check *, callback)
1977		2936
1978	Initialises and configures the prepare or check watcher - they have no	2937	Initialises and configures the prepare or check watcher - they have no
1979	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	2938	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1980	macros, but using them is utterly, utterly and completely pointless.	2939	macros, but using them is utterly, utterly, utterly and completely
		2940	pointless.
1981		2941
1982	=back	2942	=back
1983		2943
1984	=head3 Examples	2944	=head3 Examples
1985		2945
…		…
1998		2958
1999	static ev_io iow [nfd];	2959	static ev_io iow [nfd];
2000	static ev_timer tw;	2960	static ev_timer tw;
2001		2961
2002	static void	2962	static void
2003	io_cb (ev_loop *loop, ev_io *w, int revents)	2963	io_cb (struct ev_loop *loop, ev_io *w, int revents)
2004	{	2964	{
2005	}	2965	}
2006		2966
2007	// create io watchers for each fd and a timer before blocking	2967	// create io watchers for each fd and a timer before blocking
2008	static void	2968	static void
2009	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2969	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
2010	{	2970	{
2011	int timeout = 3600000;	2971	int timeout = 3600000;
2012	struct pollfd fds [nfd];	2972	struct pollfd fds [nfd];
2013	// actual code will need to loop here and realloc etc.	2973	// actual code will need to loop here and realloc etc.
2014	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2974	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2015		2975
2016	/* the callback is illegal, but won't be called as we stop during check */	2976	/* the callback is illegal, but won't be called as we stop during check */
2017	ev_timer_init (&tw, 0, timeout * 1e-3);	2977	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2018	ev_timer_start (loop, &tw);	2978	ev_timer_start (loop, &tw);
2019		2979
2020	// create one ev_io per pollfd	2980	// create one ev_io per pollfd
2021	for (int i = 0; i < nfd; ++i)	2981	for (int i = 0; i < nfd; ++i)
2022	{	2982	{
…		…
2029	}	2989	}
2030	}	2990	}
2031		2991
2032	// stop all watchers after blocking	2992	// stop all watchers after blocking
2033	static void	2993	static void
2034	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2994	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
2035	{	2995	{
2036	ev_timer_stop (loop, &tw);	2996	ev_timer_stop (loop, &tw);
2037		2997
2038	for (int i = 0; i < nfd; ++i)	2998	for (int i = 0; i < nfd; ++i)
2039	{	2999	{
…		…
2078	}	3038	}
2079		3039
2080	// do not ever call adns_afterpoll	3040	// do not ever call adns_afterpoll
2081		3041
2082	Method 4: Do not use a prepare or check watcher because the module you	3042	Method 4: Do not use a prepare or check watcher because the module you
2083	want to embed is too inflexible to support it. Instead, you can override	3043	want to embed is not flexible enough to support it. Instead, you can
2084	their poll function. The drawback with this solution is that the main	3044	override their poll function. The drawback with this solution is that the
2085	loop is now no longer controllable by EV. The C<Glib::EV> module does	3045	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
2086	this.	3046	this approach, effectively embedding EV as a client into the horrible
		3047	libglib event loop.
2087		3048
2088	static gint	3049	static gint
2089	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	3050	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2090	{	3051	{
2091	int got_events = 0;	3052	int got_events = 0;
…		…
2095		3056
2096	if (timeout >= 0)	3057	if (timeout >= 0)
2097	// create/start timer	3058	// create/start timer
2098		3059
2099	// poll	3060	// poll
2100	ev_loop (EV_A_ 0);	3061	ev_run (EV_A_ 0);
2101		3062
2102	// stop timer again	3063	// stop timer again
2103	if (timeout >= 0)	3064	if (timeout >= 0)
2104	ev_timer_stop (EV_A_ &to);	3065	ev_timer_stop (EV_A_ &to);
2105		3066
…		…
2122	prioritise I/O.	3083	prioritise I/O.
2123		3084
2124	As an example for a bug workaround, the kqueue backend might only support	3085	As an example for a bug workaround, the kqueue backend might only support
2125	sockets on some platform, so it is unusable as generic backend, but you	3086	sockets on some platform, so it is unusable as generic backend, but you
2126	still want to make use of it because you have many sockets and it scales	3087	still want to make use of it because you have many sockets and it scales
2127	so nicely. In this case, you would create a kqueue-based loop and embed it	3088	so nicely. In this case, you would create a kqueue-based loop and embed
2128	into your default loop (which might use e.g. poll). Overall operation will	3089	it into your default loop (which might use e.g. poll). Overall operation
2129	be a bit slower because first libev has to poll and then call kevent, but	3090	will be a bit slower because first libev has to call C<poll> and then
2130	at least you can use both at what they are best.	3091	C<kevent>, but at least you can use both mechanisms for what they are
		3092	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
2131		3093
2132	As for prioritising I/O: rarely you have the case where some fds have	3094	As for prioritising I/O: under rare circumstances you have the case where
2133	to be watched and handled very quickly (with low latency), and even	3095	some fds have to be watched and handled very quickly (with low latency),
2134	priorities and idle watchers might have too much overhead. In this case	3096	and even priorities and idle watchers might have too much overhead. In
2135	you would put all the high priority stuff in one loop and all the rest in	3097	this case you would put all the high priority stuff in one loop and all
2136	a second one, and embed the second one in the first.	3098	the rest in a second one, and embed the second one in the first.
2137		3099
2138	As long as the watcher is active, the callback will be invoked every time	3100	As long as the watcher is active, the callback will be invoked every
2139	there might be events pending in the embedded loop. The callback must then	3101	time there might be events pending in the embedded loop. The callback
2140	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	3102	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2141	their callbacks (you could also start an idle watcher to give the embedded	3103	sweep and invoke their callbacks (the callback doesn't need to invoke the
2142	loop strictly lower priority for example). You can also set the callback	3104	C<ev_embed_sweep> function directly, it could also start an idle watcher
2143	to C<0>, in which case the embed watcher will automatically execute the	3105	to give the embedded loop strictly lower priority for example).
2144	embedded loop sweep.
2145		3106
2146	As long as the watcher is started it will automatically handle events. The	3107	You can also set the callback to C<0>, in which case the embed watcher
2147	callback will be invoked whenever some events have been handled. You can	3108	will automatically execute the embedded loop sweep whenever necessary.
2148	set the callback to C<0> to avoid having to specify one if you are not
2149	interested in that.
2150		3109
2151	Also, there have not currently been made special provisions for forking:	3110	Fork detection will be handled transparently while the C<ev_embed> watcher
2152	when you fork, you not only have to call C<ev_loop_fork> on both loops,	3111	is active, i.e., the embedded loop will automatically be forked when the
2153	but you will also have to stop and restart any C<ev_embed> watchers	3112	embedding loop forks. In other cases, the user is responsible for calling
2154	yourself.	3113	C<ev_loop_fork> on the embedded loop.
2155		3114
2156	Unfortunately, not all backends are embeddable, only the ones returned by	3115	Unfortunately, not all backends are embeddable: only the ones returned by
2157	C<ev_embeddable_backends> are, which, unfortunately, does not include any	3116	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2158	portable one.	3117	portable one.
2159		3118
2160	So when you want to use this feature you will always have to be prepared	3119	So when you want to use this feature you will always have to be prepared
2161	that you cannot get an embeddable loop. The recommended way to get around	3120	that you cannot get an embeddable loop. The recommended way to get around
2162	this is to have a separate variables for your embeddable loop, try to	3121	this is to have a separate variables for your embeddable loop, try to
2163	create it, and if that fails, use the normal loop for everything.	3122	create it, and if that fails, use the normal loop for everything.
		3123
		3124	=head3 C<ev_embed> and fork
		3125
		3126	While the C<ev_embed> watcher is running, forks in the embedding loop will
		3127	automatically be applied to the embedded loop as well, so no special
		3128	fork handling is required in that case. When the watcher is not running,
		3129	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		3130	as applicable.
2164		3131
2165	=head3 Watcher-Specific Functions and Data Members	3132	=head3 Watcher-Specific Functions and Data Members
2166		3133
2167	=over 4	3134	=over 4
2168		3135
…		…
2177	if you do not want that, you need to temporarily stop the embed watcher).	3144	if you do not want that, you need to temporarily stop the embed watcher).
2178		3145
2179	=item ev_embed_sweep (loop, ev_embed *)	3146	=item ev_embed_sweep (loop, ev_embed *)
2180		3147
2181	Make a single, non-blocking sweep over the embedded loop. This works	3148	Make a single, non-blocking sweep over the embedded loop. This works
2182	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3149	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2183	appropriate way for embedded loops.	3150	appropriate way for embedded loops.
2184		3151
2185	=item struct ev_loop *other [read-only]	3152	=item struct ev_loop *other [read-only]
2186		3153
2187	The embedded event loop.	3154	The embedded event loop.
…		…
2196	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be	3163	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2197	used).	3164	used).
2198		3165
2199	struct ev_loop *loop_hi = ev_default_init (0);	3166	struct ev_loop *loop_hi = ev_default_init (0);
2200	struct ev_loop *loop_lo = 0;	3167	struct ev_loop *loop_lo = 0;
2201	struct ev_embed embed;	3168	ev_embed embed;
2202		3169
2203	// see if there is a chance of getting one that works	3170	// see if there is a chance of getting one that works
2204	// (remember that a flags value of 0 means autodetection)	3171	// (remember that a flags value of 0 means autodetection)
2205	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	3172	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2206	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	3173	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
…		…
2220	kqueue implementation). Store the kqueue/socket-only event loop in	3187	kqueue implementation). Store the kqueue/socket-only event loop in
2221	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	3188	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2222		3189
2223	struct ev_loop *loop = ev_default_init (0);	3190	struct ev_loop *loop = ev_default_init (0);
2224	struct ev_loop *loop_socket = 0;	3191	struct ev_loop *loop_socket = 0;
2225	struct ev_embed embed;	3192	ev_embed embed;
2226		3193
2227	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	3194	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2228	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	3195	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2229	{	3196	{
2230	ev_embed_init (&embed, 0, loop_socket);	3197	ev_embed_init (&embed, 0, loop_socket);
…		…
2245	event loop blocks next and before C<ev_check> watchers are being called,	3212	event loop blocks next and before C<ev_check> watchers are being called,
2246	and only in the child after the fork. If whoever good citizen calling	3213	and only in the child after the fork. If whoever good citizen calling
2247	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3214	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2248	handlers will be invoked, too, of course.	3215	handlers will be invoked, too, of course.
2249		3216
		3217	=head3 The special problem of life after fork - how is it possible?
		3218
		3219	Most uses of C<fork()> consist of forking, then some simple calls to set
		3220	up/change the process environment, followed by a call to C<exec()>. This
		3221	sequence should be handled by libev without any problems.
		3222
		3223	This changes when the application actually wants to do event handling
		3224	in the child, or both parent in child, in effect "continuing" after the
		3225	fork.
		3226
		3227	The default mode of operation (for libev, with application help to detect
		3228	forks) is to duplicate all the state in the child, as would be expected
		3229	when I<either> the parent I<or> the child process continues.
		3230
		3231	When both processes want to continue using libev, then this is usually the
		3232	wrong result. In that case, usually one process (typically the parent) is
		3233	supposed to continue with all watchers in place as before, while the other
		3234	process typically wants to start fresh, i.e. without any active watchers.
		3235
		3236	The cleanest and most efficient way to achieve that with libev is to
		3237	simply create a new event loop, which of course will be "empty", and
		3238	use that for new watchers. This has the advantage of not touching more
		3239	memory than necessary, and thus avoiding the copy-on-write, and the
		3240	disadvantage of having to use multiple event loops (which do not support
		3241	signal watchers).
		3242
		3243	When this is not possible, or you want to use the default loop for
		3244	other reasons, then in the process that wants to start "fresh", call
		3245	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
		3246	Destroying the default loop will "orphan" (not stop) all registered
		3247	watchers, so you have to be careful not to execute code that modifies
		3248	those watchers. Note also that in that case, you have to re-register any
		3249	signal watchers.
		3250
2250	=head3 Watcher-Specific Functions and Data Members	3251	=head3 Watcher-Specific Functions and Data Members
2251		3252
2252	=over 4	3253	=over 4
2253		3254
2254	=item ev_fork_init (ev_signal *, callback)	3255	=item ev_fork_init (ev_fork *, callback)
2255		3256
2256	Initialises and configures the fork watcher - it has no parameters of any	3257	Initialises and configures the fork watcher - it has no parameters of any
2257	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3258	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2258	believe me.	3259	really.
2259		3260
2260	=back	3261	=back
2261		3262
2262		3263
		3264	=head2 C<ev_cleanup> - even the best things end
		3265
		3266	Cleanup watchers are called just before the event loop is being destroyed
		3267	by a call to C<ev_loop_destroy>.
		3268
		3269	While there is no guarantee that the event loop gets destroyed, cleanup
		3270	watchers provide a convenient method to install cleanup hooks for your
		3271	program, worker threads and so on - you just to make sure to destroy the
		3272	loop when you want them to be invoked.
		3273
		3274	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3275	all other watchers, they do not keep a reference to the event loop (which
		3276	makes a lot of sense if you think about it). Like all other watchers, you
		3277	can call libev functions in the callback, except C<ev_cleanup_start>.
		3278
		3279	=head3 Watcher-Specific Functions and Data Members
		3280
		3281	=over 4
		3282
		3283	=item ev_cleanup_init (ev_cleanup *, callback)
		3284
		3285	Initialises and configures the cleanup watcher - it has no parameters of
		3286	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3287	pointless, I assure you.
		3288
		3289	=back
		3290
		3291	Example: Register an atexit handler to destroy the default loop, so any
		3292	cleanup functions are called.
		3293
		3294	static void
		3295	program_exits (void)
		3296	{
		3297	ev_loop_destroy (EV_DEFAULT_UC);
		3298	}
		3299
		3300	...
		3301	atexit (program_exits);
		3302
		3303
2263	=head2 C<ev_async> - how to wake up another event loop	3304	=head2 C<ev_async> - how to wake up an event loop
2264		3305
2265	In general, you cannot use an C<ev_loop> from multiple threads or other	3306	In general, you cannot use an C<ev_loop> from multiple threads or other
2266	asynchronous sources such as signal handlers (as opposed to multiple event	3307	asynchronous sources such as signal handlers (as opposed to multiple event
2267	loops - those are of course safe to use in different threads).	3308	loops - those are of course safe to use in different threads).
2268		3309
2269	Sometimes, however, you need to wake up another event loop you do not	3310	Sometimes, however, you need to wake up an event loop you do not control,
2270	control, for example because it belongs to another thread. This is what	3311	for example because it belongs to another thread. This is what C<ev_async>
2271	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3312	watchers do: as long as the C<ev_async> watcher is active, you can signal
2272	can signal it by calling C<ev_async_send>, which is thread- and signal	3313	it by calling C<ev_async_send>, which is thread- and signal safe.
2273	safe.
2274		3314
2275	This functionality is very similar to C<ev_signal> watchers, as signals,	3315	This functionality is very similar to C<ev_signal> watchers, as signals,
2276	too, are asynchronous in nature, and signals, too, will be compressed	3316	too, are asynchronous in nature, and signals, too, will be compressed
2277	(i.e. the number of callback invocations may be less than the number of	3317	(i.e. the number of callback invocations may be less than the number of
2278	C<ev_async_sent> calls).	3318	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
2279		3319	of "global async watchers" by using a watcher on an otherwise unused
2280	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3320	signal, and C<ev_feed_signal> to signal this watcher from another thread,
2281	just the default loop.	3321	even without knowing which loop owns the signal.
2282		3322
2283	=head3 Queueing	3323	=head3 Queueing
2284		3324
2285	C<ev_async> does not support queueing of data in any way. The reason	3325	C<ev_async> does not support queueing of data in any way. The reason
2286	is that the author does not know of a simple (or any) algorithm for a	3326	is that the author does not know of a simple (or any) algorithm for a
2287	multiple-writer-single-reader queue that works in all cases and doesn't	3327	multiple-writer-single-reader queue that works in all cases and doesn't
2288	need elaborate support such as pthreads.	3328	need elaborate support such as pthreads or unportable memory access
		3329	semantics.
2289		3330
2290	That means that if you want to queue data, you have to provide your own	3331	That means that if you want to queue data, you have to provide your own
2291	queue. But at least I can tell you would implement locking around your	3332	queue. But at least I can tell you how to implement locking around your
2292	queue:	3333	queue:
2293		3334
2294	=over 4	3335	=over 4
2295		3336
2296	=item queueing from a signal handler context	3337	=item queueing from a signal handler context
2297		3338
2298	To implement race-free queueing, you simply add to the queue in the signal	3339	To implement race-free queueing, you simply add to the queue in the signal
2299	handler but you block the signal handler in the watcher callback. Here is an example that does that for	3340	handler but you block the signal handler in the watcher callback. Here is
2300	some fictitious SIGUSR1 handler:	3341	an example that does that for some fictitious SIGUSR1 handler:
2301		3342
2302	static ev_async mysig;	3343	static ev_async mysig;
2303		3344
2304	static void	3345	static void
2305	sigusr1_handler (void)	3346	sigusr1_handler (void)
…		…
2371	=over 4	3412	=over 4
2372		3413
2373	=item ev_async_init (ev_async *, callback)	3414	=item ev_async_init (ev_async *, callback)
2374		3415
2375	Initialises and configures the async watcher - it has no parameters of any	3416	Initialises and configures the async watcher - it has no parameters of any
2376	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	3417	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2377	believe me.	3418	trust me.
2378		3419
2379	=item ev_async_send (loop, ev_async *)	3420	=item ev_async_send (loop, ev_async *)
2380		3421
2381	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3422	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2382	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3423	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3424	returns.
		3425
2383	C<ev_feed_event>, this call is safe to do in other threads, signal or	3426	Unlike C<ev_feed_event>, this call is safe to do from other threads,
2384	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3427	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
2385	section below on what exactly this means).	3428	embedding section below on what exactly this means).
2386		3429
2387	This call incurs the overhead of a system call only once per loop iteration,	3430	Note that, as with other watchers in libev, multiple events might get
2388	so while the overhead might be noticeable, it doesn't apply to repeated	3431	compressed into a single callback invocation (another way to look at
2389	calls to C<ev_async_send>.	3432	this is that C<ev_async> watchers are level-triggered: they are set on
		3433	C<ev_async_send>, reset when the event loop detects that).
		3434
		3435	This call incurs the overhead of at most one extra system call per event
		3436	loop iteration, if the event loop is blocked, and no syscall at all if
		3437	the event loop (or your program) is processing events. That means that
		3438	repeated calls are basically free (there is no need to avoid calls for
		3439	performance reasons) and that the overhead becomes smaller (typically
		3440	zero) under load.
2390		3441
2391	=item bool = ev_async_pending (ev_async *)	3442	=item bool = ev_async_pending (ev_async *)
2392		3443
2393	Returns a non-zero value when C<ev_async_send> has been called on the	3444	Returns a non-zero value when C<ev_async_send> has been called on the
2394	watcher but the event has not yet been processed (or even noted) by the	3445	watcher but the event has not yet been processed (or even noted) by the
…		…
2397	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	3448	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2398	the loop iterates next and checks for the watcher to have become active,	3449	the loop iterates next and checks for the watcher to have become active,
2399	it will reset the flag again. C<ev_async_pending> can be used to very	3450	it will reset the flag again. C<ev_async_pending> can be used to very
2400	quickly check whether invoking the loop might be a good idea.	3451	quickly check whether invoking the loop might be a good idea.
2401		3452
2402	Not that this does I<not> check whether the watcher itself is pending, only	3453	Not that this does I<not> check whether the watcher itself is pending,
2403	whether it has been requested to make this watcher pending.	3454	only whether it has been requested to make this watcher pending: there
		3455	is a time window between the event loop checking and resetting the async
		3456	notification, and the callback being invoked.
2404		3457
2405	=back	3458	=back
2406		3459
2407		3460
2408	=head1 OTHER FUNCTIONS	3461	=head1 OTHER FUNCTIONS
…		…
2412	=over 4	3465	=over 4
2413		3466
2414	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	3467	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2415		3468
2416	This function combines a simple timer and an I/O watcher, calls your	3469	This function combines a simple timer and an I/O watcher, calls your
2417	callback on whichever event happens first and automatically stop both	3470	callback on whichever event happens first and automatically stops both
2418	watchers. This is useful if you want to wait for a single event on an fd	3471	watchers. This is useful if you want to wait for a single event on an fd
2419	or timeout without having to allocate/configure/start/stop/free one or	3472	or timeout without having to allocate/configure/start/stop/free one or
2420	more watchers yourself.	3473	more watchers yourself.
2421		3474
2422	If C<fd> is less than 0, then no I/O watcher will be started and events	3475	If C<fd> is less than 0, then no I/O watcher will be started and the
2423	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	3476	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2424	C<events> set will be created and started.	3477	the given C<fd> and C<events> set will be created and started.
2425		3478
2426	If C<timeout> is less than 0, then no timeout watcher will be	3479	If C<timeout> is less than 0, then no timeout watcher will be
2427	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3480	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2428	repeat = 0) will be started. While C<0> is a valid timeout, it is of	3481	repeat = 0) will be started. C<0> is a valid timeout.
2429	dubious value.
2430		3482
2431	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3483	The callback has the type C<void (*cb)(int revents, void *arg)> and is
2432	passed an C<revents> set like normal event callbacks (a combination of	3484	passed an C<revents> set like normal event callbacks (a combination of
2433	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3485	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
2434	value passed to C<ev_once>:	3486	value passed to C<ev_once>. Note that it is possible to receive I<both>
		3487	a timeout and an io event at the same time - you probably should give io
		3488	events precedence.
		3489
		3490	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2435		3491
2436	static void stdin_ready (int revents, void *arg)	3492	static void stdin_ready (int revents, void *arg)
2437	{	3493	{
		3494	if (revents & EV_READ)
		3495	/* stdin might have data for us, joy! */;
2438	if (revents & EV_TIMEOUT)	3496	else if (revents & EV_TIMER)
2439	/* doh, nothing entered */;	3497	/* doh, nothing entered */;
2440	else if (revents & EV_READ)
2441	/* stdin might have data for us, joy! */;
2442	}	3498	}
2443		3499
2444	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3500	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2445		3501
2446	=item ev_feed_event (ev_loop *, watcher *, int revents)
2447
2448	Feeds the given event set into the event loop, as if the specified event
2449	had happened for the specified watcher (which must be a pointer to an
2450	initialised but not necessarily started event watcher).
2451
2452	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	3502	=item ev_feed_fd_event (loop, int fd, int revents)
2453		3503
2454	Feed an event on the given fd, as if a file descriptor backend detected	3504	Feed an event on the given fd, as if a file descriptor backend detected
2455	the given events it.	3505	the given events.
2456		3506
2457	=item ev_feed_signal_event (ev_loop *loop, int signum)	3507	=item ev_feed_signal_event (loop, int signum)
2458		3508
2459	Feed an event as if the given signal occurred (C<loop> must be the default	3509	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
2460	loop!).	3510	which is async-safe.
2461		3511
2462	=back	3512	=back
		3513
		3514
		3515	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3516
		3517	This section explains some common idioms that are not immediately
		3518	obvious. Note that examples are sprinkled over the whole manual, and this
		3519	section only contains stuff that wouldn't fit anywhere else.
		3520
		3521	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3522
		3523	Each watcher has, by default, a C<void *data> member that you can read
		3524	or modify at any time: libev will completely ignore it. This can be used
		3525	to associate arbitrary data with your watcher. If you need more data and
		3526	don't want to allocate memory separately and store a pointer to it in that
		3527	data member, you can also "subclass" the watcher type and provide your own
		3528	data:
		3529
		3530	struct my_io
		3531	{
		3532	ev_io io;
		3533	int otherfd;
		3534	void *somedata;
		3535	struct whatever *mostinteresting;
		3536	};
		3537
		3538	...
		3539	struct my_io w;
		3540	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3541
		3542	And since your callback will be called with a pointer to the watcher, you
		3543	can cast it back to your own type:
		3544
		3545	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3546	{
		3547	struct my_io *w = (struct my_io *)w_;
		3548	...
		3549	}
		3550
		3551	More interesting and less C-conformant ways of casting your callback
		3552	function type instead have been omitted.
		3553
		3554	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3555
		3556	Another common scenario is to use some data structure with multiple
		3557	embedded watchers, in effect creating your own watcher that combines
		3558	multiple libev event sources into one "super-watcher":
		3559
		3560	struct my_biggy
		3561	{
		3562	int some_data;
		3563	ev_timer t1;
		3564	ev_timer t2;
		3565	}
		3566
		3567	In this case getting the pointer to C<my_biggy> is a bit more
		3568	complicated: Either you store the address of your C<my_biggy> struct in
		3569	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3570	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3571	real programmers):
		3572
		3573	#include <stddef.h>
		3574
		3575	static void
		3576	t1_cb (EV_P_ ev_timer *w, int revents)
		3577	{
		3578	struct my_biggy big = (struct my_biggy *)
		3579	(((char *)w) - offsetof (struct my_biggy, t1));
		3580	}
		3581
		3582	static void
		3583	t2_cb (EV_P_ ev_timer *w, int revents)
		3584	{
		3585	struct my_biggy big = (struct my_biggy *)
		3586	(((char *)w) - offsetof (struct my_biggy, t2));
		3587	}
		3588
		3589	=head2 AVOIDING FINISHING BEFORE RETURNING
		3590
		3591	Often you have structures like this in event-based programs:
		3592
		3593	callback ()
		3594	{
		3595	free (request);
		3596	}
		3597
		3598	request = start_new_request (..., callback);
		3599
		3600	The intent is to start some "lengthy" operation. The C<request> could be
		3601	used to cancel the operation, or do other things with it.
		3602
		3603	It's not uncommon to have code paths in C<start_new_request> that
		3604	immediately invoke the callback, for example, to report errors. Or you add
		3605	some caching layer that finds that it can skip the lengthy aspects of the
		3606	operation and simply invoke the callback with the result.
		3607
		3608	The problem here is that this will happen I<before> C<start_new_request>
		3609	has returned, so C<request> is not set.
		3610
		3611	Even if you pass the request by some safer means to the callback, you
		3612	might want to do something to the request after starting it, such as
		3613	canceling it, which probably isn't working so well when the callback has
		3614	already been invoked.
		3615
		3616	A common way around all these issues is to make sure that
		3617	C<start_new_request> I<always> returns before the callback is invoked. If
		3618	C<start_new_request> immediately knows the result, it can artificially
		3619	delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher
		3620	for example, or more sneakily, by reusing an existing (stopped) watcher
		3621	and pushing it into the pending queue:
		3622
		3623	ev_set_cb (watcher, callback);
		3624	ev_feed_event (EV_A_ watcher, 0);
		3625
		3626	This way, C<start_new_request> can safely return before the callback is
		3627	invoked, while not delaying callback invocation too much.
		3628
		3629	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3630
		3631	Often (especially in GUI toolkits) there are places where you have
		3632	I<modal> interaction, which is most easily implemented by recursively
		3633	invoking C<ev_run>.
		3634
		3635	This brings the problem of exiting - a callback might want to finish the
		3636	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3637	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3638	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3639	other combination: In these cases, C<ev_break> will not work alone.
		3640
		3641	The solution is to maintain "break this loop" variable for each C<ev_run>
		3642	invocation, and use a loop around C<ev_run> until the condition is
		3643	triggered, using C<EVRUN_ONCE>:
		3644
		3645	// main loop
		3646	int exit_main_loop = 0;
		3647
		3648	while (!exit_main_loop)
		3649	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3650
		3651	// in a modal watcher
		3652	int exit_nested_loop = 0;
		3653
		3654	while (!exit_nested_loop)
		3655	ev_run (EV_A_ EVRUN_ONCE);
		3656
		3657	To exit from any of these loops, just set the corresponding exit variable:
		3658
		3659	// exit modal loop
		3660	exit_nested_loop = 1;
		3661
		3662	// exit main program, after modal loop is finished
		3663	exit_main_loop = 1;
		3664
		3665	// exit both
		3666	exit_main_loop = exit_nested_loop = 1;
		3667
		3668	=head2 THREAD LOCKING EXAMPLE
		3669
		3670	Here is a fictitious example of how to run an event loop in a different
		3671	thread from where callbacks are being invoked and watchers are
		3672	created/added/removed.
		3673
		3674	For a real-world example, see the C<EV::Loop::Async> perl module,
		3675	which uses exactly this technique (which is suited for many high-level
		3676	languages).
		3677
		3678	The example uses a pthread mutex to protect the loop data, a condition
		3679	variable to wait for callback invocations, an async watcher to notify the
		3680	event loop thread and an unspecified mechanism to wake up the main thread.
		3681
		3682	First, you need to associate some data with the event loop:
		3683
		3684	typedef struct {
		3685	mutex_t lock; /* global loop lock */
		3686	ev_async async_w;
		3687	thread_t tid;
		3688	cond_t invoke_cv;
		3689	} userdata;
		3690
		3691	void prepare_loop (EV_P)
		3692	{
		3693	// for simplicity, we use a static userdata struct.
		3694	static userdata u;
		3695
		3696	ev_async_init (&u->async_w, async_cb);
		3697	ev_async_start (EV_A_ &u->async_w);
		3698
		3699	pthread_mutex_init (&u->lock, 0);
		3700	pthread_cond_init (&u->invoke_cv, 0);
		3701
		3702	// now associate this with the loop
		3703	ev_set_userdata (EV_A_ u);
		3704	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3705	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3706
		3707	// then create the thread running ev_run
		3708	pthread_create (&u->tid, 0, l_run, EV_A);
		3709	}
		3710
		3711	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3712	solely to wake up the event loop so it takes notice of any new watchers
		3713	that might have been added:
		3714
		3715	static void
		3716	async_cb (EV_P_ ev_async *w, int revents)
		3717	{
		3718	// just used for the side effects
		3719	}
		3720
		3721	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3722	protecting the loop data, respectively.
		3723
		3724	static void
		3725	l_release (EV_P)
		3726	{
		3727	userdata *u = ev_userdata (EV_A);
		3728	pthread_mutex_unlock (&u->lock);
		3729	}
		3730
		3731	static void
		3732	l_acquire (EV_P)
		3733	{
		3734	userdata *u = ev_userdata (EV_A);
		3735	pthread_mutex_lock (&u->lock);
		3736	}
		3737
		3738	The event loop thread first acquires the mutex, and then jumps straight
		3739	into C<ev_run>:
		3740
		3741	void *
		3742	l_run (void *thr_arg)
		3743	{
		3744	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3745
		3746	l_acquire (EV_A);
		3747	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3748	ev_run (EV_A_ 0);
		3749	l_release (EV_A);
		3750
		3751	return 0;
		3752	}
		3753
		3754	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3755	signal the main thread via some unspecified mechanism (signals? pipe
		3756	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3757	have been called (in a while loop because a) spurious wakeups are possible
		3758	and b) skipping inter-thread-communication when there are no pending
		3759	watchers is very beneficial):
		3760
		3761	static void
		3762	l_invoke (EV_P)
		3763	{
		3764	userdata *u = ev_userdata (EV_A);
		3765
		3766	while (ev_pending_count (EV_A))
		3767	{
		3768	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3769	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3770	}
		3771	}
		3772
		3773	Now, whenever the main thread gets told to invoke pending watchers, it
		3774	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3775	thread to continue:
		3776
		3777	static void
		3778	real_invoke_pending (EV_P)
		3779	{
		3780	userdata *u = ev_userdata (EV_A);
		3781
		3782	pthread_mutex_lock (&u->lock);
		3783	ev_invoke_pending (EV_A);
		3784	pthread_cond_signal (&u->invoke_cv);
		3785	pthread_mutex_unlock (&u->lock);
		3786	}
		3787
		3788	Whenever you want to start/stop a watcher or do other modifications to an
		3789	event loop, you will now have to lock:
		3790
		3791	ev_timer timeout_watcher;
		3792	userdata *u = ev_userdata (EV_A);
		3793
		3794	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3795
		3796	pthread_mutex_lock (&u->lock);
		3797	ev_timer_start (EV_A_ &timeout_watcher);
		3798	ev_async_send (EV_A_ &u->async_w);
		3799	pthread_mutex_unlock (&u->lock);
		3800
		3801	Note that sending the C<ev_async> watcher is required because otherwise
		3802	an event loop currently blocking in the kernel will have no knowledge
		3803	about the newly added timer. By waking up the loop it will pick up any new
		3804	watchers in the next event loop iteration.
		3805
		3806	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3807
		3808	While the overhead of a callback that e.g. schedules a thread is small, it
		3809	is still an overhead. If you embed libev, and your main usage is with some
		3810	kind of threads or coroutines, you might want to customise libev so that
		3811	doesn't need callbacks anymore.
		3812
		3813	Imagine you have coroutines that you can switch to using a function
		3814	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3815	and that due to some magic, the currently active coroutine is stored in a
		3816	global called C<current_coro>. Then you can build your own "wait for libev
		3817	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3818	the differing C<;> conventions):
		3819
		3820	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3821	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3822
		3823	That means instead of having a C callback function, you store the
		3824	coroutine to switch to in each watcher, and instead of having libev call
		3825	your callback, you instead have it switch to that coroutine.
		3826
		3827	A coroutine might now wait for an event with a function called
		3828	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3829	matter when, or whether the watcher is active or not when this function is
		3830	called):
		3831
		3832	void
		3833	wait_for_event (ev_watcher *w)
		3834	{
		3835	ev_cb_set (w) = current_coro;
		3836	switch_to (libev_coro);
		3837	}
		3838
		3839	That basically suspends the coroutine inside C<wait_for_event> and
		3840	continues the libev coroutine, which, when appropriate, switches back to
		3841	this or any other coroutine.
		3842
		3843	You can do similar tricks if you have, say, threads with an event queue -
		3844	instead of storing a coroutine, you store the queue object and instead of
		3845	switching to a coroutine, you push the watcher onto the queue and notify
		3846	any waiters.
		3847
		3848	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3849	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3850
		3851	// my_ev.h
		3852	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3853	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3854	#include "../libev/ev.h"
		3855
		3856	// my_ev.c
		3857	#define EV_H "my_ev.h"
		3858	#include "../libev/ev.c"
		3859
		3860	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3861	F<my_ev.c> into your project. When properly specifying include paths, you
		3862	can even use F<ev.h> as header file name directly.
2463		3863
2464		3864
2465	=head1 LIBEVENT EMULATION	3865	=head1 LIBEVENT EMULATION
2466		3866
2467	Libev offers a compatibility emulation layer for libevent. It cannot	3867	Libev offers a compatibility emulation layer for libevent. It cannot
2468	emulate the internals of libevent, so here are some usage hints:	3868	emulate the internals of libevent, so here are some usage hints:
2469		3869
2470	=over 4	3870	=over 4
		3871
		3872	=item * Only the libevent-1.4.1-beta API is being emulated.
		3873
		3874	This was the newest libevent version available when libev was implemented,
		3875	and is still mostly unchanged in 2010.
2471		3876
2472	=item * Use it by including <event.h>, as usual.	3877	=item * Use it by including <event.h>, as usual.
2473		3878
2474	=item * The following members are fully supported: ev_base, ev_callback,	3879	=item * The following members are fully supported: ev_base, ev_callback,
2475	ev_arg, ev_fd, ev_res, ev_events.	3880	ev_arg, ev_fd, ev_res, ev_events.
…		…
2481	=item * Priorities are not currently supported. Initialising priorities	3886	=item * Priorities are not currently supported. Initialising priorities
2482	will fail and all watchers will have the same priority, even though there	3887	will fail and all watchers will have the same priority, even though there
2483	is an ev_pri field.	3888	is an ev_pri field.
2484		3889
2485	=item * In libevent, the last base created gets the signals, in libev, the	3890	=item * In libevent, the last base created gets the signals, in libev, the
2486	first base created (== the default loop) gets the signals.	3891	base that registered the signal gets the signals.
2487		3892
2488	=item * Other members are not supported.	3893	=item * Other members are not supported.
2489		3894
2490	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3895	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2491	to use the libev header file and library.	3896	to use the libev header file and library.
…		…
2510	Care has been taken to keep the overhead low. The only data member the C++	3915	Care has been taken to keep the overhead low. The only data member the C++
2511	classes add (compared to plain C-style watchers) is the event loop pointer	3916	classes add (compared to plain C-style watchers) is the event loop pointer
2512	that the watcher is associated with (or no additional members at all if	3917	that the watcher is associated with (or no additional members at all if
2513	you disable C<EV_MULTIPLICITY> when embedding libev).	3918	you disable C<EV_MULTIPLICITY> when embedding libev).
2514		3919
2515	Currently, functions, and static and non-static member functions can be	3920	Currently, functions, static and non-static member functions and classes
2516	used as callbacks. Other types should be easy to add as long as they only	3921	with C<operator ()> can be used as callbacks. Other types should be easy
2517	need one additional pointer for context. If you need support for other	3922	to add as long as they only need one additional pointer for context. If
2518	types of functors please contact the author (preferably after implementing	3923	you need support for other types of functors please contact the author
2519	it).	3924	(preferably after implementing it).
		3925
		3926	For all this to work, your C++ compiler either has to use the same calling
		3927	conventions as your C compiler (for static member functions), or you have
		3928	to embed libev and compile libev itself as C++.
2520		3929
2521	Here is a list of things available in the C<ev> namespace:	3930	Here is a list of things available in the C<ev> namespace:
2522		3931
2523	=over 4	3932	=over 4
2524		3933
…		…
2534	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	3943	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
2535		3944
2536	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	3945	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
2537	the same name in the C<ev> namespace, with the exception of C<ev_signal>	3946	the same name in the C<ev> namespace, with the exception of C<ev_signal>
2538	which is called C<ev::sig> to avoid clashes with the C<signal> macro	3947	which is called C<ev::sig> to avoid clashes with the C<signal> macro
2539	defines by many implementations.	3948	defined by many implementations.
2540		3949
2541	All of those classes have these methods:	3950	All of those classes have these methods:
2542		3951
2543	=over 4	3952	=over 4
2544		3953
2545	=item ev::TYPE::TYPE ()	3954	=item ev::TYPE::TYPE ()
2546		3955
2547	=item ev::TYPE::TYPE (struct ev_loop *)	3956	=item ev::TYPE::TYPE (loop)
2548		3957
2549	=item ev::TYPE::~TYPE	3958	=item ev::TYPE::~TYPE
2550		3959
2551	The constructor (optionally) takes an event loop to associate the watcher	3960	The constructor (optionally) takes an event loop to associate the watcher
2552	with. If it is omitted, it will use C<EV_DEFAULT>.	3961	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
2584		3993
2585	myclass obj;	3994	myclass obj;
2586	ev::io iow;	3995	ev::io iow;
2587	iow.set <myclass, &myclass::io_cb> (&obj);	3996	iow.set <myclass, &myclass::io_cb> (&obj);
2588		3997
		3998	=item w->set (object *)
		3999
		4000	This is a variation of a method callback - leaving out the method to call
		4001	will default the method to C<operator ()>, which makes it possible to use
		4002	functor objects without having to manually specify the C<operator ()> all
		4003	the time. Incidentally, you can then also leave out the template argument
		4004	list.
		4005
		4006	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		4007	int revents)>.
		4008
		4009	See the method-C<set> above for more details.
		4010
		4011	Example: use a functor object as callback.
		4012
		4013	struct myfunctor
		4014	{
		4015	void operator() (ev::io &w, int revents)
		4016	{
		4017	...
		4018	}
		4019	}
		4020
		4021	myfunctor f;
		4022
		4023	ev::io w;
		4024	w.set (&f);
		4025
2589	=item w->set<function> (void *data = 0)	4026	=item w->set<function> (void *data = 0)
2590		4027
2591	Also sets a callback, but uses a static method or plain function as	4028	Also sets a callback, but uses a static method or plain function as
2592	callback. The optional C<data> argument will be stored in the watcher's	4029	callback. The optional C<data> argument will be stored in the watcher's
2593	C<data> member and is free for you to use.	4030	C<data> member and is free for you to use.
2594		4031
2595	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	4032	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2596		4033
2597	See the method-C<set> above for more details.	4034	See the method-C<set> above for more details.
2598		4035
2599	Example:	4036	Example: Use a plain function as callback.
2600		4037
2601	static void io_cb (ev::io &w, int revents) { }	4038	static void io_cb (ev::io &w, int revents) { }
2602	iow.set <io_cb> ();	4039	iow.set <io_cb> ();
2603		4040
2604	=item w->set (struct ev_loop *)	4041	=item w->set (loop)
2605		4042
2606	Associates a different C<struct ev_loop> with this watcher. You can only	4043	Associates a different C<struct ev_loop> with this watcher. You can only
2607	do this when the watcher is inactive (and not pending either).	4044	do this when the watcher is inactive (and not pending either).
2608		4045
2609	=item w->set ([arguments])	4046	=item w->set ([arguments])
2610		4047
2611	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	4048	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
2612	called at least once. Unlike the C counterpart, an active watcher gets	4049	method or a suitable start method must be called at least once. Unlike the
2613	automatically stopped and restarted when reconfiguring it with this	4050	C counterpart, an active watcher gets automatically stopped and restarted
2614	method.	4051	when reconfiguring it with this method.
2615		4052
2616	=item w->start ()	4053	=item w->start ()
2617		4054
2618	Starts the watcher. Note that there is no C<loop> argument, as the	4055	Starts the watcher. Note that there is no C<loop> argument, as the
2619	constructor already stores the event loop.	4056	constructor already stores the event loop.
2620		4057
		4058	=item w->start ([arguments])
		4059
		4060	Instead of calling C<set> and C<start> methods separately, it is often
		4061	convenient to wrap them in one call. Uses the same type of arguments as
		4062	the configure C<set> method of the watcher.
		4063
2621	=item w->stop ()	4064	=item w->stop ()
2622		4065
2623	Stops the watcher if it is active. Again, no C<loop> argument.	4066	Stops the watcher if it is active. Again, no C<loop> argument.
2624		4067
2625	=item w->again () (C<ev::timer>, C<ev::periodic> only)	4068	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
2637		4080
2638	=back	4081	=back
2639		4082
2640	=back	4083	=back
2641		4084
2642	Example: Define a class with an IO and idle watcher, start one of them in	4085	Example: Define a class with two I/O and idle watchers, start the I/O
2643	the constructor.	4086	watchers in the constructor.
2644		4087
2645	class myclass	4088	class myclass
2646	{	4089	{
2647	ev::io io; void io_cb (ev::io &w, int revents);	4090	ev::io io ; void io_cb (ev::io &w, int revents);
		4091	ev::io io2 ; void io2_cb (ev::io &w, int revents);
2648	ev:idle idle void idle_cb (ev::idle &w, int revents);	4092	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2649		4093
2650	myclass (int fd)	4094	myclass (int fd)
2651	{	4095	{
2652	io .set <myclass, &myclass::io_cb > (this);	4096	io .set <myclass, &myclass::io_cb > (this);
		4097	io2 .set <myclass, &myclass::io2_cb > (this);
2653	idle.set <myclass, &myclass::idle_cb> (this);	4098	idle.set <myclass, &myclass::idle_cb> (this);
2654		4099
2655	io.start (fd, ev::READ);	4100	io.set (fd, ev::WRITE); // configure the watcher
		4101	io.start (); // start it whenever convenient
		4102
		4103	io2.start (fd, ev::READ); // set + start in one call
2656	}	4104	}
2657	};	4105	};
2658		4106
2659		4107
2660	=head1 OTHER LANGUAGE BINDINGS	4108	=head1 OTHER LANGUAGE BINDINGS
…		…
2669	=item Perl	4117	=item Perl
2670		4118
2671	The EV module implements the full libev API and is actually used to test	4119	The EV module implements the full libev API and is actually used to test
2672	libev. EV is developed together with libev. Apart from the EV core module,	4120	libev. EV is developed together with libev. Apart from the EV core module,
2673	there are additional modules that implement libev-compatible interfaces	4121	there are additional modules that implement libev-compatible interfaces
2674	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	4122	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
2675	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	4123	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		4124	and C<EV::Glib>).
2676		4125
2677	It can be found and installed via CPAN, its homepage is at	4126	It can be found and installed via CPAN, its homepage is at
2678	L<http://software.schmorp.de/pkg/EV>.	4127	L<http://software.schmorp.de/pkg/EV>.
2679		4128
2680	=item Python	4129	=item Python
2681		4130
2682	Python bindings can be found at L<http://code.google.com/p/pyev/>. It	4131	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
2683	seems to be quite complete and well-documented. Note, however, that the	4132	seems to be quite complete and well-documented.
2684	patch they require for libev is outright dangerous as it breaks the ABI
2685	for everybody else, and therefore, should never be applied in an installed
2686	libev (if python requires an incompatible ABI then it needs to embed
2687	libev).
2688		4133
2689	=item Ruby	4134	=item Ruby
2690		4135
2691	Tony Arcieri has written a ruby extension that offers access to a subset	4136	Tony Arcieri has written a ruby extension that offers access to a subset
2692	of the libev API and adds file handle abstractions, asynchronous DNS and	4137	of the libev API and adds file handle abstractions, asynchronous DNS and
2693	more on top of it. It can be found via gem servers. Its homepage is at	4138	more on top of it. It can be found via gem servers. Its homepage is at
2694	L<http://rev.rubyforge.org/>.	4139	L<http://rev.rubyforge.org/>.
2695		4140
		4141	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		4142	makes rev work even on mingw.
		4143
		4144	=item Haskell
		4145
		4146	A haskell binding to libev is available at
		4147	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		4148
2696	=item D	4149	=item D
2697		4150
2698	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4151	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2699	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4152	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
		4153
		4154	=item Ocaml
		4155
		4156	Erkki Seppala has written Ocaml bindings for libev, to be found at
		4157	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		4158
		4159	=item Lua
		4160
		4161	Brian Maher has written a partial interface to libev for lua (at the
		4162	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
		4163	L<http://github.com/brimworks/lua-ev>.
2700		4164
2701	=back	4165	=back
2702		4166
2703		4167
2704	=head1 MACRO MAGIC	4168	=head1 MACRO MAGIC
…		…
2718	loop argument"). The C<EV_A> form is used when this is the sole argument,	4182	loop argument"). The C<EV_A> form is used when this is the sole argument,
2719	C<EV_A_> is used when other arguments are following. Example:	4183	C<EV_A_> is used when other arguments are following. Example:
2720		4184
2721	ev_unref (EV_A);	4185	ev_unref (EV_A);
2722	ev_timer_add (EV_A_ watcher);	4186	ev_timer_add (EV_A_ watcher);
2723	ev_loop (EV_A_ 0);	4187	ev_run (EV_A_ 0);
2724		4188
2725	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4189	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2726	which is often provided by the following macro.	4190	which is often provided by the following macro.
2727		4191
2728	=item C<EV_P>, C<EV_P_>	4192	=item C<EV_P>, C<EV_P_>
…		…
2741	suitable for use with C<EV_A>.	4205	suitable for use with C<EV_A>.
2742		4206
2743	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4207	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2744		4208
2745	Similar to the other two macros, this gives you the value of the default	4209	Similar to the other two macros, this gives you the value of the default
2746	loop, if multiple loops are supported ("ev loop default").	4210	loop, if multiple loops are supported ("ev loop default"). The default loop
		4211	will be initialised if it isn't already initialised.
		4212
		4213	For non-multiplicity builds, these macros do nothing, so you always have
		4214	to initialise the loop somewhere.
2747		4215
2748	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4216	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
2749		4217
2750	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4218	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
2751	default loop has been initialised (C<UC> == unchecked). Their behaviour	4219	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
2768	}	4236	}
2769		4237
2770	ev_check check;	4238	ev_check check;
2771	ev_check_init (&check, check_cb);	4239	ev_check_init (&check, check_cb);
2772	ev_check_start (EV_DEFAULT_ &check);	4240	ev_check_start (EV_DEFAULT_ &check);
2773	ev_loop (EV_DEFAULT_ 0);	4241	ev_run (EV_DEFAULT_ 0);
2774		4242
2775	=head1 EMBEDDING	4243	=head1 EMBEDDING
2776		4244
2777	Libev can (and often is) directly embedded into host	4245	Libev can (and often is) directly embedded into host
2778	applications. Examples of applications that embed it include the Deliantra	4246	applications. Examples of applications that embed it include the Deliantra
…		…
2805		4273
2806	#define EV_STANDALONE 1	4274	#define EV_STANDALONE 1
2807	#include "ev.h"	4275	#include "ev.h"
2808		4276
2809	Both header files and implementation files can be compiled with a C++	4277	Both header files and implementation files can be compiled with a C++
2810	compiler (at least, thats a stated goal, and breakage will be treated	4278	compiler (at least, that's a stated goal, and breakage will be treated
2811	as a bug).	4279	as a bug).
2812		4280
2813	You need the following files in your source tree, or in a directory	4281	You need the following files in your source tree, or in a directory
2814	in your include path (e.g. in libev/ when using -Ilibev):	4282	in your include path (e.g. in libev/ when using -Ilibev):
2815		4283
…		…
2858	libev.m4	4326	libev.m4
2859		4327
2860	=head2 PREPROCESSOR SYMBOLS/MACROS	4328	=head2 PREPROCESSOR SYMBOLS/MACROS
2861		4329
2862	Libev can be configured via a variety of preprocessor symbols you have to	4330	Libev can be configured via a variety of preprocessor symbols you have to
2863	define before including any of its files. The default in the absence of	4331	define before including (or compiling) any of its files. The default in
2864	autoconf is noted for every option.	4332	the absence of autoconf is documented for every option.
		4333
		4334	Symbols marked with "(h)" do not change the ABI, and can have different
		4335	values when compiling libev vs. including F<ev.h>, so it is permissible
		4336	to redefine them before including F<ev.h> without breaking compatibility
		4337	to a compiled library. All other symbols change the ABI, which means all
		4338	users of libev and the libev code itself must be compiled with compatible
		4339	settings.
2865		4340
2866	=over 4	4341	=over 4
2867		4342
		4343	=item EV_COMPAT3 (h)
		4344
		4345	Backwards compatibility is a major concern for libev. This is why this
		4346	release of libev comes with wrappers for the functions and symbols that
		4347	have been renamed between libev version 3 and 4.
		4348
		4349	You can disable these wrappers (to test compatibility with future
		4350	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4351	sources. This has the additional advantage that you can drop the C<struct>
		4352	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4353	typedef in that case.
		4354
		4355	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4356	and in some even more future version the compatibility code will be
		4357	removed completely.
		4358
2868	=item EV_STANDALONE	4359	=item EV_STANDALONE (h)
2869		4360
2870	Must always be C<1> if you do not use autoconf configuration, which	4361	Must always be C<1> if you do not use autoconf configuration, which
2871	keeps libev from including F<config.h>, and it also defines dummy	4362	keeps libev from including F<config.h>, and it also defines dummy
2872	implementations for some libevent functions (such as logging, which is not	4363	implementations for some libevent functions (such as logging, which is not
2873	supported). It will also not define any of the structs usually found in	4364	supported). It will also not define any of the structs usually found in
2874	F<event.h> that are not directly supported by the libev core alone.	4365	F<event.h> that are not directly supported by the libev core alone.
2875		4366
		4367	In standalone mode, libev will still try to automatically deduce the
		4368	configuration, but has to be more conservative.
		4369
		4370	=item EV_USE_FLOOR
		4371
		4372	If defined to be C<1>, libev will use the C<floor ()> function for its
		4373	periodic reschedule calculations, otherwise libev will fall back on a
		4374	portable (slower) implementation. If you enable this, you usually have to
		4375	link against libm or something equivalent. Enabling this when the C<floor>
		4376	function is not available will fail, so the safe default is to not enable
		4377	this.
		4378
2876	=item EV_USE_MONOTONIC	4379	=item EV_USE_MONOTONIC
2877		4380
2878	If defined to be C<1>, libev will try to detect the availability of the	4381	If defined to be C<1>, libev will try to detect the availability of the
2879	monotonic clock option at both compile time and runtime. Otherwise no use	4382	monotonic clock option at both compile time and runtime. Otherwise no
2880	of the monotonic clock option will be attempted. If you enable this, you	4383	use of the monotonic clock option will be attempted. If you enable this,
2881	usually have to link against librt or something similar. Enabling it when	4384	you usually have to link against librt or something similar. Enabling it
2882	the functionality isn't available is safe, though, although you have	4385	when the functionality isn't available is safe, though, although you have
2883	to make sure you link against any libraries where the C<clock_gettime>	4386	to make sure you link against any libraries where the C<clock_gettime>
2884	function is hiding in (often F<-lrt>).	4387	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2885		4388
2886	=item EV_USE_REALTIME	4389	=item EV_USE_REALTIME
2887		4390
2888	If defined to be C<1>, libev will try to detect the availability of the	4391	If defined to be C<1>, libev will try to detect the availability of the
2889	real-time clock option at compile time (and assume its availability at	4392	real-time clock option at compile time (and assume its availability
2890	runtime if successful). Otherwise no use of the real-time clock option will	4393	at runtime if successful). Otherwise no use of the real-time clock
2891	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	4394	option will be attempted. This effectively replaces C<gettimeofday>
2892	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	4395	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2893	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	4396	correctness. See the note about libraries in the description of
		4397	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		4398	C<EV_USE_CLOCK_SYSCALL>.
		4399
		4400	=item EV_USE_CLOCK_SYSCALL
		4401
		4402	If defined to be C<1>, libev will try to use a direct syscall instead
		4403	of calling the system-provided C<clock_gettime> function. This option
		4404	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		4405	unconditionally pulls in C<libpthread>, slowing down single-threaded
		4406	programs needlessly. Using a direct syscall is slightly slower (in
		4407	theory), because no optimised vdso implementation can be used, but avoids
		4408	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		4409	higher, as it simplifies linking (no need for C<-lrt>).
2894		4410
2895	=item EV_USE_NANOSLEEP	4411	=item EV_USE_NANOSLEEP
2896		4412
2897	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	4413	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2898	and will use it for delays. Otherwise it will use C<select ()>.	4414	and will use it for delays. Otherwise it will use C<select ()>.
…		…
2914		4430
2915	=item EV_SELECT_USE_FD_SET	4431	=item EV_SELECT_USE_FD_SET
2916		4432
2917	If defined to C<1>, then the select backend will use the system C<fd_set>	4433	If defined to C<1>, then the select backend will use the system C<fd_set>
2918	structure. This is useful if libev doesn't compile due to a missing	4434	structure. This is useful if libev doesn't compile due to a missing
2919	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on	4435	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
2920	exotic systems. This usually limits the range of file descriptors to some	4436	on exotic systems. This usually limits the range of file descriptors to
2921	low limit such as 1024 or might have other limitations (winsocket only	4437	some low limit such as 1024 or might have other limitations (winsocket
2922	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	4438	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2923	influence the size of the C<fd_set> used.	4439	configures the maximum size of the C<fd_set>.
2924		4440
2925	=item EV_SELECT_IS_WINSOCKET	4441	=item EV_SELECT_IS_WINSOCKET
2926		4442
2927	When defined to C<1>, the select backend will assume that	4443	When defined to C<1>, the select backend will assume that
2928	select/socket/connect etc. don't understand file descriptors but	4444	select/socket/connect etc. don't understand file descriptors but
…		…
2930	be used is the winsock select). This means that it will call	4446	be used is the winsock select). This means that it will call
2931	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	4447	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2932	it is assumed that all these functions actually work on fds, even	4448	it is assumed that all these functions actually work on fds, even
2933	on win32. Should not be defined on non-win32 platforms.	4449	on win32. Should not be defined on non-win32 platforms.
2934		4450
2935	=item EV_FD_TO_WIN32_HANDLE	4451	=item EV_FD_TO_WIN32_HANDLE(fd)
2936		4452
2937	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	4453	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2938	file descriptors to socket handles. When not defining this symbol (the	4454	file descriptors to socket handles. When not defining this symbol (the
2939	default), then libev will call C<_get_osfhandle>, which is usually	4455	default), then libev will call C<_get_osfhandle>, which is usually
2940	correct. In some cases, programs use their own file descriptor management,	4456	correct. In some cases, programs use their own file descriptor management,
2941	in which case they can provide this function to map fds to socket handles.	4457	in which case they can provide this function to map fds to socket handles.
		4458
		4459	=item EV_WIN32_HANDLE_TO_FD(handle)
		4460
		4461	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		4462	using the standard C<_open_osfhandle> function. For programs implementing
		4463	their own fd to handle mapping, overwriting this function makes it easier
		4464	to do so. This can be done by defining this macro to an appropriate value.
		4465
		4466	=item EV_WIN32_CLOSE_FD(fd)
		4467
		4468	If programs implement their own fd to handle mapping on win32, then this
		4469	macro can be used to override the C<close> function, useful to unregister
		4470	file descriptors again. Note that the replacement function has to close
		4471	the underlying OS handle.
2942		4472
2943	=item EV_USE_POLL	4473	=item EV_USE_POLL
2944		4474
2945	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4475	If defined to be C<1>, libev will compile in support for the C<poll>(2)
2946	backend. Otherwise it will be enabled on non-win32 platforms. It	4476	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
2982	If defined to be C<1>, libev will compile in support for the Linux inotify	4512	If defined to be C<1>, libev will compile in support for the Linux inotify
2983	interface to speed up C<ev_stat> watchers. Its actual availability will	4513	interface to speed up C<ev_stat> watchers. Its actual availability will
2984	be detected at runtime. If undefined, it will be enabled if the headers	4514	be detected at runtime. If undefined, it will be enabled if the headers
2985	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4515	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2986		4516
		4517	=item EV_NO_SMP
		4518
		4519	If defined to be C<1>, libev will assume that memory is always coherent
		4520	between threads, that is, threads can be used, but threads never run on
		4521	different cpus (or different cpu cores). This reduces dependencies
		4522	and makes libev faster.
		4523
		4524	=item EV_NO_THREADS
		4525
		4526	If defined to be C<1>, libev will assume that it will never be called
		4527	from different threads, which is a stronger assumption than C<EV_NO_SMP>,
		4528	above. This reduces dependencies and makes libev faster.
		4529
2987	=item EV_ATOMIC_T	4530	=item EV_ATOMIC_T
2988		4531
2989	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4532	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2990	access is atomic with respect to other threads or signal contexts. No such	4533	access is atomic and serialised with respect to other threads or signal
2991	type is easily found in the C language, so you can provide your own type	4534	contexts. No such type is easily found in the C language, so you can
2992	that you know is safe for your purposes. It is used both for signal handler "locking"	4535	provide your own type that you know is safe for your purposes. It is used
2993	as well as for signal and thread safety in C<ev_async> watchers.	4536	both for signal handler "locking" as well as for signal and thread safety
		4537	in C<ev_async> watchers.
2994		4538
2995	In the absence of this define, libev will use C<sig_atomic_t volatile>	4539	In the absence of this define, libev will use C<sig_atomic_t volatile>
2996	(from F<signal.h>), which is usually good enough on most platforms.	4540	(from F<signal.h>), which is usually good enough on most platforms,
		4541	although strictly speaking using a type that also implies a memory fence
		4542	is required.
2997		4543
2998	=item EV_H	4544	=item EV_H (h)
2999		4545
3000	The name of the F<ev.h> header file used to include it. The default if	4546	The name of the F<ev.h> header file used to include it. The default if
3001	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4547	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3002	used to virtually rename the F<ev.h> header file in case of conflicts.	4548	used to virtually rename the F<ev.h> header file in case of conflicts.
3003		4549
3004	=item EV_CONFIG_H	4550	=item EV_CONFIG_H (h)
3005		4551
3006	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4552	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3007	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4553	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3008	C<EV_H>, above.	4554	C<EV_H>, above.
3009		4555
3010	=item EV_EVENT_H	4556	=item EV_EVENT_H (h)
3011		4557
3012	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4558	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3013	of how the F<event.h> header can be found, the default is C<"event.h">.	4559	of how the F<event.h> header can be found, the default is C<"event.h">.
3014		4560
3015	=item EV_PROTOTYPES	4561	=item EV_PROTOTYPES (h)
3016		4562
3017	If defined to be C<0>, then F<ev.h> will not define any function	4563	If defined to be C<0>, then F<ev.h> will not define any function
3018	prototypes, but still define all the structs and other symbols. This is	4564	prototypes, but still define all the structs and other symbols. This is
3019	occasionally useful if you want to provide your own wrapper functions	4565	occasionally useful if you want to provide your own wrapper functions
3020	around libev functions.	4566	around libev functions.
…		…
3025	will have the C<struct ev_loop *> as first argument, and you can create	4571	will have the C<struct ev_loop *> as first argument, and you can create
3026	additional independent event loops. Otherwise there will be no support	4572	additional independent event loops. Otherwise there will be no support
3027	for multiple event loops and there is no first event loop pointer	4573	for multiple event loops and there is no first event loop pointer
3028	argument. Instead, all functions act on the single default loop.	4574	argument. Instead, all functions act on the single default loop.
3029		4575
		4576	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4577	default loop when multiplicity is switched off - you always have to
		4578	initialise the loop manually in this case.
		4579
3030	=item EV_MINPRI	4580	=item EV_MINPRI
3031		4581
3032	=item EV_MAXPRI	4582	=item EV_MAXPRI
3033		4583
3034	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4584	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
3039	When doing priority-based operations, libev usually has to linearly search	4589	When doing priority-based operations, libev usually has to linearly search
3040	all the priorities, so having many of them (hundreds) uses a lot of space	4590	all the priorities, so having many of them (hundreds) uses a lot of space
3041	and time, so using the defaults of five priorities (-2 .. +2) is usually	4591	and time, so using the defaults of five priorities (-2 .. +2) is usually
3042	fine.	4592	fine.
3043		4593
3044	If your embedding application does not need any priorities, defining these both to	4594	If your embedding application does not need any priorities, defining these
3045	C<0> will save some memory and CPU.	4595	both to C<0> will save some memory and CPU.
3046		4596
3047	=item EV_PERIODIC_ENABLE	4597	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4598	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4599	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3048		4600
3049	If undefined or defined to be C<1>, then periodic timers are supported. If	4601	If undefined or defined to be C<1> (and the platform supports it), then
3050	defined to be C<0>, then they are not. Disabling them saves a few kB of	4602	the respective watcher type is supported. If defined to be C<0>, then it
3051	code.	4603	is not. Disabling watcher types mainly saves code size.
3052		4604
3053	=item EV_IDLE_ENABLE	4605	=item EV_FEATURES
3054
3055	If undefined or defined to be C<1>, then idle watchers are supported. If
3056	defined to be C<0>, then they are not. Disabling them saves a few kB of
3057	code.
3058
3059	=item EV_EMBED_ENABLE
3060
3061	If undefined or defined to be C<1>, then embed watchers are supported. If
3062	defined to be C<0>, then they are not.
3063
3064	=item EV_STAT_ENABLE
3065
3066	If undefined or defined to be C<1>, then stat watchers are supported. If
3067	defined to be C<0>, then they are not.
3068
3069	=item EV_FORK_ENABLE
3070
3071	If undefined or defined to be C<1>, then fork watchers are supported. If
3072	defined to be C<0>, then they are not.
3073
3074	=item EV_ASYNC_ENABLE
3075
3076	If undefined or defined to be C<1>, then async watchers are supported. If
3077	defined to be C<0>, then they are not.
3078
3079	=item EV_MINIMAL
3080		4606
3081	If you need to shave off some kilobytes of code at the expense of some	4607	If you need to shave off some kilobytes of code at the expense of some
3082	speed, define this symbol to C<1>. Currently this is used to override some	4608	speed (but with the full API), you can define this symbol to request
3083	inlining decisions, saves roughly 30% code size on amd64. It also selects a	4609	certain subsets of functionality. The default is to enable all features
3084	much smaller 2-heap for timer management over the default 4-heap.	4610	that can be enabled on the platform.
		4611
		4612	A typical way to use this symbol is to define it to C<0> (or to a bitset
		4613	with some broad features you want) and then selectively re-enable
		4614	additional parts you want, for example if you want everything minimal,
		4615	but multiple event loop support, async and child watchers and the poll
		4616	backend, use this:
		4617
		4618	#define EV_FEATURES 0
		4619	#define EV_MULTIPLICITY 1
		4620	#define EV_USE_POLL 1
		4621	#define EV_CHILD_ENABLE 1
		4622	#define EV_ASYNC_ENABLE 1
		4623
		4624	The actual value is a bitset, it can be a combination of the following
		4625	values:
		4626
		4627	=over 4
		4628
		4629	=item C<1> - faster/larger code
		4630
		4631	Use larger code to speed up some operations.
		4632
		4633	Currently this is used to override some inlining decisions (enlarging the
		4634	code size by roughly 30% on amd64).
		4635
		4636	When optimising for size, use of compiler flags such as C<-Os> with
		4637	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4638	assertions.
		4639
		4640	=item C<2> - faster/larger data structures
		4641
		4642	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4643	hash table sizes and so on. This will usually further increase code size
		4644	and can additionally have an effect on the size of data structures at
		4645	runtime.
		4646
		4647	=item C<4> - full API configuration
		4648
		4649	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4650	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4651
		4652	=item C<8> - full API
		4653
		4654	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4655	details on which parts of the API are still available without this
		4656	feature, and do not complain if this subset changes over time.
		4657
		4658	=item C<16> - enable all optional watcher types
		4659
		4660	Enables all optional watcher types. If you want to selectively enable
		4661	only some watcher types other than I/O and timers (e.g. prepare,
		4662	embed, async, child...) you can enable them manually by defining
		4663	C<EV_watchertype_ENABLE> to C<1> instead.
		4664
		4665	=item C<32> - enable all backends
		4666
		4667	This enables all backends - without this feature, you need to enable at
		4668	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4669
		4670	=item C<64> - enable OS-specific "helper" APIs
		4671
		4672	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4673	default.
		4674
		4675	=back
		4676
		4677	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4678	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4679	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4680	watchers, timers and monotonic clock support.
		4681
		4682	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4683	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4684	your program might be left out as well - a binary starting a timer and an
		4685	I/O watcher then might come out at only 5Kb.
		4686
		4687	=item EV_API_STATIC
		4688
		4689	If this symbol is defined (by default it is not), then all identifiers
		4690	will have static linkage. This means that libev will not export any
		4691	identifiers, and you cannot link against libev anymore. This can be useful
		4692	when you embed libev, only want to use libev functions in a single file,
		4693	and do not want its identifiers to be visible.
		4694
		4695	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4696	wants to use libev.
		4697
		4698	This option only works when libev is compiled with a C compiler, as C++
		4699	doesn't support the required declaration syntax.
		4700
		4701	=item EV_AVOID_STDIO
		4702
		4703	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4704	functions (printf, scanf, perror etc.). This will increase the code size
		4705	somewhat, but if your program doesn't otherwise depend on stdio and your
		4706	libc allows it, this avoids linking in the stdio library which is quite
		4707	big.
		4708
		4709	Note that error messages might become less precise when this option is
		4710	enabled.
		4711
		4712	=item EV_NSIG
		4713
		4714	The highest supported signal number, +1 (or, the number of
		4715	signals): Normally, libev tries to deduce the maximum number of signals
		4716	automatically, but sometimes this fails, in which case it can be
		4717	specified. Also, using a lower number than detected (C<32> should be
		4718	good for about any system in existence) can save some memory, as libev
		4719	statically allocates some 12-24 bytes per signal number.
3085		4720
3086	=item EV_PID_HASHSIZE	4721	=item EV_PID_HASHSIZE
3087		4722
3088	C<ev_child> watchers use a small hash table to distribute workload by	4723	C<ev_child> watchers use a small hash table to distribute workload by
3089	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4724	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3090	than enough. If you need to manage thousands of children you might want to	4725	usually more than enough. If you need to manage thousands of children you
3091	increase this value (I<must> be a power of two).	4726	might want to increase this value (I<must> be a power of two).
3092		4727
3093	=item EV_INOTIFY_HASHSIZE	4728	=item EV_INOTIFY_HASHSIZE
3094		4729
3095	C<ev_stat> watchers use a small hash table to distribute workload by	4730	C<ev_stat> watchers use a small hash table to distribute workload by
3096	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4731	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3097	usually more than enough. If you need to manage thousands of C<ev_stat>	4732	disabled), usually more than enough. If you need to manage thousands of
3098	watchers you might want to increase this value (I<must> be a power of	4733	C<ev_stat> watchers you might want to increase this value (I<must> be a
3099	two).	4734	power of two).
3100		4735
3101	=item EV_USE_4HEAP	4736	=item EV_USE_4HEAP
3102		4737
3103	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4738	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3104	timer and periodics heap, libev uses a 4-heap when this symbol is defined	4739	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3105	to C<1>. The 4-heap uses more complicated (longer) code but has	4740	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3106	noticeably faster performance with many (thousands) of watchers.	4741	faster performance with many (thousands) of watchers.
3107		4742
3108	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4743	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3109	(disabled).	4744	will be C<0>.
3110		4745
3111	=item EV_HEAP_CACHE_AT	4746	=item EV_HEAP_CACHE_AT
3112		4747
3113	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4748	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3114	timer and periodics heap, libev can cache the timestamp (I<at>) within	4749	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3115	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4750	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3116	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4751	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3117	but avoids random read accesses on heap changes. This improves performance	4752	but avoids random read accesses on heap changes. This improves performance
3118	noticeably with with many (hundreds) of watchers.	4753	noticeably with many (hundreds) of watchers.
3119		4754
3120	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4755	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3121	(disabled).	4756	will be C<0>.
3122		4757
3123	=item EV_VERIFY	4758	=item EV_VERIFY
3124		4759
3125	Controls how much internal verification (see C<ev_loop_verify ()>) will	4760	Controls how much internal verification (see C<ev_verify ()>) will
3126	be done: If set to C<0>, no internal verification code will be compiled	4761	be done: If set to C<0>, no internal verification code will be compiled
3127	in. If set to C<1>, then verification code will be compiled in, but not	4762	in. If set to C<1>, then verification code will be compiled in, but not
3128	called. If set to C<2>, then the internal verification code will be	4763	called. If set to C<2>, then the internal verification code will be
3129	called once per loop, which can slow down libev. If set to C<3>, then the	4764	called once per loop, which can slow down libev. If set to C<3>, then the
3130	verification code will be called very frequently, which will slow down	4765	verification code will be called very frequently, which will slow down
3131	libev considerably.	4766	libev considerably.
3132		4767
3133	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4768	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3134	C<0.>	4769	will be C<0>.
3135		4770
3136	=item EV_COMMON	4771	=item EV_COMMON
3137		4772
3138	By default, all watchers have a C<void *data> member. By redefining	4773	By default, all watchers have a C<void *data> member. By redefining
3139	this macro to a something else you can include more and other types of	4774	this macro to something else you can include more and other types of
3140	members. You have to define it each time you include one of the files,	4775	members. You have to define it each time you include one of the files,
3141	though, and it must be identical each time.	4776	though, and it must be identical each time.
3142		4777
3143	For example, the perl EV module uses something like this:	4778	For example, the perl EV module uses something like this:
3144		4779
…		…
3156	and the way callbacks are invoked and set. Must expand to a struct member	4791	and the way callbacks are invoked and set. Must expand to a struct member
3157	definition and a statement, respectively. See the F<ev.h> header file for	4792	definition and a statement, respectively. See the F<ev.h> header file for
3158	their default definitions. One possible use for overriding these is to	4793	their default definitions. One possible use for overriding these is to
3159	avoid the C<struct ev_loop *> as first argument in all cases, or to use	4794	avoid the C<struct ev_loop *> as first argument in all cases, or to use
3160	method calls instead of plain function calls in C++.	4795	method calls instead of plain function calls in C++.
		4796
		4797	=back
3161		4798
3162	=head2 EXPORTED API SYMBOLS	4799	=head2 EXPORTED API SYMBOLS
3163		4800
3164	If you need to re-export the API (e.g. via a DLL) and you need a list of	4801	If you need to re-export the API (e.g. via a DLL) and you need a list of
3165	exported symbols, you can use the provided F<Symbol.*> files which list	4802	exported symbols, you can use the provided F<Symbol.*> files which list
…		…
3195	file.	4832	file.
3196		4833
3197	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4834	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3198	that everybody includes and which overrides some configure choices:	4835	that everybody includes and which overrides some configure choices:
3199		4836
3200	#define EV_MINIMAL 1	4837	#define EV_FEATURES 8
3201	#define EV_USE_POLL 0	4838	#define EV_USE_SELECT 1
3202	#define EV_MULTIPLICITY 0
3203	#define EV_PERIODIC_ENABLE 0	4839	#define EV_PREPARE_ENABLE 1
		4840	#define EV_IDLE_ENABLE 1
3204	#define EV_STAT_ENABLE 0	4841	#define EV_SIGNAL_ENABLE 1
3205	#define EV_FORK_ENABLE 0	4842	#define EV_CHILD_ENABLE 1
		4843	#define EV_USE_STDEXCEPT 0
3206	#define EV_CONFIG_H <config.h>	4844	#define EV_CONFIG_H <config.h>
3207	#define EV_MINPRI 0
3208	#define EV_MAXPRI 0
3209		4845
3210	#include "ev++.h"	4846	#include "ev++.h"
3211		4847
3212	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4848	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3213		4849
3214	#include "ev_cpp.h"	4850	#include "ev_cpp.h"
3215	#include "ev.c"	4851	#include "ev.c"
3216		4852
		4853	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3217		4854
3218	=head1 THREADS AND COROUTINES	4855	=head2 THREADS AND COROUTINES
3219		4856
3220	=head2 THREADS	4857	=head3 THREADS
3221		4858
3222	Libev itself is completely thread-safe, but it uses no locking. This	4859	All libev functions are reentrant and thread-safe unless explicitly
		4860	documented otherwise, but libev implements no locking itself. This means
3223	means that you can use as many loops as you want in parallel, as long as	4861	that you can use as many loops as you want in parallel, as long as there
3224	only one thread ever calls into one libev function with the same loop	4862	are no concurrent calls into any libev function with the same loop
3225	parameter.	4863	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		4864	of course): libev guarantees that different event loops share no data
		4865	structures that need any locking.
3226		4866
3227	Or put differently: calls with different loop parameters can be done in	4867	Or to put it differently: calls with different loop parameters can be done
3228	parallel from multiple threads, calls with the same loop parameter must be	4868	concurrently from multiple threads, calls with the same loop parameter
3229	done serially (but can be done from different threads, as long as only one	4869	must be done serially (but can be done from different threads, as long as
3230	thread ever is inside a call at any point in time, e.g. by using a mutex	4870	only one thread ever is inside a call at any point in time, e.g. by using
3231	per loop).	4871	a mutex per loop).
		4872
		4873	Specifically to support threads (and signal handlers), libev implements
		4874	so-called C<ev_async> watchers, which allow some limited form of
		4875	concurrency on the same event loop, namely waking it up "from the
		4876	outside".
3232		4877
3233	If you want to know which design (one loop, locking, or multiple loops	4878	If you want to know which design (one loop, locking, or multiple loops
3234	without or something else still) is best for your problem, then I cannot	4879	without or something else still) is best for your problem, then I cannot
3235	help you. I can give some generic advice however:	4880	help you, but here is some generic advice:
3236		4881
3237	=over 4	4882	=over 4
3238		4883
3239	=item * most applications have a main thread: use the default libev loop	4884	=item * most applications have a main thread: use the default libev loop
3240	in that thread, or create a separate thread running only the default loop.	4885	in that thread, or create a separate thread running only the default loop.
…		…
3252		4897
3253	Choosing a model is hard - look around, learn, know that usually you can do	4898	Choosing a model is hard - look around, learn, know that usually you can do
3254	better than you currently do :-)	4899	better than you currently do :-)
3255		4900
3256	=item * often you need to talk to some other thread which blocks in the	4901	=item * often you need to talk to some other thread which blocks in the
		4902	event loop.
		4903
3257	event loop - C<ev_async> watchers can be used to wake them up from other	4904	C<ev_async> watchers can be used to wake them up from other threads safely
3258	threads safely (or from signal contexts...).	4905	(or from signal contexts...).
		4906
		4907	An example use would be to communicate signals or other events that only
		4908	work in the default loop by registering the signal watcher with the
		4909	default loop and triggering an C<ev_async> watcher from the default loop
		4910	watcher callback into the event loop interested in the signal.
3259		4911
3260	=back	4912	=back
3261		4913
		4914	See also L<THREAD LOCKING EXAMPLE>.
		4915
3262	=head2 COROUTINES	4916	=head3 COROUTINES
3263		4917
3264	Libev is much more accommodating to coroutines ("cooperative threads"):	4918	Libev is very accommodating to coroutines ("cooperative threads"):
3265	libev fully supports nesting calls to it's functions from different	4919	libev fully supports nesting calls to its functions from different
3266	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4920	coroutines (e.g. you can call C<ev_run> on the same loop from two
3267	different coroutines and switch freely between both coroutines running the	4921	different coroutines, and switch freely between both coroutines running
3268	loop, as long as you don't confuse yourself). The only exception is that	4922	the loop, as long as you don't confuse yourself). The only exception is
3269	you must not do this from C<ev_periodic> reschedule callbacks.	4923	that you must not do this from C<ev_periodic> reschedule callbacks.
3270		4924
3271	Care has been invested into making sure that libev does not keep local	4925	Care has been taken to ensure that libev does not keep local state inside
3272	state inside C<ev_loop>, and other calls do not usually allow coroutine	4926	C<ev_run>, and other calls do not usually allow for coroutine switches as
3273	switches.	4927	they do not call any callbacks.
3274		4928
		4929	=head2 COMPILER WARNINGS
3275		4930
3276	=head1 COMPLEXITIES	4931	Depending on your compiler and compiler settings, you might get no or a
		4932	lot of warnings when compiling libev code. Some people are apparently
		4933	scared by this.
3277		4934
3278	In this section the complexities of (many of) the algorithms used inside	4935	However, these are unavoidable for many reasons. For one, each compiler
3279	libev will be explained. For complexity discussions about backends see the	4936	has different warnings, and each user has different tastes regarding
3280	documentation for C<ev_default_init>.	4937	warning options. "Warn-free" code therefore cannot be a goal except when
		4938	targeting a specific compiler and compiler-version.
3281		4939
3282	All of the following are about amortised time: If an array needs to be	4940	Another reason is that some compiler warnings require elaborate
3283	extended, libev needs to realloc and move the whole array, but this	4941	workarounds, or other changes to the code that make it less clear and less
3284	happens asymptotically never with higher number of elements, so O(1) might	4942	maintainable.
3285	mean it might do a lengthy realloc operation in rare cases, but on average
3286	it is much faster and asymptotically approaches constant time.
3287		4943
3288	=over 4	4944	And of course, some compiler warnings are just plain stupid, or simply
		4945	wrong (because they don't actually warn about the condition their message
		4946	seems to warn about). For example, certain older gcc versions had some
		4947	warnings that resulted in an extreme number of false positives. These have
		4948	been fixed, but some people still insist on making code warn-free with
		4949	such buggy versions.
3289		4950
3290	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	4951	While libev is written to generate as few warnings as possible,
		4952	"warn-free" code is not a goal, and it is recommended not to build libev
		4953	with any compiler warnings enabled unless you are prepared to cope with
		4954	them (e.g. by ignoring them). Remember that warnings are just that:
		4955	warnings, not errors, or proof of bugs.
3291		4956
3292	This means that, when you have a watcher that triggers in one hour and
3293	there are 100 watchers that would trigger before that then inserting will
3294	have to skip roughly seven (C<ld 100>) of these watchers.
3295		4957
3296	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	4958	=head2 VALGRIND
3297		4959
3298	That means that changing a timer costs less than removing/adding them	4960	Valgrind has a special section here because it is a popular tool that is
3299	as only the relative motion in the event queue has to be paid for.	4961	highly useful. Unfortunately, valgrind reports are very hard to interpret.
3300		4962
3301	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	4963	If you think you found a bug (memory leak, uninitialised data access etc.)
		4964	in libev, then check twice: If valgrind reports something like:
3302		4965
3303	These just add the watcher into an array or at the head of a list.	4966	==2274== definitely lost: 0 bytes in 0 blocks.
		4967	==2274== possibly lost: 0 bytes in 0 blocks.
		4968	==2274== still reachable: 256 bytes in 1 blocks.
3304		4969
3305	=item Stopping check/prepare/idle/fork/async watchers: O(1)	4970	Then there is no memory leak, just as memory accounted to global variables
		4971	is not a memleak - the memory is still being referenced, and didn't leak.
3306		4972
3307	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	4973	Similarly, under some circumstances, valgrind might report kernel bugs
		4974	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		4975	although an acceptable workaround has been found here), or it might be
		4976	confused.
3308		4977
3309	These watchers are stored in lists then need to be walked to find the	4978	Keep in mind that valgrind is a very good tool, but only a tool. Don't
3310	correct watcher to remove. The lists are usually short (you don't usually	4979	make it into some kind of religion.
3311	have many watchers waiting for the same fd or signal).
3312		4980
3313	=item Finding the next timer in each loop iteration: O(1)	4981	If you are unsure about something, feel free to contact the mailing list
		4982	with the full valgrind report and an explanation on why you think this
		4983	is a bug in libev (best check the archives, too :). However, don't be
		4984	annoyed when you get a brisk "this is no bug" answer and take the chance
		4985	of learning how to interpret valgrind properly.
3314		4986
3315	By virtue of using a binary or 4-heap, the next timer is always found at a	4987	If you need, for some reason, empty reports from valgrind for your project
3316	fixed position in the storage array.	4988	I suggest using suppression lists.
3317		4989
3318	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3319		4990
3320	A change means an I/O watcher gets started or stopped, which requires	4991	=head1 PORTABILITY NOTES
3321	libev to recalculate its status (and possibly tell the kernel, depending
3322	on backend and whether C<ev_io_set> was used).
3323		4992
3324	=item Activating one watcher (putting it into the pending state): O(1)	4993	=head2 GNU/LINUX 32 BIT LIMITATIONS
3325		4994
3326	=item Priority handling: O(number_of_priorities)	4995	GNU/Linux is the only common platform that supports 64 bit file/large file
		4996	interfaces but I<disables> them by default.
3327		4997
3328	Priorities are implemented by allocating some space for each	4998	That means that libev compiled in the default environment doesn't support
3329	priority. When doing priority-based operations, libev usually has to	4999	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
3330	linearly search all the priorities, but starting/stopping and activating
3331	watchers becomes O(1) w.r.t. priority handling.
3332		5000
3333	=item Sending an ev_async: O(1)	5001	Unfortunately, many programs try to work around this GNU/Linux issue
		5002	by enabling the large file API, which makes them incompatible with the
		5003	standard libev compiled for their system.
3334		5004
3335	=item Processing ev_async_send: O(number_of_async_watchers)	5005	Likewise, libev cannot enable the large file API itself as this would
		5006	suddenly make it incompatible to the default compile time environment,
		5007	i.e. all programs not using special compile switches.
3336		5008
3337	=item Processing signals: O(max_signal_number)	5009	=head2 OS/X AND DARWIN BUGS
3338		5010
3339	Sending involves a system call I<iff> there were no other C<ev_async_send>	5011	The whole thing is a bug if you ask me - basically any system interface
3340	calls in the current loop iteration. Checking for async and signal events	5012	you touch is broken, whether it is locales, poll, kqueue or even the
3341	involves iterating over all running async watchers or all signal numbers.	5013	OpenGL drivers.
3342		5014
3343	=back	5015	=head3 C<kqueue> is buggy
3344		5016
		5017	The kqueue syscall is broken in all known versions - most versions support
		5018	only sockets, many support pipes.
3345		5019
		5020	Libev tries to work around this by not using C<kqueue> by default on this
		5021	rotten platform, but of course you can still ask for it when creating a
		5022	loop - embedding a socket-only kqueue loop into a select-based one is
		5023	probably going to work well.
		5024
		5025	=head3 C<poll> is buggy
		5026
		5027	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		5028	implementation by something calling C<kqueue> internally around the 10.5.6
		5029	release, so now C<kqueue> I<and> C<poll> are broken.
		5030
		5031	Libev tries to work around this by not using C<poll> by default on
		5032	this rotten platform, but of course you can still ask for it when creating
		5033	a loop.
		5034
		5035	=head3 C<select> is buggy
		5036
		5037	All that's left is C<select>, and of course Apple found a way to fuck this
		5038	one up as well: On OS/X, C<select> actively limits the number of file
		5039	descriptors you can pass in to 1024 - your program suddenly crashes when
		5040	you use more.
		5041
		5042	There is an undocumented "workaround" for this - defining
		5043	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		5044	work on OS/X.
		5045
		5046	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		5047
		5048	=head3 C<errno> reentrancy
		5049
		5050	The default compile environment on Solaris is unfortunately so
		5051	thread-unsafe that you can't even use components/libraries compiled
		5052	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		5053	defined by default. A valid, if stupid, implementation choice.
		5054
		5055	If you want to use libev in threaded environments you have to make sure
		5056	it's compiled with C<_REENTRANT> defined.
		5057
		5058	=head3 Event port backend
		5059
		5060	The scalable event interface for Solaris is called "event
		5061	ports". Unfortunately, this mechanism is very buggy in all major
		5062	releases. If you run into high CPU usage, your program freezes or you get
		5063	a large number of spurious wakeups, make sure you have all the relevant
		5064	and latest kernel patches applied. No, I don't know which ones, but there
		5065	are multiple ones to apply, and afterwards, event ports actually work
		5066	great.
		5067
		5068	If you can't get it to work, you can try running the program by setting
		5069	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		5070	C<select> backends.
		5071
		5072	=head2 AIX POLL BUG
		5073
		5074	AIX unfortunately has a broken C<poll.h> header. Libev works around
		5075	this by trying to avoid the poll backend altogether (i.e. it's not even
		5076	compiled in), which normally isn't a big problem as C<select> works fine
		5077	with large bitsets on AIX, and AIX is dead anyway.
		5078
3346	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	5079	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		5080
		5081	=head3 General issues
3347		5082
3348	Win32 doesn't support any of the standards (e.g. POSIX) that libev	5083	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3349	requires, and its I/O model is fundamentally incompatible with the POSIX	5084	requires, and its I/O model is fundamentally incompatible with the POSIX
3350	model. Libev still offers limited functionality on this platform in	5085	model. Libev still offers limited functionality on this platform in
3351	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5086	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3352	descriptors. This only applies when using Win32 natively, not when using	5087	descriptors. This only applies when using Win32 natively, not when using
3353	e.g. cygwin.	5088	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		5089	as every compiler comes with a slightly differently broken/incompatible
		5090	environment.
3354		5091
3355	Lifting these limitations would basically require the full	5092	Lifting these limitations would basically require the full
3356	re-implementation of the I/O system. If you are into these kinds of	5093	re-implementation of the I/O system. If you are into this kind of thing,
3357	things, then note that glib does exactly that for you in a very portable	5094	then note that glib does exactly that for you in a very portable way (note
3358	way (note also that glib is the slowest event library known to man).	5095	also that glib is the slowest event library known to man).
3359		5096
3360	There is no supported compilation method available on windows except	5097	There is no supported compilation method available on windows except
3361	embedding it into other applications.	5098	embedding it into other applications.
		5099
		5100	Sensible signal handling is officially unsupported by Microsoft - libev
		5101	tries its best, but under most conditions, signals will simply not work.
3362		5102
3363	Not a libev limitation but worth mentioning: windows apparently doesn't	5103	Not a libev limitation but worth mentioning: windows apparently doesn't
3364	accept large writes: instead of resulting in a partial write, windows will	5104	accept large writes: instead of resulting in a partial write, windows will
3365	either accept everything or return C<ENOBUFS> if the buffer is too large,	5105	either accept everything or return C<ENOBUFS> if the buffer is too large,
3366	so make sure you only write small amounts into your sockets (less than a	5106	so make sure you only write small amounts into your sockets (less than a
3367	megabyte seems safe, but thsi apparently depends on the amount of memory	5107	megabyte seems safe, but this apparently depends on the amount of memory
3368	available).	5108	available).
3369		5109
3370	Due to the many, low, and arbitrary limits on the win32 platform and	5110	Due to the many, low, and arbitrary limits on the win32 platform and
3371	the abysmal performance of winsockets, using a large number of sockets	5111	the abysmal performance of winsockets, using a large number of sockets
3372	is not recommended (and not reasonable). If your program needs to use	5112	is not recommended (and not reasonable). If your program needs to use
3373	more than a hundred or so sockets, then likely it needs to use a totally	5113	more than a hundred or so sockets, then likely it needs to use a totally
3374	different implementation for windows, as libev offers the POSIX readiness	5114	different implementation for windows, as libev offers the POSIX readiness
3375	notification model, which cannot be implemented efficiently on windows	5115	notification model, which cannot be implemented efficiently on windows
3376	(Microsoft monopoly games).	5116	(due to Microsoft monopoly games).
3377		5117
3378	A typical way to use libev under windows is to embed it (see the embedding	5118	A typical way to use libev under windows is to embed it (see the embedding
3379	section for details) and use the following F<evwrap.h> header file instead	5119	section for details) and use the following F<evwrap.h> header file instead
3380	of F<ev.h>:	5120	of F<ev.h>:
3381		5121
…		…
3383	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */	5123	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3384		5124
3385	#include "ev.h"	5125	#include "ev.h"
3386		5126
3387	And compile the following F<evwrap.c> file into your project (make sure	5127	And compile the following F<evwrap.c> file into your project (make sure
3388	you do I<not> compile the F<ev.c> or any other embedded soruce files!):	5128	you do I<not> compile the F<ev.c> or any other embedded source files!):
3389		5129
3390	#include "evwrap.h"	5130	#include "evwrap.h"
3391	#include "ev.c"	5131	#include "ev.c"
3392		5132
3393	=over 4
3394
3395	=item The winsocket select function	5133	=head3 The winsocket C<select> function
3396		5134
3397	The winsocket C<select> function doesn't follow POSIX in that it	5135	The winsocket C<select> function doesn't follow POSIX in that it
3398	requires socket I<handles> and not socket I<file descriptors> (it is	5136	requires socket I<handles> and not socket I<file descriptors> (it is
3399	also extremely buggy). This makes select very inefficient, and also	5137	also extremely buggy). This makes select very inefficient, and also
3400	requires a mapping from file descriptors to socket handles (the Microsoft	5138	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
3409	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	5147	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3410		5148
3411	Note that winsockets handling of fd sets is O(n), so you can easily get a	5149	Note that winsockets handling of fd sets is O(n), so you can easily get a
3412	complexity in the O(n²) range when using win32.	5150	complexity in the O(n²) range when using win32.
3413		5151
3414	=item Limited number of file descriptors	5152	=head3 Limited number of file descriptors
3415		5153
3416	Windows has numerous arbitrary (and low) limits on things.	5154	Windows has numerous arbitrary (and low) limits on things.
3417		5155
3418	Early versions of winsocket's select only supported waiting for a maximum	5156	Early versions of winsocket's select only supported waiting for a maximum
3419	of C<64> handles (probably owning to the fact that all windows kernels	5157	of C<64> handles (probably owning to the fact that all windows kernels
3420	can only wait for C<64> things at the same time internally; Microsoft	5158	can only wait for C<64> things at the same time internally; Microsoft
3421	recommends spawning a chain of threads and wait for 63 handles and the	5159	recommends spawning a chain of threads and wait for 63 handles and the
3422	previous thread in each. Great).	5160	previous thread in each. Sounds great!).
3423		5161
3424	Newer versions support more handles, but you need to define C<FD_SETSIZE>	5162	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3425	to some high number (e.g. C<2048>) before compiling the winsocket select	5163	to some high number (e.g. C<2048>) before compiling the winsocket select
3426	call (which might be in libev or elsewhere, for example, perl does its own	5164	call (which might be in libev or elsewhere, for example, perl and many
3427	select emulation on windows).	5165	other interpreters do their own select emulation on windows).
3428		5166
3429	Another limit is the number of file descriptors in the Microsoft runtime	5167	Another limit is the number of file descriptors in the Microsoft runtime
3430	libraries, which by default is C<64> (there must be a hidden I<64> fetish	5168	libraries, which by default is C<64> (there must be a hidden I<64>
3431	or something like this inside Microsoft). You can increase this by calling	5169	fetish or something like this inside Microsoft). You can increase this
3432	C<_setmaxstdio>, which can increase this limit to C<2048> (another	5170	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3433	arbitrary limit), but is broken in many versions of the Microsoft runtime	5171	(another arbitrary limit), but is broken in many versions of the Microsoft
3434	libraries.
3435
3436	This might get you to about C<512> or C<2048> sockets (depending on	5172	runtime libraries. This might get you to about C<512> or C<2048> sockets
3437	windows version and/or the phase of the moon). To get more, you need to	5173	(depending on windows version and/or the phase of the moon). To get more,
3438	wrap all I/O functions and provide your own fd management, but the cost of	5174	you need to wrap all I/O functions and provide your own fd management, but
3439	calling select (O(n²)) will likely make this unworkable.	5175	the cost of calling select (O(n²)) will likely make this unworkable.
3440		5176
3441	=back
3442
3443
3444	=head1 PORTABILITY REQUIREMENTS	5177	=head2 PORTABILITY REQUIREMENTS
3445		5178
3446	In addition to a working ISO-C implementation, libev relies on a few	5179	In addition to a working ISO-C implementation and of course the
3447	additional extensions:	5180	backend-specific APIs, libev relies on a few additional extensions:
3448		5181
3449	=over 4	5182	=over 4
3450		5183
3451	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible	5184	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
3452	calling conventions regardless of C<ev_watcher_type *>.	5185	calling conventions regardless of C<ev_watcher_type *>.
…		…
3455	structure (guaranteed by POSIX but not by ISO C for example), but it also	5188	structure (guaranteed by POSIX but not by ISO C for example), but it also
3456	assumes that the same (machine) code can be used to call any watcher	5189	assumes that the same (machine) code can be used to call any watcher
3457	callback: The watcher callbacks have different type signatures, but libev	5190	callback: The watcher callbacks have different type signatures, but libev
3458	calls them using an C<ev_watcher *> internally.	5191	calls them using an C<ev_watcher *> internally.
3459		5192
		5193	=item pointer accesses must be thread-atomic
		5194
		5195	Accessing a pointer value must be atomic, it must both be readable and
		5196	writable in one piece - this is the case on all current architectures.
		5197
3460	=item C<sig_atomic_t volatile> must be thread-atomic as well	5198	=item C<sig_atomic_t volatile> must be thread-atomic as well
3461		5199
3462	The type C<sig_atomic_t volatile> (or whatever is defined as	5200	The type C<sig_atomic_t volatile> (or whatever is defined as
3463	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different	5201	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
3464	threads. This is not part of the specification for C<sig_atomic_t>, but is	5202	threads. This is not part of the specification for C<sig_atomic_t>, but is
3465	believed to be sufficiently portable.	5203	believed to be sufficiently portable.
3466		5204
3467	=item C<sigprocmask> must work in a threaded environment	5205	=item C<sigprocmask> must work in a threaded environment
3468		5206
…		…
3477	except the initial one, and run the default loop in the initial thread as	5215	except the initial one, and run the default loop in the initial thread as
3478	well.	5216	well.
3479		5217
3480	=item C<long> must be large enough for common memory allocation sizes	5218	=item C<long> must be large enough for common memory allocation sizes
3481		5219
3482	To improve portability and simplify using libev, libev uses C<long>	5220	To improve portability and simplify its API, libev uses C<long> internally
3483	internally instead of C<size_t> when allocating its data structures. On	5221	instead of C<size_t> when allocating its data structures. On non-POSIX
3484	non-POSIX systems (Microsoft...) this might be unexpectedly low, but	5222	systems (Microsoft...) this might be unexpectedly low, but is still at
3485	is still at least 31 bits everywhere, which is enough for hundreds of	5223	least 31 bits everywhere, which is enough for hundreds of millions of
3486	millions of watchers.	5224	watchers.
3487		5225
3488	=item C<double> must hold a time value in seconds with enough accuracy	5226	=item C<double> must hold a time value in seconds with enough accuracy
3489		5227
3490	The type C<double> is used to represent timestamps. It is required to	5228	The type C<double> is used to represent timestamps. It is required to
3491	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5229	have at least 51 bits of mantissa (and 9 bits of exponent), which is
3492	enough for at least into the year 4000. This requirement is fulfilled by	5230	good enough for at least into the year 4000 with millisecond accuracy
		5231	(the design goal for libev). This requirement is overfulfilled by
3493	implementations implementing IEEE 754 (basically all existing ones).	5232	implementations using IEEE 754, which is basically all existing ones.
		5233
		5234	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5235	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5236	is either obsolete or somebody patched it to use C<long double> or
		5237	something like that, just kidding).
3494		5238
3495	=back	5239	=back
3496		5240
3497	If you know of other additional requirements drop me a note.	5241	If you know of other additional requirements drop me a note.
3498		5242
3499		5243
3500	=head1 COMPILER WARNINGS	5244	=head1 ALGORITHMIC COMPLEXITIES
3501		5245
3502	Depending on your compiler and compiler settings, you might get no or a	5246	In this section the complexities of (many of) the algorithms used inside
3503	lot of warnings when compiling libev code. Some people are apparently	5247	libev will be documented. For complexity discussions about backends see
3504	scared by this.	5248	the documentation for C<ev_default_init>.
3505		5249
3506	However, these are unavoidable for many reasons. For one, each compiler	5250	All of the following are about amortised time: If an array needs to be
3507	has different warnings, and each user has different tastes regarding	5251	extended, libev needs to realloc and move the whole array, but this
3508	warning options. "Warn-free" code therefore cannot be a goal except when	5252	happens asymptotically rarer with higher number of elements, so O(1) might
3509	targeting a specific compiler and compiler-version.	5253	mean that libev does a lengthy realloc operation in rare cases, but on
		5254	average it is much faster and asymptotically approaches constant time.
3510		5255
3511	Another reason is that some compiler warnings require elaborate	5256	=over 4
3512	workarounds, or other changes to the code that make it less clear and less
3513	maintainable.
3514		5257
3515	And of course, some compiler warnings are just plain stupid, or simply	5258	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
3516	wrong (because they don't actually warn about the condition their message
3517	seems to warn about).
3518		5259
3519	While libev is written to generate as few warnings as possible,	5260	This means that, when you have a watcher that triggers in one hour and
3520	"warn-free" code is not a goal, and it is recommended not to build libev	5261	there are 100 watchers that would trigger before that, then inserting will
3521	with any compiler warnings enabled unless you are prepared to cope with	5262	have to skip roughly seven (C<ld 100>) of these watchers.
3522	them (e.g. by ignoring them). Remember that warnings are just that:
3523	warnings, not errors, or proof of bugs.
3524		5263
		5264	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
3525		5265
3526	=head1 VALGRIND	5266	That means that changing a timer costs less than removing/adding them,
		5267	as only the relative motion in the event queue has to be paid for.
3527		5268
3528	Valgrind has a special section here because it is a popular tool that is	5269	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
3529	highly useful, but valgrind reports are very hard to interpret.
3530		5270
3531	If you think you found a bug (memory leak, uninitialised data access etc.)	5271	These just add the watcher into an array or at the head of a list.
3532	in libev, then check twice: If valgrind reports something like:
3533		5272
3534	==2274== definitely lost: 0 bytes in 0 blocks.	5273	=item Stopping check/prepare/idle/fork/async watchers: O(1)
3535	==2274== possibly lost: 0 bytes in 0 blocks.
3536	==2274== still reachable: 256 bytes in 1 blocks.
3537		5274
3538	Then there is no memory leak. Similarly, under some circumstances,	5275	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
3539	valgrind might report kernel bugs as if it were a bug in libev, or it
3540	might be confused (it is a very good tool, but only a tool).
3541		5276
3542	If you are unsure about something, feel free to contact the mailing list	5277	These watchers are stored in lists, so they need to be walked to find the
3543	with the full valgrind report and an explanation on why you think this is	5278	correct watcher to remove. The lists are usually short (you don't usually
3544	a bug in libev. However, don't be annoyed when you get a brisk "this is	5279	have many watchers waiting for the same fd or signal: one is typical, two
3545	no bug" answer and take the chance of learning how to interpret valgrind	5280	is rare).
3546	properly.
3547		5281
3548	If you need, for some reason, empty reports from valgrind for your project	5282	=item Finding the next timer in each loop iteration: O(1)
3549	I suggest using suppression lists.
3550		5283
		5284	By virtue of using a binary or 4-heap, the next timer is always found at a
		5285	fixed position in the storage array.
		5286
		5287	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		5288
		5289	A change means an I/O watcher gets started or stopped, which requires
		5290	libev to recalculate its status (and possibly tell the kernel, depending
		5291	on backend and whether C<ev_io_set> was used).
		5292
		5293	=item Activating one watcher (putting it into the pending state): O(1)
		5294
		5295	=item Priority handling: O(number_of_priorities)
		5296
		5297	Priorities are implemented by allocating some space for each
		5298	priority. When doing priority-based operations, libev usually has to
		5299	linearly search all the priorities, but starting/stopping and activating
		5300	watchers becomes O(1) with respect to priority handling.
		5301
		5302	=item Sending an ev_async: O(1)
		5303
		5304	=item Processing ev_async_send: O(number_of_async_watchers)
		5305
		5306	=item Processing signals: O(max_signal_number)
		5307
		5308	Sending involves a system call I<iff> there were no other C<ev_async_send>
		5309	calls in the current loop iteration and the loop is currently
		5310	blocked. Checking for async and signal events involves iterating over all
		5311	running async watchers or all signal numbers.
		5312
		5313	=back
		5314
		5315
		5316	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5317
		5318	The major version 4 introduced some incompatible changes to the API.
		5319
		5320	At the moment, the C<ev.h> header file provides compatibility definitions
		5321	for all changes, so most programs should still compile. The compatibility
		5322	layer might be removed in later versions of libev, so better update to the
		5323	new API early than late.
		5324
		5325	=over 4
		5326
		5327	=item C<EV_COMPAT3> backwards compatibility mechanism
		5328
		5329	The backward compatibility mechanism can be controlled by
		5330	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5331	section.
		5332
		5333	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5334
		5335	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5336
		5337	ev_loop_destroy (EV_DEFAULT_UC);
		5338	ev_loop_fork (EV_DEFAULT);
		5339
		5340	=item function/symbol renames
		5341
		5342	A number of functions and symbols have been renamed:
		5343
		5344	ev_loop => ev_run
		5345	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5346	EVLOOP_ONESHOT => EVRUN_ONCE
		5347
		5348	ev_unloop => ev_break
		5349	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5350	EVUNLOOP_ONE => EVBREAK_ONE
		5351	EVUNLOOP_ALL => EVBREAK_ALL
		5352
		5353	EV_TIMEOUT => EV_TIMER
		5354
		5355	ev_loop_count => ev_iteration
		5356	ev_loop_depth => ev_depth
		5357	ev_loop_verify => ev_verify
		5358
		5359	Most functions working on C<struct ev_loop> objects don't have an
		5360	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5361	associated constants have been renamed to not collide with the C<struct
		5362	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5363	as all other watcher types. Note that C<ev_loop_fork> is still called
		5364	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5365	typedef.
		5366
		5367	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5368
		5369	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5370	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5371	and work, but the library code will of course be larger.
		5372
		5373	=back
		5374
		5375
		5376	=head1 GLOSSARY
		5377
		5378	=over 4
		5379
		5380	=item active
		5381
		5382	A watcher is active as long as it has been started and not yet stopped.
		5383	See L<WATCHER STATES> for details.
		5384
		5385	=item application
		5386
		5387	In this document, an application is whatever is using libev.
		5388
		5389	=item backend
		5390
		5391	The part of the code dealing with the operating system interfaces.
		5392
		5393	=item callback
		5394
		5395	The address of a function that is called when some event has been
		5396	detected. Callbacks are being passed the event loop, the watcher that
		5397	received the event, and the actual event bitset.
		5398
		5399	=item callback/watcher invocation
		5400
		5401	The act of calling the callback associated with a watcher.
		5402
		5403	=item event
		5404
		5405	A change of state of some external event, such as data now being available
		5406	for reading on a file descriptor, time having passed or simply not having
		5407	any other events happening anymore.
		5408
		5409	In libev, events are represented as single bits (such as C<EV_READ> or
		5410	C<EV_TIMER>).
		5411
		5412	=item event library
		5413
		5414	A software package implementing an event model and loop.
		5415
		5416	=item event loop
		5417
		5418	An entity that handles and processes external events and converts them
		5419	into callback invocations.
		5420
		5421	=item event model
		5422
		5423	The model used to describe how an event loop handles and processes
		5424	watchers and events.
		5425
		5426	=item pending
		5427
		5428	A watcher is pending as soon as the corresponding event has been
		5429	detected. See L<WATCHER STATES> for details.
		5430
		5431	=item real time
		5432
		5433	The physical time that is observed. It is apparently strictly monotonic :)
		5434
		5435	=item wall-clock time
		5436
		5437	The time and date as shown on clocks. Unlike real time, it can actually
		5438	be wrong and jump forwards and backwards, e.g. when you adjust your
		5439	clock.
		5440
		5441	=item watcher
		5442
		5443	A data structure that describes interest in certain events. Watchers need
		5444	to be started (attached to an event loop) before they can receive events.
		5445
		5446	=back
3551		5447
3552	=head1 AUTHOR	5448	=head1 AUTHOR
3553		5449
3554	Marc Lehmann <libev@schmorp.de>.	5450	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5451	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
3555		5452

Diff Legend

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