ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

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

Diff Legend

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