ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.144 by root, Mon Apr 7 12:33:29 2008 UTC vs.
Revision 1.230 by root, Wed Apr 15 18:47:07 2009 UTC

…		…
2		2
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
		14	#include <stdio.h> // for puts
		15
14	// every watcher type has its own typedef'd struct	16	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	17	// with the name ev_TYPE
16	ev_io stdin_watcher;	18	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
18		20
19	// all watcher callbacks have a similar signature	21	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	22	// this callback is called when data is readable on stdin
21	static void	23	static void
22	stdin_cb (EV_P_ struct ev_io *w, int revents)	24	stdin_cb (EV_P_ ev_io *w, int revents)
23	{	25	{
24	puts ("stdin ready");	26	puts ("stdin ready");
25	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
26	// with its corresponding stop function.	28	// with its corresponding stop function.
27	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
28		30
29	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_loop's to stop iterating
30	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_unloop (EV_A_ EVUNLOOP_ALL);
31	}	33	}
32		34
33	// another callback, this time for a time-out	35	// another callback, this time for a time-out
34	static void	36	static void
35	timeout_cb (EV_P_ struct ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
36	{	38	{
37	puts ("timeout");	39	puts ("timeout");
38	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_loop to stop iterating
39	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_unloop (EV_A_ EVUNLOOP_ONE);
40	}	42	}
41		43
42	int	44	int
43	main (void)	45	main (void)
44	{	46	{
45	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
46	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = ev_default_loop (0);
47		49
48	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
49	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
51	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
52		54
53	// initialise a timer watcher, then start it	55	// initialise a timer watcher, then start it
54	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
56	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
57		59
58	// now wait for events to arrive	60	// now wait for events to arrive
59	ev_loop (loop, 0);	61	ev_loop (loop, 0);
60		62
61	// unloop was called, so exit	63	// unloop was called, so exit
62	return 0;	64	return 0;
63	}	65	}
64		66
65	=head1 DESCRIPTION	67	=head1 DESCRIPTION
66		68
67	The newest version of this document is also available as an html-formatted	69	The newest version of this document is also available as an html-formatted
68	web page you might find easier to navigate when reading it for the first	70	web page you might find easier to navigate when reading it for the first
69	time: L<http://cvs.schmorp.de/libev/ev.html>.	71	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
70		72
71	Libev is an event loop: you register interest in certain events (such as a	73	Libev is an event loop: you register interest in certain events (such as a
72	file descriptor being readable or a timeout occurring), and it will manage	74	file descriptor being readable or a timeout occurring), and it will manage
73	these event sources and provide your program with events.	75	these event sources and provide your program with events.
74		76
…		…
103	Libev is very configurable. In this manual the default (and most common)	105	Libev is very configurable. In this manual the default (and most common)
104	configuration will be described, which supports multiple event loops. For	106	configuration will be described, which supports multiple event loops. For
105	more info about various configuration options please have a look at	107	more info about various configuration options please have a look at
106	B<EMBED> section in this manual. If libev was configured without support	108	B<EMBED> section in this manual. If libev was configured without support
107	for multiple event loops, then all functions taking an initial argument of	109	for multiple event loops, then all functions taking an initial argument of
108	name C<loop> (which is always of type C<struct ev_loop *>) will not have	110	name C<loop> (which is always of type C<ev_loop *>) will not have
109	this argument.	111	this argument.
110		112
111	=head2 TIME REPRESENTATION	113	=head2 TIME REPRESENTATION
112		114
113	Libev represents time as a single floating point number, representing the	115	Libev represents time as a single floating point number, representing the
114	(fractional) number of seconds since the (POSIX) epoch (somewhere near	116	(fractional) number of seconds since the (POSIX) epoch (somewhere near
115	the beginning of 1970, details are complicated, don't ask). This type is	117	the beginning of 1970, details are complicated, don't ask). This type is
116	called C<ev_tstamp>, which is what you should use too. It usually aliases	118	called C<ev_tstamp>, which is what you should use too. It usually aliases
117	to the C<double> type in C, and when you need to do any calculations on	119	to the C<double> type in C, and when you need to do any calculations on
118	it, you should treat it as some floatingpoint value. Unlike the name	120	it, you should treat it as some floating point value. Unlike the name
119	component C<stamp> might indicate, it is also used for time differences	121	component C<stamp> might indicate, it is also used for time differences
120	throughout libev.	122	throughout libev.
		123
		124	=head1 ERROR HANDLING
		125
		126	Libev knows three classes of errors: operating system errors, usage errors
		127	and internal errors (bugs).
		128
		129	When libev catches an operating system error it cannot handle (for example
		130	a system call indicating a condition libev cannot fix), it calls the callback
		131	set via C<ev_set_syserr_cb>, which is supposed to fix the problem or
		132	abort. The default is to print a diagnostic message and to call C<abort
		133	()>.
		134
		135	When libev detects a usage error such as a negative timer interval, then
		136	it will print a diagnostic message and abort (via the C<assert> mechanism,
		137	so C<NDEBUG> will disable this checking): these are programming errors in
		138	the libev caller and need to be fixed there.
		139
		140	Libev also has a few internal error-checking C<assert>ions, and also has
		141	extensive consistency checking code. These do not trigger under normal
		142	circumstances, as they indicate either a bug in libev or worse.
		143
121		144
122	=head1 GLOBAL FUNCTIONS	145	=head1 GLOBAL FUNCTIONS
123		146
124	These functions can be called anytime, even before initialising the	147	These functions can be called anytime, even before initialising the
125	library in any way.	148	library in any way.
…		…
134		157
135	=item ev_sleep (ev_tstamp interval)	158	=item ev_sleep (ev_tstamp interval)
136		159
137	Sleep for the given interval: The current thread will be blocked until	160	Sleep for the given interval: The current thread will be blocked until
138	either it is interrupted or the given time interval has passed. Basically	161	either it is interrupted or the given time interval has passed. Basically
139	this is a subsecond-resolution C<sleep ()>.	162	this is a sub-second-resolution C<sleep ()>.
140		163
141	=item int ev_version_major ()	164	=item int ev_version_major ()
142		165
143	=item int ev_version_minor ()	166	=item int ev_version_minor ()
144		167
…		…
157	not a problem.	180	not a problem.
158		181
159	Example: Make sure we haven't accidentally been linked against the wrong	182	Example: Make sure we haven't accidentally been linked against the wrong
160	version.	183	version.
161		184
162	assert (("libev version mismatch",	185	assert (("libev version mismatch",
163	ev_version_major () == EV_VERSION_MAJOR	186	ev_version_major () == EV_VERSION_MAJOR
164	&& ev_version_minor () >= EV_VERSION_MINOR));	187	&& ev_version_minor () >= EV_VERSION_MINOR));
165		188
166	=item unsigned int ev_supported_backends ()	189	=item unsigned int ev_supported_backends ()
167		190
168	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	191	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
169	value) compiled into this binary of libev (independent of their	192	value) compiled into this binary of libev (independent of their
…		…
171	a description of the set values.	194	a description of the set values.
172		195
173	Example: make sure we have the epoll method, because yeah this is cool and	196	Example: make sure we have the epoll method, because yeah this is cool and
174	a must have and can we have a torrent of it please!!!11	197	a must have and can we have a torrent of it please!!!11
175		198
176	assert (("sorry, no epoll, no sex",	199	assert (("sorry, no epoll, no sex",
177	ev_supported_backends () & EVBACKEND_EPOLL));	200	ev_supported_backends () & EVBACKEND_EPOLL));
178		201
179	=item unsigned int ev_recommended_backends ()	202	=item unsigned int ev_recommended_backends ()
180		203
181	Return the set of all backends compiled into this binary of libev and also	204	Return the set of all backends compiled into this binary of libev and also
182	recommended for this platform. This set is often smaller than the one	205	recommended for this platform. This set is often smaller than the one
183	returned by C<ev_supported_backends>, as for example kqueue is broken on	206	returned by C<ev_supported_backends>, as for example kqueue is broken on
184	most BSDs and will not be autodetected unless you explicitly request it	207	most BSDs and will not be auto-detected unless you explicitly request it
185	(assuming you know what you are doing). This is the set of backends that	208	(assuming you know what you are doing). This is the set of backends that
186	libev will probe for if you specify no backends explicitly.	209	libev will probe for if you specify no backends explicitly.
187		210
188	=item unsigned int ev_embeddable_backends ()	211	=item unsigned int ev_embeddable_backends ()
189		212
…		…
193	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	216	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
194	recommended ones.	217	recommended ones.
195		218
196	See the description of C<ev_embed> watchers for more info.	219	See the description of C<ev_embed> watchers for more info.
197		220
198	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	221	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
199		222
200	Sets the allocation function to use (the prototype is similar - the	223	Sets the allocation function to use (the prototype is similar - the
201	semantics is identical - to the realloc C function). It is used to	224	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
202	allocate and free memory (no surprises here). If it returns zero when	225	used to allocate and free memory (no surprises here). If it returns zero
203	memory needs to be allocated, the library might abort or take some	226	when memory needs to be allocated (C<size != 0>), the library might abort
204	potentially destructive action. The default is your system realloc	227	or take some potentially destructive action.
205	function.	228
		229	Since some systems (at least OpenBSD and Darwin) fail to implement
		230	correct C<realloc> semantics, libev will use a wrapper around the system
		231	C<realloc> and C<free> functions by default.
206		232
207	You could override this function in high-availability programs to, say,	233	You could override this function in high-availability programs to, say,
208	free some memory if it cannot allocate memory, to use a special allocator,	234	free some memory if it cannot allocate memory, to use a special allocator,
209	or even to sleep a while and retry until some memory is available.	235	or even to sleep a while and retry until some memory is available.
210		236
211	Example: Replace the libev allocator with one that waits a bit and then	237	Example: Replace the libev allocator with one that waits a bit and then
212	retries).	238	retries (example requires a standards-compliant C<realloc>).
213		239
214	static void *	240	static void *
215	persistent_realloc (void *ptr, size_t size)	241	persistent_realloc (void *ptr, size_t size)
216	{	242	{
217	for (;;)	243	for (;;)
…		…
226	}	252	}
227		253
228	...	254	...
229	ev_set_allocator (persistent_realloc);	255	ev_set_allocator (persistent_realloc);
230		256
231	=item ev_set_syserr_cb (void (*cb)(const char *msg));	257	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
232		258
233	Set the callback function to call on a retryable syscall error (such	259	Set the callback function to call on a retryable system call error (such
234	as failed select, poll, epoll_wait). The message is a printable string	260	as failed select, poll, epoll_wait). The message is a printable string
235	indicating the system call or subsystem causing the problem. If this	261	indicating the system call or subsystem causing the problem. If this
236	callback is set, then libev will expect it to remedy the sitution, no	262	callback is set, then libev will expect it to remedy the situation, no
237	matter what, when it returns. That is, libev will generally retry the	263	matter what, when it returns. That is, libev will generally retry the
238	requested operation, or, if the condition doesn't go away, do bad stuff	264	requested operation, or, if the condition doesn't go away, do bad stuff
239	(such as abort).	265	(such as abort).
240		266
241	Example: This is basically the same thing that libev does internally, too.	267	Example: This is basically the same thing that libev does internally, too.
…		…
252		278
253	=back	279	=back
254		280
255	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	281	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
256		282
257	An event loop is described by a C<struct ev_loop *>. The library knows two	283	An event loop is described by a C<struct ev_loop *> (the C<struct>
258	types of such loops, the I<default> loop, which supports signals and child	284	is I<not> optional in this case, as there is also an C<ev_loop>
259	events, and dynamically created loops which do not.	285	I<function>).
		286
		287	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
		289	not.
260		290
261	=over 4	291	=over 4
262		292
263	=item struct ev_loop *ev_default_loop (unsigned int flags)	293	=item struct ev_loop *ev_default_loop (unsigned int flags)
264		294
…		…
270	If you don't know what event loop to use, use the one returned from this	300	If you don't know what event loop to use, use the one returned from this
271	function.	301	function.
272		302
273	Note that this function is I<not> thread-safe, so if you want to use it	303	Note that this function is I<not> thread-safe, so if you want to use it
274	from multiple threads, you have to lock (note also that this is unlikely,	304	from multiple threads, you have to lock (note also that this is unlikely,
275	as loops cannot bes hared easily between threads anyway).	305	as loops cannot be shared easily between threads anyway).
276		306
277	The default loop is the only loop that can handle C<ev_signal> and	307	The default loop is the only loop that can handle C<ev_signal> and
278	C<ev_child> watchers, and to do this, it always registers a handler	308	C<ev_child> watchers, and to do this, it always registers a handler
279	for C<SIGCHLD>. If this is a problem for your app you can either	309	for C<SIGCHLD>. If this is a problem for your application you can either
280	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	310	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
281	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	311	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
282	C<ev_default_init>.	312	C<ev_default_init>.
283		313
284	The flags argument can be used to specify special behaviour or specific	314	The flags argument can be used to specify special behaviour or specific
…		…
293	The default flags value. Use this if you have no clue (it's the right	323	The default flags value. Use this if you have no clue (it's the right
294	thing, believe me).	324	thing, believe me).
295		325
296	=item C<EVFLAG_NOENV>	326	=item C<EVFLAG_NOENV>
297		327
298	If this flag bit is ored into the flag value (or the program runs setuid	328	If this flag bit is or'ed into the flag value (or the program runs setuid
299	or setgid) then libev will I<not> look at the environment variable	329	or setgid) then libev will I<not> look at the environment variable
300	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	330	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
301	override the flags completely if it is found in the environment. This is	331	override the flags completely if it is found in the environment. This is
302	useful to try out specific backends to test their performance, or to work	332	useful to try out specific backends to test their performance, or to work
303	around bugs.	333	around bugs.
…		…
310		340
311	This works by calling C<getpid ()> on every iteration of the loop,	341	This works by calling C<getpid ()> on every iteration of the loop,
312	and thus this might slow down your event loop if you do a lot of loop	342	and thus this might slow down your event loop if you do a lot of loop
313	iterations and little real work, but is usually not noticeable (on my	343	iterations and little real work, but is usually not noticeable (on my
314	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	344	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
315	without a syscall and thus I<very> fast, but my GNU/Linux system also has	345	without a system call and thus I<very> fast, but my GNU/Linux system also has
316	C<pthread_atfork> which is even faster).	346	C<pthread_atfork> which is even faster).
317		347
318	The big advantage of this flag is that you can forget about fork (and	348	The big advantage of this flag is that you can forget about fork (and
319	forget about forgetting to tell libev about forking) when you use this	349	forget about forgetting to tell libev about forking) when you use this
320	flag.	350	flag.
321		351
322	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>	352	This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
323	environment variable.	353	environment variable.
324		354
325	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	355	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
326		356
327	This is your standard select(2) backend. Not I<completely> standard, as	357	This is your standard select(2) backend. Not I<completely> standard, as
…		…
329	but if that fails, expect a fairly low limit on the number of fds when	359	but if that fails, expect a fairly low limit on the number of fds when
330	using this backend. It doesn't scale too well (O(highest_fd)), but its	360	using this backend. It doesn't scale too well (O(highest_fd)), but its
331	usually the fastest backend for a low number of (low-numbered :) fds.	361	usually the fastest backend for a low number of (low-numbered :) fds.
332		362
333	To get good performance out of this backend you need a high amount of	363	To get good performance out of this backend you need a high amount of
334	parallelity (most of the file descriptors should be busy). If you are	364	parallelism (most of the file descriptors should be busy). If you are
335	writing a server, you should C<accept ()> in a loop to accept as many	365	writing a server, you should C<accept ()> in a loop to accept as many
336	connections as possible during one iteration. You might also want to have	366	connections as possible during one iteration. You might also want to have
337	a look at C<ev_set_io_collect_interval ()> to increase the amount of	367	a look at C<ev_set_io_collect_interval ()> to increase the amount of
338	readyness notifications you get per iteration.	368	readiness notifications you get per iteration.
		369
		370	This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
		371	C<writefds> set (and to work around Microsoft Windows bugs, also onto the
		372	C<exceptfds> set on that platform).
339		373
340	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	374	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
341		375
342	And this is your standard poll(2) backend. It's more complicated	376	And this is your standard poll(2) backend. It's more complicated
343	than select, but handles sparse fds better and has no artificial	377	than select, but handles sparse fds better and has no artificial
344	limit on the number of fds you can use (except it will slow down	378	limit on the number of fds you can use (except it will slow down
345	considerably with a lot of inactive fds). It scales similarly to select,	379	considerably with a lot of inactive fds). It scales similarly to select,
346	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for	380	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
347	performance tips.	381	performance tips.
348		382
		383	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		384	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
		385
349	=item C<EVBACKEND_EPOLL> (value 4, Linux)	386	=item C<EVBACKEND_EPOLL> (value 4, Linux)
350		387
351	For few fds, this backend is a bit little slower than poll and select,	388	For few fds, this backend is a bit little slower than poll and select,
352	but it scales phenomenally better. While poll and select usually scale	389	but it scales phenomenally better. While poll and select usually scale
353	like O(total_fds) where n is the total number of fds (or the highest fd),	390	like O(total_fds) where n is the total number of fds (or the highest fd),
354	epoll scales either O(1) or O(active_fds). The epoll design has a number	391	epoll scales either O(1) or O(active_fds).
355	of shortcomings, such as silently dropping events in some hard-to-detect	392
356	cases and requiring a syscall per fd change, no fork support and bad	393	The epoll mechanism deserves honorable mention as the most misdesigned
357	support for dup.	394	of the more advanced event mechanisms: mere annoyances include silently
		395	dropping file descriptors, requiring a system call per change per file
		396	descriptor (and unnecessary guessing of parameters), problems with dup and
		397	so on. The biggest issue is fork races, however - if a program forks then
		398	I<both> parent and child process have to recreate the epoll set, which can
		399	take considerable time (one syscall per file descriptor) and is of course
		400	hard to detect.
		401
		402	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		403	of course I<doesn't>, and epoll just loves to report events for totally
		404	I<different> file descriptors (even already closed ones, so one cannot
		405	even remove them from the set) than registered in the set (especially
		406	on SMP systems). Libev tries to counter these spurious notifications by
		407	employing an additional generation counter and comparing that against the
		408	events to filter out spurious ones, recreating the set when required.
