ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.230 by root, Wed Apr 15 18:47:07 2009 UTC vs.
Revision 1.388 by root, Tue Dec 20 04:08:35 2011 UTC

…		…
26	puts ("stdin ready");	26	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	28	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
30		30
31	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
33	}	33	}
34		34
35	// another callback, this time for a time-out	35	// another callback, this time for a time-out
36	static void	36	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	38	{
39	puts ("timeout");	39	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
42	}	42	}
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	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);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_loop (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// break was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
67	=head1 DESCRIPTION	67	=head1 ABOUT THIS DOCUMENT
		68
		69	This document documents the libev software package.
68		70
69	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
70	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
71	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
72		92
73	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
74	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
75	these event sources and provide your program with events.	95	these event sources and provide your program with events.
76		96
…		…
86	=head2 FEATURES	106	=head2 FEATURES
87		107
88	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
89	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms	109	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
90	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
91	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers	111	(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
92	with customised rescheduling (C<ev_periodic>), synchronous signals	112	inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
93	(C<ev_signal>), process status change events (C<ev_child>), and event	113	timers (C<ev_timer>), absolute timers with customised rescheduling
94	watchers dealing with the event loop mechanism itself (C<ev_idle>,	114	(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
95	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
96	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
97	(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>).
98		119
99	It also is quite fast (see this	120	It also is quite fast (see this
100	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
101	for example).	122	for example).
102		123
…		…
105	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)
106	configuration will be described, which supports multiple event loops. For	127	configuration will be described, which supports multiple event loops. For
107	more info about various configuration options please have a look at	128	more info about various configuration options please have a look at
108	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
109	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
110	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
111	this argument.	132	this argument.
112		133
113	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
114		135
115	Libev represents time as a single floating point number, representing the	136	Libev represents time as a single floating point number, representing
116	(fractional) number of seconds since the (POSIX) epoch (somewhere near	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
117	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
118	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
119	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
120	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
121	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
122	throughout libev.	144	time differences (e.g. delays) throughout libev.
123		145
124	=head1 ERROR HANDLING	146	=head1 ERROR HANDLING
125		147
126	Libev knows three classes of errors: operating system errors, usage errors	148	Libev knows three classes of errors: operating system errors, usage errors
127	and internal errors (bugs).	149	and internal errors (bugs).
…		…
151		173
152	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
153		175
154	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
155	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
156	you actually want to know.	178	you actually want to know. Also interesting is the combination of
		179	C<ev_now_update> and C<ev_now>.
157		180
158	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
159		182
160	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked
161	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
162	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 >>).
163		192
164	=item int ev_version_major ()	193	=item int ev_version_major ()
165		194
166	=item int ev_version_minor ()	195	=item int ev_version_minor ()
167		196
…		…
178	as this indicates an incompatible change. Minor versions are usually	207	as this indicates an incompatible change. Minor versions are usually
179	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
180	not a problem.	209	not a problem.
181		210
182	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
183	version.	212	version (note, however, that this will not detect other ABI mismatches,
		213	such as LFS or reentrancy).
184		214
185	assert (("libev version mismatch",	215	assert (("libev version mismatch",
186	ev_version_major () == EV_VERSION_MAJOR	216	ev_version_major () == EV_VERSION_MAJOR
187	&& ev_version_minor () >= EV_VERSION_MINOR));	217	&& ev_version_minor () >= EV_VERSION_MINOR));
188		218
…		…
199	assert (("sorry, no epoll, no sex",	229	assert (("sorry, no epoll, no sex",
200	ev_supported_backends () & EVBACKEND_EPOLL));	230	ev_supported_backends () & EVBACKEND_EPOLL));
201		231
202	=item unsigned int ev_recommended_backends ()	232	=item unsigned int ev_recommended_backends ()
203		233
204	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
205	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
206	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
207	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
208	(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
209	libev will probe for if you specify no backends explicitly.	240	probe for if you specify no backends explicitly.
210		241
211	=item unsigned int ev_embeddable_backends ()	242	=item unsigned int ev_embeddable_backends ()
212		243
213	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
214	is the theoretical, all-platform, value. To find which backends	245	value is platform-specific but can include backends not available on the
215	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
216	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	247	the current system, you would need to look at C<ev_embeddable_backends ()
217	recommended ones.	248	& ev_supported_backends ()>, likewise for recommended ones.
218		249
219	See the description of C<ev_embed> watchers for more info.	250	See the description of C<ev_embed> watchers for more info.
220		251
221	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
222		253
223	Sets the allocation function to use (the prototype is similar - the	254	Sets the allocation function to use (the prototype is similar - the
224	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
225	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
226	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
…		…
252	}	283	}
253		284
254	...	285	...
255	ev_set_allocator (persistent_realloc);	286	ev_set_allocator (persistent_realloc);
256		287
257	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	288	=item ev_set_syserr_cb (void (*cb)(const char *msg))
258		289
259	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
260	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
261	indicating the system call or subsystem causing the problem. If this	292	indicating the system call or subsystem causing the problem. If this
262	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
…		…
274	}	305	}
275		306
276	...	307	...
277	ev_set_syserr_cb (fatal_error);	308	ev_set_syserr_cb (fatal_error);
278		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
279	=back	323	=back
280		324
281	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	325	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
282		326
283	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
284	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
285	I<function>).	329	libev 3 had an C<ev_loop> function colliding with the struct name).
286		330
287	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
288	supports signals and child events, and dynamically created loops which do	332	supports child process events, and dynamically created event loops which
289	not.	333	do not.
290		334
291	=over 4	335	=over 4
292		336
293	=item struct ev_loop *ev_default_loop (unsigned int flags)	337	=item struct ev_loop *ev_default_loop (unsigned int flags)
294		338
295	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
296	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
297	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
298	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".
299		349
300	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
301	function.	351	function (or via the C<EV_DEFAULT> macro).
302		352
303	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
304	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
305	as loops cannot be shared easily between threads anyway).	355	that this case is unlikely, as loops cannot be shared easily between
		356	threads anyway).
306		357
307	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,
308	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
309	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
310	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
311	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	362	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
312	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.
313		382
314	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
315	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>).
316		385
317	The following flags are supported:	386	The following flags are supported:
…		…
332	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
333	around bugs.	402	around bugs.
334		403
335	=item C<EVFLAG_FORKCHECK>	404	=item C<EVFLAG_FORKCHECK>
336		405
337	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
338	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.
339	enabling this flag.
340		408
341	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,
342	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
343	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
344	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
…		…
350	flag.	418	flag.
351		419
352	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>
353	environment variable.	421	environment variable.
354		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
355	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
356		459
357	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
358	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,
359	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
…		…
383	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
384	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	487	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
385		488
386	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
387		490
		491	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		492	kernels).
		493
388	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
389	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
390	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
391	epoll scales either O(1) or O(active_fds).	497	fd), epoll scales either O(1) or O(active_fds).
392		498
393	The epoll mechanism deserves honorable mention as the most misdesigned	499	The epoll mechanism deserves honorable mention as the most misdesigned
394	of the more advanced event mechanisms: mere annoyances include silently	500	of the more advanced event mechanisms: mere annoyances include silently
395	dropping file descriptors, requiring a system call per change per file	501	dropping file descriptors, requiring a system call per change per file
396	descriptor (and unnecessary guessing of parameters), problems with dup and	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
397	so on. The biggest issue is fork races, however - if a program forks then	505	0.1ms) and so on. The biggest issue is fork races, however - if a program
398	I<both> parent and child process have to recreate the epoll set, which can	506	forks then I<both> parent and child process have to recreate the epoll
399	take considerable time (one syscall per file descriptor) and is of course	507	set, which can take considerable time (one syscall per file descriptor)
400	hard to detect.	508	and is of course hard to detect.
401		509
402	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
403	of course I<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
404	I<different> file descriptors (even already closed ones, so one cannot	512	totally I<different> file descriptors (even already closed ones, so
405	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
406	on SMP systems). Libev tries to counter these spurious notifications by	514	(especially on SMP systems). Libev tries to counter these spurious
407	employing an additional generation counter and comparing that against the	515	notifications by employing an additional generation counter and comparing
408	events to filter out spurious ones, recreating the set when required.	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...
409		526
410	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
411	will result in some caching, there is still a system call per such	528	will result in some caching, there is still a system call per such
412	incident (because the same I<file descriptor> could point to a different	529	incident (because the same I<file descriptor> could point to a different
413	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	530	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
479	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	596	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
480		597
481	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,
482	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)).
483		600
484	Please note that Solaris event ports can deliver a lot of spurious
485	notifications, so you need to use non-blocking I/O or other means to avoid
486	blocking when no data (or space) is available.
487
488	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
489	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
490	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	603	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
491	might perform better.	604	might perform better.
492		605
493	On the positive side, with the exception of the spurious readiness	606	On the positive side, this backend actually performed fully to
494	notifications, this backend actually performed fully to specification
495	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
496	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.
497		620
498	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
499	C<EVBACKEND_POLL>.	622	C<EVBACKEND_POLL>.
500		623
501	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
502		625
503	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
504	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
505	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	628	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
506		629
507	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).
508		639
509	=back	640	=back
510		641
511	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,
512	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
513	specified, all backends in C<ev_recommended_backends ()> will be tried.	644	here). If none are specified, all backends in C<ev_recommended_backends
514		645	()> will be tried.
515	Example: This is the most typical usage.
516
517	if (!ev_default_loop (0))
518	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
519
520	Example: Restrict libev to the select and poll backends, and do not allow
521	environment settings to be taken into account:
522
523	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
524
525	Example: Use whatever libev has to offer, but make sure that kqueue is
526	used if available (warning, breaks stuff, best use only with your own
527	private event loop and only if you know the OS supports your types of
528	fds):
529
530	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
531
532	=item struct ev_loop *ev_loop_new (unsigned int flags)
533
534	Similar to C<ev_default_loop>, but always creates a new event loop that is
535	always distinct from the default loop. Unlike the default loop, it cannot
536	handle signal and child watchers, and attempts to do so will be greeted by
537	undefined behaviour (or a failed assertion if assertions are enabled).
538
539	Note that this function I<is> thread-safe, and the recommended way to use
540	libev with threads is indeed to create one loop per thread, and using the
541	default loop in the "main" or "initial" thread.
542		646
543	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.
544		648
545	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	649	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
546	if (!epoller)	650	if (!epoller)
547	fatal ("no epoll found here, maybe it hides under your chair");	651	fatal ("no epoll found here, maybe it hides under your chair");
548		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
549	=item ev_default_destroy ()	658	=item ev_loop_destroy (loop)
550		659
551	Destroys the default loop again (frees all memory and kernel state	660	Destroys an event loop object (frees all memory and kernel state
552	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
553	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
554	responsibility to either stop all watchers cleanly yourself I<before>	663	responsibility to either stop all watchers cleanly yourself I<before>
555	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
556	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
…		…
558		667
559	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
560	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
561	as signal and child watchers) would need to be stopped manually.	670	as signal and child watchers) would need to be stopped manually.
562		671
563	In general it is not advisable to call this function except in the	672	This function is normally used on loop objects allocated by
564	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.
565	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>
566	C<ev_loop_new> and C<ev_loop_destroy>).	679	and C<ev_loop_destroy>.
567		680
568	=item ev_loop_destroy (loop)	681	=item ev_loop_fork (loop)
569		682
570	Like C<ev_default_destroy>, but destroys an event loop created by an
571	earlier call to C<ev_loop_new>.
572
573	=item ev_default_fork ()
574
575	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
576	to reinitialise the kernel state for backends that have one. Despite the	684	reinitialise the kernel state for backends that have one. Despite the
577	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
578	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
579	sense). You I<must> call it in the child before using any of the libev	687	child before resuming or calling C<ev_run>.
580	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.
581		693
582	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
583	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
584	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).
585		700
586	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
587	it just in case after a fork. To make this easy, the function will fit in	702	it just in case after a fork.
588	quite nicely into a call to C<pthread_atfork>:
589		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	...
590	pthread_atfork (0, 0, ev_default_fork);	714	pthread_atfork (0, 0, post_fork_child);
591
592	=item ev_loop_fork (loop)
593
594	Like C<ev_default_fork>, but acts on an event loop created by
595	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
596	after fork that you want to re-use in the child, and how you do this is
597	entirely your own problem.
598		715
599	=item int ev_is_default_loop (loop)	716	=item int ev_is_default_loop (loop)
600		717
601	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
602	otherwise.	719	otherwise.
603		720
604	=item unsigned int ev_loop_count (loop)	721	=item unsigned int ev_iteration (loop)
605		722
606	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
607	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>
608	happily wraps around with enough iterations.	725	and happily wraps around with enough iterations.
609		726
610	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
611	"ticks" the number of loop iterations), as it roughly corresponds with	728	"ticks" the number of loop iterations), as it roughly corresponds with
612	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.
613		745
614	=item unsigned int ev_backend (loop)	746	=item unsigned int ev_backend (loop)
615		747
616	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
617	use.	749	use.
…		…
626		758
627	=item ev_now_update (loop)	759	=item ev_now_update (loop)
628		760
629	Establishes the current time by querying the kernel, updating the time	761	Establishes the current time by querying the kernel, updating the time
630	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
631	is usually done automatically within C<ev_loop ()>.	763	is usually done automatically within C<ev_run ()>.
632		764
633	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
634	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
635	the current time is a good idea.	767	the current time is a good idea.
636		768
637	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.
638		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
639	=item ev_loop (loop, int flags)	797	=item ev_run (loop, int flags)
640		798
641	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
642	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
643	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>.
644		804
645	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
646	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.
647		808
648	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
649	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
650	finished (especially in interactive programs), but having a program	811	finished (especially in interactive programs), but having a program
651	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
652	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
653	beauty.	814	beauty.
654		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
655	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
656	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
657	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
658	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.
659		826
660	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
661	necessary) and will handle those and any already outstanding ones. It	828	necessary) and will handle those and any already outstanding ones. It
662	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
663	be an event internal to libev itself, so there is no guarantee that a	830	be an event internal to libev itself, so there is no guarantee that a
664	user-registered callback will be called), and will return after one	831	user-registered callback will be called), and will return after one
665	iteration of the loop.	832	iteration of the loop.
666		833
667	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
668	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
669	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
670	usually a better approach for this kind of thing.	837	usually a better approach for this kind of thing.
671		838
672	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):
673		842
		843	- Increment loop depth.
		844	- Reset the ev_break status.
674	- Before the first iteration, call any pending watchers.	845	- Before the first iteration, call any pending watchers.
		846	LOOP:
675	* If EVFLAG_FORKCHECK was used, check for a fork.	847	- If EVFLAG_FORKCHECK was used, check for a fork.
676	- 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.
677	- Queue and call all prepare watchers.	849	- Queue and call all prepare watchers.
		850	- If ev_break was called, goto FINISH.
