ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.163 by root, Sat May 31 23:19:23 2008 UTC vs.
Revision 1.233 by root, Thu Apr 16 07:32:51 2009 UTC

…		…
2		2
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
		14	#include <stdio.h> // for puts
		15
14	// every watcher type has its own typedef'd struct	16	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	17	// with the name ev_TYPE
16	ev_io stdin_watcher;	18	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
18		20
19	// all watcher callbacks have a similar signature	21	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	22	// this callback is called when data is readable on stdin
21	static void	23	static void
22	stdin_cb (EV_P_ struct ev_io *w, int revents)	24	stdin_cb (EV_P_ ev_io *w, int revents)
23	{	25	{
24	puts ("stdin ready");	26	puts ("stdin ready");
25	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
26	// with its corresponding stop function.	28	// with its corresponding stop function.
27	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
28		30
29	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_loop's to stop iterating
30	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_unloop (EV_A_ EVUNLOOP_ALL);
31	}	33	}
32		34
33	// another callback, this time for a time-out	35	// another callback, this time for a time-out
34	static void	36	static void
35	timeout_cb (EV_P_ struct ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
36	{	38	{
37	puts ("timeout");	39	puts ("timeout");
38	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_loop to stop iterating
39	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_unloop (EV_A_ EVUNLOOP_ONE);
40	}	42	}
41		43
42	int	44	int
43	main (void)	45	main (void)
44	{	46	{
45	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
46	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = ev_default_loop (0);
47		49
48	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
49	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
51	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
52		54
53	// initialise a timer watcher, then start it	55	// initialise a timer watcher, then start it
54	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
56	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
57		59
58	// now wait for events to arrive	60	// now wait for events to arrive
59	ev_loop (loop, 0);	61	ev_loop (loop, 0);
60		62
61	// unloop was called, so exit	63	// unloop was called, so exit
62	return 0;	64	return 0;
63	}	65	}
64		66
65	=head1 DESCRIPTION	67	=head1 DESCRIPTION
66		68
67	The newest version of this document is also available as an html-formatted	69	The newest version of this document is also available as an html-formatted
68	web page you might find easier to navigate when reading it for the first	70	web page you might find easier to navigate when reading it for the first
…		…
103	Libev is very configurable. In this manual the default (and most common)	105	Libev is very configurable. In this manual the default (and most common)
104	configuration will be described, which supports multiple event loops. For	106	configuration will be described, which supports multiple event loops. For
105	more info about various configuration options please have a look at	107	more info about various configuration options please have a look at
106	B<EMBED> section in this manual. If libev was configured without support	108	B<EMBED> section in this manual. If libev was configured without support
107	for multiple event loops, then all functions taking an initial argument of	109	for multiple event loops, then all functions taking an initial argument of
108	name C<loop> (which is always of type C<struct ev_loop *>) will not have	110	name C<loop> (which is always of type C<ev_loop *>) will not have
109	this argument.	111	this argument.
110		112
111	=head2 TIME REPRESENTATION	113	=head2 TIME REPRESENTATION
112		114
113	Libev represents time as a single floating point number, representing the	115	Libev represents time as a single floating point number, representing the
…		…
178	not a problem.	180	not a problem.
179		181
180	Example: Make sure we haven't accidentally been linked against the wrong	182	Example: Make sure we haven't accidentally been linked against the wrong
181	version.	183	version.
182		184
183	assert (("libev version mismatch",	185	assert (("libev version mismatch",
184	ev_version_major () == EV_VERSION_MAJOR	186	ev_version_major () == EV_VERSION_MAJOR
185	&& ev_version_minor () >= EV_VERSION_MINOR));	187	&& ev_version_minor () >= EV_VERSION_MINOR));
186		188
187	=item unsigned int ev_supported_backends ()	189	=item unsigned int ev_supported_backends ()
188		190
189	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	191	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
190	value) compiled into this binary of libev (independent of their	192	value) compiled into this binary of libev (independent of their
…		…
192	a description of the set values.	194	a description of the set values.
193		195
194	Example: make sure we have the epoll method, because yeah this is cool and	196	Example: make sure we have the epoll method, because yeah this is cool and
195	a must have and can we have a torrent of it please!!!11	197	a must have and can we have a torrent of it please!!!11
196		198
197	assert (("sorry, no epoll, no sex",	199	assert (("sorry, no epoll, no sex",
198	ev_supported_backends () & EVBACKEND_EPOLL));	200	ev_supported_backends () & EVBACKEND_EPOLL));
199		201
200	=item unsigned int ev_recommended_backends ()	202	=item unsigned int ev_recommended_backends ()
201		203
202	Return the set of all backends compiled into this binary of libev and also	204	Return the set of all backends compiled into this binary of libev and also
203	recommended for this platform. This set is often smaller than the one	205	recommended for this platform. This set is often smaller than the one
…		…
214	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	216	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
215	recommended ones.	217	recommended ones.
216		218
217	See the description of C<ev_embed> watchers for more info.	219	See the description of C<ev_embed> watchers for more info.
218		220
219	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	221	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
220		222
221	Sets the allocation function to use (the prototype is similar - the	223	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	224	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	225	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	226	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
250	}	252	}
251		253
252	...	254	...
253	ev_set_allocator (persistent_realloc);	255	ev_set_allocator (persistent_realloc);
254		256
255	=item ev_set_syserr_cb (void (*cb)(const char *msg));	257	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
256		258
257	Set the callback function to call on a retryable system call error (such	259	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	260	as failed select, poll, epoll_wait). The message is a printable string
259	indicating the system call or subsystem causing the problem. If this	261	indicating the system call or subsystem causing the problem. If this
260	callback is set, then libev will expect it to remedy the situation, no	262	callback is set, then libev will expect it to remedy the situation, no
…		…
276		278
277	=back	279	=back
278		280
279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	281	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
280		282
281	An event loop is described by a C<struct ev_loop *>. The library knows two	283	An event loop is described by a C<struct ev_loop *> (the C<struct>
282	types of such loops, the I<default> loop, which supports signals and child	284	is I<not> optional in this case, as there is also an C<ev_loop>
283	events, and dynamically created loops which do not.	285	I<function>).
		286
		287	The library knows two types of such loops, the I<default> loop, which
		288	supports signals and child events, and dynamically created loops which do
		289	not.
284		290
285	=over 4	291	=over 4
286		292
287	=item struct ev_loop *ev_default_loop (unsigned int flags)	293	=item struct ev_loop *ev_default_loop (unsigned int flags)
288		294
…		…
294	If you don't know what event loop to use, use the one returned from this	300	If you don't know what event loop to use, use the one returned from this
295	function.	301	function.
296		302
297	Note that this function is I<not> thread-safe, so if you want to use it	303	Note that this function is I<not> thread-safe, so if you want to use it
298	from multiple threads, you have to lock (note also that this is unlikely,	304	from multiple threads, you have to lock (note also that this is unlikely,
299	as loops cannot bes hared easily between threads anyway).	305	as loops cannot be shared easily between threads anyway).
300		306
301	The default loop is the only loop that can handle C<ev_signal> and	307	The default loop is the only loop that can handle C<ev_signal> and
302	C<ev_child> watchers, and to do this, it always registers a handler	308	C<ev_child> watchers, and to do this, it always registers a handler
303	for C<SIGCHLD>. If this is a problem for your application you can either	309	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	310	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
…		…
359	writing a server, you should C<accept ()> in a loop to accept as many	365	writing a server, you should C<accept ()> in a loop to accept as many
360	connections as possible during one iteration. You might also want to have	366	connections as possible during one iteration. You might also want to have
361	a look at C<ev_set_io_collect_interval ()> to increase the amount of	367	a look at C<ev_set_io_collect_interval ()> to increase the amount of
362	readiness notifications you get per iteration.	368	readiness notifications you get per iteration.
363		369
		370	This backend maps C<EV_READ> to the C<readfds> set and C<EV_WRITE> to the
		371	C<writefds> set (and to work around Microsoft Windows bugs, also onto the
		372	C<exceptfds> set on that platform).
		373
364	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	374	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
365		375
366	And this is your standard poll(2) backend. It's more complicated	376	And this is your standard poll(2) backend. It's more complicated
367	than select, but handles sparse fds better and has no artificial	377	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	378	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,	379	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	380	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
371	performance tips.	381	performance tips.
372		382
		383	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
		384	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
		385
373	=item C<EVBACKEND_EPOLL> (value 4, Linux)	386	=item C<EVBACKEND_EPOLL> (value 4, Linux)
374		387
375	For few fds, this backend is a bit little slower than poll and select,	388	For few fds, this backend is a bit little slower than poll and select,
376	but it scales phenomenally better. While poll and select usually scale	389	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),	390	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	391	epoll scales either O(1) or O(active_fds).
379	of shortcomings, such as silently dropping events in some hard-to-detect	392
380	cases and requiring a system call per fd change, no fork support and bad	393	The epoll mechanism deserves honorable mention as the most misdesigned
381	support for dup.	394	of the more advanced event mechanisms: mere annoyances include silently
		395	dropping file descriptors, requiring a system call per change per file
		396	descriptor (and unnecessary guessing of parameters), problems with dup and
		397	so on. The biggest issue is fork races, however - if a program forks then
		398	I<both> parent and child process have to recreate the epoll set, which can
		399	take considerable time (one syscall per file descriptor) and is of course
		400	hard to detect.
		401
		402	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		403	of course I<doesn't>, and epoll just loves to report events for totally
		404	I<different> file descriptors (even already closed ones, so one cannot
		405	even remove them from the set) than registered in the set (especially
		406	on SMP systems). Libev tries to counter these spurious notifications by
		407	employing an additional generation counter and comparing that against the
		408	events to filter out spurious ones, recreating the set when required.
382		409
383	While stopping, setting and starting an I/O watcher in the same iteration	410	While stopping, setting and starting an I/O watcher in the same iteration
384	will result in some caching, there is still a system call per such incident	411	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	412	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	413	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
387	very well if you register events for both fds.	414	file descriptors might not work very well if you register events for both
388		415	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		416
393	Best performance from this backend is achieved by not unregistering all	417	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.	418	watchers for a file descriptor until it has been closed, if possible,
395	keep at least one watcher active per fd at all times.	419	i.e. keep at least one watcher active per fd at all times. Stopping and
		420	starting a watcher (without re-setting it) also usually doesn't cause
		421	extra overhead. A fork can both result in spurious notifications as well
		422	as in libev having to destroy and recreate the epoll object, which can
		423	take considerable time and thus should be avoided.
		424
		425	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		426	faster than epoll for maybe up to a hundred file descriptors, depending on
		427	the usage. So sad.
396		428
397	While nominally embeddable in other event loops, this feature is broken in	429	While nominally embeddable in other event loops, this feature is broken in
398	all kernel versions tested so far.	430	all kernel versions tested so far.
		431
		432	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		433	C<EVBACKEND_POLL>.
399		434
400	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	435	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
401		436
402	Kqueue deserves special mention, as at the time of this writing, it	437	Kqueue deserves special mention, as at the time of this writing, it
403	was broken on all BSDs except NetBSD (usually it doesn't work reliably	438	was broken on all BSDs except NetBSD (usually it doesn't work reliably
404	with anything but sockets and pipes, except on Darwin, where of course	439	with anything but sockets and pipes, except on Darwin, where of course
405	it's completely useless). For this reason it's not being "auto-detected"	440	it's completely useless). Unlike epoll, however, whose brokenness
		441	is by design, these kqueue bugs can (and eventually will) be fixed
		442	without API changes to existing programs. For this reason it's not being
406	unless you explicitly specify it explicitly in the flags (i.e. using	443	"auto-detected" unless you explicitly specify it in the flags (i.e. using
407	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)	444	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
408	system like NetBSD.	445	system like NetBSD.
409		446
410	You still can embed kqueue into a normal poll or select backend and use it	447	You still can embed kqueue into a normal poll or select backend and use it
411	only for sockets (after having made sure that sockets work with kqueue on	448	only for sockets (after having made sure that sockets work with kqueue on
…		…
413		450
414	It scales in the same way as the epoll backend, but the interface to the	451	It scales in the same way as the epoll backend, but the interface to the
415	kernel is more efficient (which says nothing about its actual speed, of	452	kernel is more efficient (which says nothing about its actual speed, of
416	course). While stopping, setting and starting an I/O watcher does never	453	course). While stopping, setting and starting an I/O watcher does never
417	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	454	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
418	two event changes per incident, support for C<fork ()> is very bad and it	455	two event changes per incident. Support for C<fork ()> is very bad (but
419	drops fds silently in similarly hard-to-detect cases.	456	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		457	cases
420		458
421	This backend usually performs well under most conditions.	459	This backend usually performs well under most conditions.
422		460
423	While nominally embeddable in other event loops, this doesn't work	461	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	462	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	463	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	464	(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	465	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
428	sockets.	466	also broken on OS X)) and, did I mention it, using it only for sockets.
		467
		468	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
		469	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
		470	C<NOTE_EOF>.
429		471
430	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	472	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
431		473
432	This is not implemented yet (and might never be, unless you send me an	474	This is not implemented yet (and might never be, unless you send me an
433	implementation). According to reports, C</dev/poll> only supports sockets	475	implementation). According to reports, C</dev/poll> only supports sockets
…		…
446	While this backend scales well, it requires one system call per active	488	While this backend scales well, it requires one system call per active
447	file descriptor per loop iteration. For small and medium numbers of file	489	file descriptor per loop iteration. For small and medium numbers of file
448	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	490	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
449	might perform better.	491	might perform better.
450		492
451	On the positive side, ignoring the spurious readiness notifications, this	493	On the positive side, with the exception of the spurious readiness
452	backend actually performed to specification in all tests and is fully	494	notifications, this backend actually performed fully to specification
453	embeddable, which is a rare feat among the OS-specific backends.	495	in all tests and is fully embeddable, which is a rare feat among the
		496	OS-specific backends (I vastly prefer correctness over speed hacks).
		497
		498	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
		499	C<EVBACKEND_POLL>.
454		500
455	=item C<EVBACKEND_ALL>	501	=item C<EVBACKEND_ALL>
456		502
457	Try all backends (even potentially broken ones that wouldn't be tried	503	Try all backends (even potentially broken ones that wouldn't be tried
458	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	504	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
…		…
464		510
465	If one or more of these are or'ed into the flags value, then only these	511	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	512	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.	513	specified, all backends in C<ev_recommended_backends ()> will be tried.
468		514
469	The most typical usage is like this:	515	Example: This is the most typical usage.
470		516
471	if (!ev_default_loop (0))	517	if (!ev_default_loop (0))
472	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	518	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
473		519
474	Restrict libev to the select and poll backends, and do not allow	520	Example: Restrict libev to the select and poll backends, and do not allow
475	environment settings to be taken into account:	521	environment settings to be taken into account:
476		522
477	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);	523	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
478		524
479	Use whatever libev has to offer, but make sure that kqueue is used if	525	Example: Use whatever libev has to offer, but make sure that kqueue is
480	available (warning, breaks stuff, best use only with your own private	526	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):	527	private event loop and only if you know the OS supports your types of
		528	fds):
482		529
483	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);	530	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
484		531
485	=item struct ev_loop *ev_loop_new (unsigned int flags)	532	=item struct ev_loop *ev_loop_new (unsigned int flags)
486		533
487	Similar to C<ev_default_loop>, but always creates a new event loop that is	534	Similar to C<ev_default_loop>, but always creates a new event loop that is
488	always distinct from the default loop. Unlike the default loop, it cannot	535	always distinct from the default loop. Unlike the default loop, it cannot
…		…
493	libev with threads is indeed to create one loop per thread, and using the	540	libev with threads is indeed to create one loop per thread, and using the
494	default loop in the "main" or "initial" thread.	541	default loop in the "main" or "initial" thread.
495		542
496	Example: Try to create a event loop that uses epoll and nothing else.	543	Example: Try to create a event loop that uses epoll and nothing else.
497		544
498	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	545	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
499	if (!epoller)	546	if (!epoller)
500	fatal ("no epoll found here, maybe it hides under your chair");	547	fatal ("no epoll found here, maybe it hides under your chair");
501		548
502	=item ev_default_destroy ()	549	=item ev_default_destroy ()
503		550
504	Destroys the default loop again (frees all memory and kernel state	551	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	552	etc.). None of the active event watchers will be stopped in the normal
…		…
507	responsibility to either stop all watchers cleanly yourself I<before>	554	responsibility to either stop all watchers cleanly yourself I<before>
508	calling this function, or cope with the fact afterwards (which is usually	555	calling this function, or cope with the fact afterwards (which is usually
509	the easiest thing, you can just ignore the watchers and/or C<free ()> them	556	the easiest thing, you can just ignore the watchers and/or C<free ()> them
510	for example).	557	for example).
511		558
512	Note that certain global state, such as signal state, will not be freed by	559	Note that certain global state, such as signal state (and installed signal
513	this function, and related watchers (such as signal and child watchers)	560	handlers), will not be freed by this function, and related watchers (such
514	would need to be stopped manually.	561	as signal and child watchers) would need to be stopped manually.
515		562
516	In general it is not advisable to call this function except in the	563	In general it is not advisable to call this function except in the
517	rare occasion where you really need to free e.g. the signal handling	564	rare occasion where you really need to free e.g. the signal handling
518	pipe fds. If you need dynamically allocated loops it is better to use	565	pipe fds. If you need dynamically allocated loops it is better to use
519	C<ev_loop_new> and C<ev_loop_destroy>).	566	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
544		591
545	=item ev_loop_fork (loop)	592	=item ev_loop_fork (loop)
546		593
547	Like C<ev_default_fork>, but acts on an event loop created by	594	Like C<ev_default_fork>, but acts on an event loop created by
548	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	595	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
549	after fork, and how you do this is entirely your own problem.	596	after fork that you want to re-use in the child, and how you do this is
		597	entirely your own problem.
550		598
551	=item int ev_is_default_loop (loop)	599	=item int ev_is_default_loop (loop)
552		600
553	Returns true when the given loop actually is the default loop, false otherwise.	601	Returns true when the given loop is, in fact, the default loop, and false
		602	otherwise.