358		409
359	While stopping, setting and starting an I/O watcher in the same iteration	410	While stopping, setting and starting an I/O watcher in the same iteration
360	will result in some caching, there is still a syscall per such incident	411	will result in some caching, there is still a system call per such
361	(because the fd could point to a different file description now), so its	412	incident (because the same I<file descriptor> could point to a different
362	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	413	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
363	very well if you register events for both fds.	414	file descriptors might not work very well if you register events for both
364		415	file descriptors.
365	Please note that epoll sometimes generates spurious notifications, so you
366	need to use non-blocking I/O or other means to avoid blocking when no data
367	(or space) is available.
368		416
369	Best performance from this backend is achieved by not unregistering all	417	Best performance from this backend is achieved by not unregistering all
370	watchers for a file descriptor until it has been closed, if possible, i.e.	418	watchers for a file descriptor until it has been closed, if possible,
371	keep at least one watcher active per fd at all times.	419	i.e. keep at least one watcher active per fd at all times. Stopping and
		420	starting a watcher (without re-setting it) also usually doesn't cause
		421	extra overhead. A fork can both result in spurious notifications as well
		422	as in libev having to destroy and recreate the epoll object, which can
		423	take considerable time and thus should be avoided.
372		424
		425	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		426	faster than epoll for maybe up to a hundred file descriptors, depending on
		427	the usage. So sad.
		428
373	While nominally embeddeble in other event loops, this feature is broken in	429	While nominally embeddable in other event loops, this feature is broken in
374	all kernel versions tested so far.	430	all kernel versions tested so far.
		431
		432	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		433	C<EVBACKEND_POLL>.
375		434
376	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	435	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
377		436
378	Kqueue deserves special mention, as at the time of this writing, it	437	Kqueue deserves special mention, as at the time of this writing, it
379	was broken on all BSDs except NetBSD (usually it doesn't work reliably	438	was broken on all BSDs except NetBSD (usually it doesn't work reliably
380	with anything but sockets and pipes, except on Darwin, where of course	439	with anything but sockets and pipes, except on Darwin, where of course
381	it's completely useless). For this reason it's not being "autodetected"	440	it's completely useless). Unlike epoll, however, whose brokenness
		441	is by design, these kqueue bugs can (and eventually will) be fixed
		442	without API changes to existing programs. For this reason it's not being
382	unless you explicitly specify it explicitly in the flags (i.e. using	443	"auto-detected" unless you explicitly specify it in the flags (i.e. using
383	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	444	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
384	system like NetBSD.	445	system like NetBSD.
385		446
386	You still can embed kqueue into a normal poll or select backend and use it	447	You still can embed kqueue into a normal poll or select backend and use it
387	only for sockets (after having made sure that sockets work with kqueue on	448	only for sockets (after having made sure that sockets work with kqueue on
388	the target platform). See C<ev_embed> watchers for more info.	449	the target platform). See C<ev_embed> watchers for more info.
389		450
390	It scales in the same way as the epoll backend, but the interface to the	451	It scales in the same way as the epoll backend, but the interface to the
391	kernel is more efficient (which says nothing about its actual speed, of	452	kernel is more efficient (which says nothing about its actual speed, of
392	course). While stopping, setting and starting an I/O watcher does never	453	course). While stopping, setting and starting an I/O watcher does never
393	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to	454	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
394	two event changes per incident, support for C<fork ()> is very bad and it	455	two event changes per incident. Support for C<fork ()> is very bad (but
395	drops fds silently in similarly hard-to-detect cases.	456	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		457	cases
396		458
397	This backend usually performs well under most conditions.	459	This backend usually performs well under most conditions.
398		460
399	While nominally embeddable in other event loops, this doesn't work	461	While nominally embeddable in other event loops, this doesn't work
400	everywhere, so you might need to test for this. And since it is broken	462	everywhere, so you might need to test for this. And since it is broken
401	almost everywhere, you should only use it when you have a lot of sockets	463	almost everywhere, you should only use it when you have a lot of sockets
402	(for which it usually works), by embedding it into another event loop	464	(for which it usually works), by embedding it into another event loop
403	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for	465	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
404	sockets.	466	also broken on OS X)) and, did I mention it, using it only for sockets.
		467
		468	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
		469	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
		470	C<NOTE_EOF>.
405		471
406	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	472	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
407		473
408	This is not implemented yet (and might never be, unless you send me an	474	This is not implemented yet (and might never be, unless you send me an
409	implementation). According to reports, C</dev/poll> only supports sockets	475	implementation). According to reports, C</dev/poll> only supports sockets
…		…
413	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	479	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
414		480
415	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	481	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
416	it's really slow, but it still scales very well (O(active_fds)).	482	it's really slow, but it still scales very well (O(active_fds)).
417		483
418	Please note that solaris event ports can deliver a lot of spurious	484	Please note that Solaris event ports can deliver a lot of spurious
419	notifications, so you need to use non-blocking I/O or other means to avoid	485	notifications, so you need to use non-blocking I/O or other means to avoid
420	blocking when no data (or space) is available.	486	blocking when no data (or space) is available.
421		487
422	While this backend scales well, it requires one system call per active	488	While this backend scales well, it requires one system call per active
423	file descriptor per loop iteration. For small and medium numbers of file	489	file descriptor per loop iteration. For small and medium numbers of file
424	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	490	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
425	might perform better.	491	might perform better.
426		492
427	On the positive side, ignoring the spurious readyness notifications, this	493	On the positive side, with the exception of the spurious readiness
428	backend actually performed to specification in all tests and is fully	494	notifications, this backend actually performed fully to specification
429	embeddable, which is a rare feat among the OS-specific backends.	495	in all tests and is fully embeddable, which is a rare feat among the
		496	OS-specific backends (I vastly prefer correctness over speed hacks).
		497
		498	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		499	C<EVBACKEND_POLL>.
430		500
431	=item C<EVBACKEND_ALL>	501	=item C<EVBACKEND_ALL>
432		502
433	Try all backends (even potentially broken ones that wouldn't be tried	503	Try all backends (even potentially broken ones that wouldn't be tried
434	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	504	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
…		…
436		506
437	It is definitely not recommended to use this flag.	507	It is definitely not recommended to use this flag.
438		508
439	=back	509	=back
440		510
441	If one or more of these are ored into the flags value, then only these	511	If one or more of these are or'ed into the flags value, then only these
442	backends will be tried (in the reverse order as listed here). If none are	512	backends will be tried (in the reverse order as listed here). If none are
443	specified, all backends in C<ev_recommended_backends ()> will be tried.	513	specified, all backends in C<ev_recommended_backends ()> will be tried.
444		514
445	The most typical usage is like this:	515	Example: This is the most typical usage.
446		516
447	if (!ev_default_loop (0))	517	if (!ev_default_loop (0))
448	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	518	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
449		519
450	Restrict libev to the select and poll backends, and do not allow	520	Example: Restrict libev to the select and poll backends, and do not allow
451	environment settings to be taken into account:	521	environment settings to be taken into account:
452		522
453	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	523	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
454		524
455	Use whatever libev has to offer, but make sure that kqueue is used if	525	Example: Use whatever libev has to offer, but make sure that kqueue is
456	available (warning, breaks stuff, best use only with your own private	526	used if available (warning, breaks stuff, best use only with your own
457	event loop and only if you know the OS supports your types of fds):	527	private event loop and only if you know the OS supports your types of
		528	fds):
458		529
459	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	530	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
460		531
461	=item struct ev_loop *ev_loop_new (unsigned int flags)	532	=item struct ev_loop *ev_loop_new (unsigned int flags)
462		533
463	Similar to C<ev_default_loop>, but always creates a new event loop that is	534	Similar to C<ev_default_loop>, but always creates a new event loop that is
464	always distinct from the default loop. Unlike the default loop, it cannot	535	always distinct from the default loop. Unlike the default loop, it cannot
…		…
469	libev with threads is indeed to create one loop per thread, and using the	540	libev with threads is indeed to create one loop per thread, and using the
470	default loop in the "main" or "initial" thread.	541	default loop in the "main" or "initial" thread.
471		542
472	Example: Try to create a event loop that uses epoll and nothing else.	543	Example: Try to create a event loop that uses epoll and nothing else.
473		544
474	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	545	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
475	if (!epoller)	546	if (!epoller)
476	fatal ("no epoll found here, maybe it hides under your chair");	547	fatal ("no epoll found here, maybe it hides under your chair");
477		548
478	=item ev_default_destroy ()	549	=item ev_default_destroy ()
479		550
480	Destroys the default loop again (frees all memory and kernel state	551	Destroys the default loop again (frees all memory and kernel state
481	etc.). None of the active event watchers will be stopped in the normal	552	etc.). None of the active event watchers will be stopped in the normal
482	sense, so e.g. C<ev_is_active> might still return true. It is your	553	sense, so e.g. C<ev_is_active> might still return true. It is your
483	responsibility to either stop all watchers cleanly yoursef I<before>	554	responsibility to either stop all watchers cleanly yourself I<before>
484	calling this function, or cope with the fact afterwards (which is usually	555	calling this function, or cope with the fact afterwards (which is usually
485	the easiest thing, you can just ignore the watchers and/or C<free ()> them	556	the easiest thing, you can just ignore the watchers and/or C<free ()> them
486	for example).	557	for example).
487		558
488	Note that certain global state, such as signal state, will not be freed by	559	Note that certain global state, such as signal state (and installed signal
489	this function, and related watchers (such as signal and child watchers)	560	handlers), will not be freed by this function, and related watchers (such
490	would need to be stopped manually.	561	as signal and child watchers) would need to be stopped manually.
491		562
492	In general it is not advisable to call this function except in the	563	In general it is not advisable to call this function except in the
493	rare occasion where you really need to free e.g. the signal handling	564	rare occasion where you really need to free e.g. the signal handling
494	pipe fds. If you need dynamically allocated loops it is better to use	565	pipe fds. If you need dynamically allocated loops it is better to use
495	C<ev_loop_new> and C<ev_loop_destroy>).	566	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
520		591
521	=item ev_loop_fork (loop)	592	=item ev_loop_fork (loop)
522		593
523	Like C<ev_default_fork>, but acts on an event loop created by	594	Like C<ev_default_fork>, but acts on an event loop created by
524	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	595	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
525	after fork, and how you do this is entirely your own problem.	596	after fork that you want to re-use in the child, and how you do this is
		597	entirely your own problem.
526		598
527	=item int ev_is_default_loop (loop)	599	=item int ev_is_default_loop (loop)
528		600
529	Returns true when the given loop actually is the default loop, false otherwise.	601	Returns true when the given loop is, in fact, the default loop, and false
		602	otherwise.
530		603
531	=item unsigned int ev_loop_count (loop)	604	=item unsigned int ev_loop_count (loop)
532		605
533	Returns the count of loop iterations for the loop, which is identical to	606	Returns the count of loop iterations for the loop, which is identical to
534	the number of times libev did poll for new events. It starts at C<0> and	607	the number of times libev did poll for new events. It starts at C<0> and
…		…
549	received events and started processing them. This timestamp does not	622	received events and started processing them. This timestamp does not
550	change as long as callbacks are being processed, and this is also the base	623	change as long as callbacks are being processed, and this is also the base
551	time used for relative timers. You can treat it as the timestamp of the	624	time used for relative timers. You can treat it as the timestamp of the
552	event occurring (or more correctly, libev finding out about it).	625	event occurring (or more correctly, libev finding out about it).
553		626
		627	=item ev_now_update (loop)
		628
		629	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
		631	is usually done automatically within C<ev_loop ()>.
		632
		633	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
		635	the current time is a good idea.
		636
		637	See also "The special problem of time updates" in the C<ev_timer> section.
		638
554	=item ev_loop (loop, int flags)	639	=item ev_loop (loop, int flags)
555		640
556	Finally, this is it, the event handler. This function usually is called	641	Finally, this is it, the event handler. This function usually is called
557	after you initialised all your watchers and you want to start handling	642	after you initialised all your watchers and you want to start handling
558	events.	643	events.
…		…
560	If the flags argument is specified as C<0>, it will not return until	645	If the flags argument is specified as C<0>, it will not return until
561	either no event watchers are active anymore or C<ev_unloop> was called.	646	either no event watchers are active anymore or C<ev_unloop> was called.
562		647
563	Please note that an explicit C<ev_unloop> is usually better than	648	Please note that an explicit C<ev_unloop> is usually better than
564	relying on all watchers to be stopped when deciding when a program has	649	relying on all watchers to be stopped when deciding when a program has
565	finished (especially in interactive programs), but having a program that	650	finished (especially in interactive programs), but having a program
566	automatically loops as long as it has to and no longer by virtue of	651	that automatically loops as long as it has to and no longer by virtue
567	relying on its watchers stopping correctly is a thing of beauty.	652	of relying on its watchers stopping correctly, that is truly a thing of
		653	beauty.
568		654
569	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	655	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
570	those events and any outstanding ones, but will not block your process in	656	those events and any already outstanding ones, but will not block your
571	case there are no events and will return after one iteration of the loop.	657	process in case there are no events and will return after one iteration of
		658	the loop.
572		659
573	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	660	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
574	neccessary) and will handle those and any outstanding ones. It will block	661	necessary) and will handle those and any already outstanding ones. It
575	your process until at least one new event arrives, and will return after	662	will block your process until at least one new event arrives (which could
576	one iteration of the loop. This is useful if you are waiting for some	663	be an event internal to libev itself, so there is no guarantee that a
577	external event in conjunction with something not expressible using other	664	user-registered callback will be called), and will return after one
		665	iteration of the loop.
		666
		667	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
578	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	669	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
579	usually a better approach for this kind of thing.	670	usually a better approach for this kind of thing.
580		671
581	Here are the gory details of what C<ev_loop> does:	672	Here are the gory details of what C<ev_loop> does:
582		673
583	- Before the first iteration, call any pending watchers.	674	- Before the first iteration, call any pending watchers.
584	* If EVFLAG_FORKCHECK was used, check for a fork.	675	* If EVFLAG_FORKCHECK was used, check for a fork.
585	- If a fork was detected, queue and call all fork watchers.	676	- If a fork was detected (by any means), queue and call all fork watchers.
586	- Queue and call all prepare watchers.	677	- Queue and call all prepare watchers.
587	- If we have been forked, recreate the kernel state.	678	- If we have been forked, detach and recreate the kernel state
		679	as to not disturb the other process.
588	- Update the kernel state with all outstanding changes.	680	- Update the kernel state with all outstanding changes.
589	- Update the "event loop time".	681	- Update the "event loop time" (ev_now ()).
590	- Calculate for how long to sleep or block, if at all	682	- Calculate for how long to sleep or block, if at all
591	(active idle watchers, EVLOOP_NONBLOCK or not having	683	(active idle watchers, EVLOOP_NONBLOCK or not having
592	any active watchers at all will result in not sleeping).	684	any active watchers at all will result in not sleeping).
593	- Sleep if the I/O and timer collect interval say so.	685	- Sleep if the I/O and timer collect interval say so.
594	- Block the process, waiting for any events.	686	- Block the process, waiting for any events.
595	- Queue all outstanding I/O (fd) events.	687	- Queue all outstanding I/O (fd) events.
596	- Update the "event loop time" and do time jump handling.	688	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
597	- Queue all outstanding timers.	689	- Queue all expired timers.
598	- Queue all outstanding periodics.	690	- Queue all expired periodics.
599	- If no events are pending now, queue all idle watchers.	691	- Unless any events are pending now, queue all idle watchers.
600	- Queue all check watchers.	692	- Queue all check watchers.
601	- Call all queued watchers in reverse order (i.e. check watchers first).	693	- Call all queued watchers in reverse order (i.e. check watchers first).
602	Signals and child watchers are implemented as I/O watchers, and will	694	Signals and child watchers are implemented as I/O watchers, and will
603	be handled here by queueing them when their watcher gets executed.	695	be handled here by queueing them when their watcher gets executed.
604	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	696	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
…		…
609	anymore.	701	anymore.
610		702
611	... queue jobs here, make sure they register event watchers as long	703	... queue jobs here, make sure they register event watchers as long
612	... as they still have work to do (even an idle watcher will do..)	704	... as they still have work to do (even an idle watcher will do..)
613	ev_loop (my_loop, 0);	705	ev_loop (my_loop, 0);
614	... jobs done. yeah!	706	... jobs done or somebody called unloop. yeah!
615		707
616	=item ev_unloop (loop, how)	708	=item ev_unloop (loop, how)
617		709
618	Can be used to make a call to C<ev_loop> return early (but only after it	710	Can be used to make a call to C<ev_loop> return early (but only after it
619	has processed all outstanding events). The C<how> argument must be either	711	has processed all outstanding events). The C<how> argument must be either
620	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	712	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
621	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	713	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
622		714
623	This "unloop state" will be cleared when entering C<ev_loop> again.	715	This "unloop state" will be cleared when entering C<ev_loop> again.
624		716
		717	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		718
625	=item ev_ref (loop)	719	=item ev_ref (loop)
626		720
627	=item ev_unref (loop)	721	=item ev_unref (loop)
628		722
629	Ref/unref can be used to add or remove a reference count on the event	723	Ref/unref can be used to add or remove a reference count on the event
630	loop: Every watcher keeps one reference, and as long as the reference	724	loop: Every watcher keeps one reference, and as long as the reference
631	count is nonzero, C<ev_loop> will not return on its own. If you have	725	count is nonzero, C<ev_loop> will not return on its own.
		726
632	a watcher you never unregister that should not keep C<ev_loop> from	727	If you have a watcher you never unregister that should not keep C<ev_loop>
633	returning, ev_unref() after starting, and ev_ref() before stopping it. For	728	from returning, call ev_unref() after starting, and ev_ref() before
		729	stopping it.
		730
634	example, libev itself uses this for its internal signal pipe: It is not	731	As an example, libev itself uses this for its internal signal pipe: It
635	visible to the libev user and should not keep C<ev_loop> from exiting if	732	is not visible to the libev user and should not keep C<ev_loop> from
636	no event watchers registered by it are active. It is also an excellent	733	exiting if no event watchers registered by it are active. It is also an
637	way to do this for generic recurring timers or from within third-party	734	excellent way to do this for generic recurring timers or from within
638	libraries. Just remember to I<unref after start> and I<ref before stop>	735	third-party libraries. Just remember to I<unref after start> and I<ref
639	(but only if the watcher wasn't active before, or was active before,	736	before stop> (but only if the watcher wasn't active before, or was active
640	respectively).	737	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>
		739	in the callback).
641		740
642	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	741	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
643	running when nothing else is active.	742	running when nothing else is active.
644		743
645	struct ev_signal exitsig;	744	ev_signal exitsig;
646	ev_signal_init (&exitsig, sig_cb, SIGINT);	745	ev_signal_init (&exitsig, sig_cb, SIGINT);
647	ev_signal_start (loop, &exitsig);	746	ev_signal_start (loop, &exitsig);
648	evf_unref (loop);	747	evf_unref (loop);
649		748
650	Example: For some weird reason, unregister the above signal handler again.	749	Example: For some weird reason, unregister the above signal handler again.
651		750
652	ev_ref (loop);	751	ev_ref (loop);
653	ev_signal_stop (loop, &exitsig);	752	ev_signal_stop (loop, &exitsig);
654		753
655	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	754	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
656		755
657	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	756	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
658		757
659	These advanced functions influence the time that libev will spend waiting	758	These advanced functions influence the time that libev will spend waiting
660	for events. Both are by default C<0>, meaning that libev will try to	759	for events. Both time intervals are by default C<0>, meaning that libev
661	invoke timer/periodic callbacks and I/O callbacks with minimum latency.	760	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		761	latency.
662		762
663	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	763	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
664	allows libev to delay invocation of I/O and timer/periodic callbacks to	764	allows libev to delay invocation of I/O and timer/periodic callbacks
665	increase efficiency of loop iterations.	765	to increase efficiency of loop iterations (or to increase power-saving
		766	opportunities).
666		767
667	The background is that sometimes your program runs just fast enough to	768	The idea is that sometimes your program runs just fast enough to handle
668	handle one (or very few) event(s) per loop iteration. While this makes	769	one (or very few) event(s) per loop iteration. While this makes the
669	the program responsive, it also wastes a lot of CPU time to poll for new	770	program responsive, it also wastes a lot of CPU time to poll for new
670	events, especially with backends like C<select ()> which have a high	771	events, especially with backends like C<select ()> which have a high
671	overhead for the actual polling but can deliver many events at once.	772	overhead for the actual polling but can deliver many events at once.
672		773
673	By setting a higher I<io collect interval> you allow libev to spend more	774	By setting a higher I<io collect interval> you allow libev to spend more
674	time collecting I/O events, so you can handle more events per iteration,	775	time collecting I/O events, so you can handle more events per iteration,
…		…
676	C<ev_timer>) will be not affected. Setting this to a non-null value will	777	C<ev_timer>) will be not affected. Setting this to a non-null value will
677	introduce an additional C<ev_sleep ()> call into most loop iterations.	778	introduce an additional C<ev_sleep ()> call into most loop iterations.
678		779
679	Likewise, by setting a higher I<timeout collect interval> you allow libev	780	Likewise, by setting a higher I<timeout collect interval> you allow libev
680	to spend more time collecting timeouts, at the expense of increased	781	to spend more time collecting timeouts, at the expense of increased
681	latency (the watcher callback will be called later). C<ev_io> watchers	782	latency/jitter/inexactness (the watcher callback will be called
682	will not be affected. Setting this to a non-null value will not introduce	783	later). C<ev_io> watchers will not be affected. Setting this to a non-null
683	any overhead in libev.	784	value will not introduce any overhead in libev.
684		785
685	Many (busy) programs can usually benefit by setting the io collect	786	Many (busy) programs can usually benefit by setting the I/O collect
686	interval to a value near C<0.1> or so, which is often enough for	787	interval to a value near C<0.1> or so, which is often enough for
687	interactive servers (of course not for games), likewise for timeouts. It	788	interactive servers (of course not for games), likewise for timeouts. It
688	usually doesn't make much sense to set it to a lower value than C<0.01>,	789	usually doesn't make much sense to set it to a lower value than C<0.01>,
689	as this approsaches the timing granularity of most systems.	790	as this approaches the timing granularity of most systems.
		791
		792	Setting the I<timeout collect interval> can improve the opportunity for
		793	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
		795	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
		797	they fire on, say, one-second boundaries only.
		798
		799	=item ev_loop_verify (loop)
		800
		801	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
		803	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
		805	error and call C<abort ()>.
		806
		807	This can be used to catch bugs inside libev itself: under normal
		808	circumstances, this function will never abort as of course libev keeps its
		809	data structures consistent.
690		810
691	=back	811	=back
692		812
693		813
694	=head1 ANATOMY OF A WATCHER	814	=head1 ANATOMY OF A WATCHER
		815
		816	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
		818	watchers and C<ev_io_start> for I/O watchers.
695		819
696	A watcher is a structure that you create and register to record your	820	A watcher is a structure that you create and register to record your
697	interest in some event. For instance, if you want to wait for STDIN to	821	interest in some event. For instance, if you want to wait for STDIN to
698	become readable, you would create an C<ev_io> watcher for that:	822	become readable, you would create an C<ev_io> watcher for that:
699		823
700	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	824	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
701	{	825	{
702	ev_io_stop (w);	826	ev_io_stop (w);
703	ev_unloop (loop, EVUNLOOP_ALL);	827	ev_unloop (loop, EVUNLOOP_ALL);
704	}	828	}
705		829
706	struct ev_loop *loop = ev_default_loop (0);	830	struct ev_loop *loop = ev_default_loop (0);
		831
707	struct ev_io stdin_watcher;	832	ev_io stdin_watcher;
		833
708	ev_init (&stdin_watcher, my_cb);	834	ev_init (&stdin_watcher, my_cb);
709	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	835	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
710	ev_io_start (loop, &stdin_watcher);	836	ev_io_start (loop, &stdin_watcher);
		837
711	ev_loop (loop, 0);	838	ev_loop (loop, 0);
712		839
713	As you can see, you are responsible for allocating the memory for your	840	As you can see, you are responsible for allocating the memory for your
714	watcher structures (and it is usually a bad idea to do this on the stack,	841	watcher structures (and it is I<usually> a bad idea to do this on the
715	although this can sometimes be quite valid).	842	stack).
		843
		844	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).
716		846
717	Each watcher structure must be initialised by a call to C<ev_init	847	Each watcher structure must be initialised by a call to C<ev_init
718	(watcher *, callback)>, which expects a callback to be provided. This	848	(watcher *, callback)>, which expects a callback to be provided. This
719	callback gets invoked each time the event occurs (or, in the case of io	849	callback gets invoked each time the event occurs (or, in the case of I/O
720	watchers, each time the event loop detects that the file descriptor given	850	watchers, each time the event loop detects that the file descriptor given
721	is readable and/or writable).	851	is readable and/or writable).
722		852
723	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	853	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
724	with arguments specific to this watcher type. There is also a macro	854	macro to configure it, with arguments specific to the watcher type. There
725	to combine initialisation and setting in one call: C<< ev_<type>_init	855	is also a macro to combine initialisation and setting in one call: C<<
726	(watcher *, callback, ...) >>.	856	ev_TYPE_init (watcher *, callback, ...) >>.
727		857
728	To make the watcher actually watch out for events, you have to start it	858	To make the watcher actually watch out for events, you have to start it
729	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	859	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
730	*) >>), and you can stop watching for events at any time by calling the	860	*) >>), and you can stop watching for events at any time by calling the
731	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	861	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
732		862
733	As long as your watcher is active (has been started but not stopped) you	863	As long as your watcher is active (has been started but not stopped) you
734	must not touch the values stored in it. Most specifically you must never	864	must not touch the values stored in it. Most specifically you must never
735	reinitialise it or call its C<set> macro.	865	reinitialise it or call its C<ev_TYPE_set> macro.
736		866
737	Each and every callback receives the event loop pointer as first, the	867	Each and every callback receives the event loop pointer as first, the
738	registered watcher structure as second, and a bitset of received events as	868	registered watcher structure as second, and a bitset of received events as
739	third argument.	869	third argument.
740		870
…		…
798		928
799	=item C<EV_ASYNC>	929	=item C<EV_ASYNC>
800		930
801	The given async watcher has been asynchronously notified (see C<ev_async>).	931	The given async watcher has been asynchronously notified (see C<ev_async>).
802		932
		933	=item C<EV_CUSTOM>
		934
		935	Not ever sent (or otherwise used) by libev itself, but can be freely used
		936	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		937
803	=item C<EV_ERROR>	938	=item C<EV_ERROR>
804		939
805	An unspecified error has occured, the watcher has been stopped. This might	940	An unspecified error has occurred, the watcher has been stopped. This might
806	happen because the watcher could not be properly started because libev	941	happen because the watcher could not be properly started because libev
807	ran out of memory, a file descriptor was found to be closed or any other	942	ran out of memory, a file descriptor was found to be closed or any other
		943	problem. Libev considers these application bugs.
		944
808	problem. You best act on it by reporting the problem and somehow coping	945	You best act on it by reporting the problem and somehow coping with the
809	with the watcher being stopped.	946	watcher being stopped. Note that well-written programs should not receive
		947	an error ever, so when your watcher receives it, this usually indicates a
		948	bug in your program.
810		949
811	Libev will usually signal a few "dummy" events together with an error,	950	Libev will usually signal a few "dummy" events together with an error, for
812	for example it might indicate that a fd is readable or writable, and if	951	example it might indicate that a fd is readable or writable, and if your
813	your callbacks is well-written it can just attempt the operation and cope	952	callbacks is well-written it can just attempt the operation and cope with
814	with the error from read() or write(). This will not work in multithreaded	953	the error from read() or write(). This will not work in multi-threaded
815	programs, though, so beware.	954	programs, though, as the fd could already be closed and reused for another
		955	thing, so beware.
816		956
817	=back	957	=back
818		958
819	=head2 GENERIC WATCHER FUNCTIONS	959	=head2 GENERIC WATCHER FUNCTIONS
820
821	In the following description, C<TYPE> stands for the watcher type,
822	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
823		960
824	=over 4	961	=over 4
825		962
826	=item C<ev_init> (ev_TYPE *watcher, callback)	963	=item C<ev_init> (ev_TYPE *watcher, callback)
827		964
…		…
833	which rolls both calls into one.	970	which rolls both calls into one.
834		971
835	You can reinitialise a watcher at any time as long as it has been stopped	972	You can reinitialise a watcher at any time as long as it has been stopped
836	(or never started) and there are no pending events outstanding.	973	(or never started) and there are no pending events outstanding.
837		974
838	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	975	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
839	int revents)>.	976	int revents)>.
		977
		978	Example: Initialise an C<ev_io> watcher in two steps.
		979
		980	ev_io w;
		981	ev_init (&w, my_cb);
		982	ev_io_set (&w, STDIN_FILENO, EV_READ);
840		983
841	=item C<ev_TYPE_set> (ev_TYPE *, [args])	984	=item C<ev_TYPE_set> (ev_TYPE *, [args])
842		985
843	This macro initialises the type-specific parts of a watcher. You need to	986	This macro initialises the type-specific parts of a watcher. You need to
844	call C<ev_init> at least once before you call this macro, but you can	987	call C<ev_init> at least once before you call this macro, but you can
…		…
847	difference to the C<ev_init> macro).	990	difference to the C<ev_init> macro).
848		991
849	Although some watcher types do not have type-specific arguments	992	Although some watcher types do not have type-specific arguments
850	(e.g. C<ev_prepare>) you still need to call its C<set> macro.	993	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
851		994
		995	See C<ev_init>, above, for an example.
		996
