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

Diff Legend

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