554		603
555	=item unsigned int ev_loop_count (loop)	604	=item unsigned int ev_loop_count (loop)
556		605
557	Returns the count of loop iterations for the loop, which is identical to	606	Returns the count of loop iterations for the loop, which is identical to
558	the number of times libev did poll for new events. It starts at C<0> and	607	the number of times libev did poll for new events. It starts at C<0> and
…		…
573	received events and started processing them. This timestamp does not	622	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	623	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	624	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).	625	event occurring (or more correctly, libev finding out about it).
577		626
		627	=item ev_now_update (loop)
		628
		629	Establishes the current time by querying the kernel, updating the time
		630	returned by C<ev_now ()> in the progress. This is a costly operation and
		631	is usually done automatically within C<ev_loop ()>.
		632
		633	This function is rarely useful, but when some event callback runs for a
		634	very long time without entering the event loop, updating libev's idea of
		635	the current time is a good idea.
		636
		637	See also "The special problem of time updates" in the C<ev_timer> section.
		638
		639	=item ev_suspend (loop)
		640
		641	=item ev_resume (loop)
		642
		643	These two functions suspend and resume a loop, for use when the loop is
		644	not used for a while and timeouts should not be processed.
		645
		646	A typical use case would be an interactive program such as a game: When
		647	the user presses C<^Z> to suspend the game and resumes it an hour later it
		648	would be best to handle timeouts as if no time had actually passed while
		649	the program was suspended. This can be achieved by calling C<ev_suspend>
		650	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		651	C<ev_resume> directly afterwards to resume timer processing.
		652
		653	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		654	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		655	will be rescheduled (that is, they will lose any events that would have
		656	occured while suspended).
		657
		658	After calling C<ev_suspend> you B<must not> call I<any> function on the
		659	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		660	without a previous call to C<ev_suspend>.
		661
		662	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		663	event loop time (see C<ev_now_update>).
		664
578	=item ev_loop (loop, int flags)	665	=item ev_loop (loop, int flags)
579		666
580	Finally, this is it, the event handler. This function usually is called	667	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	668	after you initialised all your watchers and you want to start handling
582	events.	669	events.
…		…
584	If the flags argument is specified as C<0>, it will not return until	671	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.	672	either no event watchers are active anymore or C<ev_unloop> was called.
586		673
587	Please note that an explicit C<ev_unloop> is usually better than	674	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	675	relying on all watchers to be stopped when deciding when a program has
589	finished (especially in interactive programs), but having a program that	676	finished (especially in interactive programs), but having a program
590	automatically loops as long as it has to and no longer by virtue of	677	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.	678	of relying on its watchers stopping correctly, that is truly a thing of
		679	beauty.
592		680
593	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	681	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	682	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.	683	process in case there are no events and will return after one iteration of
		684	the loop.
596		685
597	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	686	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
598	necessary) and will handle those and any outstanding ones. It will block	687	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	688	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	689	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	690	user-registered callback will be called), and will return after one
		691	iteration of the loop.
		692
		693	This is useful if you are waiting for some external event in conjunction
		694	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	695	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.	696	usually a better approach for this kind of thing.
604		697
605	Here are the gory details of what C<ev_loop> does:	698	Here are the gory details of what C<ev_loop> does:
606		699
607	- Before the first iteration, call any pending watchers.	700	- Before the first iteration, call any pending watchers.
608	* If EVFLAG_FORKCHECK was used, check for a fork.	701	* If EVFLAG_FORKCHECK was used, check for a fork.
609	- If a fork was detected, queue and call all fork watchers.	702	- If a fork was detected (by any means), queue and call all fork watchers.
610	- Queue and call all prepare watchers.	703	- Queue and call all prepare watchers.
611	- If we have been forked, recreate the kernel state.	704	- If we have been forked, detach and recreate the kernel state
		705	as to not disturb the other process.
612	- Update the kernel state with all outstanding changes.	706	- Update the kernel state with all outstanding changes.
613	- Update the "event loop time".	707	- Update the "event loop time" (ev_now ()).
614	- Calculate for how long to sleep or block, if at all	708	- Calculate for how long to sleep or block, if at all
615	(active idle watchers, EVLOOP_NONBLOCK or not having	709	(active idle watchers, EVLOOP_NONBLOCK or not having
616	any active watchers at all will result in not sleeping).	710	any active watchers at all will result in not sleeping).
617	- Sleep if the I/O and timer collect interval say so.	711	- Sleep if the I/O and timer collect interval say so.
618	- Block the process, waiting for any events.	712	- Block the process, waiting for any events.
619	- Queue all outstanding I/O (fd) events.	713	- Queue all outstanding I/O (fd) events.
620	- Update the "event loop time" and do time jump handling.	714	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
621	- Queue all outstanding timers.	715	- Queue all expired timers.
622	- Queue all outstanding periodics.	716	- Queue all expired periodics.
623	- If no events are pending now, queue all idle watchers.	717	- Unless any events are pending now, queue all idle watchers.
624	- Queue all check watchers.	718	- Queue all check watchers.
625	- Call all queued watchers in reverse order (i.e. check watchers first).	719	- 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	720	Signals and child watchers are implemented as I/O watchers, and will
627	be handled here by queueing them when their watcher gets executed.	721	be handled here by queueing them when their watcher gets executed.
628	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	722	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
…		…
633	anymore.	727	anymore.
634		728
635	... queue jobs here, make sure they register event watchers as long	729	... 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..)	730	... as they still have work to do (even an idle watcher will do..)
637	ev_loop (my_loop, 0);	731	ev_loop (my_loop, 0);
638	... jobs done. yeah!	732	... jobs done or somebody called unloop. yeah!
639		733
640	=item ev_unloop (loop, how)	734	=item ev_unloop (loop, how)
641		735
642	Can be used to make a call to C<ev_loop> return early (but only after it	736	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	737	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	738	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.	739	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
646		740
647	This "unloop state" will be cleared when entering C<ev_loop> again.	741	This "unloop state" will be cleared when entering C<ev_loop> again.
648		742
		743	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		744
649	=item ev_ref (loop)	745	=item ev_ref (loop)
650		746
651	=item ev_unref (loop)	747	=item ev_unref (loop)
652		748
653	Ref/unref can be used to add or remove a reference count on the event	749	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	750	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	751	count is nonzero, C<ev_loop> will not return on its own.
		752
656	a watcher you never unregister that should not keep C<ev_loop> from	753	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	754	from returning, call ev_unref() after starting, and ev_ref() before
		755	stopping it.
		756
658	example, libev itself uses this for its internal signal pipe: It is not	757	As an example, libev itself uses this for its internal signal pipe: It
659	visible to the libev user and should not keep C<ev_loop> from exiting if	758	is not visible to the libev user and should not keep C<ev_loop> from
660	no event watchers registered by it are active. It is also an excellent	759	exiting if no event watchers registered by it are active. It is also an
661	way to do this for generic recurring timers or from within third-party	760	excellent way to do this for generic recurring timers or from within
662	libraries. Just remember to I<unref after start> and I<ref before stop>	761	third-party libraries. Just remember to I<unref after start> and I<ref
663	(but only if the watcher wasn't active before, or was active before,	762	before stop> (but only if the watcher wasn't active before, or was active
664	respectively).	763	before, respectively. Note also that libev might stop watchers itself
		764	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		765	in the callback).
665		766
666	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	767	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
667	running when nothing else is active.	768	running when nothing else is active.
668		769
669	struct ev_signal exitsig;	770	ev_signal exitsig;
670	ev_signal_init (&exitsig, sig_cb, SIGINT);	771	ev_signal_init (&exitsig, sig_cb, SIGINT);
671	ev_signal_start (loop, &exitsig);	772	ev_signal_start (loop, &exitsig);
672	evf_unref (loop);	773	evf_unref (loop);
673		774
674	Example: For some weird reason, unregister the above signal handler again.	775	Example: For some weird reason, unregister the above signal handler again.
675		776
676	ev_ref (loop);	777	ev_ref (loop);
677	ev_signal_stop (loop, &exitsig);	778	ev_signal_stop (loop, &exitsig);
678		779
679	=item ev_set_io_collect_interval (loop, ev_tstamp interval)	780	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
680		781
681	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)	782	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
682		783
683	These advanced functions influence the time that libev will spend waiting	784	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	785	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.	786	will try to invoke timer/periodic callbacks and I/O callbacks with minimum
		787	latency.
686		788
687	Setting these to a higher value (the C<interval> I<must> be >= C<0>)	789	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	790	allows libev to delay invocation of I/O and timer/periodic callbacks
689	increase efficiency of loop iterations.	791	to increase efficiency of loop iterations (or to increase power-saving
		792	opportunities).
690		793
691	The background is that sometimes your program runs just fast enough to	794	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	795	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	796	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	797	events, especially with backends like C<select ()> which have a high
695	overhead for the actual polling but can deliver many events at once.	798	overhead for the actual polling but can deliver many events at once.
696		799
697	By setting a higher I<io collect interval> you allow libev to spend more	800	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,	801	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	803	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.	804	introduce an additional C<ev_sleep ()> call into most loop iterations.
702		805
703	Likewise, by setting a higher I<timeout collect interval> you allow libev	806	Likewise, by setting a higher I<timeout collect interval> you allow libev
704	to spend more time collecting timeouts, at the expense of increased	807	to spend more time collecting timeouts, at the expense of increased
705	latency (the watcher callback will be called later). C<ev_io> watchers	808	latency/jitter/inexactness (the watcher callback will be called
706	will not be affected. Setting this to a non-null value will not introduce	809	later). C<ev_io> watchers will not be affected. Setting this to a non-null
707	any overhead in libev.	810	value will not introduce any overhead in libev.
708		811
709	Many (busy) programs can usually benefit by setting the I/O collect	812	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	813	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	814	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>,	815	usually doesn't make much sense to set it to a lower value than C<0.01>,
713	as this approaches the timing granularity of most systems.	816	as this approaches the timing granularity of most systems.
714		817
		818	Setting the I<timeout collect interval> can improve the opportunity for
		819	saving power, as the program will "bundle" timer callback invocations that
		820	are "near" in time together, by delaying some, thus reducing the number of
		821	times the process sleeps and wakes up again. Another useful technique to
		822	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
		823	they fire on, say, one-second boundaries only.
		824
715	=item ev_loop_verify (loop)	825	=item ev_loop_verify (loop)
716		826
717	This function only does something when C<EV_VERIFY> support has been	827	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	828	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	829	through all internal structures and checks them for validity. If anything
720	an error message to standard error and call C<abort ()>.	830	is found to be inconsistent, it will print an error message to standard
		831	error and call C<abort ()>.
721		832
722	This can be used to catch bugs inside libev itself: under normal	833	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	834	circumstances, this function will never abort as of course libev keeps its
724	data structures consistent.	835	data structures consistent.
725		836
726	=back	837	=back
727		838
728		839
729	=head1 ANATOMY OF A WATCHER	840	=head1 ANATOMY OF A WATCHER
730		841
		842	In the following description, uppercase C<TYPE> in names stands for the
		843	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		844	watchers and C<ev_io_start> for I/O watchers.
		845
731	A watcher is a structure that you create and register to record your	846	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	847	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:	848	become readable, you would create an C<ev_io> watcher for that:
734		849
735	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	850	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
736	{	851	{
737	ev_io_stop (w);	852	ev_io_stop (w);
738	ev_unloop (loop, EVUNLOOP_ALL);	853	ev_unloop (loop, EVUNLOOP_ALL);
739	}	854	}
740		855
741	struct ev_loop *loop = ev_default_loop (0);	856	struct ev_loop *loop = ev_default_loop (0);
		857
742	struct ev_io stdin_watcher;	858	ev_io stdin_watcher;
		859
743	ev_init (&stdin_watcher, my_cb);	860	ev_init (&stdin_watcher, my_cb);
744	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	861	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
745	ev_io_start (loop, &stdin_watcher);	862	ev_io_start (loop, &stdin_watcher);
		863
746	ev_loop (loop, 0);	864	ev_loop (loop, 0);
747		865
748	As you can see, you are responsible for allocating the memory for your	866	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,	867	watcher structures (and it is I<usually> a bad idea to do this on the
750	although this can sometimes be quite valid).	868	stack).
		869
		870	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		871	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
751		872
752	Each watcher structure must be initialised by a call to C<ev_init	873	Each watcher structure must be initialised by a call to C<ev_init
753	(watcher *, callback)>, which expects a callback to be provided. This	874	(watcher *, callback)>, which expects a callback to be provided. This
754	callback gets invoked each time the event occurs (or, in the case of I/O	875	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	876	watchers, each time the event loop detects that the file descriptor given
756	is readable and/or writable).	877	is readable and/or writable).
757		878
758	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	879	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	880	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	881	is also a macro to combine initialisation and setting in one call: C<<
761	(watcher *, callback, ...) >>.	882	ev_TYPE_init (watcher *, callback, ...) >>.
762		883
763	To make the watcher actually watch out for events, you have to start it	884	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	885	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	886	*) >>), and you can stop watching for events at any time by calling the
766	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	887	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
767		888
768	As long as your watcher is active (has been started but not stopped) you	889	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	890	must not touch the values stored in it. Most specifically you must never
770	reinitialise it or call its C<set> macro.	891	reinitialise it or call its C<ev_TYPE_set> macro.
771		892
772	Each and every callback receives the event loop pointer as first, the	893	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	894	registered watcher structure as second, and a bitset of received events as
774	third argument.	895	third argument.
775		896
…		…
833		954
834	=item C<EV_ASYNC>	955	=item C<EV_ASYNC>
835		956
836	The given async watcher has been asynchronously notified (see C<ev_async>).	957	The given async watcher has been asynchronously notified (see C<ev_async>).
837		958
		959	=item C<EV_CUSTOM>
		960
		961	Not ever sent (or otherwise used) by libev itself, but can be freely used
		962	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		963
838	=item C<EV_ERROR>	964	=item C<EV_ERROR>
839		965
840	An unspecified error has occurred, the watcher has been stopped. This might	966	An unspecified error has occurred, the watcher has been stopped. This might
841	happen because the watcher could not be properly started because libev	967	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	968	ran out of memory, a file descriptor was found to be closed or any other
		969	problem. Libev considers these application bugs.
		970
843	problem. You best act on it by reporting the problem and somehow coping	971	You best act on it by reporting the problem and somehow coping with the
844	with the watcher being stopped.	972	watcher being stopped. Note that well-written programs should not receive
		973	an error ever, so when your watcher receives it, this usually indicates a
		974	bug in your program.
845		975
846	Libev will usually signal a few "dummy" events together with an error,	976	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	977	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	978	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 multi-threaded	979	the error from read() or write(). This will not work in multi-threaded
850	programs, though, so beware.	980	programs, though, as the fd could already be closed and reused for another
		981	thing, so beware.
851		982
852	=back	983	=back
853		984
854	=head2 GENERIC WATCHER FUNCTIONS	985	=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		986
859	=over 4	987	=over 4
860		988
861	=item C<ev_init> (ev_TYPE *watcher, callback)	989	=item C<ev_init> (ev_TYPE *watcher, callback)
862		990
…		…
868	which rolls both calls into one.	996	which rolls both calls into one.
869		997
870	You can reinitialise a watcher at any time as long as it has been stopped	998	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.	999	(or never started) and there are no pending events outstanding.
872		1000
873	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	1001	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
874	int revents)>.	1002	int revents)>.
		1003
		1004	Example: Initialise an C<ev_io> watcher in two steps.
		1005
		1006	ev_io w;
		1007	ev_init (&w, my_cb);
		1008	ev_io_set (&w, STDIN_FILENO, EV_READ);
875		1009
876	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1010	=item C<ev_TYPE_set> (ev_TYPE *, [args])
877		1011
878	This macro initialises the type-specific parts of a watcher. You need to	1012	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	1013	call C<ev_init> at least once before you call this macro, but you can
…		…
882	difference to the C<ev_init> macro).	1016	difference to the C<ev_init> macro).
883		1017
884	Although some watcher types do not have type-specific arguments	1018	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.	1019	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
886		1020
		1021	See C<ev_init>, above, for an example.
		1022
887	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])	1023	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
888		1024
889	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro	1025	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
890	calls into a single call. This is the most convenient method to initialise	1026	calls into a single call. This is the most convenient method to initialise
891	a watcher. The same limitations apply, of course.	1027	a watcher. The same limitations apply, of course.
892		1028
		1029	Example: Initialise and set an C<ev_io> watcher in one step.
		1030
		1031	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
		1032
893	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1033	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)
894		1034
895	Starts (activates) the given watcher. Only active watchers will receive	1035	Starts (activates) the given watcher. Only active watchers will receive
896	events. If the watcher is already active nothing will happen.	1036	events. If the watcher is already active nothing will happen.
897		1037
		1038	Example: Start the C<ev_io> watcher that is being abused as example in this
		1039	whole section.
		1040
		1041	ev_io_start (EV_DEFAULT_UC, &w);
		1042
898	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1043	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
899		1044
900	Stops the given watcher again (if active) and clears the pending	1045	Stops the given watcher if active, and clears the pending status (whether
		1046	the watcher was active or not).
		1047
901	status. It is possible that stopped watchers are pending (for example,	1048	It is possible that stopped watchers are pending - for example,
902	non-repeating timers are being stopped when they become pending), but	1049	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	1050	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	1051	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.	1052	therefore a good idea to always call its C<ev_TYPE_stop> function.
906		1053
907	=item bool ev_is_active (ev_TYPE *watcher)	1054	=item bool ev_is_active (ev_TYPE *watcher)
908		1055
909	Returns a true value iff the watcher is active (i.e. it has been started	1056	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	1057	and not yet been stopped). As long as a watcher is active you must not modify
…		…
936	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1083	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
937	(default: C<-2>). Pending watchers with higher priority will be invoked	1084	(default: C<-2>). Pending watchers with higher priority will be invoked
938	before watchers with lower priority, but priority will not keep watchers	1085	before watchers with lower priority, but priority will not keep watchers
939	from being executed (except for C<ev_idle> watchers).	1086	from being executed (except for C<ev_idle> watchers).
940		1087
941	This means that priorities are I<only> used for ordering callback
942	invocation after new events have been received. This is useful, for
943	example, to reduce latency after idling, or more often, to bind two
944	watchers on the same event and make sure one is called first.
945
946	If you need to suppress invocation when higher priority events are pending	1088	If you need to suppress invocation when higher priority events are pending
947	you need to look at C<ev_idle> watchers, which provide this functionality.	1089	you need to look at C<ev_idle> watchers, which provide this functionality.
948		1090
949	You I<must not> change the priority of a watcher as long as it is active or	1091	You I<must not> change the priority of a watcher as long as it is active or
950	pending.	1092	pending.
951		1093
		1094	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1095	fine, as long as you do not mind that the priority value you query might
		1096	or might not have been clamped to the valid range.
		1097
952	The default priority used by watchers when no priority has been set is	1098	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 :).	1099	always C<0>, which is supposed to not be too high and not be too low :).
954		1100
955	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1101	See L<WATCHER PRIORITIES>, below, for a more thorough treatment of
956	fine, as long as you do not mind that the priority value you query might	1102	priorities.
957	or might not have been adjusted to be within valid range.
958		1103
959	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1104	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
960		1105
961	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1106	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	1107	C<loop> nor C<revents> need to be valid as long as the watcher callback
963	can deal with that fact.	1108	can deal with that fact, as both are simply passed through to the
		1109	callback.