852	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	997	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
853		998
854	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	999	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
855	calls into a single call. This is the most convinient method to initialise	1000	calls into a single call. This is the most convenient method to initialise
856	a watcher. The same limitations apply, of course.	1001	a watcher. The same limitations apply, of course.
		1002
		1003	Example: Initialise and set an C<ev_io> watcher in one step.
		1004
		1005	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
857		1006
858	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1007	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
859		1008
860	Starts (activates) the given watcher. Only active watchers will receive	1009	Starts (activates) the given watcher. Only active watchers will receive
861	events. If the watcher is already active nothing will happen.	1010	events. If the watcher is already active nothing will happen.
862		1011
		1012	Example: Start the C<ev_io> watcher that is being abused as example in this
		1013	whole section.
		1014
		1015	ev_io_start (EV_DEFAULT_UC, &w);
		1016
863	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1017	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
864		1018
865	Stops the given watcher again (if active) and clears the pending	1019	Stops the given watcher if active, and clears the pending status (whether
		1020	the watcher was active or not).
		1021
866	status. It is possible that stopped watchers are pending (for example,	1022	It is possible that stopped watchers are pending - for example,
867	non-repeating timers are being stopped when they become pending), but	1023	non-repeating timers are being stopped when they become pending - but
868	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	1024	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
869	you want to free or reuse the memory used by the watcher it is therefore a	1025	pending. If you want to free or reuse the memory used by the watcher it is
870	good idea to always call its C<ev_TYPE_stop> function.	1026	therefore a good idea to always call its C<ev_TYPE_stop> function.
871		1027
872	=item bool ev_is_active (ev_TYPE *watcher)	1028	=item bool ev_is_active (ev_TYPE *watcher)
873		1029
874	Returns a true value iff the watcher is active (i.e. it has been started	1030	Returns a true value iff the watcher is active (i.e. it has been started
875	and not yet been stopped). As long as a watcher is active you must not modify	1031	and not yet been stopped). As long as a watcher is active you must not modify
…		…
917	The default priority used by watchers when no priority has been set is	1073	The default priority used by watchers when no priority has been set is
918	always C<0>, which is supposed to not be too high and not be too low :).	1074	always C<0>, which is supposed to not be too high and not be too low :).
919		1075
920	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1076	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
921	fine, as long as you do not mind that the priority value you query might	1077	fine, as long as you do not mind that the priority value you query might
922	or might not have been adjusted to be within valid range.	1078	or might not have been clamped to the valid range.
923		1079
924	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1080	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
925		1081
926	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1082	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
927	C<loop> nor C<revents> need to be valid as long as the watcher callback	1083	C<loop> nor C<revents> need to be valid as long as the watcher callback
928	can deal with that fact.	1084	can deal with that fact, as both are simply passed through to the
		1085	callback.
929		1086
930	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1087	=item int ev_clear_pending (loop, ev_TYPE *watcher)
931		1088
932	If the watcher is pending, this function returns clears its pending status	1089	If the watcher is pending, this function clears its pending status and
933	and returns its C<revents> bitset (as if its callback was invoked). If the	1090	returns its C<revents> bitset (as if its callback was invoked). If the
934	watcher isn't pending it does nothing and returns C<0>.	1091	watcher isn't pending it does nothing and returns C<0>.
935		1092
		1093	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.
		1095
936	=back	1096	=back
937		1097
938		1098
939	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1099	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
940		1100
941	Each watcher has, by default, a member C<void *data> that you can change	1101	Each watcher has, by default, a member C<void *data> that you can change
942	and read at any time, libev will completely ignore it. This can be used	1102	and read at any time: libev will completely ignore it. This can be used
943	to associate arbitrary data with your watcher. If you need more data and	1103	to associate arbitrary data with your watcher. If you need more data and
944	don't want to allocate memory and store a pointer to it in that data	1104	don't want to allocate memory and store a pointer to it in that data
945	member, you can also "subclass" the watcher type and provide your own	1105	member, you can also "subclass" the watcher type and provide your own
946	data:	1106	data:
947		1107
948	struct my_io	1108	struct my_io
949	{	1109	{
950	struct ev_io io;	1110	ev_io io;
951	int otherfd;	1111	int otherfd;
952	void *somedata;	1112	void *somedata;
953	struct whatever *mostinteresting;	1113	struct whatever *mostinteresting;
954	}	1114	};
		1115
		1116	...
		1117	struct my_io w;
		1118	ev_io_init (&w.io, my_cb, fd, EV_READ);
955		1119
956	And since your callback will be called with a pointer to the watcher, you	1120	And since your callback will be called with a pointer to the watcher, you
957	can cast it back to your own type:	1121	can cast it back to your own type:
958		1122
959	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1123	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
960	{	1124	{
961	struct my_io *w = (struct my_io *)w_;	1125	struct my_io *w = (struct my_io *)w_;
962	...	1126	...
963	}	1127	}
964		1128
965	More interesting and less C-conformant ways of casting your callback type	1129	More interesting and less C-conformant ways of casting your callback type
966	instead have been omitted.	1130	instead have been omitted.
967		1131
968	Another common scenario is having some data structure with multiple	1132	Another common scenario is to use some data structure with multiple
969	watchers:	1133	embedded watchers:
970		1134
971	struct my_biggy	1135	struct my_biggy
972	{	1136	{
973	int some_data;	1137	int some_data;
974	ev_timer t1;	1138	ev_timer t1;
975	ev_timer t2;	1139	ev_timer t2;
976	}	1140	}
977		1141
978	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1142	In this case getting the pointer to C<my_biggy> is a bit more
979	you need to use C<offsetof>:	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):
980		1147
981	#include <stddef.h>	1148	#include <stddef.h>
982		1149
983	static void	1150	static void
984	t1_cb (EV_P_ struct ev_timer *w, int revents)	1151	t1_cb (EV_P_ ev_timer *w, int revents)
985	{	1152	{
986	struct my_biggy big = (struct my_biggy *	1153	struct my_biggy big = (struct my_biggy *
987	(((char *)w) - offsetof (struct my_biggy, t1));	1154	(((char *)w) - offsetof (struct my_biggy, t1));
988	}	1155	}
989		1156
990	static void	1157	static void
991	t2_cb (EV_P_ struct ev_timer *w, int revents)	1158	t2_cb (EV_P_ ev_timer *w, int revents)
992	{	1159	{
993	struct my_biggy big = (struct my_biggy *	1160	struct my_biggy big = (struct my_biggy *
994	(((char *)w) - offsetof (struct my_biggy, t2));	1161	(((char *)w) - offsetof (struct my_biggy, t2));
995	}	1162	}
996		1163
997		1164
998	=head1 WATCHER TYPES	1165	=head1 WATCHER TYPES
999		1166
1000	This section describes each watcher in detail, but will not repeat	1167	This section describes each watcher in detail, but will not repeat
…		…
1024	In general you can register as many read and/or write event watchers per	1191	In general you can register as many read and/or write event watchers per
1025	fd as you want (as long as you don't confuse yourself). Setting all file	1192	fd as you want (as long as you don't confuse yourself). Setting all file
1026	descriptors to non-blocking mode is also usually a good idea (but not	1193	descriptors to non-blocking mode is also usually a good idea (but not
1027	required if you know what you are doing).	1194	required if you know what you are doing).
1028		1195
1029	If you must do this, then force the use of a known-to-be-good backend	1196	If you cannot use non-blocking mode, then force the use of a
1030	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1197	known-to-be-good backend (at the time of this writing, this includes only
1031	C<EVBACKEND_POLL>).	1198	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1032		1199
1033	Another thing you have to watch out for is that it is quite easy to	1200	Another thing you have to watch out for is that it is quite easy to
1034	receive "spurious" readyness notifications, that is your callback might	1201	receive "spurious" readiness notifications, that is your callback might
1035	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1202	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1036	because there is no data. Not only are some backends known to create a	1203	because there is no data. Not only are some backends known to create a
1037	lot of those (for example solaris ports), it is very easy to get into	1204	lot of those (for example Solaris ports), it is very easy to get into
1038	this situation even with a relatively standard program structure. Thus	1205	this situation even with a relatively standard program structure. Thus
1039	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1206	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1040	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1207	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1041		1208
1042	If you cannot run the fd in non-blocking mode (for example you should not	1209	If you cannot run the fd in non-blocking mode (for example you should
1043	play around with an Xlib connection), then you have to seperately re-test	1210	not play around with an Xlib connection), then you have to separately
1044	whether a file descriptor is really ready with a known-to-be good interface	1211	re-test whether a file descriptor is really ready with a known-to-be good
1045	such as poll (fortunately in our Xlib example, Xlib already does this on	1212	interface such as poll (fortunately in our Xlib example, Xlib already
1046	its own, so its quite safe to use).	1213	does 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
		1215	indefinitely.
		1216
		1217	But really, best use non-blocking mode.
1047		1218
1048	=head3 The special problem of disappearing file descriptors	1219	=head3 The special problem of disappearing file descriptors
1049		1220
1050	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1221	Some backends (e.g. kqueue, epoll) need to be told about closing a file
1051	descriptor (either by calling C<close> explicitly or by any other means,	1222	descriptor (either due to calling C<close> explicitly or any other means,
1052	such as C<dup>). The reason is that you register interest in some file	1223	such as C<dup2>). The reason is that you register interest in some file
1053	descriptor, but when it goes away, the operating system will silently drop	1224	descriptor, but when it goes away, the operating system will silently drop
1054	this interest. If another file descriptor with the same number then is	1225	this interest. If another file descriptor with the same number then is
1055	registered with libev, there is no efficient way to see that this is, in	1226	registered with libev, there is no efficient way to see that this is, in
1056	fact, a different file descriptor.	1227	fact, a different file descriptor.
1057		1228
…		…
1088	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1259	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1089	C<EVBACKEND_POLL>.	1260	C<EVBACKEND_POLL>.
1090		1261
1091	=head3 The special problem of SIGPIPE	1262	=head3 The special problem of SIGPIPE
1092		1263
1093	While not really specific to libev, it is easy to forget about SIGPIPE:	1264	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1094	when reading from a pipe whose other end has been closed, your program	1265	when writing to a pipe whose other end has been closed, your program gets
1095	gets send a SIGPIPE, which, by default, aborts your program. For most	1266	sent a SIGPIPE, which, by default, aborts your program. For most programs
1096	programs this is sensible behaviour, for daemons, this is usually	1267	this is sensible behaviour, for daemons, this is usually undesirable.
1097	undesirable.
1098		1268
1099	So when you encounter spurious, unexplained daemon exits, make sure you	1269	So when you encounter spurious, unexplained daemon exits, make sure you
1100	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1270	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1101	somewhere, as that would have given you a big clue).	1271	somewhere, as that would have given you a big clue).
1102		1272
…		…
1108	=item ev_io_init (ev_io *, callback, int fd, int events)	1278	=item ev_io_init (ev_io *, callback, int fd, int events)
1109		1279
1110	=item ev_io_set (ev_io *, int fd, int events)	1280	=item ev_io_set (ev_io *, int fd, int events)
1111		1281
1112	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1282	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1113	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1283	receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or
1114	C<EV_READ | EV_WRITE> to receive the given events.	1284	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1115		1285
1116	=item int fd [read-only]	1286	=item int fd [read-only]
1117		1287
1118	The file descriptor being watched.	1288	The file descriptor being watched.
1119		1289
…		…
1127		1297
1128	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1298	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1129	readable, but only once. Since it is likely line-buffered, you could	1299	readable, but only once. Since it is likely line-buffered, you could
1130	attempt to read a whole line in the callback.	1300	attempt to read a whole line in the callback.
1131		1301
1132	static void	1302	static void
1133	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1303	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1134	{	1304	{
1135	ev_io_stop (loop, w);	1305	ev_io_stop (loop, w);
1136	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1306	.. read from stdin here (or from w->fd) and handle any I/O errors
1137	}	1307	}
1138		1308
1139	...	1309	...
1140	struct ev_loop *loop = ev_default_init (0);	1310	struct ev_loop *loop = ev_default_init (0);
1141	struct ev_io stdin_readable;	1311	ev_io stdin_readable;
1142	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1312	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1143	ev_io_start (loop, &stdin_readable);	1313	ev_io_start (loop, &stdin_readable);
1144	ev_loop (loop, 0);	1314	ev_loop (loop, 0);
1145		1315
1146		1316
1147	=head2 C<ev_timer> - relative and optionally repeating timeouts	1317	=head2 C<ev_timer> - relative and optionally repeating timeouts
1148		1318
1149	Timer watchers are simple relative timers that generate an event after a	1319	Timer watchers are simple relative timers that generate an event after a
1150	given time, and optionally repeating in regular intervals after that.	1320	given time, and optionally repeating in regular intervals after that.
1151		1321
1152	The timers are based on real time, that is, if you register an event that	1322	The timers are based on real time, that is, if you register an event that
1153	times out after an hour and you reset your system clock to last years	1323	times out after an hour and you reset your system clock to January last
1154	time, it will still time out after (roughly) and hour. "Roughly" because	1324	year, it will still time out after (roughly) one hour. "Roughly" because
1155	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1325	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1156	monotonic clock option helps a lot here).	1326	monotonic clock option helps a lot here).
		1327
		1328	The callback is guaranteed to be invoked only I<after> its timeout has
		1329	passed. If multiple timers become ready during the same loop iteration
		1330	then the ones with earlier time-out values are invoked before ones with
		1331	later time-out values (but this is no longer true when a callback calls
		1332	C<ev_loop> recursively).
		1333
		1334	=head3 Be smart about timeouts
		1335
		1336	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,
		1338	you want to raise some error after a while.
		1339
		1340	What follows are some ways to handle this problem, from obvious and
		1341	inefficient to smart and efficient.
		1342
		1343	In the following, a 60 second activity timeout is assumed - a timeout that
		1344	gets reset to 60 seconds each time there is activity (e.g. each time some
		1345	data or other life sign was received).
		1346
		1347	=over 4
		1348
		1349	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1350
		1351	This is the most obvious, but not the most simple way: In the beginning,
		1352	start the watcher:
		1353
		1354	ev_timer_init (timer, callback, 60., 0.);
		1355	ev_timer_start (loop, timer);
		1356
		1357	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1358	and start it again:
		1359
		1360	ev_timer_stop (loop, timer);
		1361	ev_timer_set (timer, 60., 0.);
		1362	ev_timer_start (loop, timer);
		1363
		1364	This is relatively simple to implement, but means that each time there is
		1365	some activity, libev will first have to remove the timer from its internal
		1366	data structure and then add it again. Libev tries to be fast, but it's
		1367	still not a constant-time operation.
		1368
		1369	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1370
		1371	This is the easiest way, and involves using C<ev_timer_again> instead of
		1372	C<ev_timer_start>.
		1373
		1374	To implement this, configure an C<ev_timer> with a C<repeat> value
		1375	of C<60> and then call C<ev_timer_again> at start and each time you
		1376	successfully read or write some data. If you go into an idle state where
		1377	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1378	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1379
		1380	That means you can ignore both the C<ev_timer_start> function and the
		1381	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1382	member and C<ev_timer_again>.
		1383
		1384	At start:
		1385
		1386	ev_timer_init (timer, callback);
		1387	timer->repeat = 60.;
		1388	ev_timer_again (loop, timer);
		1389
		1390	Each time there is some activity:
		1391
		1392	ev_timer_again (loop, timer);
		1393
		1394	It is even possible to change the time-out on the fly, regardless of
		1395	whether the watcher is active or not:
		1396
		1397	timer->repeat = 30.;
		1398	ev_timer_again (loop, timer);
		1399
		1400	This is slightly more efficient then stopping/starting the timer each time
		1401	you want to modify its timeout value, as libev does not have to completely
		1402	remove and re-insert the timer from/into its internal data structure.
		1403
		1404	It is, however, even simpler than the "obvious" way to do it.
		1405
		1406	=item 3. Let the timer time out, but then re-arm it as required.
		1407
		1408	This method is more tricky, but usually most efficient: Most timeouts are
		1409	relatively long compared to the intervals between other activity - in
		1410	our example, within 60 seconds, there are usually many I/O events with
		1411	associated activity resets.
		1412
		1413	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
		1415	within the callback:
		1416
		1417	ev_tstamp last_activity; // time of last activity
		1418
		1419	static void
		1420	callback (EV_P_ ev_timer *w, int revents)
		1421	{
		1422	ev_tstamp now = ev_now (EV_A);
		1423	ev_tstamp timeout = last_activity + 60.;
		1424
		1425	// if last_activity + 60. is older than now, we did time out
		1426	if (timeout < now)
		1427	{
		1428	// timeout occured, take action
		1429	}
		1430	else
		1431	{
		1432	// callback was invoked, but there was some activity, re-arm
		1433	// the watcher to fire in last_activity + 60, which is
		1434	// guaranteed to be in the future, so "again" is positive:
		1435	w->repeat = timeout - now;
		1436	ev_timer_again (EV_A_ w);
		1437	}
		1438	}
		1439
		1440	To summarise the callback: first calculate the real timeout (defined
		1441	as "60 seconds after the last activity"), then check if that time has
		1442	been reached, which means something I<did>, in fact, time out. Otherwise
		1443	the callback was invoked too early (C<timeout> is in the future), so
		1444	re-schedule the timer to fire at that future time, to see if maybe we have
		1445	a timeout then.
		1446
		1447	Note how C<ev_timer_again> is used, taking advantage of the
		1448	C<ev_timer_again> optimisation when the timer is already running.
		1449
		1450	This scheme causes more callback invocations (about one every 60 seconds
		1451	minus half the average time between activity), but virtually no calls to
		1452	libev to change the timeout.
		1453
		1454	To start the timer, simply initialise the watcher and set C<last_activity>
		1455	to the current time (meaning we just have some activity :), then call the
		1456	callback, which will "do the right thing" and start the timer:
		1457
		1458	ev_timer_init (timer, callback);
		1459	last_activity = ev_now (loop);
		1460	callback (loop, timer, EV_TIMEOUT);
		1461
		1462	And when there is some activity, simply store the current time in
		1463	C<last_activity>, no libev calls at all:
		1464
		1465	last_actiivty = ev_now (loop);
		1466
		1467	This technique is slightly more complex, but in most cases where the
		1468	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
		1474	=item 4. Wee, just use a double-linked list for your timeouts.
		1475
		1476	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
		1478	do even better:
		1479
		1480	When starting the timeout, calculate the timeout value and put the timeout
		1481	at the I<end> of the list.
		1482
		1483	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1484	the list is expected to fire (for example, using the technique #3).
		1485
		1486	When there is some activity, remove the timer from the list, recalculate
		1487	the timeout, append it to the end of the list again, and make sure to
		1488	update the C<ev_timer> if it was taken from the beginning of the list.
		1489
		1490	This way, one can manage an unlimited number of timeouts in O(1) time for
		1491	starting, stopping and updating the timers, at the expense of a major
		1492	complication, and having to use a constant timeout. The constant timeout
		1493	ensures that the list stays sorted.
		1494
		1495	=back
		1496
		1497	So which method the best?
		1498
		1499	Method #2 is a simple no-brain-required solution that is adequate in most
		1500	situations. Method #3 requires a bit more thinking, but handles many cases
		1501	better, and isn't very complicated either. In most case, choosing either
		1502	one is fine, with #3 being better in typical situations.
		1503
		1504	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
		1506	off after the first million or so of active timers, i.e. it's usually
		1507	overkill :)
		1508
		1509	=head3 The special problem of time updates
		1510
		1511	Establishing the current time is a costly operation (it usually takes at
		1512	least two system calls): EV therefore updates its idea of the current
		1513	time only before and after C<ev_loop> collects new events, which causes a
		1514	growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1515	lots of events in one iteration.
1157		1516
1158	The relative timeouts are calculated relative to the C<ev_now ()>	1517	The relative timeouts are calculated relative to the C<ev_now ()>
1159	time. This is usually the right thing as this timestamp refers to the time	1518	time. This is usually the right thing as this timestamp refers to the time
1160	of the event triggering whatever timeout you are modifying/starting. If	1519	of the event triggering whatever timeout you are modifying/starting. If
1161	you suspect event processing to be delayed and you I<need> to base the timeout	1520	you suspect event processing to be delayed and you I<need> to base the
1162	on the current time, use something like this to adjust for this:	1521	timeout on the current time, use something like this to adjust for this:
1163		1522
1164	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1523	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1165		1524
1166	The callback is guarenteed to be invoked only when its timeout has passed,	1525	If the event loop is suspended for a long time, you can also force an
1167	but if multiple timers become ready during the same loop iteration then	1526	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1168	order of execution is undefined.	1527	()>.
1169		1528
1170	=head3 Watcher-Specific Functions and Data Members	1529	=head3 Watcher-Specific Functions and Data Members
1171		1530
1172	=over 4	1531	=over 4
1173		1532
1174	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1533	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1175		1534
1176	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1535	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1177		1536
1178	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1537	Configure the timer to trigger after C<after> seconds. If C<repeat>
1179	C<0.>, then it will automatically be stopped. If it is positive, then the	1538	is C<0.>, then it will automatically be stopped once the timeout is
1180	timer will automatically be configured to trigger again C<repeat> seconds	1539	reached. If it is positive, then the timer will automatically be
1181	later, again, and again, until stopped manually.	1540	configured to trigger again C<repeat> seconds later, again, and again,
		1541	until stopped manually.
1182		1542
1183	The timer itself will do a best-effort at avoiding drift, that is, if you	1543	The timer itself will do a best-effort at avoiding drift, that is, if
1184	configure a timer to trigger every 10 seconds, then it will trigger at	1544	you configure a timer to trigger every 10 seconds, then it will normally
1185	exactly 10 second intervals. If, however, your program cannot keep up with	1545	trigger at exactly 10 second intervals. If, however, your program cannot
1186	the timer (because it takes longer than those 10 seconds to do stuff) the	1546	keep up with the timer (because it takes longer than those 10 seconds to
1187	timer will not fire more than once per event loop iteration.	1547	do stuff) the timer will not fire more than once per event loop iteration.
1188		1548
1189	=item ev_timer_again (loop, ev_timer *)	1549	=item ev_timer_again (loop, ev_timer *)
1190		1550
1191	This will act as if the timer timed out and restart it again if it is	1551	This will act as if the timer timed out and restart it again if it is
1192	repeating. The exact semantics are:	1552	repeating. The exact semantics are:
1193		1553
1194	If the timer is pending, its pending status is cleared.	1554	If the timer is pending, its pending status is cleared.
1195		1555
1196	If the timer is started but nonrepeating, stop it (as if it timed out).	1556	If the timer is started but non-repeating, stop it (as if it timed out).
1197		1557
1198	If the timer is repeating, either start it if necessary (with the	1558	If the timer is repeating, either start it if necessary (with the
1199	C<repeat> value), or reset the running timer to the C<repeat> value.	1559	C<repeat> value), or reset the running timer to the C<repeat> value.
1200		1560
1201	This sounds a bit complicated, but here is a useful and typical	1561	This sounds a bit complicated, see "Be smart about timeouts", above, for a
1202	example: Imagine you have a tcp connection and you want a so-called idle	1562	usage example.
1203	timeout, that is, you want to be called when there have been, say, 60
1204	seconds of inactivity on the socket. The easiest way to do this is to
1205	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1206	C<ev_timer_again> each time you successfully read or write some data. If
1207	you go into an idle state where you do not expect data to travel on the
1208	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1209	automatically restart it if need be.
1210
1211	That means you can ignore the C<after> value and C<ev_timer_start>
1212	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1213
1214	ev_timer_init (timer, callback, 0., 5.);
1215	ev_timer_again (loop, timer);
1216	...
1217	timer->again = 17.;
1218	ev_timer_again (loop, timer);
1219	...
1220	timer->again = 10.;
1221	ev_timer_again (loop, timer);
1222
1223	This is more slightly efficient then stopping/starting the timer each time
1224	you want to modify its timeout value.
1225		1563
1226	=item ev_tstamp repeat [read-write]	1564	=item ev_tstamp repeat [read-write]
1227		1565
1228	The current C<repeat> value. Will be used each time the watcher times out	1566	The current C<repeat> value. Will be used each time the watcher times out
1229	or C<ev_timer_again> is called and determines the next timeout (if any),	1567	or C<ev_timer_again> is called, and determines the next timeout (if any),
1230	which is also when any modifications are taken into account.	1568	which is also when any modifications are taken into account.
1231		1569
1232	=back	1570	=back
1233		1571
1234	=head3 Examples	1572	=head3 Examples
1235		1573
1236	Example: Create a timer that fires after 60 seconds.	1574	Example: Create a timer that fires after 60 seconds.
1237		1575
1238	static void	1576	static void
1239	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1577	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1240	{	1578	{
1241	.. one minute over, w is actually stopped right here	1579	.. one minute over, w is actually stopped right here
1242	}	1580	}
1243		1581
1244	struct ev_timer mytimer;	1582	ev_timer mytimer;
1245	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1583	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1246	ev_timer_start (loop, &mytimer);	1584	ev_timer_start (loop, &mytimer);
1247		1585
1248	Example: Create a timeout timer that times out after 10 seconds of	1586	Example: Create a timeout timer that times out after 10 seconds of
1249	inactivity.	1587	inactivity.
1250		1588
1251	static void	1589	static void
1252	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1590	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1253	{	1591	{
1254	.. ten seconds without any activity	1592	.. ten seconds without any activity
1255	}	1593	}
1256		1594
1257	struct ev_timer mytimer;	1595	ev_timer mytimer;
1258	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1596	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1259	ev_timer_again (&mytimer); /* start timer */	1597	ev_timer_again (&mytimer); /* start timer */
1260	ev_loop (loop, 0);	1598	ev_loop (loop, 0);
1261		1599
1262	// and in some piece of code that gets executed on any "activity":	1600	// and in some piece of code that gets executed on any "activity":
1263	// reset the timeout to start ticking again at 10 seconds	1601	// reset the timeout to start ticking again at 10 seconds
1264	ev_timer_again (&mytimer);	1602	ev_timer_again (&mytimer);
1265		1603
1266		1604
1267	=head2 C<ev_periodic> - to cron or not to cron?	1605	=head2 C<ev_periodic> - to cron or not to cron?
1268		1606
1269	Periodic watchers are also timers of a kind, but they are very versatile	1607	Periodic watchers are also timers of a kind, but they are very versatile
1270	(and unfortunately a bit complex).	1608	(and unfortunately a bit complex).
1271		1609
1272	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1610	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1273	but on wallclock time (absolute time). You can tell a periodic watcher	1611	relative time, the physical time that passes) but on wall clock time
1274	to trigger "at" some specific point in time. For example, if you tell a	1612	(absolute time, the thing you can read on your calender or clock). The
1275	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1613	difference is that wall clock time can run faster or slower than real
1276	+ 10.>) and then reset your system clock to the last year, then it will	1614	time, and time jumps are not uncommon (e.g. when you adjust your
1277	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1615	wrist-watch).
1278	roughly 10 seconds later).
1279		1616
1280	They can also be used to implement vastly more complex timers, such as	1617	You can tell a periodic watcher to trigger after some specific point
1281	triggering an event on each midnight, local time or other, complicated,	1618	in time: for example, if you tell a periodic watcher to trigger "in 10
1282	rules.	1619	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1620	not a delay) and then reset your system clock to January of the previous
		1621	year, then it will take a year or more to trigger the event (unlike an
		1622	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1623	it, as it uses a relative timeout).
