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.375 by root, Mon Jun 13 09:52:36 2011 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_update_now> 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 (but
419	drops fds silently in similarly hard-to-detect cases.	573	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		574	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 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, an 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
599	Please note that an explicit C<ev_unloop> is usually better than	809	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	810	relying on all watchers to be stopped when deciding when a program has
601	finished (especially in interactive programs), but having a program that	811	finished (especially in interactive programs), but having a program
602	automatically loops as long as it has to and no longer by virtue of	812	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.	813	of relying on its watchers stopping correctly, that is truly a thing of
		814	beauty.
604		815
		816	This function is also I<mostly> exception-safe - you can break out of
		817	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		818	exception and so on. This does not decrement the C<ev_depth> value, nor
		819	will it clear any outstanding C<EVBREAK_ONE> breaks.
		820
605	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	821	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	822	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.	823	block your process in case there are no events and will return after one
		824	iteration of the loop. This is sometimes useful to poll and handle new
		825	events while doing lengthy calculations, to keep the program responsive.
608		826
609	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	827	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	828	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	829	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	830	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	831	user-registered callback will be called), and will return after one
		832	iteration of the loop.
		833
		834	This is useful if you are waiting for some external event in conjunction
		835	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	836	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.	837	usually a better approach for this kind of thing.
616		838
617	Here are the gory details of what C<ev_loop> does:	839	Here are the gory details of what C<ev_run> does (this is for your
		840	understanding, not a guarantee that things will work exactly like this in
		841	future versions):
618		842
		843	- Increment loop depth.
		844	- Reset the ev_break status.
619	- Before the first iteration, call any pending watchers.	845	- Before the first iteration, call any pending watchers.
		846	LOOP:
620	* If EVFLAG_FORKCHECK was used, check for a fork.	847	- If EVFLAG_FORKCHECK was used, check for a fork.
621	- If a fork was detected (by any means), queue and call all fork watchers.	848	- If a fork was detected (by any means), queue and call all fork watchers.
622	- Queue and call all prepare watchers.	849	- Queue and call all prepare watchers.
		850	- If ev_break was called, goto FINISH.
623	- If we have been forked, detach and recreate the kernel state	851	- If we have been forked, detach and recreate the kernel state
624	as to not disturb the other process.	852	as to not disturb the other process.
625	- Update the kernel state with all outstanding changes.	853	- Update the kernel state with all outstanding changes.
626	- Update the "event loop time" (ev_now ()).	854	- Update the "event loop time" (ev_now ()).
627	- Calculate for how long to sleep or block, if at all	855	- Calculate for how long to sleep or block, if at all
628	(active idle watchers, EVLOOP_NONBLOCK or not having	856	(active idle watchers, EVRUN_NOWAIT or not having
629	any active watchers at all will result in not sleeping).	857	any active watchers at all will result in not sleeping).
630	- Sleep if the I/O and timer collect interval say so.	858	- Sleep if the I/O and timer collect interval say so.
		859	- Increment loop iteration counter.
631	- Block the process, waiting for any events.	860	- Block the process, waiting for any events.
632	- Queue all outstanding I/O (fd) events.	861	- Queue all outstanding I/O (fd) events.
633	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	862	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
634	- Queue all outstanding timers.	863	- Queue all expired timers.
635	- Queue all outstanding periodics.	864	- Queue all expired periodics.
636	- Unless any events are pending now, queue all idle watchers.	865	- Queue all idle watchers with priority higher than that of pending events.
637	- Queue all check watchers.	866	- Queue all check watchers.
638	- Call all queued watchers in reverse order (i.e. check watchers first).	867	- 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	868	Signals and child watchers are implemented as I/O watchers, and will
640	be handled here by queueing them when their watcher gets executed.	869	be handled here by queueing them when their watcher gets executed.
641	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	870	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
642	were used, or there are no active watchers, return, otherwise	871	were used, or there are no active watchers, goto FINISH, otherwise
643	continue with step *.	872	continue with step LOOP.
		873	FINISH:
		874	- Reset the ev_break status iff it was EVBREAK_ONE.
		875	- Decrement the loop depth.
		876	- Return.
644		877
645	Example: Queue some jobs and then loop until no events are outstanding	878	Example: Queue some jobs and then loop until no events are outstanding
646	anymore.	879	anymore.
647		880
648	... queue jobs here, make sure they register event watchers as long	881	... 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..)	882	... as they still have work to do (even an idle watcher will do..)
650	ev_loop (my_loop, 0);	883	ev_run (my_loop, 0);
651	... jobs done or somebody called unloop. yeah!	884	... jobs done or somebody called break. yeah!
652		885
653	=item ev_unloop (loop, how)	886	=item ev_break (loop, how)
654		887
655	Can be used to make a call to C<ev_loop> return early (but only after it	888	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	889	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	890	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.	891	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
659		892
660	This "unloop state" will be cleared when entering C<ev_loop> again.	893	This "break state" will be cleared on the next call to C<ev_run>.
		894
		895	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		896	which case it will have no effect.
661		897
662	=item ev_ref (loop)	898	=item ev_ref (loop)
663		899
664	=item ev_unref (loop)	900	=item ev_unref (loop)
665		901
666	Ref/unref can be used to add or remove a reference count on the event	902	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	903	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	904	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	905
670	returning, ev_unref() after starting, and ev_ref() before stopping it. For	906	This is useful when you have a watcher that you never intend to
		907	unregister, but that nevertheless should not keep C<ev_run> from
		908	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
		909	before stopping it.
		910
671	example, libev itself uses this for its internal signal pipe: It is not	911	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	912	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	913	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	914	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>	915	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,	916	before stop> (but only if the watcher wasn't active before, or was active
677	respectively).	917	before, respectively. Note also that libev might stop watchers itself
		918	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		919	in the callback).
678		920
679	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	921	Example: Create a signal watcher, but keep it from keeping C<ev_run>
680	running when nothing else is active.	922	running when nothing else is active.
681		923
682	struct ev_signal exitsig;	924	ev_signal exitsig;
683	ev_signal_init (&exitsig, sig_cb, SIGINT);	925	ev_signal_init (&exitsig, sig_cb, SIGINT);
684	ev_signal_start (loop, &exitsig);	926	ev_signal_start (loop, &exitsig);
685	evf_unref (loop);	927	ev_unref (loop);
686		928
687	Example: For some weird reason, unregister the above signal handler again.	929	Example: For some weird reason, unregister the above signal handler again.
688		930
689	ev_ref (loop);	931	ev_ref (loop);
690	ev_signal_stop (loop, &exitsig);	932	ev_signal_stop (loop, &exitsig);
…		…
701	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	943	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	944	allows libev to delay invocation of I/O and timer/periodic callbacks
703	to increase efficiency of loop iterations (or to increase power-saving	945	to increase efficiency of loop iterations (or to increase power-saving
704	opportunities).	946	opportunities).
705		947
706	The background is that sometimes your program runs just fast enough to	948	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	949	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	950	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	951	events, especially with backends like C<select ()> which have a high
710	overhead for the actual polling but can deliver many events at once.	952	overhead for the actual polling but can deliver many events at once.
711		953
712	By setting a higher I<io collect interval> you allow libev to spend more	954	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,	955	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	956	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	957	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.	958	introduce an additional C<ev_sleep ()> call into most loop iterations. The
		959	sleep time ensures that libev will not poll for I/O events more often then
		960	once per this interval, on average (as long as the host time resolution is
		961	good enough).
717		962
718	Likewise, by setting a higher I<timeout collect interval> you allow libev	963	Likewise, by setting a higher I<timeout collect interval> you allow libev
719	to spend more time collecting timeouts, at the expense of increased	964	to spend more time collecting timeouts, at the expense of increased
720	latency (the watcher callback will be called later). C<ev_io> watchers	965	latency/jitter/inexactness (the watcher callback will be called
721	will not be affected. Setting this to a non-null value will not introduce	966	later). C<ev_io> watchers will not be affected. Setting this to a non-null
722	any overhead in libev.	967	value will not introduce any overhead in libev.
723		968
724	Many (busy) programs can usually benefit by setting the I/O collect	969	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	970	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	971	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>,	972	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.	973	as this approaches the timing granularity of most systems. Note that if
		974	you do transactions with the outside world and you can't increase the
		975	parallelity, then this setting will limit your transaction rate (if you
		976	need to poll once per transaction and the I/O collect interval is 0.01,
		977	then you can't do more than 100 transactions per second).
729		978
730	Setting the I<timeout collect interval> can improve the opportunity for	979	Setting the I<timeout collect interval> can improve the opportunity for
731	saving power, as the program will "bundle" timer callback invocations that	980	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	981	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	982	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	983	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
735	they fire on, say, one-second boundaries only.	984	they fire on, say, one-second boundaries only.
736		985
		986	Example: we only need 0.1s timeout granularity, and we wish not to poll
		987	more often than 100 times per second:
		988
		989	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
		990	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
		991
		992	=item ev_invoke_pending (loop)
		993
		994	This call will simply invoke all pending watchers while resetting their
		995	pending state. Normally, C<ev_run> does this automatically when required,
		996	but when overriding the invoke callback this call comes handy. This
		997	function can be invoked from a watcher - this can be useful for example
		998	when you want to do some lengthy calculation and want to pass further
		999	event handling to another thread (you still have to make sure only one
		1000	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
		1001
		1002	=item int ev_pending_count (loop)
		1003
		1004	Returns the number of pending watchers - zero indicates that no watchers
		1005	are pending.
		1006
		1007	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
		1008
		1009	This overrides the invoke pending functionality of the loop: Instead of
		1010	invoking all pending watchers when there are any, C<ev_run> will call
		1011	this callback instead. This is useful, for example, when you want to
		1012	invoke the actual watchers inside another context (another thread etc.).
		1013
		1014	If you want to reset the callback, use C<ev_invoke_pending> as new
		1015	callback.
		1016
		1017	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
		1018
		1019	Sometimes you want to share the same loop between multiple threads. This
		1020	can be done relatively simply by putting mutex_lock/unlock calls around
		1021	each call to a libev function.
		1022
		1023	However, C<ev_run> can run an indefinite time, so it is not feasible
		1024	to wait for it to return. One way around this is to wake up the event
		1025	loop via C<ev_break> and C<av_async_send>, another way is to set these
		1026	I<release> and I<acquire> callbacks on the loop.
		1027
		1028	When set, then C<release> will be called just before the thread is
		1029	suspended waiting for new events, and C<acquire> is called just
		1030	afterwards.
		1031
		1032	Ideally, C<release> will just call your mutex_unlock function, and
		1033	C<acquire> will just call the mutex_lock function again.
		1034
		1035	While event loop modifications are allowed between invocations of
		1036	C<release> and C<acquire> (that's their only purpose after all), no
		1037	modifications done will affect the event loop, i.e. adding watchers will
		1038	have no effect on the set of file descriptors being watched, or the time
		1039	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
		1040	to take note of any changes you made.
		1041
		1042	In theory, threads executing C<ev_run> will be async-cancel safe between
		1043	invocations of C<release> and C<acquire>.
		1044
		1045	See also the locking example in the C<THREADS> section later in this
		1046	document.
		1047
		1048	=item ev_set_userdata (loop, void *data)
		1049
		1050	=item void *ev_userdata (loop)
		1051
		1052	Set and retrieve a single C<void *> associated with a loop. When
		1053	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
		1054	C<0>.
		1055
		1056	These two functions can be used to associate arbitrary data with a loop,
		1057	and are intended solely for the C<invoke_pending_cb>, C<release> and
		1058	C<acquire> callbacks described above, but of course can be (ab-)used for
		1059	any other purpose as well.
		1060
737	=item ev_loop_verify (loop)	1061	=item ev_verify (loop)
738		1062
739	This function only does something when C<EV_VERIFY> support has been	1063	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	1064	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	1065	through all internal structures and checks them for validity. If anything
742	an error message to standard error and call C<abort ()>.	1066	is found to be inconsistent, it will print an error message to standard
		1067	error and call C<abort ()>.
743		1068
744	This can be used to catch bugs inside libev itself: under normal	1069	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	1070	circumstances, this function will never abort as of course libev keeps its
746	data structures consistent.	1071	data structures consistent.
747		1072
748	=back	1073	=back
749		1074
750		1075
751	=head1 ANATOMY OF A WATCHER	1076	=head1 ANATOMY OF A WATCHER
752		1077
		1078	In the following description, uppercase C<TYPE> in names stands for the
		1079	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		1080	watchers and C<ev_io_start> for I/O watchers.
		1081
753	A watcher is a structure that you create and register to record your	1082	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	1083	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:	1084	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1085	for that:
756		1086
757	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1087	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
758	{	1088	{
759	ev_io_stop (w);	1089	ev_io_stop (w);
760	ev_unloop (loop, EVUNLOOP_ALL);	1090	ev_break (loop, EVBREAK_ALL);
761	}	1091	}
762		1092
763	struct ev_loop *loop = ev_default_loop (0);	1093	struct ev_loop *loop = ev_default_loop (0);
		1094
764	struct ev_io stdin_watcher;	1095	ev_io stdin_watcher;
		1096
765	ev_init (&stdin_watcher, my_cb);	1097	ev_init (&stdin_watcher, my_cb);
766	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1098	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
767	ev_io_start (loop, &stdin_watcher);	1099	ev_io_start (loop, &stdin_watcher);
		1100
768	ev_loop (loop, 0);	1101	ev_run (loop, 0);
769		1102
770	As you can see, you are responsible for allocating the memory for your	1103	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,	1104	watcher structures (and it is I<usually> a bad idea to do this on the
772	although this can sometimes be quite valid).	1105	stack).
773		1106
		1107	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		1108	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
		1109
774	Each watcher structure must be initialised by a call to C<ev_init	1110	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	1111	*, 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	1112	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	1113	time the event loop detects that the file descriptor given is readable
778	is readable and/or writable).	1114	and/or writable).
779		1115
780	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	1116	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	1117	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	1118	is also a macro to combine initialisation and setting in one call: C<<
783	(watcher *, callback, ...) >>.	1119	ev_TYPE_init (watcher *, callback, ...) >>.
784		1120
785	To make the watcher actually watch out for events, you have to start it	1121	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	1122	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	1123	*) >>), and you can stop watching for events at any time by calling the
788	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	1124	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
789		1125
790	As long as your watcher is active (has been started but not stopped) you	1126	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	1127	must not touch the values stored in it. Most specifically you must never
792	reinitialise it or call its C<set> macro.	1128	reinitialise it or call its C<ev_TYPE_set> macro.
793		1129
794	Each and every callback receives the event loop pointer as first, the	1130	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	1131	registered watcher structure as second, and a bitset of received events as
796	third argument.	1132	third argument.
797		1133
…		…
806	=item C<EV_WRITE>	1142	=item C<EV_WRITE>
807		1143
808	The file descriptor in the C<ev_io> watcher has become readable and/or	1144	The file descriptor in the C<ev_io> watcher has become readable and/or
809	writable.	1145	writable.
810		1146
811	=item C<EV_TIMEOUT>	1147	=item C<EV_TIMER>
812		1148
813	The C<ev_timer> watcher has timed out.	1149	The C<ev_timer> watcher has timed out.
814		1150
815	=item C<EV_PERIODIC>	1151	=item C<EV_PERIODIC>
816		1152
…		…
834		1170
835	=item C<EV_PREPARE>	1171	=item C<EV_PREPARE>
836		1172
837	=item C<EV_CHECK>	1173	=item C<EV_CHECK>
838		1174
839	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1175	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	1176	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	1177	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	1178	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	1179	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	1180	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
845	C<ev_loop> from blocking).	1181	C<ev_run> from blocking).
846		1182
847	=item C<EV_EMBED>	1183	=item C<EV_EMBED>
848		1184
849	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1185	The embedded event loop specified in the C<ev_embed> watcher needs attention.
850		1186
851	=item C<EV_FORK>	1187	=item C<EV_FORK>
852		1188
853	The event loop has been resumed in the child process after fork (see	1189	The event loop has been resumed in the child process after fork (see
854	C<ev_fork>).	1190	C<ev_fork>).
855		1191
		1192	=item C<EV_CLEANUP>
		1193
		1194	The event loop is about to be destroyed (see C<ev_cleanup>).
		1195
856	=item C<EV_ASYNC>	1196	=item C<EV_ASYNC>
857		1197
858	The given async watcher has been asynchronously notified (see C<ev_async>).	1198	The given async watcher has been asynchronously notified (see C<ev_async>).
		1199
		1200	=item C<EV_CUSTOM>
		1201
		1202	Not ever sent (or otherwise used) by libev itself, but can be freely used
		1203	by libev users to signal watchers (e.g. via C<ev_feed_event>).
859		1204
860	=item C<EV_ERROR>	1205	=item C<EV_ERROR>
861		1206
862	An unspecified error has occurred, the watcher has been stopped. This might	1207	An unspecified error has occurred, the watcher has been stopped. This might
863	happen because the watcher could not be properly started because libev	1208	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	1209	ran out of memory, a file descriptor was found to be closed or any other
		1210	problem. Libev considers these application bugs.
		1211
865	problem. You best act on it by reporting the problem and somehow coping	1212	You best act on it by reporting the problem and somehow coping with the
866	with the watcher being stopped.	1213	watcher being stopped. Note that well-written programs should not receive
		1214	an error ever, so when your watcher receives it, this usually indicates a
		1215	bug in your program.
867		1216
868	Libev will usually signal a few "dummy" events together with an error,	1217	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	1218	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	1219	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	1220	the error from read() or write(). This will not work in multi-threaded
872	programs, though, so beware.	1221	programs, though, as the fd could already be closed and reused for another
		1222	thing, so beware.
873		1223
874	=back	1224	=back
875		1225
876	=head2 GENERIC WATCHER FUNCTIONS	1226	=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		1227
881	=over 4	1228	=over 4
882		1229
883	=item C<ev_init> (ev_TYPE *watcher, callback)	1230	=item C<ev_init> (ev_TYPE *watcher, callback)
884		1231
…		…
890	which rolls both calls into one.	1237	which rolls both calls into one.
891		1238
892	You can reinitialise a watcher at any time as long as it has been stopped	1239	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.	1240	(or never started) and there are no pending events outstanding.
894		1241
895	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	1242	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
896	int revents)>.	1243	int revents)>.
897		1244
		1245	Example: Initialise an C<ev_io> watcher in two steps.
		1246
		1247	ev_io w;
		1248	ev_init (&w, my_cb);
		1249	ev_io_set (&w, STDIN_FILENO, EV_READ);
		1250
898	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1251	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
899		1252
900	This macro initialises the type-specific parts of a watcher. You need to	1253	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	1254	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	1255	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	1256	macro on a watcher that is active (it can be pending, however, which is a
904	difference to the C<ev_init> macro).	1257	difference to the C<ev_init> macro).
905		1258
906	Although some watcher types do not have type-specific arguments	1259	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.	1260	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
908		1261
		1262	See C<ev_init>, above, for an example.
		1263
909	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	1264	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
910		1265
911	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	1266	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	1267	calls into a single call. This is the most convenient method to initialise
913	a watcher. The same limitations apply, of course.	1268	a watcher. The same limitations apply, of course.
914		1269
		1270	Example: Initialise and set an C<ev_io> watcher in one step.
		1271
		1272	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
		1273
915	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1274	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
916		1275
917	Starts (activates) the given watcher. Only active watchers will receive	1276	Starts (activates) the given watcher. Only active watchers will receive
918	events. If the watcher is already active nothing will happen.	1277	events. If the watcher is already active nothing will happen.
919		1278
		1279	Example: Start the C<ev_io> watcher that is being abused as example in this
		1280	whole section.
		1281
		1282	ev_io_start (EV_DEFAULT_UC, &w);
		1283
