ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.206 by root, Tue Oct 28 12:31:38 2008 UTC vs.
Revision 1.379 by root, Tue Jul 12 23:32:10 2011 UTC

…		…
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
		13
		14	#include <stdio.h> // for puts
13		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;
…		…
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_ 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	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
…		…
103	Libev is very configurable. In this manual the default (and most common)	126	Libev is very configurable. In this manual the default (and most common)
104	configuration will be described, which supports multiple event loops. For	127	configuration will be described, which supports multiple event loops. For
105	more info about various configuration options please have a look at	128	more info about various configuration options please have a look at
106	B<EMBED> section in this manual. If libev was configured without support	129	B<EMBED> section in this manual. If libev was configured without support
107	for multiple event loops, then all functions taking an initial argument of	130	for multiple event loops, then all functions taking an initial argument of
108	name C<loop> (which is always of type C<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)) [NOT REENTRANT]	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
220		253
221	Sets the allocation function to use (the prototype is similar - the	254	Sets the allocation function to use (the prototype is similar - the
222	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	255	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
223	used to allocate and free memory (no surprises here). If it returns zero	256	used to allocate and free memory (no surprises here). If it returns zero
224	when memory needs to be allocated (C<size != 0>), the library might abort	257	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
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)); [NOT REENTRANT]	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 C<struct>	327	An event loop is described by a C<struct ev_loop *> (the C<struct> is
282	is I<not> optional in this case, as there is also an C<ev_loop>	328	I<not> optional in this case unless libev 3 compatibility is disabled, as
283	I<function>).	329	libev 3 had an C<ev_loop> function colliding with the struct name).
284		330
285	The library knows two types of such loops, the I<default> loop, which	331	The library knows two types of such loops, the I<default> loop, which
286	supports signals and child events, and dynamically created loops which do	332	supports child process events, and dynamically created event loops which
287	not.	333	do not.
288		334
289	=over 4	335	=over 4
290		336
291	=item struct ev_loop *ev_default_loop (unsigned int flags)	337	=item struct ev_loop *ev_default_loop (unsigned int flags)
292		338
293	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
294	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
295	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
296	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".
297		349
298	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
299	function.	351	function (or via the C<EV_DEFAULT> macro).
300		352
301	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
302	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
303	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).
304		357
305	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,
306	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
307	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
308	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
309	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	362	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
310	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.
311		382
312	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
313	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>).
314		385
315	The following flags are supported:	386	The following flags are supported:
…		…
330	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
331	around bugs.	402	around bugs.
332		403
333	=item C<EVFLAG_FORKCHECK>	404	=item C<EVFLAG_FORKCHECK>
334		405
335	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
336	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.
337	enabling this flag.
338		408
339	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,
340	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
341	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
342	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
…		…
348	flag.	418	flag.
349		419
350	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>
351	environment variable.	421	environment variable.
352		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
353	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
354		459
355	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
356	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,
357	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
…		…
381	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and	486	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
382	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	487	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
383		488
384	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
385		490
		491	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		492	kernels).
		493
386	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
387	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
388	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
389	epoll scales either O(1) or O(active_fds).	497	fd), epoll scales either O(1) or O(active_fds).
390		498
391	The epoll syscalls are the most misdesigned of the more advanced event	499	The epoll mechanism deserves honorable mention as the most misdesigned
392	mechanisms: problems include silently dropping fds, requiring a system	500	of the more advanced event mechanisms: mere annoyances include silently
		501	dropping file descriptors, requiring a system call per change per file
393	call per change per fd (and unnecessary guessing of parameters), problems	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
394	with dup and so on. The biggest issue is fork races, however - if a	505	0.1ms) and so on. The biggest issue is fork races, however - if a program
395	program forks then I<both> parent and child process have to recreate the	506	forks then I<both> parent and child process have to recreate the epoll
396	epoll set, which can take considerable time (one syscall per fd) and is of	507	set, which can take considerable time (one syscall per file descriptor)
397	course hard to detect.	508	and is of course hard to detect.
398		509
399	Epoll is also notoriously buggy - embedding epoll fds should work, but	510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
400	of course doesn't, and epoll just loves to report events for totally	511	but of course I<doesn't>, and epoll just loves to report events for
401	I<different> file descriptors (even already closed ones, so one cannot	512	totally I<different> file descriptors (even already closed ones, so
402	even remove them from the set) than registered in the set (especially	513	one cannot even remove them from the set) than registered in the set
403	on SMP systems). Libev tries to counter these spurious notifications by	514	(especially on SMP systems). Libev tries to counter these spurious
404	employing an additional generation counter and comparing that against the	515	notifications by employing an additional generation counter and comparing
405	events to filter out spurious ones.	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...
406		526
407	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
408	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
409	(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
410	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
411	very well if you register events for both fds.	531	file descriptors might not work very well if you register events for both
		532	file descriptors.
412		533
413	Best performance from this backend is achieved by not unregistering all	534	Best performance from this backend is achieved by not unregistering all
414	watchers for a file descriptor until it has been closed, if possible,	535	watchers for a file descriptor until it has been closed, if possible,
415	i.e. keep at least one watcher active per fd at all times. Stopping and	536	i.e. keep at least one watcher active per fd at all times. Stopping and
416	starting a watcher (without re-setting it) also usually doesn't cause	537	starting a watcher (without re-setting it) also usually doesn't cause
417	extra overhead. A fork can both result in spurious notifications as well	538	extra overhead. A fork can both result in spurious notifications as well
418	as in libev having to destroy and recreate the epoll object, which can	539	as in libev having to destroy and recreate the epoll object, which can
419	take considerable time and thus should be avoided.	540	take considerable time and thus should be avoided.
420		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.
		545
421	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
422	all kernel versions tested so far.	547	all kernel versions tested so far.
423		548
424	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	549	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
425	C<EVBACKEND_POLL>.	550	C<EVBACKEND_POLL>.
426		551
427	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	552	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
428		553
429	Kqueue deserves special mention, as at the time of this writing, it was	554	Kqueue deserves special mention, as at the time of this writing, it
430	broken on all BSDs except NetBSD (usually it doesn't work reliably with	555	was broken on all BSDs except NetBSD (usually it doesn't work reliably
431	anything but sockets and pipes, except on Darwin, where of course it's	556	with anything but sockets and pipes, except on Darwin, where of course
432	completely useless). For this reason it's not being "auto-detected" unless	557	it's completely useless). Unlike epoll, however, whose brokenness
433	you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or	558	is by design, these kqueue bugs can (and eventually will) be fixed
434	libev was compiled on a known-to-be-good (-enough) system like NetBSD.	559	without API changes to existing programs. For this reason it's not being
		560	"auto-detected" unless you explicitly specify it in the flags (i.e. using
		561	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		562	system like NetBSD.
435		563
436	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
437	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
438	the target platform). See C<ev_embed> watchers for more info.	566	the target platform). See C<ev_embed> watchers for more info.
439		567
…		…
449		577
450	While nominally embeddable in other event loops, this doesn't work	578	While nominally embeddable in other event loops, this doesn't work
451	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
452	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
453	(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
454	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it,	582	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
455	using it only for sockets.	583	also broken on OS X)) and, did I mention it, using it only for sockets.
456		584
457	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with	585	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
458	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with	586	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
459	C<NOTE_EOF>.	587	C<NOTE_EOF>.
460		588
…		…
468	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	596	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
469		597
470	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,
471	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)).
472		600
473	Please note that Solaris event ports can deliver a lot of spurious
474	notifications, so you need to use non-blocking I/O or other means to avoid
475	blocking when no data (or space) is available.
476
477	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
478	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
479	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	603	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
480	might perform better.	604	might perform better.
481		605
482	On the positive side, with the exception of the spurious readiness	606	On the positive side, this backend actually performed fully to
483	notifications, this backend actually performed fully to specification
484	in all tests and is fully embeddable, which is a rare feat among the	607	specification in all tests and is fully embeddable, which is a rare feat
485	OS-specific backends (I vastly prefer correctness over speed hacks).	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.
486		620
487	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	621	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
488	C<EVBACKEND_POLL>.	622	C<EVBACKEND_POLL>.
489		623
490	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
491		625
492	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
493	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
494	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	628	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
495		629
496	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).
497		639
498	=back	640	=back
499		641
500	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,
501	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
502	specified, all backends in C<ev_recommended_backends ()> will be tried.	644	here). If none are specified, all backends in C<ev_recommended_backends
503		645	()> will be tried.
504	Example: This is the most typical usage.
505
506	if (!ev_default_loop (0))
507	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
508
509	Example: Restrict libev to the select and poll backends, and do not allow
510	environment settings to be taken into account:
511
512	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
513
514	Example: Use whatever libev has to offer, but make sure that kqueue is
515	used if available (warning, breaks stuff, best use only with your own
516	private event loop and only if you know the OS supports your types of
517	fds):
518
519	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
520
521	=item struct ev_loop *ev_loop_new (unsigned int flags)
522
523	Similar to C<ev_default_loop>, but always creates a new event loop that is
524	always distinct from the default loop. Unlike the default loop, it cannot
525	handle signal and child watchers, and attempts to do so will be greeted by
526	undefined behaviour (or a failed assertion if assertions are enabled).
527
528	Note that this function I<is> thread-safe, and the recommended way to use
529	libev with threads is indeed to create one loop per thread, and using the
530	default loop in the "main" or "initial" thread.
531		646
532	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.
533		648
534	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	649	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
535	if (!epoller)	650	if (!epoller)
536	fatal ("no epoll found here, maybe it hides under your chair");	651	fatal ("no epoll found here, maybe it hides under your chair");
537		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
538	=item ev_default_destroy ()	658	=item ev_loop_destroy (loop)
539		659
540	Destroys the default loop again (frees all memory and kernel state	660	Destroys an event loop object (frees all memory and kernel state
541	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
542	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
543	responsibility to either stop all watchers cleanly yourself I<before>	663	responsibility to either stop all watchers cleanly yourself I<before>
544	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
545	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
…		…
547		667
548	Note that certain global state, such as signal state (and installed signal	668	Note that certain global state, such as signal state (and installed signal
549	handlers), will not be freed by this function, and related watchers (such	669	handlers), will not be freed by this function, and related watchers (such
550	as signal and child watchers) would need to be stopped manually.	670	as signal and child watchers) would need to be stopped manually.
551		671
552	In general it is not advisable to call this function except in the	672	This function is normally used on loop objects allocated by
553	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.
554	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>
555	C<ev_loop_new> and C<ev_loop_destroy>).	679	and C<ev_loop_destroy>.
556		680
557	=item ev_loop_destroy (loop)	681	=item ev_loop_fork (loop)
558		682
559	Like C<ev_default_destroy>, but destroys an event loop created by an
560	earlier call to C<ev_loop_new>.
561
562	=item ev_default_fork ()
563
564	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
565	to reinitialise the kernel state for backends that have one. Despite the	684	reinitialise the kernel state for backends that have one. Despite the
566	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
567	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
568	sense). You I<must> call it in the child before using any of the libev	687	child before resuming or calling C<ev_run>.
569	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.
570		693
571	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
572	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
573	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).
574		700
575	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
576	it just in case after a fork. To make this easy, the function will fit in	702	it just in case after a fork.
577	quite nicely into a call to C<pthread_atfork>:
578		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	...
579	pthread_atfork (0, 0, ev_default_fork);	714	pthread_atfork (0, 0, post_fork_child);
580
581	=item ev_loop_fork (loop)
582
583	Like C<ev_default_fork>, but acts on an event loop created by
584	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
585	after fork that you want to re-use in the child, and how you do this is
586	entirely your own problem.
587		715
588	=item int ev_is_default_loop (loop)	716	=item int ev_is_default_loop (loop)
589		717
590	Returns true when the given loop is, in fact, the default loop, and false	718	Returns true when the given loop is, in fact, the default loop, and false
591	otherwise.	719	otherwise.
592		720
593	=item unsigned int ev_loop_count (loop)	721	=item unsigned int ev_iteration (loop)
594		722
595	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
596	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>
597	happily wraps around with enough iterations.	725	and happily wraps around with enough iterations.
598		726
599	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
600	"ticks" the number of loop iterations), as it roughly corresponds with	728	"ticks" the number of loop iterations), as it roughly corresponds with
601	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.
602		745
603	=item unsigned int ev_backend (loop)	746	=item unsigned int ev_backend (loop)
604		747
605	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
606	use.	749	use.
…		…
615		758
616	=item ev_now_update (loop)	759	=item ev_now_update (loop)
617		760
618	Establishes the current time by querying the kernel, updating the time	761	Establishes the current time by querying the kernel, updating the time
619	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
620	is usually done automatically within C<ev_loop ()>.	763	is usually done automatically within C<ev_run ()>.
621		764
622	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
623	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
624	the current time is a good idea.	767	the current time is a good idea.
625		768
626	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.
627		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
628	=item ev_loop (loop, int flags)	797	=item ev_run (loop, int flags)
629		798
630	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
631	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
632	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>.
633		804
634	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
635	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.
636		808
637	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
638	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
639	finished (especially in interactive programs), but having a program	811	finished (especially in interactive programs), but having a program
640	that automatically loops as long as it has to and no longer by virtue	812	that automatically loops as long as it has to and no longer by virtue
641	of relying on its watchers stopping correctly, that is truly a thing of	813	of relying on its watchers stopping correctly, that is truly a thing of
642	beauty.	814	beauty.
643		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
644	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
645	those events and any already outstanding ones, but will not block your	822	those events and any already outstanding ones, but will not wait and
646	process in case there are no events and will return after one iteration of	823	block your process in case there are no events and will return after one
647	the loop.	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.
648		826
649	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
650	necessary) and will handle those and any already outstanding ones. It	828	necessary) and will handle those and any already outstanding ones. It
651	will block your process until at least one new event arrives (which could	829	will block your process until at least one new event arrives (which could
652	be an event internal to libev itself, so there is no guarentee that a	830	be an event internal to libev itself, so there is no guarantee that a
653	user-registered callback will be called), and will return after one	831	user-registered callback will be called), and will return after one
654	iteration of the loop.	832	iteration of the loop.
655		833
656	This is useful if you are waiting for some external event in conjunction	834	This is useful if you are waiting for some external event in conjunction
657	with something not expressible using other libev watchers (i.e. "roll your	835	with something not expressible using other libev watchers (i.e. "roll your
658	own C<ev_loop>"). 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
659	usually a better approach for this kind of thing.	837	usually a better approach for this kind of thing.
660		838
661	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):
662		842
		843	- Increment loop depth.
		844	- Reset the ev_break status.