1283		1624
		1625	C<ev_periodic> watchers can also be used to implement vastly more complex
		1626	timers, such as triggering an event on each "midnight, local time", or
		1627	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1628	those cannot react to time jumps.
		1629
1284	As with timers, the callback is guarenteed to be invoked only when the	1630	As with timers, the callback is guaranteed to be invoked only when the
1285	time (C<at>) has been passed, but if multiple periodic timers become ready	1631	point in time where it is supposed to trigger has passed. If multiple
1286	during the same loop iteration then order of execution is undefined.	1632	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
		1634	(but this is no longer true when a callback calls C<ev_loop> recursively).
1287		1635
1288	=head3 Watcher-Specific Functions and Data Members	1636	=head3 Watcher-Specific Functions and Data Members
1289		1637
1290	=over 4	1638	=over 4
1291		1639
1292	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1640	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1293		1641
1294	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1642	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1295		1643
1296	Lots of arguments, lets sort it out... There are basically three modes of	1644	Lots of arguments, let's sort it out... There are basically three modes of
1297	operation, and we will explain them from simplest to complex:	1645	operation, and we will explain them from simplest to most complex:
1298		1646
1299	=over 4	1647	=over 4
1300		1648
1301	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1649	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1302		1650
1303	In this configuration the watcher triggers an event at the wallclock time	1651	In this configuration the watcher triggers an event after the wall clock
1304	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1652	time C<offset> has passed. It will not repeat and will not adjust when a
1305	that is, if it is to be run at January 1st 2011 then it will run when the	1653	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1306	system time reaches or surpasses this time.	1654	will be stopped and invoked when the system clock reaches or surpasses
		1655	this point in time.
1307		1656
1308	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1657	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1309		1658
1310	In this mode the watcher will always be scheduled to time out at the next	1659	In this mode the watcher will always be scheduled to time out at the next
1311	C<at + N * interval> time (for some integer N, which can also be negative)	1660	C<offset + N * interval> time (for some integer N, which can also be
1312	and then repeat, regardless of any time jumps.	1661	negative) and then repeat, regardless of any time jumps. The C<offset>
		1662	argument is merely an offset into the C<interval> periods.
1313		1663
1314	This can be used to create timers that do not drift with respect to system	1664	This can be used to create timers that do not drift with respect to the
1315	time:	1665	system clock, for example, here is an C<ev_periodic> that triggers each
		1666	hour, on the hour (with respect to UTC):
1316		1667
1317	ev_periodic_set (&periodic, 0., 3600., 0);	1668	ev_periodic_set (&periodic, 0., 3600., 0);
1318		1669
1319	This doesn't mean there will always be 3600 seconds in between triggers,	1670	This doesn't mean there will always be 3600 seconds in between triggers,
1320	but only that the the callback will be called when the system time shows a	1671	but only that the callback will be called when the system time shows a
1321	full hour (UTC), or more correctly, when the system time is evenly divisible	1672	full hour (UTC), or more correctly, when the system time is evenly divisible
1322	by 3600.	1673	by 3600.
1323		1674
1324	Another way to think about it (for the mathematically inclined) is that	1675	Another way to think about it (for the mathematically inclined) is that
1325	C<ev_periodic> will try to run the callback in this mode at the next possible	1676	C<ev_periodic> will try to run the callback in this mode at the next possible
1326	time where C<time = at (mod interval)>, regardless of any time jumps.	1677	time where C<time = offset (mod interval)>, regardless of any time jumps.
1327		1678
1328	For numerical stability it is preferable that the C<at> value is near	1679	For numerical stability it is preferable that the C<offset> value is near
1329	C<ev_now ()> (the current time), but there is no range requirement for	1680	C<ev_now ()> (the current time), but there is no range requirement for
1330	this value.	1681	this value, and in fact is often specified as zero.
1331		1682
		1683	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
		1685	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).
		1687
1332	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1688	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1333		1689
1334	In this mode the values for C<interval> and C<at> are both being	1690	In this mode the values for C<interval> and C<offset> are both being
1335	ignored. Instead, each time the periodic watcher gets scheduled, the	1691	ignored. Instead, each time the periodic watcher gets scheduled, the
1336	reschedule callback will be called with the watcher as first, and the	1692	reschedule callback will be called with the watcher as first, and the
1337	current time as second argument.	1693	current time as second argument.
1338		1694
1339	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1695	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1340	ever, or make any event loop modifications>. If you need to stop it,	1696	or make ANY other event loop modifications whatsoever, unless explicitly
1341	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1697	allowed by documentation here>.
1342	starting an C<ev_prepare> watcher, which is legal).
1343		1698
		1699	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1700	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1701	only event loop modification you are allowed to do).
		1702
1344	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1703	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1345	ev_tstamp now)>, e.g.:	1704	*w, ev_tstamp now)>, e.g.:
1346		1705
		1706	static ev_tstamp
1347	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1707	my_rescheduler (ev_periodic *w, ev_tstamp now)
1348	{	1708	{
1349	return now + 60.;	1709	return now + 60.;
1350	}	1710	}
1351		1711
1352	It must return the next time to trigger, based on the passed time value	1712	It must return the next time to trigger, based on the passed time value
1353	(that is, the lowest time value larger than to the second argument). It	1713	(that is, the lowest time value larger than to the second argument). It
1354	will usually be called just before the callback will be triggered, but	1714	will usually be called just before the callback will be triggered, but
1355	might be called at other times, too.	1715	might be called at other times, too.
1356		1716
1357	NOTE: I<< This callback must always return a time that is later than the	1717	NOTE: I<< This callback must always return a time that is higher than or
1358	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1718	equal to the passed C<now> value >>.
1359		1719
1360	This can be used to create very complex timers, such as a timer that	1720	This can be used to create very complex timers, such as a timer that
1361	triggers on each midnight, local time. To do this, you would calculate the	1721	triggers on "next midnight, local time". To do this, you would calculate the
1362	next midnight after C<now> and return the timestamp value for this. How	1722	next midnight after C<now> and return the timestamp value for this. How
1363	you do this is, again, up to you (but it is not trivial, which is the main	1723	you do this is, again, up to you (but it is not trivial, which is the main
1364	reason I omitted it as an example).	1724	reason I omitted it as an example).
1365		1725
1366	=back	1726	=back
…		…
1370	Simply stops and restarts the periodic watcher again. This is only useful	1730	Simply stops and restarts the periodic watcher again. This is only useful
1371	when you changed some parameters or the reschedule callback would return	1731	when you changed some parameters or the reschedule callback would return
1372	a different time than the last time it was called (e.g. in a crond like	1732	a different time than the last time it was called (e.g. in a crond like
1373	program when the crontabs have changed).	1733	program when the crontabs have changed).
1374		1734
		1735	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1736
		1737	When active, returns the absolute time that the watcher is supposed
		1738	to trigger next. This is not the same as the C<offset> argument to
		1739	C<ev_periodic_set>, but indeed works even in interval and manual
		1740	rescheduling modes.
		1741
1375	=item ev_tstamp offset [read-write]	1742	=item ev_tstamp offset [read-write]
1376		1743
1377	When repeating, this contains the offset value, otherwise this is the	1744	When repeating, this contains the offset value, otherwise this is the
1378	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1745	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1746	although libev might modify this value for better numerical stability).
1379		1747
1380	Can be modified any time, but changes only take effect when the periodic	1748	Can be modified any time, but changes only take effect when the periodic
1381	timer fires or C<ev_periodic_again> is being called.	1749	timer fires or C<ev_periodic_again> is being called.
1382		1750
1383	=item ev_tstamp interval [read-write]	1751	=item ev_tstamp interval [read-write]
1384		1752
1385	The current interval value. Can be modified any time, but changes only	1753	The current interval value. Can be modified any time, but changes only
1386	take effect when the periodic timer fires or C<ev_periodic_again> is being	1754	take effect when the periodic timer fires or C<ev_periodic_again> is being
1387	called.	1755	called.
1388		1756
1389	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1757	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1390		1758
1391	The current reschedule callback, or C<0>, if this functionality is	1759	The current reschedule callback, or C<0>, if this functionality is
1392	switched off. Can be changed any time, but changes only take effect when	1760	switched off. Can be changed any time, but changes only take effect when
1393	the periodic timer fires or C<ev_periodic_again> is being called.	1761	the periodic timer fires or C<ev_periodic_again> is being called.
1394		1762
1395	=item ev_tstamp at [read-only]
1396
1397	When active, contains the absolute time that the watcher is supposed to
1398	trigger next.
1399
1400	=back	1763	=back
1401		1764
1402	=head3 Examples	1765	=head3 Examples
1403		1766
1404	Example: Call a callback every hour, or, more precisely, whenever the	1767	Example: Call a callback every hour, or, more precisely, whenever the
1405	system clock is divisible by 3600. The callback invocation times have	1768	system time is divisible by 3600. The callback invocation times have
1406	potentially a lot of jittering, but good long-term stability.	1769	potentially a lot of jitter, but good long-term stability.
1407		1770
1408	static void	1771	static void
1409	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1772	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1410	{	1773	{
1411	... its now a full hour (UTC, or TAI or whatever your clock follows)	1774	... its now a full hour (UTC, or TAI or whatever your clock follows)
1412	}	1775	}
1413		1776
1414	struct ev_periodic hourly_tick;	1777	ev_periodic hourly_tick;
1415	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1778	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1416	ev_periodic_start (loop, &hourly_tick);	1779	ev_periodic_start (loop, &hourly_tick);
1417		1780
1418	Example: The same as above, but use a reschedule callback to do it:	1781	Example: The same as above, but use a reschedule callback to do it:
1419		1782
1420	#include <math.h>	1783	#include <math.h>
1421		1784
1422	static ev_tstamp	1785	static ev_tstamp
1423	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1786	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1424	{	1787	{
1425	return fmod (now, 3600.) + 3600.;	1788	return now + (3600. - fmod (now, 3600.));
1426	}	1789	}
1427		1790
1428	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1791	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1429		1792
1430	Example: Call a callback every hour, starting now:	1793	Example: Call a callback every hour, starting now:
1431		1794
1432	struct ev_periodic hourly_tick;	1795	ev_periodic hourly_tick;
1433	ev_periodic_init (&hourly_tick, clock_cb,	1796	ev_periodic_init (&hourly_tick, clock_cb,
1434	fmod (ev_now (loop), 3600.), 3600., 0);	1797	fmod (ev_now (loop), 3600.), 3600., 0);
1435	ev_periodic_start (loop, &hourly_tick);	1798	ev_periodic_start (loop, &hourly_tick);
1436		1799
1437		1800
1438	=head2 C<ev_signal> - signal me when a signal gets signalled!	1801	=head2 C<ev_signal> - signal me when a signal gets signalled!
1439		1802
1440	Signal watchers will trigger an event when the process receives a specific	1803	Signal watchers will trigger an event when the process receives a specific
1441	signal one or more times. Even though signals are very asynchronous, libev	1804	signal one or more times. Even though signals are very asynchronous, libev
1442	will try it's best to deliver signals synchronously, i.e. as part of the	1805	will try it's best to deliver signals synchronously, i.e. as part of the
1443	normal event processing, like any other event.	1806	normal event processing, like any other event.
1444		1807
		1808	If you want signals asynchronously, just use C<sigaction> as you would
		1809	do without libev and forget about sharing the signal. You can even use
		1810	C<ev_async> from a signal handler to synchronously wake up an event loop.
		1811
1445	You can configure as many watchers as you like per signal. Only when the	1812	You can configure as many watchers as you like per signal. Only when the
1446	first watcher gets started will libev actually register a signal watcher	1813	first watcher gets started will libev actually register a signal handler
1447	with the kernel (thus it coexists with your own signal handlers as long	1814	with the kernel (thus it coexists with your own signal handlers as long as
1448	as you don't register any with libev). Similarly, when the last signal	1815	you don't register any with libev for the same signal). Similarly, when
1449	watcher for a signal is stopped libev will reset the signal handler to	1816	the last signal watcher for a signal is stopped, libev will reset the
1450	SIG_DFL (regardless of what it was set to before).	1817	signal handler to SIG_DFL (regardless of what it was set to before).
1451		1818
1452	If possible and supported, libev will install its handlers with	1819	If possible and supported, libev will install its handlers with
1453	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly	1820	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1454	interrupted. If you have a problem with syscalls getting interrupted by	1821	interrupted. If you have a problem with system calls getting interrupted by
1455	signals you can block all signals in an C<ev_check> watcher and unblock	1822	signals you can block all signals in an C<ev_check> watcher and unblock
1456	them in an C<ev_prepare> watcher.	1823	them in an C<ev_prepare> watcher.
1457		1824
1458	=head3 Watcher-Specific Functions and Data Members	1825	=head3 Watcher-Specific Functions and Data Members
1459		1826
…		…
1472		1839
1473	=back	1840	=back
1474		1841
1475	=head3 Examples	1842	=head3 Examples
1476		1843
1477	Example: Try to exit cleanly on SIGINT and SIGTERM.	1844	Example: Try to exit cleanly on SIGINT.
1478		1845
1479	static void	1846	static void
1480	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1847	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1481	{	1848	{
1482	ev_unloop (loop, EVUNLOOP_ALL);	1849	ev_unloop (loop, EVUNLOOP_ALL);
1483	}	1850	}
1484		1851
1485	struct ev_signal signal_watcher;	1852	ev_signal signal_watcher;
1486	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1853	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1487	ev_signal_start (loop, &sigint_cb);	1854	ev_signal_start (loop, &signal_watcher);
1488		1855
1489		1856
1490	=head2 C<ev_child> - watch out for process status changes	1857	=head2 C<ev_child> - watch out for process status changes
1491		1858
1492	Child watchers trigger when your process receives a SIGCHLD in response to	1859	Child watchers trigger when your process receives a SIGCHLD in response to
1493	some child status changes (most typically when a child of yours dies). It	1860	some child status changes (most typically when a child of yours dies or
1494	is permissible to install a child watcher I<after> the child has been	1861	exits). It is permissible to install a child watcher I<after> the child
1495	forked (which implies it might have already exited), as long as the event	1862	has been forked (which implies it might have already exited), as long
1496	loop isn't entered (or is continued from a watcher).	1863	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,
		1865	but forking and registering a watcher a few event loop iterations later is
		1866	not.
1497		1867
1498	Only the default event loop is capable of handling signals, and therefore	1868	Only the default event loop is capable of handling signals, and therefore
1499	you can only rgeister child watchers in the default event loop.	1869	you can only register child watchers in the default event loop.
1500		1870
1501	=head3 Process Interaction	1871	=head3 Process Interaction
1502		1872
1503	Libev grabs C<SIGCHLD> as soon as the default event loop is	1873	Libev grabs C<SIGCHLD> as soon as the default event loop is
1504	initialised. This is necessary to guarantee proper behaviour even if	1874	initialised. This is necessary to guarantee proper behaviour even if
1505	the first child watcher is started after the child exits. The occurance	1875	the first child watcher is started after the child exits. The occurrence
1506	of C<SIGCHLD> is recorded asynchronously, but child reaping is done	1876	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1507	synchronously as part of the event loop processing. Libev always reaps all	1877	synchronously as part of the event loop processing. Libev always reaps all
1508	children, even ones not watched.	1878	children, even ones not watched.
1509		1879
1510	=head3 Overriding the Built-In Processing	1880	=head3 Overriding the Built-In Processing
…		…
1514	handler, you can override it easily by installing your own handler for	1884	handler, you can override it easily by installing your own handler for
1515	C<SIGCHLD> after initialising the default loop, and making sure the	1885	C<SIGCHLD> after initialising the default loop, and making sure the
1516	default loop never gets destroyed. You are encouraged, however, to use an	1886	default loop never gets destroyed. You are encouraged, however, to use an
1517	event-based approach to child reaping and thus use libev's support for	1887	event-based approach to child reaping and thus use libev's support for
1518	that, so other libev users can use C<ev_child> watchers freely.	1888	that, so other libev users can use C<ev_child> watchers freely.
		1889
		1890	=head3 Stopping the Child Watcher
		1891
		1892	Currently, the child watcher never gets stopped, even when the
		1893	child terminates, so normally one needs to stop the watcher in the
		1894	callback. Future versions of libev might stop the watcher automatically
		1895	when a child exit is detected.
1519		1896
1520	=head3 Watcher-Specific Functions and Data Members	1897	=head3 Watcher-Specific Functions and Data Members
1521		1898
1522	=over 4	1899	=over 4
1523		1900
…		…
1552	=head3 Examples	1929	=head3 Examples
1553		1930
1554	Example: C<fork()> a new process and install a child handler to wait for	1931	Example: C<fork()> a new process and install a child handler to wait for
1555	its completion.	1932	its completion.
1556		1933
1557	ev_child cw;	1934	ev_child cw;
1558		1935
1559	static void	1936	static void
1560	child_cb (EV_P_ struct ev_child *w, int revents)	1937	child_cb (EV_P_ ev_child *w, int revents)
1561	{	1938	{
1562	ev_child_stop (EV_A_ w);	1939	ev_child_stop (EV_A_ w);
1563	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	1940	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1564	}	1941	}
1565		1942
1566	pid_t pid = fork ();	1943	pid_t pid = fork ();
1567		1944
1568	if (pid < 0)	1945	if (pid < 0)
1569	// error	1946	// error
1570	else if (pid == 0)	1947	else if (pid == 0)
1571	{	1948	{
1572	// the forked child executes here	1949	// the forked child executes here
1573	exit (1);	1950	exit (1);
1574	}	1951	}
1575	else	1952	else
1576	{	1953	{
1577	ev_child_init (&cw, child_cb, pid, 0);	1954	ev_child_init (&cw, child_cb, pid, 0);
1578	ev_child_start (EV_DEFAULT_ &cw);	1955	ev_child_start (EV_DEFAULT_ &cw);
1579	}	1956	}
1580		1957
1581		1958
1582	=head2 C<ev_stat> - did the file attributes just change?	1959	=head2 C<ev_stat> - did the file attributes just change?
1583		1960
1584	This watches a filesystem path for attribute changes. That is, it calls	1961	This watches a file system path for attribute changes. That is, it calls
1585	C<stat> regularly (or when the OS says it changed) and sees if it changed	1962	C<stat> on that path in regular intervals (or when the OS says it changed)
1586	compared to the last time, invoking the callback if it did.	1963	and sees if it changed compared to the last time, invoking the callback if
		1964	it did.
1587		1965
1588	The path does not need to exist: changing from "path exists" to "path does	1966	The path does not need to exist: changing from "path exists" to "path does
1589	not exist" is a status change like any other. The condition "path does	1967	not exist" is a status change like any other. The condition "path does not
1590	not exist" is signified by the C<st_nlink> field being zero (which is	1968	exist" (or more correctly "path cannot be stat'ed") is signified by the
1591	otherwise always forced to be at least one) and all the other fields of	1969	C<st_nlink> field being zero (which is otherwise always forced to be at
1592	the stat buffer having unspecified contents.	1970	least one) and all the other fields of the stat buffer having unspecified
		1971	contents.
1593		1972
1594	The path I<should> be absolute and I<must not> end in a slash. If it is	1973	The path I<must not> end in a slash or contain special components such as
		1974	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1595	relative and your working directory changes, the behaviour is undefined.	1975	your working directory changes, then the behaviour is undefined.