964		1110
965	=item int ev_clear_pending (loop, ev_TYPE *watcher)	1111	=item int ev_clear_pending (loop, ev_TYPE *watcher)
966		1112
967	If the watcher is pending, this function returns clears its pending status	1113	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	1114	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>.	1115	watcher isn't pending it does nothing and returns C<0>.
970		1116
		1117	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1118	callback to be invoked, which can be accomplished with this function.
		1119
971	=back	1120	=back
972		1121
973		1122
974	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1123	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
975		1124
976	Each watcher has, by default, a member C<void *data> that you can change	1125	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	1126	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	1127	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	1128	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	1129	member, you can also "subclass" the watcher type and provide your own
981	data:	1130	data:
982		1131
983	struct my_io	1132	struct my_io
984	{	1133	{
985	struct ev_io io;	1134	ev_io io;
986	int otherfd;	1135	int otherfd;
987	void *somedata;	1136	void *somedata;
988	struct whatever *mostinteresting;	1137	struct whatever *mostinteresting;
989	}	1138	};
		1139
		1140	...
		1141	struct my_io w;
		1142	ev_io_init (&w.io, my_cb, fd, EV_READ);
990		1143
991	And since your callback will be called with a pointer to the watcher, you	1144	And since your callback will be called with a pointer to the watcher, you
992	can cast it back to your own type:	1145	can cast it back to your own type:
993		1146
994	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1147	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
995	{	1148	{
996	struct my_io *w = (struct my_io *)w_;	1149	struct my_io *w = (struct my_io *)w_;
997	...	1150	...
998	}	1151	}
999		1152
1000	More interesting and less C-conformant ways of casting your callback type	1153	More interesting and less C-conformant ways of casting your callback type
1001	instead have been omitted.	1154	instead have been omitted.
1002		1155
1003	Another common scenario is having some data structure with multiple	1156	Another common scenario is to use some data structure with multiple
1004	watchers:	1157	embedded watchers:
1005		1158
1006	struct my_biggy	1159	struct my_biggy
1007	{	1160	{
1008	int some_data;	1161	int some_data;
1009	ev_timer t1;	1162	ev_timer t1;
1010	ev_timer t2;	1163	ev_timer t2;
1011	}	1164	}
1012		1165
1013	In this case getting the pointer to C<my_biggy> is a bit more complicated,	1166	In this case getting the pointer to C<my_biggy> is a bit more
1014	you need to use C<offsetof>:	1167	complicated: Either you store the address of your C<my_biggy> struct
		1168	in the C<data> member of the watcher (for woozies), or you need to use
		1169	some pointer arithmetic using C<offsetof> inside your watchers (for real
		1170	programmers):
1015		1171
1016	#include <stddef.h>	1172	#include <stddef.h>
1017		1173
1018	static void	1174	static void
1019	t1_cb (EV_P_ struct ev_timer *w, int revents)	1175	t1_cb (EV_P_ ev_timer *w, int revents)
1020	{	1176	{
1021	struct my_biggy big = (struct my_biggy *	1177	struct my_biggy big = (struct my_biggy *
1022	(((char *)w) - offsetof (struct my_biggy, t1));	1178	(((char *)w) - offsetof (struct my_biggy, t1));
1023	}	1179	}
1024		1180
1025	static void	1181	static void
1026	t2_cb (EV_P_ struct ev_timer *w, int revents)	1182	t2_cb (EV_P_ ev_timer *w, int revents)
1027	{	1183	{
1028	struct my_biggy big = (struct my_biggy *	1184	struct my_biggy big = (struct my_biggy *
1029	(((char *)w) - offsetof (struct my_biggy, t2));	1185	(((char *)w) - offsetof (struct my_biggy, t2));
1030	}	1186	}
		1187
		1188	=head2 WATCHER PRIORITY MODELS
		1189
		1190	Many event loops support I<watcher priorities>, which are usually small
		1191	integers that influence the ordering of event callback invocation
		1192	between watchers in some way, all else being equal.
		1193
		1194	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1195	description for the more technical details such as the actual priority
		1196	range.
		1197
		1198	There are two common ways how these these priorities are being interpreted
		1199	by event loops:
		1200
		1201	In the more common lock-out model, higher priorities "lock out" invocation
		1202	of lower priority watchers, which means as long as higher priority
		1203	watchers receive events, lower priority watchers are not being invoked.
		1204
		1205	The less common only-for-ordering model uses priorities solely to order
		1206	callback invocation within a single event loop iteration: Higher priority
		1207	watchers are invoked before lower priority ones, but they all get invoked
		1208	before polling for new events.
		1209
		1210	Libev uses the second (only-for-ordering) model for all its watchers
		1211	except for idle watchers (which use the lock-out model).
		1212
		1213	The rationale behind this is that implementing the lock-out model for
		1214	watchers is not well supported by most kernel interfaces, and most event
		1215	libraries will just poll for the same events again and again as long as
		1216	their callbacks have not been executed, which is very inefficient in the
		1217	common case of one high-priority watcher locking out a mass of lower
		1218	priority ones.
		1219
		1220	Static (ordering) priorities are most useful when you have two or more
		1221	watchers handling the same resource: a typical usage example is having an
		1222	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1223	timeouts. Under load, data might be received while the program handles
		1224	other jobs, but since timers normally get invoked first, the timeout
		1225	handler will be executed before checking for data. In that case, giving
		1226	the timer a lower priority than the I/O watcher ensures that I/O will be
		1227	handled first even under adverse conditions (which is usually, but not
		1228	always, what you want).
		1229
		1230	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1231	will only be executed when no same or higher priority watchers have
		1232	received events, they can be used to implement the "lock-out" model when
		1233	required.
		1234
		1235	For example, to emulate how many other event libraries handle priorities,
		1236	you can associate an C<ev_idle> watcher to each such watcher, and in
		1237	the normal watcher callback, you just start the idle watcher. The real
		1238	processing is done in the idle watcher callback. This causes libev to
		1239	continously poll and process kernel event data for the watcher, but when
		1240	the lock-out case is known to be rare (which in turn is rare :), this is
		1241	workable.
		1242
		1243	Usually, however, the lock-out model implemented that way will perform
		1244	miserably under the type of load it was designed to handle. In that case,
		1245	it might be preferable to stop the real watcher before starting the
		1246	idle watcher, so the kernel will not have to process the event in case
		1247	the actual processing will be delayed for considerable time.
		1248
		1249	Here is an example of an I/O watcher that should run at a strictly lower
		1250	priority than the default, and which should only process data when no
		1251	other events are pending:
		1252
		1253	ev_idle idle; // actual processing watcher
		1254	ev_io io; // actual event watcher
		1255
		1256	static void
		1257	io_cb (EV_P_ ev_io *w, int revents)
		1258	{
		1259	// stop the I/O watcher, we received the event, but
		1260	// are not yet ready to handle it.
		1261	ev_io_stop (EV_A_ w);
		1262
		1263	// start the idle watcher to ahndle the actual event.
		1264	// it will not be executed as long as other watchers
		1265	// with the default priority are receiving events.
		1266	ev_idle_start (EV_A_ &idle);
		1267	}
		1268
		1269	static void
		1270	idle-cb (EV_P_ ev_idle *w, int revents)
		1271	{
		1272	// actual processing
		1273	read (STDIN_FILENO, ...);
		1274
		1275	// have to start the I/O watcher again, as
		1276	// we have handled the event
		1277	ev_io_start (EV_P_ &io);
		1278	}
		1279
		1280	// initialisation
		1281	ev_idle_init (&idle, idle_cb);
		1282	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1283	ev_io_start (EV_DEFAULT_ &io);
		1284
		1285	In the "real" world, it might also be beneficial to start a timer, so that
		1286	low-priority connections can not be locked out forever under load. This
		1287	enables your program to keep a lower latency for important connections
		1288	during short periods of high load, while not completely locking out less
		1289	important ones.
1031		1290
1032		1291
1033	=head1 WATCHER TYPES	1292	=head1 WATCHER TYPES
1034		1293
1035	This section describes each watcher in detail, but will not repeat	1294	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	1318	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	1319	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	1320	descriptors to non-blocking mode is also usually a good idea (but not
1062	required if you know what you are doing).	1321	required if you know what you are doing).
1063		1322
1064	If you must do this, then force the use of a known-to-be-good backend	1323	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	1324	known-to-be-good backend (at the time of this writing, this includes only
1066	C<EVBACKEND_POLL>).	1325	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).
1067		1326
1068	Another thing you have to watch out for is that it is quite easy to	1327	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	1328	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	1329	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	1330	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	1331	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	1332	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	1333	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.	1334	C<EAGAIN> is far preferable to a program hanging until some data arrives.
1076		1335
1077	If you cannot run the fd in non-blocking mode (for example you should not	1336	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 separately re-test	1337	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	1338	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	1339	interface such as poll (fortunately in our Xlib example, Xlib already
1081	its own, so its quite safe to use).	1340	does this on its own, so its quite safe to use). Some people additionally
		1341	use C<SIGALRM> and an interval timer, just to be sure you won't block
		1342	indefinitely.
		1343
		1344	But really, best use non-blocking mode.
1082		1345
1083	=head3 The special problem of disappearing file descriptors	1346	=head3 The special problem of disappearing file descriptors
1084		1347
1085	Some backends (e.g. kqueue, epoll) need to be told about closing a file	1348	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,	1349	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	1350	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	1351	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	1352	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	1353	registered with libev, there is no efficient way to see that this is, in
1091	fact, a different file descriptor.	1354	fact, a different file descriptor.
1092		1355
…		…
1123	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1386	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1124	C<EVBACKEND_POLL>.	1387	C<EVBACKEND_POLL>.
1125		1388
1126	=head3 The special problem of SIGPIPE	1389	=head3 The special problem of SIGPIPE
1127		1390
1128	While not really specific to libev, it is easy to forget about SIGPIPE:	1391	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	1392	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	1393	sent a SIGPIPE, which, by default, aborts your program. For most programs
1131	programs this is sensible behaviour, for daemons, this is usually	1394	this is sensible behaviour, for daemons, this is usually undesirable.
1132	undesirable.
1133		1395
1134	So when you encounter spurious, unexplained daemon exits, make sure you	1396	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	1397	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).	1398	somewhere, as that would have given you a big clue).
1137		1399
…		…
1143	=item ev_io_init (ev_io *, callback, int fd, int events)	1405	=item ev_io_init (ev_io *, callback, int fd, int events)
1144		1406
1145	=item ev_io_set (ev_io *, int fd, int events)	1407	=item ev_io_set (ev_io *, int fd, int events)
1146		1408
1147	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1409	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1148	receive events for and events is either C<EV_READ>, C<EV_WRITE> or	1410	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.	1411	C<EV_READ | EV_WRITE>, to express the desire to receive the given events.
1150		1412
1151	=item int fd [read-only]	1413	=item int fd [read-only]
1152		1414
1153	The file descriptor being watched.	1415	The file descriptor being watched.
1154		1416
…		…
1162		1424
1163	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1425	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	1426	readable, but only once. Since it is likely line-buffered, you could
1165	attempt to read a whole line in the callback.	1427	attempt to read a whole line in the callback.
1166		1428
1167	static void	1429	static void
1168	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1430	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1169	{	1431	{
1170	ev_io_stop (loop, w);	1432	ev_io_stop (loop, w);
1171	.. read from stdin here (or from w->fd) and haqndle any I/O errors	1433	.. read from stdin here (or from w->fd) and handle any I/O errors
1172	}	1434	}
1173		1435
1174	...	1436	...
1175	struct ev_loop *loop = ev_default_init (0);	1437	struct ev_loop *loop = ev_default_init (0);
1176	struct ev_io stdin_readable;	1438	ev_io stdin_readable;
1177	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1439	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1178	ev_io_start (loop, &stdin_readable);	1440	ev_io_start (loop, &stdin_readable);
1179	ev_loop (loop, 0);	1441	ev_loop (loop, 0);
1180		1442
1181		1443
1182	=head2 C<ev_timer> - relative and optionally repeating timeouts	1444	=head2 C<ev_timer> - relative and optionally repeating timeouts
1183		1445
1184	Timer watchers are simple relative timers that generate an event after a	1446	Timer watchers are simple relative timers that generate an event after a
1185	given time, and optionally repeating in regular intervals after that.	1447	given time, and optionally repeating in regular intervals after that.
1186		1448
1187	The timers are based on real time, that is, if you register an event that	1449	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	1450	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	1451	year, it will still time out after (roughly) one hour. "Roughly" because
1190	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1452	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1191	monotonic clock option helps a lot here).	1453	monotonic clock option helps a lot here).
		1454
		1455	The callback is guaranteed to be invoked only I<after> its timeout has
		1456	passed. If multiple timers become ready during the same loop iteration
		1457	then the ones with earlier time-out values are invoked before ones with
		1458	later time-out values (but this is no longer true when a callback calls
		1459	C<ev_loop> recursively).
		1460
		1461	=head3 Be smart about timeouts
		1462
		1463	Many real-world problems involve some kind of timeout, usually for error
		1464	recovery. A typical example is an HTTP request - if the other side hangs,
		1465	you want to raise some error after a while.
		1466
		1467	What follows are some ways to handle this problem, from obvious and
		1468	inefficient to smart and efficient.
		1469
		1470	In the following, a 60 second activity timeout is assumed - a timeout that
		1471	gets reset to 60 seconds each time there is activity (e.g. each time some
		1472	data or other life sign was received).
		1473
		1474	=over 4
		1475
		1476	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1477
		1478	This is the most obvious, but not the most simple way: In the beginning,
		1479	start the watcher:
		1480
		1481	ev_timer_init (timer, callback, 60., 0.);
		1482	ev_timer_start (loop, timer);
		1483
		1484	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1485	and start it again:
		1486
		1487	ev_timer_stop (loop, timer);
		1488	ev_timer_set (timer, 60., 0.);
		1489	ev_timer_start (loop, timer);
		1490
		1491	This is relatively simple to implement, but means that each time there is
		1492	some activity, libev will first have to remove the timer from its internal
		1493	data structure and then add it again. Libev tries to be fast, but it's
		1494	still not a constant-time operation.
		1495
		1496	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1497
		1498	This is the easiest way, and involves using C<ev_timer_again> instead of
		1499	C<ev_timer_start>.
		1500
		1501	To implement this, configure an C<ev_timer> with a C<repeat> value
		1502	of C<60> and then call C<ev_timer_again> at start and each time you
		1503	successfully read or write some data. If you go into an idle state where
		1504	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1505	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1506
		1507	That means you can ignore both the C<ev_timer_start> function and the
		1508	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1509	member and C<ev_timer_again>.
		1510
		1511	At start:
		1512
		1513	ev_timer_init (timer, callback);
		1514	timer->repeat = 60.;
		1515	ev_timer_again (loop, timer);
		1516
		1517	Each time there is some activity:
		1518
		1519	ev_timer_again (loop, timer);
		1520
		1521	It is even possible to change the time-out on the fly, regardless of
		1522	whether the watcher is active or not:
		1523
		1524	timer->repeat = 30.;
		1525	ev_timer_again (loop, timer);
		1526
		1527	This is slightly more efficient then stopping/starting the timer each time
		1528	you want to modify its timeout value, as libev does not have to completely
		1529	remove and re-insert the timer from/into its internal data structure.
		1530
		1531	It is, however, even simpler than the "obvious" way to do it.
		1532
		1533	=item 3. Let the timer time out, but then re-arm it as required.
		1534
		1535	This method is more tricky, but usually most efficient: Most timeouts are
		1536	relatively long compared to the intervals between other activity - in
		1537	our example, within 60 seconds, there are usually many I/O events with
		1538	associated activity resets.
		1539
		1540	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1541	but remember the time of last activity, and check for a real timeout only
		1542	within the callback:
		1543
		1544	ev_tstamp last_activity; // time of last activity
		1545
		1546	static void
		1547	callback (EV_P_ ev_timer *w, int revents)
		1548	{
		1549	ev_tstamp now = ev_now (EV_A);
		1550	ev_tstamp timeout = last_activity + 60.;
		1551
		1552	// if last_activity + 60. is older than now, we did time out
		1553	if (timeout < now)
		1554	{
		1555	// timeout occured, take action
		1556	}
		1557	else
		1558	{
		1559	// callback was invoked, but there was some activity, re-arm
		1560	// the watcher to fire in last_activity + 60, which is
		1561	// guaranteed to be in the future, so "again" is positive:
		1562	w->repeat = timeout - now;
		1563	ev_timer_again (EV_A_ w);
		1564	}
		1565	}
		1566
		1567	To summarise the callback: first calculate the real timeout (defined
		1568	as "60 seconds after the last activity"), then check if that time has
		1569	been reached, which means something I<did>, in fact, time out. Otherwise
		1570	the callback was invoked too early (C<timeout> is in the future), so
		1571	re-schedule the timer to fire at that future time, to see if maybe we have
		1572	a timeout then.
		1573
		1574	Note how C<ev_timer_again> is used, taking advantage of the
		1575	C<ev_timer_again> optimisation when the timer is already running.
		1576
		1577	This scheme causes more callback invocations (about one every 60 seconds
		1578	minus half the average time between activity), but virtually no calls to
		1579	libev to change the timeout.
		1580
		1581	To start the timer, simply initialise the watcher and set C<last_activity>
		1582	to the current time (meaning we just have some activity :), then call the
		1583	callback, which will "do the right thing" and start the timer:
		1584
		1585	ev_timer_init (timer, callback);
		1586	last_activity = ev_now (loop);
		1587	callback (loop, timer, EV_TIMEOUT);
		1588
		1589	And when there is some activity, simply store the current time in
		1590	C<last_activity>, no libev calls at all:
		1591
		1592	last_actiivty = ev_now (loop);
		1593
		1594	This technique is slightly more complex, but in most cases where the
		1595	time-out is unlikely to be triggered, much more efficient.
		1596
		1597	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1598	callback :) - just change the timeout and invoke the callback, which will
		1599	fix things for you.
		1600
		1601	=item 4. Wee, just use a double-linked list for your timeouts.
		1602
		1603	If there is not one request, but many thousands (millions...), all
		1604	employing some kind of timeout with the same timeout value, then one can
		1605	do even better:
		1606
		1607	When starting the timeout, calculate the timeout value and put the timeout
		1608	at the I<end> of the list.
		1609
		1610	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1611	the list is expected to fire (for example, using the technique #3).
		1612
		1613	When there is some activity, remove the timer from the list, recalculate
		1614	the timeout, append it to the end of the list again, and make sure to
		1615	update the C<ev_timer> if it was taken from the beginning of the list.
		1616
		1617	This way, one can manage an unlimited number of timeouts in O(1) time for
		1618	starting, stopping and updating the timers, at the expense of a major
		1619	complication, and having to use a constant timeout. The constant timeout
		1620	ensures that the list stays sorted.
		1621
		1622	=back
		1623
		1624	So which method the best?
		1625
		1626	Method #2 is a simple no-brain-required solution that is adequate in most
		1627	situations. Method #3 requires a bit more thinking, but handles many cases
		1628	better, and isn't very complicated either. In most case, choosing either
		1629	one is fine, with #3 being better in typical situations.
		1630
		1631	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1632	rather complicated, but extremely efficient, something that really pays
		1633	off after the first million or so of active timers, i.e. it's usually
		1634	overkill :)
		1635
		1636	=head3 The special problem of time updates
		1637
		1638	Establishing the current time is a costly operation (it usually takes at
		1639	least two system calls): EV therefore updates its idea of the current
		1640	time only before and after C<ev_loop> collects new events, which causes a
		1641	growing difference between C<ev_now ()> and C<ev_time ()> when handling
		1642	lots of events in one iteration.