920	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1284	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
921		1285
922	Stops the given watcher again (if active) and clears the pending	1286	Stops the given watcher if active, and clears the pending status (whether
		1287	the watcher was active or not).
		1288
923	status. It is possible that stopped watchers are pending (for example,	1289	It is possible that stopped watchers are pending - for example,
924	non-repeating timers are being stopped when they become pending), but	1290	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	1291	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	1292	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.	1293	therefore a good idea to always call its C<ev_TYPE_stop> function.
928		1294
929	=item bool ev_is_active (ev_TYPE *watcher)	1295	=item bool ev_is_active (ev_TYPE *watcher)
930		1296
931	Returns a true value iff the watcher is active (i.e. it has been started	1297	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	1298	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)	1314	=item ev_cb_set (ev_TYPE *watcher, callback)
949		1315
950	Change the callback. You can change the callback at virtually any time	1316	Change the callback. You can change the callback at virtually any time
951	(modulo threads).	1317	(modulo threads).
952		1318
953	=item ev_set_priority (ev_TYPE *watcher, priority)	1319	=item ev_set_priority (ev_TYPE *watcher, int priority)
954		1320
955	=item int ev_priority (ev_TYPE *watcher)	1321	=item int ev_priority (ev_TYPE *watcher)
956		1322
957	Set and query the priority of the watcher. The priority is a small	1323	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>	1324	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
959	(default: C<-2>). Pending watchers with higher priority will be invoked	1325	(default: C<-2>). Pending watchers with higher priority will be invoked
960	before watchers with lower priority, but priority will not keep watchers	1326	before watchers with lower priority, but priority will not keep watchers
961	from being executed (except for C<ev_idle> watchers).	1327	from being executed (except for C<ev_idle> watchers).
962		1328
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	1329	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.	1330	you need to look at C<ev_idle> watchers, which provide this functionality.
970		1331
971	You I<must not> change the priority of a watcher as long as it is active or	1332	You I<must not> change the priority of a watcher as long as it is active or
972	pending.	1333	pending.
973		1334
		1335	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1336	fine, as long as you do not mind that the priority value you query might
		1337	or might not have been clamped to the valid range.
		1338
974	The default priority used by watchers when no priority has been set is	1339	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 :).	1340	always C<0>, which is supposed to not be too high and not be too low :).
976		1341
977	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1342	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	1343	priorities.
979	or might not have been adjusted to be within valid range.
980		1344
981	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1345	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
982		1346
983	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1347	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	1348	C<loop> nor C<revents> need to be valid as long as the watcher callback
985	can deal with that fact.	1349	can deal with that fact, as both are simply passed through to the
		1350	callback.
986		1351
987	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1352	=item int ev_clear_pending (loop, ev_TYPE *watcher)
988		1353
989	If the watcher is pending, this function returns clears its pending status	1354	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	1355	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>.	1356	watcher isn't pending it does nothing and returns C<0>.
992		1357
		1358	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1359	callback to be invoked, which can be accomplished with this function.
		1360
		1361	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1362
		1363	Feeds the given event set into the event loop, as if the specified event
		1364	had happened for the specified watcher (which must be a pointer to an
		1365	initialised but not necessarily started event watcher). Obviously you must
		1366	not free the watcher as long as it has pending events.
		1367
		1368	Stopping the watcher, letting libev invoke it, or calling
		1369	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1370	not started in the first place.
		1371
		1372	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1373	functions that do not need a watcher.
		1374
993	=back	1375	=back
994		1376
		1377	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1378	OWN COMPOSITE WATCHERS> idioms.
995		1379
996	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1380	=head2 WATCHER STATES
997		1381
998	Each watcher has, by default, a member C<void *data> that you can change	1382	There are various watcher states mentioned throughout this manual -
999	and read at any time, libev will completely ignore it. This can be used	1383	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	1384	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	1385	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		1386
1005	struct my_io	1387	=over 4
		1388
		1389	=item initialiased
		1390
		1391	Before a watcher can be registered with the event loop it has to be
		1392	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1393	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1394
		1395	In this state it is simply some block of memory that is suitable for
		1396	use in an event loop. It can be moved around, freed, reused etc. at
		1397	will - as long as you either keep the memory contents intact, or call
		1398	C<ev_TYPE_init> again.
		1399
		1400	=item started/running/active
		1401
		1402	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1403	property of the event loop, and is actively waiting for events. While in
		1404	this state it cannot be accessed (except in a few documented ways), moved,
		1405	freed or anything else - the only legal thing is to keep a pointer to it,
		1406	and call libev functions on it that are documented to work on active watchers.
		1407
		1408	=item pending
		1409
		1410	If a watcher is active and libev determines that an event it is interested
		1411	in has occurred (such as a timer expiring), it will become pending. It will
		1412	stay in this pending state until either it is stopped or its callback is
		1413	about to be invoked, so it is not normally pending inside the watcher
		1414	callback.
		1415
		1416	The watcher might or might not be active while it is pending (for example,
		1417	an expired non-repeating timer can be pending but no longer active). If it
		1418	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1419	but it is still property of the event loop at this time, so cannot be
		1420	moved, freed or reused. And if it is active the rules described in the
		1421	previous item still apply.
		1422
		1423	It is also possible to feed an event on a watcher that is not active (e.g.
		1424	via C<ev_feed_event>), in which case it becomes pending without being
		1425	active.
		1426
		1427	=item stopped
		1428
		1429	A watcher can be stopped implicitly by libev (in which case it might still
		1430	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1431	latter will clear any pending state the watcher might be in, regardless
		1432	of whether it was active or not, so stopping a watcher explicitly before
		1433	freeing it is often a good idea.
		1434
		1435	While stopped (and not pending) the watcher is essentially in the
		1436	initialised state, that is, it can be reused, moved, modified in any way
		1437	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1438	it again).
		1439
		1440	=back
		1441
		1442	=head2 WATCHER PRIORITY MODELS
		1443
		1444	Many event loops support I<watcher priorities>, which are usually small
		1445	integers that influence the ordering of event callback invocation
		1446	between watchers in some way, all else being equal.
		1447
		1448	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1449	description for the more technical details such as the actual priority
		1450	range.
		1451
		1452	There are two common ways how these these priorities are being interpreted
		1453	by event loops:
		1454
		1455	In the more common lock-out model, higher priorities "lock out" invocation
		1456	of lower priority watchers, which means as long as higher priority
		1457	watchers receive events, lower priority watchers are not being invoked.
		1458
		1459	The less common only-for-ordering model uses priorities solely to order
		1460	callback invocation within a single event loop iteration: Higher priority
		1461	watchers are invoked before lower priority ones, but they all get invoked
		1462	before polling for new events.
		1463
		1464	Libev uses the second (only-for-ordering) model for all its watchers
		1465	except for idle watchers (which use the lock-out model).
		1466
		1467	The rationale behind this is that implementing the lock-out model for
		1468	watchers is not well supported by most kernel interfaces, and most event
		1469	libraries will just poll for the same events again and again as long as
		1470	their callbacks have not been executed, which is very inefficient in the
		1471	common case of one high-priority watcher locking out a mass of lower
		1472	priority ones.
		1473
		1474	Static (ordering) priorities are most useful when you have two or more
		1475	watchers handling the same resource: a typical usage example is having an
		1476	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1477	timeouts. Under load, data might be received while the program handles
		1478	other jobs, but since timers normally get invoked first, the timeout
		1479	handler will be executed before checking for data. In that case, giving
		1480	the timer a lower priority than the I/O watcher ensures that I/O will be
		1481	handled first even under adverse conditions (which is usually, but not
		1482	always, what you want).
		1483
		1484	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1485	will only be executed when no same or higher priority watchers have
		1486	received events, they can be used to implement the "lock-out" model when
		1487	required.
		1488
		1489	For example, to emulate how many other event libraries handle priorities,
		1490	you can associate an C<ev_idle> watcher to each such watcher, and in
		1491	the normal watcher callback, you just start the idle watcher. The real
		1492	processing is done in the idle watcher callback. This causes libev to
		1493	continuously poll and process kernel event data for the watcher, but when
		1494	the lock-out case is known to be rare (which in turn is rare :), this is
		1495	workable.
		1496
		1497	Usually, however, the lock-out model implemented that way will perform
		1498	miserably under the type of load it was designed to handle. In that case,
		1499	it might be preferable to stop the real watcher before starting the
		1500	idle watcher, so the kernel will not have to process the event in case
		1501	the actual processing will be delayed for considerable time.
		1502
		1503	Here is an example of an I/O watcher that should run at a strictly lower
		1504	priority than the default, and which should only process data when no
		1505	other events are pending:
		1506
		1507	ev_idle idle; // actual processing watcher
		1508	ev_io io; // actual event watcher
		1509
		1510	static void
		1511	io_cb (EV_P_ ev_io *w, int revents)
1006	{	1512	{
1007	struct ev_io io;	1513	// stop the I/O watcher, we received the event, but
1008	int otherfd;	1514	// are not yet ready to handle it.
1009	void *somedata;	1515	ev_io_stop (EV_A_ w);
1010	struct whatever *mostinteresting;	1516
		1517	// start the idle watcher to handle the actual event.
		1518	// it will not be executed as long as other watchers
		1519	// with the default priority are receiving events.
		1520	ev_idle_start (EV_A_ &idle);
1011	}	1521	}
1012		1522
1013	And since your callback will be called with a pointer to the watcher, you	1523	static void
1014	can cast it back to your own type:	1524	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	{	1525	{
1018	struct my_io *w = (struct my_io *)w_;	1526	// actual processing
1019	...	1527	read (STDIN_FILENO, ...);
		1528
		1529	// have to start the I/O watcher again, as
		1530	// we have handled the event
		1531	ev_io_start (EV_P_ &io);
1020	}	1532	}
1021		1533
1022	More interesting and less C-conformant ways of casting your callback type	1534	// initialisation
1023	instead have been omitted.	1535	ev_idle_init (&idle, idle_cb);
		1536	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1537	ev_io_start (EV_DEFAULT_ &io);
1024		1538
1025	Another common scenario is having some data structure with multiple	1539	In the "real" world, it might also be beneficial to start a timer, so that
1026	watchers:	1540	low-priority connections can not be locked out forever under load. This
1027		1541	enables your program to keep a lower latency for important connections
1028	struct my_biggy	1542	during short periods of high load, while not completely locking out less
1029	{	1543	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		1544
1054		1545
1055	=head1 WATCHER TYPES	1546	=head1 WATCHER TYPES
1056		1547
1057	This section describes each watcher in detail, but will not repeat	1548	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	1572	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	1573	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	1574	descriptors to non-blocking mode is also usually a good idea (but not
1084	required if you know what you are doing).	1575	required if you know what you are doing).
1085		1576
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	1577	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	1578	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	1579	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	1580	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	1581	with a relatively standard program structure. Thus it is best to always
1095	this situation even with a relatively standard program structure. Thus	1582	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.	1583	preferable to a program hanging until some data arrives.
1098		1584
1099	If you cannot run the fd in non-blocking mode (for example you should not	1585	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	1586	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	1587	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	1588	interface such as poll (fortunately in the case of Xlib, it already does
1103	its own, so its quite safe to use).	1589	this on its own, so its quite safe to use). Some people additionally
		1590	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1591	indefinitely.
		1592
		1593	But really, best use non-blocking mode.
1104		1594
1105	=head3 The special problem of disappearing file descriptors	1595	=head3 The special problem of disappearing file descriptors
1106		1596
1107	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1597	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,	1598	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	1599	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	1600	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	1601	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	1602	registered with libev, there is no efficient way to see that this is, in
1113	fact, a different file descriptor.	1603	fact, a different file descriptor.
1114		1604
…		…
1132		1622
1133	There is no workaround possible except not registering events	1623	There is no workaround possible except not registering events
1134	for potentially C<dup ()>'ed file descriptors, or to resort to	1624	for potentially C<dup ()>'ed file descriptors, or to resort to
1135	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1625	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1136		1626
		1627	=head3 The special problem of files
		1628
		1629	Many people try to use C<select> (or libev) on file descriptors
		1630	representing files, and expect it to become ready when their program
		1631	doesn't block on disk accesses (which can take a long time on their own).
		1632
		1633	However, this cannot ever work in the "expected" way - you get a readiness
		1634	notification as soon as the kernel knows whether and how much data is
		1635	there, and in the case of open files, that's always the case, so you
		1636	always get a readiness notification instantly, and your read (or possibly
		1637	write) will still block on the disk I/O.
		1638
		1639	Another way to view it is that in the case of sockets, pipes, character
		1640	devices and so on, there is another party (the sender) that delivers data
		1641	on its own, but in the case of files, there is no such thing: the disk
		1642	will not send data on its own, simply because it doesn't know what you
		1643	wish to read - you would first have to request some data.
		1644
		1645	Since files are typically not-so-well supported by advanced notification
		1646	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1647	to files, even though you should not use it. The reason for this is
		1648	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1649	usually a tty, often a pipe, but also sometimes files or special devices
		1650	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1651	F</dev/urandom>), and even though the file might better be served with
		1652	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1653	it "just works" instead of freezing.
		1654
		1655	So avoid file descriptors pointing to files when you know it (e.g. use
		1656	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1657	when you rarely read from a file instead of from a socket, and want to
		1658	reuse the same code path.
		1659
1137	=head3 The special problem of fork	1660	=head3 The special problem of fork
1138		1661
1139	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1662	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	1663	useless behaviour. Libev fully supports fork, but needs to be told about
1141	it in the child.	1664	it in the child if you want to continue to use it in the child.
1142		1665
1143	To support fork in your programs, you either have to call	1666	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,	1667	()> 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	1668	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1146	C<EVBACKEND_POLL>.
1147		1669
1148	=head3 The special problem of SIGPIPE	1670	=head3 The special problem of SIGPIPE
1149		1671
1150	While not really specific to libev, it is easy to forget about SIGPIPE:	1672	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	1673	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	1674	sent a SIGPIPE, which, by default, aborts your program. For most programs
1153	this is sensible behaviour, for daemons, this is usually undesirable.	1675	this is sensible behaviour, for daemons, this is usually undesirable.
1154		1676
1155	So when you encounter spurious, unexplained daemon exits, make sure you	1677	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	1678	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).	1679	somewhere, as that would have given you a big clue).
1158		1680
		1681	=head3 The special problem of accept()ing when you can't
		1682
		1683	Many implementations of the POSIX C<accept> function (for example,
		1684	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1685	connection from the pending queue in all error cases.
		1686
		1687	For example, larger servers often run out of file descriptors (because
		1688	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1689	rejecting the connection, leading to libev signalling readiness on
		1690	the next iteration again (the connection still exists after all), and
		1691	typically causing the program to loop at 100% CPU usage.
		1692
		1693	Unfortunately, the set of errors that cause this issue differs between
		1694	operating systems, there is usually little the app can do to remedy the
		1695	situation, and no known thread-safe method of removing the connection to
		1696	cope with overload is known (to me).
		1697
		1698	One of the easiest ways to handle this situation is to just ignore it
		1699	- when the program encounters an overload, it will just loop until the
		1700	situation is over. While this is a form of busy waiting, no OS offers an
		1701	event-based way to handle this situation, so it's the best one can do.
		1702
		1703	A better way to handle the situation is to log any errors other than
		1704	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1705	messages, and continue as usual, which at least gives the user an idea of
		1706	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1707	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1708	usage.
		1709
		1710	If your program is single-threaded, then you could also keep a dummy file
		1711	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1712	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1713	close that fd, and create a new dummy fd. This will gracefully refuse
		1714	clients under typical overload conditions.
		1715
		1716	The last way to handle it is to simply log the error and C<exit>, as
		1717	is often done with C<malloc> failures, but this results in an easy
		1718	opportunity for a DoS attack.
1159		1719
1160	=head3 Watcher-Specific Functions	1720	=head3 Watcher-Specific Functions
1161		1721
1162	=over 4	1722	=over 4
1163		1723
1164	=item ev_io_init (ev_io *, callback, int fd, int events)	1724	=item ev_io_init (ev_io *, callback, int fd, int events)
1165		1725
1166	=item ev_io_set (ev_io *, int fd, int events)	1726	=item ev_io_set (ev_io *, int fd, int events)
1167		1727
1168	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1728	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	1729	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.	1730	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1171		1731
1172	=item int fd [read-only]	1732	=item int fd [read-only]
1173		1733
1174	The file descriptor being watched.	1734	The file descriptor being watched.
1175		1735
…		…
1184	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1744	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	1745	readable, but only once. Since it is likely line-buffered, you could
1186	attempt to read a whole line in the callback.	1746	attempt to read a whole line in the callback.
1187		1747
1188	static void	1748	static void
1189	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1749	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1190	{	1750	{
1191	ev_io_stop (loop, w);	1751	ev_io_stop (loop, w);
1192	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1752	.. read from stdin here (or from w->fd) and handle any I/O errors
1193	}	1753	}
1194		1754
1195	...	1755	...
1196	struct ev_loop *loop = ev_default_init (0);	1756	struct ev_loop *loop = ev_default_init (0);
1197	struct ev_io stdin_readable;	1757	ev_io stdin_readable;
1198	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1758	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1199	ev_io_start (loop, &stdin_readable);	1759	ev_io_start (loop, &stdin_readable);
1200	ev_loop (loop, 0);	1760	ev_run (loop, 0);
1201		1761
1202		1762
1203	=head2 C<ev_timer> - relative and optionally repeating timeouts	1763	=head2 C<ev_timer> - relative and optionally repeating timeouts
1204		1764
1205	Timer watchers are simple relative timers that generate an event after a	1765	Timer watchers are simple relative timers that generate an event after a
1206	given time, and optionally repeating in regular intervals after that.	1766	given time, and optionally repeating in regular intervals after that.
1207		1767
1208	The timers are based on real time, that is, if you register an event that	1768	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	1769	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	1770	year, it will still time out after (roughly) one hour. "Roughly" because
1211	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1771	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1212	monotonic clock option helps a lot here).	1772	monotonic clock option helps a lot here).
1213		1773
1214	The callback is guaranteed to be invoked only after its timeout has passed,	1774	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	1775	passed (not I<at>, so on systems with very low-resolution clocks this
1216	order of execution is undefined.	1776	might introduce a small delay). If multiple timers become ready during the
		1777	same loop iteration then the ones with earlier time-out values are invoked
		1778	before ones of the same priority with later time-out values (but this is
		1779	no longer true when a callback calls C<ev_run> recursively).
		1780
		1781	=head3 Be smart about timeouts
		1782
		1783	Many real-world problems involve some kind of timeout, usually for error
		1784	recovery. A typical example is an HTTP request - if the other side hangs,
		1785	you want to raise some error after a while.
		1786
		1787	What follows are some ways to handle this problem, from obvious and
		1788	inefficient to smart and efficient.
		1789
		1790	In the following, a 60 second activity timeout is assumed - a timeout that
		1791	gets reset to 60 seconds each time there is activity (e.g. each time some
		1792	data or other life sign was received).
		1793
		1794	=over 4
		1795
		1796	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1797
		1798	This is the most obvious, but not the most simple way: In the beginning,
		1799	start the watcher:
		1800
		1801	ev_timer_init (timer, callback, 60., 0.);
		1802	ev_timer_start (loop, timer);
		1803
		1804	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1805	and start it again:
		1806
		1807	ev_timer_stop (loop, timer);
		1808	ev_timer_set (timer, 60., 0.);
		1809	ev_timer_start (loop, timer);
		1810
		1811	This is relatively simple to implement, but means that each time there is
		1812	some activity, libev will first have to remove the timer from its internal
		1813	data structure and then add it again. Libev tries to be fast, but it's
		1814	still not a constant-time operation.
		1815
		1816	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1817
		1818	This is the easiest way, and involves using C<ev_timer_again> instead of
		1819	C<ev_timer_start>.
		1820
		1821	To implement this, configure an C<ev_timer> with a C<repeat> value
		1822	of C<60> and then call C<ev_timer_again> at start and each time you
		1823	successfully read or write some data. If you go into an idle state where
		1824	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1825	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1826
		1827	That means you can ignore both the C<ev_timer_start> function and the
		1828	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1829	member and C<ev_timer_again>.
		1830
		1831	At start:
		1832
		1833	ev_init (timer, callback);
		1834	timer->repeat = 60.;
		1835	ev_timer_again (loop, timer);
		1836
		1837	Each time there is some activity:
		1838
		1839	ev_timer_again (loop, timer);
		1840
		1841	It is even possible to change the time-out on the fly, regardless of
		1842	whether the watcher is active or not:
		1843
		1844	timer->repeat = 30.;
		1845	ev_timer_again (loop, timer);
		1846
		1847	This is slightly more efficient then stopping/starting the timer each time
		1848	you want to modify its timeout value, as libev does not have to completely
		1849	remove and re-insert the timer from/into its internal data structure.
		1850
		1851	It is, however, even simpler than the "obvious" way to do it.
		1852
		1853	=item 3. Let the timer time out, but then re-arm it as required.
		1854
		1855	This method is more tricky, but usually most efficient: Most timeouts are
		1856	relatively long compared to the intervals between other activity - in
		1857	our example, within 60 seconds, there are usually many I/O events with
		1858	associated activity resets.
		1859
		1860	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1861	but remember the time of last activity, and check for a real timeout only
		1862	within the callback:
		1863
		1864	ev_tstamp last_activity; // time of last activity
		1865
		1866	static void
		1867	callback (EV_P_ ev_timer *w, int revents)
		1868	{
		1869	ev_tstamp now = ev_now (EV_A);
		1870	ev_tstamp timeout = last_activity + 60.;
		1871
		1872	// if last_activity + 60. is older than now, we did time out
		1873	if (timeout < now)
		1874	{
		1875	// timeout occurred, take action
		1876	}
		1877	else
		1878	{
		1879	// callback was invoked, but there was some activity, re-arm
		1880	// the watcher to fire in last_activity + 60, which is
		1881	// guaranteed to be in the future, so "again" is positive:
		1882	w->repeat = timeout - now;
		1883	ev_timer_again (EV_A_ w);
		1884	}
		1885	}
		1886
		1887	To summarise the callback: first calculate the real timeout (defined
		1888	as "60 seconds after the last activity"), then check if that time has
		1889	been reached, which means something I<did>, in fact, time out. Otherwise
		1890	the callback was invoked too early (C<timeout> is in the future), so
		1891	re-schedule the timer to fire at that future time, to see if maybe we have
		1892	a timeout then.
		1893
		1894	Note how C<ev_timer_again> is used, taking advantage of the
		1895	C<ev_timer_again> optimisation when the timer is already running.
		1896
		1897	This scheme causes more callback invocations (about one every 60 seconds
		1898	minus half the average time between activity), but virtually no calls to
		1899	libev to change the timeout.
		1900
		1901	To start the timer, simply initialise the watcher and set C<last_activity>
		1902	to the current time (meaning we just have some activity :), then call the
		1903	callback, which will "do the right thing" and start the timer:
		1904
		1905	ev_init (timer, callback);
		1906	last_activity = ev_now (loop);
		1907	callback (loop, timer, EV_TIMER);
		1908
		1909	And when there is some activity, simply store the current time in
		1910	C<last_activity>, no libev calls at all:
		1911
		1912	last_activity = ev_now (loop);
		1913
		1914	This technique is slightly more complex, but in most cases where the
		1915	time-out is unlikely to be triggered, much more efficient.
		1916
		1917	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1918	callback :) - just change the timeout and invoke the callback, which will
		1919	fix things for you.
		1920
		1921	=item 4. Wee, just use a double-linked list for your timeouts.
		1922
		1923	If there is not one request, but many thousands (millions...), all
		1924	employing some kind of timeout with the same timeout value, then one can
		1925	do even better:
		1926
		1927	When starting the timeout, calculate the timeout value and put the timeout
		1928	at the I<end> of the list.
		1929
		1930	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1931	the list is expected to fire (for example, using the technique #3).
		1932
		1933	When there is some activity, remove the timer from the list, recalculate
		1934	the timeout, append it to the end of the list again, and make sure to
		1935	update the C<ev_timer> if it was taken from the beginning of the list.
		1936
		1937	This way, one can manage an unlimited number of timeouts in O(1) time for
		1938	starting, stopping and updating the timers, at the expense of a major
		1939	complication, and having to use a constant timeout. The constant timeout
		1940	ensures that the list stays sorted.
		1941
		1942	=back
		1943
		1944	So which method the best?
		1945
		1946	Method #2 is a simple no-brain-required solution that is adequate in most
		1947	situations. Method #3 requires a bit more thinking, but handles many cases
		1948	better, and isn't very complicated either. In most case, choosing either
		1949	one is fine, with #3 being better in typical situations.
		1950
		1951	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1952	rather complicated, but extremely efficient, something that really pays
		1953	off after the first million or so of active timers, i.e. it's usually
		1954	overkill :)