1596		1976
1597	Since there is no standard to do this, the portable implementation simply	1977	Since there is no portable change notification interface available, the
1598	calls C<stat (2)> regularly on the path to see if it changed somehow. You	1978	portable implementation simply calls C<stat(2)> regularly on the path
1599	can specify a recommended polling interval for this case. If you specify	1979	to see if it changed somehow. You can specify a recommended polling
1600	a polling interval of C<0> (highly recommended!) then a I<suitable,	1980	interval for this case. If you specify a polling interval of C<0> (highly
1601	unspecified default> value will be used (which you can expect to be around	1981	recommended!) then a I<suitable, unspecified default> value will be used
1602	five seconds, although this might change dynamically). Libev will also	1982	(which you can expect to be around five seconds, although this might
1603	impose a minimum interval which is currently around C<0.1>, but thats	1983	change dynamically). Libev will also impose a minimum interval which is
1604	usually overkill.	1984	currently around C<0.1>, but that's usually overkill.
1605		1985
1606	This watcher type is not meant for massive numbers of stat watchers,	1986	This watcher type is not meant for massive numbers of stat watchers,
1607	as even with OS-supported change notifications, this can be	1987	as even with OS-supported change notifications, this can be
1608	resource-intensive.	1988	resource-intensive.
1609		1989
1610	At the time of this writing, only the Linux inotify interface is	1990	At the time of this writing, the only OS-specific interface implemented
1611	implemented (implementing kqueue support is left as an exercise for the	1991	is the Linux inotify interface (implementing kqueue support is left as an
1612	reader). Inotify will be used to give hints only and should not change the	1992	exercise for the reader. Note, however, that the author sees no way of
1613	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1993	implementing C<ev_stat> semantics with kqueue, except as a hint).
1614	to fall back to regular polling again even with inotify, but changes are
1615	usually detected immediately, and if the file exists there will be no
1616	polling.
1617		1994
1618	=head3 ABI Issues (Largefile Support)	1995	=head3 ABI Issues (Largefile Support)
1619		1996
1620	Libev by default (unless the user overrides this) uses the default	1997	Libev by default (unless the user overrides this) uses the default
1621	compilation environment, which means that on systems with optionally	1998	compilation environment, which means that on systems with large file
1622	disabled large file support, you get the 32 bit version of the stat	1999	support disabled by default, you get the 32 bit version of the stat
1623	structure. When using the library from programs that change the ABI to	2000	structure. When using the library from programs that change the ABI to
1624	use 64 bit file offsets the programs will fail. In that case you have to	2001	use 64 bit file offsets the programs will fail. In that case you have to
1625	compile libev with the same flags to get binary compatibility. This is	2002	compile libev with the same flags to get binary compatibility. This is
1626	obviously the case with any flags that change the ABI, but the problem is	2003	obviously the case with any flags that change the ABI, but the problem is
1627	most noticably with ev_stat and largefile support.	2004	most noticeably displayed with ev_stat and large file support.
1628		2005
1629	=head3 Inotify	2006	The solution for this is to lobby your distribution maker to make large
		2007	file interfaces available by default (as e.g. FreeBSD does) and not
		2008	optional. Libev cannot simply switch on large file support because it has
		2009	to exchange stat structures with application programs compiled using the
		2010	default compilation environment.
1630		2011
		2012	=head3 Inotify and Kqueue
		2013
1631	When C<inotify (7)> support has been compiled into libev (generally only	2014	When C<inotify (7)> support has been compiled into libev and present at
1632	available on Linux) and present at runtime, it will be used to speed up	2015	runtime, it will be used to speed up change detection where possible. The
1633	change detection where possible. The inotify descriptor will be created lazily	2016	inotify descriptor will be created lazily when the first C<ev_stat>
1634	when the first C<ev_stat> watcher is being started.	2017	watcher is being started.
1635		2018
1636	Inotify presense does not change the semantics of C<ev_stat> watchers	2019	Inotify presence does not change the semantics of C<ev_stat> watchers
1637	except that changes might be detected earlier, and in some cases, to avoid	2020	except that changes might be detected earlier, and in some cases, to avoid
1638	making regular C<stat> calls. Even in the presense of inotify support	2021	making regular C<stat> calls. Even in the presence of inotify support
1639	there are many cases where libev has to resort to regular C<stat> polling.	2022	there are many cases where libev has to resort to regular C<stat> polling,
		2023	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2024	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2025	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2026	xfs are fully working) libev usually gets away without polling.
1640		2027
1641	(There is no support for kqueue, as apparently it cannot be used to	2028	There is no support for kqueue, as apparently it cannot be used to
1642	implement this functionality, due to the requirement of having a file	2029	implement this functionality, due to the requirement of having a file
1643	descriptor open on the object at all times).	2030	descriptor open on the object at all times, and detecting renames, unlinks
		2031	etc. is difficult.
		2032
		2033	=head3 C<stat ()> is a synchronous operation
		2034
		2035	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2036	the process. The exception are C<ev_stat> watchers - those call C<stat
		2037	()>, which is a synchronous operation.
		2038
		2039	For local paths, this usually doesn't matter: unless the system is very
		2040	busy or the intervals between stat's are large, a stat call will be fast,
		2041	as the path data is usually in memory already (except when starting the
		2042	watcher).
		2043
		2044	For networked file systems, calling C<stat ()> can block an indefinite
		2045	time due to network issues, and even under good conditions, a stat call
		2046	often takes multiple milliseconds.
		2047
		2048	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2049	paths, although this is fully supported by libev.
1644		2050
1645	=head3 The special problem of stat time resolution	2051	=head3 The special problem of stat time resolution
1646		2052
1647	The C<stat ()> syscall only supports full-second resolution portably, and	2053	The C<stat ()> system call only supports full-second resolution portably,
1648	even on systems where the resolution is higher, many filesystems still	2054	and even on systems where the resolution is higher, most file systems
1649	only support whole seconds.	2055	still only support whole seconds.
1650		2056
1651	That means that, if the time is the only thing that changes, you might	2057	That means that, if the time is the only thing that changes, you can
1652	miss updates: on the first update, C<ev_stat> detects a change and calls	2058	easily miss updates: on the first update, C<ev_stat> detects a change and
1653	your callback, which does something. When there is another update within	2059	calls your callback, which does something. When there is another update
1654	the same second, C<ev_stat> will be unable to detect it.	2060	within the same second, C<ev_stat> will be unable to detect unless the
		2061	stat data does change in other ways (e.g. file size).
1655		2062
1656	The solution to this is to delay acting on a change for a second (or till	2063	The solution to this is to delay acting on a change for slightly more
1657	the next second boundary), using a roughly one-second delay C<ev_timer>	2064	than a second (or till slightly after the next full second boundary), using
1658	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	2065	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1659	is added to work around small timing inconsistencies of some operating	2066	ev_timer_again (loop, w)>).
1660	systems.	2067
		2068	The C<.02> offset is added to work around small timing inconsistencies
		2069	of some operating systems (where the second counter of the current time
		2070	might be be delayed. One such system is the Linux kernel, where a call to
		2071	C<gettimeofday> might return a timestamp with a full second later than
		2072	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		2073	update file times then there will be a small window where the kernel uses
		2074	the previous second to update file times but libev might already execute
		2075	the timer callback).
1661		2076
1662	=head3 Watcher-Specific Functions and Data Members	2077	=head3 Watcher-Specific Functions and Data Members
1663		2078
1664	=over 4	2079	=over 4
1665		2080
…		…
1671	C<path>. The C<interval> is a hint on how quickly a change is expected to	2086	C<path>. The C<interval> is a hint on how quickly a change is expected to
1672	be detected and should normally be specified as C<0> to let libev choose	2087	be detected and should normally be specified as C<0> to let libev choose
1673	a suitable value. The memory pointed to by C<path> must point to the same	2088	a suitable value. The memory pointed to by C<path> must point to the same
1674	path for as long as the watcher is active.	2089	path for as long as the watcher is active.
1675		2090
1676	The callback will be receive C<EV_STAT> when a change was detected,	2091	The callback will receive an C<EV_STAT> event when a change was detected,
1677	relative to the attributes at the time the watcher was started (or the	2092	relative to the attributes at the time the watcher was started (or the
1678	last change was detected).	2093	last change was detected).
1679		2094
1680	=item ev_stat_stat (loop, ev_stat *)	2095	=item ev_stat_stat (loop, ev_stat *)
1681		2096
1682	Updates the stat buffer immediately with new values. If you change the	2097	Updates the stat buffer immediately with new values. If you change the
1683	watched path in your callback, you could call this fucntion to avoid	2098	watched path in your callback, you could call this function to avoid
1684	detecting this change (while introducing a race condition). Can also be	2099	detecting this change (while introducing a race condition if you are not
1685	useful simply to find out the new values.	2100	the only one changing the path). Can also be useful simply to find out the
		2101	new values.
1686		2102
1687	=item ev_statdata attr [read-only]	2103	=item ev_statdata attr [read-only]
1688		2104
1689	The most-recently detected attributes of the file. Although the type is of	2105	The most-recently detected attributes of the file. Although the type is
1690	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	2106	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1691	suitable for your system. If the C<st_nlink> member is C<0>, then there	2107	suitable for your system, but you can only rely on the POSIX-standardised
		2108	members to be present. If the C<st_nlink> member is C<0>, then there was
1692	was some error while C<stat>ing the file.	2109	some error while C<stat>ing the file.
1693		2110
1694	=item ev_statdata prev [read-only]	2111	=item ev_statdata prev [read-only]
1695		2112
1696	The previous attributes of the file. The callback gets invoked whenever	2113	The previous attributes of the file. The callback gets invoked whenever
1697	C<prev> != C<attr>.	2114	C<prev> != C<attr>, or, more precisely, one or more of these members
		2115	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		2116	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1698		2117
1699	=item ev_tstamp interval [read-only]	2118	=item ev_tstamp interval [read-only]
1700		2119
1701	The specified interval.	2120	The specified interval.
1702		2121
1703	=item const char *path [read-only]	2122	=item const char *path [read-only]
1704		2123
1705	The filesystem path that is being watched.	2124	The file system path that is being watched.
1706		2125
1707	=back	2126	=back
1708		2127
1709	=head3 Examples	2128	=head3 Examples
1710		2129
1711	Example: Watch C</etc/passwd> for attribute changes.	2130	Example: Watch C</etc/passwd> for attribute changes.
1712		2131
1713	static void	2132	static void
1714	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	2133	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1715	{	2134	{
1716	/* /etc/passwd changed in some way */	2135	/* /etc/passwd changed in some way */
1717	if (w->attr.st_nlink)	2136	if (w->attr.st_nlink)
1718	{	2137	{
1719	printf ("passwd current size %ld\n", (long)w->attr.st_size);	2138	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1720	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	2139	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1721	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	2140	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1722	}	2141	}
1723	else	2142	else
1724	/* you shalt not abuse printf for puts */	2143	/* you shalt not abuse printf for puts */
1725	puts ("wow, /etc/passwd is not there, expect problems. "	2144	puts ("wow, /etc/passwd is not there, expect problems. "
1726	"if this is windows, they already arrived\n");	2145	"if this is windows, they already arrived\n");
1727	}	2146	}
1728		2147
1729	...	2148	...
1730	ev_stat passwd;	2149	ev_stat passwd;
1731		2150
1732	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	2151	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1733	ev_stat_start (loop, &passwd);	2152	ev_stat_start (loop, &passwd);
1734		2153
1735	Example: Like above, but additionally use a one-second delay so we do not	2154	Example: Like above, but additionally use a one-second delay so we do not
1736	miss updates (however, frequent updates will delay processing, too, so	2155	miss updates (however, frequent updates will delay processing, too, so
1737	one might do the work both on C<ev_stat> callback invocation I<and> on	2156	one might do the work both on C<ev_stat> callback invocation I<and> on
1738	C<ev_timer> callback invocation).	2157	C<ev_timer> callback invocation).
1739		2158
1740	static ev_stat passwd;	2159	static ev_stat passwd;
1741	static ev_timer timer;	2160	static ev_timer timer;
1742		2161
1743	static void	2162	static void
1744	timer_cb (EV_P_ ev_timer *w, int revents)	2163	timer_cb (EV_P_ ev_timer *w, int revents)
1745	{	2164	{
1746	ev_timer_stop (EV_A_ w);	2165	ev_timer_stop (EV_A_ w);
1747		2166
1748	/* now it's one second after the most recent passwd change */	2167	/* now it's one second after the most recent passwd change */
1749	}	2168	}
1750		2169
1751	static void	2170	static void
1752	stat_cb (EV_P_ ev_stat *w, int revents)	2171	stat_cb (EV_P_ ev_stat *w, int revents)
1753	{	2172	{
1754	/* reset the one-second timer */	2173	/* reset the one-second timer */
1755	ev_timer_again (EV_A_ &timer);	2174	ev_timer_again (EV_A_ &timer);
1756	}	2175	}
1757		2176
1758	...	2177	...
1759	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	2178	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1760	ev_stat_start (loop, &passwd);	2179	ev_stat_start (loop, &passwd);
1761	ev_timer_init (&timer, timer_cb, 0., 1.01);	2180	ev_timer_init (&timer, timer_cb, 0., 1.02);
1762		2181
1763		2182
1764	=head2 C<ev_idle> - when you've got nothing better to do...	2183	=head2 C<ev_idle> - when you've got nothing better to do...
1765		2184
1766	Idle watchers trigger events when no other events of the same or higher	2185	Idle watchers trigger events when no other events of the same or higher
1767	priority are pending (prepare, check and other idle watchers do not	2186	priority are pending (prepare, check and other idle watchers do not count
1768	count).	2187	as receiving "events").
1769		2188
1770	That is, as long as your process is busy handling sockets or timeouts	2189	That is, as long as your process is busy handling sockets or timeouts
1771	(or even signals, imagine) of the same or higher priority it will not be	2190	(or even signals, imagine) of the same or higher priority it will not be
1772	triggered. But when your process is idle (or only lower-priority watchers	2191	triggered. But when your process is idle (or only lower-priority watchers
1773	are pending), the idle watchers are being called once per event loop	2192	are pending), the idle watchers are being called once per event loop
…		…
1784		2203
1785	=head3 Watcher-Specific Functions and Data Members	2204	=head3 Watcher-Specific Functions and Data Members
1786		2205
1787	=over 4	2206	=over 4
1788		2207
1789	=item ev_idle_init (ev_signal *, callback)	2208	=item ev_idle_init (ev_idle *, callback)
1790		2209
1791	Initialises and configures the idle watcher - it has no parameters of any	2210	Initialises and configures the idle watcher - it has no parameters of any
1792	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2211	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1793	believe me.	2212	believe me.
1794		2213
…		…
1797	=head3 Examples	2216	=head3 Examples
1798		2217
1799	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2218	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1800	callback, free it. Also, use no error checking, as usual.	2219	callback, free it. Also, use no error checking, as usual.
1801		2220
1802	static void	2221	static void
1803	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2222	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1804	{	2223	{
1805	free (w);	2224	free (w);
1806	// now do something you wanted to do when the program has	2225	// now do something you wanted to do when the program has
1807	// no longer anything immediate to do.	2226	// no longer anything immediate to do.
1808	}	2227	}
1809		2228
1810	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2229	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1811	ev_idle_init (idle_watcher, idle_cb);	2230	ev_idle_init (idle_watcher, idle_cb);
1812	ev_idle_start (loop, idle_cb);	2231	ev_idle_start (loop, idle_cb);
1813		2232
1814		2233
1815	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2234	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1816		2235
1817	Prepare and check watchers are usually (but not always) used in tandem:	2236	Prepare and check watchers are usually (but not always) used in pairs:
1818	prepare watchers get invoked before the process blocks and check watchers	2237	prepare watchers get invoked before the process blocks and check watchers
1819	afterwards.	2238	afterwards.
1820		2239
1821	You I<must not> call C<ev_loop> or similar functions that enter	2240	You I<must not> call C<ev_loop> or similar functions that enter
1822	the current event loop from either C<ev_prepare> or C<ev_check>	2241	the current event loop from either C<ev_prepare> or C<ev_check>
…		…
1825	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2244	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
1826	C<ev_check> so if you have one watcher of each kind they will always be	2245	C<ev_check> so if you have one watcher of each kind they will always be
1827	called in pairs bracketing the blocking call.	2246	called in pairs bracketing the blocking call.
1828		2247
1829	Their main purpose is to integrate other event mechanisms into libev and	2248	Their main purpose is to integrate other event mechanisms into libev and
1830	their use is somewhat advanced. This could be used, for example, to track	2249	their use is somewhat advanced. They could be used, for example, to track
1831	variable changes, implement your own watchers, integrate net-snmp or a	2250	variable changes, implement your own watchers, integrate net-snmp or a
1832	coroutine library and lots more. They are also occasionally useful if	2251	coroutine library and lots more. They are also occasionally useful if
1833	you cache some data and want to flush it before blocking (for example,	2252	you cache some data and want to flush it before blocking (for example,
1834	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>	2253	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1835	watcher).	2254	watcher).
1836		2255
1837	This is done by examining in each prepare call which file descriptors need	2256	This is done by examining in each prepare call which file descriptors
1838	to be watched by the other library, registering C<ev_io> watchers for	2257	need to be watched by the other library, registering C<ev_io> watchers
1839	them and starting an C<ev_timer> watcher for any timeouts (many libraries	2258	for them and starting an C<ev_timer> watcher for any timeouts (many
1840	provide just this functionality). Then, in the check watcher you check for	2259	libraries provide exactly this functionality). Then, in the check watcher,
1841	any events that occured (by checking the pending status of all watchers	2260	you check for any events that occurred (by checking the pending status
1842	and stopping them) and call back into the library. The I/O and timer	2261	of all watchers and stopping them) and call back into the library. The
1843	callbacks will never actually be called (but must be valid nevertheless,	2262	I/O and timer callbacks will never actually be called (but must be valid
1844	because you never know, you know?).	2263	nevertheless, because you never know, you know?).
1845		2264
1846	As another example, the Perl Coro module uses these hooks to integrate	2265	As another example, the Perl Coro module uses these hooks to integrate
1847	coroutines into libev programs, by yielding to other active coroutines	2266	coroutines into libev programs, by yielding to other active coroutines
1848	during each prepare and only letting the process block if no coroutines	2267	during each prepare and only letting the process block if no coroutines
1849	are ready to run (it's actually more complicated: it only runs coroutines	2268	are ready to run (it's actually more complicated: it only runs coroutines
…		…
1852	loop from blocking if lower-priority coroutines are active, thus mapping	2271	loop from blocking if lower-priority coroutines are active, thus mapping
1853	low-priority coroutines to idle/background tasks).	2272	low-priority coroutines to idle/background tasks).
1854		2273
1855	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2274	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1856	priority, to ensure that they are being run before any other watchers	2275	priority, to ensure that they are being run before any other watchers
		2276	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2277
1857	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2278	Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
1858	too) should not activate ("feed") events into libev. While libev fully	2279	activate ("feed") events into libev. While libev fully supports this, they
1859	supports this, they will be called before other C<ev_check> watchers	2280	might get executed before other C<ev_check> watchers did their job. As
1860	did their job. As C<ev_check> watchers are often used to embed other	2281	C<ev_check> watchers are often used to embed other (non-libev) event
1861	(non-libev) event loops those other event loops might be in an unusable	2282	loops those other event loops might be in an unusable state until their
1862	state until their C<ev_check> watcher ran (always remind yourself to	2283	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1863	coexist peacefully with others).	2284	others).
1864		2285
1865	=head3 Watcher-Specific Functions and Data Members	2286	=head3 Watcher-Specific Functions and Data Members
1866		2287
1867	=over 4	2288	=over 4
1868		2289
…		…
1870		2291
1871	=item ev_check_init (ev_check *, callback)	2292	=item ev_check_init (ev_check *, callback)
1872		2293
1873	Initialises and configures the prepare or check watcher - they have no	2294	Initialises and configures the prepare or check watcher - they have no
1874	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	2295	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1875	macros, but using them is utterly, utterly and completely pointless.	2296	macros, but using them is utterly, utterly, utterly and completely
		2297	pointless.