1192		1643
1193	The relative timeouts are calculated relative to the C<ev_now ()>	1644	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	1645	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	1646	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	1647	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:	1648	timeout on the current time, use something like this to adjust for this:
1198		1649
1199	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1650	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1200		1651
1201	The callback is guaranteed to be invoked only after its timeout has passed,	1652	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	1653	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1203	order of execution is undefined.	1654	()>.
1204		1655
1205	=head3 Watcher-Specific Functions and Data Members	1656	=head3 Watcher-Specific Functions and Data Members
1206		1657
1207	=over 4	1658	=over 4
1208		1659
…		…
1232	If the timer is started but non-repeating, stop it (as if it timed out).	1683	If the timer is started but non-repeating, stop it (as if it timed out).
1233		1684
1234	If the timer is repeating, either start it if necessary (with the	1685	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.	1686	C<repeat> value), or reset the running timer to the C<repeat> value.
1236		1687
1237	This sounds a bit complicated, but here is a useful and typical	1688	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1238	example: Imagine you have a TCP connection and you want a so-called idle	1689	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		1690
1262	=item ev_tstamp repeat [read-write]	1691	=item ev_tstamp repeat [read-write]
1263		1692
1264	The current C<repeat> value. Will be used each time the watcher times out	1693	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),	1694	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.	1695	which is also when any modifications are taken into account.
1267		1696
1268	=back	1697	=back
1269		1698
1270	=head3 Examples	1699	=head3 Examples
1271		1700
1272	Example: Create a timer that fires after 60 seconds.	1701	Example: Create a timer that fires after 60 seconds.
1273		1702
1274	static void	1703	static void
1275	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1704	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1276	{	1705	{
1277	.. one minute over, w is actually stopped right here	1706	.. one minute over, w is actually stopped right here
1278	}	1707	}
1279		1708
1280	struct ev_timer mytimer;	1709	ev_timer mytimer;
1281	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1710	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1282	ev_timer_start (loop, &mytimer);	1711	ev_timer_start (loop, &mytimer);
1283		1712
1284	Example: Create a timeout timer that times out after 10 seconds of	1713	Example: Create a timeout timer that times out after 10 seconds of
1285	inactivity.	1714	inactivity.
1286		1715
1287	static void	1716	static void
1288	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1717	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1289	{	1718	{
1290	.. ten seconds without any activity	1719	.. ten seconds without any activity
1291	}	1720	}
1292		1721
1293	struct ev_timer mytimer;	1722	ev_timer mytimer;
1294	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1723	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1295	ev_timer_again (&mytimer); /* start timer */	1724	ev_timer_again (&mytimer); /* start timer */
1296	ev_loop (loop, 0);	1725	ev_loop (loop, 0);
1297		1726
1298	// and in some piece of code that gets executed on any "activity":	1727	// and in some piece of code that gets executed on any "activity":
1299	// reset the timeout to start ticking again at 10 seconds	1728	// reset the timeout to start ticking again at 10 seconds
1300	ev_timer_again (&mytimer);	1729	ev_timer_again (&mytimer);
1301		1730
1302		1731
1303	=head2 C<ev_periodic> - to cron or not to cron?	1732	=head2 C<ev_periodic> - to cron or not to cron?
1304		1733
1305	Periodic watchers are also timers of a kind, but they are very versatile	1734	Periodic watchers are also timers of a kind, but they are very versatile
1306	(and unfortunately a bit complex).	1735	(and unfortunately a bit complex).
1307		1736
1308	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1737	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1309	but on wall clock time (absolute time). You can tell a periodic watcher	1738	relative time, the physical time that passes) but on wall clock time
1310	to trigger after some specific point in time. For example, if you tell a	1739	(absolute time, the thing you can read on your calender or clock). The
1311	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()	1740	difference is that wall clock time can run faster or slower than real
1312	+ 10.>, that is, an absolute time not a delay) and then reset your system	1741	time, and time jumps are not uncommon (e.g. when you adjust your
1313	clock to January of the previous year, then it will take more than year	1742	wrist-watch).
1314	to trigger the event (unlike an C<ev_timer>, which would still trigger
1315	roughly 10 seconds later as it uses a relative timeout).
1316		1743
		1744	You can tell a periodic watcher to trigger after some specific point
		1745	in time: for example, if you tell a periodic watcher to trigger "in 10
		1746	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1747	not a delay) and then reset your system clock to January of the previous
		1748	year, then it will take a year or more to trigger the event (unlike an
		1749	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1750	it, as it uses a relative timeout).
		1751
1317	C<ev_periodic>s can also be used to implement vastly more complex timers,	1752	C<ev_periodic> watchers can also be used to implement vastly more complex
1318	such as triggering an event on each "midnight, local time", or other	1753	timers, such as triggering an event on each "midnight, local time", or
1319	complicated, rules.	1754	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1755	those cannot react to time jumps.
1320		1756
1321	As with timers, the callback is guaranteed to be invoked only when the	1757	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	1758	point in time where it is supposed to trigger has passed. If multiple
1323	during the same loop iteration then order of execution is undefined.	1759	timers become ready during the same loop iteration then the ones with
		1760	earlier time-out values are invoked before ones with later time-out values
		1761	(but this is no longer true when a callback calls C<ev_loop> recursively).
1324		1762
1325	=head3 Watcher-Specific Functions and Data Members	1763	=head3 Watcher-Specific Functions and Data Members
1326		1764
1327	=over 4	1765	=over 4
1328		1766
1329	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1767	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1330		1768
1331	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1769	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1332		1770
1333	Lots of arguments, lets sort it out... There are basically three modes of	1771	Lots of arguments, let's sort it out... There are basically three modes of
1334	operation, and we will explain them from simplest to complex:	1772	operation, and we will explain them from simplest to most complex:
1335		1773
1336	=over 4	1774	=over 4
1337		1775
1338	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1776	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1339		1777
1340	In this configuration the watcher triggers an event after the wall clock	1778	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	1779	time C<offset> has passed. It will not repeat and will not adjust when a
1342	jump occurs, that is, if it is to be run at January 1st 2011 then it will	1780	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1343	run when the system time reaches or surpasses this time.	1781	will be stopped and invoked when the system clock reaches or surpasses
		1782	this point in time.
1344		1783
1345	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1784	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1346		1785
1347	In this mode the watcher will always be scheduled to time out at the next	1786	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)	1787	C<offset + N * interval> time (for some integer N, which can also be
1349	and then repeat, regardless of any time jumps.	1788	negative) and then repeat, regardless of any time jumps. The C<offset>
		1789	argument is merely an offset into the C<interval> periods.
1350		1790
1351	This can be used to create timers that do not drift with respect to system	1791	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	1792	system clock, for example, here is an C<ev_periodic> that triggers each
1353	the hour:	1793	hour, on the hour (with respect to UTC):
1354		1794
1355	ev_periodic_set (&periodic, 0., 3600., 0);	1795	ev_periodic_set (&periodic, 0., 3600., 0);
1356		1796
1357	This doesn't mean there will always be 3600 seconds in between triggers,	1797	This doesn't mean there will always be 3600 seconds in between triggers,
1358	but only that the callback will be called when the system time shows a	1798	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	1799	full hour (UTC), or more correctly, when the system time is evenly divisible
1360	by 3600.	1800	by 3600.
1361		1801
1362	Another way to think about it (for the mathematically inclined) is that	1802	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	1803	C<ev_periodic> will try to run the callback in this mode at the next possible
1364	time where C<time = at (mod interval)>, regardless of any time jumps.	1804	time where C<time = offset (mod interval)>, regardless of any time jumps.
1365		1805
1366	For numerical stability it is preferable that the C<at> value is near	1806	For numerical stability it is preferable that the C<offset> value is near
1367	C<ev_now ()> (the current time), but there is no range requirement for	1807	C<ev_now ()> (the current time), but there is no range requirement for
1368	this value, and in fact is often specified as zero.	1808	this value, and in fact is often specified as zero.
1369		1809
1370	Note also that there is an upper limit to how often a timer can fire (CPU	1810	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	1811	speed for example), so if C<interval> is very small then timing stability
1372	will of course deteriorate. Libev itself tries to be exact to be about one	1812	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).	1813	millisecond (if the OS supports it and the machine is fast enough).
1374		1814
1375	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1815	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1376		1816
1377	In this mode the values for C<interval> and C<at> are both being	1817	In this mode the values for C<interval> and C<offset> are both being
1378	ignored. Instead, each time the periodic watcher gets scheduled, the	1818	ignored. Instead, each time the periodic watcher gets scheduled, the
1379	reschedule callback will be called with the watcher as first, and the	1819	reschedule callback will be called with the watcher as first, and the
1380	current time as second argument.	1820	current time as second argument.
1381		1821
1382	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1822	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1383	ever, or make ANY event loop modifications whatsoever>.	1823	or make ANY other event loop modifications whatsoever, unless explicitly
		1824	allowed by documentation here>.
1384		1825
1385	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	1826	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	1827	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1387	only event loop modification you are allowed to do).	1828	only event loop modification you are allowed to do).
1388		1829
1389	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic	1830	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1390	*w, ev_tstamp now)>, e.g.:	1831	*w, ev_tstamp now)>, e.g.:
1391		1832
		1833	static ev_tstamp
1392	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1834	my_rescheduler (ev_periodic *w, ev_tstamp now)
1393	{	1835	{
1394	return now + 60.;	1836	return now + 60.;
1395	}	1837	}
1396		1838
1397	It must return the next time to trigger, based on the passed time value	1839	It must return the next time to trigger, based on the passed time value
…		…
1417	a different time than the last time it was called (e.g. in a crond like	1859	a different time than the last time it was called (e.g. in a crond like
1418	program when the crontabs have changed).	1860	program when the crontabs have changed).
1419		1861
1420	=item ev_tstamp ev_periodic_at (ev_periodic *)	1862	=item ev_tstamp ev_periodic_at (ev_periodic *)
1421		1863
1422	When active, returns the absolute time that the watcher is supposed to	1864	When active, returns the absolute time that the watcher is supposed
1423	trigger next.	1865	to trigger next. This is not the same as the C<offset> argument to
		1866	C<ev_periodic_set>, but indeed works even in interval and manual
		1867	rescheduling modes.
1424		1868
1425	=item ev_tstamp offset [read-write]	1869	=item ev_tstamp offset [read-write]
1426		1870
1427	When repeating, this contains the offset value, otherwise this is the	1871	When repeating, this contains the offset value, otherwise this is the
1428	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1872	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1873	although libev might modify this value for better numerical stability).
1429		1874
1430	Can be modified any time, but changes only take effect when the periodic	1875	Can be modified any time, but changes only take effect when the periodic
1431	timer fires or C<ev_periodic_again> is being called.	1876	timer fires or C<ev_periodic_again> is being called.
1432		1877
1433	=item ev_tstamp interval [read-write]	1878	=item ev_tstamp interval [read-write]
1434		1879
1435	The current interval value. Can be modified any time, but changes only	1880	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	1881	take effect when the periodic timer fires or C<ev_periodic_again> is being
1437	called.	1882	called.
1438		1883
1439	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1884	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1440		1885
1441	The current reschedule callback, or C<0>, if this functionality is	1886	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	1887	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.	1888	the periodic timer fires or C<ev_periodic_again> is being called.
1444		1889
1445	=back	1890	=back
1446		1891
1447	=head3 Examples	1892	=head3 Examples
1448		1893
1449	Example: Call a callback every hour, or, more precisely, whenever the	1894	Example: Call a callback every hour, or, more precisely, whenever the
1450	system clock is divisible by 3600. The callback invocation times have	1895	system time is divisible by 3600. The callback invocation times have
1451	potentially a lot of jitter, but good long-term stability.	1896	potentially a lot of jitter, but good long-term stability.
1452		1897
1453	static void	1898	static void
1454	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1899	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1455	{	1900	{
1456	... its now a full hour (UTC, or TAI or whatever your clock follows)	1901	... its now a full hour (UTC, or TAI or whatever your clock follows)
1457	}	1902	}
1458		1903
1459	struct ev_periodic hourly_tick;	1904	ev_periodic hourly_tick;
1460	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1905	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1461	ev_periodic_start (loop, &hourly_tick);	1906	ev_periodic_start (loop, &hourly_tick);
1462		1907
1463	Example: The same as above, but use a reschedule callback to do it:	1908	Example: The same as above, but use a reschedule callback to do it:
1464		1909
1465	#include <math.h>	1910	#include <math.h>
1466		1911
1467	static ev_tstamp	1912	static ev_tstamp
1468	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1913	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1469	{	1914	{
1470	return fmod (now, 3600.) + 3600.;	1915	return now + (3600. - fmod (now, 3600.));
1471	}	1916	}
1472		1917
1473	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1918	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1474		1919
1475	Example: Call a callback every hour, starting now:	1920	Example: Call a callback every hour, starting now:
1476		1921
1477	struct ev_periodic hourly_tick;	1922	ev_periodic hourly_tick;
1478	ev_periodic_init (&hourly_tick, clock_cb,	1923	ev_periodic_init (&hourly_tick, clock_cb,
1479	fmod (ev_now (loop), 3600.), 3600., 0);	1924	fmod (ev_now (loop), 3600.), 3600., 0);
1480	ev_periodic_start (loop, &hourly_tick);	1925	ev_periodic_start (loop, &hourly_tick);
1481		1926
1482		1927
1483	=head2 C<ev_signal> - signal me when a signal gets signalled!	1928	=head2 C<ev_signal> - signal me when a signal gets signalled!
1484		1929
1485	Signal watchers will trigger an event when the process receives a specific	1930	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	1931	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	1932	will try it's best to deliver signals synchronously, i.e. as part of the
1488	normal event processing, like any other event.	1933	normal event processing, like any other event.
1489		1934
		1935	If you want signals asynchronously, just use C<sigaction> as you would
		1936	do without libev and forget about sharing the signal. You can even use
		1937	C<ev_async> from a signal handler to synchronously wake up an event loop.
		1938
1490	You can configure as many watchers as you like per signal. Only when the	1939	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	1940	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	1941	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	1942	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	1943	the last signal watcher for a signal is stopped, libev will reset the
1495	SIG_DFL (regardless of what it was set to before).	1944	signal handler to SIG_DFL (regardless of what it was set to before).
1496		1945
1497	If possible and supported, libev will install its handlers with	1946	If possible and supported, libev will install its handlers with
1498	C<SA_RESTART> behaviour enabled, so system calls should not be unduly	1947	C<SA_RESTART> behaviour enabled, so system calls should not be unduly
1499	interrupted. If you have a problem with system calls getting interrupted by	1948	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	1949	signals you can block all signals in an C<ev_check> watcher and unblock
…		…
1517		1966
1518	=back	1967	=back
1519		1968
1520	=head3 Examples	1969	=head3 Examples
1521		1970
1522	Example: Try to exit cleanly on SIGINT and SIGTERM.	1971	Example: Try to exit cleanly on SIGINT.
1523		1972
1524	static void	1973	static void
1525	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1974	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1526	{	1975	{
1527	ev_unloop (loop, EVUNLOOP_ALL);	1976	ev_unloop (loop, EVUNLOOP_ALL);
1528	}	1977	}
1529		1978
1530	struct ev_signal signal_watcher;	1979	ev_signal signal_watcher;
1531	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1980	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1532	ev_signal_start (loop, &sigint_cb);	1981	ev_signal_start (loop, &signal_watcher);
1533		1982
1534		1983
1535	=head2 C<ev_child> - watch out for process status changes	1984	=head2 C<ev_child> - watch out for process status changes
1536		1985
1537	Child watchers trigger when your process receives a SIGCHLD in response to	1986	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	1987	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	1988	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	1989	has been forked (which implies it might have already exited), as long
1541	loop isn't entered (or is continued from a watcher).	1990	as the event loop isn't entered (or is continued from a watcher), i.e.,
		1991	forking and then immediately registering a watcher for the child is fine,
		1992	but forking and registering a watcher a few event loop iterations later is
		1993	not.
1542		1994
1543	Only the default event loop is capable of handling signals, and therefore	1995	Only the default event loop is capable of handling signals, and therefore
1544	you can only register child watchers in the default event loop.	1996	you can only register child watchers in the default event loop.
1545		1997
1546	=head3 Process Interaction	1998	=head3 Process Interaction
…		…
1559	handler, you can override it easily by installing your own handler for	2011	handler, you can override it easily by installing your own handler for
1560	C<SIGCHLD> after initialising the default loop, and making sure the	2012	C<SIGCHLD> after initialising the default loop, and making sure the
1561	default loop never gets destroyed. You are encouraged, however, to use an	2013	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	2014	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.	2015	that, so other libev users can use C<ev_child> watchers freely.
		2016
		2017	=head3 Stopping the Child Watcher
		2018
		2019	Currently, the child watcher never gets stopped, even when the
		2020	child terminates, so normally one needs to stop the watcher in the
		2021	callback. Future versions of libev might stop the watcher automatically
		2022	when a child exit is detected.