663	- Before the first iteration, call any pending watchers.	845	- Before the first iteration, call any pending watchers.
		846	LOOP:
664	* If EVFLAG_FORKCHECK was used, check for a fork.	847	- If EVFLAG_FORKCHECK was used, check for a fork.
665	- 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.
666	- Queue and call all prepare watchers.	849	- Queue and call all prepare watchers.
		850	- If ev_break was called, goto FINISH.
667	- If we have been forked, detach and recreate the kernel state	851	- If we have been forked, detach and recreate the kernel state
668	as to not disturb the other process.	852	as to not disturb the other process.
669	- Update the kernel state with all outstanding changes.	853	- Update the kernel state with all outstanding changes.
670	- Update the "event loop time" (ev_now ()).	854	- Update the "event loop time" (ev_now ()).
671	- Calculate for how long to sleep or block, if at all	855	- Calculate for how long to sleep or block, if at all
672	(active idle watchers, EVLOOP_NONBLOCK or not having	856	(active idle watchers, EVRUN_NOWAIT or not having
673	any active watchers at all will result in not sleeping).	857	any active watchers at all will result in not sleeping).
674	- 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.
675	- Block the process, waiting for any events.	860	- Block the process, waiting for any events.
676	- Queue all outstanding I/O (fd) events.	861	- Queue all outstanding I/O (fd) events.
677	- 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.
678	- Queue all expired timers.	863	- Queue all expired timers.
679	- Queue all expired periodics.	864	- Queue all expired periodics.
680	- Unless any events are pending now, queue all idle watchers.	865	- Queue all idle watchers with priority higher than that of pending events.
681	- Queue all check watchers.	866	- Queue all check watchers.
682	- 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).
683	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
684	be handled here by queueing them when their watcher gets executed.	869	be handled here by queueing them when their watcher gets executed.
685	- 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
686	were used, or there are no active watchers, return, otherwise	871	were used, or there are no active watchers, goto FINISH, otherwise
687	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.
688		877
689	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
690	anymore.	879	anymore.
691		880
692	... queue jobs here, make sure they register event watchers as long	881	... queue jobs here, make sure they register event watchers as long
693	... 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..)
694	ev_loop (my_loop, 0);	883	ev_run (my_loop, 0);
695	... jobs done or somebody called unloop. yeah!	884	... jobs done or somebody called break. yeah!
696		885
697	=item ev_unloop (loop, how)	886	=item ev_break (loop, how)
698		887
699	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
700	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
701	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
702	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.
703		892
704	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>.
705		894
706	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	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.
707		897
708	=item ev_ref (loop)	898	=item ev_ref (loop)
709		899
710	=item ev_unref (loop)	900	=item ev_unref (loop)
711		901
712	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
713	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
714	count is nonzero, C<ev_loop> will not return on its own.	904	count is nonzero, C<ev_run> will not return on its own.
715		905
716	If you have a watcher you never unregister that should not keep C<ev_loop>	906	This is useful when you have a watcher that you never intend to
717	from returning, call ev_unref() after starting, and ev_ref() before	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>
718	stopping it.	909	before stopping it.
719		910
720	As an example, libev itself uses this for its internal signal pipe: It is	911	As an example, libev itself uses this for its internal signal pipe: It
721	not visible to the libev user and should not keep C<ev_loop> from exiting	912	is not visible to the libev user and should not keep C<ev_run> from
722	if 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
723	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
724	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
725	(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
726	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).
727		920
728	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>
729	running when nothing else is active.	922	running when nothing else is active.
730		923
731	ev_signal exitsig;	924	ev_signal exitsig;
732	ev_signal_init (&exitsig, sig_cb, SIGINT);	925	ev_signal_init (&exitsig, sig_cb, SIGINT);
733	ev_signal_start (loop, &exitsig);	926	ev_signal_start (loop, &exitsig);
734	evf_unref (loop);	927	ev_unref (loop);
735		928
736	Example: For some weird reason, unregister the above signal handler again.	929	Example: For some weird reason, unregister the above signal handler again.
737		930
738	ev_ref (loop);	931	ev_ref (loop);
739	ev_signal_stop (loop, &exitsig);	932	ev_signal_stop (loop, &exitsig);
…		…
759	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.
760		953
761	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
762	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,
763	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
764	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
765	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).
766		962
767	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
768	to spend more time collecting timeouts, at the expense of increased	964	to spend more time collecting timeouts, at the expense of increased
769	latency/jitter/inexactness (the watcher callback will be called	965	latency/jitter/inexactness (the watcher callback will be called
770	later). C<ev_io> watchers will not be affected. Setting this to a non-null	966	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
772		968
773	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
774	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
775	interactive servers (of course not for games), likewise for timeouts. It	971	interactive servers (of course not for games), likewise for timeouts. It
776	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>,
777	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).
778		978
779	Setting the I<timeout collect interval> can improve the opportunity for	979	Setting the I<timeout collect interval> can improve the opportunity for
780	saving power, as the program will "bundle" timer callback invocations that	980	saving power, as the program will "bundle" timer callback invocations that
781	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
782	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
783	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
784	they fire on, say, one-second boundaries only.	984	they fire on, say, one-second boundaries only.
785		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
786	=item ev_loop_verify (loop)	1061	=item ev_verify (loop)
787		1062
788	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
789	compiled in, which is the default for non-minimal builds. It tries to go	1064	compiled in, which is the default for non-minimal builds. It tries to go
790	through all internal structures and checks them for validity. If anything	1065	through all internal structures and checks them for validity. If anything
791	is found to be inconsistent, it will print an error message to standard	1066	is found to be inconsistent, it will print an error message to standard
…		…
802		1077
803	In the following description, uppercase C<TYPE> in names stands for the	1078	In the following description, uppercase C<TYPE> in names stands for the
804	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1079	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
805	watchers and C<ev_io_start> for I/O watchers.	1080	watchers and C<ev_io_start> for I/O watchers.
806		1081
807	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
808	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
809	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:
810		1086
811	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1087	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
812	{	1088	{
813	ev_io_stop (w);	1089	ev_io_stop (w);
814	ev_unloop (loop, EVUNLOOP_ALL);	1090	ev_break (loop, EVBREAK_ALL);
815	}	1091	}
816		1092
817	struct ev_loop *loop = ev_default_loop (0);	1093	struct ev_loop *loop = ev_default_loop (0);
818		1094
819	ev_io stdin_watcher;	1095	ev_io stdin_watcher;
820		1096
821	ev_init (&stdin_watcher, my_cb);	1097	ev_init (&stdin_watcher, my_cb);
822	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1098	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
823	ev_io_start (loop, &stdin_watcher);	1099	ev_io_start (loop, &stdin_watcher);
824		1100
825	ev_loop (loop, 0);	1101	ev_run (loop, 0);
826		1102
827	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
828	watcher structures (and it is I<usually> a bad idea to do this on the	1104	watcher structures (and it is I<usually> a bad idea to do this on the
829	stack).	1105	stack).
830		1106
831	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1107	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
832	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1108	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
833		1109
834	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
835	(watcher *, callback)>, which expects a callback to be provided. This	1111	*, callback)>, which expects a callback to be provided. This callback is
836	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
837	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
838	is readable and/or writable).	1114	and/or writable).
839		1115
840	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1116	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
841	macro to configure it, with arguments specific to the watcher type. There	1117	macro to configure it, with arguments specific to the watcher type. There
842	is also a macro to combine initialisation and setting in one call: C<<	1118	is also a macro to combine initialisation and setting in one call: C<<
843	ev_TYPE_init (watcher *, callback, ...) >>.	1119	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
866	=item C<EV_WRITE>	1142	=item C<EV_WRITE>
867		1143
868	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
869	writable.	1145	writable.
870		1146
871	=item C<EV_TIMEOUT>	1147	=item C<EV_TIMER>
872		1148
873	The C<ev_timer> watcher has timed out.	1149	The C<ev_timer> watcher has timed out.
874		1150
875	=item C<EV_PERIODIC>	1151	=item C<EV_PERIODIC>
876		1152
…		…
894		1170
895	=item C<EV_PREPARE>	1171	=item C<EV_PREPARE>
896		1172
897	=item C<EV_CHECK>	1173	=item C<EV_CHECK>
898		1174
899	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
900	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
901	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
902	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
903	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
904	(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
905	C<ev_loop> from blocking).	1181	C<ev_run> from blocking).
906		1182
907	=item C<EV_EMBED>	1183	=item C<EV_EMBED>
908		1184
909	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.
910		1186
911	=item C<EV_FORK>	1187	=item C<EV_FORK>
912		1188
913	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
914	C<ev_fork>).	1190	C<ev_fork>).
915		1191
		1192	=item C<EV_CLEANUP>
		1193
		1194	The event loop is about to be destroyed (see C<ev_cleanup>).
		1195
916	=item C<EV_ASYNC>	1196	=item C<EV_ASYNC>
917		1197
918	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>).
919		1204
920	=item C<EV_ERROR>	1205	=item C<EV_ERROR>
921		1206
922	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
923	happen because the watcher could not be properly started because libev	1208	happen because the watcher could not be properly started because libev
…		…
961		1246
962	ev_io w;	1247	ev_io w;
963	ev_init (&w, my_cb);	1248	ev_init (&w, my_cb);
964	ev_io_set (&w, STDIN_FILENO, EV_READ);	1249	ev_io_set (&w, STDIN_FILENO, EV_READ);
965		1250
966	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1251	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
967		1252
968	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
969	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
970	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
971	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
…		…
984		1269
985	Example: Initialise and set an C<ev_io> watcher in one step.	1270	Example: Initialise and set an C<ev_io> watcher in one step.
986		1271
987	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1272	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
988		1273
989	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1274	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
990		1275
991	Starts (activates) the given watcher. Only active watchers will receive	1276	Starts (activates) the given watcher. Only active watchers will receive
992	events. If the watcher is already active nothing will happen.	1277	events. If the watcher is already active nothing will happen.
993		1278
994	Example: Start the C<ev_io> watcher that is being abused as example in this	1279	Example: Start the C<ev_io> watcher that is being abused as example in this
995	whole section.	1280	whole section.
996		1281
997	ev_io_start (EV_DEFAULT_UC, &w);	1282	ev_io_start (EV_DEFAULT_UC, &w);
998		1283
999	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1284	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1000		1285
1001	Stops the given watcher if active, and clears the pending status (whether	1286	Stops the given watcher if active, and clears the pending status (whether
1002	the watcher was active or not).	1287	the watcher was active or not).
1003		1288
1004	It is possible that stopped watchers are pending - for example,	1289	It is possible that stopped watchers are pending - for example,
…		…
1029	=item ev_cb_set (ev_TYPE *watcher, callback)	1314	=item ev_cb_set (ev_TYPE *watcher, callback)
1030		1315
1031	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
1032	(modulo threads).	1317	(modulo threads).
1033		1318
1034	=item ev_set_priority (ev_TYPE *watcher, priority)	1319	=item ev_set_priority (ev_TYPE *watcher, int priority)
1035		1320
1036	=item int ev_priority (ev_TYPE *watcher)	1321	=item int ev_priority (ev_TYPE *watcher)
1037		1322
1038	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
1039	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>
1040	(default: C<-2>). Pending watchers with higher priority will be invoked	1325	(default: C<-2>). Pending watchers with higher priority will be invoked
1041	before watchers with lower priority, but priority will not keep watchers	1326	before watchers with lower priority, but priority will not keep watchers
1042	from being executed (except for C<ev_idle> watchers).	1327	from being executed (except for C<ev_idle> watchers).
1043		1328
1044	This means that priorities are I<only> used for ordering callback
1045	invocation after new events have been received. This is useful, for
1046	example, to reduce latency after idling, or more often, to bind two
1047	watchers on the same event and make sure one is called first.
1048
1049	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
1050	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.
1051		1331
1052	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
1053	pending.	1333	pending.
1054
1055	The default priority used by watchers when no priority has been set is
1056	always C<0>, which is supposed to not be too high and not be too low :).
1057		1334
1058	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1335	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1059	fine, as long as you do not mind that the priority value you query might	1336	fine, as long as you do not mind that the priority value you query might
1060	or might not have been clamped to the valid range.	1337	or might not have been clamped to the valid range.
		1338
		1339	The default priority used by watchers when no priority has been set is
		1340	always C<0>, which is supposed to not be too high and not be too low :).
		1341
		1342	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
		1343	priorities.