1876		2298
1877	=back	2299	=back
1878		2300
1879	=head3 Examples	2301	=head3 Examples
1880		2302
1881	There are a number of principal ways to embed other event loops or modules	2303	There are a number of principal ways to embed other event loops or modules
1882	into libev. Here are some ideas on how to include libadns into libev	2304	into libev. Here are some ideas on how to include libadns into libev
1883	(there is a Perl module named C<EV::ADNS> that does this, which you could	2305	(there is a Perl module named C<EV::ADNS> that does this, which you could
1884	use for an actually working example. Another Perl module named C<EV::Glib>	2306	use as a working example. Another Perl module named C<EV::Glib> embeds a
1885	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	2307	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1886	into the Glib event loop).	2308	Glib event loop).
1887		2309
1888	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	2310	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1889	and in a check watcher, destroy them and call into libadns. What follows	2311	and in a check watcher, destroy them and call into libadns. What follows
1890	is pseudo-code only of course. This requires you to either use a low	2312	is pseudo-code only of course. This requires you to either use a low
1891	priority for the check watcher or use C<ev_clear_pending> explicitly, as	2313	priority for the check watcher or use C<ev_clear_pending> explicitly, as
1892	the callbacks for the IO/timeout watchers might not have been called yet.	2314	the callbacks for the IO/timeout watchers might not have been called yet.
1893		2315
1894	static ev_io iow [nfd];	2316	static ev_io iow [nfd];
1895	static ev_timer tw;	2317	static ev_timer tw;
1896		2318
1897	static void	2319	static void
1898	io_cb (ev_loop *loop, ev_io *w, int revents)	2320	io_cb (struct ev_loop *loop, ev_io *w, int revents)
1899	{	2321	{
1900	}	2322	}
1901		2323
1902	// create io watchers for each fd and a timer before blocking	2324	// create io watchers for each fd and a timer before blocking
1903	static void	2325	static void
1904	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2326	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1905	{	2327	{
1906	int timeout = 3600000;	2328	int timeout = 3600000;
1907	struct pollfd fds [nfd];	2329	struct pollfd fds [nfd];
1908	// actual code will need to loop here and realloc etc.	2330	// actual code will need to loop here and realloc etc.
1909	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2331	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1910		2332
1911	/* the callback is illegal, but won't be called as we stop during check */	2333	/* the callback is illegal, but won't be called as we stop during check */
1912	ev_timer_init (&tw, 0, timeout * 1e-3);	2334	ev_timer_init (&tw, 0, timeout * 1e-3);
1913	ev_timer_start (loop, &tw);	2335	ev_timer_start (loop, &tw);
1914		2336
1915	// create one ev_io per pollfd	2337	// create one ev_io per pollfd
1916	for (int i = 0; i < nfd; ++i)	2338	for (int i = 0; i < nfd; ++i)
1917	{	2339	{
1918	ev_io_init (iow + i, io_cb, fds [i].fd,	2340	ev_io_init (iow + i, io_cb, fds [i].fd,
1919	((fds [i].events & POLLIN ? EV_READ : 0)	2341	((fds [i].events & POLLIN ? EV_READ : 0)
1920	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2342	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1921		2343
1922	fds [i].revents = 0;	2344	fds [i].revents = 0;
1923	ev_io_start (loop, iow + i);	2345	ev_io_start (loop, iow + i);
1924	}	2346	}
1925	}	2347	}
1926		2348
1927	// stop all watchers after blocking	2349	// stop all watchers after blocking
1928	static void	2350	static void
1929	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2351	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
1930	{	2352	{
1931	ev_timer_stop (loop, &tw);	2353	ev_timer_stop (loop, &tw);
1932		2354
1933	for (int i = 0; i < nfd; ++i)	2355	for (int i = 0; i < nfd; ++i)
1934	{	2356	{
1935	// set the relevant poll flags	2357	// set the relevant poll flags
1936	// could also call adns_processreadable etc. here	2358	// could also call adns_processreadable etc. here
1937	struct pollfd *fd = fds + i;	2359	struct pollfd *fd = fds + i;
1938	int revents = ev_clear_pending (iow + i);	2360	int revents = ev_clear_pending (iow + i);
1939	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2361	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1940	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2362	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1941		2363
1942	// now stop the watcher	2364	// now stop the watcher
1943	ev_io_stop (loop, iow + i);	2365	ev_io_stop (loop, iow + i);
1944	}	2366	}
1945		2367
1946	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2368	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
1947	}	2369	}
1948		2370
1949	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2371	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
1950	in the prepare watcher and would dispose of the check watcher.	2372	in the prepare watcher and would dispose of the check watcher.
1951		2373
1952	Method 3: If the module to be embedded supports explicit event	2374	Method 3: If the module to be embedded supports explicit event
1953	notification (adns does), you can also make use of the actual watcher	2375	notification (libadns does), you can also make use of the actual watcher
1954	callbacks, and only destroy/create the watchers in the prepare watcher.	2376	callbacks, and only destroy/create the watchers in the prepare watcher.
1955		2377
1956	static void	2378	static void
1957	timer_cb (EV_P_ ev_timer *w, int revents)	2379	timer_cb (EV_P_ ev_timer *w, int revents)
1958	{	2380	{
1959	adns_state ads = (adns_state)w->data;	2381	adns_state ads = (adns_state)w->data;
1960	update_now (EV_A);	2382	update_now (EV_A);
1961		2383
1962	adns_processtimeouts (ads, &tv_now);	2384	adns_processtimeouts (ads, &tv_now);
1963	}	2385	}
1964		2386
1965	static void	2387	static void
1966	io_cb (EV_P_ ev_io *w, int revents)	2388	io_cb (EV_P_ ev_io *w, int revents)
1967	{	2389	{
1968	adns_state ads = (adns_state)w->data;	2390	adns_state ads = (adns_state)w->data;
1969	update_now (EV_A);	2391	update_now (EV_A);
1970		2392
1971	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2393	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
1972	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2394	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
1973	}	2395	}
1974		2396
1975	// do not ever call adns_afterpoll	2397	// do not ever call adns_afterpoll
1976		2398
1977	Method 4: Do not use a prepare or check watcher because the module you	2399	Method 4: Do not use a prepare or check watcher because the module you
1978	want to embed is too inflexible to support it. Instead, youc na override	2400	want to embed is not flexible enough to support it. Instead, you can
1979	their poll function. The drawback with this solution is that the main	2401	override their poll function. The drawback with this solution is that the
1980	loop is now no longer controllable by EV. The C<Glib::EV> module does	2402	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
1981	this.	2403	this approach, effectively embedding EV as a client into the horrible
		2404	libglib event loop.
1982		2405
1983	static gint	2406	static gint
1984	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2407	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
1985	{	2408	{
1986	int got_events = 0;	2409	int got_events = 0;
1987		2410
1988	for (n = 0; n < nfds; ++n)	2411	for (n = 0; n < nfds; ++n)
1989	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2412	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
1990		2413
1991	if (timeout >= 0)	2414	if (timeout >= 0)
1992	// create/start timer	2415	// create/start timer
1993		2416
1994	// poll	2417	// poll
1995	ev_loop (EV_A_ 0);	2418	ev_loop (EV_A_ 0);
1996		2419
1997	// stop timer again	2420	// stop timer again
1998	if (timeout >= 0)	2421	if (timeout >= 0)
1999	ev_timer_stop (EV_A_ &to);	2422	ev_timer_stop (EV_A_ &to);
2000		2423
2001	// stop io watchers again - their callbacks should have set	2424	// stop io watchers again - their callbacks should have set
2002	for (n = 0; n < nfds; ++n)	2425	for (n = 0; n < nfds; ++n)
2003	ev_io_stop (EV_A_ iow [n]);	2426	ev_io_stop (EV_A_ iow [n]);
2004		2427
2005	return got_events;	2428	return got_events;
2006	}	2429	}
2007		2430
2008		2431
2009	=head2 C<ev_embed> - when one backend isn't enough...	2432	=head2 C<ev_embed> - when one backend isn't enough...
2010		2433
2011	This is a rather advanced watcher type that lets you embed one event loop	2434	This is a rather advanced watcher type that lets you embed one event loop
…		…
2017	prioritise I/O.	2440	prioritise I/O.
2018		2441
2019	As an example for a bug workaround, the kqueue backend might only support	2442	As an example for a bug workaround, the kqueue backend might only support
2020	sockets on some platform, so it is unusable as generic backend, but you	2443	sockets on some platform, so it is unusable as generic backend, but you
2021	still want to make use of it because you have many sockets and it scales	2444	still want to make use of it because you have many sockets and it scales
2022	so nicely. In this case, you would create a kqueue-based loop and embed it	2445	so nicely. In this case, you would create a kqueue-based loop and embed
2023	into your default loop (which might use e.g. poll). Overall operation will	2446	it into your default loop (which might use e.g. poll). Overall operation
2024	be a bit slower because first libev has to poll and then call kevent, but	2447	will be a bit slower because first libev has to call C<poll> and then
2025	at least you can use both at what they are best.	2448	C<kevent>, but at least you can use both mechanisms for what they are
		2449	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
2026		2450
2027	As for prioritising I/O: rarely you have the case where some fds have	2451	As for prioritising I/O: under rare circumstances you have the case where
2028	to be watched and handled very quickly (with low latency), and even	2452	some fds have to be watched and handled very quickly (with low latency),
2029	priorities and idle watchers might have too much overhead. In this case	2453	and even priorities and idle watchers might have too much overhead. In
2030	you would put all the high priority stuff in one loop and all the rest in	2454	this case you would put all the high priority stuff in one loop and all
2031	a second one, and embed the second one in the first.	2455	the rest in a second one, and embed the second one in the first.
2032		2456
2033	As long as the watcher is active, the callback will be invoked every time	2457	As long as the watcher is active, the callback will be invoked every
2034	there might be events pending in the embedded loop. The callback must then	2458	time there might be events pending in the embedded loop. The callback
2035	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2459	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2036	their callbacks (you could also start an idle watcher to give the embedded	2460	sweep and invoke their callbacks (the callback doesn't need to invoke the
2037	loop strictly lower priority for example). You can also set the callback	2461	C<ev_embed_sweep> function directly, it could also start an idle watcher
2038	to C<0>, in which case the embed watcher will automatically execute the	2462	to give the embedded loop strictly lower priority for example).
2039	embedded loop sweep.
2040		2463
2041	As long as the watcher is started it will automatically handle events. The	2464	You can also set the callback to C<0>, in which case the embed watcher
2042	callback will be invoked whenever some events have been handled. You can	2465	will automatically execute the embedded loop sweep whenever necessary.
2043	set the callback to C<0> to avoid having to specify one if you are not
2044	interested in that.
2045		2466
2046	Also, there have not currently been made special provisions for forking:	2467	Fork detection will be handled transparently while the C<ev_embed> watcher
2047	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2468	is active, i.e., the embedded loop will automatically be forked when the
2048	but you will also have to stop and restart any C<ev_embed> watchers	2469	embedding loop forks. In other cases, the user is responsible for calling
2049	yourself.	2470	C<ev_loop_fork> on the embedded loop.
2050		2471
2051	Unfortunately, not all backends are embeddable, only the ones returned by	2472	Unfortunately, not all backends are embeddable: only the ones returned by
2052	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2473	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2053	portable one.	2474	portable one.
2054		2475
2055	So when you want to use this feature you will always have to be prepared	2476	So when you want to use this feature you will always have to be prepared
2056	that you cannot get an embeddable loop. The recommended way to get around	2477	that you cannot get an embeddable loop. The recommended way to get around
2057	this is to have a separate variables for your embeddable loop, try to	2478	this is to have a separate variables for your embeddable loop, try to
2058	create it, and if that fails, use the normal loop for everything.	2479	create it, and if that fails, use the normal loop for everything.
2059		2480
		2481	=head3 C<ev_embed> and fork
		2482
		2483	While the C<ev_embed> watcher is running, forks in the embedding loop will
		2484	automatically be applied to the embedded loop as well, so no special
		2485	fork handling is required in that case. When the watcher is not running,
		2486	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		2487	as applicable.
		2488
2060	=head3 Watcher-Specific Functions and Data Members	2489	=head3 Watcher-Specific Functions and Data Members
2061		2490
2062	=over 4	2491	=over 4
2063		2492
2064	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	2493	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
…		…
2067		2496
2068	Configures the watcher to embed the given loop, which must be	2497	Configures the watcher to embed the given loop, which must be
2069	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be	2498	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
2070	invoked automatically, otherwise it is the responsibility of the callback	2499	invoked automatically, otherwise it is the responsibility of the callback
2071	to invoke it (it will continue to be called until the sweep has been done,	2500	to invoke it (it will continue to be called until the sweep has been done,
2072	if you do not want thta, you need to temporarily stop the embed watcher).	2501	if you do not want that, you need to temporarily stop the embed watcher).
2073		2502
2074	=item ev_embed_sweep (loop, ev_embed *)	2503	=item ev_embed_sweep (loop, ev_embed *)
2075		2504
2076	Make a single, non-blocking sweep over the embedded loop. This works	2505	Make a single, non-blocking sweep over the embedded loop. This works
2077	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2506	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
2078	apropriate way for embedded loops.	2507	appropriate way for embedded loops.
2079		2508
2080	=item struct ev_loop *other [read-only]	2509	=item struct ev_loop *other [read-only]
2081		2510
2082	The embedded event loop.	2511	The embedded event loop.
2083		2512
…		…
2085		2514
2086	=head3 Examples	2515	=head3 Examples
2087		2516
2088	Example: Try to get an embeddable event loop and embed it into the default	2517	Example: Try to get an embeddable event loop and embed it into the default
2089	event loop. If that is not possible, use the default loop. The default	2518	event loop. If that is not possible, use the default loop. The default
2090	loop is stored in C<loop_hi>, while the mebeddable loop is stored in	2519	loop is stored in C<loop_hi>, while the embeddable loop is stored in
2091	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be	2520	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2092	used).	2521	used).
2093		2522
2094	struct ev_loop *loop_hi = ev_default_init (0);	2523	struct ev_loop *loop_hi = ev_default_init (0);
2095	struct ev_loop *loop_lo = 0;	2524	struct ev_loop *loop_lo = 0;
2096	struct ev_embed embed;	2525	ev_embed embed;
2097		2526
2098	// see if there is a chance of getting one that works	2527	// see if there is a chance of getting one that works
2099	// (remember that a flags value of 0 means autodetection)	2528	// (remember that a flags value of 0 means autodetection)
2100	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2529	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2101	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2530	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2102	: 0;	2531	: 0;
2103		2532
2104	// if we got one, then embed it, otherwise default to loop_hi	2533	// if we got one, then embed it, otherwise default to loop_hi
2105	if (loop_lo)	2534	if (loop_lo)
2106	{	2535	{
2107	ev_embed_init (&embed, 0, loop_lo);	2536	ev_embed_init (&embed, 0, loop_lo);
2108	ev_embed_start (loop_hi, &embed);	2537	ev_embed_start (loop_hi, &embed);
2109	}	2538	}
2110	else	2539	else
2111	loop_lo = loop_hi;	2540	loop_lo = loop_hi;
2112		2541
2113	Example: Check if kqueue is available but not recommended and create	2542	Example: Check if kqueue is available but not recommended and create
2114	a kqueue backend for use with sockets (which usually work with any	2543	a kqueue backend for use with sockets (which usually work with any
2115	kqueue implementation). Store the kqueue/socket-only event loop in	2544	kqueue implementation). Store the kqueue/socket-only event loop in
2116	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2545	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2117		2546
2118	struct ev_loop *loop = ev_default_init (0);	2547	struct ev_loop *loop = ev_default_init (0);
2119	struct ev_loop *loop_socket = 0;	2548	struct ev_loop *loop_socket = 0;
2120	struct ev_embed embed;	2549	ev_embed embed;
2121		2550
2122	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2551	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2123	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2552	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2124	{	2553	{
2125	ev_embed_init (&embed, 0, loop_socket);	2554	ev_embed_init (&embed, 0, loop_socket);
2126	ev_embed_start (loop, &embed);	2555	ev_embed_start (loop, &embed);
2127	}	2556	}
2128		2557
2129	if (!loop_socket)	2558	if (!loop_socket)
2130	loop_socket = loop;	2559	loop_socket = loop;
2131		2560
2132	// now use loop_socket for all sockets, and loop for everything else	2561	// now use loop_socket for all sockets, and loop for everything else
2133		2562
2134		2563
2135	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2564	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2136		2565
2137	Fork watchers are called when a C<fork ()> was detected (usually because	2566	Fork watchers are called when a C<fork ()> was detected (usually because
…		…
2181	is that the author does not know of a simple (or any) algorithm for a	2610	is that the author does not know of a simple (or any) algorithm for a
2182	multiple-writer-single-reader queue that works in all cases and doesn't	2611	multiple-writer-single-reader queue that works in all cases and doesn't
2183	need elaborate support such as pthreads.	2612	need elaborate support such as pthreads.
2184		2613
2185	That means that if you want to queue data, you have to provide your own	2614	That means that if you want to queue data, you have to provide your own
2186	queue. But at least I can tell you would implement locking around your	2615	queue. But at least I can tell you how to implement locking around your
2187	queue:	2616	queue:
2188		2617
2189	=over 4	2618	=over 4
2190		2619
2191	=item queueing from a signal handler context	2620	=item queueing from a signal handler context
2192		2621
2193	To implement race-free queueing, you simply add to the queue in the signal	2622	To implement race-free queueing, you simply add to the queue in the signal
2194	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2623	handler but you block the signal handler in the watcher callback. Here is
2195	some fictitiuous SIGUSR1 handler:	2624	an example that does that for some fictitious SIGUSR1 handler:
2196		2625
2197	static ev_async mysig;	2626	static ev_async mysig;
2198		2627
2199	static void	2628	static void
2200	sigusr1_handler (void)	2629	sigusr1_handler (void)
…		…
2266	=over 4	2695	=over 4
2267		2696
2268	=item ev_async_init (ev_async *, callback)	2697	=item ev_async_init (ev_async *, callback)
2269		2698
2270	Initialises and configures the async watcher - it has no parameters of any	2699	Initialises and configures the async watcher - it has no parameters of any
2271	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	2700	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2272	believe me.	2701	trust me.
2273		2702
2274	=item ev_async_send (loop, ev_async *)	2703	=item ev_async_send (loop, ev_async *)
2275		2704
2276	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2705	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2277	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2706	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2278	C<ev_feed_event>, this call is safe to do in other threads, signal or	2707	C<ev_feed_event>, this call is safe to do from other threads, signal or
2279	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding	2708	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2280	section below on what exactly this means).	2709	section below on what exactly this means).
2281		2710
		2711	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
		2713	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2714	reset when the event loop detects that).
		2715
2282	This call incurs the overhead of a syscall only once per loop iteration,	2716	This call incurs the overhead of a system call only once per event loop
2283	so while the overhead might be noticable, it doesn't apply to repeated	2717	iteration, so while the overhead might be noticeable, it doesn't apply to
2284	calls to C<ev_async_send>.	2718	repeated calls to C<ev_async_send> for the same event loop.
2285		2719
2286	=item bool = ev_async_pending (ev_async *)	2720	=item bool = ev_async_pending (ev_async *)
2287		2721
2288	Returns a non-zero value when C<ev_async_send> has been called on the	2722	Returns a non-zero value when C<ev_async_send> has been called on the
2289	watcher but the event has not yet been processed (or even noted) by the	2723	watcher but the event has not yet been processed (or even noted) by the
2290	event loop.	2724	event loop.
2291		2725
2292	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2726	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2293	the loop iterates next and checks for the watcher to have become active,	2727	the loop iterates next and checks for the watcher to have become active,
2294	it will reset the flag again. C<ev_async_pending> can be used to very	2728	it will reset the flag again. C<ev_async_pending> can be used to very
2295	quickly check wether invoking the loop might be a good idea.	2729	quickly check whether invoking the loop might be a good idea.
2296		2730
2297	Not that this does I<not> check wether the watcher itself is pending, only	2731	Not that this does I<not> check whether the watcher itself is pending,
2298	wether it has been requested to make this watcher pending.	2732	only whether it has been requested to make this watcher pending: there
		2733	is a time window between the event loop checking and resetting the async
		2734	notification, and the callback being invoked.
2299		2735
2300	=back	2736	=back
2301		2737
2302		2738
2303	=head1 OTHER FUNCTIONS	2739	=head1 OTHER FUNCTIONS
…		…
2307	=over 4	2743	=over 4
2308		2744
2309	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	2745	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2310		2746
2311	This function combines a simple timer and an I/O watcher, calls your	2747	This function combines a simple timer and an I/O watcher, calls your
2312	callback on whichever event happens first and automatically stop both	2748	callback on whichever event happens first and automatically stops both
2313	watchers. This is useful if you want to wait for a single event on an fd	2749	watchers. This is useful if you want to wait for a single event on an fd
2314	or timeout without having to allocate/configure/start/stop/free one or	2750	or timeout without having to allocate/configure/start/stop/free one or
2315	more watchers yourself.	2751	more watchers yourself.
2316		2752
2317	If C<fd> is less than 0, then no I/O watcher will be started and events	2753	If C<fd> is less than 0, then no I/O watcher will be started and the
2318	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2754	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2319	C<events> set will be craeted and started.	2755	the given C<fd> and C<events> set will be created and started.
2320		2756
2321	If C<timeout> is less than 0, then no timeout watcher will be	2757	If C<timeout> is less than 0, then no timeout watcher will be
2322	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2758	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2323	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2759	repeat = 0) will be started. C<0> is a valid timeout.
2324	dubious value.
2325		2760
2326	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2761	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2327	passed an C<revents> set like normal event callbacks (a combination of	2762	passed an C<revents> set like normal event callbacks (a combination of
2328	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2763	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2329	value passed to C<ev_once>:	2764	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
		2766	events precedence.
2330		2767
		2768	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
		2769
2331	static void stdin_ready (int revents, void *arg)	2770	static void stdin_ready (int revents, void *arg)
2332	{	2771	{
2333	if (revents & EV_TIMEOUT)
2334	/* doh, nothing entered */;
2335	else if (revents & EV_READ)	2772	if (revents & EV_READ)
2336	/* stdin might have data for us, joy! */;	2773	/* stdin might have data for us, joy! */;
		2774	else if (revents & EV_TIMEOUT)
		2775	/* doh, nothing entered */;
2337	}	2776	}
2338		2777
2339	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2778	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2340		2779
2341	=item ev_feed_event (ev_loop *, watcher *, int revents)	2780	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2342		2781
2343	Feeds the given event set into the event loop, as if the specified event	2782	Feeds the given event set into the event loop, as if the specified event
2344	had happened for the specified watcher (which must be a pointer to an	2783	had happened for the specified watcher (which must be a pointer to an
2345	initialised but not necessarily started event watcher).	2784	initialised but not necessarily started event watcher).
2346		2785
2347	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2786	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2348		2787
2349	Feed an event on the given fd, as if a file descriptor backend detected	2788	Feed an event on the given fd, as if a file descriptor backend detected
2350	the given events it.	2789	the given events it.
2351		2790
2352	=item ev_feed_signal_event (ev_loop *loop, int signum)	2791	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2353		2792
2354	Feed an event as if the given signal occured (C<loop> must be the default	2793	Feed an event as if the given signal occurred (C<loop> must be the default
2355	loop!).	2794	loop!).
2356		2795
2357	=back	2796	=back
2358		2797
2359		2798
…		…
2375		2814
2376	=item * Priorities are not currently supported. Initialising priorities	2815	=item * Priorities are not currently supported. Initialising priorities
2377	will fail and all watchers will have the same priority, even though there	2816	will fail and all watchers will have the same priority, even though there
2378	is an ev_pri field.	2817	is an ev_pri field.
2379		2818
		2819	=item * In libevent, the last base created gets the signals, in libev, the
		2820	first base created (== the default loop) gets the signals.
		2821
2380	=item * Other members are not supported.	2822	=item * Other members are not supported.
2381		2823
2382	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2824	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2383	to use the libev header file and library.	2825	to use the libev header file and library.
2384		2826
2385	=back	2827	=back
2386		2828
2387	=head1 C++ SUPPORT	2829	=head1 C++ SUPPORT
2388		2830
2389	Libev comes with some simplistic wrapper classes for C++ that mainly allow	2831	Libev comes with some simplistic wrapper classes for C++ that mainly allow
2390	you to use some convinience methods to start/stop watchers and also change	2832	you to use some convenience methods to start/stop watchers and also change
2391	the callback model to a model using method callbacks on objects.	2833	the callback model to a model using method callbacks on objects.
2392		2834
2393	To use it,	2835	To use it,
2394		2836
2395	#include <ev++.h>	2837	#include <ev++.h>
2396		2838
2397	This automatically includes F<ev.h> and puts all of its definitions (many	2839	This automatically includes F<ev.h> and puts all of its definitions (many
2398	of them macros) into the global namespace. All C++ specific things are	2840	of them macros) into the global namespace. All C++ specific things are
2399	put into the C<ev> namespace. It should support all the same embedding	2841	put into the C<ev> namespace. It should support all the same embedding
2400	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2842	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2467	your compiler is good :), then the method will be fully inlined into the	2909	your compiler is good :), then the method will be fully inlined into the
2468	thunking function, making it as fast as a direct C callback.	2910	thunking function, making it as fast as a direct C callback.
2469		2911
2470	Example: simple class declaration and watcher initialisation	2912	Example: simple class declaration and watcher initialisation
2471		2913
2472	struct myclass	2914	struct myclass
2473	{	2915	{
2474	void io_cb (ev::io &w, int revents) { }	2916	void io_cb (ev::io &w, int revents) { }
2475	}	2917	}
2476		2918
2477	myclass obj;	2919	myclass obj;
2478	ev::io iow;	2920	ev::io iow;
2479	iow.set <myclass, &myclass::io_cb> (&obj);	2921	iow.set <myclass, &myclass::io_cb> (&obj);
		2922
		2923	=item w->set (object *)
		2924
		2925	This is an B<experimental> feature that might go away in a future version.
		2926
		2927	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
		2929	functor objects without having to manually specify the C<operator ()> all
		2930	the time. Incidentally, you can then also leave out the template argument
		2931	list.
		2932
		2933	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		2934	int revents)>.
		2935
		2936	See the method-C<set> above for more details.
		2937
		2938	Example: use a functor object as callback.
		2939
		2940	struct myfunctor
		2941	{
		2942	void operator() (ev::io &w, int revents)
		2943	{
		2944	...
		2945	}
		2946	}
		2947
		2948	myfunctor f;
		2949
		2950	ev::io w;
		2951	w.set (&f);