1564		2023
1565	=head3 Watcher-Specific Functions and Data Members	2024	=head3 Watcher-Specific Functions and Data Members
1566		2025
1567	=over 4	2026	=over 4
1568		2027
…		…
1597	=head3 Examples	2056	=head3 Examples
1598		2057
1599	Example: C<fork()> a new process and install a child handler to wait for	2058	Example: C<fork()> a new process and install a child handler to wait for
1600	its completion.	2059	its completion.
1601		2060
1602	ev_child cw;	2061	ev_child cw;
1603		2062
1604	static void	2063	static void
1605	child_cb (EV_P_ struct ev_child *w, int revents)	2064	child_cb (EV_P_ ev_child *w, int revents)
1606	{	2065	{
1607	ev_child_stop (EV_A_ w);	2066	ev_child_stop (EV_A_ w);
1608	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	2067	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1609	}	2068	}
1610		2069
1611	pid_t pid = fork ();	2070	pid_t pid = fork ();
1612		2071
1613	if (pid < 0)	2072	if (pid < 0)
1614	// error	2073	// error
1615	else if (pid == 0)	2074	else if (pid == 0)
1616	{	2075	{
1617	// the forked child executes here	2076	// the forked child executes here
1618	exit (1);	2077	exit (1);
1619	}	2078	}
1620	else	2079	else
1621	{	2080	{
1622	ev_child_init (&cw, child_cb, pid, 0);	2081	ev_child_init (&cw, child_cb, pid, 0);
1623	ev_child_start (EV_DEFAULT_ &cw);	2082	ev_child_start (EV_DEFAULT_ &cw);
1624	}	2083	}
1625		2084
1626		2085
1627	=head2 C<ev_stat> - did the file attributes just change?	2086	=head2 C<ev_stat> - did the file attributes just change?
1628		2087
1629	This watches a file system path for attribute changes. That is, it calls	2088	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	2089	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.	2090	and sees if it changed compared to the last time, invoking the callback if
		2091	it did.
1632		2092
1633	The path does not need to exist: changing from "path exists" to "path does	2093	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	2094	not exist" is a status change like any other. The condition "path does not
1635	not exist" is signified by the C<st_nlink> field being zero (which is	2095	exist" (or more correctly "path cannot be stat'ed") is signified by the
1636	otherwise always forced to be at least one) and all the other fields of	2096	C<st_nlink> field being zero (which is otherwise always forced to be at
1637	the stat buffer having unspecified contents.	2097	least one) and all the other fields of the stat buffer having unspecified
		2098	contents.
1638		2099
1639	The path I<should> be absolute and I<must not> end in a slash. If it is	2100	The path I<must not> end in a slash or contain special components such as
		2101	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.	2102	your working directory changes, then the behaviour is undefined.
1641		2103
1642	Since there is no standard to do this, the portable implementation simply	2104	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	2105	portable implementation simply calls C<stat(2)> regularly on the path
1644	can specify a recommended polling interval for this case. If you specify	2106	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,	2107	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	2108	recommended!) then a I<suitable, unspecified default> value will be used
1647	five seconds, although this might change dynamically). Libev will also	2109	(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	2110	change dynamically). Libev will also impose a minimum interval which is
1649	usually overkill.	2111	currently around C<0.1>, but that's usually overkill.
1650		2112
1651	This watcher type is not meant for massive numbers of stat watchers,	2113	This watcher type is not meant for massive numbers of stat watchers,
1652	as even with OS-supported change notifications, this can be	2114	as even with OS-supported change notifications, this can be
1653	resource-intensive.	2115	resource-intensive.
1654		2116
1655	At the time of this writing, only the Linux inotify interface is	2117	At the time of this writing, the only OS-specific interface implemented
1656	implemented (implementing kqueue support is left as an exercise for the	2118	is the Linux inotify interface (implementing kqueue support is left as an
1657	reader, note, however, that the author sees no way of implementing ev_stat	2119	exercise for the reader. Note, however, that the author sees no way of
1658	semantics with kqueue). Inotify will be used to give hints only and should	2120	implementing C<ev_stat> semantics with kqueue, except as a hint).
1659	not change the semantics of C<ev_stat> watchers, which means that libev
1660	sometimes needs to fall back to regular polling again even with inotify,
1661	but changes are usually detected immediately, and if the file exists there
1662	will be no polling.
1663		2121
1664	=head3 ABI Issues (Largefile Support)	2122	=head3 ABI Issues (Largefile Support)
1665		2123
1666	Libev by default (unless the user overrides this) uses the default	2124	Libev by default (unless the user overrides this) uses the default
1667	compilation environment, which means that on systems with optionally	2125	compilation environment, which means that on systems with large file
1668	disabled large file support, you get the 32 bit version of the stat	2126	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	2127	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	2128	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	2129	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	2130	obviously the case with any flags that change the ABI, but the problem is
1673	most noticeably with ev_stat and large file support.	2131	most noticeably displayed with ev_stat and large file support.
1674		2132
1675	=head3 Inotify	2133	The solution for this is to lobby your distribution maker to make large
		2134	file interfaces available by default (as e.g. FreeBSD does) and not
		2135	optional. Libev cannot simply switch on large file support because it has
		2136	to exchange stat structures with application programs compiled using the
		2137	default compilation environment.
1676		2138
		2139	=head3 Inotify and Kqueue
		2140
1677	When C<inotify (7)> support has been compiled into libev (generally only	2141	When C<inotify (7)> support has been compiled into libev and present at
1678	available on Linux) and present at runtime, it will be used to speed up	2142	runtime, it will be used to speed up change detection where possible. The
1679	change detection where possible. The inotify descriptor will be created lazily	2143	inotify descriptor will be created lazily when the first C<ev_stat>
1680	when the first C<ev_stat> watcher is being started.	2144	watcher is being started.
1681		2145
1682	Inotify presence does not change the semantics of C<ev_stat> watchers	2146	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	2147	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	2148	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.	2149	there are many cases where libev has to resort to regular C<stat> polling,
		2150	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2151	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2152	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2153	xfs are fully working) libev usually gets away without polling.
1686		2154
1687	(There is no support for kqueue, as apparently it cannot be used to	2155	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	2156	implement this functionality, due to the requirement of having a file
1689	descriptor open on the object at all times).	2157	descriptor open on the object at all times, and detecting renames, unlinks
		2158	etc. is difficult.
		2159
		2160	=head3 C<stat ()> is a synchronous operation
		2161
		2162	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2163	the process. The exception are C<ev_stat> watchers - those call C<stat
		2164	()>, which is a synchronous operation.
		2165
		2166	For local paths, this usually doesn't matter: unless the system is very
		2167	busy or the intervals between stat's are large, a stat call will be fast,
		2168	as the path data is usually in memory already (except when starting the
		2169	watcher).
		2170
		2171	For networked file systems, calling C<stat ()> can block an indefinite
		2172	time due to network issues, and even under good conditions, a stat call
		2173	often takes multiple milliseconds.
		2174
		2175	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2176	paths, although this is fully supported by libev.
1690		2177
1691	=head3 The special problem of stat time resolution	2178	=head3 The special problem of stat time resolution
1692		2179
1693	The C<stat ()> system call only supports full-second resolution portably, and	2180	The C<stat ()> system call only supports full-second resolution portably,
1694	even on systems where the resolution is higher, many file systems still	2181	and even on systems where the resolution is higher, most file systems
1695	only support whole seconds.	2182	still only support whole seconds.
1696		2183
1697	That means that, if the time is the only thing that changes, you can	2184	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	2185	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	2186	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	2187	within the same second, C<ev_stat> will be unable to detect unless the
1701	data does not change.	2188	stat data does change in other ways (e.g. file size).
1702		2189
1703	The solution to this is to delay acting on a change for slightly more	2190	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	2191	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);	2192	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1706	ev_timer_again (loop, w)>).	2193	ev_timer_again (loop, w)>).
…		…
1726	C<path>. The C<interval> is a hint on how quickly a change is expected to	2213	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	2214	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	2215	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.	2216	path for as long as the watcher is active.
1730		2217
1731	The callback will receive C<EV_STAT> when a change was detected, relative	2218	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	2219	relative to the attributes at the time the watcher was started (or the
1733	was detected).	2220	last change was detected).
1734		2221
1735	=item ev_stat_stat (loop, ev_stat *)	2222	=item ev_stat_stat (loop, ev_stat *)
1736		2223
1737	Updates the stat buffer immediately with new values. If you change the	2224	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	2225	watched path in your callback, you could call this function to avoid
…		…
1767		2254
1768	=head3 Examples	2255	=head3 Examples
1769		2256
1770	Example: Watch C</etc/passwd> for attribute changes.	2257	Example: Watch C</etc/passwd> for attribute changes.
1771		2258
1772	static void	2259	static void
1773	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)	2260	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
1774	{	2261	{
1775	/* /etc/passwd changed in some way */	2262	/* /etc/passwd changed in some way */
1776	if (w->attr.st_nlink)	2263	if (w->attr.st_nlink)
1777	{	2264	{
1778	printf ("passwd current size %ld\n", (long)w->attr.st_size);	2265	printf ("passwd current size %ld\n", (long)w->attr.st_size);
1779	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);	2266	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
1780	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);	2267	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
1781	}	2268	}
1782	else	2269	else
1783	/* you shalt not abuse printf for puts */	2270	/* you shalt not abuse printf for puts */
1784	puts ("wow, /etc/passwd is not there, expect problems. "	2271	puts ("wow, /etc/passwd is not there, expect problems. "
1785	"if this is windows, they already arrived\n");	2272	"if this is windows, they already arrived\n");
1786	}	2273	}
1787		2274
1788	...	2275	...
1789	ev_stat passwd;	2276	ev_stat passwd;
1790		2277
1791	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);	2278	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1792	ev_stat_start (loop, &passwd);	2279	ev_stat_start (loop, &passwd);
1793		2280
1794	Example: Like above, but additionally use a one-second delay so we do not	2281	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	2282	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	2283	one might do the work both on C<ev_stat> callback invocation I<and> on
1797	C<ev_timer> callback invocation).	2284	C<ev_timer> callback invocation).
1798		2285
1799	static ev_stat passwd;	2286	static ev_stat passwd;
1800	static ev_timer timer;	2287	static ev_timer timer;
1801		2288
1802	static void	2289	static void
1803	timer_cb (EV_P_ ev_timer *w, int revents)	2290	timer_cb (EV_P_ ev_timer *w, int revents)
1804	{	2291	{
1805	ev_timer_stop (EV_A_ w);	2292	ev_timer_stop (EV_A_ w);
1806		2293
1807	/* now it's one second after the most recent passwd change */	2294	/* now it's one second after the most recent passwd change */
1808	}	2295	}
1809		2296
1810	static void	2297	static void
1811	stat_cb (EV_P_ ev_stat *w, int revents)	2298	stat_cb (EV_P_ ev_stat *w, int revents)
1812	{	2299	{
1813	/* reset the one-second timer */	2300	/* reset the one-second timer */
1814	ev_timer_again (EV_A_ &timer);	2301	ev_timer_again (EV_A_ &timer);
1815	}	2302	}
1816		2303
1817	...	2304	...
1818	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	2305	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1819	ev_stat_start (loop, &passwd);	2306	ev_stat_start (loop, &passwd);
1820	ev_timer_init (&timer, timer_cb, 0., 1.02);	2307	ev_timer_init (&timer, timer_cb, 0., 1.02);
1821		2308
1822		2309
1823	=head2 C<ev_idle> - when you've got nothing better to do...	2310	=head2 C<ev_idle> - when you've got nothing better to do...
1824		2311
1825	Idle watchers trigger events when no other events of the same or higher	2312	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	2313	priority are pending (prepare, check and other idle watchers do not count
1827	count).	2314	as receiving "events").
1828		2315
1829	That is, as long as your process is busy handling sockets or timeouts	2316	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	2317	(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	2318	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	2319	are pending), the idle watchers are being called once per event loop
…		…
1843		2330
1844	=head3 Watcher-Specific Functions and Data Members	2331	=head3 Watcher-Specific Functions and Data Members
1845		2332
1846	=over 4	2333	=over 4
1847		2334
1848	=item ev_idle_init (ev_signal *, callback)	2335	=item ev_idle_init (ev_idle *, callback)
1849		2336
1850	Initialises and configures the idle watcher - it has no parameters of any	2337	Initialises and configures the idle watcher - it has no parameters of any
1851	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2338	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1852	believe me.	2339	believe me.
1853		2340
…		…
1856	=head3 Examples	2343	=head3 Examples
1857		2344
1858	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2345	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1859	callback, free it. Also, use no error checking, as usual.	2346	callback, free it. Also, use no error checking, as usual.
1860		2347
1861	static void	2348	static void
1862	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2349	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1863	{	2350	{
1864	free (w);	2351	free (w);
1865	// now do something you wanted to do when the program has	2352	// now do something you wanted to do when the program has
1866	// no longer anything immediate to do.	2353	// no longer anything immediate to do.
1867	}	2354	}
1868		2355
1869	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2356	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1870	ev_idle_init (idle_watcher, idle_cb);	2357	ev_idle_init (idle_watcher, idle_cb);
1871	ev_idle_start (loop, idle_cb);	2358	ev_idle_start (loop, idle_cb);
1872		2359
1873		2360
1874	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2361	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1875		2362
1876	Prepare and check watchers are usually (but not always) used in tandem:	2363	Prepare and check watchers are usually (but not always) used in pairs:
1877	prepare watchers get invoked before the process blocks and check watchers	2364	prepare watchers get invoked before the process blocks and check watchers
1878	afterwards.	2365	afterwards.
1879		2366
1880	You I<must not> call C<ev_loop> or similar functions that enter	2367	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>	2368	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,	2371	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	2372	C<ev_check> so if you have one watcher of each kind they will always be
1886	called in pairs bracketing the blocking call.	2373	called in pairs bracketing the blocking call.
1887		2374
1888	Their main purpose is to integrate other event mechanisms into libev and	2375	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	2376	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	2377	variable changes, implement your own watchers, integrate net-snmp or a
1891	coroutine library and lots more. They are also occasionally useful if	2378	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,	2379	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>	2380	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
1894	watcher).	2381	watcher).
1895		2382
1896	This is done by examining in each prepare call which file descriptors need	2383	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	2384	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	2385	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	2386	libraries provide exactly this functionality). Then, in the check watcher,
1900	any events that occurred (by checking the pending status of all watchers	2387	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	2388	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,	2389	I/O and timer callbacks will never actually be called (but must be valid
1903	because you never know, you know?).	2390	nevertheless, because you never know, you know?).
1904		2391
1905	As another example, the Perl Coro module uses these hooks to integrate	2392	As another example, the Perl Coro module uses these hooks to integrate
1906	coroutines into libev programs, by yielding to other active coroutines	2393	coroutines into libev programs, by yielding to other active coroutines
1907	during each prepare and only letting the process block if no coroutines	2394	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	2395	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	2398	loop from blocking if lower-priority coroutines are active, thus mapping
1912	low-priority coroutines to idle/background tasks).	2399	low-priority coroutines to idle/background tasks).
1913		2400
1914	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	2401	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	2402	priority, to ensure that they are being run before any other watchers
		2403	after the poll (this doesn't matter for C<ev_prepare> watchers).
		2404
1916	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	2405	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	2406	activate ("feed") events into libev. While libev fully supports this, they
1918	supports this, they might get executed before other C<ev_check> watchers	2407	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	2408	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	2409	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	2410	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
1922	coexist peacefully with others).	2411	others).
1923		2412
1924	=head3 Watcher-Specific Functions and Data Members	2413	=head3 Watcher-Specific Functions and Data Members
1925		2414
1926	=over 4	2415	=over 4
1927		2416
…		…
1929		2418
1930	=item ev_check_init (ev_check *, callback)	2419	=item ev_check_init (ev_check *, callback)
1931		2420
1932	Initialises and configures the prepare or check watcher - they have no	2421	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>	2422	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.	2423	macros, but using them is utterly, utterly, utterly and completely
		2424	pointless.