678	- If we have been forked, detach and recreate the kernel state	851	- If we have been forked, detach and recreate the kernel state
679	as to not disturb the other process.	852	as to not disturb the other process.
680	- Update the kernel state with all outstanding changes.	853	- Update the kernel state with all outstanding changes.
681	- Update the "event loop time" (ev_now ()).	854	- Update the "event loop time" (ev_now ()).
682	- Calculate for how long to sleep or block, if at all	855	- Calculate for how long to sleep or block, if at all
683	(active idle watchers, EVLOOP_NONBLOCK or not having	856	(active idle watchers, EVRUN_NOWAIT or not having
684	any active watchers at all will result in not sleeping).	857	any active watchers at all will result in not sleeping).
685	- 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.
686	- Block the process, waiting for any events.	860	- Block the process, waiting for any events.
687	- Queue all outstanding I/O (fd) events.	861	- Queue all outstanding I/O (fd) events.
688	- 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.
689	- Queue all expired timers.	863	- Queue all expired timers.
690	- Queue all expired periodics.	864	- Queue all expired periodics.
691	- Unless any events are pending now, queue all idle watchers.	865	- Queue all idle watchers with priority higher than that of pending events.
692	- Queue all check watchers.	866	- Queue all check watchers.
693	- 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).
694	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
695	be handled here by queueing them when their watcher gets executed.	869	be handled here by queueing them when their watcher gets executed.
696	- 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
697	were used, or there are no active watchers, return, otherwise	871	were used, or there are no active watchers, goto FINISH, otherwise
698	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.
699		877
700	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
701	anymore.	879	anymore.
702		880
703	... queue jobs here, make sure they register event watchers as long	881	... queue jobs here, make sure they register event watchers as long
704	... 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..)
705	ev_loop (my_loop, 0);	883	ev_run (my_loop, 0);
706	... jobs done or somebody called unloop. yeah!	884	... jobs done or somebody called break. yeah!
707		885
708	=item ev_unloop (loop, how)	886	=item ev_break (loop, how)
709		887
710	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
711	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
712	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
713	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.
714		892
715	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>.
716		894
717	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.
718		897
719	=item ev_ref (loop)	898	=item ev_ref (loop)
720		899
721	=item ev_unref (loop)	900	=item ev_unref (loop)
722		901
723	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
724	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
725	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.
726		905
727	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
728	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>
729	stopping it.	909	before stopping it.
730		910
731	As an example, libev itself uses this for its internal signal pipe: It	911	As an example, libev itself uses this for its internal signal pipe: It
732	is not visible to the libev user and should not keep C<ev_loop> from	912	is not visible to the libev user and should not keep C<ev_run> from
733	exiting if no event watchers registered by it are active. It is also an	913	exiting if no event watchers registered by it are active. It is also an
734	excellent way to do this for generic recurring timers or from within	914	excellent way to do this for generic recurring timers or from within
735	third-party libraries. Just remember to I<unref after start> and I<ref	915	third-party libraries. Just remember to I<unref after start> and I<ref
736	before stop> (but only if the watcher wasn't active before, or was active	916	before stop> (but only if the watcher wasn't active before, or was active
737	before, respectively. Note also that libev might stop watchers itself	917	before, respectively. Note also that libev might stop watchers itself
738	(e.g. non-repeating timers) in which case you have to C<ev_ref>	918	(e.g. non-repeating timers) in which case you have to C<ev_ref>
739	in the callback).	919	in the callback).
740		920
741	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>
742	running when nothing else is active.	922	running when nothing else is active.
743		923
744	ev_signal exitsig;	924	ev_signal exitsig;
745	ev_signal_init (&exitsig, sig_cb, SIGINT);	925	ev_signal_init (&exitsig, sig_cb, SIGINT);
746	ev_signal_start (loop, &exitsig);	926	ev_signal_start (loop, &exitsig);
747	evf_unref (loop);	927	ev_unref (loop);
748		928
749	Example: For some weird reason, unregister the above signal handler again.	929	Example: For some weird reason, unregister the above signal handler again.
750		930
751	ev_ref (loop);	931	ev_ref (loop);
752	ev_signal_stop (loop, &exitsig);	932	ev_signal_stop (loop, &exitsig);
…		…
772	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.
773		953
774	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
775	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,
776	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
777	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
778	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).
779		962
780	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
781	to spend more time collecting timeouts, at the expense of increased	964	to spend more time collecting timeouts, at the expense of increased
782	latency/jitter/inexactness (the watcher callback will be called	965	latency/jitter/inexactness (the watcher callback will be called
783	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
…		…
785		968
786	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
787	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
788	interactive servers (of course not for games), likewise for timeouts. It	971	interactive servers (of course not for games), likewise for timeouts. It
789	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>,
790	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).
791		978
792	Setting the I<timeout collect interval> can improve the opportunity for	979	Setting the I<timeout collect interval> can improve the opportunity for
793	saving power, as the program will "bundle" timer callback invocations that	980	saving power, as the program will "bundle" timer callback invocations that
794	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
795	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
796	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
797	they fire on, say, one-second boundaries only.	984	they fire on, say, one-second boundaries only.
798		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<ev_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
799	=item ev_loop_verify (loop)	1061	=item ev_verify (loop)
800		1062
801	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
802	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
803	through all internal structures and checks them for validity. If anything	1065	through all internal structures and checks them for validity. If anything
804	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
…		…
815		1077
816	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
817	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
818	watchers and C<ev_io_start> for I/O watchers.	1080	watchers and C<ev_io_start> for I/O watchers.
819		1081
820	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
821	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
822	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:
823		1086
824	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)
825	{	1088	{
826	ev_io_stop (w);	1089	ev_io_stop (w);
827	ev_unloop (loop, EVUNLOOP_ALL);	1090	ev_break (loop, EVBREAK_ALL);
828	}	1091	}
829		1092
830	struct ev_loop *loop = ev_default_loop (0);	1093	struct ev_loop *loop = ev_default_loop (0);
831		1094
832	ev_io stdin_watcher;	1095	ev_io stdin_watcher;
833		1096
834	ev_init (&stdin_watcher, my_cb);	1097	ev_init (&stdin_watcher, my_cb);
835	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1098	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
836	ev_io_start (loop, &stdin_watcher);	1099	ev_io_start (loop, &stdin_watcher);
837		1100
838	ev_loop (loop, 0);	1101	ev_run (loop, 0);
839		1102
840	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
841	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
842	stack).	1105	stack).
843		1106
844	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>
845	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).
846		1109
847	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
848	(watcher *, callback)>, which expects a callback to be provided. This	1111	*, callback)>, which expects a callback to be provided. This callback is
849	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
850	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
851	is readable and/or writable).	1114	and/or writable).
852		1115
853	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 *, ...) >>
854	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
855	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<<
856	ev_TYPE_init (watcher *, callback, ...) >>.	1119	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
879	=item C<EV_WRITE>	1142	=item C<EV_WRITE>
880		1143
881	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
882	writable.	1145	writable.
883		1146
884	=item C<EV_TIMEOUT>	1147	=item C<EV_TIMER>
885		1148
886	The C<ev_timer> watcher has timed out.	1149	The C<ev_timer> watcher has timed out.
887		1150
888	=item C<EV_PERIODIC>	1151	=item C<EV_PERIODIC>
889		1152
…		…
907		1170
908	=item C<EV_PREPARE>	1171	=item C<EV_PREPARE>
909		1172
910	=item C<EV_CHECK>	1173	=item C<EV_CHECK>
911		1174
912	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
913	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
914	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
915	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
916	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
917	(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
918	C<ev_loop> from blocking).	1181	C<ev_run> from blocking).
919		1182
920	=item C<EV_EMBED>	1183	=item C<EV_EMBED>
921		1184
922	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.
923		1186
924	=item C<EV_FORK>	1187	=item C<EV_FORK>
925		1188
926	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
927	C<ev_fork>).	1190	C<ev_fork>).
		1191
		1192	=item C<EV_CLEANUP>
		1193
		1194	The event loop is about to be destroyed (see C<ev_cleanup>).
928		1195
929	=item C<EV_ASYNC>	1196	=item C<EV_ASYNC>
930		1197
931	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>).
932		1199
…		…
979		1246
980	ev_io w;	1247	ev_io w;
981	ev_init (&w, my_cb);	1248	ev_init (&w, my_cb);
982	ev_io_set (&w, STDIN_FILENO, EV_READ);	1249	ev_io_set (&w, STDIN_FILENO, EV_READ);
983		1250
984	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1251	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
985		1252
986	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
987	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
988	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
989	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
…		…
1002		1269
1003	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.
1004		1271
1005	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1272	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1006		1273
1007	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1274	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1008		1275
1009	Starts (activates) the given watcher. Only active watchers will receive	1276	Starts (activates) the given watcher. Only active watchers will receive
1010	events. If the watcher is already active nothing will happen.	1277	events. If the watcher is already active nothing will happen.
1011		1278
1012	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
1013	whole section.	1280	whole section.
1014		1281
1015	ev_io_start (EV_DEFAULT_UC, &w);	1282	ev_io_start (EV_DEFAULT_UC, &w);
1016		1283
1017	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1284	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1018		1285
1019	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
1020	the watcher was active or not).	1287	the watcher was active or not).
1021		1288
1022	It is possible that stopped watchers are pending - for example,	1289	It is possible that stopped watchers are pending - for example,
…		…
1047	=item ev_cb_set (ev_TYPE *watcher, callback)	1314	=item ev_cb_set (ev_TYPE *watcher, callback)
1048		1315
1049	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
1050	(modulo threads).	1317	(modulo threads).
1051		1318
1052	=item ev_set_priority (ev_TYPE *watcher, priority)	1319	=item ev_set_priority (ev_TYPE *watcher, int priority)
1053		1320
1054	=item int ev_priority (ev_TYPE *watcher)	1321	=item int ev_priority (ev_TYPE *watcher)
1055		1322
1056	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
1057	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>
1058	(default: C<-2>). Pending watchers with higher priority will be invoked	1325	(default: C<-2>). Pending watchers with higher priority will be invoked
1059	before watchers with lower priority, but priority will not keep watchers	1326	before watchers with lower priority, but priority will not keep watchers
1060	from being executed (except for C<ev_idle> watchers).	1327	from being executed (except for C<ev_idle> watchers).
1061		1328
1062	This means that priorities are I<only> used for ordering callback
1063	invocation after new events have been received. This is useful, for
1064	example, to reduce latency after idling, or more often, to bind two
1065	watchers on the same event and make sure one is called first.
1066
1067	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
1068	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.
1069		1331
1070	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
1071	pending.	1333	pending.
1072
1073	The default priority used by watchers when no priority has been set is
1074	always C<0>, which is supposed to not be too high and not be too low :).
1075		1334
1076	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
1077	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
1078	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.
1079		1344
1080	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1345	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1081		1346
1082	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
1083	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
…		…
1091	watcher isn't pending it does nothing and returns C<0>.	1356	watcher isn't pending it does nothing and returns C<0>.
1092		1357
1093	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
1094	callback to be invoked, which can be accomplished with this function.	1359	callback to be invoked, which can be accomplished with this function.
1095		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
1096	=back	1375	=back
1097		1376
		1377	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1378	OWN COMPOSITE WATCHERS> idioms.
1098		1379
1099	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1380	=head2 WATCHER STATES
1100		1381
1101	Each watcher has, by default, a member C<void *data> that you can change	1382	There are various watcher states mentioned throughout this manual -
1102	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
1103	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
1104	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".
1105	member, you can also "subclass" the watcher type and provide your own
1106	data:
1107		1386
1108	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)
1109	{	1512	{
1110	ev_io io;	1513	// stop the I/O watcher, we received the event, but
1111	int otherfd;	1514	// are not yet ready to handle it.
1112	void *somedata;	1515	ev_io_stop (EV_A_ w);
1113	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);
1114	};	1521	}
1115		1522
1116	...	1523	static void
1117	struct my_io w;	1524	idle_cb (EV_P_ ev_idle *w, int revents)
1118	ev_io_init (&w.io, my_cb, fd, EV_READ);
1119
1120	And since your callback will be called with a pointer to the watcher, you
1121	can cast it back to your own type:
1122
1123	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1124	{	1525	{
1125	struct my_io *w = (struct my_io *)w_;	1526	// actual processing
1126	...	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);
1127	}	1532	}
1128		1533
1129	More interesting and less C-conformant ways of casting your callback type	1534	// initialisation
1130	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);
1131		1538
1132	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
1133	embedded watchers:	1540	low-priority connections can not be locked out forever under load. This
1134		1541	enables your program to keep a lower latency for important connections
1135	struct my_biggy	1542	during short periods of high load, while not completely locking out less
1136	{	1543	important ones.
1137	int some_data;
1138	ev_timer t1;
1139	ev_timer t2;
1140	}
1141
1142	In this case getting the pointer to C<my_biggy> is a bit more
1143	complicated: Either you store the address of your C<my_biggy> struct
1144	in the C<data> member of the watcher (for woozies), or you need to use
1145	some pointer arithmetic using C<offsetof> inside your watchers (for real
1146	programmers):
1147
1148	#include <stddef.h>
1149
1150	static void
1151	t1_cb (EV_P_ ev_timer *w, int revents)
1152	{
1153	struct my_biggy big = (struct my_biggy *
1154	(((char *)w) - offsetof (struct my_biggy, t1));
1155	}
1156
1157	static void
1158	t2_cb (EV_P_ ev_timer *w, int revents)
1159	{
1160	struct my_biggy big = (struct my_biggy *
1161	(((char *)w) - offsetof (struct my_biggy, t2));
1162	}
1163		1544
1164		1545
1165	=head1 WATCHER TYPES	1546	=head1 WATCHER TYPES
1166		1547
1167	This section describes each watcher in detail, but will not repeat	1548	This section describes each watcher in detail, but will not repeat
…		…
1191	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
1192	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
1193	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
1194	required if you know what you are doing).	1575	required if you know what you are doing).
1195		1576
1196	If you cannot use non-blocking mode, then force the use of a
1197	known-to-be-good backend (at the time of this writing, this includes only
1198	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1199
1200	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
1201	receive "spurious" readiness notifications, that is your callback might	1578	receive "spurious" readiness notifications, that is, your callback might
1202	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
1203	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
1204	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
1205	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
1206	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1207	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1583	preferable to a program hanging until some data arrives.
1208		1584
1209	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
1210	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
1211	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
1212	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
1213	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
1214	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
1215	indefinitely.	1591	indefinitely.
1216		1592
1217	But really, best use non-blocking mode.	1593	But really, best use non-blocking mode.
1218		1594
…		…
1246		1622
1247	There is no workaround possible except not registering events	1623	There is no workaround possible except not registering events
1248	for potentially C<dup ()>'ed file descriptors, or to resort to	1624	for potentially C<dup ()>'ed file descriptors, or to resort to
1249	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1625	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1250		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
1251	=head3 The special problem of fork	1660	=head3 The special problem of fork
1252		1661
1253	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
1254	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
1255	it in the child.	1664	it in the child if you want to continue to use it in the child.
1256		1665
1257	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
1258	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
1259	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1668	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1260	C<EVBACKEND_POLL>.
1261		1669
1262	=head3 The special problem of SIGPIPE	1670	=head3 The special problem of SIGPIPE
1263		1671
1264	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>:
1265	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
…		…
1268		1676
1269	So when you encounter spurious, unexplained daemon exits, make sure you	1677	So when you encounter spurious, unexplained daemon exits, make sure you
1270	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
1271	somewhere, as that would have given you a big clue).	1679	somewhere, as that would have given you a big clue).
1272		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.
1273		1719
1274	=head3 Watcher-Specific Functions	1720	=head3 Watcher-Specific Functions
1275		1721
1276	=over 4	1722	=over 4
1277		1723
…		…
1309	...	1755	...
1310	struct ev_loop *loop = ev_default_init (0);	1756	struct ev_loop *loop = ev_default_init (0);
1311	ev_io stdin_readable;	1757	ev_io stdin_readable;
1312	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);
1313	ev_io_start (loop, &stdin_readable);	1759	ev_io_start (loop, &stdin_readable);
1314	ev_loop (loop, 0);	1760	ev_run (loop, 0);
1315		1761
1316		1762
1317	=head2 C<ev_timer> - relative and optionally repeating timeouts	1763	=head2 C<ev_timer> - relative and optionally repeating timeouts
1318		1764
1319	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
…		…
1324	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
1325	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1771	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1326	monotonic clock option helps a lot here).	1772	monotonic clock option helps a lot here).
1327		1773
1328	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
		1775	passed (not I<at>, so on systems with very low-resolution clocks this
		1776	might introduce a small delay, see "the special problem of being too
1329	passed. If multiple timers become ready during the same loop iteration	1777	early", below). If multiple timers become ready during the same loop
1330	then the ones with earlier time-out values are invoked before ones with	1778	iteration then the ones with earlier time-out values are invoked before
1331	later time-out values (but this is no longer true when a callback calls	1779	ones of the same priority with later time-out values (but this is no
1332	C<ev_loop> recursively).	1780	longer true when a callback calls C<ev_run> recursively).
1333		1781
1334	=head3 Be smart about timeouts	1782	=head3 Be smart about timeouts
1335		1783
1336	Many real-world problems involve some kind of timeout, usually for error	1784	Many real-world problems involve some kind of timeout, usually for error
1337	recovery. A typical example is an HTTP request - if the other side hangs,	1785	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1381	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>	1829	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1382	member and C<ev_timer_again>.	1830	member and C<ev_timer_again>.
1383		1831
1384	At start:	1832	At start:
1385		1833
1386	ev_timer_init (timer, callback);	1834	ev_init (timer, callback);
1387	timer->repeat = 60.;	1835	timer->repeat = 60.;
1388	ev_timer_again (loop, timer);	1836	ev_timer_again (loop, timer);
1389		1837
1390	Each time there is some activity:	1838	Each time there is some activity:
1391		1839
…		…
1412		1860
1413	In this case, it would be more efficient to leave the C<ev_timer> alone,	1861	In this case, it would be more efficient to leave the C<ev_timer> alone,
1414	but remember the time of last activity, and check for a real timeout only	1862	but remember the time of last activity, and check for a real timeout only
1415	within the callback:	1863	within the callback:
1416		1864
		1865	ev_tstamp timeout = 60.;
1417	ev_tstamp last_activity; // time of last activity	1866	ev_tstamp last_activity; // time of last activity
		1867	ev_timer timer;
1418		1868
1419	static void	1869	static void
1420	callback (EV_P_ ev_timer *w, int revents)	1870	callback (EV_P_ ev_timer *w, int revents)
1421	{	1871	{
1422	ev_tstamp now = ev_now (EV_A);	1872	// calculate when the timeout would happen
1423	ev_tstamp timeout = last_activity + 60.;	1873	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1424		1874
1425	// if last_activity + 60. is older than now, we did time out	1875	// if negative, it means we the timeout already occured
1426	if (timeout < now)	1876	if (after < 0.)
1427	{	1877	{
1428	// timeout occured, take action	1878	// timeout occurred, take action
1429	}	1879	}
1430	else	1880	else
1431	{	1881	{
1432	// callback was invoked, but there was some activity, re-arm	1882	// callback was invoked, but there was some recent
1433	// the watcher to fire in last_activity + 60, which is	1883	// activity. simply restart the timer to time out
1434	// guaranteed to be in the future, so "again" is positive:	1884	// after "after" seconds, which is the earliest time
1435	w->repeat = timeout - now;	1885	// the timeout can occur.
		1886	ev_timer_set (w, after, 0.);
1436	ev_timer_again (EV_A_ w);	1887	ev_timer_start (EV_A_ w);
1437	}	1888	}
1438	}	1889	}
1439		1890
1440	To summarise the callback: first calculate the real timeout (defined	1891	To summarise the callback: first calculate in how many seconds the
1441	as "60 seconds after the last activity"), then check if that time has	1892	timeout will occur (by calculating the absolute time when it would occur,
1442	been reached, which means something I<did>, in fact, time out. Otherwise	1893	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1443	the callback was invoked too early (C<timeout> is in the future), so	1894	(EV_A)> from that).
1444	re-schedule the timer to fire at that future time, to see if maybe we have
1445	a timeout then.
1446		1895
1447	Note how C<ev_timer_again> is used, taking advantage of the	1896	If this value is negative, then we are already past the timeout, i.e. we
1448	C<ev_timer_again> optimisation when the timer is already running.	1897	timed out, and need to do whatever is needed in this case.
		1898
		1899	Otherwise, we now the earliest time at which the timeout would trigger,
		1900	and simply start the timer with this timeout value.
		1901
		1902	In other words, each time the callback is invoked it will check whether
		1903	the timeout cocured. If not, it will simply reschedule itself to check
		1904	again at the earliest time it could time out. Rinse. Repeat.
1449		1905
1450	This scheme causes more callback invocations (about one every 60 seconds	1906	This scheme causes more callback invocations (about one every 60 seconds
1451	minus half the average time between activity), but virtually no calls to	1907	minus half the average time between activity), but virtually no calls to
1452	libev to change the timeout.	1908	libev to change the timeout.
1453		1909
1454	To start the timer, simply initialise the watcher and set C<last_activity>	1910	To start the machinery, simply initialise the watcher and set
1455	to the current time (meaning we just have some activity :), then call the	1911	C<last_activity> to the current time (meaning there was some activity just
1456	callback, which will "do the right thing" and start the timer:	1912	now), then call the callback, which will "do the right thing" and start
		1913	the timer:
1457		1914
		1915	last_activity = ev_now (EV_A);
1458	ev_timer_init (timer, callback);	1916	ev_init (&timer, callback);
1459	last_activity = ev_now (loop);	1917	callback (EV_A_ &timer, 0);
1460	callback (loop, timer, EV_TIMEOUT);
1461		1918
1462	And when there is some activity, simply store the current time in	1919	When there is some activity, simply store the current time in
1463	C<last_activity>, no libev calls at all:	1920	C<last_activity>, no libev calls at all:
1464		1921
		1922	if (activity detected)
1465	last_actiivty = ev_now (loop);	1923	last_activity = ev_now (EV_A);
		1924
		1925	When your timeout value changes, then the timeout can be changed by simply
		1926	providing a new value, stopping the timer and calling the callback, which
		1927	will agaion do the right thing (for example, time out immediately :).
		1928
		1929	timeout = new_value;
		1930	ev_timer_stop (EV_A_ &timer);
		1931	callback (EV_A_ &timer, 0);
1466		1932
1467	This technique is slightly more complex, but in most cases where the	1933	This technique is slightly more complex, but in most cases where the
1468	time-out is unlikely to be triggered, much more efficient.	1934	time-out is unlikely to be triggered, much more efficient.
1469
1470	Changing the timeout is trivial as well (if it isn't hard-coded in the
1471	callback :) - just change the timeout and invoke the callback, which will
1472	fix things for you.
1473		1935
1474	=item 4. Wee, just use a double-linked list for your timeouts.	1936	=item 4. Wee, just use a double-linked list for your timeouts.
1475		1937
1476	If there is not one request, but many thousands (millions...), all	1938	If there is not one request, but many thousands (millions...), all
1477	employing some kind of timeout with the same timeout value, then one can	1939	employing some kind of timeout with the same timeout value, then one can
…		…
1504	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1966	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1505	rather complicated, but extremely efficient, something that really pays	1967	rather complicated, but extremely efficient, something that really pays
1506	off after the first million or so of active timers, i.e. it's usually	1968	off after the first million or so of active timers, i.e. it's usually
1507	overkill :)	1969	overkill :)
1508		1970
		1971	=head3 The special problem of being too early
		1972
		1973	If you ask a timer to call your callback after three seconds, then
		1974	you expect it to be invoked after three seconds - but of course, this
		1975	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1976	guaranteed to any precision by libev - imagine somebody suspending the
		1977	process with a STOP signal for a few hours for example.
		1978
		1979	So, libev tries to invoke your callback as soon as possible I<after> the
		1980	delay has occurred, but cannot guarantee this.
		1981
		1982	A less obvious failure mode is calling your callback too early: many event
		1983	loops compare timestamps with a "elapsed delay >= requested delay", but
		1984	this can cause your callback to be invoked much earlier than you would
		1985	expect.
		1986
		1987	To see why, imagine a system with a clock that only offers full second
		1988	resolution (think windows if you can't come up with a broken enough OS
		1989	yourself). If you schedule a one-second timer at the time 500.9, then the
		1990	event loop will schedule your timeout to elapse at a system time of 500
		1991	(500.9 truncated to the resolution) + 1, or 501.
		1992
		1993	If an event library looks at the timeout 0.1s later, it will see "501 >=
		1994	501" and invoke the callback 0.1s after it was started, even though a
		1995	one-second delay was requested - this is being "too early", despite best
		1996	intentions.
		1997
		1998	This is the reason why libev will never invoke the callback if the elapsed
		1999	delay equals the requested delay, but only when the elapsed delay is
		2000	larger than the requested delay. In the example above, libev would only invoke
		2001	the callback at system time 502, or 1.1s after the timer was started.
		2002
		2003	So, while libev cannot guarantee that your callback will be invoked
		2004	exactly when requested, it I<can> and I<does> guarantee that the requested
		2005	delay has actually elapsed, or in other words, it always errs on the "too
		2006	late" side of things.
		2007