2480		2952
2481	=item w->set<function> (void *data = 0)	2953	=item w->set<function> (void *data = 0)
2482		2954
2483	Also sets a callback, but uses a static method or plain function as	2955	Also sets a callback, but uses a static method or plain function as
2484	callback. The optional C<data> argument will be stored in the watcher's	2956	callback. The optional C<data> argument will be stored in the watcher's
…		…
2486		2958
2487	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	2959	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2488		2960
2489	See the method-C<set> above for more details.	2961	See the method-C<set> above for more details.
2490		2962
2491	Example:	2963	Example: Use a plain function as callback.
2492		2964
2493	static void io_cb (ev::io &w, int revents) { }	2965	static void io_cb (ev::io &w, int revents) { }
2494	iow.set <io_cb> ();	2966	iow.set <io_cb> ();
2495		2967
2496	=item w->set (struct ev_loop *)	2968	=item w->set (struct ev_loop *)
2497		2969
2498	Associates a different C<struct ev_loop> with this watcher. You can only	2970	Associates a different C<struct ev_loop> with this watcher. You can only
2499	do this when the watcher is inactive (and not pending either).	2971	do this when the watcher is inactive (and not pending either).
2500		2972
2501	=item w->set ([args])	2973	=item w->set ([arguments])
2502		2974
2503	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2975	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be
2504	called at least once. Unlike the C counterpart, an active watcher gets	2976	called at least once. Unlike the C counterpart, an active watcher gets
2505	automatically stopped and restarted when reconfiguring it with this	2977	automatically stopped and restarted when reconfiguring it with this
2506	method.	2978	method.
2507		2979
2508	=item w->start ()	2980	=item w->start ()
…		…
2532	=back	3004	=back
2533		3005
2534	Example: Define a class with an IO and idle watcher, start one of them in	3006	Example: Define a class with an IO and idle watcher, start one of them in
2535	the constructor.	3007	the constructor.
2536		3008
2537	class myclass	3009	class myclass
2538	{	3010	{
2539	ev::io io; void io_cb (ev::io &w, int revents);	3011	ev::io io ; void io_cb (ev::io &w, int revents);
2540	ev:idle idle void idle_cb (ev::idle &w, int revents);	3012	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2541		3013
2542	myclass (int fd)	3014	myclass (int fd)
2543	{	3015	{
2544	io .set <myclass, &myclass::io_cb > (this);	3016	io .set <myclass, &myclass::io_cb > (this);
2545	idle.set <myclass, &myclass::idle_cb> (this);	3017	idle.set <myclass, &myclass::idle_cb> (this);
2546		3018
2547	io.start (fd, ev::READ);	3019	io.start (fd, ev::READ);
2548	}	3020	}
2549	};	3021	};
2550		3022
2551		3023
2552	=head1 OTHER LANGUAGE BINDINGS	3024	=head1 OTHER LANGUAGE BINDINGS
2553		3025
2554	Libev does not offer other language bindings itself, but bindings for a	3026	Libev does not offer other language bindings itself, but bindings for a
2555	numbe rof languages exist in the form of third-party packages. If you know	3027	number of languages exist in the form of third-party packages. If you know
2556	any interesting language binding in addition to the ones listed here, drop	3028	any interesting language binding in addition to the ones listed here, drop
2557	me a note.	3029	me a note.
2558		3030
2559	=over 4	3031	=over 4
2560		3032
2561	=item Perl	3033	=item Perl
2562		3034
2563	The EV module implements the full libev API and is actually used to test	3035	The EV module implements the full libev API and is actually used to test
2564	libev. EV is developed together with libev. Apart from the EV core module,	3036	libev. EV is developed together with libev. Apart from the EV core module,
2565	there are additional modules that implement libev-compatible interfaces	3037	there are additional modules that implement libev-compatible interfaces
2566	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	3038	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
2567	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	3039	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3040	and C<EV::Glib>).
2568		3041
2569	It can be found and installed via CPAN, its homepage is found at	3042	It can be found and installed via CPAN, its homepage is at
2570	L<http://software.schmorp.de/pkg/EV>.	3043	L<http://software.schmorp.de/pkg/EV>.
2571		3044
		3045	=item Python
		3046
		3047	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		3048	seems to be quite complete and well-documented.
		3049
2572	=item Ruby	3050	=item Ruby
2573		3051
2574	Tony Arcieri has written a ruby extension that offers access to a subset	3052	Tony Arcieri has written a ruby extension that offers access to a subset
2575	of the libev API and adds filehandle abstractions, asynchronous DNS and	3053	of the libev API and adds file handle abstractions, asynchronous DNS and
2576	more on top of it. It can be found via gem servers. Its homepage is at	3054	more on top of it. It can be found via gem servers. Its homepage is at
2577	L<http://rev.rubyforge.org/>.	3055	L<http://rev.rubyforge.org/>.
2578		3056
		3057	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3058	makes rev work even on mingw.
		3059
		3060	=item Haskell
		3061
		3062	A haskell binding to libev is available at
		3063	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3064
2579	=item D	3065	=item D
2580		3066
2581	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	3067	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2582	be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.	3068	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3069
		3070	=item Ocaml
		3071
		3072	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3073	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2583		3074
2584	=back	3075	=back
2585		3076
2586		3077
2587	=head1 MACRO MAGIC	3078	=head1 MACRO MAGIC
2588		3079
2589	Libev can be compiled with a variety of options, the most fundamantal	3080	Libev can be compiled with a variety of options, the most fundamental
2590	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	3081	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2591	functions and callbacks have an initial C<struct ev_loop *> argument.	3082	functions and callbacks have an initial C<struct ev_loop *> argument.
2592		3083
2593	To make it easier to write programs that cope with either variant, the	3084	To make it easier to write programs that cope with either variant, the
2594	following macros are defined:	3085	following macros are defined:
…		…
2599		3090
2600	This provides the loop I<argument> for functions, if one is required ("ev	3091	This provides the loop I<argument> for functions, if one is required ("ev
2601	loop argument"). The C<EV_A> form is used when this is the sole argument,	3092	loop argument"). The C<EV_A> form is used when this is the sole argument,
2602	C<EV_A_> is used when other arguments are following. Example:	3093	C<EV_A_> is used when other arguments are following. Example:
2603		3094
2604	ev_unref (EV_A);	3095	ev_unref (EV_A);
2605	ev_timer_add (EV_A_ watcher);	3096	ev_timer_add (EV_A_ watcher);
2606	ev_loop (EV_A_ 0);	3097	ev_loop (EV_A_ 0);
2607		3098
2608	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3099	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2609	which is often provided by the following macro.	3100	which is often provided by the following macro.
2610		3101
2611	=item C<EV_P>, C<EV_P_>	3102	=item C<EV_P>, C<EV_P_>
2612		3103
2613	This provides the loop I<parameter> for functions, if one is required ("ev	3104	This provides the loop I<parameter> for functions, if one is required ("ev
2614	loop parameter"). The C<EV_P> form is used when this is the sole parameter,	3105	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
2615	C<EV_P_> is used when other parameters are following. Example:	3106	C<EV_P_> is used when other parameters are following. Example:
2616		3107
2617	// this is how ev_unref is being declared	3108	// this is how ev_unref is being declared
2618	static void ev_unref (EV_P);	3109	static void ev_unref (EV_P);
2619		3110
2620	// this is how you can declare your typical callback	3111	// this is how you can declare your typical callback
2621	static void cb (EV_P_ ev_timer *w, int revents)	3112	static void cb (EV_P_ ev_timer *w, int revents)
2622		3113
2623	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	3114	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2624	suitable for use with C<EV_A>.	3115	suitable for use with C<EV_A>.
2625		3116
2626	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	3117	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
…		…
2642		3133
2643	Example: Declare and initialise a check watcher, utilising the above	3134	Example: Declare and initialise a check watcher, utilising the above
2644	macros so it will work regardless of whether multiple loops are supported	3135	macros so it will work regardless of whether multiple loops are supported
2645	or not.	3136	or not.
2646		3137
2647	static void	3138	static void
2648	check_cb (EV_P_ ev_timer *w, int revents)	3139	check_cb (EV_P_ ev_timer *w, int revents)
2649	{	3140	{
2650	ev_check_stop (EV_A_ w);	3141	ev_check_stop (EV_A_ w);
2651	}	3142	}
2652		3143
2653	ev_check check;	3144	ev_check check;
2654	ev_check_init (&check, check_cb);	3145	ev_check_init (&check, check_cb);
2655	ev_check_start (EV_DEFAULT_ &check);	3146	ev_check_start (EV_DEFAULT_ &check);
2656	ev_loop (EV_DEFAULT_ 0);	3147	ev_loop (EV_DEFAULT_ 0);
2657		3148
2658	=head1 EMBEDDING	3149	=head1 EMBEDDING
2659		3150
2660	Libev can (and often is) directly embedded into host	3151	Libev can (and often is) directly embedded into host
2661	applications. Examples of applications that embed it include the Deliantra	3152	applications. Examples of applications that embed it include the Deliantra
…		…
2668	libev somewhere in your source tree).	3159	libev somewhere in your source tree).
2669		3160
2670	=head2 FILESETS	3161	=head2 FILESETS
2671		3162
2672	Depending on what features you need you need to include one or more sets of files	3163	Depending on what features you need you need to include one or more sets of files
2673	in your app.	3164	in your application.
2674		3165
2675	=head3 CORE EVENT LOOP	3166	=head3 CORE EVENT LOOP
2676		3167
2677	To include only the libev core (all the C<ev_*> functions), with manual	3168	To include only the libev core (all the C<ev_*> functions), with manual
2678	configuration (no autoconf):	3169	configuration (no autoconf):
2679		3170
2680	#define EV_STANDALONE 1	3171	#define EV_STANDALONE 1
2681	#include "ev.c"	3172	#include "ev.c"
2682		3173
2683	This will automatically include F<ev.h>, too, and should be done in a	3174	This will automatically include F<ev.h>, too, and should be done in a
2684	single C source file only to provide the function implementations. To use	3175	single C source file only to provide the function implementations. To use
2685	it, do the same for F<ev.h> in all files wishing to use this API (best	3176	it, do the same for F<ev.h> in all files wishing to use this API (best
2686	done by writing a wrapper around F<ev.h> that you can include instead and	3177	done by writing a wrapper around F<ev.h> that you can include instead and
2687	where you can put other configuration options):	3178	where you can put other configuration options):
2688		3179
2689	#define EV_STANDALONE 1	3180	#define EV_STANDALONE 1
2690	#include "ev.h"	3181	#include "ev.h"
2691		3182
2692	Both header files and implementation files can be compiled with a C++	3183	Both header files and implementation files can be compiled with a C++
2693	compiler (at least, thats a stated goal, and breakage will be treated	3184	compiler (at least, that's a stated goal, and breakage will be treated
2694	as a bug).	3185	as a bug).
2695		3186
2696	You need the following files in your source tree, or in a directory	3187	You need the following files in your source tree, or in a directory
2697	in your include path (e.g. in libev/ when using -Ilibev):	3188	in your include path (e.g. in libev/ when using -Ilibev):
2698		3189
2699	ev.h	3190	ev.h
2700	ev.c	3191	ev.c
2701	ev_vars.h	3192	ev_vars.h
2702	ev_wrap.h	3193	ev_wrap.h
2703		3194
2704	ev_win32.c required on win32 platforms only	3195	ev_win32.c required on win32 platforms only
2705		3196
2706	ev_select.c only when select backend is enabled (which is enabled by default)	3197	ev_select.c only when select backend is enabled (which is enabled by default)
2707	ev_poll.c only when poll backend is enabled (disabled by default)	3198	ev_poll.c only when poll backend is enabled (disabled by default)
2708	ev_epoll.c only when the epoll backend is enabled (disabled by default)	3199	ev_epoll.c only when the epoll backend is enabled (disabled by default)
2709	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	3200	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
2710	ev_port.c only when the solaris port backend is enabled (disabled by default)	3201	ev_port.c only when the solaris port backend is enabled (disabled by default)
2711		3202
2712	F<ev.c> includes the backend files directly when enabled, so you only need	3203	F<ev.c> includes the backend files directly when enabled, so you only need
2713	to compile this single file.	3204	to compile this single file.
2714		3205
2715	=head3 LIBEVENT COMPATIBILITY API	3206	=head3 LIBEVENT COMPATIBILITY API
2716		3207
2717	To include the libevent compatibility API, also include:	3208	To include the libevent compatibility API, also include:
2718		3209
2719	#include "event.c"	3210	#include "event.c"
2720		3211
2721	in the file including F<ev.c>, and:	3212	in the file including F<ev.c>, and:
2722		3213
2723	#include "event.h"	3214	#include "event.h"
2724		3215
2725	in the files that want to use the libevent API. This also includes F<ev.h>.	3216	in the files that want to use the libevent API. This also includes F<ev.h>.
2726		3217
2727	You need the following additional files for this:	3218	You need the following additional files for this:
2728		3219
2729	event.h	3220	event.h
2730	event.c	3221	event.c
2731		3222
2732	=head3 AUTOCONF SUPPORT	3223	=head3 AUTOCONF SUPPORT
2733		3224
2734	Instead of using C<EV_STANDALONE=1> and providing your config in	3225	Instead of using C<EV_STANDALONE=1> and providing your configuration in
2735	whatever way you want, you can also C<m4_include([libev.m4])> in your	3226	whatever way you want, you can also C<m4_include([libev.m4])> in your
2736	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then	3227	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2737	include F<config.h> and configure itself accordingly.	3228	include F<config.h> and configure itself accordingly.
2738		3229
2739	For this of course you need the m4 file:	3230	For this of course you need the m4 file:
2740		3231
2741	libev.m4	3232	libev.m4
2742		3233
2743	=head2 PREPROCESSOR SYMBOLS/MACROS	3234	=head2 PREPROCESSOR SYMBOLS/MACROS
2744		3235
2745	Libev can be configured via a variety of preprocessor symbols you have to	3236	Libev can be configured via a variety of preprocessor symbols you have to
2746	define before including any of its files. The default in the absense of	3237	define before including any of its files. The default in the absence of
2747	autoconf is noted for every option.	3238	autoconf is documented for every option.
2748		3239
2749	=over 4	3240	=over 4
2750		3241
2751	=item EV_STANDALONE	3242	=item EV_STANDALONE
2752		3243
…		…
2754	keeps libev from including F<config.h>, and it also defines dummy	3245	keeps libev from including F<config.h>, and it also defines dummy
2755	implementations for some libevent functions (such as logging, which is not	3246	implementations for some libevent functions (such as logging, which is not
2756	supported). It will also not define any of the structs usually found in	3247	supported). It will also not define any of the structs usually found in
2757	F<event.h> that are not directly supported by the libev core alone.	3248	F<event.h> that are not directly supported by the libev core alone.
2758		3249
		3250	In stanbdalone mode, libev will still try to automatically deduce the
		3251	configuration, but has to be more conservative.
		3252
2759	=item EV_USE_MONOTONIC	3253	=item EV_USE_MONOTONIC
2760		3254
2761	If defined to be C<1>, libev will try to detect the availability of the	3255	If defined to be C<1>, libev will try to detect the availability of the
2762	monotonic clock option at both compiletime and runtime. Otherwise no use	3256	monotonic clock option at both compile time and runtime. Otherwise no
2763	of the monotonic clock option will be attempted. If you enable this, you	3257	use of the monotonic clock option will be attempted. If you enable this,
2764	usually have to link against librt or something similar. Enabling it when	3258	you usually have to link against librt or something similar. Enabling it
2765	the functionality isn't available is safe, though, although you have	3259	when the functionality isn't available is safe, though, although you have
2766	to make sure you link against any libraries where the C<clock_gettime>	3260	to make sure you link against any libraries where the C<clock_gettime>
2767	function is hiding in (often F<-lrt>).	3261	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2768		3262
2769	=item EV_USE_REALTIME	3263	=item EV_USE_REALTIME
2770		3264
2771	If defined to be C<1>, libev will try to detect the availability of the	3265	If defined to be C<1>, libev will try to detect the availability of the
2772	realtime clock option at compiletime (and assume its availability at	3266	real-time clock option at compile time (and assume its availability
2773	runtime if successful). Otherwise no use of the realtime clock option will	3267	at runtime if successful). Otherwise no use of the real-time clock
2774	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3268	option will be attempted. This effectively replaces C<gettimeofday>
2775	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3269	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2776	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3270	correctness. See the note about libraries in the description of
		3271	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3272	C<EV_USE_CLOCK_SYSCALL>.
		3273
		3274	=item EV_USE_CLOCK_SYSCALL
		3275
		3276	If defined to be C<1>, libev will try to use a direct syscall instead
		3277	of calling the system-provided C<clock_gettime> function. This option
		3278	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3279	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3280	programs needlessly. Using a direct syscall is slightly slower (in
		3281	theory), because no optimised vdso implementation can be used, but avoids
		3282	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3283	higher, as it simplifies linking (no need for C<-lrt>).
2777		3284
2778	=item EV_USE_NANOSLEEP	3285	=item EV_USE_NANOSLEEP
2779		3286
2780	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3287	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2781	and will use it for delays. Otherwise it will use C<select ()>.	3288	and will use it for delays. Otherwise it will use C<select ()>.
…		…
2789	2.7 or newer, otherwise disabled.	3296	2.7 or newer, otherwise disabled.
2790		3297
2791	=item EV_USE_SELECT	3298	=item EV_USE_SELECT
2792		3299
2793	If undefined or defined to be C<1>, libev will compile in support for the	3300	If undefined or defined to be C<1>, libev will compile in support for the
2794	C<select>(2) backend. No attempt at autodetection will be done: if no	3301	C<select>(2) backend. No attempt at auto-detection will be done: if no
2795	other method takes over, select will be it. Otherwise the select backend	3302	other method takes over, select will be it. Otherwise the select backend
2796	will not be compiled in.	3303	will not be compiled in.
2797		3304
2798	=item EV_SELECT_USE_FD_SET	3305	=item EV_SELECT_USE_FD_SET
2799		3306
2800	If defined to C<1>, then the select backend will use the system C<fd_set>	3307	If defined to C<1>, then the select backend will use the system C<fd_set>
2801	structure. This is useful if libev doesn't compile due to a missing	3308	structure. This is useful if libev doesn't compile due to a missing
2802	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on	3309	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
2803	exotic systems. This usually limits the range of file descriptors to some	3310	on exotic systems. This usually limits the range of file descriptors to
2804	low limit such as 1024 or might have other limitations (winsocket only	3311	some low limit such as 1024 or might have other limitations (winsocket
2805	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3312	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2806	influence the size of the C<fd_set> used.	3313	configures the maximum size of the C<fd_set>.
2807		3314
2808	=item EV_SELECT_IS_WINSOCKET	3315	=item EV_SELECT_IS_WINSOCKET
2809		3316
2810	When defined to C<1>, the select backend will assume that	3317	When defined to C<1>, the select backend will assume that
2811	select/socket/connect etc. don't understand file descriptors but	3318	select/socket/connect etc. don't understand file descriptors but
…		…
2856	otherwise another method will be used as fallback. This is the preferred	3363	otherwise another method will be used as fallback. This is the preferred
2857	backend for Solaris 10 systems.	3364	backend for Solaris 10 systems.
2858		3365
2859	=item EV_USE_DEVPOLL	3366	=item EV_USE_DEVPOLL
2860		3367
2861	reserved for future expansion, works like the USE symbols above.	3368	Reserved for future expansion, works like the USE symbols above.
2862		3369
2863	=item EV_USE_INOTIFY	3370	=item EV_USE_INOTIFY
2864		3371
2865	If defined to be C<1>, libev will compile in support for the Linux inotify	3372	If defined to be C<1>, libev will compile in support for the Linux inotify
2866	interface to speed up C<ev_stat> watchers. Its actual availability will	3373	interface to speed up C<ev_stat> watchers. Its actual availability will
…		…
2873	access is atomic with respect to other threads or signal contexts. No such	3380	access is atomic with respect to other threads or signal contexts. No such
2874	type is easily found in the C language, so you can provide your own type	3381	type is easily found in the C language, so you can provide your own type
2875	that you know is safe for your purposes. It is used both for signal handler "locking"	3382	that you know is safe for your purposes. It is used both for signal handler "locking"
2876	as well as for signal and thread safety in C<ev_async> watchers.	3383	as well as for signal and thread safety in C<ev_async> watchers.
2877		3384
2878	In the absense of this define, libev will use C<sig_atomic_t volatile>	3385	In the absence of this define, libev will use C<sig_atomic_t volatile>
2879	(from F<signal.h>), which is usually good enough on most platforms.	3386	(from F<signal.h>), which is usually good enough on most platforms.
2880		3387
2881	=item EV_H	3388	=item EV_H
2882		3389
2883	The name of the F<ev.h> header file used to include it. The default if	3390	The name of the F<ev.h> header file used to include it. The default if
…		…
2922	When doing priority-based operations, libev usually has to linearly search	3429	When doing priority-based operations, libev usually has to linearly search
2923	all the priorities, so having many of them (hundreds) uses a lot of space	3430	all the priorities, so having many of them (hundreds) uses a lot of space
2924	and time, so using the defaults of five priorities (-2 .. +2) is usually	3431	and time, so using the defaults of five priorities (-2 .. +2) is usually
2925	fine.	3432	fine.
2926		3433
2927	If your embedding app does not need any priorities, defining these both to	3434	If your embedding application does not need any priorities, defining these
2928	C<0> will save some memory and cpu.	3435	both to C<0> will save some memory and CPU.
2929		3436
2930	=item EV_PERIODIC_ENABLE	3437	=item EV_PERIODIC_ENABLE
2931		3438
2932	If undefined or defined to be C<1>, then periodic timers are supported. If	3439	If undefined or defined to be C<1>, then periodic timers are supported. If
2933	defined to be C<0>, then they are not. Disabling them saves a few kB of	3440	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
2940	code.	3447	code.
2941		3448
2942	=item EV_EMBED_ENABLE	3449	=item EV_EMBED_ENABLE
2943		3450
2944	If undefined or defined to be C<1>, then embed watchers are supported. If	3451	If undefined or defined to be C<1>, then embed watchers are supported. If
2945	defined to be C<0>, then they are not.	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.
2946		3454
2947	=item EV_STAT_ENABLE	3455	=item EV_STAT_ENABLE
2948		3456
2949	If undefined or defined to be C<1>, then stat watchers are supported. If	3457	If undefined or defined to be C<1>, then stat watchers are supported. If
2950	defined to be C<0>, then they are not.	3458	defined to be C<0>, then they are not.
…		…
2960	defined to be C<0>, then they are not.	3468	defined to be C<0>, then they are not.
2961		3469
2962	=item EV_MINIMAL	3470	=item EV_MINIMAL
2963		3471
2964	If you need to shave off some kilobytes of code at the expense of some	3472	If you need to shave off some kilobytes of code at the expense of some
2965	speed, define this symbol to C<1>. Currently only used for gcc to override	3473	speed, define this symbol to C<1>. Currently this is used to override some
2966	some inlining decisions, saves roughly 30% codesize of amd64.	3474	inlining decisions, saves roughly 30% code size on amd64. It also selects a
		3475	much smaller 2-heap for timer management over the default 4-heap.
2967		3476
2968	=item EV_PID_HASHSIZE	3477	=item EV_PID_HASHSIZE
2969		3478
2970	C<ev_child> watchers use a small hash table to distribute workload by	3479	C<ev_child> watchers use a small hash table to distribute workload by
2971	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	3480	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2978	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3487	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2979	usually more than enough. If you need to manage thousands of C<ev_stat>	3488	usually more than enough. If you need to manage thousands of C<ev_stat>
2980	watchers you might want to increase this value (I<must> be a power of	3489	watchers you might want to increase this value (I<must> be a power of
2981	two).	3490	two).
2982		3491
		3492	=item EV_USE_4HEAP
		3493
		3494	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
		3496	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
		3497	faster performance with many (thousands) of watchers.
		3498
		3499	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3500	(disabled).
		3501
		3502	=item EV_HEAP_CACHE_AT
		3503
		3504	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
		3506	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,
		3508	but avoids random read accesses on heap changes. This improves performance
		3509	noticeably with many (hundreds) of watchers.
		3510
		3511	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3512	(disabled).
		3513
		3514	=item EV_VERIFY
		3515
		3516	Controls how much internal verification (see C<ev_loop_verify ()>) will
		3517	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
		3519	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
		3521	verification code will be called very frequently, which will slow down
		3522	libev considerably.
		3523
		3524	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
		3525	C<0>.
		3526
2983	=item EV_COMMON	3527	=item EV_COMMON
2984		3528
2985	By default, all watchers have a C<void *data> member. By redefining	3529	By default, all watchers have a C<void *data> member. By redefining
2986	this macro to a something else you can include more and other types of	3530	this macro to a something else you can include more and other types of
2987	members. You have to define it each time you include one of the files,	3531	members. You have to define it each time you include one of the files,
2988	though, and it must be identical each time.	3532	though, and it must be identical each time.
2989		3533
2990	For example, the perl EV module uses something like this:	3534	For example, the perl EV module uses something like this:
2991		3535
2992	#define EV_COMMON \	3536	#define EV_COMMON \
2993	SV *self; /* contains this struct */ \	3537	SV *self; /* contains this struct */ \
2994	SV *cb_sv, *fh /* note no trailing ";" */	3538	SV *cb_sv, *fh /* note no trailing ";" */
2995		3539
2996	=item EV_CB_DECLARE (type)	3540	=item EV_CB_DECLARE (type)
2997		3541
2998	=item EV_CB_INVOKE (watcher, revents)	3542	=item EV_CB_INVOKE (watcher, revents)
2999		3543
…		…
3004	definition and a statement, respectively. See the F<ev.h> header file for	3548	definition and a statement, respectively. See the F<ev.h> header file for
3005	their default definitions. One possible use for overriding these is to	3549	their default definitions. One possible use for overriding these is to
3006	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3550	avoid the C<struct ev_loop *> as first argument in all cases, or to use
3007	method calls instead of plain function calls in C++.	3551	method calls instead of plain function calls in C++.
3008		3552
		3553	=back
		3554
3009	=head2 EXPORTED API SYMBOLS	3555	=head2 EXPORTED API SYMBOLS
3010		3556
3011	If you need to re-export the API (e.g. via a dll) and you need a list of	3557	If you need to re-export the API (e.g. via a DLL) and you need a list of
3012	exported symbols, you can use the provided F<Symbol.*> files which list	3558	exported symbols, you can use the provided F<Symbol.*> files which list
3013	all public symbols, one per line:	3559	all public symbols, one per line:
3014		3560
3015	Symbols.ev for libev proper	3561	Symbols.ev for libev proper
3016	Symbols.event for the libevent emulation	3562	Symbols.event for the libevent emulation
3017		3563
3018	This can also be used to rename all public symbols to avoid clashes with	3564	This can also be used to rename all public symbols to avoid clashes with
3019	multiple versions of libev linked together (which is obviously bad in	3565	multiple versions of libev linked together (which is obviously bad in
3020	itself, but sometimes it is inconvinient to avoid this).	3566	itself, but sometimes it is inconvenient to avoid this).
3021		3567
3022	A sed command like this will create wrapper C<#define>'s that you need to	3568	A sed command like this will create wrapper C<#define>'s that you need to
3023	include before including F<ev.h>:	3569	include before including F<ev.h>:
3024		3570
3025	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h	3571	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
…		…
3042	file.	3588	file.
3043		3589
3044	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3590	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3045	that everybody includes and which overrides some configure choices:	3591	that everybody includes and which overrides some configure choices:
3046		3592
3047	#define EV_MINIMAL 1	3593	#define EV_MINIMAL 1
3048	#define EV_USE_POLL 0	3594	#define EV_USE_POLL 0
3049	#define EV_MULTIPLICITY 0	3595	#define EV_MULTIPLICITY 0
3050	#define EV_PERIODIC_ENABLE 0	3596	#define EV_PERIODIC_ENABLE 0
3051	#define EV_STAT_ENABLE 0	3597	#define EV_STAT_ENABLE 0
3052	#define EV_FORK_ENABLE 0	3598	#define EV_FORK_ENABLE 0
3053	#define EV_CONFIG_H <config.h>	3599	#define EV_CONFIG_H <config.h>
3054	#define EV_MINPRI 0	3600	#define EV_MINPRI 0
3055	#define EV_MAXPRI 0	3601	#define EV_MAXPRI 0
3056		3602
3057	#include "ev++.h"	3603	#include "ev++.h"
3058		3604
3059	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3605	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3060		3606
3061	#include "ev_cpp.h"	3607	#include "ev_cpp.h"
3062	#include "ev.c"	3608	#include "ev.c"
3063		3609
		3610	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
3064		3611
3065	=head1 THREADS AND COROUTINES	3612	=head2 THREADS AND COROUTINES
3066		3613
3067	=head2 THREADS	3614	=head3 THREADS
3068		3615
3069	Libev itself is completely threadsafe, but it uses no locking. This	3616	All libev functions are reentrant and thread-safe unless explicitly
		3617	documented otherwise, but libev implements no locking itself. This means
3070	means that you can use as many loops as you want in parallel, as long as	3618	that you can use as many loops as you want in parallel, as long as there
3071	only one thread ever calls into one libev function with the same loop	3619	are no concurrent calls into any libev function with the same loop
3072	parameter.	3620	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		3621	of course): libev guarantees that different event loops share no data
		3622	structures that need any locking.
3073		3623
3074	Or put differently: calls with different loop parameters can be done in	3624	Or to put it differently: calls with different loop parameters can be done
3075	parallel from multiple threads, calls with the same loop parameter must be	3625	concurrently from multiple threads, calls with the same loop parameter
3076	done serially (but can be done from different threads, as long as only one	3626	must be done serially (but can be done from different threads, as long as
3077	thread ever is inside a call at any point in time, e.g. by using a mutex	3627	only one thread ever is inside a call at any point in time, e.g. by using
3078	per loop).	3628	a mutex per loop).
3079		3629
3080	If you want to know which design is best for your problem, then I cannot	3630	Specifically to support threads (and signal handlers), libev implements
		3631	so-called C<ev_async> watchers, which allow some limited form of
		3632	concurrency on the same event loop, namely waking it up "from the
		3633	outside".
		3634
		3635	If you want to know which design (one loop, locking, or multiple loops
		3636	without or something else still) is best for your problem, then I cannot
3081	help you but by giving some generic advice:	3637	help you, but here is some generic advice:
3082		3638
3083	=over 4	3639	=over 4
3084		3640
3085	=item * most applications have a main thread: use the default libev loop	3641	=item * most applications have a main thread: use the default libev loop
3086	in that thread, or create a seperate thread running only the default loop.	3642	in that thread, or create a separate thread running only the default loop.
3087		3643
3088	This helps integrating other libraries or software modules that use libev	3644	This helps integrating other libraries or software modules that use libev
3089	themselves and don't care/know about threading.	3645	themselves and don't care/know about threading.
3090		3646
3091	=item * one loop per thread is usually a good model.	3647	=item * one loop per thread is usually a good model.
3092		3648
3093	Doing this is almost never wrong, sometimes a better-performance model	3649	Doing this is almost never wrong, sometimes a better-performance model
3094	exists, but it is always a good start.	3650	exists, but it is always a good start.
3095		3651
3096	=item * other models exist, such as the leader/follower pattern, where one	3652	=item * other models exist, such as the leader/follower pattern, where one
3097	loop is handed through multiple threads in a kind of round-robbin fashion.	3653	loop is handed through multiple threads in a kind of round-robin fashion.
3098		3654
3099	Chosing a model is hard - look around, learn, know that usually you cna do	3655	Choosing a model is hard - look around, learn, know that usually you can do
3100	better than you currently do :-)	3656	better than you currently do :-)
3101		3657
3102	=item * often you need to talk to some other thread which blocks in the	3658	=item * often you need to talk to some other thread which blocks in the
		3659	event loop.
		3660