1935		2425
1936	=back	2426	=back
1937		2427
1938	=head3 Examples	2428	=head3 Examples
1939		2429
…		…
1948	and in a check watcher, destroy them and call into libadns. What follows	2438	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	2439	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	2440	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.	2441	the callbacks for the IO/timeout watchers might not have been called yet.
1952		2442
1953	static ev_io iow [nfd];	2443	static ev_io iow [nfd];
1954	static ev_timer tw;	2444	static ev_timer tw;
1955		2445
1956	static void	2446	static void
1957	io_cb (ev_loop *loop, ev_io *w, int revents)	2447	io_cb (struct ev_loop *loop, ev_io *w, int revents)
1958	{	2448	{
1959	}	2449	}
1960		2450
1961	// create io watchers for each fd and a timer before blocking	2451	// create io watchers for each fd and a timer before blocking
1962	static void	2452	static void
1963	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2453	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
1964	{	2454	{
1965	int timeout = 3600000;	2455	int timeout = 3600000;
1966	struct pollfd fds [nfd];	2456	struct pollfd fds [nfd];
1967	// actual code will need to loop here and realloc etc.	2457	// actual code will need to loop here and realloc etc.
1968	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2458	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1969		2459
1970	/* the callback is illegal, but won't be called as we stop during check */	2460	/* the callback is illegal, but won't be called as we stop during check */
1971	ev_timer_init (&tw, 0, timeout * 1e-3);	2461	ev_timer_init (&tw, 0, timeout * 1e-3);
1972	ev_timer_start (loop, &tw);	2462	ev_timer_start (loop, &tw);
1973		2463
1974	// create one ev_io per pollfd	2464	// create one ev_io per pollfd
1975	for (int i = 0; i < nfd; ++i)	2465	for (int i = 0; i < nfd; ++i)
1976	{	2466	{
1977	ev_io_init (iow + i, io_cb, fds [i].fd,	2467	ev_io_init (iow + i, io_cb, fds [i].fd,
1978	((fds [i].events & POLLIN ? EV_READ : 0)	2468	((fds [i].events & POLLIN ? EV_READ : 0)
1979	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	2469	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1980		2470
1981	fds [i].revents = 0;	2471	fds [i].revents = 0;
1982	ev_io_start (loop, iow + i);	2472	ev_io_start (loop, iow + i);
1983	}	2473	}
1984	}	2474	}
1985		2475
1986	// stop all watchers after blocking	2476	// stop all watchers after blocking
1987	static void	2477	static void
1988	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2478	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
1989	{	2479	{
1990	ev_timer_stop (loop, &tw);	2480	ev_timer_stop (loop, &tw);
1991		2481
1992	for (int i = 0; i < nfd; ++i)	2482	for (int i = 0; i < nfd; ++i)
1993	{	2483	{
1994	// set the relevant poll flags	2484	// set the relevant poll flags
1995	// could also call adns_processreadable etc. here	2485	// could also call adns_processreadable etc. here
1996	struct pollfd *fd = fds + i;	2486	struct pollfd *fd = fds + i;
1997	int revents = ev_clear_pending (iow + i);	2487	int revents = ev_clear_pending (iow + i);
1998	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;	2488	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1999	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;	2489	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
2000		2490
2001	// now stop the watcher	2491	// now stop the watcher
2002	ev_io_stop (loop, iow + i);	2492	ev_io_stop (loop, iow + i);
2003	}	2493	}
2004		2494
2005	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	2495	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
2006	}	2496	}
2007		2497
2008	Method 2: This would be just like method 1, but you run C<adns_afterpoll>	2498	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.	2499	in the prepare watcher and would dispose of the check watcher.
2010		2500
2011	Method 3: If the module to be embedded supports explicit event	2501	Method 3: If the module to be embedded supports explicit event
2012	notification (libadns does), you can also make use of the actual watcher	2502	notification (libadns does), you can also make use of the actual watcher
2013	callbacks, and only destroy/create the watchers in the prepare watcher.	2503	callbacks, and only destroy/create the watchers in the prepare watcher.
2014		2504
2015	static void	2505	static void
2016	timer_cb (EV_P_ ev_timer *w, int revents)	2506	timer_cb (EV_P_ ev_timer *w, int revents)
2017	{	2507	{
2018	adns_state ads = (adns_state)w->data;	2508	adns_state ads = (adns_state)w->data;
2019	update_now (EV_A);	2509	update_now (EV_A);
2020		2510
2021	adns_processtimeouts (ads, &tv_now);	2511	adns_processtimeouts (ads, &tv_now);
2022	}	2512	}
2023		2513
2024	static void	2514	static void
2025	io_cb (EV_P_ ev_io *w, int revents)	2515	io_cb (EV_P_ ev_io *w, int revents)
2026	{	2516	{
2027	adns_state ads = (adns_state)w->data;	2517	adns_state ads = (adns_state)w->data;
2028	update_now (EV_A);	2518	update_now (EV_A);
2029		2519
2030	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);	2520	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
2031	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);	2521	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
2032	}	2522	}
2033		2523
2034	// do not ever call adns_afterpoll	2524	// do not ever call adns_afterpoll
2035		2525
2036	Method 4: Do not use a prepare or check watcher because the module you	2526	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, you can override	2527	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	2528	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	2529	main loop is now no longer controllable by EV. The C<Glib::EV> module uses
2040	this.	2530	this approach, effectively embedding EV as a client into the horrible
		2531	libglib event loop.
2041		2532
2042	static gint	2533	static gint
2043	event_poll_func (GPollFD *fds, guint nfds, gint timeout)	2534	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
2044	{	2535	{
2045	int got_events = 0;	2536	int got_events = 0;
2046		2537
2047	for (n = 0; n < nfds; ++n)	2538	for (n = 0; n < nfds; ++n)
2048	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events	2539	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
2049		2540
2050	if (timeout >= 0)	2541	if (timeout >= 0)
2051	// create/start timer	2542	// create/start timer
2052		2543
2053	// poll	2544	// poll
2054	ev_loop (EV_A_ 0);	2545	ev_loop (EV_A_ 0);
2055		2546
2056	// stop timer again	2547	// stop timer again
2057	if (timeout >= 0)	2548	if (timeout >= 0)
2058	ev_timer_stop (EV_A_ &to);	2549	ev_timer_stop (EV_A_ &to);
2059		2550
2060	// stop io watchers again - their callbacks should have set	2551	// stop io watchers again - their callbacks should have set
2061	for (n = 0; n < nfds; ++n)	2552	for (n = 0; n < nfds; ++n)
2062	ev_io_stop (EV_A_ iow [n]);	2553	ev_io_stop (EV_A_ iow [n]);
2063		2554
2064	return got_events;	2555	return got_events;
2065	}	2556	}
2066		2557
2067		2558
2068	=head2 C<ev_embed> - when one backend isn't enough...	2559	=head2 C<ev_embed> - when one backend isn't enough...
2069		2560
2070	This is a rather advanced watcher type that lets you embed one event loop	2561	This is a rather advanced watcher type that lets you embed one event loop
…		…
2076	prioritise I/O.	2567	prioritise I/O.
2077		2568
2078	As an example for a bug workaround, the kqueue backend might only support	2569	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	2570	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	2571	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	2572	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	2573	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	2574	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.	2575	C<kevent>, but at least you can use both mechanisms for what they are
		2576	best: C<kqueue> for scalable sockets and C<poll> if you want it to work :)
2085		2577
2086	As for prioritising I/O: rarely you have the case where some fds have	2578	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	2579	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	2580	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	2581	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.	2582	the rest in a second one, and embed the second one in the first.
2091		2583
2092	As long as the watcher is active, the callback will be invoked every time	2584	As long as the watcher is active, the callback will be invoked every
2093	there might be events pending in the embedded loop. The callback must then	2585	time there might be events pending in the embedded loop. The callback
2094	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2586	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2095	their callbacks (you could also start an idle watcher to give the embedded	2587	sweep and invoke their callbacks (the callback doesn't need to invoke the
2096	loop strictly lower priority for example). You can also set the callback	2588	C<ev_embed_sweep> function directly, it could also start an idle watcher
2097	to C<0>, in which case the embed watcher will automatically execute the	2589	to give the embedded loop strictly lower priority for example).
2098	embedded loop sweep.
2099		2590
2100	As long as the watcher is started it will automatically handle events. The	2591	You can also set the callback to C<0>, in which case the embed watcher
2101	callback will be invoked whenever some events have been handled. You can	2592	will automatically execute the embedded loop sweep whenever necessary.
2102	set the callback to C<0> to avoid having to specify one if you are not
2103	interested in that.
2104		2593
2105	Also, there have not currently been made special provisions for forking:	2594	Fork detection will be handled transparently while the C<ev_embed> watcher
2106	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2595	is active, i.e., the embedded loop will automatically be forked when the
2107	but you will also have to stop and restart any C<ev_embed> watchers	2596	embedding loop forks. In other cases, the user is responsible for calling
2108	yourself.	2597	C<ev_loop_fork> on the embedded loop.
2109		2598
2110	Unfortunately, not all backends are embeddable, only the ones returned by	2599	Unfortunately, not all backends are embeddable: only the ones returned by
2111	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2600	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2112	portable one.	2601	portable one.
2113		2602
2114	So when you want to use this feature you will always have to be prepared	2603	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	2604	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	2605	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.	2606	create it, and if that fails, use the normal loop for everything.
		2607
		2608	=head3 C<ev_embed> and fork
		2609
		2610	While the C<ev_embed> watcher is running, forks in the embedding loop will
		2611	automatically be applied to the embedded loop as well, so no special
		2612	fork handling is required in that case. When the watcher is not running,
		2613	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		2614	as applicable.
2118		2615
2119	=head3 Watcher-Specific Functions and Data Members	2616	=head3 Watcher-Specific Functions and Data Members
2120		2617
2121	=over 4	2618	=over 4
2122		2619
…		…
2148	event loop. If that is not possible, use the default loop. The default	2645	event loop. If that is not possible, use the default loop. The default
2149	loop is stored in C<loop_hi>, while the embeddable loop is stored in	2646	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 case no embeddable loop can be	2647	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2151	used).	2648	used).
2152		2649
2153	struct ev_loop *loop_hi = ev_default_init (0);	2650	struct ev_loop *loop_hi = ev_default_init (0);
2154	struct ev_loop *loop_lo = 0;	2651	struct ev_loop *loop_lo = 0;
2155	struct ev_embed embed;	2652	ev_embed embed;
2156		2653
2157	// see if there is a chance of getting one that works	2654	// see if there is a chance of getting one that works
2158	// (remember that a flags value of 0 means autodetection)	2655	// (remember that a flags value of 0 means autodetection)
2159	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2656	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2160	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2657	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
2161	: 0;	2658	: 0;
2162		2659
2163	// if we got one, then embed it, otherwise default to loop_hi	2660	// if we got one, then embed it, otherwise default to loop_hi
2164	if (loop_lo)	2661	if (loop_lo)
2165	{	2662	{
2166	ev_embed_init (&embed, 0, loop_lo);	2663	ev_embed_init (&embed, 0, loop_lo);
2167	ev_embed_start (loop_hi, &embed);	2664	ev_embed_start (loop_hi, &embed);
2168	}	2665	}
2169	else	2666	else
2170	loop_lo = loop_hi;	2667	loop_lo = loop_hi;
2171		2668
2172	Example: Check if kqueue is available but not recommended and create	2669	Example: Check if kqueue is available but not recommended and create
2173	a kqueue backend for use with sockets (which usually work with any	2670	a kqueue backend for use with sockets (which usually work with any
2174	kqueue implementation). Store the kqueue/socket-only event loop in	2671	kqueue implementation). Store the kqueue/socket-only event loop in
2175	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2672	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2176		2673
2177	struct ev_loop *loop = ev_default_init (0);	2674	struct ev_loop *loop = ev_default_init (0);
2178	struct ev_loop *loop_socket = 0;	2675	struct ev_loop *loop_socket = 0;
2179	struct ev_embed embed;	2676	ev_embed embed;
2180		2677
2181	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2678	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2182	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2679	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2183	{	2680	{
2184	ev_embed_init (&embed, 0, loop_socket);	2681	ev_embed_init (&embed, 0, loop_socket);
2185	ev_embed_start (loop, &embed);	2682	ev_embed_start (loop, &embed);
2186	}	2683	}
2187		2684
2188	if (!loop_socket)	2685	if (!loop_socket)
2189	loop_socket = loop;	2686	loop_socket = loop;
2190		2687
2191	// now use loop_socket for all sockets, and loop for everything else	2688	// now use loop_socket for all sockets, and loop for everything else
2192		2689
2193		2690
2194	=head2 C<ev_fork> - the audacity to resume the event loop after a fork	2691	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
2195		2692
2196	Fork watchers are called when a C<fork ()> was detected (usually because	2693	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	2737	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	2738	multiple-writer-single-reader queue that works in all cases and doesn't
2242	need elaborate support such as pthreads.	2739	need elaborate support such as pthreads.
2243		2740
2244	That means that if you want to queue data, you have to provide your own	2741	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	2742	queue. But at least I can tell you how to implement locking around your
2246	queue:	2743	queue:
2247		2744
2248	=over 4	2745	=over 4
2249		2746
2250	=item queueing from a signal handler context	2747	=item queueing from a signal handler context
2251		2748
2252	To implement race-free queueing, you simply add to the queue in the signal	2749	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	2750	handler but you block the signal handler in the watcher callback. Here is
2254	some fictitious SIGUSR1 handler:	2751	an example that does that for some fictitious SIGUSR1 handler:
2255		2752
2256	static ev_async mysig;	2753	static ev_async mysig;
2257		2754
2258	static void	2755	static void
2259	sigusr1_handler (void)	2756	sigusr1_handler (void)
…		…
2325	=over 4	2822	=over 4
2326		2823
2327	=item ev_async_init (ev_async *, callback)	2824	=item ev_async_init (ev_async *, callback)
2328		2825
2329	Initialises and configures the async watcher - it has no parameters of any	2826	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,	2827	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2331	believe me.	2828	trust me.
2332		2829
2333	=item ev_async_send (loop, ev_async *)	2830	=item ev_async_send (loop, ev_async *)
2334		2831
2335	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2832	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	2833	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	2834	C<ev_feed_event>, this call is safe to do from other threads, signal or
2338	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	2835	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2339	section below on what exactly this means).	2836	section below on what exactly this means).
2340		2837
		2838	Note that, as with other watchers in libev, multiple events might get
		2839	compressed into a single callback invocation (another way to look at this
		2840	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2841	reset when the event loop detects that).
		2842
2341	This call incurs the overhead of a system call only once per loop iteration,	2843	This call incurs the overhead of a system call only once per event loop
2342	so while the overhead might be noticeable, it doesn't apply to repeated	2844	iteration, so while the overhead might be noticeable, it doesn't apply to
2343	calls to C<ev_async_send>.	2845	repeated calls to C<ev_async_send> for the same event loop.
2344		2846
2345	=item bool = ev_async_pending (ev_async *)	2847	=item bool = ev_async_pending (ev_async *)
2346		2848
2347	Returns a non-zero value when C<ev_async_send> has been called on the	2849	Returns a non-zero value when C<ev_async_send> has been called on the
2348	watcher but the event has not yet been processed (or even noted) by the	2850	watcher but the event has not yet been processed (or even noted) by the
…		…
2351	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2853	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,	2854	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	2855	it will reset the flag again. C<ev_async_pending> can be used to very
2354	quickly check whether invoking the loop might be a good idea.	2856	quickly check whether invoking the loop might be a good idea.
2355		2857
2356	Not that this does I<not> check whether the watcher itself is pending, only	2858	Not that this does I<not> check whether the watcher itself is pending,
2357	whether it has been requested to make this watcher pending.	2859	only whether it has been requested to make this watcher pending: there
		2860	is a time window between the event loop checking and resetting the async
		2861	notification, and the callback being invoked.
2358		2862
2359	=back	2863	=back
2360		2864
2361		2865
2362	=head1 OTHER FUNCTIONS	2866	=head1 OTHER FUNCTIONS
…		…
2366	=over 4	2870	=over 4
2367		2871
2368	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	2872	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2369		2873
2370	This function combines a simple timer and an I/O watcher, calls your	2874	This function combines a simple timer and an I/O watcher, calls your
2371	callback on whichever event happens first and automatically stop both	2875	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	2876	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	2877	or timeout without having to allocate/configure/start/stop/free one or
2374	more watchers yourself.	2878	more watchers yourself.
2375		2879
2376	If C<fd> is less than 0, then no I/O watcher will be started and events	2880	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	2881	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2378	C<events> set will be created and started.	2882	the given C<fd> and C<events> set will be created and started.
2379		2883
2380	If C<timeout> is less than 0, then no timeout watcher will be	2884	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	2885	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	2886	repeat = 0) will be started. C<0> is a valid timeout.
2383	dubious value.
2384		2887
2385	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2888	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	2889	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>	2890	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2388	value passed to C<ev_once>:	2891	value passed to C<ev_once>. Note that it is possible to receive I<both>
		2892	a timeout and an io event at the same time - you probably should give io
		2893	events precedence.
2389		2894
		2895	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
		2896
2390	static void stdin_ready (int revents, void *arg)	2897	static void stdin_ready (int revents, void *arg)
2391	{	2898	{
2392	if (revents & EV_TIMEOUT)
2393	/* doh, nothing entered */;
2394	else if (revents & EV_READ)	2899	if (revents & EV_READ)
2395	/* stdin might have data for us, joy! */;	2900	/* stdin might have data for us, joy! */;
		2901	else if (revents & EV_TIMEOUT)
		2902	/* doh, nothing entered */;
2396	}	2903	}
2397		2904
2398	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2905	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2399		2906
2400	=item ev_feed_event (ev_loop *, watcher *, int revents)	2907	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2401		2908
2402	Feeds the given event set into the event loop, as if the specified event	2909	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	2910	had happened for the specified watcher (which must be a pointer to an
2404	initialised but not necessarily started event watcher).	2911	initialised but not necessarily started event watcher).
2405		2912
2406	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2913	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2407		2914
2408	Feed an event on the given fd, as if a file descriptor backend detected	2915	Feed an event on the given fd, as if a file descriptor backend detected
2409	the given events it.	2916	the given events it.
2410		2917
2411	=item ev_feed_signal_event (ev_loop *loop, int signum)	2918	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2412		2919
2413	Feed an event as if the given signal occurred (C<loop> must be the default	2920	Feed an event as if the given signal occurred (C<loop> must be the default
2414	loop!).	2921	loop!).
2415		2922
2416	=back	2923	=back
…		…
2452	you to use some convenience methods to start/stop watchers and also change	2959	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.	2960	the callback model to a model using method callbacks on objects.
2454		2961
2455	To use it,	2962	To use it,
2456		2963
2457	#include <ev++.h>	2964	#include <ev++.h>
2458		2965
2459	This automatically includes F<ev.h> and puts all of its definitions (many	2966	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	2967	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	2968	put into the C<ev> namespace. It should support all the same embedding
2462	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.	2969	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
…		…
2529	your compiler is good :), then the method will be fully inlined into the	3036	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.	3037	thunking function, making it as fast as a direct C callback.
2531		3038
2532	Example: simple class declaration and watcher initialisation	3039	Example: simple class declaration and watcher initialisation
2533		3040
2534	struct myclass	3041	struct myclass
2535	{	3042	{
2536	void io_cb (ev::io &w, int revents) { }	3043	void io_cb (ev::io &w, int revents) { }
2537	}	3044	}
2538		3045
2539	myclass obj;	3046	myclass obj;
2540	ev::io iow;	3047	ev::io iow;
2541	iow.set <myclass, &myclass::io_cb> (&obj);	3048	iow.set <myclass, &myclass::io_cb> (&obj);
		3049
		3050	=item w->set (object *)
		3051
		3052	This is an B<experimental> feature that might go away in a future version.
		3053
		3054	This is a variation of a method callback - leaving out the method to call
		3055	will default the method to C<operator ()>, which makes it possible to use
		3056	functor objects without having to manually specify the C<operator ()> all
		3057	the time. Incidentally, you can then also leave out the template argument
		3058	list.
		3059
		3060	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3061	int revents)>.
		3062
		3063	See the method-C<set> above for more details.
		3064
		3065	Example: use a functor object as callback.
		3066
		3067	struct myfunctor
		3068	{
		3069	void operator() (ev::io &w, int revents)
		3070	{
		3071	...
		3072	}
		3073	}
		3074
		3075	myfunctor f;
		3076
		3077	ev::io w;
		3078	w.set (&f);
2542		3079
2543	=item w->set<function> (void *data = 0)	3080	=item w->set<function> (void *data = 0)
2544		3081
2545	Also sets a callback, but uses a static method or plain function as	3082	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	3083	callback. The optional C<data> argument will be stored in the watcher's
…		…
2548		3085
2549	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	3086	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2550		3087
2551	See the method-C<set> above for more details.	3088	See the method-C<set> above for more details.
2552		3089
2553	Example:	3090	Example: Use a plain function as callback.
2554		3091
2555	static void io_cb (ev::io &w, int revents) { }	3092	static void io_cb (ev::io &w, int revents) { }
2556	iow.set <io_cb> ();	3093	iow.set <io_cb> ();
2557		3094
2558	=item w->set (struct ev_loop *)	3095	=item w->set (struct ev_loop *)
2559		3096
2560	Associates a different C<struct ev_loop> with this watcher. You can only	3097	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).	3098	do this when the watcher is inactive (and not pending either).
…		…
2594	=back	3131	=back
2595		3132
2596	Example: Define a class with an IO and idle watcher, start one of them in	3133	Example: Define a class with an IO and idle watcher, start one of them in
2597	the constructor.	3134	the constructor.
2598		3135
2599	class myclass	3136	class myclass
2600	{	3137	{
2601	ev::io io; void io_cb (ev::io &w, int revents);	3138	ev::io io ; void io_cb (ev::io &w, int revents);
2602	ev:idle idle void idle_cb (ev::idle &w, int revents);	3139	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2603		3140
2604	myclass (int fd)	3141	myclass (int fd)
2605	{	3142	{
2606	io .set <myclass, &myclass::io_cb > (this);	3143	io .set <myclass, &myclass::io_cb > (this);
2607	idle.set <myclass, &myclass::idle_cb> (this);	3144	idle.set <myclass, &myclass::idle_cb> (this);
2608		3145
2609	io.start (fd, ev::READ);	3146	io.start (fd, ev::READ);
2610	}	3147	}
2611	};	3148	};
2612		3149
2613		3150
2614	=head1 OTHER LANGUAGE BINDINGS	3151	=head1 OTHER LANGUAGE BINDINGS
2615		3152
2616	Libev does not offer other language bindings itself, but bindings for a	3153	Libev does not offer other language bindings itself, but bindings for a
…		…
2623	=item Perl	3160	=item Perl
2624		3161
2625	The EV module implements the full libev API and is actually used to test	3162	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,	3163	libev. EV is developed together with libev. Apart from the EV core module,
2627	there are additional modules that implement libev-compatible interfaces	3164	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	3165	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>).	3166	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3167	and C<EV::Glib>).
2630		3168
2631	It can be found and installed via CPAN, its homepage is found at	3169	It can be found and installed via CPAN, its homepage is at
2632	L<http://software.schmorp.de/pkg/EV>.	3170	L<http://software.schmorp.de/pkg/EV>.
		3171
		3172	=item Python
		3173
		3174	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
		3175	seems to be quite complete and well-documented.