1217		1955
1218	=head3 The special problem of time updates	1956	=head3 The special problem of time updates
1219		1957
1220	Establishing the current time is a costly operation (it usually takes at	1958	Establishing the current time is a costly operation (it usually takes at
1221	least two system calls): EV therefore updates its idea of the current	1959	least two system calls): EV therefore updates its idea of the current
1222	time only before and after C<ev_loop> polls for new events, which causes	1960	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	1961	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1224	lots of events.	1962	lots of events in one iteration.
1225		1963
1226	The relative timeouts are calculated relative to the C<ev_now ()>	1964	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	1965	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	1966	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	1967	you suspect event processing to be delayed and you I<need> to base the
…		…
1233		1971
1234	If the event loop is suspended for a long time, you can also force an	1972	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	1973	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1236	()>.	1974	()>.
1237		1975
		1976	=head3 The special problems of suspended animation
		1977
		1978	When you leave the server world it is quite customary to hit machines that
		1979	can suspend/hibernate - what happens to the clocks during such a suspend?
		1980
		1981	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		1982	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		1983	to run until the system is suspended, but they will not advance while the
		1984	system is suspended. That means, on resume, it will be as if the program
		1985	was frozen for a few seconds, but the suspend time will not be counted
		1986	towards C<ev_timer> when a monotonic clock source is used. The real time
		1987	clock advanced as expected, but if it is used as sole clocksource, then a
		1988	long suspend would be detected as a time jump by libev, and timers would
		1989	be adjusted accordingly.
		1990
		1991	I would not be surprised to see different behaviour in different between
		1992	operating systems, OS versions or even different hardware.
		1993
		1994	The other form of suspend (job control, or sending a SIGSTOP) will see a
		1995	time jump in the monotonic clocks and the realtime clock. If the program
		1996	is suspended for a very long time, and monotonic clock sources are in use,
		1997	then you can expect C<ev_timer>s to expire as the full suspension time
		1998	will be counted towards the timers. When no monotonic clock source is in
		1999	use, then libev will again assume a timejump and adjust accordingly.
		2000
		2001	It might be beneficial for this latter case to call C<ev_suspend>
		2002	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		2003	deterministic behaviour in this case (you can do nothing against
		2004	C<SIGSTOP>).
		2005
1238	=head3 Watcher-Specific Functions and Data Members	2006	=head3 Watcher-Specific Functions and Data Members
1239		2007
1240	=over 4	2008	=over 4
1241		2009
1242	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2010	=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	2023	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.	2024	do stuff) the timer will not fire more than once per event loop iteration.
1257		2025
1258	=item ev_timer_again (loop, ev_timer *)	2026	=item ev_timer_again (loop, ev_timer *)
1259		2027
1260	This will act as if the timer timed out and restart it again if it is	2028	This will act as if the timer timed out and restarts it again if it is
1261	repeating. The exact semantics are:	2029	repeating. The exact semantics are:
1262		2030
1263	If the timer is pending, its pending status is cleared.	2031	If the timer is pending, its pending status is cleared.
1264		2032
1265	If the timer is started but non-repeating, stop it (as if it timed out).	2033	If the timer is started but non-repeating, stop it (as if it timed out).
1266		2034
1267	If the timer is repeating, either start it if necessary (with the	2035	If the timer is repeating, either start it if necessary (with the
1268	C<repeat> value), or reset the running timer to the C<repeat> value.	2036	C<repeat> value), or reset the running timer to the C<repeat> value.
1269		2037
1270	This sounds a bit complicated, but here is a useful and typical	2038	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1271	example: Imagine you have a TCP connection and you want a so-called idle	2039	usage example.
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		2040
1280	That means you can ignore the C<after> value and C<ev_timer_start>	2041	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1281	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1282		2042
1283	ev_timer_init (timer, callback, 0., 5.);	2043	Returns the remaining time until a timer fires. If the timer is active,
1284	ev_timer_again (loop, timer);	2044	then this time is relative to the current event loop time, otherwise it's
1285	...	2045	the timeout value currently configured.
1286	timer->again = 17.;
1287	ev_timer_again (loop, timer);
1288	...
1289	timer->again = 10.;
1290	ev_timer_again (loop, timer);
1291		2046
1292	This is more slightly efficient then stopping/starting the timer each time	2047	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1293	you want to modify its timeout value.	2048	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
		2049	will return C<4>. When the timer expires and is restarted, it will return
		2050	roughly C<7> (likely slightly less as callback invocation takes some time,
		2051	too), and so on.
1294		2052
1295	=item ev_tstamp repeat [read-write]	2053	=item ev_tstamp repeat [read-write]
1296		2054
1297	The current C<repeat> value. Will be used each time the watcher times out	2055	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),	2056	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.	2057	which is also when any modifications are taken into account.
1300		2058
1301	=back	2059	=back
1302		2060
1303	=head3 Examples	2061	=head3 Examples
1304		2062
1305	Example: Create a timer that fires after 60 seconds.	2063	Example: Create a timer that fires after 60 seconds.
1306		2064
1307	static void	2065	static void
1308	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	2066	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1309	{	2067	{
1310	.. one minute over, w is actually stopped right here	2068	.. one minute over, w is actually stopped right here
1311	}	2069	}
1312		2070
1313	struct ev_timer mytimer;	2071	ev_timer mytimer;
1314	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	2072	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1315	ev_timer_start (loop, &mytimer);	2073	ev_timer_start (loop, &mytimer);
1316		2074
1317	Example: Create a timeout timer that times out after 10 seconds of	2075	Example: Create a timeout timer that times out after 10 seconds of
1318	inactivity.	2076	inactivity.
1319		2077
1320	static void	2078	static void
1321	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	2079	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1322	{	2080	{
1323	.. ten seconds without any activity	2081	.. ten seconds without any activity
1324	}	2082	}
1325		2083
1326	struct ev_timer mytimer;	2084	ev_timer mytimer;
1327	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2085	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1328	ev_timer_again (&mytimer); /* start timer */	2086	ev_timer_again (&mytimer); /* start timer */
1329	ev_loop (loop, 0);	2087	ev_run (loop, 0);
1330		2088
1331	// and in some piece of code that gets executed on any "activity":	2089	// and in some piece of code that gets executed on any "activity":
1332	// reset the timeout to start ticking again at 10 seconds	2090	// reset the timeout to start ticking again at 10 seconds
1333	ev_timer_again (&mytimer);	2091	ev_timer_again (&mytimer);
1334		2092
…		…
1336	=head2 C<ev_periodic> - to cron or not to cron?	2094	=head2 C<ev_periodic> - to cron or not to cron?
1337		2095
1338	Periodic watchers are also timers of a kind, but they are very versatile	2096	Periodic watchers are also timers of a kind, but they are very versatile
1339	(and unfortunately a bit complex).	2097	(and unfortunately a bit complex).
1340		2098
1341	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	2099	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	2100	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	2101	(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 ()	2102	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	2103	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	2104	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		2105
		2106	You can tell a periodic watcher to trigger after some specific point
		2107	in time: for example, if you tell a periodic watcher to trigger "in 10
		2108	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		2109	not a delay) and then reset your system clock to January of the previous
		2110	year, then it will take a year or more to trigger the event (unlike an
		2111	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		2112	it, as it uses a relative timeout).
		2113
1350	C<ev_periodic>s can also be used to implement vastly more complex timers,	2114	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	2115	timers, such as triggering an event on each "midnight, local time", or
1352	complicated, rules.	2116	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		2117	those cannot react to time jumps.
1353		2118
1354	As with timers, the callback is guaranteed to be invoked only when the	2119	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	2120	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.	2121	timers become ready during the same loop iteration then the ones with
		2122	earlier time-out values are invoked before ones with later time-out values
		2123	(but this is no longer true when a callback calls C<ev_run> recursively).
1357		2124
1358	=head3 Watcher-Specific Functions and Data Members	2125	=head3 Watcher-Specific Functions and Data Members
1359		2126
1360	=over 4	2127	=over 4
1361		2128
1362	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	2129	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1363		2130
1364	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	2131	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1365		2132
1366	Lots of arguments, lets sort it out... There are basically three modes of	2133	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:	2134	operation, and we will explain them from simplest to most complex:
1368		2135
1369	=over 4	2136	=over 4
1370		2137
1371	=item * absolute timer (at = time, interval = reschedule_cb = 0)	2138	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1372		2139
1373	In this configuration the watcher triggers an event after the wall clock	2140	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	2141	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	2142	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.	2143	will be stopped and invoked when the system clock reaches or surpasses
		2144	this point in time.
1377		2145
1378	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	2146	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1379		2147
1380	In this mode the watcher will always be scheduled to time out at the next	2148	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)	2149	C<offset + N * interval> time (for some integer N, which can also be
1382	and then repeat, regardless of any time jumps.	2150	negative) and then repeat, regardless of any time jumps. The C<offset>
		2151	argument is merely an offset into the C<interval> periods.
1383		2152
1384	This can be used to create timers that do not drift with respect to system	2153	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	2154	system clock, for example, here is an C<ev_periodic> that triggers each
1386	the hour:	2155	hour, on the hour (with respect to UTC):
1387		2156
1388	ev_periodic_set (&periodic, 0., 3600., 0);	2157	ev_periodic_set (&periodic, 0., 3600., 0);
1389		2158
1390	This doesn't mean there will always be 3600 seconds in between triggers,	2159	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	2160	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	2161	full hour (UTC), or more correctly, when the system time is evenly divisible
1393	by 3600.	2162	by 3600.
1394		2163
1395	Another way to think about it (for the mathematically inclined) is that	2164	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	2165	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.	2166	time where C<time = offset (mod interval)>, regardless of any time jumps.
1398		2167
1399	For numerical stability it is preferable that the C<at> value is near	2168	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	2169	interval value should be higher than C<1/8192> (which is around 100
1401	this value, and in fact is often specified as zero.	2170	microseconds) and C<offset> should be higher than C<0> and should have
		2171	at most a similar magnitude as the current time (say, within a factor of
		2172	ten). Typical values for offset are, in fact, C<0> or something between
		2173	C<0> and C<interval>, which is also the recommended range.
1402		2174
1403	Note also that there is an upper limit to how often a timer can fire (CPU	2175	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	2176	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	2177	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).	2178	millisecond (if the OS supports it and the machine is fast enough).
1407		2179
1408	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	2180	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1409		2181
1410	In this mode the values for C<interval> and C<at> are both being	2182	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	2183	ignored. Instead, each time the periodic watcher gets scheduled, the
1412	reschedule callback will be called with the watcher as first, and the	2184	reschedule callback will be called with the watcher as first, and the
1413	current time as second argument.	2185	current time as second argument.
1414		2186
1415	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	2187	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1416	ever, or make ANY event loop modifications whatsoever>.	2188	or make ANY other event loop modifications whatsoever, unless explicitly
		2189	allowed by documentation here>.
1417		2190
1418	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	2191	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	2192	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1420	only event loop modification you are allowed to do).	2193	only event loop modification you are allowed to do).
1421		2194
1422	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic	2195	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1423	*w, ev_tstamp now)>, e.g.:	2196	*w, ev_tstamp now)>, e.g.:
1424		2197
		2198	static ev_tstamp
1425	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	2199	my_rescheduler (ev_periodic *w, ev_tstamp now)
1426	{	2200	{
1427	return now + 60.;	2201	return now + 60.;
1428	}	2202	}
1429		2203
1430	It must return the next time to trigger, based on the passed time value	2204	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	2224	a different time than the last time it was called (e.g. in a crond like
1451	program when the crontabs have changed).	2225	program when the crontabs have changed).
1452		2226
1453	=item ev_tstamp ev_periodic_at (ev_periodic *)	2227	=item ev_tstamp ev_periodic_at (ev_periodic *)
1454		2228
1455	When active, returns the absolute time that the watcher is supposed to	2229	When active, returns the absolute time that the watcher is supposed
1456	trigger next.	2230	to trigger next. This is not the same as the C<offset> argument to
		2231	C<ev_periodic_set>, but indeed works even in interval and manual
		2232	rescheduling modes.
1457		2233
1458	=item ev_tstamp offset [read-write]	2234	=item ev_tstamp offset [read-write]
1459		2235
1460	When repeating, this contains the offset value, otherwise this is the	2236	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>).	2237	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		2238	although libev might modify this value for better numerical stability).
1462		2239
1463	Can be modified any time, but changes only take effect when the periodic	2240	Can be modified any time, but changes only take effect when the periodic
1464	timer fires or C<ev_periodic_again> is being called.	2241	timer fires or C<ev_periodic_again> is being called.
1465		2242
1466	=item ev_tstamp interval [read-write]	2243	=item ev_tstamp interval [read-write]
1467		2244
1468	The current interval value. Can be modified any time, but changes only	2245	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	2246	take effect when the periodic timer fires or C<ev_periodic_again> is being
1470	called.	2247	called.
1471		2248
1472	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	2249	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1473		2250
1474	The current reschedule callback, or C<0>, if this functionality is	2251	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	2252	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.	2253	the periodic timer fires or C<ev_periodic_again> is being called.
1477		2254
1478	=back	2255	=back
1479		2256
1480	=head3 Examples	2257	=head3 Examples
1481		2258
1482	Example: Call a callback every hour, or, more precisely, whenever the	2259	Example: Call a callback every hour, or, more precisely, whenever the
1483	system clock is divisible by 3600. The callback invocation times have	2260	system time is divisible by 3600. The callback invocation times have
1484	potentially a lot of jitter, but good long-term stability.	2261	potentially a lot of jitter, but good long-term stability.
1485		2262
1486	static void	2263	static void
1487	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	2264	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1488	{	2265	{
1489	... its now a full hour (UTC, or TAI or whatever your clock follows)	2266	... its now a full hour (UTC, or TAI or whatever your clock follows)
1490	}	2267	}
1491		2268
1492	struct ev_periodic hourly_tick;	2269	ev_periodic hourly_tick;
1493	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	2270	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1494	ev_periodic_start (loop, &hourly_tick);	2271	ev_periodic_start (loop, &hourly_tick);
1495		2272
1496	Example: The same as above, but use a reschedule callback to do it:	2273	Example: The same as above, but use a reschedule callback to do it:
1497		2274
1498	#include <math.h>	2275	#include <math.h>
1499		2276
1500	static ev_tstamp	2277	static ev_tstamp
1501	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	2278	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1502	{	2279	{
1503	return fmod (now, 3600.) + 3600.;	2280	return now + (3600. - fmod (now, 3600.));
1504	}	2281	}
1505		2282
1506	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	2283	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1507		2284
1508	Example: Call a callback every hour, starting now:	2285	Example: Call a callback every hour, starting now:
1509		2286
1510	struct ev_periodic hourly_tick;	2287	ev_periodic hourly_tick;
1511	ev_periodic_init (&hourly_tick, clock_cb,	2288	ev_periodic_init (&hourly_tick, clock_cb,
1512	fmod (ev_now (loop), 3600.), 3600., 0);	2289	fmod (ev_now (loop), 3600.), 3600., 0);
1513	ev_periodic_start (loop, &hourly_tick);	2290	ev_periodic_start (loop, &hourly_tick);
1514		2291
1515		2292
1516	=head2 C<ev_signal> - signal me when a signal gets signalled!	2293	=head2 C<ev_signal> - signal me when a signal gets signalled!
1517		2294
1518	Signal watchers will trigger an event when the process receives a specific	2295	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	2296	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	2297	will try its best to deliver signals synchronously, i.e. as part of the
1521	normal event processing, like any other event.	2298	normal event processing, like any other event.
1522		2299
		2300	If you want signals to be delivered truly asynchronously, just use
		2301	C<sigaction> as you would do without libev and forget about sharing
		2302	the signal. You can even use C<ev_async> from a signal handler to
		2303	synchronously wake up an event loop.
		2304