1509	=head3 The special problem of time updates	2008	=head3 The special problem of time updates
1510		2009
1511	Establishing the current time is a costly operation (it usually takes at	2010	Establishing the current time is a costly operation (it usually takes
1512	least two system calls): EV therefore updates its idea of the current	2011	at least one system call): EV therefore updates its idea of the current
1513	time only before and after C<ev_loop> collects new events, which causes a	2012	time only before and after C<ev_run> collects new events, which causes a
1514	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2013	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1515	lots of events in one iteration.	2014	lots of events in one iteration.
1516		2015
1517	The relative timeouts are calculated relative to the C<ev_now ()>	2016	The relative timeouts are calculated relative to the C<ev_now ()>
1518	time. This is usually the right thing as this timestamp refers to the time	2017	time. This is usually the right thing as this timestamp refers to the time
…		…
1524		2023
1525	If the event loop is suspended for a long time, you can also force an	2024	If the event loop is suspended for a long time, you can also force an
1526	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2025	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1527	()>.	2026	()>.
1528		2027
		2028	=head3 The special problem of unsynchronised clocks
		2029
		2030	Modern systems have a variety of clocks - libev itself uses the normal
		2031	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2032	jumps).
		2033
		2034	Neither of these clocks is synchronised with each other or any other clock
		2035	on the system, so C<ev_time ()> might return a considerably different time
		2036	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2037	a call to C<gettimeofday> might return a second count that is one higher
		2038	than a directly following call to C<time>.
		2039
		2040	The moral of this is to only compare libev-related timestamps with
		2041	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2042	a second or so.
		2043
		2044	One more problem arises due to this lack of synchronisation: if libev uses
		2045	the system monotonic clock and you compare timestamps from C<ev_time>
		2046	or C<ev_now> from when you started your timer and when your callback is
		2047	invoked, you will find that sometimes the callback is a bit "early".
		2048
		2049	This is because C<ev_timer>s work in real time, not wall clock time, so
		2050	libev makes sure your callback is not invoked before the delay happened,
		2051	I<measured according to the real time>, not the system clock.
		2052
		2053	If your timeouts are based on a physical timescale (e.g. "time out this
		2054	connection after 100 seconds") then this shouldn't bother you as it is
		2055	exactly the right behaviour.
		2056
		2057	If you want to compare wall clock/system timestamps to your timers, then
		2058	you need to use C<ev_periodic>s, as these are based on the wall clock
		2059	time, where your comparisons will always generate correct results.
		2060
		2061	=head3 The special problems of suspended animation
		2062
		2063	When you leave the server world it is quite customary to hit machines that
		2064	can suspend/hibernate - what happens to the clocks during such a suspend?
		2065
		2066	Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
		2067	all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
		2068	to run until the system is suspended, but they will not advance while the
		2069	system is suspended. That means, on resume, it will be as if the program
		2070	was frozen for a few seconds, but the suspend time will not be counted
		2071	towards C<ev_timer> when a monotonic clock source is used. The real time
		2072	clock advanced as expected, but if it is used as sole clocksource, then a
		2073	long suspend would be detected as a time jump by libev, and timers would
		2074	be adjusted accordingly.
		2075
		2076	I would not be surprised to see different behaviour in different between
		2077	operating systems, OS versions or even different hardware.
		2078
		2079	The other form of suspend (job control, or sending a SIGSTOP) will see a
		2080	time jump in the monotonic clocks and the realtime clock. If the program
		2081	is suspended for a very long time, and monotonic clock sources are in use,
		2082	then you can expect C<ev_timer>s to expire as the full suspension time
		2083	will be counted towards the timers. When no monotonic clock source is in
		2084	use, then libev will again assume a timejump and adjust accordingly.
		2085
		2086	It might be beneficial for this latter case to call C<ev_suspend>
		2087	and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
		2088	deterministic behaviour in this case (you can do nothing against
		2089	C<SIGSTOP>).
		2090
1529	=head3 Watcher-Specific Functions and Data Members	2091	=head3 Watcher-Specific Functions and Data Members
1530		2092
1531	=over 4	2093	=over 4
1532		2094
1533	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	2095	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
…		…
1546	keep up with the timer (because it takes longer than those 10 seconds to	2108	keep up with the timer (because it takes longer than those 10 seconds to
1547	do stuff) the timer will not fire more than once per event loop iteration.	2109	do stuff) the timer will not fire more than once per event loop iteration.
1548		2110
1549	=item ev_timer_again (loop, ev_timer *)	2111	=item ev_timer_again (loop, ev_timer *)
1550		2112
1551	This will act as if the timer timed out and restart it again if it is	2113	This will act as if the timer timed out and restarts it again if it is
1552	repeating. The exact semantics are:	2114	repeating. The exact semantics are:
1553		2115
1554	If the timer is pending, its pending status is cleared.	2116	If the timer is pending, its pending status is cleared.
1555		2117
1556	If the timer is started but non-repeating, stop it (as if it timed out).	2118	If the timer is started but non-repeating, stop it (as if it timed out).
1557		2119
1558	If the timer is repeating, either start it if necessary (with the	2120	If the timer is repeating, either start it if necessary (with the
1559	C<repeat> value), or reset the running timer to the C<repeat> value.	2121	C<repeat> value), or reset the running timer to the C<repeat> value.
1560		2122
1561	This sounds a bit complicated, see "Be smart about timeouts", above, for a	2123	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1562	usage example.	2124	usage example.
		2125
		2126	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
		2127
		2128	Returns the remaining time until a timer fires. If the timer is active,
		2129	then this time is relative to the current event loop time, otherwise it's
		2130	the timeout value currently configured.
		2131
		2132	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
		2133	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
		2134	will return C<4>. When the timer expires and is restarted, it will return
		2135	roughly C<7> (likely slightly less as callback invocation takes some time,
		2136	too), and so on.
1563		2137
1564	=item ev_tstamp repeat [read-write]	2138	=item ev_tstamp repeat [read-write]
1565		2139
1566	The current C<repeat> value. Will be used each time the watcher times out	2140	The current C<repeat> value. Will be used each time the watcher times out
1567	or C<ev_timer_again> is called, and determines the next timeout (if any),	2141	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1593	}	2167	}
1594		2168
1595	ev_timer mytimer;	2169	ev_timer mytimer;
1596	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2170	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1597	ev_timer_again (&mytimer); /* start timer */	2171	ev_timer_again (&mytimer); /* start timer */
1598	ev_loop (loop, 0);	2172	ev_run (loop, 0);
1599		2173
1600	// and in some piece of code that gets executed on any "activity":	2174	// and in some piece of code that gets executed on any "activity":
1601	// reset the timeout to start ticking again at 10 seconds	2175	// reset the timeout to start ticking again at 10 seconds
1602	ev_timer_again (&mytimer);	2176	ev_timer_again (&mytimer);
1603		2177
…		…
1629		2203
1630	As with timers, the callback is guaranteed to be invoked only when the	2204	As with timers, the callback is guaranteed to be invoked only when the
1631	point in time where it is supposed to trigger has passed. If multiple	2205	point in time where it is supposed to trigger has passed. If multiple
1632	timers become ready during the same loop iteration then the ones with	2206	timers become ready during the same loop iteration then the ones with
1633	earlier time-out values are invoked before ones with later time-out values	2207	earlier time-out values are invoked before ones with later time-out values
1634	(but this is no longer true when a callback calls C<ev_loop> recursively).	2208	(but this is no longer true when a callback calls C<ev_run> recursively).
1635		2209
1636	=head3 Watcher-Specific Functions and Data Members	2210	=head3 Watcher-Specific Functions and Data Members
1637		2211
1638	=over 4	2212	=over 4
1639		2213
…		…
1674		2248
1675	Another way to think about it (for the mathematically inclined) is that	2249	Another way to think about it (for the mathematically inclined) is that
1676	C<ev_periodic> will try to run the callback in this mode at the next possible	2250	C<ev_periodic> will try to run the callback in this mode at the next possible
1677	time where C<time = offset (mod interval)>, regardless of any time jumps.	2251	time where C<time = offset (mod interval)>, regardless of any time jumps.
1678		2252
1679	For numerical stability it is preferable that the C<offset> value is near	2253	The C<interval> I<MUST> be positive, and for numerical stability, the
1680	C<ev_now ()> (the current time), but there is no range requirement for	2254	interval value should be higher than C<1/8192> (which is around 100
1681	this value, and in fact is often specified as zero.	2255	microseconds) and C<offset> should be higher than C<0> and should have
		2256	at most a similar magnitude as the current time (say, within a factor of
		2257	ten). Typical values for offset are, in fact, C<0> or something between
		2258	C<0> and C<interval>, which is also the recommended range.
1682		2259
1683	Note also that there is an upper limit to how often a timer can fire (CPU	2260	Note also that there is an upper limit to how often a timer can fire (CPU
1684	speed for example), so if C<interval> is very small then timing stability	2261	speed for example), so if C<interval> is very small then timing stability
1685	will of course deteriorate. Libev itself tries to be exact to be about one	2262	will of course deteriorate. Libev itself tries to be exact to be about one
1686	millisecond (if the OS supports it and the machine is fast enough).	2263	millisecond (if the OS supports it and the machine is fast enough).
…		…
1767	Example: Call a callback every hour, or, more precisely, whenever the	2344	Example: Call a callback every hour, or, more precisely, whenever the
1768	system time is divisible by 3600. The callback invocation times have	2345	system time is divisible by 3600. The callback invocation times have
1769	potentially a lot of jitter, but good long-term stability.	2346	potentially a lot of jitter, but good long-term stability.
1770		2347
1771	static void	2348	static void
1772	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2349	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1773	{	2350	{
1774	... its now a full hour (UTC, or TAI or whatever your clock follows)	2351	... its now a full hour (UTC, or TAI or whatever your clock follows)
1775	}	2352	}
1776		2353
1777	ev_periodic hourly_tick;	2354	ev_periodic hourly_tick;
…		…
1800		2377
1801	=head2 C<ev_signal> - signal me when a signal gets signalled!	2378	=head2 C<ev_signal> - signal me when a signal gets signalled!
1802		2379
1803	Signal watchers will trigger an event when the process receives a specific	2380	Signal watchers will trigger an event when the process receives a specific
1804	signal one or more times. Even though signals are very asynchronous, libev	2381	signal one or more times. Even though signals are very asynchronous, libev
1805	will try it's best to deliver signals synchronously, i.e. as part of the	2382	will try its best to deliver signals synchronously, i.e. as part of the
1806	normal event processing, like any other event.	2383	normal event processing, like any other event.
1807		2384
1808	If you want signals asynchronously, just use C<sigaction> as you would	2385	If you want signals to be delivered truly asynchronously, just use
1809	do without libev and forget about sharing the signal. You can even use	2386	C<sigaction> as you would do without libev and forget about sharing
1810	C<ev_async> from a signal handler to synchronously wake up an event loop.	2387	the signal. You can even use C<ev_async> from a signal handler to
		2388	synchronously wake up an event loop.