1061		1344
1062	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1345	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1063		1346
1064	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
1065	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
…		…
1073	watcher isn't pending it does nothing and returns C<0>.	1356	watcher isn't pending it does nothing and returns C<0>.
1074		1357
1075	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1358	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1076	callback to be invoked, which can be accomplished with this function.	1359	callback to be invoked, which can be accomplished with this function.
1077		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
1078	=back	1375	=back
1079		1376
		1377	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1378	OWN COMPOSITE WATCHERS> idioms.
1080		1379
1081	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1380	=head2 WATCHER STATES
1082		1381
1083	Each watcher has, by default, a member C<void *data> that you can change	1382	There are various watcher states mentioned throughout this manual -
1084	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
1085	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
1086	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".
1087	member, you can also "subclass" the watcher type and provide your own
1088	data:
1089		1386
1090	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)
1091	{	1512	{
1092	ev_io io;	1513	// stop the I/O watcher, we received the event, but
1093	int otherfd;	1514	// are not yet ready to handle it.
1094	void *somedata;	1515	ev_io_stop (EV_A_ w);
1095	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);
1096	};	1521	}
1097		1522
1098	...	1523	static void
1099	struct my_io w;	1524	idle_cb (EV_P_ ev_idle *w, int revents)
1100	ev_io_init (&w.io, my_cb, fd, EV_READ);
1101
1102	And since your callback will be called with a pointer to the watcher, you
1103	can cast it back to your own type:
1104
1105	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1106	{	1525	{
1107	struct my_io *w = (struct my_io *)w_;	1526	// actual processing
1108	...	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);
1109	}	1532	}
1110		1533
1111	More interesting and less C-conformant ways of casting your callback type	1534	// initialisation
1112	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);
1113		1538
1114	Another common scenario is to use some data structure with multiple	1539	In the "real" world, it might also be beneficial to start a timer, so that
1115	embedded watchers:	1540	low-priority connections can not be locked out forever under load. This
1116		1541	enables your program to keep a lower latency for important connections
1117	struct my_biggy	1542	during short periods of high load, while not completely locking out less
1118	{	1543	important ones.
1119	int some_data;
1120	ev_timer t1;
1121	ev_timer t2;
1122	}
1123
1124	In this case getting the pointer to C<my_biggy> is a bit more
1125	complicated: Either you store the address of your C<my_biggy> struct
1126	in the C<data> member of the watcher (for woozies), or you need to use
1127	some pointer arithmetic using C<offsetof> inside your watchers (for real
1128	programmers):
1129
1130	#include <stddef.h>
1131
1132	static void
1133	t1_cb (EV_P_ ev_timer *w, int revents)
1134	{
1135	struct my_biggy big = (struct my_biggy *
1136	(((char *)w) - offsetof (struct my_biggy, t1));
1137	}
1138
1139	static void
1140	t2_cb (EV_P_ ev_timer *w, int revents)
1141	{
1142	struct my_biggy big = (struct my_biggy *
1143	(((char *)w) - offsetof (struct my_biggy, t2));
1144	}
1145		1544
1146		1545
1147	=head1 WATCHER TYPES	1546	=head1 WATCHER TYPES
1148		1547
1149	This section describes each watcher in detail, but will not repeat	1548	This section describes each watcher in detail, but will not repeat
…		…
1173	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
1174	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
1175	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
1176	required if you know what you are doing).	1575	required if you know what you are doing).
1177		1576
1178	If you cannot use non-blocking mode, then force the use of a
1179	known-to-be-good backend (at the time of this writing, this includes only
1180	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1181
1182	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
1183	receive "spurious" readiness notifications, that is your callback might	1578	receive "spurious" readiness notifications, that is, your callback might
1184	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
1185	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
1186	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
1187	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
1188	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1189	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1583	preferable to a program hanging until some data arrives.
1190		1584
1191	If you cannot run the fd in non-blocking mode (for example you should	1585	If you cannot run the fd in non-blocking mode (for example you should
1192	not play around with an Xlib connection), then you have to separately	1586	not play around with an Xlib connection), then you have to separately
1193	re-test whether a file descriptor is really ready with a known-to-be good	1587	re-test whether a file descriptor is really ready with a known-to-be good
1194	interface such as poll (fortunately in our Xlib example, Xlib already	1588	interface such as poll (fortunately in the case of Xlib, it already does
1195	does this on its own, so its quite safe to use). Some people additionally	1589	this on its own, so its quite safe to use). Some people additionally
1196	use C<SIGALRM> and an interval timer, just to be sure you won't block	1590	use C<SIGALRM> and an interval timer, just to be sure you won't block
1197	indefinitely.	1591	indefinitely.
1198		1592
1199	But really, best use non-blocking mode.	1593	But really, best use non-blocking mode.
1200		1594
…		…
1228		1622
1229	There is no workaround possible except not registering events	1623	There is no workaround possible except not registering events
1230	for potentially C<dup ()>'ed file descriptors, or to resort to	1624	for potentially C<dup ()>'ed file descriptors, or to resort to
1231	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1625	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1232		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
1233	=head3 The special problem of fork	1660	=head3 The special problem of fork
1234		1661
1235	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
1236	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
1237	it in the child.	1664	it in the child if you want to continue to use it in the child.
1238		1665
1239	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
1240	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
1241	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1668	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1242	C<EVBACKEND_POLL>.
1243		1669
1244	=head3 The special problem of SIGPIPE	1670	=head3 The special problem of SIGPIPE
1245		1671
1246	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1672	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1247	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
…		…
1250		1676
1251	So when you encounter spurious, unexplained daemon exits, make sure you	1677	So when you encounter spurious, unexplained daemon exits, make sure you
1252	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
1253	somewhere, as that would have given you a big clue).	1679	somewhere, as that would have given you a big clue).
1254		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.
1255		1719
1256	=head3 Watcher-Specific Functions	1720	=head3 Watcher-Specific Functions
1257		1721
1258	=over 4	1722	=over 4
1259		1723
…		…
1291	...	1755	...
1292	struct ev_loop *loop = ev_default_init (0);	1756	struct ev_loop *loop = ev_default_init (0);
1293	ev_io stdin_readable;	1757	ev_io stdin_readable;
1294	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);
1295	ev_io_start (loop, &stdin_readable);	1759	ev_io_start (loop, &stdin_readable);
1296	ev_loop (loop, 0);	1760	ev_run (loop, 0);
1297		1761
1298		1762
1299	=head2 C<ev_timer> - relative and optionally repeating timeouts	1763	=head2 C<ev_timer> - relative and optionally repeating timeouts
1300		1764
1301	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
…		…
1306	year, it will still time out after (roughly) one hour. "Roughly" because	1770	year, it will still time out after (roughly) one hour. "Roughly" because
1307	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1771	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1308	monotonic clock option helps a lot here).	1772	monotonic clock option helps a lot here).
1309		1773
1310	The callback is guaranteed to be invoked only I<after> its timeout has	1774	The callback is guaranteed to be invoked only I<after> its timeout has
1311	passed, but if multiple timers become ready during the same loop iteration	1775	passed (not I<at>, so on systems with very low-resolution clocks this
1312	then 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).
1313		1780
1314	=head3 Be smart about timeouts	1781	=head3 Be smart about timeouts
1315		1782
1316	Many real-world problems involve some kind of timeout, usually for error	1783	Many real-world problems involve some kind of timeout, usually for error
1317	recovery. A typical example is an HTTP request - if the other side hangs,	1784	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1361	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>	1828	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1362	member and C<ev_timer_again>.	1829	member and C<ev_timer_again>.
1363		1830
1364	At start:	1831	At start:
1365		1832
1366	ev_timer_init (timer, callback);	1833	ev_init (timer, callback);
1367	timer->repeat = 60.;	1834	timer->repeat = 60.;
1368	ev_timer_again (loop, timer);	1835	ev_timer_again (loop, timer);
1369		1836
1370	Each time there is some activity:	1837	Each time there is some activity:
1371		1838
…		…
1403	ev_tstamp timeout = last_activity + 60.;	1870	ev_tstamp timeout = last_activity + 60.;
1404		1871
1405	// if last_activity + 60. is older than now, we did time out	1872	// if last_activity + 60. is older than now, we did time out
1406	if (timeout < now)	1873	if (timeout < now)
1407	{	1874	{
1408	// timeout occured, take action	1875	// timeout occurred, take action
1409	}	1876	}
1410	else	1877	else
1411	{	1878	{
1412	// callback was invoked, but there was some activity, re-arm	1879	// callback was invoked, but there was some activity, re-arm
1413	// the watcher to fire in last_activity + 60, which is	1880	// the watcher to fire in last_activity + 60, which is
1414	// guaranteed to be in the future, so "again" is positive:	1881	// guaranteed to be in the future, so "again" is positive:
1415	w->again = timeout - now;	1882	w->repeat = timeout - now;
1416	ev_timer_again (EV_A_ w);	1883	ev_timer_again (EV_A_ w);
1417	}	1884	}
1418	}	1885	}
1419		1886
1420	To summarise the callback: first calculate the real timeout (defined	1887	To summarise the callback: first calculate the real timeout (defined
…		…
1433		1900
1434	To start the timer, simply initialise the watcher and set C<last_activity>	1901	To start the timer, simply initialise the watcher and set C<last_activity>
1435	to the current time (meaning we just have some activity :), then call the	1902	to the current time (meaning we just have some activity :), then call the
1436	callback, which will "do the right thing" and start the timer:	1903	callback, which will "do the right thing" and start the timer:
1437		1904
1438	ev_timer_init (timer, callback);	1905	ev_init (timer, callback);
1439	last_activity = ev_now (loop);	1906	last_activity = ev_now (loop);
1440	callback (loop, timer, EV_TIMEOUT);	1907	callback (loop, timer, EV_TIMER);
1441		1908
1442	And when there is some activity, simply store the current time in	1909	And when there is some activity, simply store the current time in
1443	C<last_activity>, no libev calls at all:	1910	C<last_activity>, no libev calls at all:
1444		1911
1445	last_actiivty = ev_now (loop);	1912	last_activity = ev_now (loop);
1446		1913
1447	This technique is slightly more complex, but in most cases where the	1914	This technique is slightly more complex, but in most cases where the
1448	time-out is unlikely to be triggered, much more efficient.	1915	time-out is unlikely to be triggered, much more efficient.
1449		1916
1450	Changing the timeout is trivial as well (if it isn't hard-coded in the	1917	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1488		1955
1489	=head3 The special problem of time updates	1956	=head3 The special problem of time updates
1490		1957
1491	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
1492	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
1493	time only before and after C<ev_loop> collects new events, which causes a	1960	time only before and after C<ev_run> collects new events, which causes a
1494	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
1495	lots of events in one iteration.	1962	lots of events in one iteration.
1496		1963
1497	The relative timeouts are calculated relative to the C<ev_now ()>	1964	The relative timeouts are calculated relative to the C<ev_now ()>
1498	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
…		…
1504		1971
1505	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
1506	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
1507	()>.	1974	()>.
1508		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
1509	=head3 Watcher-Specific Functions and Data Members	2006	=head3 Watcher-Specific Functions and Data Members
1510		2007
1511	=over 4	2008	=over 4
1512		2009
1513	=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)
…		…
1526	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
1527	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.
1528		2025
1529	=item ev_timer_again (loop, ev_timer *)	2026	=item ev_timer_again (loop, ev_timer *)
1530		2027
1531	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
1532	repeating. The exact semantics are:	2029	repeating. The exact semantics are:
1533		2030
1534	If the timer is pending, its pending status is cleared.	2031	If the timer is pending, its pending status is cleared.
1535		2032
1536	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).
1537		2034
1538	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
1539	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.
1540		2037
1541	This sounds a bit complicated, see "Be smart about timeouts", above, for a	2038	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1542	usage example.	2039	usage example.
		2040
		2041	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
		2042
		2043	Returns the remaining time until a timer fires. If the timer is active,
		2044	then this time is relative to the current event loop time, otherwise it's
		2045	the timeout value currently configured.
		2046
		2047	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		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.
1543		2052
1544	=item ev_tstamp repeat [read-write]	2053	=item ev_tstamp repeat [read-write]
1545		2054
1546	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
1547	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),
…		…
1573	}	2082	}
1574		2083
1575	ev_timer mytimer;	2084	ev_timer mytimer;
1576	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 */
1577	ev_timer_again (&mytimer); /* start timer */	2086	ev_timer_again (&mytimer); /* start timer */
1578	ev_loop (loop, 0);	2087	ev_run (loop, 0);
1579		2088
1580	// 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":
1581	// reset the timeout to start ticking again at 10 seconds	2090	// reset the timeout to start ticking again at 10 seconds
1582	ev_timer_again (&mytimer);	2091	ev_timer_again (&mytimer);
1583		2092
…		…
1585	=head2 C<ev_periodic> - to cron or not to cron?	2094	=head2 C<ev_periodic> - to cron or not to cron?
1586		2095
1587	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
1588	(and unfortunately a bit complex).	2097	(and unfortunately a bit complex).
1589		2098
1590	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
1591	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
1592	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
1593	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
1594	+ 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
1595	clock to January of the previous year, then it will take more than year	2104	wrist-watch).
1596	to trigger the event (unlike an C<ev_timer>, which would still trigger
1597	roughly 10 seconds later as it uses a relative timeout).
1598		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
1599	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
1600	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
1601	complicated rules.	2116	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		2117	those cannot react to time jumps.
1602		2118
1603	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
1604	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
1605	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).
1606		2124
1607	=head3 Watcher-Specific Functions and Data Members	2125	=head3 Watcher-Specific Functions and Data Members
1608		2126
1609	=over 4	2127	=over 4
1610		2128
1611	=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)
1612		2130
1613	=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)
1614		2132
1615	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
1616	operation, and we will explain them from simplest to most complex:	2134	operation, and we will explain them from simplest to most complex:
1617		2135
1618	=over 4	2136	=over 4
1619		2137
1620	=item * absolute timer (at = time, interval = reschedule_cb = 0)	2138	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1621		2139
1622	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
1623	time C<at> has passed. It will not repeat and will not adjust when a time	2141	time C<offset> has passed. It will not repeat and will not adjust when a
1624	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
1625	only run when the system clock reaches or surpasses this time.	2143	will be stopped and invoked when the system clock reaches or surpasses
		2144	this point in time.