1523	You can configure as many watchers as you like per signal. Only when the	2305	You can configure as many watchers as you like for the same signal, but
		2306	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2307	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2308	C<SIGINT> in both the default loop and another loop at the same time. At
		2309	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2310
1524	first watcher gets started will libev actually register a signal watcher	2311	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	2312	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	2313	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		2314
1530	If possible and supported, libev will install its handlers with	2315	If possible and supported, libev will install its handlers with
1531	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2316	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1532	interrupted. If you have a problem with system calls getting interrupted by	2317	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	2318	interrupted by signals you can block all signals in an C<ev_check> watcher
1534	them in an C<ev_prepare> watcher.	2319	and unblock them in an C<ev_prepare> watcher.
		2320
		2321	=head3 The special problem of inheritance over fork/execve/pthread_create
		2322
		2323	Both the signal mask (C<sigprocmask>) and the signal disposition
		2324	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2325	stopping it again), that is, libev might or might not block the signal,
		2326	and might or might not set or restore the installed signal handler (but
		2327	see C<EVFLAG_NOSIGMASK>).
		2328
		2329	While this does not matter for the signal disposition (libev never
		2330	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2331	C<execve>), this matters for the signal mask: many programs do not expect
		2332	certain signals to be blocked.
		2333
		2334	This means that before calling C<exec> (from the child) you should reset
		2335	the signal mask to whatever "default" you expect (all clear is a good
		2336	choice usually).
		2337
		2338	The simplest way to ensure that the signal mask is reset in the child is
		2339	to install a fork handler with C<pthread_atfork> that resets it. That will
		2340	catch fork calls done by libraries (such as the libc) as well.
		2341
		2342	In current versions of libev, the signal will not be blocked indefinitely
		2343	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2344	the window of opportunity for problems, it will not go away, as libev
		2345	I<has> to modify the signal mask, at least temporarily.
		2346
		2347	So I can't stress this enough: I<If you do not reset your signal mask when
		2348	you expect it to be empty, you have a race condition in your code>. This
		2349	is not a libev-specific thing, this is true for most event libraries.
		2350
		2351	=head3 The special problem of threads signal handling
		2352
		2353	POSIX threads has problematic signal handling semantics, specifically,
		2354	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2355	threads in a process block signals, which is hard to achieve.
		2356
		2357	When you want to use sigwait (or mix libev signal handling with your own
		2358	for the same signals), you can tackle this problem by globally blocking
		2359	all signals before creating any threads (or creating them with a fully set
		2360	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2361	loops. Then designate one thread as "signal receiver thread" which handles
		2362	these signals. You can pass on any signals that libev might be interested
		2363	in by calling C<ev_feed_signal>.
1535		2364
1536	=head3 Watcher-Specific Functions and Data Members	2365	=head3 Watcher-Specific Functions and Data Members
1537		2366
1538	=over 4	2367	=over 4
1539		2368
…		…
1550		2379
1551	=back	2380	=back
1552		2381
1553	=head3 Examples	2382	=head3 Examples
1554		2383
1555	Example: Try to exit cleanly on SIGINT and SIGTERM.	2384	Example: Try to exit cleanly on SIGINT.
1556		2385
1557	static void	2386	static void
1558	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	2387	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1559	{	2388	{
1560	ev_unloop (loop, EVUNLOOP_ALL);	2389	ev_break (loop, EVBREAK_ALL);
1561	}	2390	}
1562		2391
1563	struct ev_signal signal_watcher;	2392	ev_signal signal_watcher;
1564	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2393	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1565	ev_signal_start (loop, &sigint_cb);	2394	ev_signal_start (loop, &signal_watcher);
1566		2395
1567		2396
1568	=head2 C<ev_child> - watch out for process status changes	2397	=head2 C<ev_child> - watch out for process status changes
1569		2398
1570	Child watchers trigger when your process receives a SIGCHLD in response to	2399	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	2400	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	2401	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	2402	has been forked (which implies it might have already exited), as long
1574	loop isn't entered (or is continued from a watcher).	2403	as the event loop isn't entered (or is continued from a watcher), i.e.,
		2404	forking and then immediately registering a watcher for the child is fine,
		2405	but forking and registering a watcher a few event loop iterations later or
		2406	in the next callback invocation is not.
1575		2407
1576	Only the default event loop is capable of handling signals, and therefore	2408	Only the default event loop is capable of handling signals, and therefore
1577	you can only register child watchers in the default event loop.	2409	you can only register child watchers in the default event loop.
1578		2410
		2411	Due to some design glitches inside libev, child watchers will always be
		2412	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2413	libev)
		2414
1579	=head3 Process Interaction	2415	=head3 Process Interaction
1580		2416
1581	Libev grabs C<SIGCHLD> as soon as the default event loop is	2417	Libev grabs C<SIGCHLD> as soon as the default event loop is
1582	initialised. This is necessary to guarantee proper behaviour even if	2418	initialised. This is necessary to guarantee proper behaviour even if the
1583	the first child watcher is started after the child exits. The occurrence	2419	first child watcher is started after the child exits. The occurrence
1584	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2420	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1585	synchronously as part of the event loop processing. Libev always reaps all	2421	synchronously as part of the event loop processing. Libev always reaps all
1586	children, even ones not watched.	2422	children, even ones not watched.
1587		2423
1588	=head3 Overriding the Built-In Processing	2424	=head3 Overriding the Built-In Processing
…		…
1598	=head3 Stopping the Child Watcher	2434	=head3 Stopping the Child Watcher
1599		2435
1600	Currently, the child watcher never gets stopped, even when the	2436	Currently, the child watcher never gets stopped, even when the
1601	child terminates, so normally one needs to stop the watcher in the	2437	child terminates, so normally one needs to stop the watcher in the
1602	callback. Future versions of libev might stop the watcher automatically	2438	callback. Future versions of libev might stop the watcher automatically
1603	when a child exit is detected.	2439	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2440	problem).
1604		2441
1605	=head3 Watcher-Specific Functions and Data Members	2442	=head3 Watcher-Specific Functions and Data Members
1606		2443
1607	=over 4	2444	=over 4
1608		2445
…		…
1640	its completion.	2477	its completion.
1641		2478
1642	ev_child cw;	2479	ev_child cw;
1643		2480
1644	static void	2481	static void
1645	child_cb (EV_P_ struct ev_child *w, int revents)	2482	child_cb (EV_P_ ev_child *w, int revents)
1646	{	2483	{
1647	ev_child_stop (EV_A_ w);	2484	ev_child_stop (EV_A_ w);
1648	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	2485	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1649	}	2486	}
1650		2487
…		…
1665		2502
1666		2503
1667	=head2 C<ev_stat> - did the file attributes just change?	2504	=head2 C<ev_stat> - did the file attributes just change?
1668		2505
1669	This watches a file system path for attribute changes. That is, it calls	2506	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	2507	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.	2508	and sees if it changed compared to the last time, invoking the callback if
		2509	it did.
1672		2510
1673	The path does not need to exist: changing from "path exists" to "path does	2511	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	2512	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	2513	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	2514	C<st_nlink> field being zero (which is otherwise always forced to be at
1677	the stat buffer having unspecified contents.	2515	least one) and all the other fields of the stat buffer having unspecified
		2516	contents.
1678		2517
1679	The path I<should> be absolute and I<must not> end in a slash. If it is	2518	The path I<must not> end in a slash or contain special components such as
		2519	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.	2520	your working directory changes, then the behaviour is undefined.
1681		2521
1682	Since there is no standard to do this, the portable implementation simply	2522	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	2523	portable implementation simply calls C<stat(2)> regularly on the path
1684	can specify a recommended polling interval for this case. If you specify	2524	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,	2525	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	2526	recommended!) then a I<suitable, unspecified default> value will be used
1687	five seconds, although this might change dynamically). Libev will also	2527	(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	2528	change dynamically). Libev will also impose a minimum interval which is
1689	usually overkill.	2529	currently around C<0.1>, but that's usually overkill.
1690		2530
1691	This watcher type is not meant for massive numbers of stat watchers,	2531	This watcher type is not meant for massive numbers of stat watchers,
1692	as even with OS-supported change notifications, this can be	2532	as even with OS-supported change notifications, this can be
1693	resource-intensive.	2533	resource-intensive.
1694		2534
1695	At the time of this writing, only the Linux inotify interface is	2535	At the time of this writing, the only OS-specific interface implemented
1696	implemented (implementing kqueue support is left as an exercise for the	2536	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	2537	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	2538	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		2539
1704	=head3 ABI Issues (Largefile Support)	2540	=head3 ABI Issues (Largefile Support)
1705		2541
1706	Libev by default (unless the user overrides this) uses the default	2542	Libev by default (unless the user overrides this) uses the default
1707	compilation environment, which means that on systems with large file	2543	compilation environment, which means that on systems with large file
1708	support disabled by default, you get the 32 bit version of the stat	2544	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	2545	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	2546	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	2547	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	2548	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.	2549	most noticeably displayed with ev_stat and large file support.
1714		2550
1715	The solution for this is to lobby your distribution maker to make large	2551	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	2552	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	2553	optional. Libev cannot simply switch on large file support because it has
1718	to exchange stat structures with application programs compiled using the	2554	to exchange stat structures with application programs compiled using the
1719	default compilation environment.	2555	default compilation environment.
1720		2556
1721	=head3 Inotify	2557	=head3 Inotify and Kqueue
1722		2558
1723	When C<inotify (7)> support has been compiled into libev (generally only	2559	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	2560	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	2561	inotify descriptor will be created lazily when the first C<ev_stat>
1726	when the first C<ev_stat> watcher is being started.	2562	watcher is being started.
1727		2563
1728	Inotify presence does not change the semantics of C<ev_stat> watchers	2564	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	2565	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	2566	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.	2567	there are many cases where libev has to resort to regular C<stat> polling,
		2568	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2569	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2570	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2571	xfs are fully working) libev usually gets away without polling.
1732		2572
1733	(There is no support for kqueue, as apparently it cannot be used to	2573	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	2574	implement this functionality, due to the requirement of having a file
1735	descriptor open on the object at all times).	2575	descriptor open on the object at all times, and detecting renames, unlinks
		2576	etc. is difficult.
		2577
		2578	=head3 C<stat ()> is a synchronous operation
		2579
		2580	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2581	the process. The exception are C<ev_stat> watchers - those call C<stat
		2582	()>, which is a synchronous operation.
		2583
		2584	For local paths, this usually doesn't matter: unless the system is very
		2585	busy or the intervals between stat's are large, a stat call will be fast,
		2586	as the path data is usually in memory already (except when starting the
		2587	watcher).
		2588
		2589	For networked file systems, calling C<stat ()> can block an indefinite
		2590	time due to network issues, and even under good conditions, a stat call
		2591	often takes multiple milliseconds.
		2592
		2593	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2594	paths, although this is fully supported by libev.
1736		2595
1737	=head3 The special problem of stat time resolution	2596	=head3 The special problem of stat time resolution
1738		2597
1739	The C<stat ()> system call only supports full-second resolution portably, and	2598	The C<stat ()> system call only supports full-second resolution portably,
1740	even on systems where the resolution is higher, many file systems still	2599	and even on systems where the resolution is higher, most file systems
1741	only support whole seconds.	2600	still only support whole seconds.
1742		2601
1743	That means that, if the time is the only thing that changes, you can	2602	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	2603	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	2604	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	2605	within the same second, C<ev_stat> will be unable to detect unless the
1747	data does not change.	2606	stat data does change in other ways (e.g. file size).
1748		2607
1749	The solution to this is to delay acting on a change for slightly more	2608	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	2609	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);	2610	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1752	ev_timer_again (loop, w)>).	2611	ev_timer_again (loop, w)>).
…		…
1772	C<path>. The C<interval> is a hint on how quickly a change is expected to	2631	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	2632	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	2633	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.	2634	path for as long as the watcher is active.
1776		2635
1777	The callback will receive C<EV_STAT> when a change was detected, relative	2636	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	2637	relative to the attributes at the time the watcher was started (or the
1779	was detected).	2638	last change was detected).
1780		2639
1781	=item ev_stat_stat (loop, ev_stat *)	2640	=item ev_stat_stat (loop, ev_stat *)
1782		2641
1783	Updates the stat buffer immediately with new values. If you change the	2642	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	2643	watched path in your callback, you could call this function to avoid
…		…
1867		2726
1868		2727
1869	=head2 C<ev_idle> - when you've got nothing better to do...	2728	=head2 C<ev_idle> - when you've got nothing better to do...
1870		2729
1871	Idle watchers trigger events when no other events of the same or higher	2730	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	2731	priority are pending (prepare, check and other idle watchers do not count
1873	count).	2732	as receiving "events").
1874		2733
1875	That is, as long as your process is busy handling sockets or timeouts	2734	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	2735	(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	2736	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	2737	are pending), the idle watchers are being called once per event loop
…		…
1889		2748
1890	=head3 Watcher-Specific Functions and Data Members	2749	=head3 Watcher-Specific Functions and Data Members
1891		2750
1892	=over 4	2751	=over 4
1893		2752
1894	=item ev_idle_init (ev_signal *, callback)	2753	=item ev_idle_init (ev_idle *, callback)
1895		2754
1896	Initialises and configures the idle watcher - it has no parameters of any	2755	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,	2756	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1898	believe me.	2757	believe me.
1899		2758
…		…
1903		2762
1904	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2763	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1905	callback, free it. Also, use no error checking, as usual.	2764	callback, free it. Also, use no error checking, as usual.
1906		2765
1907	static void	2766	static void
1908	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2767	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1909	{	2768	{
1910	free (w);	2769	free (w);
1911	// now do something you wanted to do when the program has	2770	// now do something you wanted to do when the program has
1912	// no longer anything immediate to do.	2771	// no longer anything immediate to do.
1913	}	2772	}
1914		2773
1915	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2774	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1916	ev_idle_init (idle_watcher, idle_cb);	2775	ev_idle_init (idle_watcher, idle_cb);
1917	ev_idle_start (loop, idle_cb);	2776	ev_idle_start (loop, idle_watcher);
1918		2777
1919		2778
1920	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2779	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1921		2780
1922	Prepare and check watchers are usually (but not always) used in tandem:	2781	Prepare and check watchers are usually (but not always) used in pairs:
1923	prepare watchers get invoked before the process blocks and check watchers	2782	prepare watchers get invoked before the process blocks and check watchers
1924	afterwards.	2783	afterwards.
1925		2784
1926	You I<must not> call C<ev_loop> or similar functions that enter	2785	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>	2786	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	2787	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	2788	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,	2789	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	2790	C<ev_check> so if you have one watcher of each kind they will always be
1932	called in pairs bracketing the blocking call.	2791	called in pairs bracketing the blocking call.
1933		2792
1934	Their main purpose is to integrate other event mechanisms into libev and	2793	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	2794	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	2795	variable changes, implement your own watchers, integrate net-snmp or a
1937	coroutine library and lots more. They are also occasionally useful if	2796	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,	2797	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>	2798	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1940	watcher).	2799	watcher).
1941		2800
1942	This is done by examining in each prepare call which file descriptors need	2801	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	2802	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	2803	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	2804	libraries provide exactly this functionality). Then, in the check watcher,
1946	any events that occurred (by checking the pending status of all watchers	2805	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	2806	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,	2807	I/O and timer callbacks will never actually be called (but must be valid
1949	because you never know, you know?).	2808	nevertheless, because you never know, you know?).
1950		2809
1951	As another example, the Perl Coro module uses these hooks to integrate	2810	As another example, the Perl Coro module uses these hooks to integrate
1952	coroutines into libev programs, by yielding to other active coroutines	2811	coroutines into libev programs, by yielding to other active coroutines
1953	during each prepare and only letting the process block if no coroutines	2812	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	2813	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	2816	loop from blocking if lower-priority coroutines are active, thus mapping
1958	low-priority coroutines to idle/background tasks).	2817	low-priority coroutines to idle/background tasks).
1959		2818
1960	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2819	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	2820	priority, to ensure that they are being run before any other watchers
		2821	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2822
1962	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2823	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	2824	activate ("feed") events into libev. While libev fully supports this, they
1964	supports this, they might get executed before other C<ev_check> watchers	2825	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	2826	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	2827	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	2828	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1968	coexist peacefully with others).	2829	others).
1969		2830
1970	=head3 Watcher-Specific Functions and Data Members	2831	=head3 Watcher-Specific Functions and Data Members
1971		2832
1972	=over 4	2833	=over 4
1973		2834
…		…
1975		2836
1976	=item ev_check_init (ev_check *, callback)	2837	=item ev_check_init (ev_check *, callback)
1977		2838
1978	Initialises and configures the prepare or check watcher - they have no	2839	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>	2840	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.	2841	macros, but using them is utterly, utterly, utterly and completely
		2842	pointless.