1811		2389
1812	You can configure as many watchers as you like per signal. Only when the	2390	You can configure as many watchers as you like for the same signal, but
		2391	only within the same loop, i.e. you can watch for C<SIGINT> in your
		2392	default loop and for C<SIGIO> in another loop, but you cannot watch for
		2393	C<SIGINT> in both the default loop and another loop at the same time. At
		2394	the moment, C<SIGCHLD> is permanently tied to the default loop.
		2395
1813	first watcher gets started will libev actually register a signal handler	2396	When the first watcher gets started will libev actually register something
1814	with the kernel (thus it coexists with your own signal handlers as long as	2397	with the kernel (thus it coexists with your own signal handlers as long as
1815	you don't register any with libev for the same signal). Similarly, when	2398	you don't register any with libev for the same signal).
1816	the last signal watcher for a signal is stopped, libev will reset the
1817	signal handler to SIG_DFL (regardless of what it was set to before).
1818		2399
1819	If possible and supported, libev will install its handlers with	2400	If possible and supported, libev will install its handlers with
1820	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	2401	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1821	interrupted. If you have a problem with system calls getting interrupted by	2402	not be unduly interrupted. If you have a problem with system calls getting
1822	signals you can block all signals in an C<ev_check> watcher and unblock	2403	interrupted by signals you can block all signals in an C<ev_check> watcher
1823	them in an C<ev_prepare> watcher.	2404	and unblock them in an C<ev_prepare> watcher.
		2405
		2406	=head3 The special problem of inheritance over fork/execve/pthread_create
		2407
		2408	Both the signal mask (C<sigprocmask>) and the signal disposition
		2409	(C<sigaction>) are unspecified after starting a signal watcher (and after
		2410	stopping it again), that is, libev might or might not block the signal,
		2411	and might or might not set or restore the installed signal handler (but
		2412	see C<EVFLAG_NOSIGMASK>).
		2413
		2414	While this does not matter for the signal disposition (libev never
		2415	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
		2416	C<execve>), this matters for the signal mask: many programs do not expect
		2417	certain signals to be blocked.
		2418
		2419	This means that before calling C<exec> (from the child) you should reset
		2420	the signal mask to whatever "default" you expect (all clear is a good
		2421	choice usually).
		2422
		2423	The simplest way to ensure that the signal mask is reset in the child is
		2424	to install a fork handler with C<pthread_atfork> that resets it. That will
		2425	catch fork calls done by libraries (such as the libc) as well.
		2426
		2427	In current versions of libev, the signal will not be blocked indefinitely
		2428	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2429	the window of opportunity for problems, it will not go away, as libev
		2430	I<has> to modify the signal mask, at least temporarily.
		2431
		2432	So I can't stress this enough: I<If you do not reset your signal mask when
		2433	you expect it to be empty, you have a race condition in your code>. This
		2434	is not a libev-specific thing, this is true for most event libraries.
		2435
		2436	=head3 The special problem of threads signal handling
		2437
		2438	POSIX threads has problematic signal handling semantics, specifically,
		2439	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2440	threads in a process block signals, which is hard to achieve.
		2441
		2442	When you want to use sigwait (or mix libev signal handling with your own
		2443	for the same signals), you can tackle this problem by globally blocking
		2444	all signals before creating any threads (or creating them with a fully set
		2445	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2446	loops. Then designate one thread as "signal receiver thread" which handles
		2447	these signals. You can pass on any signals that libev might be interested
		2448	in by calling C<ev_feed_signal>.
1824		2449
1825	=head3 Watcher-Specific Functions and Data Members	2450	=head3 Watcher-Specific Functions and Data Members
1826		2451
1827	=over 4	2452	=over 4
1828		2453
…		…
1844	Example: Try to exit cleanly on SIGINT.	2469	Example: Try to exit cleanly on SIGINT.
1845		2470
1846	static void	2471	static void
1847	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2472	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1848	{	2473	{
1849	ev_unloop (loop, EVUNLOOP_ALL);	2474	ev_break (loop, EVBREAK_ALL);
1850	}	2475	}
1851		2476
1852	ev_signal signal_watcher;	2477	ev_signal signal_watcher;
1853	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2478	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1854	ev_signal_start (loop, &signal_watcher);	2479	ev_signal_start (loop, &signal_watcher);
…		…
1860	some child status changes (most typically when a child of yours dies or	2485	some child status changes (most typically when a child of yours dies or
1861	exits). It is permissible to install a child watcher I<after> the child	2486	exits). It is permissible to install a child watcher I<after> the child
1862	has been forked (which implies it might have already exited), as long	2487	has been forked (which implies it might have already exited), as long
1863	as the event loop isn't entered (or is continued from a watcher), i.e.,	2488	as the event loop isn't entered (or is continued from a watcher), i.e.,
1864	forking and then immediately registering a watcher for the child is fine,	2489	forking and then immediately registering a watcher for the child is fine,
1865	but forking and registering a watcher a few event loop iterations later is	2490	but forking and registering a watcher a few event loop iterations later or
1866	not.	2491	in the next callback invocation is not.
1867		2492
1868	Only the default event loop is capable of handling signals, and therefore	2493	Only the default event loop is capable of handling signals, and therefore
1869	you can only register child watchers in the default event loop.	2494	you can only register child watchers in the default event loop.
1870		2495
		2496	Due to some design glitches inside libev, child watchers will always be
		2497	handled at maximum priority (their priority is set to C<EV_MAXPRI> by
		2498	libev)
		2499
1871	=head3 Process Interaction	2500	=head3 Process Interaction
1872		2501
1873	Libev grabs C<SIGCHLD> as soon as the default event loop is	2502	Libev grabs C<SIGCHLD> as soon as the default event loop is
1874	initialised. This is necessary to guarantee proper behaviour even if	2503	initialised. This is necessary to guarantee proper behaviour even if the
1875	the first child watcher is started after the child exits. The occurrence	2504	first child watcher is started after the child exits. The occurrence
1876	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	2505	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1877	synchronously as part of the event loop processing. Libev always reaps all	2506	synchronously as part of the event loop processing. Libev always reaps all
1878	children, even ones not watched.	2507	children, even ones not watched.
1879		2508
1880	=head3 Overriding the Built-In Processing	2509	=head3 Overriding the Built-In Processing
…		…
1890	=head3 Stopping the Child Watcher	2519	=head3 Stopping the Child Watcher
1891		2520
1892	Currently, the child watcher never gets stopped, even when the	2521	Currently, the child watcher never gets stopped, even when the
1893	child terminates, so normally one needs to stop the watcher in the	2522	child terminates, so normally one needs to stop the watcher in the
1894	callback. Future versions of libev might stop the watcher automatically	2523	callback. Future versions of libev might stop the watcher automatically
1895	when a child exit is detected.	2524	when a child exit is detected (calling C<ev_child_stop> twice is not a
		2525	problem).
1896		2526
1897	=head3 Watcher-Specific Functions and Data Members	2527	=head3 Watcher-Specific Functions and Data Members
1898		2528
1899	=over 4	2529	=over 4
1900		2530
…		…
2226	// no longer anything immediate to do.	2856	// no longer anything immediate to do.
2227	}	2857	}
2228		2858
2229	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	2859	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2230	ev_idle_init (idle_watcher, idle_cb);	2860	ev_idle_init (idle_watcher, idle_cb);
2231	ev_idle_start (loop, idle_cb);	2861	ev_idle_start (loop, idle_watcher);
2232		2862
2233		2863
2234	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2864	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2235		2865
2236	Prepare and check watchers are usually (but not always) used in pairs:	2866	Prepare and check watchers are usually (but not always) used in pairs:
2237	prepare watchers get invoked before the process blocks and check watchers	2867	prepare watchers get invoked before the process blocks and check watchers
2238	afterwards.	2868	afterwards.
2239		2869
2240	You I<must not> call C<ev_loop> or similar functions that enter	2870	You I<must not> call C<ev_run> or similar functions that enter
2241	the current event loop from either C<ev_prepare> or C<ev_check>	2871	the current event loop from either C<ev_prepare> or C<ev_check>
2242	watchers. Other loops than the current one are fine, however. The	2872	watchers. Other loops than the current one are fine, however. The
2243	rationale behind this is that you do not need to check for recursion in	2873	rationale behind this is that you do not need to check for recursion in
2244	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2874	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2245	C<ev_check> so if you have one watcher of each kind they will always be	2875	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2329	struct pollfd fds [nfd];	2959	struct pollfd fds [nfd];
2330	// actual code will need to loop here and realloc etc.	2960	// actual code will need to loop here and realloc etc.
2331	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2961	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2332		2962
2333	/* the callback is illegal, but won't be called as we stop during check */	2963	/* the callback is illegal, but won't be called as we stop during check */
2334	ev_timer_init (&tw, 0, timeout * 1e-3);	2964	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2335	ev_timer_start (loop, &tw);	2965	ev_timer_start (loop, &tw);
2336		2966
2337	// create one ev_io per pollfd	2967	// create one ev_io per pollfd
2338	for (int i = 0; i < nfd; ++i)	2968	for (int i = 0; i < nfd; ++i)
2339	{	2969	{
…		…
2413		3043
2414	if (timeout >= 0)	3044	if (timeout >= 0)
2415	// create/start timer	3045	// create/start timer
2416		3046
2417	// poll	3047	// poll
2418	ev_loop (EV_A_ 0);	3048	ev_run (EV_A_ 0);
2419		3049
2420	// stop timer again	3050	// stop timer again
2421	if (timeout >= 0)	3051	if (timeout >= 0)
2422	ev_timer_stop (EV_A_ &to);	3052	ev_timer_stop (EV_A_ &to);
2423		3053
…		…
2501	if you do not want that, you need to temporarily stop the embed watcher).	3131	if you do not want that, you need to temporarily stop the embed watcher).
2502		3132
2503	=item ev_embed_sweep (loop, ev_embed *)	3133	=item ev_embed_sweep (loop, ev_embed *)
2504		3134
2505	Make a single, non-blocking sweep over the embedded loop. This works	3135	Make a single, non-blocking sweep over the embedded loop. This works
2506	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3136	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2507	appropriate way for embedded loops.	3137	appropriate way for embedded loops.
2508		3138
2509	=item struct ev_loop *other [read-only]	3139	=item struct ev_loop *other [read-only]
2510		3140
2511	The embedded event loop.	3141	The embedded event loop.
…		…
2569	event loop blocks next and before C<ev_check> watchers are being called,	3199	event loop blocks next and before C<ev_check> watchers are being called,
2570	and only in the child after the fork. If whoever good citizen calling	3200	and only in the child after the fork. If whoever good citizen calling
2571	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3201	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2572	handlers will be invoked, too, of course.	3202	handlers will be invoked, too, of course.
2573		3203
		3204	=head3 The special problem of life after fork - how is it possible?
		3205
		3206	Most uses of C<fork()> consist of forking, then some simple calls to set
		3207	up/change the process environment, followed by a call to C<exec()>. This
		3208	sequence should be handled by libev without any problems.
		3209
		3210	This changes when the application actually wants to do event handling
		3211	in the child, or both parent in child, in effect "continuing" after the
		3212	fork.
		3213
		3214	The default mode of operation (for libev, with application help to detect
		3215	forks) is to duplicate all the state in the child, as would be expected
		3216	when I<either> the parent I<or> the child process continues.
		3217
		3218	When both processes want to continue using libev, then this is usually the
		3219	wrong result. In that case, usually one process (typically the parent) is
		3220	supposed to continue with all watchers in place as before, while the other
		3221	process typically wants to start fresh, i.e. without any active watchers.
		3222
		3223	The cleanest and most efficient way to achieve that with libev is to
		3224	simply create a new event loop, which of course will be "empty", and
		3225	use that for new watchers. This has the advantage of not touching more
		3226	memory than necessary, and thus avoiding the copy-on-write, and the
		3227	disadvantage of having to use multiple event loops (which do not support
		3228	signal watchers).
		3229
		3230	When this is not possible, or you want to use the default loop for
		3231	other reasons, then in the process that wants to start "fresh", call
		3232	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
		3233	Destroying the default loop will "orphan" (not stop) all registered
		3234	watchers, so you have to be careful not to execute code that modifies
		3235	those watchers. Note also that in that case, you have to re-register any
		3236	signal watchers.
		3237
2574	=head3 Watcher-Specific Functions and Data Members	3238	=head3 Watcher-Specific Functions and Data Members
2575		3239
2576	=over 4	3240	=over 4
2577		3241
2578	=item ev_fork_init (ev_signal *, callback)	3242	=item ev_fork_init (ev_fork *, callback)
2579		3243
2580	Initialises and configures the fork watcher - it has no parameters of any	3244	Initialises and configures the fork watcher - it has no parameters of any
2581	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3245	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2582	believe me.	3246	really.
2583		3247
2584	=back	3248	=back
2585		3249
2586		3250
		3251	=head2 C<ev_cleanup> - even the best things end
		3252
		3253	Cleanup watchers are called just before the event loop is being destroyed
		3254	by a call to C<ev_loop_destroy>.
		3255
		3256	While there is no guarantee that the event loop gets destroyed, cleanup
		3257	watchers provide a convenient method to install cleanup hooks for your
		3258	program, worker threads and so on - you just to make sure to destroy the
		3259	loop when you want them to be invoked.
		3260
		3261	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3262	all other watchers, they do not keep a reference to the event loop (which
		3263	makes a lot of sense if you think about it). Like all other watchers, you
		3264	can call libev functions in the callback, except C<ev_cleanup_start>.
		3265
		3266	=head3 Watcher-Specific Functions and Data Members
		3267
		3268	=over 4
		3269
		3270	=item ev_cleanup_init (ev_cleanup *, callback)
		3271
		3272	Initialises and configures the cleanup watcher - it has no parameters of
		3273	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3274	pointless, I assure you.
		3275
		3276	=back
		3277
		3278	Example: Register an atexit handler to destroy the default loop, so any
		3279	cleanup functions are called.
		3280
		3281	static void
		3282	program_exits (void)
		3283	{
		3284	ev_loop_destroy (EV_DEFAULT_UC);
		3285	}
		3286
		3287	...
		3288	atexit (program_exits);
		3289
		3290