2633		3176
2634	=item Ruby	3177	=item Ruby
2635		3178
2636	Tony Arcieri has written a ruby extension that offers access to a subset	3179	Tony Arcieri has written a ruby extension that offers access to a subset
2637	of the libev API and adds file handle abstractions, asynchronous DNS and	3180	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	3181	more on top of it. It can be found via gem servers. Its homepage is at
2639	L<http://rev.rubyforge.org/>.	3182	L<http://rev.rubyforge.org/>.
2640		3183
		3184	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3185	makes rev work even on mingw.
		3186
		3187	=item Haskell
		3188
		3189	A haskell binding to libev is available at
		3190	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3191
2641	=item D	3192	=item D
2642		3193
2643	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	3194	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>.	3195	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3196
		3197	=item Ocaml
		3198
		3199	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3200	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2645		3201
2646	=back	3202	=back
2647		3203
2648		3204
2649	=head1 MACRO MAGIC	3205	=head1 MACRO MAGIC
…		…
2661		3217
2662	This provides the loop I<argument> for functions, if one is required ("ev	3218	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,	3219	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:	3220	C<EV_A_> is used when other arguments are following. Example:
2665		3221
2666	ev_unref (EV_A);	3222	ev_unref (EV_A);
2667	ev_timer_add (EV_A_ watcher);	3223	ev_timer_add (EV_A_ watcher);
2668	ev_loop (EV_A_ 0);	3224	ev_loop (EV_A_ 0);
2669		3225
2670	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3226	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
2671	which is often provided by the following macro.	3227	which is often provided by the following macro.
2672		3228
2673	=item C<EV_P>, C<EV_P_>	3229	=item C<EV_P>, C<EV_P_>
2674		3230
2675	This provides the loop I<parameter> for functions, if one is required ("ev	3231	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,	3232	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:	3233	C<EV_P_> is used when other parameters are following. Example:
2678		3234
2679	// this is how ev_unref is being declared	3235	// this is how ev_unref is being declared
2680	static void ev_unref (EV_P);	3236	static void ev_unref (EV_P);
2681		3237
2682	// this is how you can declare your typical callback	3238	// this is how you can declare your typical callback
2683	static void cb (EV_P_ ev_timer *w, int revents)	3239	static void cb (EV_P_ ev_timer *w, int revents)
2684		3240
2685	It declares a parameter C<loop> of type C<struct ev_loop *>, quite	3241	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
2686	suitable for use with C<EV_A>.	3242	suitable for use with C<EV_A>.
2687		3243
2688	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	3244	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
…		…
2704		3260
2705	Example: Declare and initialise a check watcher, utilising the above	3261	Example: Declare and initialise a check watcher, utilising the above
2706	macros so it will work regardless of whether multiple loops are supported	3262	macros so it will work regardless of whether multiple loops are supported
2707	or not.	3263	or not.
2708		3264
2709	static void	3265	static void
2710	check_cb (EV_P_ ev_timer *w, int revents)	3266	check_cb (EV_P_ ev_timer *w, int revents)
2711	{	3267	{
2712	ev_check_stop (EV_A_ w);	3268	ev_check_stop (EV_A_ w);
2713	}	3269	}
2714		3270
2715	ev_check check;	3271	ev_check check;
2716	ev_check_init (&check, check_cb);	3272	ev_check_init (&check, check_cb);
2717	ev_check_start (EV_DEFAULT_ &check);	3273	ev_check_start (EV_DEFAULT_ &check);
2718	ev_loop (EV_DEFAULT_ 0);	3274	ev_loop (EV_DEFAULT_ 0);
2719		3275
2720	=head1 EMBEDDING	3276	=head1 EMBEDDING
2721		3277
2722	Libev can (and often is) directly embedded into host	3278	Libev can (and often is) directly embedded into host
2723	applications. Examples of applications that embed it include the Deliantra	3279	applications. Examples of applications that embed it include the Deliantra
…		…
2737	=head3 CORE EVENT LOOP	3293	=head3 CORE EVENT LOOP
2738		3294
2739	To include only the libev core (all the C<ev_*> functions), with manual	3295	To include only the libev core (all the C<ev_*> functions), with manual
2740	configuration (no autoconf):	3296	configuration (no autoconf):
2741		3297
2742	#define EV_STANDALONE 1	3298	#define EV_STANDALONE 1
2743	#include "ev.c"	3299	#include "ev.c"
2744		3300
2745	This will automatically include F<ev.h>, too, and should be done in a	3301	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	3302	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	3303	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	3304	done by writing a wrapper around F<ev.h> that you can include instead and
2749	where you can put other configuration options):	3305	where you can put other configuration options):
2750		3306
2751	#define EV_STANDALONE 1	3307	#define EV_STANDALONE 1
2752	#include "ev.h"	3308	#include "ev.h"
2753		3309
2754	Both header files and implementation files can be compiled with a C++	3310	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	3311	compiler (at least, that's a stated goal, and breakage will be treated
2756	as a bug).	3312	as a bug).
2757		3313
2758	You need the following files in your source tree, or in a directory	3314	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):	3315	in your include path (e.g. in libev/ when using -Ilibev):
2760		3316
2761	ev.h	3317	ev.h
2762	ev.c	3318	ev.c
2763	ev_vars.h	3319	ev_vars.h
2764	ev_wrap.h	3320	ev_wrap.h
2765		3321
2766	ev_win32.c required on win32 platforms only	3322	ev_win32.c required on win32 platforms only
2767		3323
2768	ev_select.c only when select backend is enabled (which is enabled by default)	3324	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)	3325	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)	3326	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)	3327	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)	3328	ev_port.c only when the solaris port backend is enabled (disabled by default)
2773		3329
2774	F<ev.c> includes the backend files directly when enabled, so you only need	3330	F<ev.c> includes the backend files directly when enabled, so you only need
2775	to compile this single file.	3331	to compile this single file.
2776		3332
2777	=head3 LIBEVENT COMPATIBILITY API	3333	=head3 LIBEVENT COMPATIBILITY API
2778		3334
2779	To include the libevent compatibility API, also include:	3335	To include the libevent compatibility API, also include:
2780		3336
2781	#include "event.c"	3337	#include "event.c"
2782		3338
2783	in the file including F<ev.c>, and:	3339	in the file including F<ev.c>, and:
2784		3340
2785	#include "event.h"	3341	#include "event.h"
2786		3342
2787	in the files that want to use the libevent API. This also includes F<ev.h>.	3343	in the files that want to use the libevent API. This also includes F<ev.h>.
2788		3344
2789	You need the following additional files for this:	3345	You need the following additional files for this:
2790		3346
2791	event.h	3347	event.h
2792	event.c	3348	event.c
2793		3349
2794	=head3 AUTOCONF SUPPORT	3350	=head3 AUTOCONF SUPPORT
2795		3351
2796	Instead of using C<EV_STANDALONE=1> and providing your configuration in	3352	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	3353	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	3354	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
2799	include F<config.h> and configure itself accordingly.	3355	include F<config.h> and configure itself accordingly.
2800		3356
2801	For this of course you need the m4 file:	3357	For this of course you need the m4 file:
2802		3358
2803	libev.m4	3359	libev.m4
2804		3360
2805	=head2 PREPROCESSOR SYMBOLS/MACROS	3361	=head2 PREPROCESSOR SYMBOLS/MACROS
2806		3362
2807	Libev can be configured via a variety of preprocessor symbols you have to	3363	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 absence of	3364	define before including any of its files. The default in the absence of
2809	autoconf is noted for every option.	3365	autoconf is documented for every option.
2810		3366
2811	=over 4	3367	=over 4
2812		3368
2813	=item EV_STANDALONE	3369	=item EV_STANDALONE
2814		3370
…		…
2816	keeps libev from including F<config.h>, and it also defines dummy	3372	keeps libev from including F<config.h>, and it also defines dummy
2817	implementations for some libevent functions (such as logging, which is not	3373	implementations for some libevent functions (such as logging, which is not
2818	supported). It will also not define any of the structs usually found in	3374	supported). It will also not define any of the structs usually found in
2819	F<event.h> that are not directly supported by the libev core alone.	3375	F<event.h> that are not directly supported by the libev core alone.
2820		3376
		3377	In stanbdalone mode, libev will still try to automatically deduce the
		3378	configuration, but has to be more conservative.
		3379
2821	=item EV_USE_MONOTONIC	3380	=item EV_USE_MONOTONIC
2822		3381
2823	If defined to be C<1>, libev will try to detect the availability of the	3382	If defined to be C<1>, libev will try to detect the availability of the
2824	monotonic clock option at both compile time and runtime. Otherwise no use	3383	monotonic clock option at both compile time and runtime. Otherwise no
2825	of the monotonic clock option will be attempted. If you enable this, you	3384	use of the monotonic clock option will be attempted. If you enable this,
2826	usually have to link against librt or something similar. Enabling it when	3385	you usually have to link against librt or something similar. Enabling it
2827	the functionality isn't available is safe, though, although you have	3386	when 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>	3387	to make sure you link against any libraries where the C<clock_gettime>
2829	function is hiding in (often F<-lrt>).	3388	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2830		3389
2831	=item EV_USE_REALTIME	3390	=item EV_USE_REALTIME
2832		3391
2833	If defined to be C<1>, libev will try to detect the availability of the	3392	If defined to be C<1>, libev will try to detect the availability of the
2834	real-time clock option at compile time (and assume its availability at	3393	real-time clock option at compile time (and assume its availability
2835	runtime if successful). Otherwise no use of the real-time clock option will	3394	at runtime if successful). Otherwise no use of the real-time clock
2836	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3395	option will be attempted. This effectively replaces C<gettimeofday>
2837	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3396	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2838	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3397	correctness. See the note about libraries in the description of
		3398	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3399	C<EV_USE_CLOCK_SYSCALL>.
		3400
		3401	=item EV_USE_CLOCK_SYSCALL
		3402
		3403	If defined to be C<1>, libev will try to use a direct syscall instead
		3404	of calling the system-provided C<clock_gettime> function. This option
		3405	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3406	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3407	programs needlessly. Using a direct syscall is slightly slower (in
		3408	theory), because no optimised vdso implementation can be used, but avoids
		3409	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3410	higher, as it simplifies linking (no need for C<-lrt>).
2839		3411
2840	=item EV_USE_NANOSLEEP	3412	=item EV_USE_NANOSLEEP
2841		3413
2842	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3414	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2843	and will use it for delays. Otherwise it will use C<select ()>.	3415	and will use it for delays. Otherwise it will use C<select ()>.
…		…
2859		3431
2860	=item EV_SELECT_USE_FD_SET	3432	=item EV_SELECT_USE_FD_SET
2861		3433
2862	If defined to C<1>, then the select backend will use the system C<fd_set>	3434	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	3435	structure. This is useful if libev doesn't compile due to a missing
2864	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on	3436	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
2865	exotic systems. This usually limits the range of file descriptors to some	3437	on exotic systems. This usually limits the range of file descriptors to
2866	low limit such as 1024 or might have other limitations (winsocket only	3438	some low limit such as 1024 or might have other limitations (winsocket
2867	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3439	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
2868	influence the size of the C<fd_set> used.	3440	configures the maximum size of the C<fd_set>.
2869		3441
2870	=item EV_SELECT_IS_WINSOCKET	3442	=item EV_SELECT_IS_WINSOCKET
2871		3443
2872	When defined to C<1>, the select backend will assume that	3444	When defined to C<1>, the select backend will assume that
2873	select/socket/connect etc. don't understand file descriptors but	3445	select/socket/connect etc. don't understand file descriptors but
…		…
2984	When doing priority-based operations, libev usually has to linearly search	3556	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	3557	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	3558	and time, so using the defaults of five priorities (-2 .. +2) is usually
2987	fine.	3559	fine.
2988		3560
2989	If your embedding application does not need any priorities, defining these both to	3561	If your embedding application does not need any priorities, defining these
2990	C<0> will save some memory and CPU.	3562	both to C<0> will save some memory and CPU.
2991		3563
2992	=item EV_PERIODIC_ENABLE	3564	=item EV_PERIODIC_ENABLE
2993		3565
2994	If undefined or defined to be C<1>, then periodic timers are supported. If	3566	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	3567	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
3002	code.	3574	code.
3003		3575
3004	=item EV_EMBED_ENABLE	3576	=item EV_EMBED_ENABLE
3005		3577
3006	If undefined or defined to be C<1>, then embed watchers are supported. If	3578	If undefined or defined to be C<1>, then embed watchers are supported. If
3007	defined to be C<0>, then they are not.	3579	defined to be C<0>, then they are not. Embed watchers rely on most other
		3580	watcher types, which therefore must not be disabled.
3008		3581
3009	=item EV_STAT_ENABLE	3582	=item EV_STAT_ENABLE
3010		3583
3011	If undefined or defined to be C<1>, then stat watchers are supported. If	3584	If undefined or defined to be C<1>, then stat watchers are supported. If
3012	defined to be C<0>, then they are not.	3585	defined to be C<0>, then they are not.
…		…
3044	two).	3617	two).
3045		3618
3046	=item EV_USE_4HEAP	3619	=item EV_USE_4HEAP
3047		3620
3048	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3621	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	3622	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	3623	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3051	noticeably faster performance with many (thousands) of watchers.	3624	faster performance with many (thousands) of watchers.
3052		3625
3053	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3626	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3054	(disabled).	3627	(disabled).
3055		3628
3056	=item EV_HEAP_CACHE_AT	3629	=item EV_HEAP_CACHE_AT
3057		3630
3058	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3631	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	3632	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>),	3633	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,	3634	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	3635	but avoids random read accesses on heap changes. This improves performance
3063	noticeably with with many (hundreds) of watchers.	3636	noticeably with many (hundreds) of watchers.
3064		3637
3065	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3638	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3066	(disabled).	3639	(disabled).
3067		3640
3068	=item EV_VERIFY	3641	=item EV_VERIFY
…		…
3074	called once per loop, which can slow down libev. If set to C<3>, then the	3647	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	3648	verification code will be called very frequently, which will slow down
3076	libev considerably.	3649	libev considerably.
3077		3650
3078	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	3651	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
3079	C<0.>	3652	C<0>.
3080		3653
3081	=item EV_COMMON	3654	=item EV_COMMON
3082		3655
3083	By default, all watchers have a C<void *data> member. By redefining	3656	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	3657	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,	3658	members. You have to define it each time you include one of the files,
3086	though, and it must be identical each time.	3659	though, and it must be identical each time.
3087		3660
3088	For example, the perl EV module uses something like this:	3661	For example, the perl EV module uses something like this:
3089		3662
3090	#define EV_COMMON \	3663	#define EV_COMMON \
3091	SV *self; /* contains this struct */ \	3664	SV *self; /* contains this struct */ \
3092	SV *cb_sv, *fh /* note no trailing ";" */	3665	SV *cb_sv, *fh /* note no trailing ";" */
3093		3666
3094	=item EV_CB_DECLARE (type)	3667	=item EV_CB_DECLARE (type)
3095		3668
3096	=item EV_CB_INVOKE (watcher, revents)	3669	=item EV_CB_INVOKE (watcher, revents)
3097		3670
…		…
3102	definition and a statement, respectively. See the F<ev.h> header file for	3675	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	3676	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	3677	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++.	3678	method calls instead of plain function calls in C++.
3106		3679
		3680	=back
		3681
3107	=head2 EXPORTED API SYMBOLS	3682	=head2 EXPORTED API SYMBOLS
3108		3683
3109	If you need to re-export the API (e.g. via a DLL) and you need a list of	3684	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	3685	exported symbols, you can use the provided F<Symbol.*> files which list
3111	all public symbols, one per line:	3686	all public symbols, one per line:
3112		3687
3113	Symbols.ev for libev proper	3688	Symbols.ev for libev proper
3114	Symbols.event for the libevent emulation	3689	Symbols.event for the libevent emulation
3115		3690
3116	This can also be used to rename all public symbols to avoid clashes with	3691	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	3692	multiple versions of libev linked together (which is obviously bad in
3118	itself, but sometimes it is inconvenient to avoid this).	3693	itself, but sometimes it is inconvenient to avoid this).
3119		3694
…		…
3140	file.	3715	file.
3141		3716
3142	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	3717	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:	3718	that everybody includes and which overrides some configure choices:
3144		3719
3145	#define EV_MINIMAL 1	3720	#define EV_MINIMAL 1
3146	#define EV_USE_POLL 0	3721	#define EV_USE_POLL 0
3147	#define EV_MULTIPLICITY 0	3722	#define EV_MULTIPLICITY 0
3148	#define EV_PERIODIC_ENABLE 0	3723	#define EV_PERIODIC_ENABLE 0
3149	#define EV_STAT_ENABLE 0	3724	#define EV_STAT_ENABLE 0
3150	#define EV_FORK_ENABLE 0	3725	#define EV_FORK_ENABLE 0
3151	#define EV_CONFIG_H <config.h>	3726	#define EV_CONFIG_H <config.h>
3152	#define EV_MINPRI 0	3727	#define EV_MINPRI 0
3153	#define EV_MAXPRI 0	3728	#define EV_MAXPRI 0
3154		3729
3155	#include "ev++.h"	3730	#include "ev++.h"
3156		3731
3157	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3732	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3158		3733
3159	#include "ev_cpp.h"	3734	#include "ev_cpp.h"
3160	#include "ev.c"	3735	#include "ev.c"
3161		3736
		3737	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
