ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.46 by root, Mon Nov 26 10:20:43 2007 UTC vs.
Revision 1.117 by root, Wed Jan 9 04:15:39 2008 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
		9	=head2 EXAMPLE PROGRAM
		10
		11	#include <ev.h>
		12
		13	ev_io stdin_watcher;
		14	ev_timer timeout_watcher;
		15
		16	/* called when data readable on stdin */
		17	static void
		18	stdin_cb (EV_P_ struct ev_io *w, int revents)
		19	{
		20	/* puts ("stdin ready"); */
		21	ev_io_stop (EV_A_ w); /* just a syntax example */
		22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
		23	}
		24
		25	static void
		26	timeout_cb (EV_P_ struct ev_timer *w, int revents)
		27	{
		28	/* puts ("timeout"); */
		29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
		30	}
		31
		32	int
		33	main (void)
		34	{
		35	struct ev_loop *loop = ev_default_loop (0);
		36
		37	/* initialise an io watcher, then start it */
		38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
		39	ev_io_start (loop, &stdin_watcher);
		40
		41	/* simple non-repeating 5.5 second timeout */
		42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		43	ev_timer_start (loop, &timeout_watcher);
		44
		45	/* loop till timeout or data ready */
		46	ev_loop (loop, 0);
		47
		48	return 0;
		49	}
		50
9	=head1 DESCRIPTION	51	=head1 DESCRIPTION
10		52
		53	The newest version of this document is also available as a html-formatted
		54	web page you might find easier to navigate when reading it for the first
		55	time: L<http://cvs.schmorp.de/libev/ev.html>.
		56