2587	=head2 C<ev_async> - how to wake up another event loop	3291	=head2 C<ev_async> - how to wake up an event loop
2588		3292
2589	In general, you cannot use an C<ev_loop> from multiple threads or other	3293	In general, you cannot use an C<ev_loop> from multiple threads or other
2590	asynchronous sources such as signal handlers (as opposed to multiple event	3294	asynchronous sources such as signal handlers (as opposed to multiple event
2591	loops - those are of course safe to use in different threads).	3295	loops - those are of course safe to use in different threads).
2592		3296
2593	Sometimes, however, you need to wake up another event loop you do not	3297	Sometimes, however, you need to wake up an event loop you do not control,
2594	control, for example because it belongs to another thread. This is what	3298	for example because it belongs to another thread. This is what C<ev_async>
2595	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3299	watchers do: as long as the C<ev_async> watcher is active, you can signal
2596	can signal it by calling C<ev_async_send>, which is thread- and signal	3300	it by calling C<ev_async_send>, which is thread- and signal safe.
2597	safe.
2598		3301
2599	This functionality is very similar to C<ev_signal> watchers, as signals,	3302	This functionality is very similar to C<ev_signal> watchers, as signals,
2600	too, are asynchronous in nature, and signals, too, will be compressed	3303	too, are asynchronous in nature, and signals, too, will be compressed
2601	(i.e. the number of callback invocations may be less than the number of	3304	(i.e. the number of callback invocations may be less than the number of
2602	C<ev_async_sent> calls).	3305	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
2603		3306	of "global async watchers" by using a watcher on an otherwise unused
2604	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3307	signal, and C<ev_feed_signal> to signal this watcher from another thread,
2605	just the default loop.	3308	even without knowing which loop owns the signal.
2606		3309
2607	=head3 Queueing	3310	=head3 Queueing
2608		3311
2609	C<ev_async> does not support queueing of data in any way. The reason	3312	C<ev_async> does not support queueing of data in any way. The reason
2610	is that the author does not know of a simple (or any) algorithm for a	3313	is that the author does not know of a simple (or any) algorithm for a
2611	multiple-writer-single-reader queue that works in all cases and doesn't	3314	multiple-writer-single-reader queue that works in all cases and doesn't
2612	need elaborate support such as pthreads.	3315	need elaborate support such as pthreads or unportable memory access
		3316	semantics.
2613		3317
2614	That means that if you want to queue data, you have to provide your own	3318	That means that if you want to queue data, you have to provide your own
2615	queue. But at least I can tell you how to implement locking around your	3319	queue. But at least I can tell you how to implement locking around your
2616	queue:	3320	queue:
2617		3321
…		…
2701	trust me.	3405	trust me.
2702		3406
2703	=item ev_async_send (loop, ev_async *)	3407	=item ev_async_send (loop, ev_async *)
2704		3408
2705	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3409	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2706	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3410	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3411	returns.
		3412
2707	C<ev_feed_event>, this call is safe to do from other threads, signal or	3413	Unlike C<ev_feed_event>, this call is safe to do from other threads,
2708	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3414	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
2709	section below on what exactly this means).	3415	embedding section below on what exactly this means).
2710		3416
2711	Note that, as with other watchers in libev, multiple events might get	3417	Note that, as with other watchers in libev, multiple events might get
2712	compressed into a single callback invocation (another way to look at this	3418	compressed into a single callback invocation (another way to look at
2713	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3419	this is that C<ev_async> watchers are level-triggered: they are set on
2714	reset when the event loop detects that).	3420	C<ev_async_send>, reset when the event loop detects that).
2715		3421
2716	This call incurs the overhead of a system call only once per event loop	3422	This call incurs the overhead of at most one extra system call per event
2717	iteration, so while the overhead might be noticeable, it doesn't apply to	3423	loop iteration, if the event loop is blocked, and no syscall at all if
2718	repeated calls to C<ev_async_send> for the same event loop.	3424	the event loop (or your program) is processing events. That means that
		3425	repeated calls are basically free (there is no need to avoid calls for
		3426	performance reasons) and that the overhead becomes smaller (typically
		3427	zero) under load.
2719		3428
2720	=item bool = ev_async_pending (ev_async *)	3429	=item bool = ev_async_pending (ev_async *)
2721		3430
2722	Returns a non-zero value when C<ev_async_send> has been called on the	3431	Returns a non-zero value when C<ev_async_send> has been called on the
2723	watcher but the event has not yet been processed (or even noted) by the	3432	watcher but the event has not yet been processed (or even noted) by the
…		…
2756		3465
2757	If C<timeout> is less than 0, then no timeout watcher will be	3466	If C<timeout> is less than 0, then no timeout watcher will be
2758	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3467	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2759	repeat = 0) will be started. C<0> is a valid timeout.	3468	repeat = 0) will be started. C<0> is a valid timeout.
2760		3469
2761	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3470	The callback has the type C<void (*cb)(int revents, void *arg)> and is
2762	passed an C<revents> set like normal event callbacks (a combination of	3471	passed an C<revents> set like normal event callbacks (a combination of
2763	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3472	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
2764	value passed to C<ev_once>. Note that it is possible to receive I<both>	3473	value passed to C<ev_once>. Note that it is possible to receive I<both>
2765	a timeout and an io event at the same time - you probably should give io	3474	a timeout and an io event at the same time - you probably should give io
2766	events precedence.	3475	events precedence.
2767		3476
2768	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3477	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2769		3478
2770	static void stdin_ready (int revents, void *arg)	3479	static void stdin_ready (int revents, void *arg)
2771	{	3480	{
2772	if (revents & EV_READ)	3481	if (revents & EV_READ)
2773	/* stdin might have data for us, joy! */;	3482	/* stdin might have data for us, joy! */;
2774	else if (revents & EV_TIMEOUT)	3483	else if (revents & EV_TIMER)
2775	/* doh, nothing entered */;	3484	/* doh, nothing entered */;
2776	}	3485	}
2777		3486
2778	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3487	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2779		3488
2780	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2781
2782	Feeds the given event set into the event loop, as if the specified event
2783	had happened for the specified watcher (which must be a pointer to an
2784	initialised but not necessarily started event watcher).
2785
2786	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3489	=item ev_feed_fd_event (loop, int fd, int revents)
2787		3490
2788	Feed an event on the given fd, as if a file descriptor backend detected	3491	Feed an event on the given fd, as if a file descriptor backend detected
2789	the given events it.	3492	the given events.
2790		3493
2791	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3494	=item ev_feed_signal_event (loop, int signum)
2792		3495
2793	Feed an event as if the given signal occurred (C<loop> must be the default	3496	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
2794	loop!).	3497	which is async-safe.
2795		3498
2796	=back	3499	=back
		3500
		3501
		3502	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3503
		3504	This section explains some common idioms that are not immediately
		3505	obvious. Note that examples are sprinkled over the whole manual, and this
		3506	section only contains stuff that wouldn't fit anywhere else.
		3507
		3508	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3509
		3510	Each watcher has, by default, a C<void *data> member that you can read
		3511	or modify at any time: libev will completely ignore it. This can be used
		3512	to associate arbitrary data with your watcher. If you need more data and
		3513	don't want to allocate memory separately and store a pointer to it in that
		3514	data member, you can also "subclass" the watcher type and provide your own
		3515	data:
		3516
		3517	struct my_io
		3518	{
		3519	ev_io io;
		3520	int otherfd;
		3521	void *somedata;
		3522	struct whatever *mostinteresting;
		3523	};
		3524
		3525	...
		3526	struct my_io w;
		3527	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3528
		3529	And since your callback will be called with a pointer to the watcher, you
		3530	can cast it back to your own type:
		3531
		3532	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3533	{
		3534	struct my_io *w = (struct my_io *)w_;
		3535	...
		3536	}
		3537
		3538	More interesting and less C-conformant ways of casting your callback
		3539	function type instead have been omitted.
		3540
		3541	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3542
		3543	Another common scenario is to use some data structure with multiple
		3544	embedded watchers, in effect creating your own watcher that combines
		3545	multiple libev event sources into one "super-watcher":
		3546
		3547	struct my_biggy
		3548	{
		3549	int some_data;
		3550	ev_timer t1;
		3551	ev_timer t2;
		3552	}
		3553
		3554	In this case getting the pointer to C<my_biggy> is a bit more
		3555	complicated: Either you store the address of your C<my_biggy> struct in
		3556	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3557	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3558	real programmers):
		3559
		3560	#include <stddef.h>
		3561
		3562	static void
		3563	t1_cb (EV_P_ ev_timer *w, int revents)
		3564	{
		3565	struct my_biggy big = (struct my_biggy *)
		3566	(((char *)w) - offsetof (struct my_biggy, t1));
		3567	}
		3568
		3569	static void
		3570	t2_cb (EV_P_ ev_timer *w, int revents)
		3571	{
		3572	struct my_biggy big = (struct my_biggy *)
		3573	(((char *)w) - offsetof (struct my_biggy, t2));
		3574	}
		3575
		3576	=head2 AVOIDING FINISHING BEFORE RETURNING
		3577
		3578	Often you have structures like this in event-based programs:
		3579
		3580	callback ()
		3581	{
		3582	free (request);
		3583	}
		3584
		3585	request = start_new_request (..., callback);
		3586
		3587	The intent is to start some "lengthy" operation. The C<request> could be
		3588	used to cancel the operation, or do other things with it.
		3589
		3590	It's not uncommon to have code paths in C<start_new_request> that
		3591	immediately invoke the callback, for example, to report errors. Or you add
		3592	some caching layer that finds that it can skip the lengthy aspects of the
		3593	operation and simply invoke the callback with the result.
		3594
		3595	The problem here is that this will happen I<before> C<start_new_request>
		3596	has returned, so C<request> is not set.
		3597
		3598	Even if you pass the request by some safer means to the callback, you
		3599	might want to do something to the request after starting it, such as
		3600	canceling it, which probably isn't working so well when the callback has
		3601	already been invoked.
		3602
		3603	A common way around all these issues is to make sure that
		3604	C<start_new_request> I<always> returns before the callback is invoked. If
		3605	C<start_new_request> immediately knows the result, it can artificially
		3606	delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher
		3607	for example, or more sneakily, by reusing an existing (stopped) watcher
		3608	and pushing it into the pending queue:
		3609
		3610	ev_set_cb (watcher, callback);
		3611	ev_feed_event (EV_A_ watcher, 0);
		3612
		3613	This way, C<start_new_request> can safely return before the callback is
		3614	invoked, while not delaying callback invocation too much.
		3615
		3616	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3617
		3618	Often (especially in GUI toolkits) there are places where you have
		3619	I<modal> interaction, which is most easily implemented by recursively
		3620	invoking C<ev_run>.
		3621
		3622	This brings the problem of exiting - a callback might want to finish the
		3623	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3624	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3625	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3626	other combination: In these cases, C<ev_break> will not work alone.
		3627
		3628	The solution is to maintain "break this loop" variable for each C<ev_run>
		3629	invocation, and use a loop around C<ev_run> until the condition is
		3630	triggered, using C<EVRUN_ONCE>:
		3631
		3632	// main loop
		3633	int exit_main_loop = 0;
		3634
		3635	while (!exit_main_loop)
		3636	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3637
		3638	// in a model watcher
		3639	int exit_nested_loop = 0;
		3640
		3641	while (!exit_nested_loop)
		3642	ev_run (EV_A_ EVRUN_ONCE);
		3643
		3644	To exit from any of these loops, just set the corresponding exit variable:
		3645
		3646	// exit modal loop
		3647	exit_nested_loop = 1;
		3648
		3649	// exit main program, after modal loop is finished
		3650	exit_main_loop = 1;
		3651
		3652	// exit both
		3653	exit_main_loop = exit_nested_loop = 1;
		3654
		3655	=head2 THREAD LOCKING EXAMPLE
		3656
		3657	Here is a fictitious example of how to run an event loop in a different
		3658	thread from where callbacks are being invoked and watchers are
		3659	created/added/removed.
		3660
		3661	For a real-world example, see the C<EV::Loop::Async> perl module,
		3662	which uses exactly this technique (which is suited for many high-level
		3663	languages).
		3664
		3665	The example uses a pthread mutex to protect the loop data, a condition
		3666	variable to wait for callback invocations, an async watcher to notify the
		3667	event loop thread and an unspecified mechanism to wake up the main thread.
		3668
		3669	First, you need to associate some data with the event loop:
		3670
		3671	typedef struct {
		3672	mutex_t lock; /* global loop lock */
		3673	ev_async async_w;
		3674	thread_t tid;
		3675	cond_t invoke_cv;
		3676	} userdata;
		3677
		3678	void prepare_loop (EV_P)
		3679	{
		3680	// for simplicity, we use a static userdata struct.
		3681	static userdata u;
		3682
		3683	ev_async_init (&u->async_w, async_cb);
		3684	ev_async_start (EV_A_ &u->async_w);
		3685
		3686	pthread_mutex_init (&u->lock, 0);
		3687	pthread_cond_init (&u->invoke_cv, 0);
		3688
		3689	// now associate this with the loop
		3690	ev_set_userdata (EV_A_ u);
		3691	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3692	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3693
		3694	// then create the thread running ev_run
		3695	pthread_create (&u->tid, 0, l_run, EV_A);
		3696	}
		3697
		3698	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3699	solely to wake up the event loop so it takes notice of any new watchers
		3700	that might have been added:
		3701
		3702	static void
		3703	async_cb (EV_P_ ev_async *w, int revents)
		3704	{
		3705	// just used for the side effects
		3706	}
		3707
		3708	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3709	protecting the loop data, respectively.
		3710
		3711	static void
		3712	l_release (EV_P)
		3713	{
		3714	userdata *u = ev_userdata (EV_A);
		3715	pthread_mutex_unlock (&u->lock);
		3716	}
		3717
		3718	static void
		3719	l_acquire (EV_P)
		3720	{
		3721	userdata *u = ev_userdata (EV_A);
		3722	pthread_mutex_lock (&u->lock);
		3723	}
		3724
		3725	The event loop thread first acquires the mutex, and then jumps straight
		3726	into C<ev_run>:
		3727
		3728	void *
		3729	l_run (void *thr_arg)
		3730	{
		3731	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3732
		3733	l_acquire (EV_A);
		3734	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3735	ev_run (EV_A_ 0);
		3736	l_release (EV_A);
		3737
		3738	return 0;
		3739	}
		3740
		3741	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3742	signal the main thread via some unspecified mechanism (signals? pipe
		3743	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3744	have been called (in a while loop because a) spurious wakeups are possible
		3745	and b) skipping inter-thread-communication when there are no pending
		3746	watchers is very beneficial):
		3747
		3748	static void
		3749	l_invoke (EV_P)
		3750	{
		3751	userdata *u = ev_userdata (EV_A);
		3752
		3753	while (ev_pending_count (EV_A))
		3754	{
		3755	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3756	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3757	}
		3758	}
		3759
		3760	Now, whenever the main thread gets told to invoke pending watchers, it
		3761	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3762	thread to continue:
		3763
		3764	static void
		3765	real_invoke_pending (EV_P)
		3766	{
		3767	userdata *u = ev_userdata (EV_A);
		3768
		3769	pthread_mutex_lock (&u->lock);
		3770	ev_invoke_pending (EV_A);
		3771	pthread_cond_signal (&u->invoke_cv);
		3772	pthread_mutex_unlock (&u->lock);
		3773	}
		3774
		3775	Whenever you want to start/stop a watcher or do other modifications to an
		3776	event loop, you will now have to lock:
		3777
		3778	ev_timer timeout_watcher;
		3779	userdata *u = ev_userdata (EV_A);
		3780
		3781	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3782
		3783	pthread_mutex_lock (&u->lock);
		3784	ev_timer_start (EV_A_ &timeout_watcher);
		3785	ev_async_send (EV_A_ &u->async_w);
		3786	pthread_mutex_unlock (&u->lock);
		3787
		3788	Note that sending the C<ev_async> watcher is required because otherwise
		3789	an event loop currently blocking in the kernel will have no knowledge
		3790	about the newly added timer. By waking up the loop it will pick up any new
		3791	watchers in the next event loop iteration.
		3792
		3793	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3794
		3795	While the overhead of a callback that e.g. schedules a thread is small, it
		3796	is still an overhead. If you embed libev, and your main usage is with some
		3797	kind of threads or coroutines, you might want to customise libev so that
		3798	doesn't need callbacks anymore.
		3799
		3800	Imagine you have coroutines that you can switch to using a function
		3801	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3802	and that due to some magic, the currently active coroutine is stored in a
		3803	global called C<current_coro>. Then you can build your own "wait for libev
		3804	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3805	the differing C<;> conventions):
		3806
		3807	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3808	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3809
		3810	That means instead of having a C callback function, you store the
		3811	coroutine to switch to in each watcher, and instead of having libev call
		3812	your callback, you instead have it switch to that coroutine.
		3813
		3814	A coroutine might now wait for an event with a function called
		3815	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3816	matter when, or whether the watcher is active or not when this function is
		3817	called):
		3818
		3819	void
		3820	wait_for_event (ev_watcher *w)
		3821	{
		3822	ev_cb_set (w) = current_coro;
		3823	switch_to (libev_coro);
		3824	}
		3825
		3826	That basically suspends the coroutine inside C<wait_for_event> and
		3827	continues the libev coroutine, which, when appropriate, switches back to
		3828	this or any other coroutine. I am sure if you sue this your own :)
		3829
		3830	You can do similar tricks if you have, say, threads with an event queue -
		3831	instead of storing a coroutine, you store the queue object and instead of
		3832	switching to a coroutine, you push the watcher onto the queue and notify
		3833	any waiters.
		3834
		3835	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3836	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3837
		3838	// my_ev.h
		3839	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3840	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3841	#include "../libev/ev.h"
		3842
		3843	// my_ev.c
		3844	#define EV_H "my_ev.h"
		3845	#include "../libev/ev.c"
		3846
		3847	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3848	F<my_ev.c> into your project. When properly specifying include paths, you
		3849	can even use F<ev.h> as header file name directly.