1981		2843
1982	=back	2844	=back
1983		2845
1984	=head3 Examples	2846	=head3 Examples
1985		2847
…		…
1998		2860
1999	static ev_io iow [nfd];	2861	static ev_io iow [nfd];
2000	static ev_timer tw;	2862	static ev_timer tw;
2001		2863
2002	static void	2864	static void
2003	io_cb (ev_loop *loop, ev_io *w, int revents)	2865	io_cb (struct ev_loop *loop, ev_io *w, int revents)
2004	{	2866	{
2005	}	2867	}
2006		2868
2007	// create io watchers for each fd and a timer before blocking	2869	// create io watchers for each fd and a timer before blocking
2008	static void	2870	static void
2009	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2871	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
2010	{	2872	{
2011	int timeout = 3600000;	2873	int timeout = 3600000;
2012	struct pollfd fds [nfd];	2874	struct pollfd fds [nfd];
2013	// actual code will need to loop here and realloc etc.	2875	// actual code will need to loop here and realloc etc.
2014	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2876	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2015		2877
2016	/* the callback is illegal, but won't be called as we stop during check */	2878	/* the callback is illegal, but won't be called as we stop during check */
2017	ev_timer_init (&tw, 0, timeout * 1e-3);	2879	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2018	ev_timer_start (loop, &tw);	2880	ev_timer_start (loop, &tw);
2019		2881
2020	// create one ev_io per pollfd	2882	// create one ev_io per pollfd
2021	for (int i = 0; i < nfd; ++i)	2883	for (int i = 0; i < nfd; ++i)
2022	{	2884	{
…		…
2029	}	2891	}
2030	}	2892	}
2031		2893
2032	// stop all watchers after blocking	2894	// stop all watchers after blocking
2033	static void	2895	static void
2034	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2896	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
2035	{	2897	{
2036	ev_timer_stop (loop, &tw);	2898	ev_timer_stop (loop, &tw);
2037		2899
2038	for (int i = 0; i < nfd; ++i)	2900	for (int i = 0; i < nfd; ++i)
2039	{	2901	{
…		…
2078	}	2940	}
2079		2941
2080	// do not ever call adns_afterpoll	2942	// do not ever call adns_afterpoll
2081		2943
2082	Method 4: Do not use a prepare or check watcher because the module you	2944	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	2945	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	2946	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	2947	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
2086	this.	2948	this approach, effectively embedding EV as a client into the horrible
		2949	libglib event loop.
2087		2950
2088	static gint	2951	static gint
2089	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2952	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2090	{	2953	{
2091	int got_events = 0;	2954	int got_events = 0;
…		…
2095		2958
2096	if (timeout >= 0)	2959	if (timeout >= 0)
2097	// create/start timer	2960	// create/start timer
2098		2961
2099	// poll	2962	// poll
2100	ev_loop (EV_A_ 0);	2963	ev_run (EV_A_ 0);
2101		2964
2102	// stop timer again	2965	// stop timer again
2103	if (timeout >= 0)	2966	if (timeout >= 0)
2104	ev_timer_stop (EV_A_ &to);	2967	ev_timer_stop (EV_A_ &to);
2105		2968
…		…
2122	prioritise I/O.	2985	prioritise I/O.
2123		2986
2124	As an example for a bug workaround, the kqueue backend might only support	2987	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	2988	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	2989	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	2990	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	2991	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	2992	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.	2993	C<kevent>, but at least you can use both mechanisms for what they are
		2994	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
2131		2995
2132	As for prioritising I/O: rarely you have the case where some fds have	2996	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	2997	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	2998	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	2999	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.	3000	the rest in a second one, and embed the second one in the first.
2137		3001
2138	As long as the watcher is active, the callback will be invoked every time	3002	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	3003	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	3004	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	3005	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	3006	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	3007	to give the embedded loop strictly lower priority for example).
2144	embedded loop sweep.
2145		3008
2146	As long as the watcher is started it will automatically handle events. The	3009	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	3010	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		3011
2151	Also, there have not currently been made special provisions for forking:	3012	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,	3013	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	3014	embedding loop forks. In other cases, the user is responsible for calling
2154	yourself.	3015	C<ev_loop_fork> on the embedded loop.
2155		3016
2156	Unfortunately, not all backends are embeddable, only the ones returned by	3017	Unfortunately, not all backends are embeddable: only the ones returned by
2157	C<ev_embeddable_backends> are, which, unfortunately, does not include any	3018	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2158	portable one.	3019	portable one.
2159		3020
2160	So when you want to use this feature you will always have to be prepared	3021	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	3022	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	3023	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.	3024	create it, and if that fails, use the normal loop for everything.
		3025
		3026	=head3 C<ev_embed> and fork
		3027
		3028	While the C<ev_embed> watcher is running, forks in the embedding loop will
		3029	automatically be applied to the embedded loop as well, so no special
		3030	fork handling is required in that case. When the watcher is not running,
		3031	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		3032	as applicable.
2164		3033
2165	=head3 Watcher-Specific Functions and Data Members	3034	=head3 Watcher-Specific Functions and Data Members
2166		3035
2167	=over 4	3036	=over 4
2168		3037
…		…
2177	if you do not want that, you need to temporarily stop the embed watcher).	3046	if you do not want that, you need to temporarily stop the embed watcher).
2178		3047
2179	=item ev_embed_sweep (loop, ev_embed *)	3048	=item ev_embed_sweep (loop, ev_embed *)
2180		3049
2181	Make a single, non-blocking sweep over the embedded loop. This works	3050	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	3051	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2183	appropriate way for embedded loops.	3052	appropriate way for embedded loops.
2184		3053
2185	=item struct ev_loop *other [read-only]	3054	=item struct ev_loop *other [read-only]
2186		3055
2187	The embedded event loop.	3056	The embedded event loop.
…		…
2196	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be	3065	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2197	used).	3066	used).
2198		3067
2199	struct ev_loop *loop_hi = ev_default_init (0);	3068	struct ev_loop *loop_hi = ev_default_init (0);
2200	struct ev_loop *loop_lo = 0;	3069	struct ev_loop *loop_lo = 0;
2201	struct ev_embed embed;	3070	ev_embed embed;
2202		3071
2203	// see if there is a chance of getting one that works	3072	// see if there is a chance of getting one that works
2204	// (remember that a flags value of 0 means autodetection)	3073	// (remember that a flags value of 0 means autodetection)
2205	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	3074	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2206	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	3075	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
…		…
2220	kqueue implementation). Store the kqueue/socket-only event loop in	3089	kqueue implementation). Store the kqueue/socket-only event loop in
2221	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	3090	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2222		3091
2223	struct ev_loop *loop = ev_default_init (0);	3092	struct ev_loop *loop = ev_default_init (0);
2224	struct ev_loop *loop_socket = 0;	3093	struct ev_loop *loop_socket = 0;
2225	struct ev_embed embed;	3094	ev_embed embed;
2226		3095
2227	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	3096	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2228	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	3097	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2229	{	3098	{
2230	ev_embed_init (&embed, 0, loop_socket);	3099	ev_embed_init (&embed, 0, loop_socket);
…		…
2245	event loop blocks next and before C<ev_check> watchers are being called,	3114	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	3115	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	3116	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2248	handlers will be invoked, too, of course.	3117	handlers will be invoked, too, of course.
2249		3118
		3119	=head3 The special problem of life after fork - how is it possible?
		3120
		3121	Most uses of C<fork()> consist of forking, then some simple calls to set
		3122	up/change the process environment, followed by a call to C<exec()>. This
		3123	sequence should be handled by libev without any problems.
		3124
		3125	This changes when the application actually wants to do event handling
		3126	in the child, or both parent in child, in effect "continuing" after the
		3127	fork.
		3128
		3129	The default mode of operation (for libev, with application help to detect
		3130	forks) is to duplicate all the state in the child, as would be expected
		3131	when I<either> the parent I<or> the child process continues.
		3132
		3133	When both processes want to continue using libev, then this is usually the
		3134	wrong result. In that case, usually one process (typically the parent) is
		3135	supposed to continue with all watchers in place as before, while the other
		3136	process typically wants to start fresh, i.e. without any active watchers.
		3137
		3138	The cleanest and most efficient way to achieve that with libev is to
		3139	simply create a new event loop, which of course will be "empty", and
		3140	use that for new watchers. This has the advantage of not touching more
		3141	memory than necessary, and thus avoiding the copy-on-write, and the
		3142	disadvantage of having to use multiple event loops (which do not support
		3143	signal watchers).
		3144
		3145	When this is not possible, or you want to use the default loop for
		3146	other reasons, then in the process that wants to start "fresh", call
		3147	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
		3148	Destroying the default loop will "orphan" (not stop) all registered
		3149	watchers, so you have to be careful not to execute code that modifies
		3150	those watchers. Note also that in that case, you have to re-register any
		3151	signal watchers.
		3152
2250	=head3 Watcher-Specific Functions and Data Members	3153	=head3 Watcher-Specific Functions and Data Members
2251		3154
2252	=over 4	3155	=over 4
2253		3156
2254	=item ev_fork_init (ev_signal *, callback)	3157	=item ev_fork_init (ev_fork *, callback)
2255		3158
2256	Initialises and configures the fork watcher - it has no parameters of any	3159	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,	3160	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2258	believe me.	3161	really.
2259		3162
2260	=back	3163	=back
2261		3164
2262		3165
		3166	=head2 C<ev_cleanup> - even the best things end
		3167
		3168	Cleanup watchers are called just before the event loop is being destroyed
		3169	by a call to C<ev_loop_destroy>.
		3170
		3171	While there is no guarantee that the event loop gets destroyed, cleanup
		3172	watchers provide a convenient method to install cleanup hooks for your
		3173	program, worker threads and so on - you just to make sure to destroy the
		3174	loop when you want them to be invoked.
		3175
		3176	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3177	all other watchers, they do not keep a reference to the event loop (which
		3178	makes a lot of sense if you think about it). Like all other watchers, you
		3179	can call libev functions in the callback, except C<ev_cleanup_start>.
		3180
		3181	=head3 Watcher-Specific Functions and Data Members
		3182
		3183	=over 4
		3184
		3185	=item ev_cleanup_init (ev_cleanup *, callback)
		3186
		3187	Initialises and configures the cleanup watcher - it has no parameters of
		3188	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3189	pointless, I assure you.
		3190
		3191	=back
		3192
		3193	Example: Register an atexit handler to destroy the default loop, so any
		3194	cleanup functions are called.
		3195
		3196	static void
		3197	program_exits (void)
		3198	{
		3199	ev_loop_destroy (EV_DEFAULT_UC);
		3200	}
		3201
		3202	...
		3203	atexit (program_exits);
		3204
		3205
2263	=head2 C<ev_async> - how to wake up another event loop	3206	=head2 C<ev_async> - how to wake up an event loop
2264		3207
2265	In general, you cannot use an C<ev_loop> from multiple threads or other	3208	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	3209	asynchronous sources such as signal handlers (as opposed to multiple event
2267	loops - those are of course safe to use in different threads).	3210	loops - those are of course safe to use in different threads).
2268		3211
2269	Sometimes, however, you need to wake up another event loop you do not	3212	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	3213	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	3214	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	3215	it by calling C<ev_async_send>, which is thread- and signal safe.
2273	safe.
2274		3216
2275	This functionality is very similar to C<ev_signal> watchers, as signals,	3217	This functionality is very similar to C<ev_signal> watchers, as signals,
2276	too, are asynchronous in nature, and signals, too, will be compressed	3218	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	3219	(i.e. the number of callback invocations may be less than the number of
2278	C<ev_async_sent> calls).	3220	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
2279		3221	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	3222	signal, and C<ev_feed_signal> to signal this watcher from another thread,
2281	just the default loop.	3223	even without knowing which loop owns the signal.
2282		3224
2283	=head3 Queueing	3225	=head3 Queueing
2284		3226
2285	C<ev_async> does not support queueing of data in any way. The reason	3227	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	3228	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	3229	multiple-writer-single-reader queue that works in all cases and doesn't
2288	need elaborate support such as pthreads.	3230	need elaborate support such as pthreads or unportable memory access
		3231	semantics.
2289		3232
2290	That means that if you want to queue data, you have to provide your own	3233	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	3234	queue. But at least I can tell you how to implement locking around your
2292	queue:	3235	queue:
2293		3236
2294	=over 4	3237	=over 4
2295		3238
2296	=item queueing from a signal handler context	3239	=item queueing from a signal handler context
2297		3240
2298	To implement race-free queueing, you simply add to the queue in the signal	3241	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	3242	handler but you block the signal handler in the watcher callback. Here is
2300	some fictitious SIGUSR1 handler:	3243	an example that does that for some fictitious SIGUSR1 handler:
2301		3244
2302	static ev_async mysig;	3245	static ev_async mysig;
2303		3246
2304	static void	3247	static void
2305	sigusr1_handler (void)	3248	sigusr1_handler (void)
…		…
2371	=over 4	3314	=over 4
2372		3315
2373	=item ev_async_init (ev_async *, callback)	3316	=item ev_async_init (ev_async *, callback)
2374		3317
2375	Initialises and configures the async watcher - it has no parameters of any	3318	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,	3319	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2377	believe me.	3320	trust me.
2378		3321
2379	=item ev_async_send (loop, ev_async *)	3322	=item ev_async_send (loop, ev_async *)
2380		3323
2381	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3324	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	3325	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3326	returns.
		3327
2383	C<ev_feed_event>, this call is safe to do in other threads, signal or	3328	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	3329	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
2385	section below on what exactly this means).	3330	embedding section below on what exactly this means).
2386		3331
2387	This call incurs the overhead of a system call only once per loop iteration,	3332	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	3333	compressed into a single callback invocation (another way to look at
2389	calls to C<ev_async_send>.	3334	this is that C<ev_async> watchers are level-triggered: they are set on
		3335	C<ev_async_send>, reset when the event loop detects that).
		3336
		3337	This call incurs the overhead of at most one extra system call per event
		3338	loop iteration, if the event loop is blocked, and no syscall at all if
		3339	the event loop (or your program) is processing events. That means that
		3340	repeated calls are basically free (there is no need to avoid calls for
		3341	performance reasons) and that the overhead becomes smaller (typically
		3342	zero) under load.
2390		3343
2391	=item bool = ev_async_pending (ev_async *)	3344	=item bool = ev_async_pending (ev_async *)
2392		3345
2393	Returns a non-zero value when C<ev_async_send> has been called on the	3346	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	3347	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	3350	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,	3351	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	3352	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.	3353	quickly check whether invoking the loop might be a good idea.
2401		3354
2402	Not that this does I<not> check whether the watcher itself is pending, only	3355	Not that this does I<not> check whether the watcher itself is pending,
2403	whether it has been requested to make this watcher pending.	3356	only whether it has been requested to make this watcher pending: there
		3357	is a time window between the event loop checking and resetting the async
		3358	notification, and the callback being invoked.
2404		3359
2405	=back	3360	=back
2406		3361
2407		3362
2408	=head1 OTHER FUNCTIONS	3363	=head1 OTHER FUNCTIONS
…		…
2412	=over 4	3367	=over 4
2413		3368
2414	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	3369	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2415		3370
2416	This function combines a simple timer and an I/O watcher, calls your	3371	This function combines a simple timer and an I/O watcher, calls your
2417	callback on whichever event happens first and automatically stop both	3372	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	3373	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	3374	or timeout without having to allocate/configure/start/stop/free one or
2420	more watchers yourself.	3375	more watchers yourself.
2421		3376
2422	If C<fd> is less than 0, then no I/O watcher will be started and events	3377	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	3378	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2424	C<events> set will be created and started.	3379	the given C<fd> and C<events> set will be created and started.
2425		3380
2426	If C<timeout> is less than 0, then no timeout watcher will be	3381	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	3382	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	3383	repeat = 0) will be started. C<0> is a valid timeout.
2429	dubious value.
2430		3384
2431	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3385	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	3386	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>	3387	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
2434	value passed to C<ev_once>:	3388	value passed to C<ev_once>. Note that it is possible to receive I<both>
		3389	a timeout and an io event at the same time - you probably should give io
		3390	events precedence.
		3391
		3392	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2435		3393