11	Libev is an event loop: you register interest in certain events (such as a	57	Libev is an event loop: you register interest in certain events (such as a
12	file descriptor being readable or a timeout occuring), and it will manage	58	file descriptor being readable or a timeout occurring), and it will manage
13	these event sources and provide your program with events.	59	these event sources and provide your program with events.
14		60
15	To do this, it must take more or less complete control over your process	61	To do this, it must take more or less complete control over your process
16	(or thread) by executing the I<event loop> handler, and will then	62	(or thread) by executing the I<event loop> handler, and will then
17	communicate events via a callback mechanism.	63	communicate events via a callback mechanism.
…		…
19	You register interest in certain events by registering so-called I<event	65	You register interest in certain events by registering so-called I<event
20	watchers>, which are relatively small C structures you initialise with the	66	watchers>, which are relatively small C structures you initialise with the
21	details of the event, and then hand it over to libev by I<starting> the	67	details of the event, and then hand it over to libev by I<starting> the
22	watcher.	68	watcher.
23		69
24	=head1 FEATURES	70	=head2 FEATURES
25		71
26	Libev supports select, poll, the linux-specific epoll and the bsd-specific	72	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
27	kqueue mechanisms for file descriptor events, relative timers, absolute	73	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
28	timers with customised rescheduling, signal events, process status change	74	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
29	events (related to SIGCHLD), and event watchers dealing with the event	75	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30	loop mechanism itself (idle, prepare and check watchers). It also is quite	76	with customised rescheduling (C<ev_periodic>), synchronous signals
		77	(C<ev_signal>), process status change events (C<ev_child>), and event
		78	watchers dealing with the event loop mechanism itself (C<ev_idle>,
		79	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		80	file watchers (C<ev_stat>) and even limited support for fork events
		81	(C<ev_fork>).
		82
		83	It also is quite fast (see this
31	fast (see this L<benchmark|http://libev.schmorp.de/bench.html> comparing	84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
32	it to libevent for example).	85	for example).
33		86
34	=head1 CONVENTIONS	87	=head2 CONVENTIONS
35		88
36	Libev is very configurable. In this manual the default configuration	89	Libev is very configurable. In this manual the default configuration will
37	will be described, which supports multiple event loops. For more info	90	be described, which supports multiple event loops. For more info about
38	about various configuration options please have a look at the file	91	various configuration options please have a look at B<EMBED> section in
39	F<README.embed> in the libev distribution. If libev was configured without	92	this manual. If libev was configured without support for multiple event
40	support for multiple event loops, then all functions taking an initial	93	loops, then all functions taking an initial argument of name C<loop>
41	argument of name C<loop> (which is always of type C<struct ev_loop *>)	94	(which is always of type C<struct ev_loop *>) will not have this argument.
42	will not have this argument.
43		95
44	=head1 TIME REPRESENTATION	96	=head2 TIME REPRESENTATION
45		97
46	Libev represents time as a single floating point number, representing the	98	Libev represents time as a single floating point number, representing the
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	99	(fractional) number of seconds since the (POSIX) epoch (somewhere near
48	the beginning of 1970, details are complicated, don't ask). This type is	100	the beginning of 1970, details are complicated, don't ask). This type is
49	called C<ev_tstamp>, which is what you should use too. It usually aliases	101	called C<ev_tstamp>, which is what you should use too. It usually aliases
50	to the C<double> type in C, and when you need to do any calculations on	102	to the C<double> type in C, and when you need to do any calculations on
51	it, you should treat it as such.	103	it, you should treat it as some floatingpoint value. Unlike the name
52		104	component C<stamp> might indicate, it is also used for time differences
		105	throughout libev.
53		106
54	=head1 GLOBAL FUNCTIONS	107	=head1 GLOBAL FUNCTIONS
55		108
56	These functions can be called anytime, even before initialising the	109	These functions can be called anytime, even before initialising the
57	library in any way.	110	library in any way.
…		…
62		115
63	Returns the current time as libev would use it. Please note that the	116	Returns the current time as libev would use it. Please note that the
64	C<ev_now> function is usually faster and also often returns the timestamp	117	C<ev_now> function is usually faster and also often returns the timestamp
65	you actually want to know.	118	you actually want to know.
66		119
		120	=item ev_sleep (ev_tstamp interval)
		121
		122	Sleep for the given interval: The current thread will be blocked until
		123	either it is interrupted or the given time interval has passed. Basically
		124	this is a subsecond-resolution C<sleep ()>.
		125
67	=item int ev_version_major ()	126	=item int ev_version_major ()
68		127
69	=item int ev_version_minor ()	128	=item int ev_version_minor ()
70		129
71	You can find out the major and minor version numbers of the library	130	You can find out the major and minor ABI version numbers of the library
72	you linked against by calling the functions C<ev_version_major> and	131	you linked against by calling the functions C<ev_version_major> and
73	C<ev_version_minor>. If you want, you can compare against the global	132	C<ev_version_minor>. If you want, you can compare against the global
74	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	133	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
75	version of the library your program was compiled against.	134	version of the library your program was compiled against.
76		135
		136	These version numbers refer to the ABI version of the library, not the
		137	release version.
		138
77	Usually, it's a good idea to terminate if the major versions mismatch,	139	Usually, it's a good idea to terminate if the major versions mismatch,
78	as this indicates an incompatible change. Minor versions are usually	140	as this indicates an incompatible change. Minor versions are usually
79	compatible to older versions, so a larger minor version alone is usually	141	compatible to older versions, so a larger minor version alone is usually
80	not a problem.	142	not a problem.
81		143
82	Example: make sure we haven't accidentally been linked against the wrong	144	Example: Make sure we haven't accidentally been linked against the wrong
83	version:	145	version.
84		146
85	assert (("libev version mismatch",	147	assert (("libev version mismatch",
86	ev_version_major () == EV_VERSION_MAJOR	148	ev_version_major () == EV_VERSION_MAJOR
87	&& ev_version_minor () >= EV_VERSION_MINOR));	149	&& ev_version_minor () >= EV_VERSION_MINOR));
88		150
…		…
118		180
119	See the description of C<ev_embed> watchers for more info.	181	See the description of C<ev_embed> watchers for more info.
120		182
121	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	183	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
122		184
123	Sets the allocation function to use (the prototype is similar to the	185	Sets the allocation function to use (the prototype is similar - the
124	realloc C function, the semantics are identical). It is used to allocate	186	semantics is identical - to the realloc C function). It is used to
125	and free memory (no surprises here). If it returns zero when memory	187	allocate and free memory (no surprises here). If it returns zero when
126	needs to be allocated, the library might abort or take some potentially	188	memory needs to be allocated, the library might abort or take some
127	destructive action. The default is your system realloc function.	189	potentially destructive action. The default is your system realloc
		190	function.
128		191
129	You could override this function in high-availability programs to, say,	192	You could override this function in high-availability programs to, say,
130	free some memory if it cannot allocate memory, to use a special allocator,	193	free some memory if it cannot allocate memory, to use a special allocator,
131	or even to sleep a while and retry until some memory is available.	194	or even to sleep a while and retry until some memory is available.
132		195
133	Example: replace the libev allocator with one that waits a bit and then	196	Example: Replace the libev allocator with one that waits a bit and then
134	retries: better than mine).	197	retries).
135		198
136	static void *	199	static void *
137	persistent_realloc (void *ptr, long size)	200	persistent_realloc (void *ptr, size_t size)
138	{	201	{
139	for (;;)	202	for (;;)
140	{	203	{
141	void *newptr = realloc (ptr, size);	204	void *newptr = realloc (ptr, size);
142		205
…		…
158	callback is set, then libev will expect it to remedy the sitution, no	221	callback is set, then libev will expect it to remedy the sitution, no
159	matter what, when it returns. That is, libev will generally retry the	222	matter what, when it returns. That is, libev will generally retry the
160	requested operation, or, if the condition doesn't go away, do bad stuff	223	requested operation, or, if the condition doesn't go away, do bad stuff
161	(such as abort).	224	(such as abort).
162		225
163	Example: do the same thing as libev does internally:	226	Example: This is basically the same thing that libev does internally, too.
164		227
165	static void	228	static void
166	fatal_error (const char *msg)	229	fatal_error (const char *msg)
167	{	230	{
168	perror (msg);	231	perror (msg);
…		…
218	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	281	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
219	override the flags completely if it is found in the environment. This is	282	override the flags completely if it is found in the environment. This is
220	useful to try out specific backends to test their performance, or to work	283	useful to try out specific backends to test their performance, or to work
221	around bugs.	284	around bugs.
222		285
		286	=item C<EVFLAG_FORKCHECK>
		287
		288	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		289	a fork, you can also make libev check for a fork in each iteration by
		290	enabling this flag.
		291
		292	This works by calling C<getpid ()> on every iteration of the loop,
		293	and thus this might slow down your event loop if you do a lot of loop
		294	iterations and little real work, but is usually not noticeable (on my
		295	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		296	without a syscall and thus I<very> fast, but my Linux system also has
		297	C<pthread_atfork> which is even faster).
		298
		299	The big advantage of this flag is that you can forget about fork (and
		300	forget about forgetting to tell libev about forking) when you use this
		301	flag.
		302
		303	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		304	environment variable.
		305
223	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	306	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
224		307
225	This is your standard select(2) backend. Not I<completely> standard, as	308	This is your standard select(2) backend. Not I<completely> standard, as
226	libev tries to roll its own fd_set with no limits on the number of fds,	309	libev tries to roll its own fd_set with no limits on the number of fds,
227	but if that fails, expect a fairly low limit on the number of fds when	310	but if that fails, expect a fairly low limit on the number of fds when
228	using this backend. It doesn't scale too well (O(highest_fd)), but its usually	311	using this backend. It doesn't scale too well (O(highest_fd)), but its
229	the fastest backend for a low number of fds.	312	usually the fastest backend for a low number of (low-numbered :) fds.
		313
		314	To get good performance out of this backend you need a high amount of
		315	parallelity (most of the file descriptors should be busy). If you are
		316	writing a server, you should C<accept ()> in a loop to accept as many
		317	connections as possible during one iteration. You might also want to have
		318	a look at C<ev_set_io_collect_interval ()> to increase the amount of
		319	readyness notifications you get per iteration.
230		320
231	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	321	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
232		322
233	And this is your standard poll(2) backend. It's more complicated than	323	And this is your standard poll(2) backend. It's more complicated
234	select, but handles sparse fds better and has no artificial limit on the	324	than select, but handles sparse fds better and has no artificial
235	number of fds you can use (except it will slow down considerably with a	325	limit on the number of fds you can use (except it will slow down
236	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).	326	considerably with a lot of inactive fds). It scales similarly to select,
		327	i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
		328	performance tips.
237		329
238	=item C<EVBACKEND_EPOLL> (value 4, Linux)	330	=item C<EVBACKEND_EPOLL> (value 4, Linux)
239		331
240	For few fds, this backend is a bit little slower than poll and select,	332	For few fds, this backend is a bit little slower than poll and select,
241	but it scales phenomenally better. While poll and select usually scale like	333	but it scales phenomenally better. While poll and select usually scale
242	O(total_fds) where n is the total number of fds (or the highest fd), epoll scales	334	like O(total_fds) where n is the total number of fds (or the highest fd),
243	either O(1) or O(active_fds).	335	epoll scales either O(1) or O(active_fds). The epoll design has a number
		336	of shortcomings, such as silently dropping events in some hard-to-detect
		337	cases and rewiring a syscall per fd change, no fork support and bad
		338	support for dup.
244		339
245	While stopping and starting an I/O watcher in the same iteration will	340	While stopping, setting and starting an I/O watcher in the same iteration
246	result in some caching, there is still a syscall per such incident	341	will result in some caching, there is still a syscall per such incident
247	(because the fd could point to a different file description now), so its	342	(because the fd could point to a different file description now), so its
248	best to avoid that. Also, dup()ed file descriptors might not work very	343	best to avoid that. Also, C<dup ()>'ed file descriptors might not work
249	well if you register events for both fds.	344	very well if you register events for both fds.
250		345
251	Please note that epoll sometimes generates spurious notifications, so you	346	Please note that epoll sometimes generates spurious notifications, so you
252	need to use non-blocking I/O or other means to avoid blocking when no data	347	need to use non-blocking I/O or other means to avoid blocking when no data
253	(or space) is available.	348	(or space) is available.
254		349
		350	Best performance from this backend is achieved by not unregistering all
		351	watchers for a file descriptor until it has been closed, if possible, i.e.
		352	keep at least one watcher active per fd at all times.
		353
		354	While nominally embeddeble in other event loops, this feature is broken in
		355	all kernel versions tested so far.
		356
255	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	357	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
256		358
257	Kqueue deserves special mention, as at the time of this writing, it	359	Kqueue deserves special mention, as at the time of this writing, it
258	was broken on all BSDs except NetBSD (usually it doesn't work with	360	was broken on all BSDs except NetBSD (usually it doesn't work reliably
259	anything but sockets and pipes, except on Darwin, where of course its	361	with anything but sockets and pipes, except on Darwin, where of course
260	completely useless). For this reason its not being "autodetected"	362	it's completely useless). For this reason it's not being "autodetected"
261	unless you explicitly specify it explicitly in the flags (i.e. using	363	unless you explicitly specify it explicitly in the flags (i.e. using
262	C<EVBACKEND_KQUEUE>).	364	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		365	system like NetBSD.
		366
		367	You still can embed kqueue into a normal poll or select backend and use it
		368	only for sockets (after having made sure that sockets work with kqueue on
		369	the target platform). See C<ev_embed> watchers for more info.
263		370
264	It scales in the same way as the epoll backend, but the interface to the	371	It scales in the same way as the epoll backend, but the interface to the
265	kernel is more efficient (which says nothing about its actual speed, of	372	kernel is more efficient (which says nothing about its actual speed, of
266	course). While starting and stopping an I/O watcher does not cause an	373	course). While stopping, setting and starting an I/O watcher does never
267	extra syscall as with epoll, it still adds up to four event changes per	374	cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
268	incident, so its best to avoid that.	375	two event changes per incident, support for C<fork ()> is very bad and it
		376	drops fds silently in similarly hard-to-detect cases.
		377
		378	This backend usually performs well under most conditions.
		379
		380	While nominally embeddable in other event loops, this doesn't work
		381	everywhere, so you might need to test for this. And since it is broken
		382	almost everywhere, you should only use it when you have a lot of sockets
		383	(for which it usually works), by embedding it into another event loop
		384	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
		385	sockets.
269		386
270	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)	387	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
271		388
272	This is not implemented yet (and might never be).	389	This is not implemented yet (and might never be, unless you send me an
		390	implementation). According to reports, C</dev/poll> only supports sockets
		391	and is not embeddable, which would limit the usefulness of this backend
		392	immensely.
273		393
274	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	394	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
275		395
276	This uses the Solaris 10 port mechanism. As with everything on Solaris,	396	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
277	it's really slow, but it still scales very well (O(active_fds)).	397	it's really slow, but it still scales very well (O(active_fds)).
278		398
279	Please note that solaris ports can result in a lot of spurious	399	Please note that solaris event ports can deliver a lot of spurious
280	notifications, so you need to use non-blocking I/O or other means to avoid	400	notifications, so you need to use non-blocking I/O or other means to avoid
281	blocking when no data (or space) is available.	401	blocking when no data (or space) is available.
		402
		403	While this backend scales well, it requires one system call per active
		404	file descriptor per loop iteration. For small and medium numbers of file
		405	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
		406	might perform better.
		407
		408	On the positive side, ignoring the spurious readyness notifications, this
		409	backend actually performed to specification in all tests and is fully
		410	embeddable, which is a rare feat among the OS-specific backends.
282		411
283	=item C<EVBACKEND_ALL>	412	=item C<EVBACKEND_ALL>
284		413
285	Try all backends (even potentially broken ones that wouldn't be tried	414	Try all backends (even potentially broken ones that wouldn't be tried
286	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	415	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
287	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	416	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
288		417
		418	It is definitely not recommended to use this flag.
		419
289	=back	420	=back
290		421
291	If one or more of these are ored into the flags value, then only these	422	If one or more of these are ored into the flags value, then only these
292	backends will be tried (in the reverse order as given here). If none are	423	backends will be tried (in the reverse order as listed here). If none are
293	specified, most compiled-in backend will be tried, usually in reverse	424	specified, all backends in C<ev_recommended_backends ()> will be tried.
294	order of their flag values :)
295		425
296	The most typical usage is like this:	426	The most typical usage is like this:
297		427
298	if (!ev_default_loop (0))	428	if (!ev_default_loop (0))
299	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	429	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
…		…
314	Similar to C<ev_default_loop>, but always creates a new event loop that is	444	Similar to C<ev_default_loop>, but always creates a new event loop that is
315	always distinct from the default loop. Unlike the default loop, it cannot	445	always distinct from the default loop. Unlike the default loop, it cannot
316	handle signal and child watchers, and attempts to do so will be greeted by	446	handle signal and child watchers, and attempts to do so will be greeted by
317	undefined behaviour (or a failed assertion if assertions are enabled).	447	undefined behaviour (or a failed assertion if assertions are enabled).
318		448
319	Example: try to create a event loop that uses epoll and nothing else.	449	Example: Try to create a event loop that uses epoll and nothing else.
320		450
321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	451	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
322	if (!epoller)	452	if (!epoller)
323	fatal ("no epoll found here, maybe it hides under your chair");	453	fatal ("no epoll found here, maybe it hides under your chair");
324		454
…		…
327	Destroys the default loop again (frees all memory and kernel state	457	Destroys the default loop again (frees all memory and kernel state
328	etc.). None of the active event watchers will be stopped in the normal	458	etc.). None of the active event watchers will be stopped in the normal
329	sense, so e.g. C<ev_is_active> might still return true. It is your	459	sense, so e.g. C<ev_is_active> might still return true. It is your
330	responsibility to either stop all watchers cleanly yoursef I<before>	460	responsibility to either stop all watchers cleanly yoursef I<before>
331	calling this function, or cope with the fact afterwards (which is usually	461	calling this function, or cope with the fact afterwards (which is usually
332	the easiest thing, youc na just ignore the watchers and/or C<free ()> them	462	the easiest thing, you can just ignore the watchers and/or C<free ()> them
333	for example).	463	for example).
		464
		465	Note that certain global state, such as signal state, will not be freed by
		466	this function, and related watchers (such as signal and child watchers)
		467	would need to be stopped manually.
		468
		469	In general it is not advisable to call this function except in the
		470	rare occasion where you really need to free e.g. the signal handling
		471	pipe fds. If you need dynamically allocated loops it is better to use
		472	C<ev_loop_new> and C<ev_loop_destroy>).
334		473
335	=item ev_loop_destroy (loop)	474	=item ev_loop_destroy (loop)
336		475
337	Like C<ev_default_destroy>, but destroys an event loop created by an	476	Like C<ev_default_destroy>, but destroys an event loop created by an
338	earlier call to C<ev_loop_new>.	477	earlier call to C<ev_loop_new>.
…		…
362		501
363	Like C<ev_default_fork>, but acts on an event loop created by	502	Like C<ev_default_fork>, but acts on an event loop created by
364	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	503	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
365	after fork, and how you do this is entirely your own problem.	504	after fork, and how you do this is entirely your own problem.
366		505
		506	=item unsigned int ev_loop_count (loop)
		507
		508	Returns the count of loop iterations for the loop, which is identical to
		509	the number of times libev did poll for new events. It starts at C<0> and
		510	happily wraps around with enough iterations.
		511
		512	This value can sometimes be useful as a generation counter of sorts (it
		513	"ticks" the number of loop iterations), as it roughly corresponds with
		514	C<ev_prepare> and C<ev_check> calls.
		515
367	=item unsigned int ev_backend (loop)	516	=item unsigned int ev_backend (loop)
368		517
369	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	518	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
370	use.	519	use.
371		520
…		…
373		522
374	Returns the current "event loop time", which is the time the event loop	523	Returns the current "event loop time", which is the time the event loop
375	received events and started processing them. This timestamp does not	524	received events and started processing them. This timestamp does not
376	change as long as callbacks are being processed, and this is also the base	525	change as long as callbacks are being processed, and this is also the base
377	time used for relative timers. You can treat it as the timestamp of the	526	time used for relative timers. You can treat it as the timestamp of the
378	event occuring (or more correctly, libev finding out about it).	527	event occurring (or more correctly, libev finding out about it).
379		528
380	=item ev_loop (loop, int flags)	529	=item ev_loop (loop, int flags)
381		530
382	Finally, this is it, the event handler. This function usually is called	531	Finally, this is it, the event handler. This function usually is called
383	after you initialised all your watchers and you want to start handling	532	after you initialised all your watchers and you want to start handling
…		…
404	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	553	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
405	usually a better approach for this kind of thing.	554	usually a better approach for this kind of thing.
406		555
407	Here are the gory details of what C<ev_loop> does:	556	Here are the gory details of what C<ev_loop> does:
408		557
409	* If there are no active watchers (reference count is zero), return.	558	- Before the first iteration, call any pending watchers.
410	- Queue prepare watchers and then call all outstanding watchers.	559	* If EVFLAG_FORKCHECK was used, check for a fork.
		560	- If a fork was detected, queue and call all fork watchers.
		561	- Queue and call all prepare watchers.
411	- If we have been forked, recreate the kernel state.	562	- If we have been forked, recreate the kernel state.
412	- Update the kernel state with all outstanding changes.	563	- Update the kernel state with all outstanding changes.
413	- Update the "event loop time".	564	- Update the "event loop time".
414	- Calculate for how long to block.	565	- Calculate for how long to sleep or block, if at all
		566	(active idle watchers, EVLOOP_NONBLOCK or not having
		567	any active watchers at all will result in not sleeping).
		568	- Sleep if the I/O and timer collect interval say so.
415	- Block the process, waiting for any events.	569	- Block the process, waiting for any events.
416	- Queue all outstanding I/O (fd) events.	570	- Queue all outstanding I/O (fd) events.
417	- Update the "event loop time" and do time jump handling.	571	- Update the "event loop time" and do time jump handling.
418	- Queue all outstanding timers.	572	- Queue all outstanding timers.
419	- Queue all outstanding periodics.	573	- Queue all outstanding periodics.
420	- If no events are pending now, queue all idle watchers.	574	- If no events are pending now, queue all idle watchers.
421	- Queue all check watchers.	575	- Queue all check watchers.
422	- Call all queued watchers in reverse order (i.e. check watchers first).	576	- Call all queued watchers in reverse order (i.e. check watchers first).
423	Signals and child watchers are implemented as I/O watchers, and will	577	Signals and child watchers are implemented as I/O watchers, and will
424	be handled here by queueing them when their watcher gets executed.	578	be handled here by queueing them when their watcher gets executed.
425	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	579	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
426	were used, return, otherwise continue with step *.	580	were used, or there are no active watchers, return, otherwise
		581	continue with step *.
427		582
428	Example: queue some jobs and then loop until no events are outsanding	583	Example: Queue some jobs and then loop until no events are outstanding
429	anymore.	584	anymore.
430		585
431	... queue jobs here, make sure they register event watchers as long	586	... queue jobs here, make sure they register event watchers as long
432	... as they still have work to do (even an idle watcher will do..)	587	... as they still have work to do (even an idle watcher will do..)
433	ev_loop (my_loop, 0);	588	ev_loop (my_loop, 0);
…		…
437		592
438	Can be used to make a call to C<ev_loop> return early (but only after it	593	Can be used to make a call to C<ev_loop> return early (but only after it
439	has processed all outstanding events). The C<how> argument must be either	594	has processed all outstanding events). The C<how> argument must be either
440	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	595	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
441	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	596	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
		597
		598	This "unloop state" will be cleared when entering C<ev_loop> again.
442		599
443	=item ev_ref (loop)	600	=item ev_ref (loop)
444		601
445	=item ev_unref (loop)	602	=item ev_unref (loop)
446		603
…		…
451	returning, ev_unref() after starting, and ev_ref() before stopping it. For	608	returning, ev_unref() after starting, and ev_ref() before stopping it. For
452	example, libev itself uses this for its internal signal pipe: It is not	609	example, libev itself uses this for its internal signal pipe: It is not
453	visible to the libev user and should not keep C<ev_loop> from exiting if	610	visible to the libev user and should not keep C<ev_loop> from exiting if
454	no event watchers registered by it are active. It is also an excellent	611	no event watchers registered by it are active. It is also an excellent
455	way to do this for generic recurring timers or from within third-party	612	way to do this for generic recurring timers or from within third-party
456	libraries. Just remember to I<unref after start> and I<ref before stop>.	613	libraries. Just remember to I<unref after start> and I<ref before stop>
		614	(but only if the watcher wasn't active before, or was active before,
		615	respectively).
457		616
458	Example: create a signal watcher, but keep it from keeping C<ev_loop>	617	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
459	running when nothing else is active.	618	running when nothing else is active.
460		619
461	struct dv_signal exitsig;	620	struct ev_signal exitsig;
462	ev_signal_init (&exitsig, sig_cb, SIGINT);	621	ev_signal_init (&exitsig, sig_cb, SIGINT);
463	ev_signal_start (myloop, &exitsig);	622	ev_signal_start (loop, &exitsig);
464	evf_unref (myloop);	623	evf_unref (loop);
465		624
466	Example: for some weird reason, unregister the above signal handler again.	625	Example: For some weird reason, unregister the above signal handler again.
467		626
468	ev_ref (myloop);	627	ev_ref (loop);
469	ev_signal_stop (myloop, &exitsig);	628	ev_signal_stop (loop, &exitsig);
		629
		630	=item ev_set_io_collect_interval (loop, ev_tstamp interval)
		631
		632	=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
		633
		634	These advanced functions influence the time that libev will spend waiting
		635	for events. Both are by default C<0>, meaning that libev will try to
		636	invoke timer/periodic callbacks and I/O callbacks with minimum latency.
		637
		638	Setting these to a higher value (the C<interval> I<must> be >= C<0>)
		639	allows libev to delay invocation of I/O and timer/periodic callbacks to
		640	increase efficiency of loop iterations.
		641
		642	The background is that sometimes your program runs just fast enough to
		643	handle one (or very few) event(s) per loop iteration. While this makes
		644	the program responsive, it also wastes a lot of CPU time to poll for new
		645	events, especially with backends like C<select ()> which have a high
		646	overhead for the actual polling but can deliver many events at once.
		647
		648	By setting a higher I<io collect interval> you allow libev to spend more
		649	time collecting I/O events, so you can handle more events per iteration,
		650	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
		651	C<ev_timer>) will be not affected. Setting this to a non-null value will
		652	introduce an additional C<ev_sleep ()> call into most loop iterations.
		653
		654	Likewise, by setting a higher I<timeout collect interval> you allow libev
		655	to spend more time collecting timeouts, at the expense of increased
		656	latency (the watcher callback will be called later). C<ev_io> watchers
		657	will not be affected. Setting this to a non-null value will not introduce
		658	any overhead in libev.
		659
		660	Many (busy) programs can usually benefit by setting the io collect
		661	interval to a value near C<0.1> or so, which is often enough for
		662	interactive servers (of course not for games), likewise for timeouts. It
		663	usually doesn't make much sense to set it to a lower value than C<0.01>,
		664	as this approsaches the timing granularity of most systems.
470		665
471	=back	666	=back
472		667
473		668
474	=head1 ANATOMY OF A WATCHER	669	=head1 ANATOMY OF A WATCHER
…		…
544	The signal specified in the C<ev_signal> watcher has been received by a thread.	739	The signal specified in the C<ev_signal> watcher has been received by a thread.
545		740
546	=item C<EV_CHILD>	741	=item C<EV_CHILD>
547		742
548	The pid specified in the C<ev_child> watcher has received a status change.	743	The pid specified in the C<ev_child> watcher has received a status change.
		744
		745	=item C<EV_STAT>
		746
		747	The path specified in the C<ev_stat> watcher changed its attributes somehow.
549		748
550	=item C<EV_IDLE>	749	=item C<EV_IDLE>
551		750
552	The C<ev_idle> watcher has determined that you have nothing better to do.	751	The C<ev_idle> watcher has determined that you have nothing better to do.
553		752
…		…
561	received events. Callbacks of both watcher types can start and stop as	760	received events. Callbacks of both watcher types can start and stop as
562	many watchers as they want, and all of them will be taken into account	761	many watchers as they want, and all of them will be taken into account
563	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	762	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
564	C<ev_loop> from blocking).	763	C<ev_loop> from blocking).
565		764
		765	=item C<EV_EMBED>
		766
		767	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		768
		769	=item C<EV_FORK>
		770
		771	The event loop has been resumed in the child process after fork (see
		772	C<ev_fork>).
		773
566	=item C<EV_ERROR>	774	=item C<EV_ERROR>
567		775
568	An unspecified error has occured, the watcher has been stopped. This might	776	An unspecified error has occured, the watcher has been stopped. This might
569	happen because the watcher could not be properly started because libev	777	happen because the watcher could not be properly started because libev
570	ran out of memory, a file descriptor was found to be closed or any other	778	ran out of memory, a file descriptor was found to be closed or any other
…		…
641	=item bool ev_is_pending (ev_TYPE *watcher)	849	=item bool ev_is_pending (ev_TYPE *watcher)
642		850
643	Returns a true value iff the watcher is pending, (i.e. it has outstanding	851	Returns a true value iff the watcher is pending, (i.e. it has outstanding
644	events but its callback has not yet been invoked). As long as a watcher	852	events but its callback has not yet been invoked). As long as a watcher
645	is pending (but not active) you must not call an init function on it (but	853	is pending (but not active) you must not call an init function on it (but
646	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	854	C<ev_TYPE_set> is safe), you must not change its priority, and you must
647	libev (e.g. you cnanot C<free ()> it).	855	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		856	it).
648		857
649	=item callback = ev_cb (ev_TYPE *watcher)	858	=item callback ev_cb (ev_TYPE *watcher)
650		859
651	Returns the callback currently set on the watcher.	860	Returns the callback currently set on the watcher.
652		861
653	=item ev_cb_set (ev_TYPE *watcher, callback)	862	=item ev_cb_set (ev_TYPE *watcher, callback)
654		863
655	Change the callback. You can change the callback at virtually any time	864	Change the callback. You can change the callback at virtually any time
656	(modulo threads).	865	(modulo threads).
		866
		867	=item ev_set_priority (ev_TYPE *watcher, priority)
		868
		869	=item int ev_priority (ev_TYPE *watcher)
		870
		871	Set and query the priority of the watcher. The priority is a small
		872	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		873	(default: C<-2>). Pending watchers with higher priority will be invoked
		874	before watchers with lower priority, but priority will not keep watchers
		875	from being executed (except for C<ev_idle> watchers).
		876
		877	This means that priorities are I<only> used for ordering callback
		878	invocation after new events have been received. This is useful, for
		879	example, to reduce latency after idling, or more often, to bind two
		880	watchers on the same event and make sure one is called first.
		881
		882	If you need to suppress invocation when higher priority events are pending
		883	you need to look at C<ev_idle> watchers, which provide this functionality.
		884
		885	You I<must not> change the priority of a watcher as long as it is active or
		886	pending.
		887
		888	The default priority used by watchers when no priority has been set is
		889	always C<0>, which is supposed to not be too high and not be too low :).
		890
		891	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		892	fine, as long as you do not mind that the priority value you query might
		893	or might not have been adjusted to be within valid range.
		894
		895	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		896
		897	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		898	C<loop> nor C<revents> need to be valid as long as the watcher callback
		899	can deal with that fact.
		900
		901	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		902
		903	If the watcher is pending, this function returns clears its pending status
		904	and returns its C<revents> bitset (as if its callback was invoked). If the
		905	watcher isn't pending it does nothing and returns C<0>.
657		906
658	=back	907	=back
659		908
660		909
661	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	910	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
682	{	931	{
683	struct my_io *w = (struct my_io *)w_;	932	struct my_io *w = (struct my_io *)w_;
684	...	933	...
685	}	934	}
686		935
687	More interesting and less C-conformant ways of catsing your callback type	936	More interesting and less C-conformant ways of casting your callback type
688	have been omitted....	937	instead have been omitted.
		938
		939	Another common scenario is having some data structure with multiple
		940	watchers:
		941
		942	struct my_biggy
		943	{
		944	int some_data;
		945	ev_timer t1;
		946	ev_timer t2;
		947	}
		948
		949	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		950	you need to use C<offsetof>:
		951
		952	#include <stddef.h>
		953
		954	static void
		955	t1_cb (EV_P_ struct ev_timer *w, int revents)
		956	{
		957	struct my_biggy big = (struct my_biggy *
		958	(((char *)w) - offsetof (struct my_biggy, t1));
		959	}
		960
		961	static void
		962	t2_cb (EV_P_ struct ev_timer *w, int revents)
		963	{
		964	struct my_biggy big = (struct my_biggy *
		965	(((char *)w) - offsetof (struct my_biggy, t2));
		966	}
689		967
690		968
691	=head1 WATCHER TYPES	969	=head1 WATCHER TYPES
692		970
693	This section describes each watcher in detail, but will not repeat	971	This section describes each watcher in detail, but will not repeat
694	information given in the last section.	972	information given in the last section. Any initialisation/set macros,
		973	functions and members specific to the watcher type are explained.
		974
		975	Members are additionally marked with either I<[read-only]>, meaning that,
		976	while the watcher is active, you can look at the member and expect some
		977	sensible content, but you must not modify it (you can modify it while the
		978	watcher is stopped to your hearts content), or I<[read-write]>, which
		979	means you can expect it to have some sensible content while the watcher
		980	is active, but you can also modify it. Modifying it may not do something
		981	sensible or take immediate effect (or do anything at all), but libev will
		982	not crash or malfunction in any way.
695		983
696		984
697	=head2 C<ev_io> - is this file descriptor readable or writable?	985	=head2 C<ev_io> - is this file descriptor readable or writable?
698		986
699	I/O watchers check whether a file descriptor is readable or writable	987	I/O watchers check whether a file descriptor is readable or writable
…		…
706		994
707	In general you can register as many read and/or write event watchers per	995	In general you can register as many read and/or write event watchers per
708	fd as you want (as long as you don't confuse yourself). Setting all file	996	fd as you want (as long as you don't confuse yourself). Setting all file
709	descriptors to non-blocking mode is also usually a good idea (but not	997	descriptors to non-blocking mode is also usually a good idea (but not
710	required if you know what you are doing).	998	required if you know what you are doing).
711
712	You have to be careful with dup'ed file descriptors, though. Some backends
713	(the linux epoll backend is a notable example) cannot handle dup'ed file
714	descriptors correctly if you register interest in two or more fds pointing
715	to the same underlying file/socket/etc. description (that is, they share
716	the same underlying "file open").
717		999
718	If you must do this, then force the use of a known-to-be-good backend	1000	If you must do this, then force the use of a known-to-be-good backend
719	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1001	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
720	C<EVBACKEND_POLL>).	1002	C<EVBACKEND_POLL>).
721		1003
…		…
728	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1010	it is best to always use non-blocking I/O: An extra C<read>(2) returning
729	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1011	C<EAGAIN> is far preferable to a program hanging until some data arrives.
730		1012
731	If you cannot run the fd in non-blocking mode (for example you should not	1013	If you cannot run the fd in non-blocking mode (for example you should not
732	play around with an Xlib connection), then you have to seperately re-test	1014	play around with an Xlib connection), then you have to seperately re-test
733	wether a file descriptor is really ready with a known-to-be good interface	1015	whether a file descriptor is really ready with a known-to-be good interface
734	such as poll (fortunately in our Xlib example, Xlib already does this on	1016	such as poll (fortunately in our Xlib example, Xlib already does this on
735	its own, so its quite safe to use).	1017	its own, so its quite safe to use).
		1018
		1019	=head3 The special problem of disappearing file descriptors
		1020
		1021	Some backends (e.g. kqueue, epoll) need to be told about closing a file
		1022	descriptor (either by calling C<close> explicitly or by any other means,
		1023	such as C<dup>). The reason is that you register interest in some file
		1024	descriptor, but when it goes away, the operating system will silently drop
		1025	this interest. If another file descriptor with the same number then is
		1026	registered with libev, there is no efficient way to see that this is, in
		1027	fact, a different file descriptor.
		1028
		1029	To avoid having to explicitly tell libev about such cases, libev follows
		1030	the following policy: Each time C<ev_io_set> is being called, libev
		1031	will assume that this is potentially a new file descriptor, otherwise
		1032	it is assumed that the file descriptor stays the same. That means that
		1033	you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
		1034	descriptor even if the file descriptor number itself did not change.
		1035
		1036	This is how one would do it normally anyway, the important point is that
		1037	the libev application should not optimise around libev but should leave
		1038	optimisations to libev.
		1039
		1040	=head3 The special problem of dup'ed file descriptors
		1041
		1042	Some backends (e.g. epoll), cannot register events for file descriptors,
		1043	but only events for the underlying file descriptions. That means when you
		1044	have C<dup ()>'ed file descriptors or weirder constellations, and register
		1045	events for them, only one file descriptor might actually receive events.
		1046
		1047	There is no workaround possible except not registering events
		1048	for potentially C<dup ()>'ed file descriptors, or to resort to
		1049	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
		1050
		1051	=head3 The special problem of fork
		1052
		1053	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
		1054	useless behaviour. Libev fully supports fork, but needs to be told about
		1055	it in the child.
		1056
		1057	To support fork in your programs, you either have to call
		1058	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
		1059	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
		1060	C<EVBACKEND_POLL>.
		1061
		1062
		1063	=head3 Watcher-Specific Functions
736		1064
737	=over 4	1065	=over 4
738		1066
739	=item ev_io_init (ev_io *, callback, int fd, int events)	1067	=item ev_io_init (ev_io *, callback, int fd, int events)
740		1068
…		…
742		1070
743	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	1071	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
744	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	1072	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or
745	C<EV_READ | EV_WRITE> to receive the given events.	1073	C<EV_READ | EV_WRITE> to receive the given events.
746		1074
		1075	=item int fd [read-only]
		1076
		1077	The file descriptor being watched.
		1078
		1079	=item int events [read-only]
		1080
		1081	The events being watched.
		1082
747	=back	1083	=back
748		1084
		1085	=head3 Examples
		1086
749	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	1087	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
750	readable, but only once. Since it is likely line-buffered, you could	1088	readable, but only once. Since it is likely line-buffered, you could
751	attempt to read a whole line in the callback:	1089	attempt to read a whole line in the callback.
752		1090
753	static void	1091	static void
754	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1092	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
755	{	1093	{
756	ev_io_stop (loop, w);	1094	ev_io_stop (loop, w);
…		…
786		1124
787	The callback is guarenteed to be invoked only when its timeout has passed,	1125	The callback is guarenteed to be invoked only when its timeout has passed,
788	but if multiple timers become ready during the same loop iteration then	1126	but if multiple timers become ready during the same loop iteration then
789	order of execution is undefined.	1127	order of execution is undefined.
790		1128
		1129	=head3 Watcher-Specific Functions and Data Members
		1130
791	=over 4	1131	=over 4
792		1132
793	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1133	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
794		1134
795	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1135	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
…		…
808	=item ev_timer_again (loop)	1148	=item ev_timer_again (loop)
809		1149
810	This will act as if the timer timed out and restart it again if it is	1150	This will act as if the timer timed out and restart it again if it is
811	repeating. The exact semantics are:	1151	repeating. The exact semantics are:
812		1152
		1153	If the timer is pending, its pending status is cleared.
		1154
813	If the timer is started but nonrepeating, stop it.	1155	If the timer is started but nonrepeating, stop it (as if it timed out).
814		1156
815	If the timer is repeating, either start it if necessary (with the repeat	1157	If the timer is repeating, either start it if necessary (with the
816	value), or reset the running timer to the repeat value.	1158	C<repeat> value), or reset the running timer to the C<repeat> value.
817		1159
818	This sounds a bit complicated, but here is a useful and typical	1160	This sounds a bit complicated, but here is a useful and typical
819	example: Imagine you have a tcp connection and you want a so-called idle	1161	example: Imagine you have a tcp connection and you want a so-called idle
820	timeout, that is, you want to be called when there have been, say, 60	1162	timeout, that is, you want to be called when there have been, say, 60
821	seconds of inactivity on the socket. The easiest way to do this is to	1163	seconds of inactivity on the socket. The easiest way to do this is to
822	configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each	1164	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
823	time you successfully read or write some data. If you go into an idle	1165	C<ev_timer_again> each time you successfully read or write some data. If
824	state where you do not expect data to travel on the socket, you can stop	1166	you go into an idle state where you do not expect data to travel on the
825	the timer, and again will automatically restart it if need be.	1167	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
		1168	automatically restart it if need be.
		1169
		1170	That means you can ignore the C<after> value and C<ev_timer_start>
		1171	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
		1172
		1173	ev_timer_init (timer, callback, 0., 5.);
		1174	ev_timer_again (loop, timer);
		1175	...
		1176	timer->again = 17.;
		1177	ev_timer_again (loop, timer);
		1178	...
		1179	timer->again = 10.;
		1180	ev_timer_again (loop, timer);
		1181
		1182	This is more slightly efficient then stopping/starting the timer each time
		1183	you want to modify its timeout value.
		1184
		1185	=item ev_tstamp repeat [read-write]
		1186
		1187	The current C<repeat> value. Will be used each time the watcher times out
		1188	or C<ev_timer_again> is called and determines the next timeout (if any),
		1189	which is also when any modifications are taken into account.
826		1190
827	=back	1191	=back
828		1192
		1193	=head3 Examples
		1194
829	Example: create a timer that fires after 60 seconds.	1195	Example: Create a timer that fires after 60 seconds.
830		1196
831	static void	1197	static void
832	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1198	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
833	{	1199	{
834	.. one minute over, w is actually stopped right here	1200	.. one minute over, w is actually stopped right here
…		…
836		1202
837	struct ev_timer mytimer;	1203	struct ev_timer mytimer;
838	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1204	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
839	ev_timer_start (loop, &mytimer);	1205	ev_timer_start (loop, &mytimer);
840		1206
841	Example: create a timeout timer that times out after 10 seconds of	1207	Example: Create a timeout timer that times out after 10 seconds of
842	inactivity.	1208	inactivity.
843		1209
844	static void	1210	static void
845	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1211	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
846	{	1212	{
…		…
866	but on wallclock time (absolute time). You can tell a periodic watcher	1232	but on wallclock time (absolute time). You can tell a periodic watcher
867	to trigger "at" some specific point in time. For example, if you tell a	1233	to trigger "at" some specific point in time. For example, if you tell a
868	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1234	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
869	+ 10.>) and then reset your system clock to the last year, then it will	1235	+ 10.>) and then reset your system clock to the last year, then it will
870	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1236	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
871	roughly 10 seconds later and of course not if you reset your system time	1237	roughly 10 seconds later).
872	again).
873		1238
874	They can also be used to implement vastly more complex timers, such as	1239	They can also be used to implement vastly more complex timers, such as
875	triggering an event on eahc midnight, local time.	1240	triggering an event on each midnight, local time or other, complicated,
		1241	rules.
876		1242
877	As with timers, the callback is guarenteed to be invoked only when the	1243	As with timers, the callback is guarenteed to be invoked only when the
878	time (C<at>) has been passed, but if multiple periodic timers become ready	1244	time (C<at>) has been passed, but if multiple periodic timers become ready
879	during the same loop iteration then order of execution is undefined.	1245	during the same loop iteration then order of execution is undefined.
880		1246
		1247	=head3 Watcher-Specific Functions and Data Members
		1248
881	=over 4	1249	=over 4
882		1250
883	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1251	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
884		1252
885	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1253	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
…		…
887	Lots of arguments, lets sort it out... There are basically three modes of	1255	Lots of arguments, lets sort it out... There are basically three modes of
888	operation, and we will explain them from simplest to complex:	1256	operation, and we will explain them from simplest to complex:
889		1257
890	=over 4	1258	=over 4
891		1259
892	=item * absolute timer (interval = reschedule_cb = 0)	1260	=item * absolute timer (at = time, interval = reschedule_cb = 0)
893		1261
894	In this configuration the watcher triggers an event at the wallclock time	1262	In this configuration the watcher triggers an event at the wallclock time
895	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1263	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
896	that is, if it is to be run at January 1st 2011 then it will run when the	1264	that is, if it is to be run at January 1st 2011 then it will run when the
897	system time reaches or surpasses this time.	1265	system time reaches or surpasses this time.
898		1266
899	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1267	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
900		1268
901	In this mode the watcher will always be scheduled to time out at the next	1269	In this mode the watcher will always be scheduled to time out at the next
902	C<at + N * interval> time (for some integer N) and then repeat, regardless	1270	C<at + N * interval> time (for some integer N, which can also be negative)
903	of any time jumps.	1271	and then repeat, regardless of any time jumps.
904		1272
905	This can be used to create timers that do not drift with respect to system	1273	This can be used to create timers that do not drift with respect to system
906	time:	1274	time:
907		1275
908	ev_periodic_set (&periodic, 0., 3600., 0);	1276	ev_periodic_set (&periodic, 0., 3600., 0);
…		…
914		1282
915	Another way to think about it (for the mathematically inclined) is that	1283	Another way to think about it (for the mathematically inclined) is that
916	C<ev_periodic> will try to run the callback in this mode at the next possible	1284	C<ev_periodic> will try to run the callback in this mode at the next possible
917	time where C<time = at (mod interval)>, regardless of any time jumps.	1285	time where C<time = at (mod interval)>, regardless of any time jumps.
918		1286
		1287	For numerical stability it is preferable that the C<at> value is near
		1288	C<ev_now ()> (the current time), but there is no range requirement for
		1289	this value.
		1290
919	=item * manual reschedule mode (reschedule_cb = callback)	1291	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
920		1292
921	In this mode the values for C<interval> and C<at> are both being	1293	In this mode the values for C<interval> and C<at> are both being
922	ignored. Instead, each time the periodic watcher gets scheduled, the	1294	ignored. Instead, each time the periodic watcher gets scheduled, the
923	reschedule callback will be called with the watcher as first, and the	1295	reschedule callback will be called with the watcher as first, and the
924	current time as second argument.	1296	current time as second argument.
925		1297
926	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1298	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
927	ever, or make any event loop modifications>. If you need to stop it,	1299	ever, or make any event loop modifications>. If you need to stop it,
928	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1300	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
929	starting a prepare watcher).	1301	starting an C<ev_prepare> watcher, which is legal).
930		1302
931	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1303	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,
932	ev_tstamp now)>, e.g.:	1304	ev_tstamp now)>, e.g.:
933		1305
934	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1306	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
…		…
957	Simply stops and restarts the periodic watcher again. This is only useful	1329	Simply stops and restarts the periodic watcher again. This is only useful
958	when you changed some parameters or the reschedule callback would return	1330	when you changed some parameters or the reschedule callback would return
959	a different time than the last time it was called (e.g. in a crond like	1331	a different time than the last time it was called (e.g. in a crond like
960	program when the crontabs have changed).	1332	program when the crontabs have changed).
961		1333
		1334	=item ev_tstamp offset [read-write]
		1335
		1336	When repeating, this contains the offset value, otherwise this is the
		1337	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
		1338
		1339	Can be modified any time, but changes only take effect when the periodic
		1340	timer fires or C<ev_periodic_again> is being called.
		1341
		1342	=item ev_tstamp interval [read-write]
		1343
		1344	The current interval value. Can be modified any time, but changes only
		1345	take effect when the periodic timer fires or C<ev_periodic_again> is being
		1346	called.
		1347
		1348	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
		1349
		1350	The current reschedule callback, or C<0>, if this functionality is
		1351	switched off. Can be changed any time, but changes only take effect when
		1352	the periodic timer fires or C<ev_periodic_again> is being called.
		1353
		1354	=item ev_tstamp at [read-only]
		1355
		1356	When active, contains the absolute time that the watcher is supposed to
		1357	trigger next.
		1358