2797		3850
2798		3851
2799	=head1 LIBEVENT EMULATION	3852	=head1 LIBEVENT EMULATION
2800		3853
2801	Libev offers a compatibility emulation layer for libevent. It cannot	3854	Libev offers a compatibility emulation layer for libevent. It cannot
2802	emulate the internals of libevent, so here are some usage hints:	3855	emulate the internals of libevent, so here are some usage hints:
2803		3856
2804	=over 4	3857	=over 4
		3858
		3859	=item * Only the libevent-1.4.1-beta API is being emulated.
		3860
		3861	This was the newest libevent version available when libev was implemented,
		3862	and is still mostly unchanged in 2010.
2805		3863
2806	=item * Use it by including <event.h>, as usual.	3864	=item * Use it by including <event.h>, as usual.
2807		3865
2808	=item * The following members are fully supported: ev_base, ev_callback,	3866	=item * The following members are fully supported: ev_base, ev_callback,
2809	ev_arg, ev_fd, ev_res, ev_events.	3867	ev_arg, ev_fd, ev_res, ev_events.
…		…
2815	=item * Priorities are not currently supported. Initialising priorities	3873	=item * Priorities are not currently supported. Initialising priorities
2816	will fail and all watchers will have the same priority, even though there	3874	will fail and all watchers will have the same priority, even though there
2817	is an ev_pri field.	3875	is an ev_pri field.
2818		3876
2819	=item * In libevent, the last base created gets the signals, in libev, the	3877	=item * In libevent, the last base created gets the signals, in libev, the
2820	first base created (== the default loop) gets the signals.	3878	base that registered the signal gets the signals.
2821		3879
2822	=item * Other members are not supported.	3880	=item * Other members are not supported.
2823		3881
2824	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3882	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2825	to use the libev header file and library.	3883	to use the libev header file and library.
…		…
2844	Care has been taken to keep the overhead low. The only data member the C++	3902	Care has been taken to keep the overhead low. The only data member the C++
2845	classes add (compared to plain C-style watchers) is the event loop pointer	3903	classes add (compared to plain C-style watchers) is the event loop pointer
2846	that the watcher is associated with (or no additional members at all if	3904	that the watcher is associated with (or no additional members at all if
2847	you disable C<EV_MULTIPLICITY> when embedding libev).	3905	you disable C<EV_MULTIPLICITY> when embedding libev).
2848		3906
2849	Currently, functions, and static and non-static member functions can be	3907	Currently, functions, static and non-static member functions and classes
2850	used as callbacks. Other types should be easy to add as long as they only	3908	with C<operator ()> can be used as callbacks. Other types should be easy
2851	need one additional pointer for context. If you need support for other	3909	to add as long as they only need one additional pointer for context. If
2852	types of functors please contact the author (preferably after implementing	3910	you need support for other types of functors please contact the author
2853	it).	3911	(preferably after implementing it).
2854		3912
2855	Here is a list of things available in the C<ev> namespace:	3913	Here is a list of things available in the C<ev> namespace:
2856		3914
2857	=over 4	3915	=over 4
2858		3916
…		…
2876		3934
2877	=over 4	3935	=over 4
2878		3936
2879	=item ev::TYPE::TYPE ()	3937	=item ev::TYPE::TYPE ()
2880		3938
2881	=item ev::TYPE::TYPE (struct ev_loop *)	3939	=item ev::TYPE::TYPE (loop)
2882		3940
2883	=item ev::TYPE::~TYPE	3941	=item ev::TYPE::~TYPE
2884		3942
2885	The constructor (optionally) takes an event loop to associate the watcher	3943	The constructor (optionally) takes an event loop to associate the watcher
2886	with. If it is omitted, it will use C<EV_DEFAULT>.	3944	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
2919	myclass obj;	3977	myclass obj;
2920	ev::io iow;	3978	ev::io iow;
2921	iow.set <myclass, &myclass::io_cb> (&obj);	3979	iow.set <myclass, &myclass::io_cb> (&obj);
2922		3980
2923	=item w->set (object *)	3981	=item w->set (object *)
2924
2925	This is an B<experimental> feature that might go away in a future version.
2926		3982
2927	This is a variation of a method callback - leaving out the method to call	3983	This is a variation of a method callback - leaving out the method to call
2928	will default the method to C<operator ()>, which makes it possible to use	3984	will default the method to C<operator ()>, which makes it possible to use
2929	functor objects without having to manually specify the C<operator ()> all	3985	functor objects without having to manually specify the C<operator ()> all
2930	the time. Incidentally, you can then also leave out the template argument	3986	the time. Incidentally, you can then also leave out the template argument
…		…
2963	Example: Use a plain function as callback.	4019	Example: Use a plain function as callback.
2964		4020
2965	static void io_cb (ev::io &w, int revents) { }	4021	static void io_cb (ev::io &w, int revents) { }
2966	iow.set <io_cb> ();	4022	iow.set <io_cb> ();
2967		4023
2968	=item w->set (struct ev_loop *)	4024	=item w->set (loop)
2969		4025
2970	Associates a different C<struct ev_loop> with this watcher. You can only	4026	Associates a different C<struct ev_loop> with this watcher. You can only
2971	do this when the watcher is inactive (and not pending either).	4027	do this when the watcher is inactive (and not pending either).
2972		4028
2973	=item w->set ([arguments])	4029	=item w->set ([arguments])
2974		4030
2975	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	4031	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
2976	called at least once. Unlike the C counterpart, an active watcher gets	4032	method or a suitable start method must be called at least once. Unlike the
2977	automatically stopped and restarted when reconfiguring it with this	4033	C counterpart, an active watcher gets automatically stopped and restarted
2978	method.	4034	when reconfiguring it with this method.
2979		4035
2980	=item w->start ()	4036	=item w->start ()
2981		4037
2982	Starts the watcher. Note that there is no C<loop> argument, as the	4038	Starts the watcher. Note that there is no C<loop> argument, as the
2983	constructor already stores the event loop.	4039	constructor already stores the event loop.
2984		4040
		4041	=item w->start ([arguments])
		4042
		4043	Instead of calling C<set> and C<start> methods separately, it is often
		4044	convenient to wrap them in one call. Uses the same type of arguments as
		4045	the configure C<set> method of the watcher.
		4046
2985	=item w->stop ()	4047	=item w->stop ()
2986		4048
2987	Stops the watcher if it is active. Again, no C<loop> argument.	4049	Stops the watcher if it is active. Again, no C<loop> argument.
2988		4050
2989	=item w->again () (C<ev::timer>, C<ev::periodic> only)	4051	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3001		4063
3002	=back	4064	=back
3003		4065
3004	=back	4066	=back
3005		4067
3006	Example: Define a class with an IO and idle watcher, start one of them in	4068	Example: Define a class with two I/O and idle watchers, start the I/O
3007	the constructor.	4069	watchers in the constructor.
3008		4070
3009	class myclass	4071	class myclass
3010	{	4072	{
3011	ev::io io ; void io_cb (ev::io &w, int revents);	4073	ev::io io ; void io_cb (ev::io &w, int revents);
		4074	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3012	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4075	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3013		4076
3014	myclass (int fd)	4077	myclass (int fd)
3015	{	4078	{
3016	io .set <myclass, &myclass::io_cb > (this);	4079	io .set <myclass, &myclass::io_cb > (this);
		4080	io2 .set <myclass, &myclass::io2_cb > (this);
3017	idle.set <myclass, &myclass::idle_cb> (this);	4081	idle.set <myclass, &myclass::idle_cb> (this);
3018		4082
3019	io.start (fd, ev::READ);	4083	io.set (fd, ev::WRITE); // configure the watcher
		4084	io.start (); // start it whenever convenient
		4085
		4086	io2.start (fd, ev::READ); // set + start in one call
3020	}	4087	}
3021	};	4088	};
3022		4089
3023		4090
3024	=head1 OTHER LANGUAGE BINDINGS	4091	=head1 OTHER LANGUAGE BINDINGS
…		…
3063	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4130	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3064		4131
3065	=item D	4132	=item D
3066		4133
3067	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4134	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3068	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4135	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3069		4136
3070	=item Ocaml	4137	=item Ocaml
3071		4138
3072	Erkki Seppala has written Ocaml bindings for libev, to be found at	4139	Erkki Seppala has written Ocaml bindings for libev, to be found at
3073	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4140	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
		4141
		4142	=item Lua
		4143
		4144	Brian Maher has written a partial interface to libev for lua (at the
		4145	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
		4146	L<http://github.com/brimworks/lua-ev>.
3074		4147
3075	=back	4148	=back
3076		4149
3077		4150
3078	=head1 MACRO MAGIC	4151	=head1 MACRO MAGIC
…		…
3092	loop argument"). The C<EV_A> form is used when this is the sole argument,	4165	loop argument"). The C<EV_A> form is used when this is the sole argument,
3093	C<EV_A_> is used when other arguments are following. Example:	4166	C<EV_A_> is used when other arguments are following. Example:
3094		4167
3095	ev_unref (EV_A);	4168	ev_unref (EV_A);
3096	ev_timer_add (EV_A_ watcher);	4169	ev_timer_add (EV_A_ watcher);
3097	ev_loop (EV_A_ 0);	4170	ev_run (EV_A_ 0);
3098		4171
3099	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4172	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3100	which is often provided by the following macro.	4173	which is often provided by the following macro.
3101		4174
3102	=item C<EV_P>, C<EV_P_>	4175	=item C<EV_P>, C<EV_P_>
…		…
3115	suitable for use with C<EV_A>.	4188	suitable for use with C<EV_A>.
3116		4189
3117	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4190	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3118		4191
3119	Similar to the other two macros, this gives you the value of the default	4192	Similar to the other two macros, this gives you the value of the default
3120	loop, if multiple loops are supported ("ev loop default").	4193	loop, if multiple loops are supported ("ev loop default"). The default loop
		4194	will be initialised if it isn't already initialised.
		4195
		4196	For non-multiplicity builds, these macros do nothing, so you always have
		4197	to initialise the loop somewhere.
3121		4198
3122	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4199	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3123		4200
3124	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4201	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3125	default loop has been initialised (C<UC> == unchecked). Their behaviour	4202	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3142	}	4219	}
3143		4220
3144	ev_check check;	4221	ev_check check;
3145	ev_check_init (&check, check_cb);	4222	ev_check_init (&check, check_cb);
3146	ev_check_start (EV_DEFAULT_ &check);	4223	ev_check_start (EV_DEFAULT_ &check);
3147	ev_loop (EV_DEFAULT_ 0);	4224	ev_run (EV_DEFAULT_ 0);
3148		4225
3149	=head1 EMBEDDING	4226	=head1 EMBEDDING
3150		4227
3151	Libev can (and often is) directly embedded into host	4228	Libev can (and often is) directly embedded into host
3152	applications. Examples of applications that embed it include the Deliantra	4229	applications. Examples of applications that embed it include the Deliantra
…		…
3232	libev.m4	4309	libev.m4
3233		4310
3234	=head2 PREPROCESSOR SYMBOLS/MACROS	4311	=head2 PREPROCESSOR SYMBOLS/MACROS
3235		4312
3236	Libev can be configured via a variety of preprocessor symbols you have to	4313	Libev can be configured via a variety of preprocessor symbols you have to
3237	define before including any of its files. The default in the absence of	4314	define before including (or compiling) any of its files. The default in
3238	autoconf is documented for every option.	4315	the absence of autoconf is documented for every option.
		4316
		4317	Symbols marked with "(h)" do not change the ABI, and can have different
		4318	values when compiling libev vs. including F<ev.h>, so it is permissible
		4319	to redefine them before including F<ev.h> without breaking compatibility
		4320	to a compiled library. All other symbols change the ABI, which means all
		4321	users of libev and the libev code itself must be compiled with compatible
		4322	settings.
3239		4323
3240	=over 4	4324	=over 4
3241		4325
		4326	=item EV_COMPAT3 (h)
		4327
		4328	Backwards compatibility is a major concern for libev. This is why this
		4329	release of libev comes with wrappers for the functions and symbols that
		4330	have been renamed between libev version 3 and 4.
		4331
		4332	You can disable these wrappers (to test compatibility with future
		4333	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4334	sources. This has the additional advantage that you can drop the C<struct>
		4335	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4336	typedef in that case.
		4337
		4338	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4339	and in some even more future version the compatibility code will be
		4340	removed completely.
		4341
3242	=item EV_STANDALONE	4342	=item EV_STANDALONE (h)
3243		4343
3244	Must always be C<1> if you do not use autoconf configuration, which	4344	Must always be C<1> if you do not use autoconf configuration, which
3245	keeps libev from including F<config.h>, and it also defines dummy	4345	keeps libev from including F<config.h>, and it also defines dummy
3246	implementations for some libevent functions (such as logging, which is not	4346	implementations for some libevent functions (such as logging, which is not
3247	supported). It will also not define any of the structs usually found in	4347	supported). It will also not define any of the structs usually found in
3248	F<event.h> that are not directly supported by the libev core alone.	4348	F<event.h> that are not directly supported by the libev core alone.
3249		4349
3250	In stanbdalone mode, libev will still try to automatically deduce the	4350	In standalone mode, libev will still try to automatically deduce the
3251	configuration, but has to be more conservative.	4351	configuration, but has to be more conservative.
		4352
		4353	=item EV_USE_FLOOR
		4354
		4355	If defined to be C<1>, libev will use the C<floor ()> function for its
		4356	periodic reschedule calculations, otherwise libev will fall back on a
		4357	portable (slower) implementation. If you enable this, you usually have to
		4358	link against libm or something equivalent. Enabling this when the C<floor>
		4359	function is not available will fail, so the safe default is to not enable
		4360	this.
3252		4361
3253	=item EV_USE_MONOTONIC	4362	=item EV_USE_MONOTONIC
3254		4363
3255	If defined to be C<1>, libev will try to detect the availability of the	4364	If defined to be C<1>, libev will try to detect the availability of the
3256	monotonic clock option at both compile time and runtime. Otherwise no	4365	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3320	be used is the winsock select). This means that it will call	4429	be used is the winsock select). This means that it will call
3321	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	4430	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3322	it is assumed that all these functions actually work on fds, even	4431	it is assumed that all these functions actually work on fds, even
3323	on win32. Should not be defined on non-win32 platforms.	4432	on win32. Should not be defined on non-win32 platforms.
3324		4433
3325	=item EV_FD_TO_WIN32_HANDLE	4434	=item EV_FD_TO_WIN32_HANDLE(fd)
3326		4435
3327	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map	4436	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3328	file descriptors to socket handles. When not defining this symbol (the	4437	file descriptors to socket handles. When not defining this symbol (the
3329	default), then libev will call C<_get_osfhandle>, which is usually	4438	default), then libev will call C<_get_osfhandle>, which is usually
3330	correct. In some cases, programs use their own file descriptor management,	4439	correct. In some cases, programs use their own file descriptor management,
3331	in which case they can provide this function to map fds to socket handles.	4440	in which case they can provide this function to map fds to socket handles.
		4441
		4442	=item EV_WIN32_HANDLE_TO_FD(handle)
		4443
		4444	If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
		4445	using the standard C<_open_osfhandle> function. For programs implementing
		4446	their own fd to handle mapping, overwriting this function makes it easier
		4447	to do so. This can be done by defining this macro to an appropriate value.
		4448
		4449	=item EV_WIN32_CLOSE_FD(fd)
		4450
		4451	If programs implement their own fd to handle mapping on win32, then this
		4452	macro can be used to override the C<close> function, useful to unregister
		4453	file descriptors again. Note that the replacement function has to close
		4454	the underlying OS handle.
3332		4455
3333	=item EV_USE_POLL	4456	=item EV_USE_POLL
3334		4457
3335	If defined to be C<1>, libev will compile in support for the C<poll>(2)	4458	If defined to be C<1>, libev will compile in support for the C<poll>(2)
3336	backend. Otherwise it will be enabled on non-win32 platforms. It	4459	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
3375	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4498	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3376		4499
3377	=item EV_ATOMIC_T	4500	=item EV_ATOMIC_T
3378		4501
3379	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4502	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3380	access is atomic with respect to other threads or signal contexts. No such	4503	access is atomic and serialised with respect to other threads or signal
3381	type is easily found in the C language, so you can provide your own type	4504	contexts. No such type is easily found in the C language, so you can
3382	that you know is safe for your purposes. It is used both for signal handler "locking"	4505	provide your own type that you know is safe for your purposes. It is used
3383	as well as for signal and thread safety in C<ev_async> watchers.	4506	both for signal handler "locking" as well as for signal and thread safety
		4507	in C<ev_async> watchers.