2436	static void stdin_ready (int revents, void *arg)	3394	static void stdin_ready (int revents, void *arg)
2437	{	3395	{
		3396	if (revents & EV_READ)
		3397	/* stdin might have data for us, joy! */;
2438	if (revents & EV_TIMEOUT)	3398	else if (revents & EV_TIMER)
2439	/* doh, nothing entered */;	3399	/* doh, nothing entered */;
2440	else if (revents & EV_READ)
2441	/* stdin might have data for us, joy! */;
2442	}	3400	}
2443		3401
2444	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3402	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2445		3403
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)	3404	=item ev_feed_fd_event (loop, int fd, int revents)
2453		3405
2454	Feed an event on the given fd, as if a file descriptor backend detected	3406	Feed an event on the given fd, as if a file descriptor backend detected
2455	the given events it.	3407	the given events it.
2456		3408
2457	=item ev_feed_signal_event (ev_loop *loop, int signum)	3409	=item ev_feed_signal_event (loop, int signum)
2458		3410
2459	Feed an event as if the given signal occurred (C<loop> must be the default	3411	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
2460	loop!).	3412	which is async-safe.
2461		3413
2462	=back	3414	=back
		3415
		3416
		3417	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3418
		3419	This section explains some common idioms that are not immediately
		3420	obvious. Note that examples are sprinkled over the whole manual, and this
		3421	section only contains stuff that wouldn't fit anywhere else.
		3422
		3423	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3424
		3425	Each watcher has, by default, a C<void *data> member that you can read
		3426	or modify at any time: libev will completely ignore it. This can be used
		3427	to associate arbitrary data with your watcher. If you need more data and
		3428	don't want to allocate memory separately and store a pointer to it in that
		3429	data member, you can also "subclass" the watcher type and provide your own
		3430	data:
		3431
		3432	struct my_io
		3433	{
		3434	ev_io io;
		3435	int otherfd;
		3436	void *somedata;
		3437	struct whatever *mostinteresting;
		3438	};
		3439
		3440	...
		3441	struct my_io w;
		3442	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3443
		3444	And since your callback will be called with a pointer to the watcher, you
		3445	can cast it back to your own type:
		3446
		3447	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3448	{
		3449	struct my_io *w = (struct my_io *)w_;
		3450	...
		3451	}
		3452
		3453	More interesting and less C-conformant ways of casting your callback
		3454	function type instead have been omitted.
		3455
		3456	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3457
		3458	Another common scenario is to use some data structure with multiple
		3459	embedded watchers, in effect creating your own watcher that combines
		3460	multiple libev event sources into one "super-watcher":
		3461
		3462	struct my_biggy
		3463	{
		3464	int some_data;
		3465	ev_timer t1;
		3466	ev_timer t2;
		3467	}
		3468
		3469	In this case getting the pointer to C<my_biggy> is a bit more
		3470	complicated: Either you store the address of your C<my_biggy> struct in
		3471	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3472	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3473	real programmers):
		3474
		3475	#include <stddef.h>
		3476
		3477	static void
		3478	t1_cb (EV_P_ ev_timer *w, int revents)
		3479	{
		3480	struct my_biggy big = (struct my_biggy *)
		3481	(((char *)w) - offsetof (struct my_biggy, t1));
		3482	}
		3483
		3484	static void
		3485	t2_cb (EV_P_ ev_timer *w, int revents)
		3486	{
		3487	struct my_biggy big = (struct my_biggy *)
		3488	(((char *)w) - offsetof (struct my_biggy, t2));
		3489	}
		3490
		3491	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3492
		3493	Often (especially in GUI toolkits) there are places where you have
		3494	I<modal> interaction, which is most easily implemented by recursively
		3495	invoking C<ev_run>.
		3496
		3497	This brings the problem of exiting - a callback might want to finish the
		3498	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3499	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3500	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3501	other combination: In these cases, C<ev_break> will not work alone.
		3502
		3503	The solution is to maintain "break this loop" variable for each C<ev_run>
		3504	invocation, and use a loop around C<ev_run> until the condition is
		3505	triggered, using C<EVRUN_ONCE>:
		3506
		3507	// main loop
		3508	int exit_main_loop = 0;
		3509
		3510	while (!exit_main_loop)
		3511	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3512
		3513	// in a model watcher
		3514	int exit_nested_loop = 0;
		3515
		3516	while (!exit_nested_loop)
		3517	ev_run (EV_A_ EVRUN_ONCE);
		3518
		3519	To exit from any of these loops, just set the corresponding exit variable:
		3520
		3521	// exit modal loop
		3522	exit_nested_loop = 1;
		3523
		3524	// exit main program, after modal loop is finished
		3525	exit_main_loop = 1;
		3526
		3527	// exit both
		3528	exit_main_loop = exit_nested_loop = 1;
		3529
		3530	=head2 THREAD LOCKING EXAMPLE
		3531
		3532	Here is a fictitious example of how to run an event loop in a different
		3533	thread from where callbacks are being invoked and watchers are
		3534	created/added/removed.
		3535
		3536	For a real-world example, see the C<EV::Loop::Async> perl module,
		3537	which uses exactly this technique (which is suited for many high-level
		3538	languages).
		3539
		3540	The example uses a pthread mutex to protect the loop data, a condition
		3541	variable to wait for callback invocations, an async watcher to notify the
		3542	event loop thread and an unspecified mechanism to wake up the main thread.
		3543
		3544	First, you need to associate some data with the event loop:
		3545
		3546	typedef struct {
		3547	mutex_t lock; /* global loop lock */
		3548	ev_async async_w;
		3549	thread_t tid;
		3550	cond_t invoke_cv;
		3551	} userdata;
		3552
		3553	void prepare_loop (EV_P)
		3554	{
		3555	// for simplicity, we use a static userdata struct.
		3556	static userdata u;
		3557
		3558	ev_async_init (&u->async_w, async_cb);
		3559	ev_async_start (EV_A_ &u->async_w);
		3560
		3561	pthread_mutex_init (&u->lock, 0);
		3562	pthread_cond_init (&u->invoke_cv, 0);
		3563
		3564	// now associate this with the loop
		3565	ev_set_userdata (EV_A_ u);
		3566	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3567	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3568
		3569	// then create the thread running ev_run
		3570	pthread_create (&u->tid, 0, l_run, EV_A);
		3571	}
		3572
		3573	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3574	solely to wake up the event loop so it takes notice of any new watchers
		3575	that might have been added:
		3576
		3577	static void
		3578	async_cb (EV_P_ ev_async *w, int revents)
		3579	{
		3580	// just used for the side effects
		3581	}
		3582
		3583	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3584	protecting the loop data, respectively.
		3585
		3586	static void
		3587	l_release (EV_P)
		3588	{
		3589	userdata *u = ev_userdata (EV_A);
		3590	pthread_mutex_unlock (&u->lock);
		3591	}
		3592
		3593	static void
		3594	l_acquire (EV_P)
		3595	{
		3596	userdata *u = ev_userdata (EV_A);
		3597	pthread_mutex_lock (&u->lock);
		3598	}
		3599
		3600	The event loop thread first acquires the mutex, and then jumps straight
		3601	into C<ev_run>:
		3602
		3603	void *
		3604	l_run (void *thr_arg)
		3605	{
		3606	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3607
		3608	l_acquire (EV_A);
		3609	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3610	ev_run (EV_A_ 0);
		3611	l_release (EV_A);
		3612
		3613	return 0;
		3614	}
		3615
		3616	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3617	signal the main thread via some unspecified mechanism (signals? pipe
		3618	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3619	have been called (in a while loop because a) spurious wakeups are possible
		3620	and b) skipping inter-thread-communication when there are no pending
		3621	watchers is very beneficial):
		3622
		3623	static void
		3624	l_invoke (EV_P)
		3625	{
		3626	userdata *u = ev_userdata (EV_A);
		3627
		3628	while (ev_pending_count (EV_A))
		3629	{
		3630	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3631	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3632	}
		3633	}
		3634
		3635	Now, whenever the main thread gets told to invoke pending watchers, it
		3636	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3637	thread to continue:
		3638
		3639	static void
		3640	real_invoke_pending (EV_P)
		3641	{
		3642	userdata *u = ev_userdata (EV_A);
		3643
		3644	pthread_mutex_lock (&u->lock);
		3645	ev_invoke_pending (EV_A);
		3646	pthread_cond_signal (&u->invoke_cv);
		3647	pthread_mutex_unlock (&u->lock);
		3648	}
		3649
		3650	Whenever you want to start/stop a watcher or do other modifications to an
		3651	event loop, you will now have to lock:
		3652
		3653	ev_timer timeout_watcher;
		3654	userdata *u = ev_userdata (EV_A);
		3655
		3656	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3657
		3658	pthread_mutex_lock (&u->lock);
		3659	ev_timer_start (EV_A_ &timeout_watcher);
		3660	ev_async_send (EV_A_ &u->async_w);
		3661	pthread_mutex_unlock (&u->lock);
		3662
		3663	Note that sending the C<ev_async> watcher is required because otherwise
		3664	an event loop currently blocking in the kernel will have no knowledge
		3665	about the newly added timer. By waking up the loop it will pick up any new
		3666	watchers in the next event loop iteration.
		3667
		3668	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3669
		3670	While the overhead of a callback that e.g. schedules a thread is small, it
		3671	is still an overhead. If you embed libev, and your main usage is with some
		3672	kind of threads or coroutines, you might want to customise libev so that
		3673	doesn't need callbacks anymore.
		3674
		3675	Imagine you have coroutines that you can switch to using a function
		3676	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3677	and that due to some magic, the currently active coroutine is stored in a
		3678	global called C<current_coro>. Then you can build your own "wait for libev
		3679	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3680	the differing C<;> conventions):
		3681
		3682	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3683	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3684
		3685	That means instead of having a C callback function, you store the
		3686	coroutine to switch to in each watcher, and instead of having libev call
		3687	your callback, you instead have it switch to that coroutine.
		3688
		3689	A coroutine might now wait for an event with a function called
		3690	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3691	matter when, or whether the watcher is active or not when this function is
		3692	called):
		3693
		3694	void
		3695	wait_for_event (ev_watcher *w)
		3696	{
		3697	ev_cb_set (w) = current_coro;
		3698	switch_to (libev_coro);
		3699	}
		3700
		3701	That basically suspends the coroutine inside C<wait_for_event> and
		3702	continues the libev coroutine, which, when appropriate, switches back to
		3703	this or any other coroutine. I am sure if you sue this your own :)
		3704
		3705	You can do similar tricks if you have, say, threads with an event queue -
		3706	instead of storing a coroutine, you store the queue object and instead of
		3707	switching to a coroutine, you push the watcher onto the queue and notify
		3708	any waiters.
		3709
		3710	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3711	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3712
		3713	// my_ev.h
		3714	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3715	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3716	#include "../libev/ev.h"
		3717
		3718	// my_ev.c
		3719	#define EV_H "my_ev.h"
		3720	#include "../libev/ev.c"
		3721
		3722	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3723	F<my_ev.c> into your project. When properly specifying include paths, you
		3724	can even use F<ev.h> as header file name directly.
2463		3725
2464		3726
2465	=head1 LIBEVENT EMULATION	3727	=head1 LIBEVENT EMULATION
2466		3728
2467	Libev offers a compatibility emulation layer for libevent. It cannot	3729	Libev offers a compatibility emulation layer for libevent. It cannot
2468	emulate the internals of libevent, so here are some usage hints:	3730	emulate the internals of libevent, so here are some usage hints:
2469		3731
2470	=over 4	3732	=over 4
		3733
		3734	=item * Only the libevent-1.4.1-beta API is being emulated.
		3735
		3736	This was the newest libevent version available when libev was implemented,
		3737	and is still mostly unchanged in 2010.
2471		3738
2472	=item * Use it by including <event.h>, as usual.	3739	=item * Use it by including <event.h>, as usual.
2473		3740
2474	=item * The following members are fully supported: ev_base, ev_callback,	3741	=item * The following members are fully supported: ev_base, ev_callback,
2475	ev_arg, ev_fd, ev_res, ev_events.	3742	ev_arg, ev_fd, ev_res, ev_events.
…		…
2481	=item * Priorities are not currently supported. Initialising priorities	3748	=item * Priorities are not currently supported. Initialising priorities
2482	will fail and all watchers will have the same priority, even though there	3749	will fail and all watchers will have the same priority, even though there
2483	is an ev_pri field.	3750	is an ev_pri field.
2484		3751
2485	=item * In libevent, the last base created gets the signals, in libev, the	3752	=item * In libevent, the last base created gets the signals, in libev, the
2486	first base created (== the default loop) gets the signals.	3753	base that registered the signal gets the signals.
2487		3754
2488	=item * Other members are not supported.	3755	=item * Other members are not supported.
2489		3756
2490	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3757	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2491	to use the libev header file and library.	3758	to use the libev header file and library.
…		…
2510	Care has been taken to keep the overhead low. The only data member the C++	3777	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	3778	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	3779	that the watcher is associated with (or no additional members at all if
2513	you disable C<EV_MULTIPLICITY> when embedding libev).	3780	you disable C<EV_MULTIPLICITY> when embedding libev).
2514		3781
2515	Currently, functions, and static and non-static member functions can be	3782	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	3783	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	3784	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	3785	you need support for other types of functors please contact the author
2519	it).	3786	(preferably after implementing it).
2520		3787
2521	Here is a list of things available in the C<ev> namespace:	3788	Here is a list of things available in the C<ev> namespace:
2522		3789
2523	=over 4	3790	=over 4
2524		3791
…		…
2542		3809
2543	=over 4	3810	=over 4
2544		3811
2545	=item ev::TYPE::TYPE ()	3812	=item ev::TYPE::TYPE ()
2546		3813
2547	=item ev::TYPE::TYPE (struct ev_loop *)	3814	=item ev::TYPE::TYPE (loop)
2548		3815
2549	=item ev::TYPE::~TYPE	3816	=item ev::TYPE::~TYPE
2550		3817
2551	The constructor (optionally) takes an event loop to associate the watcher	3818	The constructor (optionally) takes an event loop to associate the watcher
2552	with. If it is omitted, it will use C<EV_DEFAULT>.	3819	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
2584		3851
2585	myclass obj;	3852	myclass obj;
2586	ev::io iow;	3853	ev::io iow;
2587	iow.set <myclass, &myclass::io_cb> (&obj);	3854	iow.set <myclass, &myclass::io_cb> (&obj);
2588		3855
		3856	=item w->set (object *)
		3857
		3858	This is a variation of a method callback - leaving out the method to call
		3859	will default the method to C<operator ()>, which makes it possible to use
		3860	functor objects without having to manually specify the C<operator ()> all
		3861	the time. Incidentally, you can then also leave out the template argument
		3862	list.
		3863
		3864	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3865	int revents)>.
		3866
		3867	See the method-C<set> above for more details.
		3868
		3869	Example: use a functor object as callback.
		3870
		3871	struct myfunctor
		3872	{
		3873	void operator() (ev::io &w, int revents)
		3874	{
		3875	...
		3876	}
		3877	}
		3878
		3879	myfunctor f;
		3880
		3881	ev::io w;
		3882	w.set (&f);
		3883
2589	=item w->set<function> (void *data = 0)	3884	=item w->set<function> (void *data = 0)
2590		3885
2591	Also sets a callback, but uses a static method or plain function as	3886	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	3887	callback. The optional C<data> argument will be stored in the watcher's
2593	C<data> member and is free for you to use.	3888	C<data> member and is free for you to use.
2594		3889
2595	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	3890	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2596		3891
2597	See the method-C<set> above for more details.	3892	See the method-C<set> above for more details.
2598		3893
2599	Example:	3894	Example: Use a plain function as callback.
2600		3895
2601	static void io_cb (ev::io &w, int revents) { }	3896	static void io_cb (ev::io &w, int revents) { }
2602	iow.set <io_cb> ();	3897	iow.set <io_cb> ();
2603		3898
2604	=item w->set (struct ev_loop *)	3899	=item w->set (loop)
2605		3900
2606	Associates a different C<struct ev_loop> with this watcher. You can only	3901	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).	3902	do this when the watcher is inactive (and not pending either).
2608		3903
2609	=item w->set ([arguments])	3904	=item w->set ([arguments])
2610		3905
2611	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3906	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	3907	method or a suitable start method must be called at least once. Unlike the
2613	automatically stopped and restarted when reconfiguring it with this	3908	C counterpart, an active watcher gets automatically stopped and restarted
2614	method.	3909	when reconfiguring it with this method.
2615		3910
2616	=item w->start ()	3911	=item w->start ()
2617		3912
2618	Starts the watcher. Note that there is no C<loop> argument, as the	3913	Starts the watcher. Note that there is no C<loop> argument, as the
2619	constructor already stores the event loop.	3914	constructor already stores the event loop.
2620		3915
		3916	=item w->start ([arguments])
		3917
		3918	Instead of calling C<set> and C<start> methods separately, it is often
		3919	convenient to wrap them in one call. Uses the same type of arguments as
		3920	the configure C<set> method of the watcher.
		3921
2621	=item w->stop ()	3922	=item w->stop ()
2622		3923
2623	Stops the watcher if it is active. Again, no C<loop> argument.	3924	Stops the watcher if it is active. Again, no C<loop> argument.
2624		3925
2625	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3926	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
2637		3938
2638	=back	3939	=back
2639		3940
2640	=back	3941	=back
2641		3942
2642	Example: Define a class with an IO and idle watcher, start one of them in	3943	Example: Define a class with two I/O and idle watchers, start the I/O
2643	the constructor.	3944	watchers in the constructor.
2644		3945
2645	class myclass	3946	class myclass
2646	{	3947	{
2647	ev::io io; void io_cb (ev::io &w, int revents);	3948	ev::io io ; void io_cb (ev::io &w, int revents);
		3949	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
2648	ev:idle idle void idle_cb (ev::idle &w, int revents);	3950	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2649		3951
2650	myclass (int fd)	3952	myclass (int fd)
2651	{	3953	{
2652	io .set <myclass, &myclass::io_cb > (this);	3954	io .set <myclass, &myclass::io_cb > (this);
		3955	io2 .set <myclass, &myclass::io2_cb > (this);
2653	idle.set <myclass, &myclass::idle_cb> (this);	3956	idle.set <myclass, &myclass::idle_cb> (this);
2654		3957
2655	io.start (fd, ev::READ);	3958	io.set (fd, ev::WRITE); // configure the watcher
		3959	io.start (); // start it whenever convenient
		3960
		3961	io2.start (fd, ev::READ); // set + start in one call
2656	}	3962	}
2657	};	3963	};
2658		3964
2659		3965
2660	=head1 OTHER LANGUAGE BINDINGS	3966	=head1 OTHER LANGUAGE BINDINGS
…		…
2669	=item Perl	3975	=item Perl
2670		3976
2671	The EV module implements the full libev API and is actually used to test	3977	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,	3978	libev. EV is developed together with libev. Apart from the EV core module,
2673	there are additional modules that implement libev-compatible interfaces	3979	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	3980	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>).	3981	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3982	and C<EV::Glib>).
2676		3983
2677	It can be found and installed via CPAN, its homepage is at	3984	It can be found and installed via CPAN, its homepage is at
2678	L<http://software.schmorp.de/pkg/EV>.	3985	L<http://software.schmorp.de/pkg/EV>.
2679		3986
2680	=item Python	3987	=item Python
2681		3988
2682	Python bindings can be found at L<http://code.google.com/p/pyev/>. It	3989	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	3990	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		3991
2689	=item Ruby	3992	=item Ruby
2690		3993
2691	Tony Arcieri has written a ruby extension that offers access to a subset	3994	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	3995	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	3996	more on top of it. It can be found via gem servers. Its homepage is at
2694	L<http://rev.rubyforge.org/>.	3997	L<http://rev.rubyforge.org/>.
2695		3998
		3999	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		4000	makes rev work even on mingw.
		4001
		4002	=item Haskell
		4003
		4004	A haskell binding to libev is available at
		4005	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		4006
2696	=item D	4007	=item D
2697		4008
2698	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4009	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>.	4010	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		4011
		4012	=item Ocaml
		4013
		4014	Erkki Seppala has written Ocaml bindings for libev, to be found at
		4015	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		4016
		4017	=item Lua
		4018
		4019	Brian Maher has written a partial interface to libev for lua (at the
		4020	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
		4021	L<http://github.com/brimworks/lua-ev>.
2700		4022
2701	=back	4023	=back
2702		4024
2703		4025
2704	=head1 MACRO MAGIC	4026	=head1 MACRO MAGIC
…		…
2718	loop argument"). The C<EV_A> form is used when this is the sole argument,	4040	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:	4041	C<EV_A_> is used when other arguments are following. Example:
2720		4042
2721	ev_unref (EV_A);	4043	ev_unref (EV_A);
2722	ev_timer_add (EV_A_ watcher);	4044	ev_timer_add (EV_A_ watcher);
2723	ev_loop (EV_A_ 0);	4045	ev_run (EV_A_ 0);
2724		4046
2725	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4047	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2726	which is often provided by the following macro.	4048	which is often provided by the following macro.
2727		4049
2728	=item C<EV_P>, C<EV_P_>	4050	=item C<EV_P>, C<EV_P_>
…		…
2768	}	4090	}
2769		4091
2770	ev_check check;	4092	ev_check check;
2771	ev_check_init (&check, check_cb);	4093	ev_check_init (&check, check_cb);
2772	ev_check_start (EV_DEFAULT_ &check);	4094	ev_check_start (EV_DEFAULT_ &check);
2773	ev_loop (EV_DEFAULT_ 0);	4095	ev_run (EV_DEFAULT_ 0);
2774		4096
2775	=head1 EMBEDDING	4097	=head1 EMBEDDING
2776		4098
2777	Libev can (and often is) directly embedded into host	4099	Libev can (and often is) directly embedded into host
2778	applications. Examples of applications that embed it include the Deliantra	4100	applications. Examples of applications that embed it include the Deliantra
…		…
2805		4127
2806	#define EV_STANDALONE 1	4128	#define EV_STANDALONE 1
2807	#include "ev.h"	4129	#include "ev.h"
2808		4130
2809	Both header files and implementation files can be compiled with a C++	4131	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	4132	compiler (at least, that's a stated goal, and breakage will be treated
2811	as a bug).	4133	as a bug).
2812		4134
2813	You need the following files in your source tree, or in a directory	4135	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):	4136	in your include path (e.g. in libev/ when using -Ilibev):
2815		4137
…		…
2858	libev.m4	4180	libev.m4
2859		4181
2860	=head2 PREPROCESSOR SYMBOLS/MACROS	4182	=head2 PREPROCESSOR SYMBOLS/MACROS
2861		4183
2862	Libev can be configured via a variety of preprocessor symbols you have to	4184	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	4185	define before including (or compiling) any of its files. The default in
2864	autoconf is noted for every option.	4186	the absence of autoconf is documented for every option.
		4187
		4188	Symbols marked with "(h)" do not change the ABI, and can have different
		4189	values when compiling libev vs. including F<ev.h>, so it is permissible
		4190	to redefine them before including F<ev.h> without breaking compatibility
		4191	to a compiled library. All other symbols change the ABI, which means all
		4192	users of libev and the libev code itself must be compiled with compatible
		4193	settings.