3162		3738
3163	=head1 THREADS AND COROUTINES	3739	=head2 THREADS AND COROUTINES
3164		3740
3165	=head2 THREADS	3741	=head3 THREADS
3166		3742
3167	Libev itself is completely thread-safe, but it uses no locking. This	3743	All libev functions are reentrant and thread-safe unless explicitly
		3744	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	3745	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	3746	are no concurrent calls into any libev function with the same loop
3170	parameter.	3747	parameter (C<ev_default_*> calls have an implicit default loop parameter,
		3748	of course): libev guarantees that different event loops share no data
		3749	structures that need any locking.
3171		3750
3172	Or put differently: calls with different loop parameters can be done in	3751	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	3752	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	3753	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	3754	only one thread ever is inside a call at any point in time, e.g. by using
3176	per loop).	3755	a mutex per loop).
3177		3756
3178	If you want to know which design is best for your problem, then I cannot	3757	Specifically to support threads (and signal handlers), libev implements
		3758	so-called C<ev_async> watchers, which allow some limited form of
		3759	concurrency on the same event loop, namely waking it up "from the
		3760	outside".
		3761
		3762	If you want to know which design (one loop, locking, or multiple loops
		3763	without or something else still) is best for your problem, then I cannot
3179	help you but by giving some generic advice:	3764	help you, but here is some generic advice:
3180		3765
3181	=over 4	3766	=over 4
3182		3767
3183	=item * most applications have a main thread: use the default libev loop	3768	=item * most applications have a main thread: use the default libev loop
3184	in that thread, or create a separate thread running only the default loop.	3769	in that thread, or create a separate thread running only the default loop.
…		…
3196		3781
3197	Choosing a model is hard - look around, learn, know that usually you can do	3782	Choosing a model is hard - look around, learn, know that usually you can do
3198	better than you currently do :-)	3783	better than you currently do :-)
3199		3784
3200	=item * often you need to talk to some other thread which blocks in the	3785	=item * often you need to talk to some other thread which blocks in the
		3786	event loop.
		3787
3201	event loop - C<ev_async> watchers can be used to wake them up from other	3788	C<ev_async> watchers can be used to wake them up from other threads safely
3202	threads safely (or from signal contexts...).	3789	(or from signal contexts...).
		3790
		3791	An example use would be to communicate signals or other events that only
		3792	work in the default loop by registering the signal watcher with the
		3793	default loop and triggering an C<ev_async> watcher from the default loop
		3794	watcher callback into the event loop interested in the signal.
3203		3795
3204	=back	3796	=back
3205		3797
3206	=head2 COROUTINES	3798	=head3 COROUTINES
3207		3799
3208	Libev is much more accommodating to coroutines ("cooperative threads"):	3800	Libev is very accommodating to coroutines ("cooperative threads"):
3209	libev fully supports nesting calls to it's functions from different	3801	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	3802	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	3803	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	3804	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.	3805	you must not do this from C<ev_periodic> reschedule callbacks.
3214		3806
3215	Care has been invested into making sure that libev does not keep local	3807	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	3808	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3217	switches.	3809	they do not call any callbacks.
3218		3810
		3811	=head2 COMPILER WARNINGS
3219		3812
3220	=head1 COMPLEXITIES	3813	Depending on your compiler and compiler settings, you might get no or a
		3814	lot of warnings when compiling libev code. Some people are apparently
		3815	scared by this.
3221		3816
3222	In this section the complexities of (many of) the algorithms used inside	3817	However, these are unavoidable for many reasons. For one, each compiler
3223	libev will be explained. For complexity discussions about backends see the	3818	has different warnings, and each user has different tastes regarding
3224	documentation for C<ev_default_init>.	3819	warning options. "Warn-free" code therefore cannot be a goal except when
		3820	targeting a specific compiler and compiler-version.
3225		3821
3226	All of the following are about amortised time: If an array needs to be	3822	Another reason is that some compiler warnings require elaborate
3227	extended, libev needs to realloc and move the whole array, but this	3823	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	3824	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		3825
3232	=over 4	3826	And of course, some compiler warnings are just plain stupid, or simply
		3827	wrong (because they don't actually warn about the condition their message
		3828	seems to warn about). For example, certain older gcc versions had some
		3829	warnings that resulted an extreme number of false positives. These have
		3830	been fixed, but some people still insist on making code warn-free with
		3831	such buggy versions.
3233		3832
3234	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3833	While libev is written to generate as few warnings as possible,
		3834	"warn-free" code is not a goal, and it is recommended not to build libev
		3835	with any compiler warnings enabled unless you are prepared to cope with
		3836	them (e.g. by ignoring them). Remember that warnings are just that:
		3837	warnings, not errors, or proof of bugs.
3235		3838
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		3839
3240	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3840	=head2 VALGRIND
3241		3841
3242	That means that changing a timer costs less than removing/adding them	3842	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.	3843	highly useful. Unfortunately, valgrind reports are very hard to interpret.
3244		3844
3245	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	3845	If you think you found a bug (memory leak, uninitialised data access etc.)
		3846	in libev, then check twice: If valgrind reports something like:
3246		3847
3247	These just add the watcher into an array or at the head of a list.	3848	==2274== definitely lost: 0 bytes in 0 blocks.
		3849	==2274== possibly lost: 0 bytes in 0 blocks.
		3850	==2274== still reachable: 256 bytes in 1 blocks.
3248		3851
3249	=item Stopping check/prepare/idle/fork/async watchers: O(1)	3852	Then there is no memory leak, just as memory accounted to global variables
		3853	is not a memleak - the memory is still being referenced, and didn't leak.
3250		3854
3251	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3855	Similarly, under some circumstances, valgrind might report kernel bugs
		3856	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		3857	although an acceptable workaround has been found here), or it might be
		3858	confused.
3252		3859
3253	These watchers are stored in lists then need to be walked to find the	3860	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	3861	make it into some kind of religion.
3255	have many watchers waiting for the same fd or signal).
3256		3862
3257	=item Finding the next timer in each loop iteration: O(1)	3863	If you are unsure about something, feel free to contact the mailing list
		3864	with the full valgrind report and an explanation on why you think this
		3865	is a bug in libev (best check the archives, too :). However, don't be
		3866	annoyed when you get a brisk "this is no bug" answer and take the chance
		3867	of learning how to interpret valgrind properly.
3258		3868
3259	By virtue of using a binary or 4-heap, the next timer is always found at a	3869	If you need, for some reason, empty reports from valgrind for your project
3260	fixed position in the storage array.	3870	I suggest using suppression lists.
3261		3871
3262	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3263		3872
3264	A change means an I/O watcher gets started or stopped, which requires	3873	=head1 PORTABILITY NOTES
3265	libev to recalculate its status (and possibly tell the kernel, depending
3266	on backend and whether C<ev_io_set> was used).
3267		3874
3268	=item Activating one watcher (putting it into the pending state): O(1)
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 system call 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	3875	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3291		3876
3292	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3877	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	3878	requires, and its I/O model is fundamentally incompatible with the POSIX
3294	model. Libev still offers limited functionality on this platform in	3879	model. Libev still offers limited functionality on this platform in
3295	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3880	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
…		…
3306		3891
3307	Not a libev limitation but worth mentioning: windows apparently doesn't	3892	Not a libev limitation but worth mentioning: windows apparently doesn't
3308	accept large writes: instead of resulting in a partial write, windows will	3893	accept large writes: instead of resulting in a partial write, windows will
3309	either accept everything or return C<ENOBUFS> if the buffer is too large,	3894	either accept everything or return C<ENOBUFS> if the buffer is too large,
3310	so make sure you only write small amounts into your sockets (less than a	3895	so make sure you only write small amounts into your sockets (less than a
3311	megabyte seems safe, but thsi apparently depends on the amount of memory	3896	megabyte seems safe, but this apparently depends on the amount of memory
3312	available).	3897	available).
3313		3898
3314	Due to the many, low, and arbitrary limits on the win32 platform and	3899	Due to the many, low, and arbitrary limits on the win32 platform and
3315	the abysmal performance of winsockets, using a large number of sockets	3900	the abysmal performance of winsockets, using a large number of sockets
3316	is not recommended (and not reasonable). If your program needs to use	3901	is not recommended (and not reasonable). If your program needs to use
3317	more than a hundred or so sockets, then likely it needs to use a totally	3902	more than a hundred or so sockets, then likely it needs to use a totally
3318	different implementation for windows, as libev offers the POSIX readiness	3903	different implementation for windows, as libev offers the POSIX readiness
3319	notification model, which cannot be implemented efficiently on windows	3904	notification model, which cannot be implemented efficiently on windows
3320	(Microsoft monopoly games).	3905	(Microsoft monopoly games).
3321		3906
		3907	A typical way to use libev under windows is to embed it (see the embedding
		3908	section for details) and use the following F<evwrap.h> header file instead
		3909	of F<ev.h>:
		3910
		3911	#define EV_STANDALONE /* keeps ev from requiring config.h */
		3912	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
		3913
		3914	#include "ev.h"
		3915
		3916	And compile the following F<evwrap.c> file into your project (make sure
		3917	you do I<not> compile the F<ev.c> or any other embedded source files!):
		3918
		3919	#include "evwrap.h"
		3920	#include "ev.c"
		3921
3322	=over 4	3922	=over 4
3323		3923
3324	=item The winsocket select function	3924	=item The winsocket select function
3325		3925
3326	The winsocket C<select> function doesn't follow POSIX in that it	3926	The winsocket C<select> function doesn't follow POSIX in that it
3327	requires socket I<handles> and not socket I<file descriptors> (it is	3927	requires socket I<handles> and not socket I<file descriptors> (it is
3328	also extremely buggy). This makes select very inefficient, and also	3928	also extremely buggy). This makes select very inefficient, and also
3329	requires a mapping from file descriptors to socket handles. See the	3929	requires a mapping from file descriptors to socket handles (the Microsoft
		3930	C runtime provides the function C<_open_osfhandle> for this). See the
3330	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and	3931	discussion of the C<EV_SELECT_USE_FD_SET>, C<EV_SELECT_IS_WINSOCKET> and
3331	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.	3932	C<EV_FD_TO_WIN32_HANDLE> preprocessor symbols for more info.
3332		3933
3333	The configuration for a "naked" win32 using the Microsoft runtime	3934	The configuration for a "naked" win32 using the Microsoft runtime
3334	libraries and raw winsocket select is:	3935	libraries and raw winsocket select is:
3335		3936
3336	#define EV_USE_SELECT 1	3937	#define EV_USE_SELECT 1
3337	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	3938	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3338		3939
3339	Note that winsockets handling of fd sets is O(n), so you can easily get a	3940	Note that winsockets handling of fd sets is O(n), so you can easily get a
3340	complexity in the O(n²) range when using win32.	3941	complexity in the O(n²) range when using win32.
3341		3942
3342	=item Limited number of file descriptors	3943	=item Limited number of file descriptors
…		…
3366	wrap all I/O functions and provide your own fd management, but the cost of	3967	wrap all I/O functions and provide your own fd management, but the cost of
3367	calling select (O(n²)) will likely make this unworkable.	3968	calling select (O(n²)) will likely make this unworkable.
3368		3969
3369	=back	3970	=back
3370		3971
3371
3372	=head1 PORTABILITY REQUIREMENTS	3972	=head2 PORTABILITY REQUIREMENTS
3373		3973
3374	In addition to a working ISO-C implementation, libev relies on a few	3974	In addition to a working ISO-C implementation and of course the
3375	additional extensions:	3975	backend-specific APIs, libev relies on a few additional extensions:
3376		3976
3377	=over 4	3977	=over 4
3378		3978
		3979	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
		3980	calling conventions regardless of C<ev_watcher_type *>.
		3981
		3982	Libev assumes not only that all watcher pointers have the same internal
		3983	structure (guaranteed by POSIX but not by ISO C for example), but it also
		3984	assumes that the same (machine) code can be used to call any watcher
		3985	callback: The watcher callbacks have different type signatures, but libev
		3986	calls them using an C<ev_watcher *> internally.
		3987
3379	=item C<sig_atomic_t volatile> must be thread-atomic as well	3988	=item C<sig_atomic_t volatile> must be thread-atomic as well
3380		3989
3381	The type C<sig_atomic_t volatile> (or whatever is defined as	3990	The type C<sig_atomic_t volatile> (or whatever is defined as
3382	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different	3991	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
3383	threads. This is not part of the specification for C<sig_atomic_t>, but is	3992	threads. This is not part of the specification for C<sig_atomic_t>, but is
3384	believed to be sufficiently portable.	3993	believed to be sufficiently portable.
3385		3994
3386	=item C<sigprocmask> must work in a threaded environment	3995	=item C<sigprocmask> must work in a threaded environment
3387		3996
…		…
3396	except the initial one, and run the default loop in the initial thread as	4005	except the initial one, and run the default loop in the initial thread as
3397	well.	4006	well.
3398		4007
3399	=item C<long> must be large enough for common memory allocation sizes	4008	=item C<long> must be large enough for common memory allocation sizes
3400		4009
3401	To improve portability and simplify using libev, libev uses C<long>	4010	To improve portability and simplify its API, libev uses C<long> internally
3402	internally instead of C<size_t> when allocating its data structures. On	4011	instead of C<size_t> when allocating its data structures. On non-POSIX
3403	non-POSIX systems (Microsoft...) this might be unexpectedly low, but	4012	systems (Microsoft...) this might be unexpectedly low, but is still at
3404	is still at least 31 bits everywhere, which is enough for hundreds of	4013	least 31 bits everywhere, which is enough for hundreds of millions of
3405	millions of watchers.	4014	watchers.
3406		4015
3407	=item C<double> must hold a time value in seconds with enough accuracy	4016	=item C<double> must hold a time value in seconds with enough accuracy
3408		4017
3409	The type C<double> is used to represent timestamps. It is required to	4018	The type C<double> is used to represent timestamps. It is required to
3410	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4019	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
…		…
3414	=back	4023	=back
3415		4024
3416	If you know of other additional requirements drop me a note.	4025	If you know of other additional requirements drop me a note.
3417		4026
3418		4027
3419	=head1 COMPILER WARNINGS	4028	=head1 ALGORITHMIC COMPLEXITIES
3420		4029
3421	Depending on your compiler and compiler settings, you might get no or a	4030	In this section the complexities of (many of) the algorithms used inside
3422	lot of warnings when compiling libev code. Some people are apparently	4031	libev will be documented. For complexity discussions about backends see
3423	scared by this.	4032	the documentation for C<ev_default_init>.
3424		4033
3425	However, these are unavoidable for many reasons. For one, each compiler	4034	All of the following are about amortised time: If an array needs to be
3426	has different warnings, and each user has different tastes regarding	4035	extended, libev needs to realloc and move the whole array, but this
3427	warning options. "Warn-free" code therefore cannot be a goal except when	4036	happens asymptotically rarer with higher number of elements, so O(1) might
3428	targeting a specific compiler and compiler-version.	4037	mean that libev does a lengthy realloc operation in rare cases, but on
		4038	average it is much faster and asymptotically approaches constant time.
3429		4039
3430	Another reason is that some compiler warnings require elaborate	4040	=over 4
3431	workarounds, or other changes to the code that make it less clear and less
3432	maintainable.
3433		4041
3434	And of course, some compiler warnings are just plain stupid, or simply	4042	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
3435	wrong (because they don't actually warn about the condition their message
3436	seems to warn about).
3437		4043
3438	While libev is written to generate as few warnings as possible,	4044	This means that, when you have a watcher that triggers in one hour and
3439	"warn-free" code is not a goal, and it is recommended not to build libev	4045	there are 100 watchers that would trigger before that, then inserting will
3440	with any compiler warnings enabled unless you are prepared to cope with	4046	have to skip roughly seven (C<ld 100>) of these watchers.
3441	them (e.g. by ignoring them). Remember that warnings are just that:
3442	warnings, not errors, or proof of bugs.
3443		4047
		4048	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
3444		4049
3445	=head1 VALGRIND	4050	That means that changing a timer costs less than removing/adding them,
		4051	as only the relative motion in the event queue has to be paid for.
3446		4052
3447	Valgrind has a special section here because it is a popular tool that is	4053	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
3448	highly useful, but valgrind reports are very hard to interpret.
3449		4054
3450	If you think you found a bug (memory leak, uninitialised data access etc.)	4055	These just add the watcher into an array or at the head of a list.
3451	in libev, then check twice: If valgrind reports something like:
3452		4056
3453	==2274== definitely lost: 0 bytes in 0 blocks.	4057	=item Stopping check/prepare/idle/fork/async watchers: O(1)
3454	==2274== possibly lost: 0 bytes in 0 blocks.
3455	==2274== still reachable: 256 bytes in 1 blocks.
3456		4058
3457	Then there is no memory leak. Similarly, under some circumstances,	4059	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
3458	valgrind might report kernel bugs as if it were a bug in libev, or it
3459	might be confused (it is a very good tool, but only a tool).
3460		4060
3461	If you are unsure about something, feel free to contact the mailing list	4061	These watchers are stored in lists, so they need to be walked to find the
3462	with the full valgrind report and an explanation on why you think this is	4062	correct watcher to remove. The lists are usually short (you don't usually
3463	a bug in libev. However, don't be annoyed when you get a brisk "this is	4063	have many watchers waiting for the same fd or signal: one is typical, two
3464	no bug" answer and take the chance of learning how to interpret valgrind	4064	is rare).
3465	properly.
3466		4065
3467	If you need, for some reason, empty reports from valgrind for your project	4066	=item Finding the next timer in each loop iteration: O(1)
3468	I suggest using suppression lists.	4067
		4068	By virtue of using a binary or 4-heap, the next timer is always found at a
		4069	fixed position in the storage array.
		4070
		4071	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		4072
		4073	A change means an I/O watcher gets started or stopped, which requires
		4074	libev to recalculate its status (and possibly tell the kernel, depending
		4075	on backend and whether C<ev_io_set> was used).
		4076
		4077	=item Activating one watcher (putting it into the pending state): O(1)
		4078
		4079	=item Priority handling: O(number_of_priorities)
		4080
		4081	Priorities are implemented by allocating some space for each
		4082	priority. When doing priority-based operations, libev usually has to
		4083	linearly search all the priorities, but starting/stopping and activating
		4084	watchers becomes O(1) with respect to priority handling.
		4085
		4086	=item Sending an ev_async: O(1)
		4087
		4088	=item Processing ev_async_send: O(number_of_async_watchers)
		4089
		4090	=item Processing signals: O(max_signal_number)
		4091
		4092	Sending involves a system call I<iff> there were no other C<ev_async_send>
		4093	calls in the current loop iteration. Checking for async and signal events
		4094	involves iterating over all running async watchers or all signal numbers.
		4095
		4096	=back
3469		4097
3470		4098
3471	=head1 AUTHOR	4099	=head1 AUTHOR
3472		4100
3473	Marc Lehmann <libev@schmorp.de>.	4101	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3474		4102

Diff Legend

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