ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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