3103	event loop - C<ev_async> watchers can be used to wake them up from other	3661	C<ev_async> watchers can be used to wake them up from other threads safely
3104	threads safely (or from signal contexts...).	3662	(or from signal contexts...).
		3663
		3664	An example use would be to communicate signals or other events that only
		3665	work in the default loop by registering the signal watcher with the
		3666	default loop and triggering an C<ev_async> watcher from the default loop
		3667	watcher callback into the event loop interested in the signal.
3105		3668
3106	=back	3669	=back
3107		3670
3108	=head2 COROUTINES	3671	=head3 COROUTINES
3109		3672
3110	Libev is much more accomodating to coroutines ("cooperative threads"):	3673	Libev is very accommodating to coroutines ("cooperative threads"):
3111	libev fully supports nesting calls to it's functions from different	3674	libev fully supports nesting calls to its functions from different
3112	coroutines (e.g. you can call C<ev_loop> on the same loop from two	3675	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3113	different coroutines and switch freely between both coroutines running the	3676	different coroutines, and switch freely between both coroutines running the
3114	loop, as long as you don't confuse yourself). The only exception is that	3677	loop, as long as you don't confuse yourself). The only exception is that
3115	you must not do this from C<ev_periodic> reschedule callbacks.	3678	you must not do this from C<ev_periodic> reschedule callbacks.
3116		3679
3117	Care has been invested into making sure that libev does not keep local	3680	Care has been taken to ensure that libev does not keep local state inside
3118	state inside C<ev_loop>, and other calls do not usually allow coroutine	3681	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3119	switches.	3682	they do not call any callbacks.
3120		3683
		3684	=head2 COMPILER WARNINGS
3121		3685
3122	=head1 COMPLEXITIES	3686	Depending on your compiler and compiler settings, you might get no or a
		3687	lot of warnings when compiling libev code. Some people are apparently
		3688	scared by this.
3123		3689
3124	In this section the complexities of (many of) the algorithms used inside	3690	However, these are unavoidable for many reasons. For one, each compiler
3125	libev will be explained. For complexity discussions about backends see the	3691	has different warnings, and each user has different tastes regarding
3126	documentation for C<ev_default_init>.	3692	warning options. "Warn-free" code therefore cannot be a goal except when
		3693	targeting a specific compiler and compiler-version.
3127		3694
3128	All of the following are about amortised time: If an array needs to be	3695	Another reason is that some compiler warnings require elaborate
3129	extended, libev needs to realloc and move the whole array, but this	3696	workarounds, or other changes to the code that make it less clear and less
3130	happens asymptotically never with higher number of elements, so O(1) might	3697	maintainable.
3131	mean it might do a lengthy realloc operation in rare cases, but on average
3132	it is much faster and asymptotically approaches constant time.
3133		3698
3134	=over 4	3699	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
		3701	seems to warn about). For example, certain older gcc versions had some
		3702	warnings that resulted an extreme number of false positives. These have
		3703	been fixed, but some people still insist on making code warn-free with
		3704	such buggy versions.
3135		3705
3136	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3706	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
		3708	with any compiler warnings enabled unless you are prepared to cope with
		3709	them (e.g. by ignoring them). Remember that warnings are just that:
		3710	warnings, not errors, or proof of bugs.
3137		3711
3138	This means that, when you have a watcher that triggers in one hour and
3139	there are 100 watchers that would trigger before that then inserting will
3140	have to skip roughly seven (C<ld 100>) of these watchers.
3141		3712
3142	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3713	=head2 VALGRIND
3143		3714
3144	That means that changing a timer costs less than removing/adding them	3715	Valgrind has a special section here because it is a popular tool that is
3145	as only the relative motion in the event queue has to be paid for.	3716	highly useful. Unfortunately, valgrind reports are very hard to interpret.
3146		3717
3147	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	3718	If you think you found a bug (memory leak, uninitialised data access etc.)
		3719	in libev, then check twice: If valgrind reports something like:
3148		3720
3149	These just add the watcher into an array or at the head of a list.	3721	==2274== definitely lost: 0 bytes in 0 blocks.
		3722	==2274== possibly lost: 0 bytes in 0 blocks.
		3723	==2274== still reachable: 256 bytes in 1 blocks.
3150		3724
3151	=item Stopping check/prepare/idle/fork/async watchers: O(1)	3725	Then there is no memory leak, just as memory accounted to global variables
		3726	is not a memleak - the memory is still being referenced, and didn't leak.
3152		3727
3153	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3728	Similarly, under some circumstances, valgrind might report kernel bugs
		3729	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		3730	although an acceptable workaround has been found here), or it might be
		3731	confused.
3154		3732
3155	These watchers are stored in lists then need to be walked to find the	3733	Keep in mind that valgrind is a very good tool, but only a tool. Don't
3156	correct watcher to remove. The lists are usually short (you don't usually	3734	make it into some kind of religion.
3157	have many watchers waiting for the same fd or signal).
3158		3735
3159	=item Finding the next timer in each loop iteration: O(1)	3736	If you are unsure about something, feel free to contact the mailing list
		3737	with the full valgrind report and an explanation on why you think this
		3738	is a bug in libev (best check the archives, too :). However, don't be
		3739	annoyed when you get a brisk "this is no bug" answer and take the chance
		3740	of learning how to interpret valgrind properly.
3160		3741
3161	By virtue of using a binary heap, the next timer is always found at the	3742	If you need, for some reason, empty reports from valgrind for your project
3162	beginning of the storage array.	3743	I suggest using suppression lists.
3163		3744
3164	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3165		3745
3166	A change means an I/O watcher gets started or stopped, which requires	3746	=head1 PORTABILITY NOTES
3167	libev to recalculate its status (and possibly tell the kernel, depending
3168	on backend and wether C<ev_io_set> was used).
3169		3747
3170	=item Activating one watcher (putting it into the pending state): O(1)	3748	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3171
3172	=item Priority handling: O(number_of_priorities)
3173
3174	Priorities are implemented by allocating some space for each
3175	priority. When doing priority-based operations, libev usually has to
3176	linearly search all the priorities, but starting/stopping and activating
3177	watchers becomes O(1) w.r.t. priority handling.
3178
3179	=item Sending an ev_async: O(1)
3180
3181	=item Processing ev_async_send: O(number_of_async_watchers)
3182
3183	=item Processing signals: O(max_signal_number)
3184
3185	Sending involves a syscall I<iff> there were no other C<ev_async_send>
3186	calls in the current loop iteration. Checking for async and signal events
3187	involves iterating over all running async watchers or all signal numbers.
3188
3189	=back
3190
3191
3192	=head1 Win32 platform limitations and workarounds
3193		3749
3194	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3750	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3195	requires, and its I/O model is fundamentally incompatible with the POSIX	3751	requires, and its I/O model is fundamentally incompatible with the POSIX
3196	model. Libev still offers limited functionality on this platform in	3752	model. Libev still offers limited functionality on this platform in
3197	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3753	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3198	descriptors. This only applies when using Win32 natively, not when using	3754	descriptors. This only applies when using Win32 natively, not when using
3199	e.g. cygwin.	3755	e.g. cygwin.
3200		3756
		3757	Lifting these limitations would basically require the full
		3758	re-implementation of the I/O system. If you are into these kinds of
		3759	things, then note that glib does exactly that for you in a very portable
		3760	way (note also that glib is the slowest event library known to man).
		3761
3201	There is no supported compilation method available on windows except	3762	There is no supported compilation method available on windows except
3202	embedding it into other applications.	3763	embedding it into other applications.
3203		3764
		3765	Not a libev limitation but worth mentioning: windows apparently doesn't
		3766	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,
		3768	so make sure you only write small amounts into your sockets (less than a
		3769	megabyte seems safe, but this apparently depends on the amount of memory
		3770	available).
		3771
3204	Due to the many, low, and arbitrary limits on the win32 platform and the	3772	Due to the many, low, and arbitrary limits on the win32 platform and
3205	abysmal performance of winsockets, using a large number of sockets is not	3773	the abysmal performance of winsockets, using a large number of sockets
3206	recommended (and not reasonable). If your program needs to use more than	3774	is not recommended (and not reasonable). If your program needs to use
3207	a hundred or so sockets, then likely it needs to use a totally different	3775	more than a hundred or so sockets, then likely it needs to use a totally
3208	implementation for windows, as libev offers the POSIX model, which cannot	3776	different implementation for windows, as libev offers the POSIX readiness
3209	be implemented efficiently on windows (microsoft monopoly games).	3777	notification model, which cannot be implemented efficiently on windows
		3778	(Microsoft monopoly games).
		3779
		3780	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
		3782	of F<ev.h>:
		3783
		3784	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3785	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3786
		3787	#include "ev.h"
		3788
		3789	And compile the following F<evwrap.c> file into your project (make sure
		3790	you do I<not> compile the F<ev.c> or any other embedded source files!):
		3791
		3792	#include "evwrap.h"
		3793	#include "ev.c"
3210		3794
3211	=over 4	3795	=over 4
3212		3796
3213	=item The winsocket select function	3797	=item The winsocket select function
3214		3798
3215	The winsocket C<select> function doesn't follow POSIX in that it requires	3799	The winsocket C<select> function doesn't follow POSIX in that it
3216	socket I<handles> and not socket I<file descriptors>. This makes select	3800	requires socket I<handles> and not socket I<file descriptors> (it is
3217	very inefficient, and also requires a mapping from file descriptors	3801	also extremely buggy). This makes select very inefficient, and also
3218	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,	3802	requires a mapping from file descriptors to socket handles (the Microsoft
3219	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor	3803	C runtime provides the function C<_open_osfhandle> for this). See the
3220	symbols for more info.	3804	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
		3805	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
3221		3806
3222	The configuration for a "naked" win32 using the microsoft runtime	3807	The configuration for a "naked" win32 using the Microsoft runtime
3223	libraries and raw winsocket select is:	3808	libraries and raw winsocket select is:
3224		3809
3225	#define EV_USE_SELECT 1	3810	#define EV_USE_SELECT 1
3226	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3811	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3227		3812
3228	Note that winsockets handling of fd sets is O(n), so you can easily get a	3813	Note that winsockets handling of fd sets is O(n), so you can easily get a
3229	complexity in the O(n²) range when using win32.	3814	complexity in the O(n²) range when using win32.
3230		3815
3231	=item Limited number of file descriptors	3816	=item Limited number of file descriptors
3232		3817
3233	Windows has numerous arbitrary (and low) limits on things. Early versions	3818	Windows has numerous arbitrary (and low) limits on things.
3234	of winsocket's select only supported waiting for a max. of C<64> handles	3819
		3820	Early versions of winsocket's select only supported waiting for a maximum
3235	(probably owning to the fact that all windows kernels can only wait for	3821	of C<64> handles (probably owning to the fact that all windows kernels
3236	C<64> things at the same time internally; microsoft recommends spawning a	3822	can only wait for C<64> things at the same time internally; Microsoft
3237	chain of threads and wait for 63 handles and the previous thread in each).	3823	recommends spawning a chain of threads and wait for 63 handles and the
		3824	previous thread in each. Great).
3238		3825
3239	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3826	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3240	to some high number (e.g. C<2048>) before compiling the winsocket select	3827	to some high number (e.g. C<2048>) before compiling the winsocket select
3241	call (which might be in libev or elsewhere, for example, perl does its own	3828	call (which might be in libev or elsewhere, for example, perl does its own
3242	select emulation on windows).	3829	select emulation on windows).
3243		3830
3244	Another limit is the number of file descriptors in the microsoft runtime	3831	Another limit is the number of file descriptors in the Microsoft runtime
3245	libraries, which by default is C<64> (there must be a hidden I<64> fetish	3832	libraries, which by default is C<64> (there must be a hidden I<64> fetish
3246	or something like this inside microsoft). You can increase this by calling	3833	or something like this inside Microsoft). You can increase this by calling
3247	C<_setmaxstdio>, which can increase this limit to C<2048> (another	3834	C<_setmaxstdio>, which can increase this limit to C<2048> (another
3248	arbitrary limit), but is broken in many versions of the microsoft runtime	3835	arbitrary limit), but is broken in many versions of the Microsoft runtime
3249	libraries.	3836	libraries.
3250		3837
3251	This might get you to about C<512> or C<2048> sockets (depending on	3838	This might get you to about C<512> or C<2048> sockets (depending on
3252	windows version and/or the phase of the moon). To get more, you need to	3839	windows version and/or the phase of the moon). To get more, you need to
3253	wrap all I/O functions and provide your own fd management, but the cost of	3840	wrap all I/O functions and provide your own fd management, but the cost of
3254	calling select (O(n²)) will likely make this unworkable.	3841	calling select (O(n²)) will likely make this unworkable.
3255		3842
3256	=back	3843	=back
3257		3844
		3845	=head2 PORTABILITY REQUIREMENTS
		3846
		3847	In addition to a working ISO-C implementation and of course the
		3848	backend-specific APIs, libev relies on a few additional extensions:
		3849
		3850	=over 4
		3851
		3852	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3853	calling conventions regardless of C<ev_watcher_type *>.
		3854
		3855	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
		3857	assumes that the same (machine) code can be used to call any watcher
		3858	callback: The watcher callbacks have different type signatures, but libev
		3859	calls them using an C<ev_watcher *> internally.
		3860
		3861	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3862
		3863	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
		3865	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3866	believed to be sufficiently portable.
		3867
		3868	=item C<sigprocmask> must work in a threaded environment
		3869
		3870	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3871	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3872	pthread implementations will either allow C<sigprocmask> in the "main
		3873	thread" or will block signals process-wide, both behaviours would
		3874	be compatible with libev. Interaction between C<sigprocmask> and
		3875	C<pthread_sigmask> could complicate things, however.
		3876
		3877	The most portable way to handle signals is to block signals in all threads
		3878	except the initial one, and run the default loop in the initial thread as
		3879	well.
		3880
		3881	=item C<long> must be large enough for common memory allocation sizes
		3882
		3883	To improve portability and simplify its API, libev uses C<long> internally
		3884	instead of C<size_t> when allocating its data structures. On non-POSIX
		3885	systems (Microsoft...) this might be unexpectedly low, but is still at
		3886	least 31 bits everywhere, which is enough for hundreds of millions of
		3887	watchers.
		3888
		3889	=item C<double> must hold a time value in seconds with enough accuracy
		3890
		3891	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
		3893	enough for at least into the year 4000. This requirement is fulfilled by
		3894	implementations implementing IEEE 754 (basically all existing ones).
		3895
		3896	=back
		3897
		3898	If you know of other additional requirements drop me a note.
		3899
		3900
		3901	=head1 ALGORITHMIC COMPLEXITIES
		3902
		3903	In this section the complexities of (many of) the algorithms used inside
		3904	libev will be documented. For complexity discussions about backends see
		3905	the documentation for C<ev_default_init>.
		3906
		3907	All of the following are about amortised time: If an array needs to be
		3908	extended, libev needs to realloc and move the whole array, but this
		3909	happens asymptotically rarer with higher number of elements, so O(1) might
		3910	mean that libev does a lengthy realloc operation in rare cases, but on
		3911	average it is much faster and asymptotically approaches constant time.
		3912
		3913	=over 4
		3914
		3915	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
		3916
		3917	This means that, when you have a watcher that triggers in one hour and
		3918	there are 100 watchers that would trigger before that, then inserting will
		3919	have to skip roughly seven (C<ld 100>) of these watchers.
		3920
		3921	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
		3922
		3923	That means that changing a timer costs less than removing/adding them,
		3924	as only the relative motion in the event queue has to be paid for.
		3925
		3926	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
		3927
		3928	These just add the watcher into an array or at the head of a list.
		3929
		3930	=item Stopping check/prepare/idle/fork/async watchers: O(1)
		3931
		3932	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		3933
		3934	These watchers are stored in lists, so they need to be walked to find the
		3935	correct watcher to remove. The lists are usually short (you don't usually
		3936	have many watchers waiting for the same fd or signal: one is typical, two
		3937	is rare).
		3938
		3939	=item Finding the next timer in each loop iteration: O(1)
		3940
		3941	By virtue of using a binary or 4-heap, the next timer is always found at a
		3942	fixed position in the storage array.
		3943
		3944	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		3945
		3946	A change means an I/O watcher gets started or stopped, which requires
		3947	libev to recalculate its status (and possibly tell the kernel, depending
		3948	on backend and whether C<ev_io_set> was used).
		3949
		3950	=item Activating one watcher (putting it into the pending state): O(1)
		3951
		3952	=item Priority handling: O(number_of_priorities)
		3953
		3954	Priorities are implemented by allocating some space for each
		3955	priority. When doing priority-based operations, libev usually has to
		3956	linearly search all the priorities, but starting/stopping and activating
		3957	watchers becomes O(1) with respect to priority handling.
		3958
		3959	=item Sending an ev_async: O(1)
		3960
		3961	=item Processing ev_async_send: O(number_of_async_watchers)
		3962
		3963	=item Processing signals: O(max_signal_number)
		3964
		3965	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
		3967	involves iterating over all running async watchers or all signal numbers.
		3968
		3969	=back
		3970
3258		3971
3259	=head1 AUTHOR	3972	=head1 AUTHOR
3260		3973
3261	Marc Lehmann <libev@schmorp.de>.	3974	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3262		3975

Diff Legend

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