962	=back	1359	=back
963		1360
		1361	=head3 Examples
		1362
964	Example: call a callback every hour, or, more precisely, whenever the	1363	Example: Call a callback every hour, or, more precisely, whenever the
965	system clock is divisible by 3600. The callback invocation times have	1364	system clock is divisible by 3600. The callback invocation times have
966	potentially a lot of jittering, but good long-term stability.	1365	potentially a lot of jittering, but good long-term stability.
967		1366
968	static void	1367	static void
969	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1368	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
…		…
973		1372
974	struct ev_periodic hourly_tick;	1373	struct ev_periodic hourly_tick;
975	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1374	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
976	ev_periodic_start (loop, &hourly_tick);	1375	ev_periodic_start (loop, &hourly_tick);
977		1376
978	Example: the same as above, but use a reschedule callback to do it:	1377	Example: The same as above, but use a reschedule callback to do it:
979		1378
980	#include <math.h>	1379	#include <math.h>
981		1380
982	static ev_tstamp	1381	static ev_tstamp
983	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1382	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
985	return fmod (now, 3600.) + 3600.;	1384	return fmod (now, 3600.) + 3600.;
986	}	1385	}
987		1386
988	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1387	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
989		1388
990	Example: call a callback every hour, starting now:	1389	Example: Call a callback every hour, starting now:
991		1390
992	struct ev_periodic hourly_tick;	1391	struct ev_periodic hourly_tick;
993	ev_periodic_init (&hourly_tick, clock_cb,	1392	ev_periodic_init (&hourly_tick, clock_cb,
994	fmod (ev_now (loop), 3600.), 3600., 0);	1393	fmod (ev_now (loop), 3600.), 3600., 0);
995	ev_periodic_start (loop, &hourly_tick);	1394	ev_periodic_start (loop, &hourly_tick);
…		…
1007	with the kernel (thus it coexists with your own signal handlers as long	1406	with the kernel (thus it coexists with your own signal handlers as long
1008	as you don't register any with libev). Similarly, when the last signal	1407	as you don't register any with libev). Similarly, when the last signal
1009	watcher for a signal is stopped libev will reset the signal handler to	1408	watcher for a signal is stopped libev will reset the signal handler to
1010	SIG_DFL (regardless of what it was set to before).	1409	SIG_DFL (regardless of what it was set to before).
1011		1410
		1411	=head3 Watcher-Specific Functions and Data Members
		1412
1012	=over 4	1413	=over 4
1013		1414
1014	=item ev_signal_init (ev_signal *, callback, int signum)	1415	=item ev_signal_init (ev_signal *, callback, int signum)
1015		1416
1016	=item ev_signal_set (ev_signal *, int signum)	1417	=item ev_signal_set (ev_signal *, int signum)
1017		1418
1018	Configures the watcher to trigger on the given signal number (usually one	1419	Configures the watcher to trigger on the given signal number (usually one
1019	of the C<SIGxxx> constants).	1420	of the C<SIGxxx> constants).
1020		1421
		1422	=item int signum [read-only]
		1423
		1424	The signal the watcher watches out for.
		1425
1021	=back	1426	=back
1022		1427
1023		1428
1024	=head2 C<ev_child> - watch out for process status changes	1429	=head2 C<ev_child> - watch out for process status changes
1025		1430
1026	Child watchers trigger when your process receives a SIGCHLD in response to	1431	Child watchers trigger when your process receives a SIGCHLD in response to
1027	some child status changes (most typically when a child of yours dies).	1432	some child status changes (most typically when a child of yours dies).
		1433
		1434	=head3 Watcher-Specific Functions and Data Members
1028		1435
1029	=over 4	1436	=over 4
1030		1437
1031	=item ev_child_init (ev_child *, callback, int pid)	1438	=item ev_child_init (ev_child *, callback, int pid)
1032		1439
…		…
1037	at the C<rstatus> member of the C<ev_child> watcher structure to see	1444	at the C<rstatus> member of the C<ev_child> watcher structure to see
1038	the status word (use the macros from C<sys/wait.h> and see your systems	1445	the status word (use the macros from C<sys/wait.h> and see your systems
1039	C<waitpid> documentation). The C<rpid> member contains the pid of the	1446	C<waitpid> documentation). The C<rpid> member contains the pid of the
1040	process causing the status change.	1447	process causing the status change.
1041		1448
		1449	=item int pid [read-only]
		1450
		1451	The process id this watcher watches out for, or C<0>, meaning any process id.
		1452
		1453	=item int rpid [read-write]
		1454
		1455	The process id that detected a status change.
		1456
		1457	=item int rstatus [read-write]
		1458
		1459	The process exit/trace status caused by C<rpid> (see your systems
		1460	C<waitpid> and C<sys/wait.h> documentation for details).
		1461
1042	=back	1462	=back
1043		1463
		1464	=head3 Examples
		1465
1044	Example: try to exit cleanly on SIGINT and SIGTERM.	1466	Example: Try to exit cleanly on SIGINT and SIGTERM.
1045		1467
1046	static void	1468	static void
1047	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1469	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1048	{	1470	{
1049	ev_unloop (loop, EVUNLOOP_ALL);	1471	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1052	struct ev_signal signal_watcher;	1474	struct ev_signal signal_watcher;
1053	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1475	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1054	ev_signal_start (loop, &sigint_cb);	1476	ev_signal_start (loop, &sigint_cb);
1055		1477
1056		1478
		1479	=head2 C<ev_stat> - did the file attributes just change?
		1480
		1481	This watches a filesystem path for attribute changes. That is, it calls
		1482	C<stat> regularly (or when the OS says it changed) and sees if it changed
		1483	compared to the last time, invoking the callback if it did.
		1484
		1485	The path does not need to exist: changing from "path exists" to "path does
		1486	not exist" is a status change like any other. The condition "path does
		1487	not exist" is signified by the C<st_nlink> field being zero (which is
		1488	otherwise always forced to be at least one) and all the other fields of
		1489	the stat buffer having unspecified contents.
		1490
		1491	The path I<should> be absolute and I<must not> end in a slash. If it is
		1492	relative and your working directory changes, the behaviour is undefined.
		1493
		1494	Since there is no standard to do this, the portable implementation simply
		1495	calls C<stat (2)> regularly on the path to see if it changed somehow. You
		1496	can specify a recommended polling interval for this case. If you specify
		1497	a polling interval of C<0> (highly recommended!) then a I<suitable,
		1498	unspecified default> value will be used (which you can expect to be around
		1499	five seconds, although this might change dynamically). Libev will also
		1500	impose a minimum interval which is currently around C<0.1>, but thats
		1501	usually overkill.
		1502
		1503	This watcher type is not meant for massive numbers of stat watchers,
		1504	as even with OS-supported change notifications, this can be
		1505	resource-intensive.
		1506
		1507	At the time of this writing, only the Linux inotify interface is
		1508	implemented (implementing kqueue support is left as an exercise for the
		1509	reader). Inotify will be used to give hints only and should not change the
		1510	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1511	to fall back to regular polling again even with inotify, but changes are
		1512	usually detected immediately, and if the file exists there will be no
		1513	polling.
		1514
		1515	=head3 Inotify
		1516
		1517	When C<inotify (7)> support has been compiled into libev (generally only
		1518	available on Linux) and present at runtime, it will be used to speed up
		1519	change detection where possible. The inotify descriptor will be created lazily
		1520	when the first C<ev_stat> watcher is being started.
		1521
		1522	Inotify presense does not change the semantics of C<ev_stat> watchers
		1523	except that changes might be detected earlier, and in some cases, to avoid
		1524	making regular C<stat> calls. Even in the presense of inotify support
		1525	there are many cases where libev has to resort to regular C<stat> polling.
		1526
		1527	(There is no support for kqueue, as apparently it cannot be used to
		1528	implement this functionality, due to the requirement of having a file
		1529	descriptor open on the object at all times).
		1530
		1531	=head3 The special problem of stat time resolution
		1532
		1533	The C<stat ()> syscall only supports full-second resolution portably, and
		1534	even on systems where the resolution is higher, many filesystems still
		1535	only support whole seconds.
		1536
		1537	That means that, if the time is the only thing that changes, you might
		1538	miss updates: on the first update, C<ev_stat> detects a change and calls
		1539	your callback, which does something. When there is another update within
		1540	the same second, C<ev_stat> will be unable to detect it.
		1541
		1542	The solution to this is to delay acting on a change for a second (or till
		1543	the next second boundary), using a roughly one-second delay C<ev_timer>
		1544	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
		1545	is added to work around small timing inconsistencies of some operating
		1546	systems.
		1547
		1548	=head3 Watcher-Specific Functions and Data Members
		1549
		1550	=over 4
		1551
		1552	=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
		1553
		1554	=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
		1555
		1556	Configures the watcher to wait for status changes of the given
		1557	C<path>. The C<interval> is a hint on how quickly a change is expected to
		1558	be detected and should normally be specified as C<0> to let libev choose
		1559	a suitable value. The memory pointed to by C<path> must point to the same
		1560	path for as long as the watcher is active.
		1561
		1562	The callback will be receive C<EV_STAT> when a change was detected,
		1563	relative to the attributes at the time the watcher was started (or the
		1564	last change was detected).
		1565
		1566	=item ev_stat_stat (ev_stat *)
		1567
		1568	Updates the stat buffer immediately with new values. If you change the
		1569	watched path in your callback, you could call this fucntion to avoid
		1570	detecting this change (while introducing a race condition). Can also be
		1571	useful simply to find out the new values.
		1572
		1573	=item ev_statdata attr [read-only]
		1574
		1575	The most-recently detected attributes of the file. Although the type is of
		1576	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
		1577	suitable for your system. If the C<st_nlink> member is C<0>, then there
		1578	was some error while C<stat>ing the file.
		1579
		1580	=item ev_statdata prev [read-only]
		1581
		1582	The previous attributes of the file. The callback gets invoked whenever
		1583	C<prev> != C<attr>.
		1584
		1585	=item ev_tstamp interval [read-only]
		1586
		1587	The specified interval.
		1588
		1589	=item const char *path [read-only]
		1590
		1591	The filesystem path that is being watched.
		1592
		1593	=back
		1594
		1595	=head3 Examples
		1596
		1597	Example: Watch C</etc/passwd> for attribute changes.
		1598
		1599	static void
		1600	passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
		1601	{
		1602	/* /etc/passwd changed in some way */
		1603	if (w->attr.st_nlink)
		1604	{
		1605	printf ("passwd current size %ld\n", (long)w->attr.st_size);
		1606	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
		1607	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
		1608	}
		1609	else
		1610	/* you shalt not abuse printf for puts */
		1611	puts ("wow, /etc/passwd is not there, expect problems. "
		1612	"if this is windows, they already arrived\n");
		1613	}
		1614
		1615	...
		1616	ev_stat passwd;
		1617
		1618	ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
		1619	ev_stat_start (loop, &passwd);
		1620
		1621	Example: Like above, but additionally use a one-second delay so we do not
		1622	miss updates (however, frequent updates will delay processing, too, so
		1623	one might do the work both on C<ev_stat> callback invocation I<and> on
		1624	C<ev_timer> callback invocation).
		1625
		1626	static ev_stat passwd;
		1627	static ev_timer timer;
		1628
		1629	static void
		1630	timer_cb (EV_P_ ev_timer *w, int revents)
		1631	{
		1632	ev_timer_stop (EV_A_ w);
		1633
		1634	/* now it's one second after the most recent passwd change */
		1635	}
		1636
		1637	static void
		1638	stat_cb (EV_P_ ev_stat *w, int revents)
		1639	{
		1640	/* reset the one-second timer */
		1641	ev_timer_again (EV_A_ &timer);
		1642	}
		1643
		1644	...
		1645	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
		1646	ev_stat_start (loop, &passwd);
		1647	ev_timer_init (&timer, timer_cb, 0., 1.01);
		1648
		1649
1057	=head2 C<ev_idle> - when you've got nothing better to do...	1650	=head2 C<ev_idle> - when you've got nothing better to do...
1058		1651
1059	Idle watchers trigger events when there are no other events are pending	1652	Idle watchers trigger events when no other events of the same or higher
1060	(prepare, check and other idle watchers do not count). That is, as long	1653	priority are pending (prepare, check and other idle watchers do not
1061	as your process is busy handling sockets or timeouts (or even signals,	1654	count).
1062	imagine) it will not be triggered. But when your process is idle all idle	1655
1063	watchers are being called again and again, once per event loop iteration -	1656	That is, as long as your process is busy handling sockets or timeouts
		1657	(or even signals, imagine) of the same or higher priority it will not be
		1658	triggered. But when your process is idle (or only lower-priority watchers
		1659	are pending), the idle watchers are being called once per event loop
1064	until stopped, that is, or your process receives more events and becomes	1660	iteration - until stopped, that is, or your process receives more events
1065	busy.	1661	and becomes busy again with higher priority stuff.
1066		1662
1067	The most noteworthy effect is that as long as any idle watchers are	1663	The most noteworthy effect is that as long as any idle watchers are
1068	active, the process will not block when waiting for new events.	1664	active, the process will not block when waiting for new events.
1069		1665
1070	Apart from keeping your process non-blocking (which is a useful	1666	Apart from keeping your process non-blocking (which is a useful
1071	effect on its own sometimes), idle watchers are a good place to do	1667	effect on its own sometimes), idle watchers are a good place to do
1072	"pseudo-background processing", or delay processing stuff to after the	1668	"pseudo-background processing", or delay processing stuff to after the
1073	event loop has handled all outstanding events.	1669	event loop has handled all outstanding events.
1074		1670
		1671	=head3 Watcher-Specific Functions and Data Members
		1672
1075	=over 4	1673	=over 4
1076		1674
1077	=item ev_idle_init (ev_signal *, callback)	1675	=item ev_idle_init (ev_signal *, callback)
1078		1676
1079	Initialises and configures the idle watcher - it has no parameters of any	1677	Initialises and configures the idle watcher - it has no parameters of any
1080	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1678	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1081	believe me.	1679	believe me.
1082		1680
1083	=back	1681	=back
1084		1682
		1683	=head3 Examples
		1684
1085	Example: dynamically allocate an C<ev_idle>, start it, and in the	1685	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1086	callback, free it. Alos, use no error checking, as usual.	1686	callback, free it. Also, use no error checking, as usual.
1087		1687
1088	static void	1688	static void
1089	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1689	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1090	{	1690	{
1091	free (w);	1691	free (w);
…		…
1136	with priority higher than or equal to the event loop and one coroutine	1736	with priority higher than or equal to the event loop and one coroutine
1137	of lower priority, but only once, using idle watchers to keep the event	1737	of lower priority, but only once, using idle watchers to keep the event
1138	loop from blocking if lower-priority coroutines are active, thus mapping	1738	loop from blocking if lower-priority coroutines are active, thus mapping
1139	low-priority coroutines to idle/background tasks).	1739	low-priority coroutines to idle/background tasks).
1140		1740
		1741	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1742	priority, to ensure that they are being run before any other watchers
		1743	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1744	too) should not activate ("feed") events into libev. While libev fully
		1745	supports this, they will be called before other C<ev_check> watchers
		1746	did their job. As C<ev_check> watchers are often used to embed other
		1747	(non-libev) event loops those other event loops might be in an unusable
		1748	state until their C<ev_check> watcher ran (always remind yourself to
		1749	coexist peacefully with others).
		1750
		1751	=head3 Watcher-Specific Functions and Data Members
		1752
1141	=over 4	1753	=over 4
1142		1754
1143	=item ev_prepare_init (ev_prepare *, callback)	1755	=item ev_prepare_init (ev_prepare *, callback)
1144		1756
1145	=item ev_check_init (ev_check *, callback)	1757	=item ev_check_init (ev_check *, callback)
…		…
1148	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1760	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1149	macros, but using them is utterly, utterly and completely pointless.	1761	macros, but using them is utterly, utterly and completely pointless.
1150		1762
1151	=back	1763	=back
1152		1764
1153	Example: To include a library such as adns, you would add IO watchers	1765	=head3 Examples
1154	and a timeout watcher in a prepare handler, as required by libadns, and	1766
		1767	There are a number of principal ways to embed other event loops or modules
		1768	into libev. Here are some ideas on how to include libadns into libev
		1769	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1770	use for an actually working example. Another Perl module named C<EV::Glib>
		1771	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1772	into the Glib event loop).
		1773
		1774	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1155	in a check watcher, destroy them and call into libadns. What follows is	1775	and in a check watcher, destroy them and call into libadns. What follows