1626		2145
1627	=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)
1628		2147
1629	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
1630	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
1631	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.
1632		2152
1633	This can be used to create timers that do not drift with respect to the	2153	This can be used to create timers that do not drift with respect to the
1634	system clock, for example, here is a C<ev_periodic> that triggers each	2154	system clock, for example, here is an C<ev_periodic> that triggers each
1635	hour, on the hour:	2155	hour, on the hour (with respect to UTC):
1636		2156
1637	ev_periodic_set (&periodic, 0., 3600., 0);	2157	ev_periodic_set (&periodic, 0., 3600., 0);
1638		2158
1639	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,
1640	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
1641	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
1642	by 3600.	2162	by 3600.
1643		2163
1644	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
1645	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
1646	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.
1647		2167
1648	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
1649	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
1650	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.
1651		2174
1652	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
1653	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
1654	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
1655	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).
1656		2179
1657	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	2180	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1658		2181
1659	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
1660	ignored. Instead, each time the periodic watcher gets scheduled, the	2183	ignored. Instead, each time the periodic watcher gets scheduled, the
1661	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
1662	current time as second argument.	2185	current time as second argument.
1663		2186
1664	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,
1665	ever, or make ANY event loop modifications whatsoever>.	2188	or make ANY other event loop modifications whatsoever, unless explicitly
		2189	allowed by documentation here>.
1666		2190
1667	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
1668	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
1669	only event loop modification you are allowed to do).	2193	only event loop modification you are allowed to do).
1670		2194
…		…
1700	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
1701	program when the crontabs have changed).	2225	program when the crontabs have changed).
1702		2226
1703	=item ev_tstamp ev_periodic_at (ev_periodic *)	2227	=item ev_tstamp ev_periodic_at (ev_periodic *)
1704		2228
1705	When active, returns the absolute time that the watcher is supposed to	2229	When active, returns the absolute time that the watcher is supposed
1706	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.
1707		2233
1708	=item ev_tstamp offset [read-write]	2234	=item ev_tstamp offset [read-write]
1709		2235
1710	When repeating, this contains the offset value, otherwise this is the	2236	When repeating, this contains the offset value, otherwise this is the
1711	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).
1712		2239
1713	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
1714	timer fires or C<ev_periodic_again> is being called.	2241	timer fires or C<ev_periodic_again> is being called.
1715		2242
1716	=item ev_tstamp interval [read-write]	2243	=item ev_tstamp interval [read-write]
…		…
1732	Example: Call a callback every hour, or, more precisely, whenever the	2259	Example: Call a callback every hour, or, more precisely, whenever the
1733	system time is divisible by 3600. The callback invocation times have	2260	system time is divisible by 3600. The callback invocation times have
1734	potentially a lot of jitter, but good long-term stability.	2261	potentially a lot of jitter, but good long-term stability.
1735		2262
1736	static void	2263	static void
1737	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2264	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1738	{	2265	{
1739	... 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)
1740	}	2267	}
1741		2268
1742	ev_periodic hourly_tick;	2269	ev_periodic hourly_tick;
…		…
1765		2292
1766	=head2 C<ev_signal> - signal me when a signal gets signalled!	2293	=head2 C<ev_signal> - signal me when a signal gets signalled!
1767		2294
1768	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
1769	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
1770	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
1771	normal event processing, like any other event.	2298	normal event processing, like any other event.
1772		2299
1773	If you want signals asynchronously, just use C<sigaction> as you would	2300	If you want signals to be delivered truly asynchronously, just use
1774	do without libev and forget about sharing the signal. You can even use	2301	C<sigaction> as you would do without libev and forget about sharing
1775	C<ev_async> from a signal handler to synchronously wake up an event loop.	2302	the signal. You can even use C<ev_async> from a signal handler to
		2303	synchronously wake up an event loop.
1776		2304
1777	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
1778	first watcher gets started will libev actually register a signal handler	2311	When the first watcher gets started will libev actually register something
1779	with the kernel (thus it coexists with your own signal handlers as long as	2312	with the kernel (thus it coexists with your own signal handlers as long as
1780	you don't register any with libev for the same signal). Similarly, when	2313	you don't register any with libev for the same signal).
1781	the last signal watcher for a signal is stopped, libev will reset the
1782	signal handler to SIG_DFL (regardless of what it was set to before).
1783		2314
1784	If possible and supported, libev will install its handlers with	2315	If possible and supported, libev will install its handlers with
1785	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2316	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1786	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
1787	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
1788	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>.
1789		2364
1790	=head3 Watcher-Specific Functions and Data Members	2365	=head3 Watcher-Specific Functions and Data Members
1791		2366
1792	=over 4	2367	=over 4
1793		2368
…		…
1809	Example: Try to exit cleanly on SIGINT.	2384	Example: Try to exit cleanly on SIGINT.
1810		2385
1811	static void	2386	static void
1812	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2387	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1813	{	2388	{
1814	ev_unloop (loop, EVUNLOOP_ALL);	2389	ev_break (loop, EVBREAK_ALL);
1815	}	2390	}
1816		2391
1817	ev_signal signal_watcher;	2392	ev_signal signal_watcher;
1818	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2393	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1819	ev_signal_start (loop, &signal_watcher);	2394	ev_signal_start (loop, &signal_watcher);
…		…
1825	some child status changes (most typically when a child of yours dies or	2400	some child status changes (most typically when a child of yours dies or
1826	exits). It is permissible to install a child watcher I<after> the child	2401	exits). It is permissible to install a child watcher I<after> the child
1827	has been forked (which implies it might have already exited), as long	2402	has been forked (which implies it might have already exited), as long
1828	as the event loop isn't entered (or is continued from a watcher), i.e.,	2403	as the event loop isn't entered (or is continued from a watcher), i.e.,
1829	forking and then immediately registering a watcher for the child is fine,	2404	forking and then immediately registering a watcher for the child is fine,
1830	but forking and registering a watcher a few event loop iterations later is	2405	but forking and registering a watcher a few event loop iterations later or
1831	not.	2406	in the next callback invocation is not.
1832		2407
1833	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
1834	you can only register child watchers in the default event loop.	2409	you can only register child watchers in the default event loop.
1835		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
1836	=head3 Process Interaction	2415	=head3 Process Interaction
1837		2416
1838	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
1839	initialised. This is necessary to guarantee proper behaviour even if	2418	initialised. This is necessary to guarantee proper behaviour even if the
1840	the first child watcher is started after the child exits. The occurrence	2419	first child watcher is started after the child exits. The occurrence
1841	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2420	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1842	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
1843	children, even ones not watched.	2422	children, even ones not watched.
1844		2423
1845	=head3 Overriding the Built-In Processing	2424	=head3 Overriding the Built-In Processing
…		…
1855	=head3 Stopping the Child Watcher	2434	=head3 Stopping the Child Watcher
1856		2435
1857	Currently, the child watcher never gets stopped, even when the	2436	Currently, the child watcher never gets stopped, even when the
1858	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
1859	callback. Future versions of libev might stop the watcher automatically	2438	callback. Future versions of libev might stop the watcher automatically
1860	when a child exit is detected.	2439	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2440	problem).
1861		2441
1862	=head3 Watcher-Specific Functions and Data Members	2442	=head3 Watcher-Specific Functions and Data Members
1863		2443
1864	=over 4	2444	=over 4
1865		2445
…		…
1922		2502
1923		2503
1924	=head2 C<ev_stat> - did the file attributes just change?	2504	=head2 C<ev_stat> - did the file attributes just change?
1925		2505
1926	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
1927	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)
1928	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.
1929		2510
1930	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
1931	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
1932	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
1933	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
1934	the stat buffer having unspecified contents.	2515	least one) and all the other fields of the stat buffer having unspecified
		2516	contents.
1935		2517
1936	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
1937	relative and your working directory changes, the behaviour is undefined.	2520	your working directory changes, then the behaviour is undefined.
1938		2521
1939	Since there is no standard kernel interface to do this, the portable	2522	Since there is no portable change notification interface available, the
1940	implementation simply calls C<stat (2)> regularly on the path to see if	2523	portable implementation simply calls C<stat(2)> regularly on the path
1941	it changed somehow. You can specify a recommended polling interval for	2524	to see if it changed somehow. You can specify a recommended polling
1942	this case. If you specify a polling interval of C<0> (highly recommended!)	2525	interval for this case. If you specify a polling interval of C<0> (highly
1943	then a I<suitable, unspecified default> value will be used (which	2526	recommended!) then a I<suitable, unspecified default> value will be used
1944	you can expect to be around five seconds, although this might change	2527	(which you can expect to be around five seconds, although this might
1945	dynamically). Libev will also impose a minimum interval which is currently	2528	change dynamically). Libev will also impose a minimum interval which is
1946	around C<0.1>, but thats usually overkill.	2529	currently around C<0.1>, but that's usually overkill.
1947		2530
1948	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,
1949	as even with OS-supported change notifications, this can be	2532	as even with OS-supported change notifications, this can be
1950	resource-intensive.	2533	resource-intensive.
1951		2534
1952	At the time of this writing, the only OS-specific interface implemented	2535	At the time of this writing, the only OS-specific interface implemented
1953	is the Linux inotify interface (implementing kqueue support is left as	2536	is the Linux inotify interface (implementing kqueue support is left as an
1954	an exercise for the reader. Note, however, that the author sees no way	2537	exercise for the reader. Note, however, that the author sees no way of
1955	of implementing C<ev_stat> semantics with kqueue).	2538	implementing C<ev_stat> semantics with kqueue, except as a hint).
1956		2539
1957	=head3 ABI Issues (Largefile Support)	2540	=head3 ABI Issues (Largefile Support)
1958		2541
1959	Libev by default (unless the user overrides this) uses the default	2542	Libev by default (unless the user overrides this) uses the default
1960	compilation environment, which means that on systems with large file	2543	compilation environment, which means that on systems with large file
1961	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
1962	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
1963	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
1964	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
1965	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
1966	most noticeably disabled with ev_stat and large file support.	2549	most noticeably displayed with ev_stat and large file support.
1967		2550
1968	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
1969	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
1970	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
1971	to exchange stat structures with application programs compiled using the	2554	to exchange stat structures with application programs compiled using the
1972	default compilation environment.	2555	default compilation environment.
1973		2556
1974	=head3 Inotify and Kqueue	2557	=head3 Inotify and Kqueue
1975		2558
1976	When C<inotify (7)> support has been compiled into libev (generally	2559	When C<inotify (7)> support has been compiled into libev and present at
1977	only available with Linux 2.6.25 or above due to bugs in earlier	2560	runtime, it will be used to speed up change detection where possible. The
1978	implementations) and present at runtime, it will be used to speed up	2561	inotify descriptor will be created lazily when the first C<ev_stat>
1979	change detection where possible. The inotify descriptor will be created	2562	watcher is being started.
1980	lazily when the first C<ev_stat> watcher is being started.
1981		2563
1982	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
1983	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
1984	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
1985	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,
1986	but as long as the path exists, libev usually gets away without 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.
1987		2572
1988	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
1989	implement this functionality, due to the requirement of having a file	2574	implement this functionality, due to the requirement of having a file
1990	descriptor open on the object at all times, and detecting renames, unlinks	2575	descriptor open on the object at all times, and detecting renames, unlinks
1991	etc. is difficult.	2576	etc. is difficult.
1992		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.
		2595