2865		4194
2866	=over 4	4195	=over 4
2867		4196
		4197	=item EV_COMPAT3 (h)
		4198
		4199	Backwards compatibility is a major concern for libev. This is why this
		4200	release of libev comes with wrappers for the functions and symbols that
		4201	have been renamed between libev version 3 and 4.
		4202
		4203	You can disable these wrappers (to test compatibility with future
		4204	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4205	sources. This has the additional advantage that you can drop the C<struct>
		4206	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4207	typedef in that case.
		4208
		4209	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4210	and in some even more future version the compatibility code will be
		4211	removed completely.
		4212
2868	=item EV_STANDALONE	4213	=item EV_STANDALONE (h)
2869		4214
2870	Must always be C<1> if you do not use autoconf configuration, which	4215	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	4216	keeps libev from including F<config.h>, and it also defines dummy
2872	implementations for some libevent functions (such as logging, which is not	4217	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	4218	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.	4219	F<event.h> that are not directly supported by the libev core alone.
2875		4220
		4221	In standalone mode, libev will still try to automatically deduce the
		4222	configuration, but has to be more conservative.
		4223
		4224	=item EV_USE_FLOOR
		4225
		4226	If defined to be C<1>, libev will use the C<floor ()> function for its
		4227	periodic reschedule calculations, otherwise libev will fall back on a
		4228	portable (slower) implementation. If you enable this, you usually have to
		4229	link against libm or something equivalent. Enabling this when the C<floor>
		4230	function is not available will fail, so the safe default is to not enable
		4231	this.
		4232
2876	=item EV_USE_MONOTONIC	4233	=item EV_USE_MONOTONIC
2877		4234
2878	If defined to be C<1>, libev will try to detect the availability of the	4235	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	4236	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	4237	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	4238	you usually have to link against librt or something similar. Enabling it
2882	the functionality isn't available is safe, though, although you have	4239	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>	4240	to make sure you link against any libraries where the C<clock_gettime>
2884	function is hiding in (often F<-lrt>).	4241	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2885		4242
2886	=item EV_USE_REALTIME	4243	=item EV_USE_REALTIME
2887		4244
2888	If defined to be C<1>, libev will try to detect the availability of the	4245	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	4246	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	4247	at runtime if successful). Otherwise no use of the real-time clock
2891	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	4248	option will be attempted. This effectively replaces C<gettimeofday>
2892	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	4249	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2893	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	4250	correctness. See the note about libraries in the description of
		4251	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		4252	C<EV_USE_CLOCK_SYSCALL>.
		4253
		4254	=item EV_USE_CLOCK_SYSCALL
		4255
		4256	If defined to be C<1>, libev will try to use a direct syscall instead
		4257	of calling the system-provided C<clock_gettime> function. This option
		4258	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		4259	unconditionally pulls in C<libpthread>, slowing down single-threaded
		4260	programs needlessly. Using a direct syscall is slightly slower (in
		4261	theory), because no optimised vdso implementation can be used, but avoids
		4262	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		4263	higher, as it simplifies linking (no need for C<-lrt>).
2894		4264
2895	=item EV_USE_NANOSLEEP	4265	=item EV_USE_NANOSLEEP
2896		4266
2897	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	4267	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 ()>.	4268	and will use it for delays. Otherwise it will use C<select ()>.
…		…
2914		4284
2915	=item EV_SELECT_USE_FD_SET	4285	=item EV_SELECT_USE_FD_SET
2916		4286
2917	If defined to C<1>, then the select backend will use the system C<fd_set>	4287	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	4288	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	4289	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	4290	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	4291	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	4292	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2923	influence the size of the C<fd_set> used.	4293	configures the maximum size of the C<fd_set>.
2924		4294
2925	=item EV_SELECT_IS_WINSOCKET	4295	=item EV_SELECT_IS_WINSOCKET
2926		4296
2927	When defined to C<1>, the select backend will assume that	4297	When defined to C<1>, the select backend will assume that
2928	select/socket/connect etc. don't understand file descriptors but	4298	select/socket/connect etc. don't understand file descriptors but
…		…
2930	be used is the winsock select). This means that it will call	4300	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,	4301	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	4302	it is assumed that all these functions actually work on fds, even
2933	on win32. Should not be defined on non-win32 platforms.	4303	on win32. Should not be defined on non-win32 platforms.
2934		4304
2935	=item EV_FD_TO_WIN32_HANDLE	4305	=item EV_FD_TO_WIN32_HANDLE(fd)
2936		4306
2937	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	4307	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	4308	file descriptors to socket handles. When not defining this symbol (the
2939	default), then libev will call C<_get_osfhandle>, which is usually	4309	default), then libev will call C<_get_osfhandle>, which is usually
2940	correct. In some cases, programs use their own file descriptor management,	4310	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.	4311	in which case they can provide this function to map fds to socket handles.
		4312
		4313	=item EV_WIN32_HANDLE_TO_FD(handle)
		4314
		4315	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		4316	using the standard C<_open_osfhandle> function. For programs implementing
		4317	their own fd to handle mapping, overwriting this function makes it easier
		4318	to do so. This can be done by defining this macro to an appropriate value.
		4319
		4320	=item EV_WIN32_CLOSE_FD(fd)
		4321
		4322	If programs implement their own fd to handle mapping on win32, then this
		4323	macro can be used to override the C<close> function, useful to unregister
		4324	file descriptors again. Note that the replacement function has to close
		4325	the underlying OS handle.
2942		4326
2943	=item EV_USE_POLL	4327	=item EV_USE_POLL
2944		4328
2945	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4329	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	4330	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
2985	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4369	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2986		4370
2987	=item EV_ATOMIC_T	4371	=item EV_ATOMIC_T
2988		4372
2989	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4373	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	4374	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	4375	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"	4376	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.	4377	both for signal handler "locking" as well as for signal and thread safety
		4378	in C<ev_async> watchers.
2994		4379
2995	In the absence of this define, libev will use C<sig_atomic_t volatile>	4380	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.	4381	(from F<signal.h>), which is usually good enough on most platforms.
2997		4382
2998	=item EV_H	4383	=item EV_H (h)
2999		4384
3000	The name of the F<ev.h> header file used to include it. The default if	4385	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	4386	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.	4387	used to virtually rename the F<ev.h> header file in case of conflicts.
3003		4388
3004	=item EV_CONFIG_H	4389	=item EV_CONFIG_H (h)
3005		4390
3006	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4391	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	4392	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3008	C<EV_H>, above.	4393	C<EV_H>, above.
3009		4394
3010	=item EV_EVENT_H	4395	=item EV_EVENT_H (h)
3011		4396
3012	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4397	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">.	4398	of how the F<event.h> header can be found, the default is C<"event.h">.
3014		4399
3015	=item EV_PROTOTYPES	4400	=item EV_PROTOTYPES (h)
3016		4401
3017	If defined to be C<0>, then F<ev.h> will not define any function	4402	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	4403	prototypes, but still define all the structs and other symbols. This is
3019	occasionally useful if you want to provide your own wrapper functions	4404	occasionally useful if you want to provide your own wrapper functions
3020	around libev functions.	4405	around libev functions.
…		…
3039	When doing priority-based operations, libev usually has to linearly search	4424	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	4425	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	4426	and time, so using the defaults of five priorities (-2 .. +2) is usually
3042	fine.	4427	fine.
3043		4428
3044	If your embedding application does not need any priorities, defining these both to	4429	If your embedding application does not need any priorities, defining these
3045	C<0> will save some memory and CPU.	4430	both to C<0> will save some memory and CPU.
3046		4431
3047	=item EV_PERIODIC_ENABLE	4432	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4433	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4434	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3048		4435
3049	If undefined or defined to be C<1>, then periodic timers are supported. If	4436	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	4437	the respective watcher type is supported. If defined to be C<0>, then it
3051	code.	4438	is not. Disabling watcher types mainly saves code size.
3052		4439
3053	=item EV_IDLE_ENABLE	4440	=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		4441
3081	If you need to shave off some kilobytes of code at the expense of some	4442	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	4443	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	4444	certain subsets of functionality. The default is to enable all features
3084	much smaller 2-heap for timer management over the default 4-heap.	4445	that can be enabled on the platform.
		4446
		4447	A typical way to use this symbol is to define it to C<0> (or to a bitset
		4448	with some broad features you want) and then selectively re-enable
		4449	additional parts you want, for example if you want everything minimal,
		4450	but multiple event loop support, async and child watchers and the poll
		4451	backend, use this:
		4452
		4453	#define EV_FEATURES 0
		4454	#define EV_MULTIPLICITY 1
		4455	#define EV_USE_POLL 1
		4456	#define EV_CHILD_ENABLE 1
		4457	#define EV_ASYNC_ENABLE 1
		4458
		4459	The actual value is a bitset, it can be a combination of the following
		4460	values:
		4461
		4462	=over 4
		4463
		4464	=item C<1> - faster/larger code
		4465
		4466	Use larger code to speed up some operations.
		4467
		4468	Currently this is used to override some inlining decisions (enlarging the
		4469	code size by roughly 30% on amd64).
		4470
		4471	When optimising for size, use of compiler flags such as C<-Os> with
		4472	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4473	assertions.
		4474
		4475	=item C<2> - faster/larger data structures
		4476
		4477	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4478	hash table sizes and so on. This will usually further increase code size
		4479	and can additionally have an effect on the size of data structures at
		4480	runtime.
		4481
		4482	=item C<4> - full API configuration
		4483
		4484	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4485	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4486
		4487	=item C<8> - full API
		4488
		4489	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4490	details on which parts of the API are still available without this
		4491	feature, and do not complain if this subset changes over time.
		4492
		4493	=item C<16> - enable all optional watcher types
		4494
		4495	Enables all optional watcher types. If you want to selectively enable
		4496	only some watcher types other than I/O and timers (e.g. prepare,
		4497	embed, async, child...) you can enable them manually by defining
		4498	C<EV_watchertype_ENABLE> to C<1> instead.
		4499
		4500	=item C<32> - enable all backends
		4501
		4502	This enables all backends - without this feature, you need to enable at
		4503	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4504
		4505	=item C<64> - enable OS-specific "helper" APIs
		4506
		4507	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4508	default.
		4509
		4510	=back
		4511
		4512	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4513	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4514	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4515	watchers, timers and monotonic clock support.
		4516
		4517	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4518	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4519	your program might be left out as well - a binary starting a timer and an
		4520	I/O watcher then might come out at only 5Kb.
		4521
		4522	=item EV_AVOID_STDIO
		4523
		4524	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4525	functions (printf, scanf, perror etc.). This will increase the code size
		4526	somewhat, but if your program doesn't otherwise depend on stdio and your
		4527	libc allows it, this avoids linking in the stdio library which is quite
		4528	big.
		4529
		4530	Note that error messages might become less precise when this option is
		4531	enabled.
		4532
		4533	=item EV_NSIG
		4534
		4535	The highest supported signal number, +1 (or, the number of
		4536	signals): Normally, libev tries to deduce the maximum number of signals
		4537	automatically, but sometimes this fails, in which case it can be
		4538	specified. Also, using a lower number than detected (C<32> should be
		4539	good for about any system in existence) can save some memory, as libev
		4540	statically allocates some 12-24 bytes per signal number.
3085		4541
3086	=item EV_PID_HASHSIZE	4542	=item EV_PID_HASHSIZE
3087		4543
3088	C<ev_child> watchers use a small hash table to distribute workload by	4544	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	4545	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	4546	usually more than enough. If you need to manage thousands of children you
3091	increase this value (I<must> be a power of two).	4547	might want to increase this value (I<must> be a power of two).
3092		4548
3093	=item EV_INOTIFY_HASHSIZE	4549	=item EV_INOTIFY_HASHSIZE
3094		4550
3095	C<ev_stat> watchers use a small hash table to distribute workload by	4551	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>),	4552	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>	4553	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	4554	C<ev_stat> watchers you might want to increase this value (I<must> be a
3099	two).	4555	power of two).
3100		4556
3101	=item EV_USE_4HEAP	4557	=item EV_USE_4HEAP
3102		4558
3103	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4559	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	4560	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	4561	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3106	noticeably faster performance with many (thousands) of watchers.	4562	faster performance with many (thousands) of watchers.
3107		4563
3108	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4564	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3109	(disabled).	4565	will be C<0>.
3110		4566
3111	=item EV_HEAP_CACHE_AT	4567	=item EV_HEAP_CACHE_AT
3112		4568
3113	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4569	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	4570	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>),	4571	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,	4572	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	4573	but avoids random read accesses on heap changes. This improves performance
3118	noticeably with with many (hundreds) of watchers.	4574	noticeably with many (hundreds) of watchers.
3119		4575
3120	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4576	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3121	(disabled).	4577	will be C<0>.
3122		4578
3123	=item EV_VERIFY	4579	=item EV_VERIFY
3124		4580
3125	Controls how much internal verification (see C<ev_loop_verify ()>) will	4581	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	4582	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	4583	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	4584	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	4585	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	4586	verification code will be called very frequently, which will slow down
3131	libev considerably.	4587	libev considerably.
3132		4588
3133	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4589	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3134	C<0.>	4590	will be C<0>.
3135		4591
3136	=item EV_COMMON	4592	=item EV_COMMON
3137		4593
3138	By default, all watchers have a C<void *data> member. By redefining	4594	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	4595	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,	4596	members. You have to define it each time you include one of the files,
3141	though, and it must be identical each time.	4597	though, and it must be identical each time.
3142		4598
3143	For example, the perl EV module uses something like this:	4599	For example, the perl EV module uses something like this:
3144		4600
…		…
3156	and the way callbacks are invoked and set. Must expand to a struct member	4612	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	4613	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	4614	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	4615	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++.	4616	method calls instead of plain function calls in C++.
		4617
		4618	=back
3161		4619
3162	=head2 EXPORTED API SYMBOLS	4620	=head2 EXPORTED API SYMBOLS
3163		4621
3164	If you need to re-export the API (e.g. via a DLL) and you need a list of	4622	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	4623	exported symbols, you can use the provided F<Symbol.*> files which list
…		…
3195	file.	4653	file.
3196		4654
3197	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4655	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:	4656	that everybody includes and which overrides some configure choices:
3199		4657
3200	#define EV_MINIMAL 1	4658	#define EV_FEATURES 8
3201	#define EV_USE_POLL 0	4659	#define EV_USE_SELECT 1
3202	#define EV_MULTIPLICITY 0
3203	#define EV_PERIODIC_ENABLE 0	4660	#define EV_PREPARE_ENABLE 1
		4661	#define EV_IDLE_ENABLE 1
3204	#define EV_STAT_ENABLE 0	4662	#define EV_SIGNAL_ENABLE 1
3205	#define EV_FORK_ENABLE 0	4663	#define EV_CHILD_ENABLE 1
		4664	#define EV_USE_STDEXCEPT 0
3206	#define EV_CONFIG_H <config.h>	4665	#define EV_CONFIG_H <config.h>
3207	#define EV_MINPRI 0
3208	#define EV_MAXPRI 0
3209		4666
3210	#include "ev++.h"	4667	#include "ev++.h"
3211		4668
3212	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4669	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3213		4670
3214	#include "ev_cpp.h"	4671	#include "ev_cpp.h"
3215	#include "ev.c"	4672	#include "ev.c"
3216		4673
		4674	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3217		4675
3218	=head1 THREADS AND COROUTINES	4676	=head2 THREADS AND COROUTINES
3219		4677
3220	=head2 THREADS	4678	=head3 THREADS
3221		4679
3222	Libev itself is completely thread-safe, but it uses no locking. This	4680	All libev functions are reentrant and thread-safe unless explicitly
		4681	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	4682	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	4683	are no concurrent calls into any libev function with the same loop
3225	parameter.	4684	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		4685	of course): libev guarantees that different event loops share no data
		4686	structures that need any locking.
3226		4687
3227	Or put differently: calls with different loop parameters can be done in	4688	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	4689	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	4690	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	4691	only one thread ever is inside a call at any point in time, e.g. by using
3231	per loop).	4692	a mutex per loop).
		4693
		4694	Specifically to support threads (and signal handlers), libev implements
		4695	so-called C<ev_async> watchers, which allow some limited form of
		4696	concurrency on the same event loop, namely waking it up "from the
		4697	outside".
3232		4698
3233	If you want to know which design (one loop, locking, or multiple loops	4699	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	4700	without or something else still) is best for your problem, then I cannot
3235	help you. I can give some generic advice however:	4701	help you, but here is some generic advice:
3236		4702
3237	=over 4	4703	=over 4
3238		4704
3239	=item * most applications have a main thread: use the default libev loop	4705	=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.	4706	in that thread, or create a separate thread running only the default loop.
…		…
3252		4718
3253	Choosing a model is hard - look around, learn, know that usually you can do	4719	Choosing a model is hard - look around, learn, know that usually you can do
3254	better than you currently do :-)	4720	better than you currently do :-)
3255		4721
3256	=item * often you need to talk to some other thread which blocks in the	4722	=item * often you need to talk to some other thread which blocks in the
		4723	event loop.
		4724
3257	event loop - C<ev_async> watchers can be used to wake them up from other	4725	C<ev_async> watchers can be used to wake them up from other threads safely
3258	threads safely (or from signal contexts...).	4726	(or from signal contexts...).
		4727
		4728	An example use would be to communicate signals or other events that only
		4729	work in the default loop by registering the signal watcher with the
		4730	default loop and triggering an C<ev_async> watcher from the default loop
		4731	watcher callback into the event loop interested in the signal.
3259		4732
3260	=back	4733	=back
3261		4734
		4735	See also L<THREAD LOCKING EXAMPLE>.
		4736
3262	=head2 COROUTINES	4737	=head3 COROUTINES
3263		4738
3264	Libev is much more accommodating to coroutines ("cooperative threads"):	4739	Libev is very accommodating to coroutines ("cooperative threads"):
3265	libev fully supports nesting calls to it's functions from different	4740	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	4741	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	4742	different coroutines, and switch freely between both coroutines running
3268	loop, as long as you don't confuse yourself). The only exception is that	4743	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.	4744	that you must not do this from C<ev_periodic> reschedule callbacks.
3270		4745
3271	Care has been invested into making sure that libev does not keep local	4746	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	4747	C<ev_run>, and other calls do not usually allow for coroutine switches as
3273	switches.	4748	they do not call any callbacks.
3274		4749
		4750	=head2 COMPILER WARNINGS
3275		4751
3276	=head1 COMPLEXITIES	4752	Depending on your compiler and compiler settings, you might get no or a
		4753	lot of warnings when compiling libev code. Some people are apparently
		4754	scared by this.
3277		4755
3278	In this section the complexities of (many of) the algorithms used inside	4756	However, these are unavoidable for many reasons. For one, each compiler
3279	libev will be explained. For complexity discussions about backends see the	4757	has different warnings, and each user has different tastes regarding
3280	documentation for C<ev_default_init>.	4758	warning options. "Warn-free" code therefore cannot be a goal except when
		4759	targeting a specific compiler and compiler-version.
3281		4760
3282	All of the following are about amortised time: If an array needs to be	4761	Another reason is that some compiler warnings require elaborate
3283	extended, libev needs to realloc and move the whole array, but this	4762	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	4763	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		4764
3288	=over 4	4765	And of course, some compiler warnings are just plain stupid, or simply
		4766	wrong (because they don't actually warn about the condition their message
		4767	seems to warn about). For example, certain older gcc versions had some
		4768	warnings that resulted in an extreme number of false positives. These have
		4769	been fixed, but some people still insist on making code warn-free with
		4770	such buggy versions.
3289		4771
3290	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	4772	While libev is written to generate as few warnings as possible,
		4773	"warn-free" code is not a goal, and it is recommended not to build libev
		4774	with any compiler warnings enabled unless you are prepared to cope with
		4775	them (e.g. by ignoring them). Remember that warnings are just that:
		4776	warnings, not errors, or proof of bugs.
3291		4777
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		4778
3296	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	4779	=head2 VALGRIND
3297		4780
3298	That means that changing a timer costs less than removing/adding them	4781	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.	4782	highly useful. Unfortunately, valgrind reports are very hard to interpret.
3300		4783
3301	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	4784	If you think you found a bug (memory leak, uninitialised data access etc.)
		4785	in libev, then check twice: If valgrind reports something like:
3302		4786
3303	These just add the watcher into an array or at the head of a list.	4787	==2274== definitely lost: 0 bytes in 0 blocks.
		4788	==2274== possibly lost: 0 bytes in 0 blocks.
		4789	==2274== still reachable: 256 bytes in 1 blocks.