1156	pseudo-code only of course:	1776	is pseudo-code only of course. This requires you to either use a low
		1777	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1778	the callbacks for the IO/timeout watchers might not have been called yet.
1157		1779
1158	static ev_io iow [nfd];	1780	static ev_io iow [nfd];
1159	static ev_timer tw;	1781	static ev_timer tw;
1160		1782
1161	static void	1783	static void
1162	io_cb (ev_loop *loop, ev_io *w, int revents)	1784	io_cb (ev_loop *loop, ev_io *w, int revents)
1163	{	1785	{
1164	// set the relevant poll flags
1165	// could also call adns_processreadable etc. here
1166	struct pollfd *fd = (struct pollfd *)w->data;
1167	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
1168	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
1169	}	1786	}
1170		1787
1171	// create io watchers for each fd and a timer before blocking	1788	// create io watchers for each fd and a timer before blocking
1172	static void	1789	static void
1173	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	1790	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)
1174	{	1791	{
1175	int timeout = 3600000;truct pollfd fds [nfd];	1792	int timeout = 3600000;
		1793	struct pollfd fds [nfd];
1176	// actual code will need to loop here and realloc etc.	1794	// actual code will need to loop here and realloc etc.
1177	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1795	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1178		1796
1179	/* the callback is illegal, but won't be called as we stop during check */	1797	/* the callback is illegal, but won't be called as we stop during check */
1180	ev_timer_init (&tw, 0, timeout * 1e-3);	1798	ev_timer_init (&tw, 0, timeout * 1e-3);
1181	ev_timer_start (loop, &tw);	1799	ev_timer_start (loop, &tw);
1182		1800
1183	// create on ev_io per pollfd	1801	// create one ev_io per pollfd
1184	for (int i = 0; i < nfd; ++i)	1802	for (int i = 0; i < nfd; ++i)
1185	{	1803	{
1186	ev_io_init (iow + i, io_cb, fds [i].fd,	1804	ev_io_init (iow + i, io_cb, fds [i].fd,
1187	((fds [i].events & POLLIN ? EV_READ : 0)	1805	((fds [i].events & POLLIN ? EV_READ : 0)
1188	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1806	| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1189		1807
1190	fds [i].revents = 0;	1808	fds [i].revents = 0;
1191	iow [i].data = fds + i;
1192	ev_io_start (loop, iow + i);	1809	ev_io_start (loop, iow + i);
1193	}	1810	}
1194	}	1811	}
1195		1812
1196	// stop all watchers after blocking	1813	// stop all watchers after blocking
…		…
1198	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	1815	adns_check_cb (ev_loop *loop, ev_check *w, int revents)
1199	{	1816	{
1200	ev_timer_stop (loop, &tw);	1817	ev_timer_stop (loop, &tw);
1201		1818
1202	for (int i = 0; i < nfd; ++i)	1819	for (int i = 0; i < nfd; ++i)
		1820	{
		1821	// set the relevant poll flags
		1822	// could also call adns_processreadable etc. here
		1823	struct pollfd *fd = fds + i;
		1824	int revents = ev_clear_pending (iow + i);
		1825	if (revents & EV_READ ) fd->revents |= fd->events & POLLIN;
		1826	if (revents & EV_WRITE) fd->revents |= fd->events & POLLOUT;
		1827
		1828	// now stop the watcher
1203	ev_io_stop (loop, iow + i);	1829	ev_io_stop (loop, iow + i);
		1830	}
1204		1831
1205	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1832	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1833	}
		1834
		1835	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1836	in the prepare watcher and would dispose of the check watcher.
		1837
		1838	Method 3: If the module to be embedded supports explicit event
		1839	notification (adns does), you can also make use of the actual watcher
		1840	callbacks, and only destroy/create the watchers in the prepare watcher.
		1841
		1842	static void
		1843	timer_cb (EV_P_ ev_timer *w, int revents)
		1844	{
		1845	adns_state ads = (adns_state)w->data;
		1846	update_now (EV_A);
		1847
		1848	adns_processtimeouts (ads, &tv_now);
		1849	}
		1850
		1851	static void
		1852	io_cb (EV_P_ ev_io *w, int revents)
		1853	{
		1854	adns_state ads = (adns_state)w->data;
		1855	update_now (EV_A);
		1856
		1857	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1858	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1859	}
		1860
		1861	// do not ever call adns_afterpoll
		1862
		1863	Method 4: Do not use a prepare or check watcher because the module you
		1864	want to embed is too inflexible to support it. Instead, youc na override
		1865	their poll function. The drawback with this solution is that the main
		1866	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1867	this.
		1868
		1869	static gint
		1870	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1871	{
		1872	int got_events = 0;
		1873
		1874	for (n = 0; n < nfds; ++n)
		1875	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1876
		1877	if (timeout >= 0)
		1878	// create/start timer
		1879
		1880	// poll
		1881	ev_loop (EV_A_ 0);
		1882
		1883	// stop timer again
		1884	if (timeout >= 0)
		1885	ev_timer_stop (EV_A_ &to);
		1886
		1887	// stop io watchers again - their callbacks should have set
		1888	for (n = 0; n < nfds; ++n)
		1889	ev_io_stop (EV_A_ iow [n]);
		1890
		1891	return got_events;
1206	}	1892	}
1207		1893
1208		1894
1209	=head2 C<ev_embed> - when one backend isn't enough...	1895	=head2 C<ev_embed> - when one backend isn't enough...
1210		1896
…		…
1253	portable one.	1939	portable one.
1254		1940
1255	So when you want to use this feature you will always have to be prepared	1941	So when you want to use this feature you will always have to be prepared
1256	that you cannot get an embeddable loop. The recommended way to get around	1942	that you cannot get an embeddable loop. The recommended way to get around
1257	this is to have a separate variables for your embeddable loop, try to	1943	this is to have a separate variables for your embeddable loop, try to
1258	create it, and if that fails, use the normal loop for everything:	1944	create it, and if that fails, use the normal loop for everything.
		1945
		1946	=head3 Watcher-Specific Functions and Data Members
		1947
		1948	=over 4
		1949
		1950	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
		1951
		1952	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
		1953
		1954	Configures the watcher to embed the given loop, which must be
		1955	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
		1956	invoked automatically, otherwise it is the responsibility of the callback
		1957	to invoke it (it will continue to be called until the sweep has been done,
		1958	if you do not want thta, you need to temporarily stop the embed watcher).
		1959
		1960	=item ev_embed_sweep (loop, ev_embed *)
		1961
		1962	Make a single, non-blocking sweep over the embedded loop. This works
		1963	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
		1964	apropriate way for embedded loops.
		1965
		1966	=item struct ev_loop *other [read-only]
		1967
		1968	The embedded event loop.
		1969
		1970	=back
		1971
		1972	=head3 Examples
		1973
		1974	Example: Try to get an embeddable event loop and embed it into the default
		1975	event loop. If that is not possible, use the default loop. The default
		1976	loop is stored in C<loop_hi>, while the mebeddable loop is stored in
		1977	C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
		1978	used).
1259		1979
1260	struct ev_loop *loop_hi = ev_default_init (0);	1980	struct ev_loop *loop_hi = ev_default_init (0);
1261	struct ev_loop *loop_lo = 0;	1981	struct ev_loop *loop_lo = 0;
1262	struct ev_embed embed;	1982	struct ev_embed embed;
1263		1983
…		…
1274	ev_embed_start (loop_hi, &embed);	1994	ev_embed_start (loop_hi, &embed);
1275	}	1995	}
1276	else	1996	else
1277	loop_lo = loop_hi;	1997	loop_lo = loop_hi;
1278		1998
		1999	Example: Check if kqueue is available but not recommended and create
		2000	a kqueue backend for use with sockets (which usually work with any
		2001	kqueue implementation). Store the kqueue/socket-only event loop in
		2002	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
		2003
		2004	struct ev_loop *loop = ev_default_init (0);
		2005	struct ev_loop *loop_socket = 0;
		2006	struct ev_embed embed;
		2007
		2008	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
		2009	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
		2010	{
		2011	ev_embed_init (&embed, 0, loop_socket);
		2012	ev_embed_start (loop, &embed);
		2013	}
		2014
		2015	if (!loop_socket)
		2016	loop_socket = loop;
		2017
		2018	// now use loop_socket for all sockets, and loop for everything else
		2019
		2020
		2021	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		2022
		2023	Fork watchers are called when a C<fork ()> was detected (usually because
		2024	whoever is a good citizen cared to tell libev about it by calling
		2025	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		2026	event loop blocks next and before C<ev_check> watchers are being called,
		2027	and only in the child after the fork. If whoever good citizen calling
		2028	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		2029	handlers will be invoked, too, of course.
		2030
		2031	=head3 Watcher-Specific Functions and Data Members
		2032
1279	=over 4	2033	=over 4
1280		2034
1281	=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)	2035	=item ev_fork_init (ev_signal *, callback)
1282		2036
1283	=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)	2037	Initialises and configures the fork watcher - it has no parameters of any
1284		2038	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
1285	Configures the watcher to embed the given loop, which must be	2039	believe me.
1286	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1287	invoked automatically, otherwise it is the responsibility of the callback
1288	to invoke it (it will continue to be called until the sweep has been done,
1289	if you do not want thta, you need to temporarily stop the embed watcher).
1290
1291	=item ev_embed_sweep (loop, ev_embed *)
1292
1293	Make a single, non-blocking sweep over the embedded loop. This works
1294	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1295	apropriate way for embedded loops.
1296		2040
1297	=back	2041	=back
1298		2042
1299		2043
1300	=head1 OTHER FUNCTIONS	2044	=head1 OTHER FUNCTIONS
…		…
1389		2133
1390	To use it,	2134	To use it,
1391		2135
1392	#include <ev++.h>	2136	#include <ev++.h>
1393		2137
1394	(it is not installed by default). This automatically includes F<ev.h>	2138	This automatically includes F<ev.h> and puts all of its definitions (many
1395	and puts all of its definitions (many of them macros) into the global	2139	of them macros) into the global namespace. All C++ specific things are
1396	namespace. All C++ specific things are put into the C<ev> namespace.	2140	put into the C<ev> namespace. It should support all the same embedding
		2141	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1397		2142