1993	=head3 The special problem of stat time resolution	2596	=head3 The special problem of stat time resolution
1994		2597
1995	The C<stat ()> system call only supports full-second resolution portably, and	2598	The C<stat ()> system call only supports full-second resolution portably,
1996	even on systems where the resolution is higher, most file systems still	2599	and even on systems where the resolution is higher, most file systems
1997	only support whole seconds.	2600	still only support whole seconds.
1998		2601
1999	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
2000	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
2001	calls your callback, which does something. When there is another update	2604	calls your callback, which does something. When there is another update
2002	within the same second, C<ev_stat> will be unable to detect unless the	2605	within the same second, C<ev_stat> will be unable to detect unless the
…		…
2145		2748
2146	=head3 Watcher-Specific Functions and Data Members	2749	=head3 Watcher-Specific Functions and Data Members
2147		2750
2148	=over 4	2751	=over 4
2149		2752
2150	=item ev_idle_init (ev_signal *, callback)	2753	=item ev_idle_init (ev_idle *, callback)
2151		2754
2152	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
2153	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,
2154	believe me.	2757	believe me.
2155		2758
…		…
2168	// no longer anything immediate to do.	2771	// no longer anything immediate to do.
2169	}	2772	}
2170		2773
2171	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	2774	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2172	ev_idle_init (idle_watcher, idle_cb);	2775	ev_idle_init (idle_watcher, idle_cb);
2173	ev_idle_start (loop, idle_cb);	2776	ev_idle_start (loop, idle_watcher);
2174		2777
2175		2778
2176	=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!
2177		2780
2178	Prepare and check watchers are usually (but not always) used in pairs:	2781	Prepare and check watchers are usually (but not always) used in pairs:
2179	prepare watchers get invoked before the process blocks and check watchers	2782	prepare watchers get invoked before the process blocks and check watchers
2180	afterwards.	2783	afterwards.
2181		2784
2182	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
2183	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>
2184	watchers. Other loops than the current one are fine, however. The	2787	watchers. Other loops than the current one are fine, however. The
2185	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
2186	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,
2187	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
…		…
2271	struct pollfd fds [nfd];	2874	struct pollfd fds [nfd];
2272	// actual code will need to loop here and realloc etc.	2875	// actual code will need to loop here and realloc etc.
2273	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2876	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2274		2877
2275	/* 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 */
2276	ev_timer_init (&tw, 0, timeout * 1e-3);	2879	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2277	ev_timer_start (loop, &tw);	2880	ev_timer_start (loop, &tw);
2278		2881
2279	// create one ev_io per pollfd	2882	// create one ev_io per pollfd
2280	for (int i = 0; i < nfd; ++i)	2883	for (int i = 0; i < nfd; ++i)
2281	{	2884	{
…		…
2355		2958
2356	if (timeout >= 0)	2959	if (timeout >= 0)
2357	// create/start timer	2960	// create/start timer
2358		2961
2359	// poll	2962	// poll
2360	ev_loop (EV_A_ 0);	2963	ev_run (EV_A_ 0);
2361		2964
2362	// stop timer again	2965	// stop timer again
2363	if (timeout >= 0)	2966	if (timeout >= 0)
2364	ev_timer_stop (EV_A_ &to);	2967	ev_timer_stop (EV_A_ &to);
2365		2968
…		…
2394	some fds have to be watched and handled very quickly (with low latency),	2997	some fds have to be watched and handled very quickly (with low latency),
2395	and even priorities and idle watchers might have too much overhead. In	2998	and even priorities and idle watchers might have too much overhead. In
2396	this case you would put all the high priority stuff in one loop and all	2999	this case you would put all the high priority stuff in one loop and all
2397	the rest in 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.
2398		3001
2399	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
2400	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
2401	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
2402	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
2403	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
2404	to C<0>, in which case the embed watcher will automatically execute the	3007	to give the embedded loop strictly lower priority for example).
2405	embedded loop sweep.
2406		3008
2407	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
2408	callback will be invoked whenever some events have been handled. You can	3010	will automatically execute the embedded loop sweep whenever necessary.
2409	set the callback to C<0> to avoid having to specify one if you are not
2410	interested in that.
2411		3011
2412	Also, there have not currently been made special provisions for forking:	3012	Fork detection will be handled transparently while the C<ev_embed> watcher
2413	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
2414	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
2415	yourself - but you can use a fork watcher to handle this automatically,	3015	C<ev_loop_fork> on the embedded loop.
2416	and future versions of libev might do just that.
2417		3016
2418	Unfortunately, not all backends are embeddable: only the ones returned by	3017	Unfortunately, not all backends are embeddable: only the ones returned by
2419	C<ev_embeddable_backends> are, which, unfortunately, does not include any	3018	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2420	portable one.	3019	portable one.
2421		3020
…		…
2447	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).
2448		3047
2449	=item ev_embed_sweep (loop, ev_embed *)	3048	=item ev_embed_sweep (loop, ev_embed *)
2450		3049
2451	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
2452	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
2453	appropriate way for embedded loops.	3052	appropriate way for embedded loops.
2454		3053
2455	=item struct ev_loop *other [read-only]	3054	=item struct ev_loop *other [read-only]
2456		3055
2457	The embedded event loop.	3056	The embedded event loop.
…		…
2515	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,
2516	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
2517	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
2518	handlers will be invoked, too, of course.	3117	handlers will be invoked, too, of course.
2519		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
2520	=head3 Watcher-Specific Functions and Data Members	3153	=head3 Watcher-Specific Functions and Data Members
2521		3154
2522	=over 4	3155	=over 4
2523		3156
2524	=item ev_fork_init (ev_signal *, callback)	3157	=item ev_fork_init (ev_fork *, callback)
2525		3158
2526	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
2527	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,
2528	believe me.	3161	really.
2529		3162
2530	=back	3163	=back
2531		3164
2532		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
2533	=head2 C<ev_async> - how to wake up another event loop	3206	=head2 C<ev_async> - how to wake up an event loop
2534		3207
2535	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
2536	asynchronous sources such as signal handlers (as opposed to multiple event	3209	asynchronous sources such as signal handlers (as opposed to multiple event
2537	loops - those are of course safe to use in different threads).	3210	loops - those are of course safe to use in different threads).
2538		3211
2539	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,
2540	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>
2541	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
2542	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.
2543	safe.
2544		3216
2545	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,
2546	too, are asynchronous in nature, and signals, too, will be compressed	3218	too, are asynchronous in nature, and signals, too, will be compressed
2547	(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
2548	C<ev_async_sent> calls).	3220	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
2549		3221	of "global async watchers" by using a watcher on an otherwise unused
2550	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,
2551	just the default loop.	3223	even without knowing which loop owns the signal.
2552		3224
2553	=head3 Queueing	3225	=head3 Queueing
2554		3226
2555	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
2556	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
2557	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
2558	need elaborate support such as pthreads.	3230	need elaborate support such as pthreads or unportable memory access
		3231	semantics.
