ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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