1398	It should support all the same embedding options as F<ev.h>, most notably	2143	Care has been taken to keep the overhead low. The only data member the C++
1399	C<EV_MULTIPLICITY>.	2144	classes add (compared to plain C-style watchers) is the event loop pointer
		2145	that the watcher is associated with (or no additional members at all if
		2146	you disable C<EV_MULTIPLICITY> when embedding libev).
		2147
		2148	Currently, functions, and static and non-static member functions can be
		2149	used as callbacks. Other types should be easy to add as long as they only
		2150	need one additional pointer for context. If you need support for other
		2151	types of functors please contact the author (preferably after implementing
		2152	it).
1400		2153
1401	Here is a list of things available in the C<ev> namespace:	2154	Here is a list of things available in the C<ev> namespace:
1402		2155
1403	=over 4	2156	=over 4
1404		2157
…		…
1420		2173
1421	All of those classes have these methods:	2174	All of those classes have these methods:
1422		2175
1423	=over 4	2176	=over 4
1424		2177
1425	=item ev::TYPE::TYPE (object *, object::method *)	2178	=item ev::TYPE::TYPE ()
1426		2179
1427	=item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)	2180	=item ev::TYPE::TYPE (struct ev_loop *)
1428		2181
1429	=item ev::TYPE::~TYPE	2182	=item ev::TYPE::~TYPE
1430		2183
1431	The constructor takes a pointer to an object and a method pointer to	2184	The constructor (optionally) takes an event loop to associate the watcher
1432	the event handler callback to call in this class. The constructor calls	2185	with. If it is omitted, it will use C<EV_DEFAULT>.
1433	C<ev_init> for you, which means you have to call the C<set> method	2186
1434	before starting it. If you do not specify a loop then the constructor	2187	The constructor calls C<ev_init> for you, which means you have to call the
1435	automatically associates the default loop with this watcher.	2188	C<set> method before starting it.
		2189
		2190	It will not set a callback, however: You have to call the templated C<set>
		2191	method to set a callback before you can start the watcher.
		2192
		2193	(The reason why you have to use a method is a limitation in C++ which does
		2194	not allow explicit template arguments for constructors).