3384		4508
3385	In the absence of this define, libev will use C<sig_atomic_t volatile>	4509	In the absence of this define, libev will use C<sig_atomic_t volatile>
3386	(from F<signal.h>), which is usually good enough on most platforms.	4510	(from F<signal.h>), which is usually good enough on most platforms,
		4511	although strictly speaking using a type that also implies a memory fence
		4512	is required.
3387		4513
3388	=item EV_H	4514	=item EV_H (h)
3389		4515
3390	The name of the F<ev.h> header file used to include it. The default if	4516	The name of the F<ev.h> header file used to include it. The default if
3391	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4517	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3392	used to virtually rename the F<ev.h> header file in case of conflicts.	4518	used to virtually rename the F<ev.h> header file in case of conflicts.
3393		4519
3394	=item EV_CONFIG_H	4520	=item EV_CONFIG_H (h)
3395		4521
3396	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4522	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3397	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4523	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3398	C<EV_H>, above.	4524	C<EV_H>, above.
3399		4525
3400	=item EV_EVENT_H	4526	=item EV_EVENT_H (h)
3401		4527
3402	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4528	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3403	of how the F<event.h> header can be found, the default is C<"event.h">.	4529	of how the F<event.h> header can be found, the default is C<"event.h">.
3404		4530
3405	=item EV_PROTOTYPES	4531	=item EV_PROTOTYPES (h)
3406		4532
3407	If defined to be C<0>, then F<ev.h> will not define any function	4533	If defined to be C<0>, then F<ev.h> will not define any function
3408	prototypes, but still define all the structs and other symbols. This is	4534	prototypes, but still define all the structs and other symbols. This is
3409	occasionally useful if you want to provide your own wrapper functions	4535	occasionally useful if you want to provide your own wrapper functions
3410	around libev functions.	4536	around libev functions.
…		…
3415	will have the C<struct ev_loop *> as first argument, and you can create	4541	will have the C<struct ev_loop *> as first argument, and you can create
3416	additional independent event loops. Otherwise there will be no support	4542	additional independent event loops. Otherwise there will be no support
3417	for multiple event loops and there is no first event loop pointer	4543	for multiple event loops and there is no first event loop pointer
3418	argument. Instead, all functions act on the single default loop.	4544	argument. Instead, all functions act on the single default loop.
3419		4545
		4546	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4547	default loop when multiplicity is switched off - you always have to
		4548	initialise the loop manually in this case.
		4549
3420	=item EV_MINPRI	4550	=item EV_MINPRI
3421		4551
3422	=item EV_MAXPRI	4552	=item EV_MAXPRI
3423		4553
3424	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4554	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
3432	fine.	4562	fine.
3433		4563
3434	If your embedding application does not need any priorities, defining these	4564	If your embedding application does not need any priorities, defining these
3435	both to C<0> will save some memory and CPU.	4565	both to C<0> will save some memory and CPU.
3436		4566
3437	=item EV_PERIODIC_ENABLE	4567	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4568	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4569	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3438		4570
3439	If undefined or defined to be C<1>, then periodic timers are supported. If	4571	If undefined or defined to be C<1> (and the platform supports it), then
3440	defined to be C<0>, then they are not. Disabling them saves a few kB of	4572	the respective watcher type is supported. If defined to be C<0>, then it
3441	code.	4573	is not. Disabling watcher types mainly saves code size.
3442		4574
3443	=item EV_IDLE_ENABLE	4575	=item EV_FEATURES
3444
3445	If undefined or defined to be C<1>, then idle watchers are supported. If
3446	defined to be C<0>, then they are not. Disabling them saves a few kB of
3447	code.
3448
3449	=item EV_EMBED_ENABLE
3450
3451	If undefined or defined to be C<1>, then embed watchers are supported. If
3452	defined to be C<0>, then they are not. Embed watchers rely on most other
3453	watcher types, which therefore must not be disabled.
3454
3455	=item EV_STAT_ENABLE
3456
3457	If undefined or defined to be C<1>, then stat watchers are supported. If
3458	defined to be C<0>, then they are not.
3459
3460	=item EV_FORK_ENABLE
3461
3462	If undefined or defined to be C<1>, then fork watchers are supported. If
3463	defined to be C<0>, then they are not.
3464
3465	=item EV_ASYNC_ENABLE
3466
3467	If undefined or defined to be C<1>, then async watchers are supported. If
3468	defined to be C<0>, then they are not.
3469
3470	=item EV_MINIMAL
3471		4576
3472	If you need to shave off some kilobytes of code at the expense of some	4577	If you need to shave off some kilobytes of code at the expense of some
3473	speed, define this symbol to C<1>. Currently this is used to override some	4578	speed (but with the full API), you can define this symbol to request
3474	inlining decisions, saves roughly 30% code size on amd64. It also selects a	4579	certain subsets of functionality. The default is to enable all features
3475	much smaller 2-heap for timer management over the default 4-heap.	4580	that can be enabled on the platform.
		4581
		4582	A typical way to use this symbol is to define it to C<0> (or to a bitset
		4583	with some broad features you want) and then selectively re-enable
		4584	additional parts you want, for example if you want everything minimal,
		4585	but multiple event loop support, async and child watchers and the poll
		4586	backend, use this:
		4587
		4588	#define EV_FEATURES 0
		4589	#define EV_MULTIPLICITY 1
		4590	#define EV_USE_POLL 1
		4591	#define EV_CHILD_ENABLE 1
		4592	#define EV_ASYNC_ENABLE 1
		4593
		4594	The actual value is a bitset, it can be a combination of the following
		4595	values:
		4596
		4597	=over 4
		4598
		4599	=item C<1> - faster/larger code
		4600
		4601	Use larger code to speed up some operations.
		4602
		4603	Currently this is used to override some inlining decisions (enlarging the
		4604	code size by roughly 30% on amd64).
		4605
		4606	When optimising for size, use of compiler flags such as C<-Os> with
		4607	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4608	assertions.
		4609
		4610	=item C<2> - faster/larger data structures
		4611
		4612	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4613	hash table sizes and so on. This will usually further increase code size
		4614	and can additionally have an effect on the size of data structures at
		4615	runtime.
		4616
		4617	=item C<4> - full API configuration
		4618
		4619	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4620	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4621
		4622	=item C<8> - full API
		4623
		4624	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4625	details on which parts of the API are still available without this
		4626	feature, and do not complain if this subset changes over time.
		4627
		4628	=item C<16> - enable all optional watcher types
		4629
		4630	Enables all optional watcher types. If you want to selectively enable
		4631	only some watcher types other than I/O and timers (e.g. prepare,
		4632	embed, async, child...) you can enable them manually by defining
		4633	C<EV_watchertype_ENABLE> to C<1> instead.
		4634
		4635	=item C<32> - enable all backends
		4636
		4637	This enables all backends - without this feature, you need to enable at
		4638	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4639
		4640	=item C<64> - enable OS-specific "helper" APIs
		4641
		4642	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4643	default.
		4644
		4645	=back
		4646
		4647	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4648	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4649	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4650	watchers, timers and monotonic clock support.
		4651
		4652	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4653	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4654	your program might be left out as well - a binary starting a timer and an
		4655	I/O watcher then might come out at only 5Kb.
		4656
		4657	=item EV_API_STATIC
		4658
		4659	If this symbol is defined (by default it is not), then all identifiers
		4660	will have static linkage. This means that libev will not export any
		4661	identifiers, and you cannot link against libev anymore. This can be useful
		4662	when you embed libev, only want to use libev functions in a single file,
		4663	and do not want its identifiers to be visible.
		4664
		4665	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4666	wants to use libev.
		4667
		4668	=item EV_AVOID_STDIO
		4669
		4670	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4671	functions (printf, scanf, perror etc.). This will increase the code size
		4672	somewhat, but if your program doesn't otherwise depend on stdio and your
		4673	libc allows it, this avoids linking in the stdio library which is quite
		4674	big.
		4675
		4676	Note that error messages might become less precise when this option is
		4677	enabled.
		4678
		4679	=item EV_NSIG
		4680
		4681	The highest supported signal number, +1 (or, the number of
		4682	signals): Normally, libev tries to deduce the maximum number of signals
		4683	automatically, but sometimes this fails, in which case it can be
		4684	specified. Also, using a lower number than detected (C<32> should be
		4685	good for about any system in existence) can save some memory, as libev
		4686	statically allocates some 12-24 bytes per signal number.
3476		4687
3477	=item EV_PID_HASHSIZE	4688	=item EV_PID_HASHSIZE
3478		4689
3479	C<ev_child> watchers use a small hash table to distribute workload by	4690	C<ev_child> watchers use a small hash table to distribute workload by
3480	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4691	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3481	than enough. If you need to manage thousands of children you might want to	4692	usually more than enough. If you need to manage thousands of children you
3482	increase this value (I<must> be a power of two).	4693	might want to increase this value (I<must> be a power of two).
3483		4694
3484	=item EV_INOTIFY_HASHSIZE	4695	=item EV_INOTIFY_HASHSIZE
3485		4696
3486	C<ev_stat> watchers use a small hash table to distribute workload by	4697	C<ev_stat> watchers use a small hash table to distribute workload by
3487	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4698	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3488	usually more than enough. If you need to manage thousands of C<ev_stat>	4699	disabled), usually more than enough. If you need to manage thousands of
3489	watchers you might want to increase this value (I<must> be a power of	4700	C<ev_stat> watchers you might want to increase this value (I<must> be a
3490	two).	4701	power of two).
3491		4702
3492	=item EV_USE_4HEAP	4703	=item EV_USE_4HEAP
3493		4704
3494	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4705	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3495	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4706	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3496	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4707	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3497	faster performance with many (thousands) of watchers.	4708	faster performance with many (thousands) of watchers.
3498		4709
3499	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4710	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3500	(disabled).	4711	will be C<0>.
3501		4712
3502	=item EV_HEAP_CACHE_AT	4713	=item EV_HEAP_CACHE_AT
3503		4714
3504	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4715	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3505	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4716	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3506	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4717	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3507	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4718	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3508	but avoids random read accesses on heap changes. This improves performance	4719	but avoids random read accesses on heap changes. This improves performance
3509	noticeably with many (hundreds) of watchers.	4720	noticeably with many (hundreds) of watchers.
3510		4721
3511	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4722	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3512	(disabled).	4723	will be C<0>.
3513		4724
3514	=item EV_VERIFY	4725	=item EV_VERIFY
3515		4726
3516	Controls how much internal verification (see C<ev_loop_verify ()>) will	4727	Controls how much internal verification (see C<ev_verify ()>) will
3517	be done: If set to C<0>, no internal verification code will be compiled	4728	be done: If set to C<0>, no internal verification code will be compiled
3518	in. If set to C<1>, then verification code will be compiled in, but not	4729	in. If set to C<1>, then verification code will be compiled in, but not
3519	called. If set to C<2>, then the internal verification code will be	4730	called. If set to C<2>, then the internal verification code will be
3520	called once per loop, which can slow down libev. If set to C<3>, then the	4731	called once per loop, which can slow down libev. If set to C<3>, then the
3521	verification code will be called very frequently, which will slow down	4732	verification code will be called very frequently, which will slow down
3522	libev considerably.	4733	libev considerably.
3523		4734
3524	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4735	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3525	C<0>.	4736	will be C<0>.
3526		4737
3527	=item EV_COMMON	4738	=item EV_COMMON
3528		4739
3529	By default, all watchers have a C<void *data> member. By redefining	4740	By default, all watchers have a C<void *data> member. By redefining
3530	this macro to a something else you can include more and other types of	4741	this macro to something else you can include more and other types of
3531	members. You have to define it each time you include one of the files,	4742	members. You have to define it each time you include one of the files,
3532	though, and it must be identical each time.	4743	though, and it must be identical each time.
3533		4744
3534	For example, the perl EV module uses something like this:	4745	For example, the perl EV module uses something like this:
3535		4746
…		…
3588	file.	4799	file.
3589		4800
3590	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4801	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3591	that everybody includes and which overrides some configure choices:	4802	that everybody includes and which overrides some configure choices:
3592		4803
3593	#define EV_MINIMAL 1	4804	#define EV_FEATURES 8
3594	#define EV_USE_POLL 0	4805	#define EV_USE_SELECT 1
3595	#define EV_MULTIPLICITY 0
3596	#define EV_PERIODIC_ENABLE 0	4806	#define EV_PREPARE_ENABLE 1
		4807	#define EV_IDLE_ENABLE 1
3597	#define EV_STAT_ENABLE 0	4808	#define EV_SIGNAL_ENABLE 1
3598	#define EV_FORK_ENABLE 0	4809	#define EV_CHILD_ENABLE 1
		4810	#define EV_USE_STDEXCEPT 0
3599	#define EV_CONFIG_H <config.h>	4811	#define EV_CONFIG_H <config.h>
3600	#define EV_MINPRI 0
3601	#define EV_MAXPRI 0
3602		4812
3603	#include "ev++.h"	4813	#include "ev++.h"
3604		4814
3605	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4815	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3606		4816
3607	#include "ev_cpp.h"	4817	#include "ev_cpp.h"
3608	#include "ev.c"	4818	#include "ev.c"
3609		4819
3610	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4820	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3611		4821
3612	=head2 THREADS AND COROUTINES	4822	=head2 THREADS AND COROUTINES
3613		4823
3614	=head3 THREADS	4824	=head3 THREADS
3615		4825
…		…
3666	default loop and triggering an C<ev_async> watcher from the default loop	4876	default loop and triggering an C<ev_async> watcher from the default loop
3667	watcher callback into the event loop interested in the signal.	4877	watcher callback into the event loop interested in the signal.
3668		4878
3669	=back	4879	=back
3670		4880
		4881	See also L<THREAD LOCKING EXAMPLE>.
		4882
3671	=head3 COROUTINES	4883	=head3 COROUTINES
3672		4884
3673	Libev is very accommodating to coroutines ("cooperative threads"):	4885	Libev is very accommodating to coroutines ("cooperative threads"):
3674	libev fully supports nesting calls to its functions from different	4886	libev fully supports nesting calls to its functions from different
3675	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4887	coroutines (e.g. you can call C<ev_run> on the same loop from two
3676	different coroutines, and switch freely between both coroutines running the	4888	different coroutines, and switch freely between both coroutines running
3677	loop, as long as you don't confuse yourself). The only exception is that	4889	the loop, as long as you don't confuse yourself). The only exception is
3678	you must not do this from C<ev_periodic> reschedule callbacks.	4890	that you must not do this from C<ev_periodic> reschedule callbacks.
3679		4891
3680	Care has been taken to ensure that libev does not keep local state inside	4892	Care has been taken to ensure that libev does not keep local state inside
3681	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4893	C<ev_run>, and other calls do not usually allow for coroutine switches as
3682	they do not call any callbacks.	4894	they do not call any callbacks.
3683		4895
3684	=head2 COMPILER WARNINGS	4896	=head2 COMPILER WARNINGS
3685		4897
3686	Depending on your compiler and compiler settings, you might get no or a	4898	Depending on your compiler and compiler settings, you might get no or a
…		…
3697	maintainable.	4909	maintainable.
3698		4910
3699	And of course, some compiler warnings are just plain stupid, or simply	4911	And of course, some compiler warnings are just plain stupid, or simply
3700	wrong (because they don't actually warn about the condition their message	4912	wrong (because they don't actually warn about the condition their message
3701	seems to warn about). For example, certain older gcc versions had some	4913	seems to warn about). For example, certain older gcc versions had some
3702	warnings that resulted an extreme number of false positives. These have	4914	warnings that resulted in an extreme number of false positives. These have
3703	been fixed, but some people still insist on making code warn-free with	4915	been fixed, but some people still insist on making code warn-free with
3704	such buggy versions.	4916	such buggy versions.
3705		4917
3706	While libev is written to generate as few warnings as possible,	4918	While libev is written to generate as few warnings as possible,
3707	"warn-free" code is not a goal, and it is recommended not to build libev	4919	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
3743	I suggest using suppression lists.	4955	I suggest using suppression lists.
3744		4956
3745		4957
3746	=head1 PORTABILITY NOTES	4958	=head1 PORTABILITY NOTES
3747		4959
		4960	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4961
		4962	GNU/Linux is the only common platform that supports 64 bit file/large file
		4963	interfaces but I<disables> them by default.
		4964
		4965	That means that libev compiled in the default environment doesn't support
		4966	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4967
		4968	Unfortunately, many programs try to work around this GNU/Linux issue
		4969	by enabling the large file API, which makes them incompatible with the
		4970	standard libev compiled for their system.
		4971
		4972	Likewise, libev cannot enable the large file API itself as this would
		4973	suddenly make it incompatible to the default compile time environment,
		4974	i.e. all programs not using special compile switches.
		4975
		4976	=head2 OS/X AND DARWIN BUGS
		4977
		4978	The whole thing is a bug if you ask me - basically any system interface
		4979	you touch is broken, whether it is locales, poll, kqueue or even the
		4980	OpenGL drivers.
		4981
		4982	=head3 C<kqueue> is buggy
		4983
		4984	The kqueue syscall is broken in all known versions - most versions support
		4985	only sockets, many support pipes.
		4986
		4987	Libev tries to work around this by not using C<kqueue> by default on this
		4988	rotten platform, but of course you can still ask for it when creating a
		4989	loop - embedding a socket-only kqueue loop into a select-based one is
		4990	probably going to work well.
		4991
		4992	=head3 C<poll> is buggy
		4993
		4994	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4995	implementation by something calling C<kqueue> internally around the 10.5.6
		4996	release, so now C<kqueue> I<and> C<poll> are broken.
		4997
		4998	Libev tries to work around this by not using C<poll> by default on
		4999	this rotten platform, but of course you can still ask for it when creating
		5000	a loop.
		5001
		5002	=head3 C<select> is buggy
		5003
		5004	All that's left is C<select>, and of course Apple found a way to fuck this
		5005	one up as well: On OS/X, C<select> actively limits the number of file
		5006	descriptors you can pass in to 1024 - your program suddenly crashes when
		5007	you use more.
		5008
		5009	There is an undocumented "workaround" for this - defining
		5010	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		5011	work on OS/X.
		5012
		5013	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		5014
		5015	=head3 C<errno> reentrancy
		5016
		5017	The default compile environment on Solaris is unfortunately so
		5018	thread-unsafe that you can't even use components/libraries compiled
		5019	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		5020	defined by default. A valid, if stupid, implementation choice.
		5021
		5022	If you want to use libev in threaded environments you have to make sure
		5023	it's compiled with C<_REENTRANT> defined.
		5024
		5025	=head3 Event port backend
		5026
		5027	The scalable event interface for Solaris is called "event
		5028	ports". Unfortunately, this mechanism is very buggy in all major
		5029	releases. If you run into high CPU usage, your program freezes or you get
		5030	a large number of spurious wakeups, make sure you have all the relevant
		5031	and latest kernel patches applied. No, I don't know which ones, but there
		5032	are multiple ones to apply, and afterwards, event ports actually work
		5033	great.
		5034
		5035	If you can't get it to work, you can try running the program by setting
		5036	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		5037	C<select> backends.
		5038
		5039	=head2 AIX POLL BUG
		5040
		5041	AIX unfortunately has a broken C<poll.h> header. Libev works around
		5042	this by trying to avoid the poll backend altogether (i.e. it's not even
		5043	compiled in), which normally isn't a big problem as C<select> works fine
		5044	with large bitsets on AIX, and AIX is dead anyway.
		5045