3304		4790
3305	=item Stopping check/prepare/idle/fork/async watchers: O(1)	4791	Then there is no memory leak, just as memory accounted to global variables
		4792	is not a memleak - the memory is still being referenced, and didn't leak.
3306		4793
3307	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	4794	Similarly, under some circumstances, valgrind might report kernel bugs
		4795	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		4796	although an acceptable workaround has been found here), or it might be
		4797	confused.
3308		4798
3309	These watchers are stored in lists then need to be walked to find the	4799	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	4800	make it into some kind of religion.
3311	have many watchers waiting for the same fd or signal).
3312		4801
3313	=item Finding the next timer in each loop iteration: O(1)	4802	If you are unsure about something, feel free to contact the mailing list
		4803	with the full valgrind report and an explanation on why you think this
		4804	is a bug in libev (best check the archives, too :). However, don't be
		4805	annoyed when you get a brisk "this is no bug" answer and take the chance
		4806	of learning how to interpret valgrind properly.
3314		4807
3315	By virtue of using a binary or 4-heap, the next timer is always found at a	4808	If you need, for some reason, empty reports from valgrind for your project
3316	fixed position in the storage array.	4809	I suggest using suppression lists.
3317		4810
3318	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3319		4811
3320	A change means an I/O watcher gets started or stopped, which requires	4812	=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		4813
3324	=item Activating one watcher (putting it into the pending state): O(1)	4814	=head2 GNU/LINUX 32 BIT LIMITATIONS
3325		4815
3326	=item Priority handling: O(number_of_priorities)	4816	GNU/Linux is the only common platform that supports 64 bit file/large file
		4817	interfaces but I<disables> them by default.
3327		4818
3328	Priorities are implemented by allocating some space for each	4819	That means that libev compiled in the default environment doesn't support
3329	priority. When doing priority-based operations, libev usually has to	4820	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		4821
3333	=item Sending an ev_async: O(1)	4822	Unfortunately, many programs try to work around this GNU/Linux issue
		4823	by enabling the large file API, which makes them incompatible with the
		4824	standard libev compiled for their system.
3334		4825
3335	=item Processing ev_async_send: O(number_of_async_watchers)	4826	Likewise, libev cannot enable the large file API itself as this would
		4827	suddenly make it incompatible to the default compile time environment,
		4828	i.e. all programs not using special compile switches.
3336		4829
3337	=item Processing signals: O(max_signal_number)	4830	=head2 OS/X AND DARWIN BUGS
3338		4831
3339	Sending involves a system call I<iff> there were no other C<ev_async_send>	4832	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	4833	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.	4834	OpenGL drivers.
3342		4835
3343	=back	4836	=head3 C<kqueue> is buggy
3344		4837
		4838	The kqueue syscall is broken in all known versions - most versions support
		4839	only sockets, many support pipes.
3345		4840
		4841	Libev tries to work around this by not using C<kqueue> by default on this
		4842	rotten platform, but of course you can still ask for it when creating a
		4843	loop - embedding a socket-only kqueue loop into a select-based one is
		4844	probably going to work well.
		4845
		4846	=head3 C<poll> is buggy
		4847
		4848	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4849	implementation by something calling C<kqueue> internally around the 10.5.6
		4850	release, so now C<kqueue> I<and> C<poll> are broken.
		4851
		4852	Libev tries to work around this by not using C<poll> by default on
		4853	this rotten platform, but of course you can still ask for it when creating
		4854	a loop.
		4855
		4856	=head3 C<select> is buggy
		4857
		4858	All that's left is C<select>, and of course Apple found a way to fuck this
		4859	one up as well: On OS/X, C<select> actively limits the number of file
		4860	descriptors you can pass in to 1024 - your program suddenly crashes when
		4861	you use more.
		4862
		4863	There is an undocumented "workaround" for this - defining
		4864	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4865	work on OS/X.
		4866
		4867	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4868
		4869	=head3 C<errno> reentrancy
		4870
		4871	The default compile environment on Solaris is unfortunately so
		4872	thread-unsafe that you can't even use components/libraries compiled
		4873	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4874	defined by default. A valid, if stupid, implementation choice.
		4875
		4876	If you want to use libev in threaded environments you have to make sure
		4877	it's compiled with C<_REENTRANT> defined.
		4878
		4879	=head3 Event port backend
		4880
		4881	The scalable event interface for Solaris is called "event
		4882	ports". Unfortunately, this mechanism is very buggy in all major
		4883	releases. If you run into high CPU usage, your program freezes or you get
		4884	a large number of spurious wakeups, make sure you have all the relevant
		4885	and latest kernel patches applied. No, I don't know which ones, but there
		4886	are multiple ones to apply, and afterwards, event ports actually work
		4887	great.
		4888
		4889	If you can't get it to work, you can try running the program by setting
		4890	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4891	C<select> backends.
		4892
		4893	=head2 AIX POLL BUG
		4894
		4895	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4896	this by trying to avoid the poll backend altogether (i.e. it's not even
		4897	compiled in), which normally isn't a big problem as C<select> works fine
		4898	with large bitsets on AIX, and AIX is dead anyway.
		4899
3346	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4900	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4901
		4902	=head3 General issues
3347		4903
3348	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4904	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	4905	requires, and its I/O model is fundamentally incompatible with the POSIX
3350	model. Libev still offers limited functionality on this platform in	4906	model. Libev still offers limited functionality on this platform in
3351	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4907	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3352	descriptors. This only applies when using Win32 natively, not when using	4908	descriptors. This only applies when using Win32 natively, not when using
3353	e.g. cygwin.	4909	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4910	as every compiler comes with a slightly differently broken/incompatible
		4911	environment.
3354		4912
3355	Lifting these limitations would basically require the full	4913	Lifting these limitations would basically require the full
3356	re-implementation of the I/O system. If you are into these kinds of	4914	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	4915	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).	4916	also that glib is the slowest event library known to man).
3359		4917
3360	There is no supported compilation method available on windows except	4918	There is no supported compilation method available on windows except
3361	embedding it into other applications.	4919	embedding it into other applications.
		4920
		4921	Sensible signal handling is officially unsupported by Microsoft - libev
		4922	tries its best, but under most conditions, signals will simply not work.
3362		4923
3363	Not a libev limitation but worth mentioning: windows apparently doesn't	4924	Not a libev limitation but worth mentioning: windows apparently doesn't
3364	accept large writes: instead of resulting in a partial write, windows will	4925	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,	4926	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	4927	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	4928	megabyte seems safe, but this apparently depends on the amount of memory
3368	available).	4929	available).
3369		4930
3370	Due to the many, low, and arbitrary limits on the win32 platform and	4931	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	4932	the abysmal performance of winsockets, using a large number of sockets
3372	is not recommended (and not reasonable). If your program needs to use	4933	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	4934	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	4935	different implementation for windows, as libev offers the POSIX readiness
3375	notification model, which cannot be implemented efficiently on windows	4936	notification model, which cannot be implemented efficiently on windows
3376	(Microsoft monopoly games).	4937	(due to Microsoft monopoly games).
3377		4938
3378	A typical way to use libev under windows is to embed it (see the embedding	4939	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	4940	section for details) and use the following F<evwrap.h> header file instead
3380	of F<ev.h>:	4941	of F<ev.h>:
3381		4942
…		…
3383	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */	4944	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3384		4945
3385	#include "ev.h"	4946	#include "ev.h"
3386		4947
3387	And compile the following F<evwrap.c> file into your project (make sure	4948	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!):	4949	you do I<not> compile the F<ev.c> or any other embedded source files!):
3389		4950
3390	#include "evwrap.h"	4951	#include "evwrap.h"
3391	#include "ev.c"	4952	#include "ev.c"
3392		4953
3393	=over 4
3394
3395	=item The winsocket select function	4954	=head3 The winsocket C<select> function
3396		4955
3397	The winsocket C<select> function doesn't follow POSIX in that it	4956	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	4957	requires socket I<handles> and not socket I<file descriptors> (it is
3399	also extremely buggy). This makes select very inefficient, and also	4958	also extremely buggy). This makes select very inefficient, and also
3400	requires a mapping from file descriptors to socket handles (the Microsoft	4959	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 */	4968	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3410		4969
3411	Note that winsockets handling of fd sets is O(n), so you can easily get a	4970	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.	4971	complexity in the O(n²) range when using win32.
3413		4972
3414	=item Limited number of file descriptors	4973	=head3 Limited number of file descriptors
3415		4974
3416	Windows has numerous arbitrary (and low) limits on things.	4975	Windows has numerous arbitrary (and low) limits on things.
3417		4976
3418	Early versions of winsocket's select only supported waiting for a maximum	4977	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	4978	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	4979	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	4980	recommends spawning a chain of threads and wait for 63 handles and the
3422	previous thread in each. Great).	4981	previous thread in each. Sounds great!).
3423		4982
3424	Newer versions support more handles, but you need to define C<FD_SETSIZE>	4983	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	4984	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	4985	call (which might be in libev or elsewhere, for example, perl and many
3427	select emulation on windows).	4986	other interpreters do their own select emulation on windows).
3428		4987
3429	Another limit is the number of file descriptors in the Microsoft runtime	4988	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	4989	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	4990	fetish or something like this inside Microsoft). You can increase this
3432	C<_setmaxstdio>, which can increase this limit to C<2048> (another	4991	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	4992	(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	4993	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	4994	(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	4995	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.	4996	the cost of calling select (O(n²)) will likely make this unworkable.
3440		4997
3441	=back
3442
3443
3444	=head1 PORTABILITY REQUIREMENTS	4998	=head2 PORTABILITY REQUIREMENTS
3445		4999
3446	In addition to a working ISO-C implementation, libev relies on a few	5000	In addition to a working ISO-C implementation and of course the
3447	additional extensions:	5001	backend-specific APIs, libev relies on a few additional extensions:
3448		5002
3449	=over 4	5003	=over 4
3450		5004
3451	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible	5005	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
3452	calling conventions regardless of C<ev_watcher_type *>.	5006	calling conventions regardless of C<ev_watcher_type *>.
…		…
3455	structure (guaranteed by POSIX but not by ISO C for example), but it also	5009	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	5010	assumes that the same (machine) code can be used to call any watcher
3457	callback: The watcher callbacks have different type signatures, but libev	5011	callback: The watcher callbacks have different type signatures, but libev
3458	calls them using an C<ev_watcher *> internally.	5012	calls them using an C<ev_watcher *> internally.
3459		5013
		5014	=item pointer accesses must be thread-atomic
		5015
		5016	Accessing a pointer value must be atomic, it must both be readable and
		5017	writable in one piece - this is the case on all current architectures.
		5018
3460	=item C<sig_atomic_t volatile> must be thread-atomic as well	5019	=item C<sig_atomic_t volatile> must be thread-atomic as well
3461		5020
3462	The type C<sig_atomic_t volatile> (or whatever is defined as	5021	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	5022	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	5023	threads. This is not part of the specification for C<sig_atomic_t>, but is
3465	believed to be sufficiently portable.	5024	believed to be sufficiently portable.
3466		5025
3467	=item C<sigprocmask> must work in a threaded environment	5026	=item C<sigprocmask> must work in a threaded environment
3468		5027
…		…
3477	except the initial one, and run the default loop in the initial thread as	5036	except the initial one, and run the default loop in the initial thread as
3478	well.	5037	well.
3479		5038
3480	=item C<long> must be large enough for common memory allocation sizes	5039	=item C<long> must be large enough for common memory allocation sizes
3481		5040
3482	To improve portability and simplify using libev, libev uses C<long>	5041	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	5042	instead of C<size_t> when allocating its data structures. On non-POSIX
3484	non-POSIX systems (Microsoft...) this might be unexpectedly low, but	5043	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	5044	least 31 bits everywhere, which is enough for hundreds of millions of
3486	millions of watchers.	5045	watchers.
3487		5046
3488	=item C<double> must hold a time value in seconds with enough accuracy	5047	=item C<double> must hold a time value in seconds with enough accuracy
3489		5048
3490	The type C<double> is used to represent timestamps. It is required to	5049	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	5050	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	5051	good enough for at least into the year 4000 with millisecond accuracy
		5052	(the design goal for libev). This requirement is overfulfilled by
3493	implementations implementing IEEE 754 (basically all existing ones).	5053	implementations using IEEE 754, which is basically all existing ones. With
		5054	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
3494		5055
3495	=back	5056	=back
3496		5057
3497	If you know of other additional requirements drop me a note.	5058	If you know of other additional requirements drop me a note.
3498		5059
3499		5060
3500	=head1 COMPILER WARNINGS	5061	=head1 ALGORITHMIC COMPLEXITIES
3501		5062
3502	Depending on your compiler and compiler settings, you might get no or a	5063	In this section the complexities of (many of) the algorithms used inside
3503	lot of warnings when compiling libev code. Some people are apparently	5064	libev will be documented. For complexity discussions about backends see
3504	scared by this.	5065	the documentation for C<ev_default_init>.
3505		5066
3506	However, these are unavoidable for many reasons. For one, each compiler	5067	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	5068	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	5069	happens asymptotically rarer with higher number of elements, so O(1) might
3509	targeting a specific compiler and compiler-version.	5070	mean that libev does a lengthy realloc operation in rare cases, but on
		5071	average it is much faster and asymptotically approaches constant time.
3510		5072
3511	Another reason is that some compiler warnings require elaborate	5073	=over 4
3512	workarounds, or other changes to the code that make it less clear and less
3513	maintainable.
3514		5074
3515	And of course, some compiler warnings are just plain stupid, or simply	5075	=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		5076
3519	While libev is written to generate as few warnings as possible,	5077	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	5078	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	5079	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		5080
		5081	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
3525		5082
3526	=head1 VALGRIND	5083	That means that changing a timer costs less than removing/adding them,
		5084	as only the relative motion in the event queue has to be paid for.
3527		5085
3528	Valgrind has a special section here because it is a popular tool that is	5086	=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		5087
3531	If you think you found a bug (memory leak, uninitialised data access etc.)	5088	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		5089
3534	==2274== definitely lost: 0 bytes in 0 blocks.	5090	=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		5091
3538	Then there is no memory leak. Similarly, under some circumstances,	5092	=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		5093
3542	If you are unsure about something, feel free to contact the mailing list	5094	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	5095	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	5096	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	5097	is rare).
3546	properly.
3547		5098
3548	If you need, for some reason, empty reports from valgrind for your project	5099	=item Finding the next timer in each loop iteration: O(1)
3549	I suggest using suppression lists.
3550		5100
		5101	By virtue of using a binary or 4-heap, the next timer is always found at a
		5102	fixed position in the storage array.
		5103
		5104	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		5105
		5106	A change means an I/O watcher gets started or stopped, which requires
		5107	libev to recalculate its status (and possibly tell the kernel, depending
		5108	on backend and whether C<ev_io_set> was used).
		5109
		5110	=item Activating one watcher (putting it into the pending state): O(1)
		5111
		5112	=item Priority handling: O(number_of_priorities)
		5113
		5114	Priorities are implemented by allocating some space for each
		5115	priority. When doing priority-based operations, libev usually has to
		5116	linearly search all the priorities, but starting/stopping and activating
		5117	watchers becomes O(1) with respect to priority handling.
		5118
		5119	=item Sending an ev_async: O(1)
		5120
		5121	=item Processing ev_async_send: O(number_of_async_watchers)
		5122
		5123	=item Processing signals: O(max_signal_number)
		5124
		5125	Sending involves a system call I<iff> there were no other C<ev_async_send>
		5126	calls in the current loop iteration and the loop is currently
		5127	blocked. Checking for async and signal events involves iterating over all
		5128	running async watchers or all signal numbers.
		5129
		5130	=back
		5131
		5132
		5133	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5134
		5135	The major version 4 introduced some incompatible changes to the API.
		5136
		5137	At the moment, the C<ev.h> header file provides compatibility definitions
		5138	for all changes, so most programs should still compile. The compatibility
		5139	layer might be removed in later versions of libev, so better update to the
		5140	new API early than late.
		5141
		5142	=over 4
		5143
		5144	=item C<EV_COMPAT3> backwards compatibility mechanism
		5145
		5146	The backward compatibility mechanism can be controlled by
		5147	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5148	section.
		5149
		5150	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5151
		5152	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5153
		5154	ev_loop_destroy (EV_DEFAULT_UC);
		5155	ev_loop_fork (EV_DEFAULT);
		5156
		5157	=item function/symbol renames
		5158
		5159	A number of functions and symbols have been renamed:
		5160
		5161	ev_loop => ev_run
		5162	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5163	EVLOOP_ONESHOT => EVRUN_ONCE
		5164
		5165	ev_unloop => ev_break
		5166	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5167	EVUNLOOP_ONE => EVBREAK_ONE
		5168	EVUNLOOP_ALL => EVBREAK_ALL
		5169
		5170	EV_TIMEOUT => EV_TIMER
		5171
		5172	ev_loop_count => ev_iteration
		5173	ev_loop_depth => ev_depth
		5174	ev_loop_verify => ev_verify
		5175
		5176	Most functions working on C<struct ev_loop> objects don't have an
		5177	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5178	associated constants have been renamed to not collide with the C<struct
		5179	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5180	as all other watcher types. Note that C<ev_loop_fork> is still called
		5181	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5182	typedef.
		5183
		5184	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5185
		5186	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5187	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5188	and work, but the library code will of course be larger.
		5189
		5190	=back
		5191
		5192
		5193	=head1 GLOSSARY
		5194
		5195	=over 4
		5196
		5197	=item active
		5198
		5199	A watcher is active as long as it has been started and not yet stopped.
		5200	See L<WATCHER STATES> for details.
		5201
		5202	=item application
		5203
		5204	In this document, an application is whatever is using libev.
		5205
		5206	=item backend
		5207
		5208	The part of the code dealing with the operating system interfaces.
		5209
		5210	=item callback
		5211
		5212	The address of a function that is called when some event has been
		5213	detected. Callbacks are being passed the event loop, the watcher that
		5214	received the event, and the actual event bitset.
		5215
		5216	=item callback/watcher invocation
		5217
		5218	The act of calling the callback associated with a watcher.
		5219
		5220	=item event
		5221
		5222	A change of state of some external event, such as data now being available
		5223	for reading on a file descriptor, time having passed or simply not having
		5224	any other events happening anymore.
		5225
		5226	In libev, events are represented as single bits (such as C<EV_READ> or
		5227	C<EV_TIMER>).
		5228
		5229	=item event library
		5230
		5231	A software package implementing an event model and loop.
		5232
		5233	=item event loop
		5234
		5235	An entity that handles and processes external events and converts them
		5236	into callback invocations.
		5237
		5238	=item event model
		5239
		5240	The model used to describe how an event loop handles and processes
		5241	watchers and events.
		5242
		5243	=item pending
		5244
		5245	A watcher is pending as soon as the corresponding event has been
		5246	detected. See L<WATCHER STATES> for details.
		5247
		5248	=item real time
		5249
		5250	The physical time that is observed. It is apparently strictly monotonic :)
		5251
		5252	=item wall-clock time
		5253
		5254	The time and date as shown on clocks. Unlike real time, it can actually
		5255	be wrong and jump forwards and backwards, e.g. when you adjust your
		5256	clock.
		5257
		5258	=item watcher
		5259
		5260	A data structure that describes interest in certain events. Watchers need
		5261	to be started (attached to an event loop) before they can receive events.
		5262
		5263	=back
3551		5264
3552	=head1 AUTHOR	5265	=head1 AUTHOR
3553		5266
3554	Marc Lehmann <libev@schmorp.de>.	5267	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5268	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
3555		5269

Diff Legend

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