1436		2195
1437	The destructor automatically stops the watcher if it is active.	2196	The destructor automatically stops the watcher if it is active.
		2197
		2198	=item w->set<class, &class::method> (object *)
		2199
		2200	This method sets the callback method to call. The method has to have a
		2201	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		2202	first argument and the C<revents> as second. The object must be given as
		2203	parameter and is stored in the C<data> member of the watcher.
		2204
		2205	This method synthesizes efficient thunking code to call your method from
		2206	the C callback that libev requires. If your compiler can inline your
		2207	callback (i.e. it is visible to it at the place of the C<set> call and
		2208	your compiler is good :), then the method will be fully inlined into the
		2209	thunking function, making it as fast as a direct C callback.
		2210
		2211	Example: simple class declaration and watcher initialisation
		2212
		2213	struct myclass
		2214	{
		2215	void io_cb (ev::io &w, int revents) { }
		2216	}
		2217
		2218	myclass obj;
		2219	ev::io iow;
		2220	iow.set <myclass, &myclass::io_cb> (&obj);
		2221
		2222	=item w->set<function> (void *data = 0)
		2223
		2224	Also sets a callback, but uses a static method or plain function as
		2225	callback. The optional C<data> argument will be stored in the watcher's
		2226	C<data> member and is free for you to use.
		2227
		2228	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		2229
		2230	See the method-C<set> above for more details.
		2231
		2232	Example:
		2233
		2234	static void io_cb (ev::io &w, int revents) { }
		2235	iow.set <io_cb> ();