3748	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	5046	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		5047
		5048	=head3 General issues
3749		5049
3750	Win32 doesn't support any of the standards (e.g. POSIX) that libev	5050	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3751	requires, and its I/O model is fundamentally incompatible with the POSIX	5051	requires, and its I/O model is fundamentally incompatible with the POSIX
3752	model. Libev still offers limited functionality on this platform in	5052	model. Libev still offers limited functionality on this platform in
3753	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5053	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3754	descriptors. This only applies when using Win32 natively, not when using	5054	descriptors. This only applies when using Win32 natively, not when using
3755	e.g. cygwin.	5055	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		5056	as every compiler comes with a slightly differently broken/incompatible
		5057	environment.
3756		5058
3757	Lifting these limitations would basically require the full	5059	Lifting these limitations would basically require the full
3758	re-implementation of the I/O system. If you are into these kinds of	5060	re-implementation of the I/O system. If you are into this kind of thing,
3759	things, then note that glib does exactly that for you in a very portable	5061	then note that glib does exactly that for you in a very portable way (note
3760	way (note also that glib is the slowest event library known to man).	5062	also that glib is the slowest event library known to man).
3761		5063
3762	There is no supported compilation method available on windows except	5064	There is no supported compilation method available on windows except
3763	embedding it into other applications.	5065	embedding it into other applications.
		5066
		5067	Sensible signal handling is officially unsupported by Microsoft - libev
		5068	tries its best, but under most conditions, signals will simply not work.
3764		5069
3765	Not a libev limitation but worth mentioning: windows apparently doesn't	5070	Not a libev limitation but worth mentioning: windows apparently doesn't
3766	accept large writes: instead of resulting in a partial write, windows will	5071	accept large writes: instead of resulting in a partial write, windows will
3767	either accept everything or return C<ENOBUFS> if the buffer is too large,	5072	either accept everything or return C<ENOBUFS> if the buffer is too large,
3768	so make sure you only write small amounts into your sockets (less than a	5073	so make sure you only write small amounts into your sockets (less than a
…		…
3773	the abysmal performance of winsockets, using a large number of sockets	5078	the abysmal performance of winsockets, using a large number of sockets
3774	is not recommended (and not reasonable). If your program needs to use	5079	is not recommended (and not reasonable). If your program needs to use
3775	more than a hundred or so sockets, then likely it needs to use a totally	5080	more than a hundred or so sockets, then likely it needs to use a totally
3776	different implementation for windows, as libev offers the POSIX readiness	5081	different implementation for windows, as libev offers the POSIX readiness
3777	notification model, which cannot be implemented efficiently on windows	5082	notification model, which cannot be implemented efficiently on windows
3778	(Microsoft monopoly games).	5083	(due to Microsoft monopoly games).
3779		5084
3780	A typical way to use libev under windows is to embed it (see the embedding	5085	A typical way to use libev under windows is to embed it (see the embedding
3781	section for details) and use the following F<evwrap.h> header file instead	5086	section for details) and use the following F<evwrap.h> header file instead
3782	of F<ev.h>:	5087	of F<ev.h>:
3783		5088
…		…
3790	you do I<not> compile the F<ev.c> or any other embedded source files!):	5095	you do I<not> compile the F<ev.c> or any other embedded source files!):
3791		5096
3792	#include "evwrap.h"	5097	#include "evwrap.h"
3793	#include "ev.c"	5098	#include "ev.c"
3794		5099
3795	=over 4
3796
3797	=item The winsocket select function	5100	=head3 The winsocket C<select> function
3798		5101
3799	The winsocket C<select> function doesn't follow POSIX in that it	5102	The winsocket C<select> function doesn't follow POSIX in that it
3800	requires socket I<handles> and not socket I<file descriptors> (it is	5103	requires socket I<handles> and not socket I<file descriptors> (it is
3801	also extremely buggy). This makes select very inefficient, and also	5104	also extremely buggy). This makes select very inefficient, and also
3802	requires a mapping from file descriptors to socket handles (the Microsoft	5105	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
3811	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	5114	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3812		5115
3813	Note that winsockets handling of fd sets is O(n), so you can easily get a	5116	Note that winsockets handling of fd sets is O(n), so you can easily get a
3814	complexity in the O(n²) range when using win32.	5117	complexity in the O(n²) range when using win32.
3815		5118
3816	=item Limited number of file descriptors	5119	=head3 Limited number of file descriptors
3817		5120
3818	Windows has numerous arbitrary (and low) limits on things.	5121	Windows has numerous arbitrary (and low) limits on things.
3819		5122
3820	Early versions of winsocket's select only supported waiting for a maximum	5123	Early versions of winsocket's select only supported waiting for a maximum
3821	of C<64> handles (probably owning to the fact that all windows kernels	5124	of C<64> handles (probably owning to the fact that all windows kernels
3822	can only wait for C<64> things at the same time internally; Microsoft	5125	can only wait for C<64> things at the same time internally; Microsoft
3823	recommends spawning a chain of threads and wait for 63 handles and the	5126	recommends spawning a chain of threads and wait for 63 handles and the
3824	previous thread in each. Great).	5127	previous thread in each. Sounds great!).
3825		5128
3826	Newer versions support more handles, but you need to define C<FD_SETSIZE>	5129	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3827	to some high number (e.g. C<2048>) before compiling the winsocket select	5130	to some high number (e.g. C<2048>) before compiling the winsocket select
3828	call (which might be in libev or elsewhere, for example, perl does its own	5131	call (which might be in libev or elsewhere, for example, perl and many
3829	select emulation on windows).	5132	other interpreters do their own select emulation on windows).
3830		5133
3831	Another limit is the number of file descriptors in the Microsoft runtime	5134	Another limit is the number of file descriptors in the Microsoft runtime
3832	libraries, which by default is C<64> (there must be a hidden I<64> fetish	5135	libraries, which by default is C<64> (there must be a hidden I<64>
3833	or something like this inside Microsoft). You can increase this by calling	5136	fetish or something like this inside Microsoft). You can increase this
3834	C<_setmaxstdio>, which can increase this limit to C<2048> (another	5137	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3835	arbitrary limit), but is broken in many versions of the Microsoft runtime	5138	(another arbitrary limit), but is broken in many versions of the Microsoft
3836	libraries.
3837
3838	This might get you to about C<512> or C<2048> sockets (depending on	5139	runtime libraries. This might get you to about C<512> or C<2048> sockets
3839	windows version and/or the phase of the moon). To get more, you need to	5140	(depending on windows version and/or the phase of the moon). To get more,
3840	wrap all I/O functions and provide your own fd management, but the cost of	5141	you need to wrap all I/O functions and provide your own fd management, but
3841	calling select (O(n²)) will likely make this unworkable.	5142	the cost of calling select (O(n²)) will likely make this unworkable.
3842
3843	=back
3844		5143
3845	=head2 PORTABILITY REQUIREMENTS	5144	=head2 PORTABILITY REQUIREMENTS
3846		5145
3847	In addition to a working ISO-C implementation and of course the	5146	In addition to a working ISO-C implementation and of course the
3848	backend-specific APIs, libev relies on a few additional extensions:	5147	backend-specific APIs, libev relies on a few additional extensions:
…		…
3855	Libev assumes not only that all watcher pointers have the same internal	5154	Libev assumes not only that all watcher pointers have the same internal
3856	structure (guaranteed by POSIX but not by ISO C for example), but it also	5155	structure (guaranteed by POSIX but not by ISO C for example), but it also
3857	assumes that the same (machine) code can be used to call any watcher	5156	assumes that the same (machine) code can be used to call any watcher
3858	callback: The watcher callbacks have different type signatures, but libev	5157	callback: The watcher callbacks have different type signatures, but libev
3859	calls them using an C<ev_watcher *> internally.	5158	calls them using an C<ev_watcher *> internally.
		5159
		5160	=item pointer accesses must be thread-atomic
		5161
		5162	Accessing a pointer value must be atomic, it must both be readable and
		5163	writable in one piece - this is the case on all current architectures.
3860		5164
3861	=item C<sig_atomic_t volatile> must be thread-atomic as well	5165	=item C<sig_atomic_t volatile> must be thread-atomic as well
3862		5166
3863	The type C<sig_atomic_t volatile> (or whatever is defined as	5167	The type C<sig_atomic_t volatile> (or whatever is defined as
3864	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5168	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
3887	watchers.	5191	watchers.
3888		5192
3889	=item C<double> must hold a time value in seconds with enough accuracy	5193	=item C<double> must hold a time value in seconds with enough accuracy
3890		5194
3891	The type C<double> is used to represent timestamps. It is required to	5195	The type C<double> is used to represent timestamps. It is required to
3892	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5196	have at least 51 bits of mantissa (and 9 bits of exponent), which is
3893	enough for at least into the year 4000. This requirement is fulfilled by	5197	good enough for at least into the year 4000 with millisecond accuracy
		5198	(the design goal for libev). This requirement is overfulfilled by
3894	implementations implementing IEEE 754 (basically all existing ones).	5199	implementations using IEEE 754, which is basically all existing ones.
		5200
		5201	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5202	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5203	is either obsolete or somebody patched it to use C<long double> or
		5204	something like that, just kidding).
3895		5205
3896	=back	5206	=back
3897		5207
3898	If you know of other additional requirements drop me a note.	5208	If you know of other additional requirements drop me a note.
3899		5209
…		…
3961	=item Processing ev_async_send: O(number_of_async_watchers)	5271	=item Processing ev_async_send: O(number_of_async_watchers)
3962		5272
3963	=item Processing signals: O(max_signal_number)	5273	=item Processing signals: O(max_signal_number)
3964		5274
3965	Sending involves a system call I<iff> there were no other C<ev_async_send>	5275	Sending involves a system call I<iff> there were no other C<ev_async_send>
3966	calls in the current loop iteration. Checking for async and signal events	5276	calls in the current loop iteration and the loop is currently
		5277	blocked. Checking for async and signal events involves iterating over all
3967	involves iterating over all running async watchers or all signal numbers.	5278	running async watchers or all signal numbers.
3968		5279
3969	=back	5280	=back
3970		5281
3971		5282
		5283	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5284
		5285	The major version 4 introduced some incompatible changes to the API.
		5286
		5287	At the moment, the C<ev.h> header file provides compatibility definitions
		5288	for all changes, so most programs should still compile. The compatibility
		5289	layer might be removed in later versions of libev, so better update to the
		5290	new API early than late.
		5291
		5292	=over 4
		5293
		5294	=item C<EV_COMPAT3> backwards compatibility mechanism
		5295
		5296	The backward compatibility mechanism can be controlled by
		5297	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5298	section.
		5299
		5300	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5301
		5302	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5303
		5304	ev_loop_destroy (EV_DEFAULT_UC);
		5305	ev_loop_fork (EV_DEFAULT);
		5306
		5307	=item function/symbol renames
		5308
		5309	A number of functions and symbols have been renamed:
		5310
		5311	ev_loop => ev_run
		5312	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5313	EVLOOP_ONESHOT => EVRUN_ONCE
		5314
		5315	ev_unloop => ev_break
		5316	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5317	EVUNLOOP_ONE => EVBREAK_ONE
		5318	EVUNLOOP_ALL => EVBREAK_ALL
		5319
		5320	EV_TIMEOUT => EV_TIMER
		5321
		5322	ev_loop_count => ev_iteration
		5323	ev_loop_depth => ev_depth
		5324	ev_loop_verify => ev_verify
		5325
		5326	Most functions working on C<struct ev_loop> objects don't have an
		5327	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5328	associated constants have been renamed to not collide with the C<struct
		5329	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5330	as all other watcher types. Note that C<ev_loop_fork> is still called
		5331	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5332	typedef.
		5333
		5334	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5335
		5336	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5337	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5338	and work, but the library code will of course be larger.
		5339
		5340	=back
		5341
		5342
		5343	=head1 GLOSSARY
		5344
		5345	=over 4
		5346
		5347	=item active
		5348
		5349	A watcher is active as long as it has been started and not yet stopped.
		5350	See L<WATCHER STATES> for details.
		5351
		5352	=item application
		5353
		5354	In this document, an application is whatever is using libev.
		5355
		5356	=item backend
		5357
		5358	The part of the code dealing with the operating system interfaces.
		5359
		5360	=item callback
		5361
		5362	The address of a function that is called when some event has been
		5363	detected. Callbacks are being passed the event loop, the watcher that
		5364	received the event, and the actual event bitset.
		5365
		5366	=item callback/watcher invocation
		5367
		5368	The act of calling the callback associated with a watcher.
		5369
		5370	=item event
		5371
		5372	A change of state of some external event, such as data now being available
		5373	for reading on a file descriptor, time having passed or simply not having
		5374	any other events happening anymore.
		5375
		5376	In libev, events are represented as single bits (such as C<EV_READ> or
		5377	C<EV_TIMER>).
		5378
		5379	=item event library
		5380
		5381	A software package implementing an event model and loop.
		5382
		5383	=item event loop
		5384
		5385	An entity that handles and processes external events and converts them
		5386	into callback invocations.
		5387
		5388	=item event model
		5389
		5390	The model used to describe how an event loop handles and processes
		5391	watchers and events.
		5392
		5393	=item pending
		5394
		5395	A watcher is pending as soon as the corresponding event has been
		5396	detected. See L<WATCHER STATES> for details.
		5397
		5398	=item real time
		5399
		5400	The physical time that is observed. It is apparently strictly monotonic :)
		5401
		5402	=item wall-clock time
		5403
		5404	The time and date as shown on clocks. Unlike real time, it can actually
		5405	be wrong and jump forwards and backwards, e.g. when you adjust your
		5406	clock.
		5407
		5408	=item watcher
		5409
		5410	A data structure that describes interest in certain events. Watchers need
		5411	to be started (attached to an event loop) before they can receive events.
		5412
		5413	=back
		5414
3972	=head1 AUTHOR	5415	=head1 AUTHOR
3973		5416
3974	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5417	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5418	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
3975		5419

Diff Legend

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