2559		3232
2560	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
2561	queue. But at least I can tell you how to implement locking around your	3234	queue. But at least I can tell you how to implement locking around your
2562	queue:	3235	queue:
2563		3236
…		…
2641	=over 4	3314	=over 4
2642		3315
2643	=item ev_async_init (ev_async *, callback)	3316	=item ev_async_init (ev_async *, callback)
2644		3317
2645	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
2646	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,
2647	trust me.	3320	trust me.
2648		3321
2649	=item ev_async_send (loop, ev_async *)	3322	=item ev_async_send (loop, ev_async *)
2650		3323
2651	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
2652	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
2653	C<ev_feed_event>, this call is safe to do from other threads, signal or	3328	Unlike C<ev_feed_event>, this call is safe to do from other threads,
2654	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
2655	section below on what exactly this means).	3330	embedding section below on what exactly this means).
2656		3331
2657	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
2658	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
2659	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.
2660		3343
2661	=item bool = ev_async_pending (ev_async *)	3344	=item bool = ev_async_pending (ev_async *)
2662		3345
2663	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
2664	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
…		…
2667	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
2668	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,
2669	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
2670	quickly check whether invoking the loop might be a good idea.	3353	quickly check whether invoking the loop might be a good idea.
2671		3354
2672	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,
2673	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.
2674		3359
2675	=back	3360	=back
2676		3361
2677		3362
2678	=head1 OTHER FUNCTIONS	3363	=head1 OTHER FUNCTIONS
…		…
2695		3380
2696	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
2697	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
2698	repeat = 0) will be started. C<0> is a valid timeout.	3383	repeat = 0) will be started. C<0> is a valid timeout.
2699		3384
2700	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
2701	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
2702	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>
2703	value passed to C<ev_once>. Note that it is possible to receive I<both>	3388	value passed to C<ev_once>. Note that it is possible to receive I<both>
2704	a timeout and an io event at the same time - you probably should give io	3389	a timeout and an io event at the same time - you probably should give io
2705	events precedence.	3390	events precedence.
2706		3391
2707	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3392	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2708		3393
2709	static void stdin_ready (int revents, void *arg)	3394	static void stdin_ready (int revents, void *arg)
2710	{	3395	{
2711	if (revents & EV_READ)	3396	if (revents & EV_READ)
2712	/* stdin might have data for us, joy! */;	3397	/* stdin might have data for us, joy! */;
2713	else if (revents & EV_TIMEOUT)	3398	else if (revents & EV_TIMER)
2714	/* doh, nothing entered */;	3399	/* doh, nothing entered */;
2715	}	3400	}
2716		3401
2717	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3402	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2718		3403
2719	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2720
2721	Feeds the given event set into the event loop, as if the specified event
2722	had happened for the specified watcher (which must be a pointer to an
2723	initialised but not necessarily started event watcher).
2724
2725	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3404	=item ev_feed_fd_event (loop, int fd, int revents)
2726		3405
2727	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
2728	the given events it.	3407	the given events it.
2729		3408
2730	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3409	=item ev_feed_signal_event (loop, int signum)
2731		3410
2732	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>,
2733	loop!).	3412	which is async-safe.
2734		3413
2735	=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.
2736		3725
2737		3726
2738	=head1 LIBEVENT EMULATION	3727	=head1 LIBEVENT EMULATION
2739		3728
2740	Libev offers a compatibility emulation layer for libevent. It cannot	3729	Libev offers a compatibility emulation layer for libevent. It cannot
2741	emulate the internals of libevent, so here are some usage hints:	3730	emulate the internals of libevent, so here are some usage hints:
2742		3731
2743	=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.
2744		3738
2745	=item * Use it by including <event.h>, as usual.	3739	=item * Use it by including <event.h>, as usual.
2746		3740
2747	=item * The following members are fully supported: ev_base, ev_callback,	3741	=item * The following members are fully supported: ev_base, ev_callback,
2748	ev_arg, ev_fd, ev_res, ev_events.	3742	ev_arg, ev_fd, ev_res, ev_events.
…		…
2754	=item * Priorities are not currently supported. Initialising priorities	3748	=item * Priorities are not currently supported. Initialising priorities
2755	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
2756	is an ev_pri field.	3750	is an ev_pri field.
2757		3751
2758	=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
2759	first base created (== the default loop) gets the signals.	3753	base that registered the signal gets the signals.
2760		3754
2761	=item * Other members are not supported.	3755	=item * Other members are not supported.
2762		3756
2763	=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
2764	to use the libev header file and library.	3758	to use the libev header file and library.
…		…
2783	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++
2784	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
2785	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
2786	you disable C<EV_MULTIPLICITY> when embedding libev).	3780	you disable C<EV_MULTIPLICITY> when embedding libev).
2787		3781
2788	Currently, functions, and static and non-static member functions can be	3782	Currently, functions, static and non-static member functions and classes
2789	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
2790	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
2791	types of functors please contact the author (preferably after implementing	3785	you need support for other types of functors please contact the author
2792	it).	3786	(preferably after implementing it).
2793		3787
2794	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:
2795		3789
2796	=over 4	3790	=over 4
2797		3791
…		…
2815		3809
2816	=over 4	3810	=over 4
2817		3811
2818	=item ev::TYPE::TYPE ()	3812	=item ev::TYPE::TYPE ()
2819		3813
2820	=item ev::TYPE::TYPE (struct ev_loop *)	3814	=item ev::TYPE::TYPE (loop)
2821		3815
2822	=item ev::TYPE::~TYPE	3816	=item ev::TYPE::~TYPE
2823		3817
2824	The constructor (optionally) takes an event loop to associate the watcher	3818	The constructor (optionally) takes an event loop to associate the watcher
2825	with. If it is omitted, it will use C<EV_DEFAULT>.	3819	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
2857		3851
2858	myclass obj;	3852	myclass obj;
2859	ev::io iow;	3853	ev::io iow;
2860	iow.set <myclass, &myclass::io_cb> (&obj);	3854	iow.set <myclass, &myclass::io_cb> (&obj);
2861		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
2862	=item w->set<function> (void *data = 0)	3884	=item w->set<function> (void *data = 0)
2863		3885
2864	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
2865	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
2866	C<data> member and is free for you to use.	3888	C<data> member and is free for you to use.
…		…
2872	Example: Use a plain function as callback.	3894	Example: Use a plain function as callback.
2873		3895
2874	static void io_cb (ev::io &w, int revents) { }	3896	static void io_cb (ev::io &w, int revents) { }
2875	iow.set <io_cb> ();	3897	iow.set <io_cb> ();
2876		3898
2877	=item w->set (struct ev_loop *)	3899	=item w->set (loop)
2878		3900
2879	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
2880	do this when the watcher is inactive (and not pending either).	3902	do this when the watcher is inactive (and not pending either).
2881		3903
2882	=item w->set ([arguments])	3904	=item w->set ([arguments])
2883		3905
2884	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
2885	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
2886	automatically stopped and restarted when reconfiguring it with this	3908	C counterpart, an active watcher gets automatically stopped and restarted
2887	method.	3909	when reconfiguring it with this method.
2888		3910
2889	=item w->start ()	3911	=item w->start ()
2890		3912
2891	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
2892	constructor already stores the event loop.	3914	constructor already stores the event loop.
2893		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
2894	=item w->stop ()	3922	=item w->stop ()
2895		3923
2896	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.
2897		3925
2898	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3926	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
2910		3938
2911	=back	3939	=back
2912		3940
2913	=back	3941	=back
2914		3942
2915	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
2916	the constructor.	3944	watchers in the constructor.
2917		3945
2918	class myclass	3946	class myclass
2919	{	3947	{
2920	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::io io2 ; void io2_cb (ev::io &w, int revents);
2921	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3950	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2922		3951
2923	myclass (int fd)	3952	myclass (int fd)
2924	{	3953	{
2925	io .set <myclass, &myclass::io_cb > (this);	3954	io .set <myclass, &myclass::io_cb > (this);
		3955	io2 .set <myclass, &myclass::io2_cb > (this);
2926	idle.set <myclass, &myclass::idle_cb> (this);	3956	idle.set <myclass, &myclass::idle_cb> (this);
2927		3957
2928	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
2929	}	3962	}
2930	};	3963	};
2931		3964
2932		3965
2933	=head1 OTHER LANGUAGE BINDINGS	3966	=head1 OTHER LANGUAGE BINDINGS
…		…
2952	L<http://software.schmorp.de/pkg/EV>.	3985	L<http://software.schmorp.de/pkg/EV>.
2953		3986
2954	=item Python	3987	=item Python
2955		3988
2956	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
2957	seems to be quite complete and well-documented. Note, however, that the	3990	seems to be quite complete and well-documented.
2958	patch they require for libev is outright dangerous as it breaks the ABI
2959	for everybody else, and therefore, should never be applied in an installed
2960	libev (if python requires an incompatible ABI then it needs to embed
2961	libev).
2962		3991
2963	=item Ruby	3992	=item Ruby
2964		3993
2965	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
2966	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
2967	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
2968	L<http://rev.rubyforge.org/>.	3997	L<http://rev.rubyforge.org/>.
2969		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
2970	=item D	4007	=item D
2971		4008
2972	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
2973	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4010	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
2974		4011
2975	=item Ocaml	4012	=item Ocaml
2976		4013
2977	Erkki Seppala has written Ocaml bindings for libev, to be found at	4014	Erkki Seppala has written Ocaml bindings for libev, to be found at
2978	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	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>.
2979		4022
2980	=back	4023	=back
2981		4024
2982		4025
2983	=head1 MACRO MAGIC	4026	=head1 MACRO MAGIC
…		…
2997	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,
2998	C<EV_A_> is used when other arguments are following. Example:	4041	C<EV_A_> is used when other arguments are following. Example:
2999		4042
3000	ev_unref (EV_A);	4043	ev_unref (EV_A);
3001	ev_timer_add (EV_A_ watcher);	4044	ev_timer_add (EV_A_ watcher);
3002	ev_loop (EV_A_ 0);	4045	ev_run (EV_A_ 0);
3003		4046
3004	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,
3005	which is often provided by the following macro.	4048	which is often provided by the following macro.
3006		4049
3007	=item C<EV_P>, C<EV_P_>	4050	=item C<EV_P>, C<EV_P_>
…		…
3047	}	4090	}
3048		4091
3049	ev_check check;	4092	ev_check check;
3050	ev_check_init (&check, check_cb);	4093	ev_check_init (&check, check_cb);
3051	ev_check_start (EV_DEFAULT_ &check);	4094	ev_check_start (EV_DEFAULT_ &check);
3052	ev_loop (EV_DEFAULT_ 0);	4095	ev_run (EV_DEFAULT_ 0);
3053		4096
3054	=head1 EMBEDDING	4097	=head1 EMBEDDING
3055		4098
3056	Libev can (and often is) directly embedded into host	4099	Libev can (and often is) directly embedded into host
3057	applications. Examples of applications that embed it include the Deliantra	4100	applications. Examples of applications that embed it include the Deliantra
…		…
3084		4127
3085	#define EV_STANDALONE 1	4128	#define EV_STANDALONE 1
3086	#include "ev.h"	4129	#include "ev.h"
3087		4130
3088	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++
3089	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
3090	as a bug).	4133	as a bug).
3091		4134
3092	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
3093	in your include path (e.g. in libev/ when using -Ilibev):	4136	in your include path (e.g. in libev/ when using -Ilibev):
3094		4137
…		…
3137	libev.m4	4180	libev.m4
3138		4181
3139	=head2 PREPROCESSOR SYMBOLS/MACROS	4182	=head2 PREPROCESSOR SYMBOLS/MACROS
3140		4183
3141	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
3142	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
3143	autoconf is documented 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.
3144		4194
3145	=over 4	4195	=over 4
3146		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
3147	=item EV_STANDALONE	4213	=item EV_STANDALONE (h)
3148		4214
3149	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
3150	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
3151	implementations for some libevent functions (such as logging, which is not	4217	implementations for some libevent functions (such as logging, which is not
3152	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
3153	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.
3154		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
3155	=item EV_USE_MONOTONIC	4233	=item EV_USE_MONOTONIC
3156		4234
3157	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
3158	monotonic clock option at both compile time and runtime. Otherwise no use	4236	monotonic clock option at both compile time and runtime. Otherwise no
3159	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,
3160	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
3161	the functionality isn't available is safe, though, although you have	4239	when the functionality isn't available is safe, though, although you have
3162	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>
3163	function is hiding in (often F<-lrt>).	4241	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3164		4242
3165	=item EV_USE_REALTIME	4243	=item EV_USE_REALTIME
3166		4244
3167	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
3168	real-time clock option at compile time (and assume its availability at	4246	real-time clock option at compile time (and assume its availability
3169	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
3170	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	4248	option will be attempted. This effectively replaces C<gettimeofday>
3171	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	4249	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3172	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>).
3173		4264
3174	=item EV_USE_NANOSLEEP	4265	=item EV_USE_NANOSLEEP
3175		4266
3176	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
3177	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 ()>.
…		…
3193		4284
3194	=item EV_SELECT_USE_FD_SET	4285	=item EV_SELECT_USE_FD_SET
3195		4286
3196	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>
3197	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
3198	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
3199	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
3200	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
3201	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,
3202	influence the size of the C<fd_set> used.	4293	configures the maximum size of the C<fd_set>.
3203		4294
3204	=item EV_SELECT_IS_WINSOCKET	4295	=item EV_SELECT_IS_WINSOCKET
3205		4296
3206	When defined to C<1>, the select backend will assume that	4297	When defined to C<1>, the select backend will assume that
3207	select/socket/connect etc. don't understand file descriptors but	4298	select/socket/connect etc. don't understand file descriptors but
…		…
3209	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
3210	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,
3211	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
3212	on win32. Should not be defined on non-win32 platforms.	4303	on win32. Should not be defined on non-win32 platforms.
3213		4304
3214	=item EV_FD_TO_WIN32_HANDLE	4305	=item EV_FD_TO_WIN32_HANDLE(fd)
3215		4306
3216	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
3217	file descriptors to socket handles. When not defining this symbol (the	4308	file descriptors to socket handles. When not defining this symbol (the
3218	default), then libev will call C<_get_osfhandle>, which is usually	4309	default), then libev will call C<_get_osfhandle>, which is usually
3219	correct. In some cases, programs use their own file descriptor management,	4310	correct. In some cases, programs use their own file descriptor management,
3220	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.
3221		4326
3222	=item EV_USE_POLL	4327	=item EV_USE_POLL
3223		4328
3224	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)
3225	backend. Otherwise it will be enabled on non-win32 platforms. It	4330	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3264	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4369	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3265		4370
3266	=item EV_ATOMIC_T	4371	=item EV_ATOMIC_T
3267		4372
3268	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
3269	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
3270	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
3271	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
3272	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.
3273		4379
3274	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>
3275	(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,
		4382	although strictly speaking using a type that also implies a memory fence
		4383	is required.
3276		4384
3277	=item EV_H	4385	=item EV_H (h)
3278		4386
3279	The name of the F<ev.h> header file used to include it. The default if	4387	The name of the F<ev.h> header file used to include it. The default if
3280	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4388	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3281	used to virtually rename the F<ev.h> header file in case of conflicts.	4389	used to virtually rename the F<ev.h> header file in case of conflicts.
3282		4390
3283	=item EV_CONFIG_H	4391	=item EV_CONFIG_H (h)
3284		4392
3285	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4393	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3286	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4394	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3287	C<EV_H>, above.	4395	C<EV_H>, above.
3288		4396
3289	=item EV_EVENT_H	4397	=item EV_EVENT_H (h)
3290		4398
3291	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4399	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3292	of how the F<event.h> header can be found, the default is C<"event.h">.	4400	of how the F<event.h> header can be found, the default is C<"event.h">.
3293		4401
3294	=item EV_PROTOTYPES	4402	=item EV_PROTOTYPES (h)
3295		4403
3296	If defined to be C<0>, then F<ev.h> will not define any function	4404	If defined to be C<0>, then F<ev.h> will not define any function
3297	prototypes, but still define all the structs and other symbols. This is	4405	prototypes, but still define all the structs and other symbols. This is
3298	occasionally useful if you want to provide your own wrapper functions	4406	occasionally useful if you want to provide your own wrapper functions
3299	around libev functions.	4407	around libev functions.
…		…
3321	fine.	4429	fine.
3322		4430
3323	If your embedding application does not need any priorities, defining these	4431	If your embedding application does not need any priorities, defining these
3324	both to C<0> will save some memory and CPU.	4432	both to C<0> will save some memory and CPU.
3325		4433
3326	=item EV_PERIODIC_ENABLE	4434	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4435	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4436	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3327		4437
3328	If undefined or defined to be C<1>, then periodic timers are supported. If	4438	If undefined or defined to be C<1> (and the platform supports it), then
3329	defined to be C<0>, then they are not. Disabling them saves a few kB of	4439	the respective watcher type is supported. If defined to be C<0>, then it
3330	code.	4440	is not. Disabling watcher types mainly saves code size.
3331		4441
3332	=item EV_IDLE_ENABLE	4442	=item EV_FEATURES
3333
3334	If undefined or defined to be C<1>, then idle watchers are supported. If
3335	defined to be C<0>, then they are not. Disabling them saves a few kB of
3336	code.
3337
3338	=item EV_EMBED_ENABLE
3339
3340	If undefined or defined to be C<1>, then embed watchers are supported. If
3341	defined to be C<0>, then they are not. Embed watchers rely on most other
3342	watcher types, which therefore must not be disabled.
3343
3344	=item EV_STAT_ENABLE
3345
3346	If undefined or defined to be C<1>, then stat watchers are supported. If
3347	defined to be C<0>, then they are not.
3348
3349	=item EV_FORK_ENABLE
3350
3351	If undefined or defined to be C<1>, then fork watchers are supported. If
3352	defined to be C<0>, then they are not.
3353
3354	=item EV_ASYNC_ENABLE
3355
3356	If undefined or defined to be C<1>, then async watchers are supported. If
3357	defined to be C<0>, then they are not.
3358
3359	=item EV_MINIMAL
3360		4443
3361	If you need to shave off some kilobytes of code at the expense of some	4444	If you need to shave off some kilobytes of code at the expense of some
3362	speed, define this symbol to C<1>. Currently this is used to override some	4445	speed (but with the full API), you can define this symbol to request
3363	inlining decisions, saves roughly 30% code size on amd64. It also selects a	4446	certain subsets of functionality. The default is to enable all features
3364	much smaller 2-heap for timer management over the default 4-heap.	4447	that can be enabled on the platform.
		4448
		4449	A typical way to use this symbol is to define it to C<0> (or to a bitset
		4450	with some broad features you want) and then selectively re-enable
		4451	additional parts you want, for example if you want everything minimal,
		4452	but multiple event loop support, async and child watchers and the poll
		4453	backend, use this:
		4454
		4455	#define EV_FEATURES 0
		4456	#define EV_MULTIPLICITY 1
		4457	#define EV_USE_POLL 1
		4458	#define EV_CHILD_ENABLE 1
		4459	#define EV_ASYNC_ENABLE 1
		4460
		4461	The actual value is a bitset, it can be a combination of the following
		4462	values:
		4463
		4464	=over 4
		4465
		4466	=item C<1> - faster/larger code
		4467
		4468	Use larger code to speed up some operations.
		4469
		4470	Currently this is used to override some inlining decisions (enlarging the
		4471	code size by roughly 30% on amd64).
		4472
		4473	When optimising for size, use of compiler flags such as C<-Os> with
		4474	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4475	assertions.
		4476
		4477	=item C<2> - faster/larger data structures
		4478
		4479	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4480	hash table sizes and so on. This will usually further increase code size
		4481	and can additionally have an effect on the size of data structures at
		4482	runtime.
		4483
		4484	=item C<4> - full API configuration
		4485
		4486	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4487	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4488
		4489	=item C<8> - full API
		4490
		4491	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4492	details on which parts of the API are still available without this
		4493	feature, and do not complain if this subset changes over time.
		4494
		4495	=item C<16> - enable all optional watcher types
		4496
		4497	Enables all optional watcher types. If you want to selectively enable
		4498	only some watcher types other than I/O and timers (e.g. prepare,
		4499	embed, async, child...) you can enable them manually by defining
		4500	C<EV_watchertype_ENABLE> to C<1> instead.
		4501
		4502	=item C<32> - enable all backends
		4503
		4504	This enables all backends - without this feature, you need to enable at
		4505	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4506
		4507	=item C<64> - enable OS-specific "helper" APIs
		4508
		4509	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4510	default.
		4511
		4512	=back
		4513
		4514	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4515	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4516	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4517	watchers, timers and monotonic clock support.
		4518
		4519	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4520	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4521	your program might be left out as well - a binary starting a timer and an
		4522	I/O watcher then might come out at only 5Kb.
		4523
		4524	=item EV_AVOID_STDIO
		4525
		4526	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4527	functions (printf, scanf, perror etc.). This will increase the code size
		4528	somewhat, but if your program doesn't otherwise depend on stdio and your
		4529	libc allows it, this avoids linking in the stdio library which is quite
		4530	big.
		4531
		4532	Note that error messages might become less precise when this option is
		4533	enabled.
		4534
		4535	=item EV_NSIG
		4536
		4537	The highest supported signal number, +1 (or, the number of
		4538	signals): Normally, libev tries to deduce the maximum number of signals
		4539	automatically, but sometimes this fails, in which case it can be
		4540	specified. Also, using a lower number than detected (C<32> should be
		4541	good for about any system in existence) can save some memory, as libev
		4542	statically allocates some 12-24 bytes per signal number.
3365		4543
3366	=item EV_PID_HASHSIZE	4544	=item EV_PID_HASHSIZE
3367		4545
3368	C<ev_child> watchers use a small hash table to distribute workload by	4546	C<ev_child> watchers use a small hash table to distribute workload by
3369	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4547	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3370	than enough. If you need to manage thousands of children you might want to	4548	usually more than enough. If you need to manage thousands of children you
3371	increase this value (I<must> be a power of two).	4549	might want to increase this value (I<must> be a power of two).
3372		4550
3373	=item EV_INOTIFY_HASHSIZE	4551	=item EV_INOTIFY_HASHSIZE
3374		4552
3375	C<ev_stat> watchers use a small hash table to distribute workload by	4553	C<ev_stat> watchers use a small hash table to distribute workload by
3376	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4554	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3377	usually more than enough. If you need to manage thousands of C<ev_stat>	4555	disabled), usually more than enough. If you need to manage thousands of
3378	watchers you might want to increase this value (I<must> be a power of	4556	C<ev_stat> watchers you might want to increase this value (I<must> be a
3379	two).	4557	power of two).
3380		4558
3381	=item EV_USE_4HEAP	4559	=item EV_USE_4HEAP
3382		4560
3383	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4561	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3384	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4562	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3385	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4563	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3386	faster performance with many (thousands) of watchers.	4564	faster performance with many (thousands) of watchers.
3387		4565
3388	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4566	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3389	(disabled).	4567	will be C<0>.
3390		4568
3391	=item EV_HEAP_CACHE_AT	4569	=item EV_HEAP_CACHE_AT
3392		4570
3393	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4571	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3394	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4572	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3395	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4573	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3396	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4574	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3397	but avoids random read accesses on heap changes. This improves performance	4575	but avoids random read accesses on heap changes. This improves performance
3398	noticeably with many (hundreds) of watchers.	4576	noticeably with many (hundreds) of watchers.
3399		4577
3400	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4578	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3401	(disabled).	4579	will be C<0>.
3402		4580
3403	=item EV_VERIFY	4581	=item EV_VERIFY
3404		4582
3405	Controls how much internal verification (see C<ev_loop_verify ()>) will	4583	Controls how much internal verification (see C<ev_verify ()>) will
3406	be done: If set to C<0>, no internal verification code will be compiled	4584	be done: If set to C<0>, no internal verification code will be compiled
3407	in. If set to C<1>, then verification code will be compiled in, but not	4585	in. If set to C<1>, then verification code will be compiled in, but not
3408	called. If set to C<2>, then the internal verification code will be	4586	called. If set to C<2>, then the internal verification code will be
3409	called once per loop, which can slow down libev. If set to C<3>, then the	4587	called once per loop, which can slow down libev. If set to C<3>, then the
3410	verification code will be called very frequently, which will slow down	4588	verification code will be called very frequently, which will slow down
3411	libev considerably.	4589	libev considerably.
3412		4590
3413	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4591	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3414	C<0>.	4592	will be C<0>.
3415		4593
3416	=item EV_COMMON	4594	=item EV_COMMON
3417		4595
3418	By default, all watchers have a C<void *data> member. By redefining	4596	By default, all watchers have a C<void *data> member. By redefining
3419	this macro to a something else you can include more and other types of	4597	this macro to something else you can include more and other types of
3420	members. You have to define it each time you include one of the files,	4598	members. You have to define it each time you include one of the files,
3421	though, and it must be identical each time.	4599	though, and it must be identical each time.
3422		4600
3423	For example, the perl EV module uses something like this:	4601	For example, the perl EV module uses something like this:
3424		4602
…		…
3477	file.	4655	file.
3478		4656
3479	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4657	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3480	that everybody includes and which overrides some configure choices:	4658	that everybody includes and which overrides some configure choices:
3481		4659
3482	#define EV_MINIMAL 1	4660	#define EV_FEATURES 8
3483	#define EV_USE_POLL 0	4661	#define EV_USE_SELECT 1
3484	#define EV_MULTIPLICITY 0
3485	#define EV_PERIODIC_ENABLE 0	4662	#define EV_PREPARE_ENABLE 1
		4663	#define EV_IDLE_ENABLE 1
3486	#define EV_STAT_ENABLE 0	4664	#define EV_SIGNAL_ENABLE 1
3487	#define EV_FORK_ENABLE 0	4665	#define EV_CHILD_ENABLE 1
		4666	#define EV_USE_STDEXCEPT 0
3488	#define EV_CONFIG_H <config.h>	4667	#define EV_CONFIG_H <config.h>
3489	#define EV_MINPRI 0
3490	#define EV_MAXPRI 0
3491		4668
3492	#include "ev++.h"	4669	#include "ev++.h"
3493		4670
3494	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4671	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3495		4672
3496	#include "ev_cpp.h"	4673	#include "ev_cpp.h"
3497	#include "ev.c"	4674	#include "ev.c"
3498		4675
3499	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4676	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3500		4677
3501	=head2 THREADS AND COROUTINES	4678	=head2 THREADS AND COROUTINES
3502		4679
3503	=head3 THREADS	4680	=head3 THREADS
3504		4681
…		…
3555	default loop and triggering an C<ev_async> watcher from the default loop	4732	default loop and triggering an C<ev_async> watcher from the default loop
3556	watcher callback into the event loop interested in the signal.	4733	watcher callback into the event loop interested in the signal.
3557		4734
3558	=back	4735	=back
3559		4736
		4737	See also L<THREAD LOCKING EXAMPLE>.
		4738
3560	=head3 COROUTINES	4739	=head3 COROUTINES
3561		4740
3562	Libev is very accommodating to coroutines ("cooperative threads"):	4741	Libev is very accommodating to coroutines ("cooperative threads"):
3563	libev fully supports nesting calls to its functions from different	4742	libev fully supports nesting calls to its functions from different
3564	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4743	coroutines (e.g. you can call C<ev_run> on the same loop from two
3565	different coroutines, and switch freely between both coroutines running the	4744	different coroutines, and switch freely between both coroutines running
3566	loop, as long as you don't confuse yourself). The only exception is that	4745	the loop, as long as you don't confuse yourself). The only exception is
3567	you must not do this from C<ev_periodic> reschedule callbacks.	4746	that you must not do this from C<ev_periodic> reschedule callbacks.
3568		4747
3569	Care has been taken to ensure that libev does not keep local state inside	4748	Care has been taken to ensure that libev does not keep local state inside
3570	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4749	C<ev_run>, and other calls do not usually allow for coroutine switches as
3571	they do not clal any callbacks.	4750	they do not call any callbacks.
3572		4751
3573	=head2 COMPILER WARNINGS	4752	=head2 COMPILER WARNINGS
3574		4753
3575	Depending on your compiler and compiler settings, you might get no or a	4754	Depending on your compiler and compiler settings, you might get no or a
3576	lot of warnings when compiling libev code. Some people are apparently	4755	lot of warnings when compiling libev code. Some people are apparently
…		…
3586	maintainable.	4765	maintainable.
3587		4766
3588	And of course, some compiler warnings are just plain stupid, or simply	4767	And of course, some compiler warnings are just plain stupid, or simply
3589	wrong (because they don't actually warn about the condition their message	4768	wrong (because they don't actually warn about the condition their message
3590	seems to warn about). For example, certain older gcc versions had some	4769	seems to warn about). For example, certain older gcc versions had some
3591	warnings that resulted an extreme number of false positives. These have	4770	warnings that resulted in an extreme number of false positives. These have
3592	been fixed, but some people still insist on making code warn-free with	4771	been fixed, but some people still insist on making code warn-free with
3593	such buggy versions.	4772	such buggy versions.
3594		4773
3595	While libev is written to generate as few warnings as possible,	4774	While libev is written to generate as few warnings as possible,
3596	"warn-free" code is not a goal, and it is recommended not to build libev	4775	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
3610	==2274== definitely lost: 0 bytes in 0 blocks.	4789	==2274== definitely lost: 0 bytes in 0 blocks.
3611	==2274== possibly lost: 0 bytes in 0 blocks.	4790	==2274== possibly lost: 0 bytes in 0 blocks.
3612	==2274== still reachable: 256 bytes in 1 blocks.	4791	==2274== still reachable: 256 bytes in 1 blocks.
3613		4792
3614	Then there is no memory leak, just as memory accounted to global variables	4793	Then there is no memory leak, just as memory accounted to global variables
3615	is not a memleak - the memory is still being refernced, and didn't leak.	4794	is not a memleak - the memory is still being referenced, and didn't leak.
3616		4795
3617	Similarly, under some circumstances, valgrind might report kernel bugs	4796	Similarly, under some circumstances, valgrind might report kernel bugs
3618	as if it were a bug in libev (e.g. in realloc or in the poll backend,	4797	as if it were a bug in libev (e.g. in realloc or in the poll backend,
3619	although an acceptable workaround has been found here), or it might be	4798	although an acceptable workaround has been found here), or it might be
3620	confused.	4799	confused.
…		…
3632	I suggest using suppression lists.	4811	I suggest using suppression lists.
3633		4812
3634		4813
3635	=head1 PORTABILITY NOTES	4814	=head1 PORTABILITY NOTES
3636		4815
		4816	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4817
		4818	GNU/Linux is the only common platform that supports 64 bit file/large file
		4819	interfaces but I<disables> them by default.
		4820
		4821	That means that libev compiled in the default environment doesn't support
		4822	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4823
		4824	Unfortunately, many programs try to work around this GNU/Linux issue
		4825	by enabling the large file API, which makes them incompatible with the
		4826	standard libev compiled for their system.
		4827
		4828	Likewise, libev cannot enable the large file API itself as this would
		4829	suddenly make it incompatible to the default compile time environment,
		4830	i.e. all programs not using special compile switches.
		4831
		4832	=head2 OS/X AND DARWIN BUGS
		4833
		4834	The whole thing is a bug if you ask me - basically any system interface
		4835	you touch is broken, whether it is locales, poll, kqueue or even the
		4836	OpenGL drivers.
		4837
		4838	=head3 C<kqueue> is buggy
		4839
		4840	The kqueue syscall is broken in all known versions - most versions support
		4841	only sockets, many support pipes.
		4842
		4843	Libev tries to work around this by not using C<kqueue> by default on this
		4844	rotten platform, but of course you can still ask for it when creating a
		4845	loop - embedding a socket-only kqueue loop into a select-based one is
		4846	probably going to work well.
		4847
		4848	=head3 C<poll> is buggy
		4849
		4850	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4851	implementation by something calling C<kqueue> internally around the 10.5.6
		4852	release, so now C<kqueue> I<and> C<poll> are broken.
		4853
		4854	Libev tries to work around this by not using C<poll> by default on
		4855	this rotten platform, but of course you can still ask for it when creating
		4856	a loop.
		4857
		4858	=head3 C<select> is buggy
		4859
		4860	All that's left is C<select>, and of course Apple found a way to fuck this
		4861	one up as well: On OS/X, C<select> actively limits the number of file
		4862	descriptors you can pass in to 1024 - your program suddenly crashes when
		4863	you use more.
		4864
		4865	There is an undocumented "workaround" for this - defining
		4866	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4867	work on OS/X.
		4868
		4869	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4870
		4871	=head3 C<errno> reentrancy
		4872
		4873	The default compile environment on Solaris is unfortunately so
		4874	thread-unsafe that you can't even use components/libraries compiled
		4875	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4876	defined by default. A valid, if stupid, implementation choice.
		4877
		4878	If you want to use libev in threaded environments you have to make sure
		4879	it's compiled with C<_REENTRANT> defined.
		4880
		4881	=head3 Event port backend
		4882
		4883	The scalable event interface for Solaris is called "event
		4884	ports". Unfortunately, this mechanism is very buggy in all major
		4885	releases. If you run into high CPU usage, your program freezes or you get
		4886	a large number of spurious wakeups, make sure you have all the relevant
		4887	and latest kernel patches applied. No, I don't know which ones, but there
		4888	are multiple ones to apply, and afterwards, event ports actually work
		4889	great.
		4890
		4891	If you can't get it to work, you can try running the program by setting
		4892	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4893	C<select> backends.
		4894
		4895	=head2 AIX POLL BUG
		4896
		4897	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4898	this by trying to avoid the poll backend altogether (i.e. it's not even
		4899	compiled in), which normally isn't a big problem as C<select> works fine
		4900	with large bitsets on AIX, and AIX is dead anyway.
		4901
3637	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4902	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4903
		4904	=head3 General issues
3638		4905
3639	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4906	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3640	requires, and its I/O model is fundamentally incompatible with the POSIX	4907	requires, and its I/O model is fundamentally incompatible with the POSIX
3641	model. Libev still offers limited functionality on this platform in	4908	model. Libev still offers limited functionality on this platform in
3642	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4909	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3643	descriptors. This only applies when using Win32 natively, not when using	4910	descriptors. This only applies when using Win32 natively, not when using
3644	e.g. cygwin.	4911	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4912	as every compiler comes with a slightly differently broken/incompatible
		4913	environment.
3645		4914
3646	Lifting these limitations would basically require the full	4915	Lifting these limitations would basically require the full
3647	re-implementation of the I/O system. If you are into these kinds of	4916	re-implementation of the I/O system. If you are into this kind of thing,
3648	things, then note that glib does exactly that for you in a very portable	4917	then note that glib does exactly that for you in a very portable way (note
3649	way (note also that glib is the slowest event library known to man).	4918	also that glib is the slowest event library known to man).
3650		4919
3651	There is no supported compilation method available on windows except	4920	There is no supported compilation method available on windows except
3652	embedding it into other applications.	4921	embedding it into other applications.
		4922
		4923	Sensible signal handling is officially unsupported by Microsoft - libev
		4924	tries its best, but under most conditions, signals will simply not work.
3653		4925
3654	Not a libev limitation but worth mentioning: windows apparently doesn't	4926	Not a libev limitation but worth mentioning: windows apparently doesn't
3655	accept large writes: instead of resulting in a partial write, windows will	4927	accept large writes: instead of resulting in a partial write, windows will
3656	either accept everything or return C<ENOBUFS> if the buffer is too large,	4928	either accept everything or return C<ENOBUFS> if the buffer is too large,
3657	so make sure you only write small amounts into your sockets (less than a	4929	so make sure you only write small amounts into your sockets (less than a
…		…
3662	the abysmal performance of winsockets, using a large number of sockets	4934	the abysmal performance of winsockets, using a large number of sockets
3663	is not recommended (and not reasonable). If your program needs to use	4935	is not recommended (and not reasonable). If your program needs to use
3664	more than a hundred or so sockets, then likely it needs to use a totally	4936	more than a hundred or so sockets, then likely it needs to use a totally
3665	different implementation for windows, as libev offers the POSIX readiness	4937	different implementation for windows, as libev offers the POSIX readiness
3666	notification model, which cannot be implemented efficiently on windows	4938	notification model, which cannot be implemented efficiently on windows
3667	(Microsoft monopoly games).	4939	(due to Microsoft monopoly games).
3668		4940
3669	A typical way to use libev under windows is to embed it (see the embedding	4941	A typical way to use libev under windows is to embed it (see the embedding
3670	section for details) and use the following F<evwrap.h> header file instead	4942	section for details) and use the following F<evwrap.h> header file instead
3671	of F<ev.h>:	4943	of F<ev.h>:
3672		4944
…		…
3679	you do I<not> compile the F<ev.c> or any other embedded source files!):	4951	you do I<not> compile the F<ev.c> or any other embedded source files!):
3680		4952
3681	#include "evwrap.h"	4953	#include "evwrap.h"
3682	#include "ev.c"	4954	#include "ev.c"
3683		4955
3684	=over 4
3685
3686	=item The winsocket select function	4956	=head3 The winsocket C<select> function
3687		4957
3688	The winsocket C<select> function doesn't follow POSIX in that it	4958	The winsocket C<select> function doesn't follow POSIX in that it
3689	requires socket I<handles> and not socket I<file descriptors> (it is	4959	requires socket I<handles> and not socket I<file descriptors> (it is
3690	also extremely buggy). This makes select very inefficient, and also	4960	also extremely buggy). This makes select very inefficient, and also
3691	requires a mapping from file descriptors to socket handles (the Microsoft	4961	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
3700	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	4970	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3701		4971
3702	Note that winsockets handling of fd sets is O(n), so you can easily get a	4972	Note that winsockets handling of fd sets is O(n), so you can easily get a
3703	complexity in the O(n²) range when using win32.	4973	complexity in the O(n²) range when using win32.
3704		4974
3705	=item Limited number of file descriptors	4975	=head3 Limited number of file descriptors
3706		4976
3707	Windows has numerous arbitrary (and low) limits on things.	4977	Windows has numerous arbitrary (and low) limits on things.
3708		4978
3709	Early versions of winsocket's select only supported waiting for a maximum	4979	Early versions of winsocket's select only supported waiting for a maximum
3710	of C<64> handles (probably owning to the fact that all windows kernels	4980	of C<64> handles (probably owning to the fact that all windows kernels
3711	can only wait for C<64> things at the same time internally; Microsoft	4981	can only wait for C<64> things at the same time internally; Microsoft
3712	recommends spawning a chain of threads and wait for 63 handles and the	4982	recommends spawning a chain of threads and wait for 63 handles and the
3713	previous thread in each. Great).	4983	previous thread in each. Sounds great!).
3714		4984
3715	Newer versions support more handles, but you need to define C<FD_SETSIZE>	4985	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3716	to some high number (e.g. C<2048>) before compiling the winsocket select	4986	to some high number (e.g. C<2048>) before compiling the winsocket select
3717	call (which might be in libev or elsewhere, for example, perl does its own	4987	call (which might be in libev or elsewhere, for example, perl and many
3718	select emulation on windows).	4988	other interpreters do their own select emulation on windows).
3719		4989
3720	Another limit is the number of file descriptors in the Microsoft runtime	4990	Another limit is the number of file descriptors in the Microsoft runtime
3721	libraries, which by default is C<64> (there must be a hidden I<64> fetish	4991	libraries, which by default is C<64> (there must be a hidden I<64>
3722	or something like this inside Microsoft). You can increase this by calling	4992	fetish or something like this inside Microsoft). You can increase this
3723	C<_setmaxstdio>, which can increase this limit to C<2048> (another	4993	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3724	arbitrary limit), but is broken in many versions of the Microsoft runtime	4994	(another arbitrary limit), but is broken in many versions of the Microsoft
3725	libraries.
3726
3727	This might get you to about C<512> or C<2048> sockets (depending on	4995	runtime libraries. This might get you to about C<512> or C<2048> sockets
3728	windows version and/or the phase of the moon). To get more, you need to	4996	(depending on windows version and/or the phase of the moon). To get more,
3729	wrap all I/O functions and provide your own fd management, but the cost of	4997	you need to wrap all I/O functions and provide your own fd management, but
3730	calling select (O(n²)) will likely make this unworkable.	4998	the cost of calling select (O(n²)) will likely make this unworkable.
3731
3732	=back
3733		4999
3734	=head2 PORTABILITY REQUIREMENTS	5000	=head2 PORTABILITY REQUIREMENTS
3735		5001
3736	In addition to a working ISO-C implementation and of course the	5002	In addition to a working ISO-C implementation and of course the
3737	backend-specific APIs, libev relies on a few additional extensions:	5003	backend-specific APIs, libev relies on a few additional extensions:
…		…
3744	Libev assumes not only that all watcher pointers have the same internal	5010	Libev assumes not only that all watcher pointers have the same internal
3745	structure (guaranteed by POSIX but not by ISO C for example), but it also	5011	structure (guaranteed by POSIX but not by ISO C for example), but it also
3746	assumes that the same (machine) code can be used to call any watcher	5012	assumes that the same (machine) code can be used to call any watcher
3747	callback: The watcher callbacks have different type signatures, but libev	5013	callback: The watcher callbacks have different type signatures, but libev
3748	calls them using an C<ev_watcher *> internally.	5014	calls them using an C<ev_watcher *> internally.
		5015
		5016	=item pointer accesses must be thread-atomic
		5017
		5018	Accessing a pointer value must be atomic, it must both be readable and
		5019	writable in one piece - this is the case on all current architectures.
3749		5020
3750	=item C<sig_atomic_t volatile> must be thread-atomic as well	5021	=item C<sig_atomic_t volatile> must be thread-atomic as well
3751		5022
3752	The type C<sig_atomic_t volatile> (or whatever is defined as	5023	The type C<sig_atomic_t volatile> (or whatever is defined as
3753	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5024	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
3776	watchers.	5047	watchers.
3777		5048
3778	=item C<double> must hold a time value in seconds with enough accuracy	5049	=item C<double> must hold a time value in seconds with enough accuracy
3779		5050
3780	The type C<double> is used to represent timestamps. It is required to	5051	The type C<double> is used to represent timestamps. It is required to
3781	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5052	have at least 51 bits of mantissa (and 9 bits of exponent), which is
3782	enough for at least into the year 4000. This requirement is fulfilled by	5053	good enough for at least into the year 4000 with millisecond accuracy
		5054	(the design goal for libev). This requirement is overfulfilled by
3783	implementations implementing IEEE 754 (basically all existing ones).	5055	implementations using IEEE 754, which is basically all existing ones.
		5056
		5057	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5058	year 2255 (and millisecond accuray till the year 287396 - by then, libev
		5059	is either obsolete or somebody patched it to use C<long double> or
		5060	something like that, just kidding).
3784		5061
3785	=back	5062	=back
3786		5063
3787	If you know of other additional requirements drop me a note.	5064	If you know of other additional requirements drop me a note.
3788		5065
…		…
3850	=item Processing ev_async_send: O(number_of_async_watchers)	5127	=item Processing ev_async_send: O(number_of_async_watchers)
3851		5128
3852	=item Processing signals: O(max_signal_number)	5129	=item Processing signals: O(max_signal_number)
3853		5130
3854	Sending involves a system call I<iff> there were no other C<ev_async_send>	5131	Sending involves a system call I<iff> there were no other C<ev_async_send>
3855	calls in the current loop iteration. Checking for async and signal events	5132	calls in the current loop iteration and the loop is currently
		5133	blocked. Checking for async and signal events involves iterating over all
3856	involves iterating over all running async watchers or all signal numbers.	5134	running async watchers or all signal numbers.
3857		5135
3858	=back	5136	=back
3859		5137
3860		5138
		5139	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5140
		5141	The major version 4 introduced some incompatible changes to the API.
		5142
		5143	At the moment, the C<ev.h> header file provides compatibility definitions
		5144	for all changes, so most programs should still compile. The compatibility
		5145	layer might be removed in later versions of libev, so better update to the
		5146	new API early than late.
		5147
		5148	=over 4
		5149
		5150	=item C<EV_COMPAT3> backwards compatibility mechanism
		5151
		5152	The backward compatibility mechanism can be controlled by
		5153	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5154	section.
		5155
		5156	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5157
		5158	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5159
		5160	ev_loop_destroy (EV_DEFAULT_UC);
		5161	ev_loop_fork (EV_DEFAULT);
		5162
		5163	=item function/symbol renames
		5164
		5165	A number of functions and symbols have been renamed:
		5166
		5167	ev_loop => ev_run
		5168	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5169	EVLOOP_ONESHOT => EVRUN_ONCE
		5170
		5171	ev_unloop => ev_break
		5172	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5173	EVUNLOOP_ONE => EVBREAK_ONE
		5174	EVUNLOOP_ALL => EVBREAK_ALL
		5175
		5176	EV_TIMEOUT => EV_TIMER
		5177
		5178	ev_loop_count => ev_iteration
		5179	ev_loop_depth => ev_depth
		5180	ev_loop_verify => ev_verify
		5181
		5182	Most functions working on C<struct ev_loop> objects don't have an
		5183	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5184	associated constants have been renamed to not collide with the C<struct
		5185	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5186	as all other watcher types. Note that C<ev_loop_fork> is still called
		5187	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5188	typedef.
		5189
		5190	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5191
		5192	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5193	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5194	and work, but the library code will of course be larger.
		5195
		5196	=back
		5197
		5198
		5199	=head1 GLOSSARY
		5200
		5201	=over 4
		5202
		5203	=item active
		5204
		5205	A watcher is active as long as it has been started and not yet stopped.
		5206	See L<WATCHER STATES> for details.
		5207
		5208	=item application
		5209
		5210	In this document, an application is whatever is using libev.
		5211
		5212	=item backend
		5213
		5214	The part of the code dealing with the operating system interfaces.
		5215
		5216	=item callback
		5217
		5218	The address of a function that is called when some event has been
		5219	detected. Callbacks are being passed the event loop, the watcher that
		5220	received the event, and the actual event bitset.
		5221
		5222	=item callback/watcher invocation
		5223
		5224	The act of calling the callback associated with a watcher.
		5225
		5226	=item event
		5227
		5228	A change of state of some external event, such as data now being available
		5229	for reading on a file descriptor, time having passed or simply not having
		5230	any other events happening anymore.
		5231
		5232	In libev, events are represented as single bits (such as C<EV_READ> or
		5233	C<EV_TIMER>).
		5234
		5235	=item event library
		5236
		5237	A software package implementing an event model and loop.
		5238
		5239	=item event loop
		5240
		5241	An entity that handles and processes external events and converts them
		5242	into callback invocations.
		5243
		5244	=item event model
		5245
		5246	The model used to describe how an event loop handles and processes
		5247	watchers and events.
		5248
		5249	=item pending
		5250
		5251	A watcher is pending as soon as the corresponding event has been
		5252	detected. See L<WATCHER STATES> for details.
		5253
		5254	=item real time
		5255
		5256	The physical time that is observed. It is apparently strictly monotonic :)
		5257
		5258	=item wall-clock time
		5259
		5260	The time and date as shown on clocks. Unlike real time, it can actually
		5261	be wrong and jump forwards and backwards, e.g. when you adjust your
		5262	clock.
		5263
		5264	=item watcher
		5265
		5266	A data structure that describes interest in certain events. Watchers need
		5267	to be started (attached to an event loop) before they can receive events.
		5268
		5269	=back
		5270
3861	=head1 AUTHOR	5271	=head1 AUTHOR
3862		5272
3863	Marc Lehmann <libev@schmorp.de>.	5273	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5274	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
3864		5275

Diff Legend

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