1438		2236
1439	=item w->set (struct ev_loop *)	2237	=item w->set (struct ev_loop *)
1440		2238
1441	Associates a different C<struct ev_loop> with this watcher. You can only	2239	Associates a different C<struct ev_loop> with this watcher. You can only
1442	do this when the watcher is inactive (and not pending either).	2240	do this when the watcher is inactive (and not pending either).
1443		2241
1444	=item w->set ([args])	2242	=item w->set ([args])
1445		2243
1446	Basically the same as C<ev_TYPE_set>, with the same args. Must be	2244	Basically the same as C<ev_TYPE_set>, with the same args. Must be
1447	called at least once. Unlike the C counterpart, an active watcher gets	2245	called at least once. Unlike the C counterpart, an active watcher gets
1448	automatically stopped and restarted.	2246	automatically stopped and restarted when reconfiguring it with this
		2247	method.
1449		2248
1450	=item w->start ()	2249	=item w->start ()
1451		2250
1452	Starts the watcher. Note that there is no C<loop> argument as the	2251	Starts the watcher. Note that there is no C<loop> argument, as the
1453	constructor already takes the loop.	2252	constructor already stores the event loop.
1454		2253
1455	=item w->stop ()	2254	=item w->stop ()
1456		2255
1457	Stops the watcher if it is active. Again, no C<loop> argument.	2256	Stops the watcher if it is active. Again, no C<loop> argument.
1458		2257
1459	=item w->again () C<ev::timer>, C<ev::periodic> only	2258	=item w->again () (C<ev::timer>, C<ev::periodic> only)
1460		2259
1461	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding	2260	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1462	C<ev_TYPE_again> function.	2261	C<ev_TYPE_again> function.
1463		2262
1464	=item w->sweep () C<ev::embed> only	2263	=item w->sweep () (C<ev::embed> only)
1465		2264
1466	Invokes C<ev_embed_sweep>.	2265	Invokes C<ev_embed_sweep>.
		2266
		2267	=item w->update () (C<ev::stat> only)
		2268
		2269	Invokes C<ev_stat_stat>.
