ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.163 by root, Sat May 31 23:19:23 2008 UTC vs.
Revision 1.206 by root, Tue Oct 28 12:31:38 2008 UTC

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

Diff Legend

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