1467		2270
1468	=back	2271	=back
1469		2272
1470	=back	2273	=back
1471		2274
…		…
1479		2282
1480	myclass ();	2283	myclass ();
1481	}	2284	}
1482		2285
1483	myclass::myclass (int fd)	2286	myclass::myclass (int fd)
1484	: io (this, &myclass::io_cb),
1485	idle (this, &myclass::idle_cb)
1486	{	2287	{
		2288	io .set <myclass, &myclass::io_cb > (this);
		2289	idle.set <myclass, &myclass::idle_cb> (this);
		2290
1487	io.start (fd, ev::READ);	2291	io.start (fd, ev::READ);
1488	}	2292	}
		2293
		2294
		2295	=head1 MACRO MAGIC
		2296
		2297	Libev can be compiled with a variety of options, the most fundamantal
		2298	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
		2299	functions and callbacks have an initial C<struct ev_loop *> argument.
		2300
		2301	To make it easier to write programs that cope with either variant, the
		2302	following macros are defined:
		2303
		2304	=over 4
		2305
		2306	=item C<EV_A>, C<EV_A_>
		2307
		2308	This provides the loop I<argument> for functions, if one is required ("ev
		2309	loop argument"). The C<EV_A> form is used when this is the sole argument,
		2310	C<EV_A_> is used when other arguments are following. Example:
		2311
		2312	ev_unref (EV_A);
		2313	ev_timer_add (EV_A_ watcher);
		2314	ev_loop (EV_A_ 0);
		2315
		2316	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		2317	which is often provided by the following macro.
		2318
		2319	=item C<EV_P>, C<EV_P_>
		2320
		2321	This provides the loop I<parameter> for functions, if one is required ("ev
		2322	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		2323	C<EV_P_> is used when other parameters are following. Example:
		2324
		2325	// this is how ev_unref is being declared
		2326	static void ev_unref (EV_P);
		2327
		2328	// this is how you can declare your typical callback
		2329	static void cb (EV_P_ ev_timer *w, int revents)
		2330
		2331	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		2332	suitable for use with C<EV_A>.
		2333
		2334	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		2335
		2336	Similar to the other two macros, this gives you the value of the default
		2337	loop, if multiple loops are supported ("ev loop default").
		2338
		2339	=back
		2340
		2341	Example: Declare and initialise a check watcher, utilising the above
		2342	macros so it will work regardless of whether multiple loops are supported
		2343	or not.
		2344
		2345	static void
		2346	check_cb (EV_P_ ev_timer *w, int revents)
		2347	{
		2348	ev_check_stop (EV_A_ w);
		2349	}
		2350
		2351	ev_check check;
		2352	ev_check_init (&check, check_cb);
		2353	ev_check_start (EV_DEFAULT_ &check);
		2354	ev_loop (EV_DEFAULT_ 0);
1489		2355
1490	=head1 EMBEDDING	2356	=head1 EMBEDDING
1491		2357
1492	Libev can (and often is) directly embedded into host	2358	Libev can (and often is) directly embedded into host
1493	applications. Examples of applications that embed it include the Deliantra	2359	applications. Examples of applications that embed it include the Deliantra
1494	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)	2360	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
1495	and rxvt-unicode.	2361	and rxvt-unicode.
1496		2362
1497	The goal is to enable you to just copy the neecssary files into your	2363	The goal is to enable you to just copy the necessary files into your
1498	source directory without having to change even a single line in them, so	2364	source directory without having to change even a single line in them, so
1499	you can easily upgrade by simply copying (or having a checked-out copy of	2365	you can easily upgrade by simply copying (or having a checked-out copy of
1500	libev somewhere in your source tree).	2366	libev somewhere in your source tree).
1501		2367
1502	=head2 FILESETS	2368	=head2 FILESETS
…		…
1533	ev_vars.h	2399	ev_vars.h
1534	ev_wrap.h	2400	ev_wrap.h
1535		2401
1536	ev_win32.c required on win32 platforms only	2402	ev_win32.c required on win32 platforms only
1537		2403
1538	ev_select.c only when select backend is enabled (which is by default)	2404	ev_select.c only when select backend is enabled (which is enabled by default)
1539	ev_poll.c only when poll backend is enabled (disabled by default)	2405	ev_poll.c only when poll backend is enabled (disabled by default)
1540	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2406	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1541	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2407	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1542	ev_port.c only when the solaris port backend is enabled (disabled by default)	2408	ev_port.c only when the solaris port backend is enabled (disabled by default)
1543		2409
…		…
1592		2458
1593	If defined to be C<1>, libev will try to detect the availability of the	2459	If defined to be C<1>, libev will try to detect the availability of the
1594	monotonic clock option at both compiletime and runtime. Otherwise no use	2460	monotonic clock option at both compiletime and runtime. Otherwise no use
1595	of the monotonic clock option will be attempted. If you enable this, you	2461	of the monotonic clock option will be attempted. If you enable this, you
1596	usually have to link against librt or something similar. Enabling it when	2462	usually have to link against librt or something similar. Enabling it when
1597	the functionality isn't available is safe, though, althoguh you have	2463	the functionality isn't available is safe, though, although you have
1598	to make sure you link against any libraries where the C<clock_gettime>	2464	to make sure you link against any libraries where the C<clock_gettime>
1599	function is hiding in (often F<-lrt>).	2465	function is hiding in (often F<-lrt>).
1600		2466
1601	=item EV_USE_REALTIME	2467	=item EV_USE_REALTIME
1602		2468
1603	If defined to be C<1>, libev will try to detect the availability of the	2469	If defined to be C<1>, libev will try to detect the availability of the
1604	realtime clock option at compiletime (and assume its availability at	2470	realtime clock option at compiletime (and assume its availability at
1605	runtime if successful). Otherwise no use of the realtime clock option will	2471	runtime if successful). Otherwise no use of the realtime clock option will
1606	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	2472	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
1607	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries	2473	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
1608	in the description of C<EV_USE_MONOTONIC>, though.	2474	note about libraries in the description of C<EV_USE_MONOTONIC>, though.
		2475
		2476	=item EV_USE_NANOSLEEP
		2477
		2478	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
		2479	and will use it for delays. Otherwise it will use C<select ()>.
1609		2480
1610	=item EV_USE_SELECT	2481	=item EV_USE_SELECT
1611		2482
1612	If undefined or defined to be C<1>, libev will compile in support for the	2483	If undefined or defined to be C<1>, libev will compile in support for the
1613	C<select>(2) backend. No attempt at autodetection will be done: if no	2484	C<select>(2) backend. No attempt at autodetection will be done: if no
…		…
1631	wants osf handles on win32 (this is the case when the select to	2502	wants osf handles on win32 (this is the case when the select to
1632	be used is the winsock select). This means that it will call	2503	be used is the winsock select). This means that it will call
1633	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	2504	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
1634	it is assumed that all these functions actually work on fds, even	2505	it is assumed that all these functions actually work on fds, even
1635	on win32. Should not be defined on non-win32 platforms.	2506	on win32. Should not be defined on non-win32 platforms.
		2507
		2508	=item EV_FD_TO_WIN32_HANDLE
		2509
		2510	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
		2511	file descriptors to socket handles. When not defining this symbol (the
		2512	default), then libev will call C<_get_osfhandle>, which is usually
		2513	correct. In some cases, programs use their own file descriptor management,
		2514	in which case they can provide this function to map fds to socket handles.
1636		2515
1637	=item EV_USE_POLL	2516	=item EV_USE_POLL
1638		2517
1639	If defined to be C<1>, libev will compile in support for the C<poll>(2)	2518	If defined to be C<1>, libev will compile in support for the C<poll>(2)
1640	backend. Otherwise it will be enabled on non-win32 platforms. It	2519	backend. Otherwise it will be enabled on non-win32 platforms. It
…		…
1668		2547
1669	=item EV_USE_DEVPOLL	2548	=item EV_USE_DEVPOLL
1670		2549
1671	reserved for future expansion, works like the USE symbols above.	2550	reserved for future expansion, works like the USE symbols above.
1672		2551
		2552	=item EV_USE_INOTIFY
		2553
		2554	If defined to be C<1>, libev will compile in support for the Linux inotify
		2555	interface to speed up C<ev_stat> watchers. Its actual availability will
		2556	be detected at runtime.
		2557
1673	=item EV_H	2558	=item EV_H
1674		2559
1675	The name of the F<ev.h> header file used to include it. The default if	2560	The name of the F<ev.h> header file used to include it. The default if
1676	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2561	undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to
1677	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2562	virtually rename the F<ev.h> header file in case of conflicts.
1678		2563
1679	=item EV_CONFIG_H	2564	=item EV_CONFIG_H
1680		2565
1681	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	2566	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
1682	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	2567	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
1683	C<EV_H>, above.	2568	C<EV_H>, above.
1684		2569
1685	=item EV_EVENT_H	2570	=item EV_EVENT_H
1686		2571
1687	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	2572	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
1688	of how the F<event.h> header can be found.	2573	of how the F<event.h> header can be found, the dfeault is C<"event.h">.
1689		2574
1690	=item EV_PROTOTYPES	2575	=item EV_PROTOTYPES
1691		2576
1692	If defined to be C<0>, then F<ev.h> will not define any function	2577	If defined to be C<0>, then F<ev.h> will not define any function
1693	prototypes, but still define all the structs and other symbols. This is	2578	prototypes, but still define all the structs and other symbols. This is
…		…
1700	will have the C<struct ev_loop *> as first argument, and you can create	2585	will have the C<struct ev_loop *> as first argument, and you can create
1701	additional independent event loops. Otherwise there will be no support	2586	additional independent event loops. Otherwise there will be no support
1702	for multiple event loops and there is no first event loop pointer	2587	for multiple event loops and there is no first event loop pointer
1703	argument. Instead, all functions act on the single default loop.	2588	argument. Instead, all functions act on the single default loop.
1704		2589
		2590	=item EV_MINPRI
		2591
		2592	=item EV_MAXPRI
		2593
		2594	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2595	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2596	provide for more priorities by overriding those symbols (usually defined
		2597	to be C<-2> and C<2>, respectively).
		2598
		2599	When doing priority-based operations, libev usually has to linearly search
		2600	all the priorities, so having many of them (hundreds) uses a lot of space
		2601	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2602	fine.
		2603
		2604	If your embedding app does not need any priorities, defining these both to
		2605	C<0> will save some memory and cpu.
		2606
1705	=item EV_PERIODICS	2607	=item EV_PERIODIC_ENABLE
1706		2608
1707	If undefined or defined to be C<1>, then periodic timers are supported,	2609	If undefined or defined to be C<1>, then periodic timers are supported. If
1708	otherwise not. This saves a few kb of code.	2610	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2611	code.
		2612
		2613	=item EV_IDLE_ENABLE
		2614
		2615	If undefined or defined to be C<1>, then idle watchers are supported. If
		2616	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2617	code.
		2618
		2619	=item EV_EMBED_ENABLE
		2620
		2621	If undefined or defined to be C<1>, then embed watchers are supported. If
		2622	defined to be C<0>, then they are not.
		2623
		2624	=item EV_STAT_ENABLE
		2625
		2626	If undefined or defined to be C<1>, then stat watchers are supported. If
		2627	defined to be C<0>, then they are not.
		2628
		2629	=item EV_FORK_ENABLE
		2630
		2631	If undefined or defined to be C<1>, then fork watchers are supported. If
		2632	defined to be C<0>, then they are not.
		2633
		2634	=item EV_MINIMAL
		2635
		2636	If you need to shave off some kilobytes of code at the expense of some
		2637	speed, define this symbol to C<1>. Currently only used for gcc to override
		2638	some inlining decisions, saves roughly 30% codesize of amd64.
		2639
		2640	=item EV_PID_HASHSIZE
		2641
		2642	C<ev_child> watchers use a small hash table to distribute workload by
		2643	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		2644	than enough. If you need to manage thousands of children you might want to
		2645	increase this value (I<must> be a power of two).
		2646
		2647	=item EV_INOTIFY_HASHSIZE
		2648
		2649	C<ev_stat> watchers use a small hash table to distribute workload by
		2650	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2651	usually more than enough. If you need to manage thousands of C<ev_stat>
		2652	watchers you might want to increase this value (I<must> be a power of
		2653	two).
1709		2654
1710	=item EV_COMMON	2655	=item EV_COMMON
1711		2656
1712	By default, all watchers have a C<void *data> member. By redefining	2657	By default, all watchers have a C<void *data> member. By redefining
1713	this macro to a something else you can include more and other types of	2658	this macro to a something else you can include more and other types of
…		…
1726		2671
1727	=item ev_set_cb (ev, cb)	2672	=item ev_set_cb (ev, cb)
1728		2673
1729	Can be used to change the callback member declaration in each watcher,	2674	Can be used to change the callback member declaration in each watcher,
1730	and the way callbacks are invoked and set. Must expand to a struct member	2675	and the way callbacks are invoked and set. Must expand to a struct member
1731	definition and a statement, respectively. See the F<ev.v> header file for	2676	definition and a statement, respectively. See the F<ev.h> header file for
1732	their default definitions. One possible use for overriding these is to	2677	their default definitions. One possible use for overriding these is to
1733	avoid the C<struct ev_loop *> as first argument in all cases, or to use	2678	avoid the C<struct ev_loop *> as first argument in all cases, or to use
1734	method calls instead of plain function calls in C++.	2679	method calls instead of plain function calls in C++.
		2680
		2681	=head2 EXPORTED API SYMBOLS
		2682
		2683	If you need to re-export the API (e.g. via a dll) and you need a list of
		2684	exported symbols, you can use the provided F<Symbol.*> files which list
		2685	all public symbols, one per line:
		2686
		2687	Symbols.ev for libev proper
		2688	Symbols.event for the libevent emulation
		2689
		2690	This can also be used to rename all public symbols to avoid clashes with
		2691	multiple versions of libev linked together (which is obviously bad in
		2692	itself, but sometimes it is inconvinient to avoid this).
		2693
		2694	A sed command like this will create wrapper C<#define>'s that you need to
		2695	include before including F<ev.h>:
		2696
		2697	<Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
		2698
		2699	This would create a file F<wrap.h> which essentially looks like this:
		2700
		2701	#define ev_backend myprefix_ev_backend
		2702	#define ev_check_start myprefix_ev_check_start
		2703	#define ev_check_stop myprefix_ev_check_stop
		2704	...
1735		2705
1736	=head2 EXAMPLES	2706	=head2 EXAMPLES
1737		2707
1738	For a real-world example of a program the includes libev	2708	For a real-world example of a program the includes libev
1739	verbatim, you can have a look at the EV perl module	2709	verbatim, you can have a look at the EV perl module
…		…
1742	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2712	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
1743	will be compiled. It is pretty complex because it provides its own header	2713	will be compiled. It is pretty complex because it provides its own header
1744	file.	2714	file.
1745		2715
1746	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2716	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
1747	that everybody includes and which overrides some autoconf choices:	2717	that everybody includes and which overrides some configure choices:
1748		2718
		2719	#define EV_MINIMAL 1
1749	#define EV_USE_POLL 0	2720	#define EV_USE_POLL 0
1750	#define EV_MULTIPLICITY 0	2721	#define EV_MULTIPLICITY 0
1751	#define EV_PERIODICS 0	2722	#define EV_PERIODIC_ENABLE 0
		2723	#define EV_STAT_ENABLE 0
		2724	#define EV_FORK_ENABLE 0
1752	#define EV_CONFIG_H <config.h>	2725	#define EV_CONFIG_H <config.h>
		2726	#define EV_MINPRI 0
		2727	#define EV_MAXPRI 0
1753		2728
1754	#include "ev++.h"	2729	#include "ev++.h"
1755		2730
1756	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2731	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
1757		2732
…		…
1763		2738
1764	In this section the complexities of (many of) the algorithms used inside	2739	In this section the complexities of (many of) the algorithms used inside
1765	libev will be explained. For complexity discussions about backends see the	2740	libev will be explained. For complexity discussions about backends see the
1766	documentation for C<ev_default_init>.	2741	documentation for C<ev_default_init>.
1767		2742
		2743	All of the following are about amortised time: If an array needs to be
		2744	extended, libev needs to realloc and move the whole array, but this
		2745	happens asymptotically never with higher number of elements, so O(1) might
		2746	mean it might do a lengthy realloc operation in rare cases, but on average
		2747	it is much faster and asymptotically approaches constant time.
		2748
1768	=over 4	2749	=over 4
1769		2750
1770	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2751	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
1771		2752
		2753	This means that, when you have a watcher that triggers in one hour and
		2754	there are 100 watchers that would trigger before that then inserting will
		2755	have to skip roughly seven (C<ld 100>) of these watchers.
		2756
1772	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2757	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
		2758
		2759	That means that changing a timer costs less than removing/adding them
		2760	as only the relative motion in the event queue has to be paid for.
1773		2761
1774	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2762	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
1775		2763
		2764	These just add the watcher into an array or at the head of a list.
		2765
1776	=item Stopping check/prepare/idle watchers: O(1)	2766	=item Stopping check/prepare/idle watchers: O(1)
1777		2767
1778	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	2768	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
1779		2769
		2770	These watchers are stored in lists then need to be walked to find the
		2771	correct watcher to remove. The lists are usually short (you don't usually
		2772	have many watchers waiting for the same fd or signal).
		2773
1780	=item Finding the next timer per loop iteration: O(1)	2774	=item Finding the next timer in each loop iteration: O(1)
		2775
		2776	By virtue of using a binary heap, the next timer is always found at the
		2777	beginning of the storage array.
1781		2778
1782	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2779	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
1783		2780
1784	=item Activating one watcher: O(1)	2781	A change means an I/O watcher gets started or stopped, which requires
		2782	libev to recalculate its status (and possibly tell the kernel, depending
		2783	on backend and wether C<ev_io_set> was used).
		2784
		2785	=item Activating one watcher (putting it into the pending state): O(1)
		2786
		2787	=item Priority handling: O(number_of_priorities)
		2788
		2789	Priorities are implemented by allocating some space for each
		2790	priority. When doing priority-based operations, libev usually has to
		2791	linearly search all the priorities, but starting/stopping and activating
		2792	watchers becomes O(1) w.r.t. prioritiy handling.
1785		2793
1786	=back	2794	=back
1787		2795
1788		2796
		2797	=head1 Win32 platform limitations and workarounds
		2798
		2799	Win32 doesn't support any of the standards (e.g. POSIX) that libev
		2800	requires, and its I/O model is fundamentally incompatible with the POSIX
		2801	model. Libev still offers limited functionality on this platform in
		2802	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
		2803	descriptors. This only applies when using Win32 natively, not when using
		2804	e.g. cygwin.
		2805
		2806	There is no supported compilation method available on windows except
		2807	embedding it into other applications.
		2808
		2809	Due to the many, low, and arbitrary limits on the win32 platform and the
		2810	abysmal performance of winsockets, using a large number of sockets is not
		2811	recommended (and not reasonable). If your program needs to use more than
		2812	a hundred or so sockets, then likely it needs to use a totally different
		2813	implementation for windows, as libev offers the POSIX model, which cannot
		2814	be implemented efficiently on windows (microsoft monopoly games).
		2815
		2816	=over 4
		2817
		2818	=item The winsocket select function
		2819
		2820	The winsocket C<select> function doesn't follow POSIX in that it requires
		2821	socket I<handles> and not socket I<file descriptors>. This makes select
		2822	very inefficient, and also requires a mapping from file descriptors
		2823	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
		2824	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
		2825	symbols for more info.
		2826
		2827	The configuration for a "naked" win32 using the microsoft runtime
		2828	libraries and raw winsocket select is:
		2829
		2830	#define EV_USE_SELECT 1
		2831	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
		2832
		2833	Note that winsockets handling of fd sets is O(n), so you can easily get a
		2834	complexity in the O(n²) range when using win32.
		2835
		2836	=item Limited number of file descriptors
		2837
		2838	Windows has numerous arbitrary (and low) limits on things. Early versions
		2839	of winsocket's select only supported waiting for a max. of C<64> handles
		2840	(probably owning to the fact that all windows kernels can only wait for
		2841	C<64> things at the same time internally; microsoft recommends spawning a
		2842	chain of threads and wait for 63 handles and the previous thread in each).
		2843
		2844	Newer versions support more handles, but you need to define C<FD_SETSIZE>
		2845	to some high number (e.g. C<2048>) before compiling the winsocket select
		2846	call (which might be in libev or elsewhere, for example, perl does its own
		2847	select emulation on windows).
		2848
		2849	Another limit is the number of file descriptors in the microsoft runtime
		2850	libraries, which by default is C<64> (there must be a hidden I<64> fetish
		2851	or something like this inside microsoft). You can increase this by calling
		2852	C<_setmaxstdio>, which can increase this limit to C<2048> (another
		2853	arbitrary limit), but is broken in many versions of the microsoft runtime
		2854	libraries.
		2855
		2856	This might get you to about C<512> or C<2048> sockets (depending on
		2857	windows version and/or the phase of the moon). To get more, you need to
		2858	wrap all I/O functions and provide your own fd management, but the cost of
		2859	calling select (O(n²)) will likely make this unworkable.
		2860
		2861	=back
		2862
		2863
1789	=head1 AUTHOR	2864	=head1 AUTHOR
1790		2865
1791	Marc Lehmann <libev@schmorp.de>.	2866	Marc Lehmann <libev@schmorp.de>.
1792		2867

Diff Legend

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