ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.199 by root, Thu Oct 23 07:18:21 2008 UTC vs.
Revision 1.247 by root, Wed Jul 8 02:46:05 2009 UTC

…		…
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
		14	#include <stdio.h> // for puts
		15
14	// every watcher type has its own typedef'd struct	16	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	17	// with the name ev_TYPE
16	ev_io stdin_watcher;	18	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
18		20
19	// all watcher callbacks have a similar signature	21	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	22	// this callback is called when data is readable on stdin
…		…
41		43
42	int	44	int
43	main (void)	45	main (void)
44	{	46	{
45	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
46	ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = ev_default_loop (0);
47		49
48	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
49	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
51	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
60		62
61	// unloop was called, so exit	63	// unloop was called, so exit
62	return 0;	64	return 0;
63	}	65	}
64		66
65	=head1 DESCRIPTION	67	=head1 ABOUT THIS DOCUMENT
		68
		69	This document documents the libev software package.
66		70
67	The newest version of this document is also available as an html-formatted	71	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	72	web page you might find easier to navigate when reading it for the first
69	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.	73	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
		74
		75	While this document tries to be as complete as possible in documenting
		76	libev, its usage and the rationale behind its design, it is not a tutorial
		77	on event-based programming, nor will it introduce event-based programming
		78	with libev.
		79
		80	Familarity with event based programming techniques in general is assumed
		81	throughout this document.
		82
		83	=head1 ABOUT LIBEV
70		84
71	Libev is an event loop: you register interest in certain events (such as a	85	Libev is an event loop: you register interest in certain events (such as a
72	file descriptor being readable or a timeout occurring), and it will manage	86	file descriptor being readable or a timeout occurring), and it will manage
73	these event sources and provide your program with events.	87	these event sources and provide your program with events.
74		88
…		…
108	name C<loop> (which is always of type C<ev_loop *>) will not have	122	name C<loop> (which is always of type C<ev_loop *>) will not have
109	this argument.	123	this argument.
110		124
111	=head2 TIME REPRESENTATION	125	=head2 TIME REPRESENTATION
112		126
113	Libev represents time as a single floating point number, representing the	127	Libev represents time as a single floating point number, representing
114	(fractional) number of seconds since the (POSIX) epoch (somewhere near	128	the (fractional) number of seconds since the (POSIX) epoch (somewhere
115	the beginning of 1970, details are complicated, don't ask). This type is	129	near the beginning of 1970, details are complicated, don't ask). This
116	called C<ev_tstamp>, which is what you should use too. It usually aliases	130	type is called C<ev_tstamp>, which is what you should use too. It usually
117	to the C<double> type in C, and when you need to do any calculations on	131	aliases to the C<double> type in C. When you need to do any calculations
118	it, you should treat it as some floating point value. Unlike the name	132	on it, you should treat it as some floating point value. Unlike the name
119	component C<stamp> might indicate, it is also used for time differences	133	component C<stamp> might indicate, it is also used for time differences
120	throughout libev.	134	throughout libev.
121		135
122	=head1 ERROR HANDLING	136	=head1 ERROR HANDLING
123		137
…		…
276		290
277	=back	291	=back
278		292
279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	293	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
280		294
281	An event loop is described by a C<ev_loop *>. The library knows two	295	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	296	is I<not> optional in this case, as there is also an C<ev_loop>
283	events, and dynamically created loops which do not.	297	I<function>).
		298
		299	The library knows two types of such loops, the I<default> loop, which
		300	supports signals and child events, and dynamically created loops which do
		301	not.
284		302
285	=over 4	303	=over 4
286		304
287	=item struct ev_loop *ev_default_loop (unsigned int flags)	305	=item struct ev_loop *ev_default_loop (unsigned int flags)
288		306
…		…
294	If you don't know what event loop to use, use the one returned from this	312	If you don't know what event loop to use, use the one returned from this
295	function.	313	function.
296		314
297	Note that this function is I<not> thread-safe, so if you want to use it	315	Note that this function is I<not> thread-safe, so if you want to use it
298	from multiple threads, you have to lock (note also that this is unlikely,	316	from multiple threads, you have to lock (note also that this is unlikely,
299	as loops cannot bes hared easily between threads anyway).	317	as loops cannot be shared easily between threads anyway).
300		318
301	The default loop is the only loop that can handle C<ev_signal> and	319	The default loop is the only loop that can handle C<ev_signal> and
302	C<ev_child> watchers, and to do this, it always registers a handler	320	C<ev_child> watchers, and to do this, it always registers a handler
303	for C<SIGCHLD>. If this is a problem for your application you can either	321	for C<SIGCHLD>. If this is a problem for your application you can either
304	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	322	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
…		…
380	=item C<EVBACKEND_EPOLL> (value 4, Linux)	398	=item C<EVBACKEND_EPOLL> (value 4, Linux)
381		399
382	For few fds, this backend is a bit little slower than poll and select,	400	For few fds, this backend is a bit little slower than poll and select,
383	but it scales phenomenally better. While poll and select usually scale	401	but it scales phenomenally better. While poll and select usually scale
384	like O(total_fds) where n is the total number of fds (or the highest fd),	402	like O(total_fds) where n is the total number of fds (or the highest fd),
385	epoll scales either O(1) or O(active_fds). The epoll design has a number	403	epoll scales either O(1) or O(active_fds).
386	of shortcomings, such as silently dropping events in some hard-to-detect	404
387	cases and requiring a system call per fd change, no fork support and bad	405	The epoll mechanism deserves honorable mention as the most misdesigned
388	support for dup.	406	of the more advanced event mechanisms: mere annoyances include silently
		407	dropping file descriptors, requiring a system call per change per file
		408	descriptor (and unnecessary guessing of parameters), problems with dup and
		409	so on. The biggest issue is fork races, however - if a program forks then
		410	I<both> parent and child process have to recreate the epoll set, which can
		411	take considerable time (one syscall per file descriptor) and is of course
		412	hard to detect.
		413
		414	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		415	of course I<doesn't>, and epoll just loves to report events for totally
		416	I<different> file descriptors (even already closed ones, so one cannot
		417	even remove them from the set) than registered in the set (especially
		418	on SMP systems). Libev tries to counter these spurious notifications by
		419	employing an additional generation counter and comparing that against the
		420	events to filter out spurious ones, recreating the set when required.
389		421
390	While stopping, setting and starting an I/O watcher in the same iteration	422	While stopping, setting and starting an I/O watcher in the same iteration
391	will result in some caching, there is still a system call per such incident	423	will result in some caching, there is still a system call per such
392	(because the fd could point to a different file description now), so its	424	incident (because the same I<file descriptor> could point to a different
393	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	425	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
394	very well if you register events for both fds.	426	file descriptors might not work very well if you register events for both
395		427	file descriptors.
396	Please note that epoll sometimes generates spurious notifications, so you
397	need to use non-blocking I/O or other means to avoid blocking when no data
398	(or space) is available.
399		428
400	Best performance from this backend is achieved by not unregistering all	429	Best performance from this backend is achieved by not unregistering all
401	watchers for a file descriptor until it has been closed, if possible,	430	watchers for a file descriptor until it has been closed, if possible,
402	i.e. keep at least one watcher active per fd at all times. Stopping and	431	i.e. keep at least one watcher active per fd at all times. Stopping and
403	starting a watcher (without re-setting it) also usually doesn't cause	432	starting a watcher (without re-setting it) also usually doesn't cause
404	extra overhead.	433	extra overhead. A fork can both result in spurious notifications as well
		434	as in libev having to destroy and recreate the epoll object, which can
		435	take considerable time and thus should be avoided.
		436
		437	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		438	faster than epoll for maybe up to a hundred file descriptors, depending on
		439	the usage. So sad.
405		440
406	While nominally embeddable in other event loops, this feature is broken in	441	While nominally embeddable in other event loops, this feature is broken in
407	all kernel versions tested so far.	442	all kernel versions tested so far.
408		443
409	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	444	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
410	C<EVBACKEND_POLL>.	445	C<EVBACKEND_POLL>.
411		446
412	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	447	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
413		448
414	Kqueue deserves special mention, as at the time of this writing, it was	449	Kqueue deserves special mention, as at the time of this writing, it
415	broken on all BSDs except NetBSD (usually it doesn't work reliably with	450	was broken on all BSDs except NetBSD (usually it doesn't work reliably
416	anything but sockets and pipes, except on Darwin, where of course it's	451	with anything but sockets and pipes, except on Darwin, where of course
417	completely useless). For this reason it's not being "auto-detected" unless	452	it's completely useless). Unlike epoll, however, whose brokenness
418	you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or	453	is by design, these kqueue bugs can (and eventually will) be fixed
419	libev was compiled on a known-to-be-good (-enough) system like NetBSD.	454	without API changes to existing programs. For this reason it's not being
		455	"auto-detected" unless you explicitly specify it in the flags (i.e. using
		456	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		457	system like NetBSD.
420		458
421	You still can embed kqueue into a normal poll or select backend and use it	459	You still can embed kqueue into a normal poll or select backend and use it
422	only for sockets (after having made sure that sockets work with kqueue on	460	only for sockets (after having made sure that sockets work with kqueue on
423	the target platform). See C<ev_embed> watchers for more info.	461	the target platform). See C<ev_embed> watchers for more info.
424		462
425	It scales in the same way as the epoll backend, but the interface to the	463	It scales in the same way as the epoll backend, but the interface to the
426	kernel is more efficient (which says nothing about its actual speed, of	464	kernel is more efficient (which says nothing about its actual speed, of
427	course). While stopping, setting and starting an I/O watcher does never	465	course). While stopping, setting and starting an I/O watcher does never
428	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	466	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
429	two event changes per incident. Support for C<fork ()> is very bad and it	467	two event changes per incident. Support for C<fork ()> is very bad (but
430	drops fds silently in similarly hard-to-detect cases.	468	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		469	cases
431		470
432	This backend usually performs well under most conditions.	471	This backend usually performs well under most conditions.
433		472
434	While nominally embeddable in other event loops, this doesn't work	473	While nominally embeddable in other event loops, this doesn't work
435	everywhere, so you might need to test for this. And since it is broken	474	everywhere, so you might need to test for this. And since it is broken
436	almost everywhere, you should only use it when you have a lot of sockets	475	almost everywhere, you should only use it when you have a lot of sockets
437	(for which it usually works), by embedding it into another event loop	476	(for which it usually works), by embedding it into another event loop
438	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it,	477	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
439	using it only for sockets.	478	also broken on OS X)) and, did I mention it, using it only for sockets.
440		479
441	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with	480	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
442	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with	481	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
443	C<NOTE_EOF>.	482	C<NOTE_EOF>.
444		483
…		…
464	might perform better.	503	might perform better.
465		504
466	On the positive side, with the exception of the spurious readiness	505	On the positive side, with the exception of the spurious readiness
467	notifications, this backend actually performed fully to specification	506	notifications, this backend actually performed fully to specification
468	in all tests and is fully embeddable, which is a rare feat among the	507	in all tests and is fully embeddable, which is a rare feat among the
469	OS-specific backends.	508	OS-specific backends (I vastly prefer correctness over speed hacks).
470		509
471	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	510	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
472	C<EVBACKEND_POLL>.	511	C<EVBACKEND_POLL>.
473		512
474	=item C<EVBACKEND_ALL>	513	=item C<EVBACKEND_ALL>
…		…
527	responsibility to either stop all watchers cleanly yourself I<before>	566	responsibility to either stop all watchers cleanly yourself I<before>
528	calling this function, or cope with the fact afterwards (which is usually	567	calling this function, or cope with the fact afterwards (which is usually
529	the easiest thing, you can just ignore the watchers and/or C<free ()> them	568	the easiest thing, you can just ignore the watchers and/or C<free ()> them
530	for example).	569	for example).
531		570
532	Note that certain global state, such as signal state, will not be freed by	571	Note that certain global state, such as signal state (and installed signal
533	this function, and related watchers (such as signal and child watchers)	572	handlers), will not be freed by this function, and related watchers (such
534	would need to be stopped manually.	573	as signal and child watchers) would need to be stopped manually.
535		574
536	In general it is not advisable to call this function except in the	575	In general it is not advisable to call this function except in the
537	rare occasion where you really need to free e.g. the signal handling	576	rare occasion where you really need to free e.g. the signal handling
538	pipe fds. If you need dynamically allocated loops it is better to use	577	pipe fds. If you need dynamically allocated loops it is better to use
539	C<ev_loop_new> and C<ev_loop_destroy>).	578	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
582		621
583	This value can sometimes be useful as a generation counter of sorts (it	622	This value can sometimes be useful as a generation counter of sorts (it
584	"ticks" the number of loop iterations), as it roughly corresponds with	623	"ticks" the number of loop iterations), as it roughly corresponds with
585	C<ev_prepare> and C<ev_check> calls.	624	C<ev_prepare> and C<ev_check> calls.
586		625
		626	=item unsigned int ev_loop_depth (loop)
		627
		628	Returns the number of times C<ev_loop> was entered minus the number of
		629	times C<ev_loop> was exited, in other words, the recursion depth.
		630
		631	Outside C<ev_loop>, this number is zero. In a callback, this number is
		632	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
		633	in which case it is higher.
		634
		635	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
		636	etc.), doesn't count as exit.
		637
587	=item unsigned int ev_backend (loop)	638	=item unsigned int ev_backend (loop)
588		639
589	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	640	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
590	use.	641	use.
591		642
…		…
605		656
606	This function is rarely useful, but when some event callback runs for a	657	This function is rarely useful, but when some event callback runs for a
607	very long time without entering the event loop, updating libev's idea of	658	very long time without entering the event loop, updating libev's idea of
608	the current time is a good idea.	659	the current time is a good idea.
609		660
610	See also "The special problem of time updates" in the C<ev_timer> section.	661	See also L<The special problem of time updates> in the C<ev_timer> section.
		662
		663	=item ev_suspend (loop)
		664
		665	=item ev_resume (loop)
		666
		667	These two functions suspend and resume a loop, for use when the loop is
		668	not used for a while and timeouts should not be processed.
		669
		670	A typical use case would be an interactive program such as a game: When
		671	the user presses C<^Z> to suspend the game and resumes it an hour later it
		672	would be best to handle timeouts as if no time had actually passed while
		673	the program was suspended. This can be achieved by calling C<ev_suspend>
		674	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		675	C<ev_resume> directly afterwards to resume timer processing.
		676
		677	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		678	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		679	will be rescheduled (that is, they will lose any events that would have
		680	occured while suspended).
		681
		682	After calling C<ev_suspend> you B<must not> call I<any> function on the
		683	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		684	without a previous call to C<ev_suspend>.
		685
		686	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		687	event loop time (see C<ev_now_update>).
611		688
612	=item ev_loop (loop, int flags)	689	=item ev_loop (loop, int flags)
613		690
614	Finally, this is it, the event handler. This function usually is called	691	Finally, this is it, the event handler. This function usually is called
615	after you initialised all your watchers and you want to start handling	692	after you initialised all your watchers and you want to start handling
…		…
631	the loop.	708	the loop.
632		709
633	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	710	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
634	necessary) and will handle those and any already outstanding ones. It	711	necessary) and will handle those and any already outstanding ones. It
635	will block your process until at least one new event arrives (which could	712	will block your process until at least one new event arrives (which could
636	be an event internal to libev itself, so there is no guarentee that a	713	be an event internal to libev itself, so there is no guarantee that a
637	user-registered callback will be called), and will return after one	714	user-registered callback will be called), and will return after one
638	iteration of the loop.	715	iteration of the loop.
639		716
640	This is useful if you are waiting for some external event in conjunction	717	This is useful if you are waiting for some external event in conjunction
641	with something not expressible using other libev watchers (i.e. "roll your	718	with something not expressible using other libev watchers (i.e. "roll your
…		…
699		776
700	If you have a watcher you never unregister that should not keep C<ev_loop>	777	If you have a watcher you never unregister that should not keep C<ev_loop>
701	from returning, call ev_unref() after starting, and ev_ref() before	778	from returning, call ev_unref() after starting, and ev_ref() before
702	stopping it.	779	stopping it.
703		780
704	As an example, libev itself uses this for its internal signal pipe: It is	781	As an example, libev itself uses this for its internal signal pipe: It
705	not visible to the libev user and should not keep C<ev_loop> from exiting	782	is not visible to the libev user and should not keep C<ev_loop> from
706	if no event watchers registered by it are active. It is also an excellent	783	exiting if no event watchers registered by it are active. It is also an
707	way to do this for generic recurring timers or from within third-party	784	excellent way to do this for generic recurring timers or from within
708	libraries. Just remember to I<unref after start> and I<ref before stop>	785	third-party libraries. Just remember to I<unref after start> and I<ref
709	(but only if the watcher wasn't active before, or was active before,	786	before stop> (but only if the watcher wasn't active before, or was active
710	respectively).	787	before, respectively. Note also that libev might stop watchers itself
		788	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		789	in the callback).
711		790
712	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	791	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
713	running when nothing else is active.	792	running when nothing else is active.
714		793
715	ev_signal exitsig;	794	ev_signal exitsig;
…		…
744		823
745	By setting a higher I<io collect interval> you allow libev to spend more	824	By setting a higher I<io collect interval> you allow libev to spend more
746	time collecting I/O events, so you can handle more events per iteration,	825	time collecting I/O events, so you can handle more events per iteration,
747	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	826	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
748	C<ev_timer>) will be not affected. Setting this to a non-null value will	827	C<ev_timer>) will be not affected. Setting this to a non-null value will
749	introduce an additional C<ev_sleep ()> call into most loop iterations.	828	introduce an additional C<ev_sleep ()> call into most loop iterations. The
		829	sleep time ensures that libev will not poll for I/O events more often then
		830	once per this interval, on average.
750		831
751	Likewise, by setting a higher I<timeout collect interval> you allow libev	832	Likewise, by setting a higher I<timeout collect interval> you allow libev
752	to spend more time collecting timeouts, at the expense of increased	833	to spend more time collecting timeouts, at the expense of increased
753	latency/jitter/inexactness (the watcher callback will be called	834	latency/jitter/inexactness (the watcher callback will be called
754	later). C<ev_io> watchers will not be affected. Setting this to a non-null	835	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
756		837
757	Many (busy) programs can usually benefit by setting the I/O collect	838	Many (busy) programs can usually benefit by setting the I/O collect
758	interval to a value near C<0.1> or so, which is often enough for	839	interval to a value near C<0.1> or so, which is often enough for
759	interactive servers (of course not for games), likewise for timeouts. It	840	interactive servers (of course not for games), likewise for timeouts. It
760	usually doesn't make much sense to set it to a lower value than C<0.01>,	841	usually doesn't make much sense to set it to a lower value than C<0.01>,
761	as this approaches the timing granularity of most systems.	842	as this approaches the timing granularity of most systems. Note that if
		843	you do transactions with the outside world and you can't increase the
		844	parallelity, then this setting will limit your transaction rate (if you
		845	need to poll once per transaction and the I/O collect interval is 0.01,
		846	then you can't do more than 100 transations per second).
762		847
763	Setting the I<timeout collect interval> can improve the opportunity for	848	Setting the I<timeout collect interval> can improve the opportunity for
764	saving power, as the program will "bundle" timer callback invocations that	849	saving power, as the program will "bundle" timer callback invocations that
765	are "near" in time together, by delaying some, thus reducing the number of	850	are "near" in time together, by delaying some, thus reducing the number of
766	times the process sleeps and wakes up again. Another useful technique to	851	times the process sleeps and wakes up again. Another useful technique to
767	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure	852	reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
768	they fire on, say, one-second boundaries only.	853	they fire on, say, one-second boundaries only.
769		854
		855	Example: we only need 0.1s timeout granularity, and we wish not to poll
		856	more often than 100 times per second:
		857
		858	ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
		859	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
		860
770	=item ev_loop_verify (loop)	861	=item ev_loop_verify (loop)
771		862
772	This function only does something when C<EV_VERIFY> support has been	863	This function only does something when C<EV_VERIFY> support has been
773	compiled in. which is the default for non-minimal builds. It tries to go	864	compiled in, which is the default for non-minimal builds. It tries to go
774	through all internal structures and checks them for validity. If anything	865	through all internal structures and checks them for validity. If anything
775	is found to be inconsistent, it will print an error message to standard	866	is found to be inconsistent, it will print an error message to standard
776	error and call C<abort ()>.	867	error and call C<abort ()>.
777		868
778	This can be used to catch bugs inside libev itself: under normal	869	This can be used to catch bugs inside libev itself: under normal
…		…
781		872
782	=back	873	=back
783		874
784		875
785	=head1 ANATOMY OF A WATCHER	876	=head1 ANATOMY OF A WATCHER
		877
		878	In the following description, uppercase C<TYPE> in names stands for the
		879	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		880	watchers and C<ev_io_start> for I/O watchers.
786		881
787	A watcher is a structure that you create and register to record your	882	A watcher is a structure that you create and register to record your
788	interest in some event. For instance, if you want to wait for STDIN to	883	interest in some event. For instance, if you want to wait for STDIN to
789	become readable, you would create an C<ev_io> watcher for that:	884	become readable, you would create an C<ev_io> watcher for that:
790		885
…		…
793	ev_io_stop (w);	888	ev_io_stop (w);
794	ev_unloop (loop, EVUNLOOP_ALL);	889	ev_unloop (loop, EVUNLOOP_ALL);
795	}	890	}
796		891
797	struct ev_loop *loop = ev_default_loop (0);	892	struct ev_loop *loop = ev_default_loop (0);
		893
798	ev_io stdin_watcher;	894	ev_io stdin_watcher;
		895
799	ev_init (&stdin_watcher, my_cb);	896	ev_init (&stdin_watcher, my_cb);
800	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	897	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
801	ev_io_start (loop, &stdin_watcher);	898	ev_io_start (loop, &stdin_watcher);
		899
802	ev_loop (loop, 0);	900	ev_loop (loop, 0);
803		901
804	As you can see, you are responsible for allocating the memory for your	902	As you can see, you are responsible for allocating the memory for your
805	watcher structures (and it is usually a bad idea to do this on the stack,	903	watcher structures (and it is I<usually> a bad idea to do this on the
806	although this can sometimes be quite valid).	904	stack).
		905
		906	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		907	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
807		908
808	Each watcher structure must be initialised by a call to C<ev_init	909	Each watcher structure must be initialised by a call to C<ev_init
809	(watcher *, callback)>, which expects a callback to be provided. This	910	(watcher *, callback)>, which expects a callback to be provided. This
810	callback gets invoked each time the event occurs (or, in the case of I/O	911	callback gets invoked each time the event occurs (or, in the case of I/O
811	watchers, each time the event loop detects that the file descriptor given	912	watchers, each time the event loop detects that the file descriptor given
812	is readable and/or writable).	913	is readable and/or writable).
813		914
814	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	915	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
815	with arguments specific to this watcher type. There is also a macro	916	macro to configure it, with arguments specific to the watcher type. There
816	to combine initialisation and setting in one call: C<< ev_<type>_init	917	is also a macro to combine initialisation and setting in one call: C<<
817	(watcher *, callback, ...) >>.	918	ev_TYPE_init (watcher *, callback, ...) >>.
818		919
819	To make the watcher actually watch out for events, you have to start it	920	To make the watcher actually watch out for events, you have to start it
820	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	921	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
821	*) >>), and you can stop watching for events at any time by calling the	922	*) >>), and you can stop watching for events at any time by calling the
822	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	923	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
823		924
824	As long as your watcher is active (has been started but not stopped) you	925	As long as your watcher is active (has been started but not stopped) you
825	must not touch the values stored in it. Most specifically you must never	926	must not touch the values stored in it. Most specifically you must never
826	reinitialise it or call its C<set> macro.	927	reinitialise it or call its C<ev_TYPE_set> macro.
827		928
828	Each and every callback receives the event loop pointer as first, the	929	Each and every callback receives the event loop pointer as first, the
829	registered watcher structure as second, and a bitset of received events as	930	registered watcher structure as second, and a bitset of received events as
830	third argument.	931	third argument.
831		932
…		…
889		990
890	=item C<EV_ASYNC>	991	=item C<EV_ASYNC>
891		992
892	The given async watcher has been asynchronously notified (see C<ev_async>).	993	The given async watcher has been asynchronously notified (see C<ev_async>).
893		994
		995	=item C<EV_CUSTOM>
		996
		997	Not ever sent (or otherwise used) by libev itself, but can be freely used
		998	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		999
894	=item C<EV_ERROR>	1000	=item C<EV_ERROR>
895		1001
896	An unspecified error has occurred, the watcher has been stopped. This might	1002	An unspecified error has occurred, the watcher has been stopped. This might
897	happen because the watcher could not be properly started because libev	1003	happen because the watcher could not be properly started because libev
898	ran out of memory, a file descriptor was found to be closed or any other	1004	ran out of memory, a file descriptor was found to be closed or any other
…		…
912		1018
913	=back	1019	=back
914		1020
915	=head2 GENERIC WATCHER FUNCTIONS	1021	=head2 GENERIC WATCHER FUNCTIONS
916		1022
917	In the following description, C<TYPE> stands for the watcher type,
918	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
919
920	=over 4	1023	=over 4
921		1024
922	=item C<ev_init> (ev_TYPE *watcher, callback)	1025	=item C<ev_init> (ev_TYPE *watcher, callback)
923		1026
924	This macro initialises the generic portion of a watcher. The contents	1027	This macro initialises the generic portion of a watcher. The contents
…		…
1016	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1119	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1017	(default: C<-2>). Pending watchers with higher priority will be invoked	1120	(default: C<-2>). Pending watchers with higher priority will be invoked
1018	before watchers with lower priority, but priority will not keep watchers	1121	before watchers with lower priority, but priority will not keep watchers
1019	from being executed (except for C<ev_idle> watchers).	1122	from being executed (except for C<ev_idle> watchers).
1020		1123
1021	This means that priorities are I<only> used for ordering callback
1022	invocation after new events have been received. This is useful, for
1023	example, to reduce latency after idling, or more often, to bind two
1024	watchers on the same event and make sure one is called first.
1025
1026	If you need to suppress invocation when higher priority events are pending	1124	If you need to suppress invocation when higher priority events are pending
1027	you need to look at C<ev_idle> watchers, which provide this functionality.	1125	you need to look at C<ev_idle> watchers, which provide this functionality.
1028		1126
1029	You I<must not> change the priority of a watcher as long as it is active or	1127	You I<must not> change the priority of a watcher as long as it is active or
1030	pending.	1128	pending.
1031		1129
		1130	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1131	fine, as long as you do not mind that the priority value you query might
		1132	or might not have been clamped to the valid range.
		1133
1032	The default priority used by watchers when no priority has been set is	1134	The default priority used by watchers when no priority has been set is
1033	always C<0>, which is supposed to not be too high and not be too low :).	1135	always C<0>, which is supposed to not be too high and not be too low :).
1034		1136
1035	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1137	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1036	fine, as long as you do not mind that the priority value you query might	1138	priorities.
1037	or might not have been adjusted to be within valid range.
1038		1139
1039	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1140	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1040		1141
1041	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1142	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1042	C<loop> nor C<revents> need to be valid as long as the watcher callback	1143	C<loop> nor C<revents> need to be valid as long as the watcher callback
…		…
1107	#include <stddef.h>	1208	#include <stddef.h>
1108		1209
1109	static void	1210	static void
1110	t1_cb (EV_P_ ev_timer *w, int revents)	1211	t1_cb (EV_P_ ev_timer *w, int revents)
1111	{	1212	{
1112	struct my_biggy big = (struct my_biggy *	1213	struct my_biggy big = (struct my_biggy *)
1113	(((char *)w) - offsetof (struct my_biggy, t1));	1214	(((char *)w) - offsetof (struct my_biggy, t1));
1114	}	1215	}
1115		1216
1116	static void	1217	static void
1117	t2_cb (EV_P_ ev_timer *w, int revents)	1218	t2_cb (EV_P_ ev_timer *w, int revents)
1118	{	1219	{
1119	struct my_biggy big = (struct my_biggy *	1220	struct my_biggy big = (struct my_biggy *)
1120	(((char *)w) - offsetof (struct my_biggy, t2));	1221	(((char *)w) - offsetof (struct my_biggy, t2));
1121	}	1222	}
		1223
		1224	=head2 WATCHER PRIORITY MODELS
		1225
		1226	Many event loops support I<watcher priorities>, which are usually small
		1227	integers that influence the ordering of event callback invocation
		1228	between watchers in some way, all else being equal.
		1229
		1230	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1231	description for the more technical details such as the actual priority
		1232	range.
		1233
		1234	There are two common ways how these these priorities are being interpreted
		1235	by event loops:
		1236
		1237	In the more common lock-out model, higher priorities "lock out" invocation
		1238	of lower priority watchers, which means as long as higher priority
		1239	watchers receive events, lower priority watchers are not being invoked.
		1240
		1241	The less common only-for-ordering model uses priorities solely to order
		1242	callback invocation within a single event loop iteration: Higher priority
		1243	watchers are invoked before lower priority ones, but they all get invoked
		1244	before polling for new events.
		1245
		1246	Libev uses the second (only-for-ordering) model for all its watchers
		1247	except for idle watchers (which use the lock-out model).
		1248
		1249	The rationale behind this is that implementing the lock-out model for
		1250	watchers is not well supported by most kernel interfaces, and most event
		1251	libraries will just poll for the same events again and again as long as
		1252	their callbacks have not been executed, which is very inefficient in the
		1253	common case of one high-priority watcher locking out a mass of lower
		1254	priority ones.
		1255
		1256	Static (ordering) priorities are most useful when you have two or more
		1257	watchers handling the same resource: a typical usage example is having an
		1258	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1259	timeouts. Under load, data might be received while the program handles
		1260	other jobs, but since timers normally get invoked first, the timeout
		1261	handler will be executed before checking for data. In that case, giving
		1262	the timer a lower priority than the I/O watcher ensures that I/O will be
		1263	handled first even under adverse conditions (which is usually, but not
		1264	always, what you want).
		1265
		1266	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1267	will only be executed when no same or higher priority watchers have
		1268	received events, they can be used to implement the "lock-out" model when
		1269	required.
		1270
		1271	For example, to emulate how many other event libraries handle priorities,
		1272	you can associate an C<ev_idle> watcher to each such watcher, and in
		1273	the normal watcher callback, you just start the idle watcher. The real
		1274	processing is done in the idle watcher callback. This causes libev to
		1275	continously poll and process kernel event data for the watcher, but when
		1276	the lock-out case is known to be rare (which in turn is rare :), this is
		1277	workable.
		1278
		1279	Usually, however, the lock-out model implemented that way will perform
		1280	miserably under the type of load it was designed to handle. In that case,
		1281	it might be preferable to stop the real watcher before starting the
		1282	idle watcher, so the kernel will not have to process the event in case
		1283	the actual processing will be delayed for considerable time.
		1284
		1285	Here is an example of an I/O watcher that should run at a strictly lower
		1286	priority than the default, and which should only process data when no
		1287	other events are pending:
		1288
		1289	ev_idle idle; // actual processing watcher
		1290	ev_io io; // actual event watcher
		1291
		1292	static void
		1293	io_cb (EV_P_ ev_io *w, int revents)
		1294	{
		1295	// stop the I/O watcher, we received the event, but
		1296	// are not yet ready to handle it.
		1297	ev_io_stop (EV_A_ w);
		1298
		1299	// start the idle watcher to ahndle the actual event.
		1300	// it will not be executed as long as other watchers
		1301	// with the default priority are receiving events.
		1302	ev_idle_start (EV_A_ &idle);
		1303	}
		1304
		1305	static void
		1306	idle_cb (EV_P_ ev_idle *w, int revents)
		1307	{
		1308	// actual processing
		1309	read (STDIN_FILENO, ...);
		1310
		1311	// have to start the I/O watcher again, as
		1312	// we have handled the event
		1313	ev_io_start (EV_P_ &io);
		1314	}
		1315
		1316	// initialisation
		1317	ev_idle_init (&idle, idle_cb);
		1318	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1319	ev_io_start (EV_DEFAULT_ &io);
		1320
		1321	In the "real" world, it might also be beneficial to start a timer, so that
		1322	low-priority connections can not be locked out forever under load. This
		1323	enables your program to keep a lower latency for important connections
		1324	during short periods of high load, while not completely locking out less
		1325	important ones.
1122		1326
1123		1327
1124	=head1 WATCHER TYPES	1328	=head1 WATCHER TYPES
1125		1329
1126	This section describes each watcher in detail, but will not repeat	1330	This section describes each watcher in detail, but will not repeat
…		…
1152	descriptors to non-blocking mode is also usually a good idea (but not	1356	descriptors to non-blocking mode is also usually a good idea (but not
1153	required if you know what you are doing).	1357	required if you know what you are doing).
1154		1358
1155	If you cannot use non-blocking mode, then force the use of a	1359	If you cannot use non-blocking mode, then force the use of a
1156	known-to-be-good backend (at the time of this writing, this includes only	1360	known-to-be-good backend (at the time of this writing, this includes only
1157	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).	1361	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
		1362	descriptors for which non-blocking operation makes no sense (such as
		1363	files) - libev doesn't guarentee any specific behaviour in that case.
1158		1364
1159	Another thing you have to watch out for is that it is quite easy to	1365	Another thing you have to watch out for is that it is quite easy to
1160	receive "spurious" readiness notifications, that is your callback might	1366	receive "spurious" readiness notifications, that is your callback might
1161	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1367	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1162	because there is no data. Not only are some backends known to create a	1368	because there is no data. Not only are some backends known to create a
…		…
1283	year, it will still time out after (roughly) one hour. "Roughly" because	1489	year, it will still time out after (roughly) one hour. "Roughly" because
1284	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1490	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1285	monotonic clock option helps a lot here).	1491	monotonic clock option helps a lot here).
1286		1492
1287	The callback is guaranteed to be invoked only I<after> its timeout has	1493	The callback is guaranteed to be invoked only I<after> its timeout has
1288	passed, but if multiple timers become ready during the same loop iteration	1494	passed (not I<at>, so on systems with very low-resolution clocks this
1289	then order of execution is undefined.	1495	might introduce a small delay). If multiple timers become ready during the
		1496	same loop iteration then the ones with earlier time-out values are invoked
		1497	before ones with later time-out values (but this is no longer true when a
		1498	callback calls C<ev_loop> recursively).
1290		1499
1291	=head3 Be smart about timeouts	1500	=head3 Be smart about timeouts
1292		1501
1293	Many real-world problems involve some kind of timeout, usually for error	1502	Many real-world problems involve some kind of timeout, usually for error
1294	recovery. A typical example is an HTTP request - if the other side hangs,	1503	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1338	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>	1547	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1339	member and C<ev_timer_again>.	1548	member and C<ev_timer_again>.
1340		1549
1341	At start:	1550	At start:
1342		1551
1343	ev_timer_init (timer, callback);	1552	ev_init (timer, callback);
1344	timer->repeat = 60.;	1553	timer->repeat = 60.;
1345	ev_timer_again (loop, timer);	1554	ev_timer_again (loop, timer);
1346		1555
1347	Each time there is some activity:	1556	Each time there is some activity:
1348		1557
…		…
1387	else	1596	else
1388	{	1597	{
1389	// callback was invoked, but there was some activity, re-arm	1598	// callback was invoked, but there was some activity, re-arm
1390	// the watcher to fire in last_activity + 60, which is	1599	// the watcher to fire in last_activity + 60, which is
1391	// guaranteed to be in the future, so "again" is positive:	1600	// guaranteed to be in the future, so "again" is positive:
1392	w->again = timeout - now;	1601	w->repeat = timeout - now;
1393	ev_timer_again (EV_A_ w);	1602	ev_timer_again (EV_A_ w);
1394	}	1603	}
1395	}	1604	}
1396		1605
1397	To summarise the callback: first calculate the real timeout (defined	1606	To summarise the callback: first calculate the real timeout (defined
…		…
1410		1619
1411	To start the timer, simply initialise the watcher and set C<last_activity>	1620	To start the timer, simply initialise the watcher and set C<last_activity>
1412	to the current time (meaning we just have some activity :), then call the	1621	to the current time (meaning we just have some activity :), then call the
1413	callback, which will "do the right thing" and start the timer:	1622	callback, which will "do the right thing" and start the timer:
1414		1623
1415	ev_timer_init (timer, callback);	1624	ev_init (timer, callback);
1416	last_activity = ev_now (loop);	1625	last_activity = ev_now (loop);
1417	callback (loop, timer, EV_TIMEOUT);	1626	callback (loop, timer, EV_TIMEOUT);
1418		1627
1419	And when there is some activity, simply store the current time in	1628	And when there is some activity, simply store the current time in
1420	C<last_activity>, no libev calls at all:	1629	C<last_activity>, no libev calls at all:
…		…
1426		1635
1427	Changing the timeout is trivial as well (if it isn't hard-coded in the	1636	Changing the timeout is trivial as well (if it isn't hard-coded in the
1428	callback :) - just change the timeout and invoke the callback, which will	1637	callback :) - just change the timeout and invoke the callback, which will
1429	fix things for you.	1638	fix things for you.
1430		1639
1431	=item 4. Whee, use a double-linked list for your timeouts.	1640	=item 4. Wee, just use a double-linked list for your timeouts.
1432		1641
1433	If there is not one request, but many thousands, all employing some kind	1642	If there is not one request, but many thousands (millions...), all
1434	of timeout with the same timeout value, then one can do even better:	1643	employing some kind of timeout with the same timeout value, then one can
		1644	do even better:
1435		1645
1436	When starting the timeout, calculate the timeout value and put the timeout	1646	When starting the timeout, calculate the timeout value and put the timeout
1437	at the I<end> of the list.	1647	at the I<end> of the list.
1438		1648
1439	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of	1649	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
…		…
1448	complication, and having to use a constant timeout. The constant timeout	1658	complication, and having to use a constant timeout. The constant timeout
1449	ensures that the list stays sorted.	1659	ensures that the list stays sorted.
1450		1660
1451	=back	1661	=back
1452		1662
1453	So what method is the best?	1663	So which method the best?
1454		1664
1455	The method #2 is a simple no-brain-required solution that is adequate in	1665	Method #2 is a simple no-brain-required solution that is adequate in most
1456	most situations. Method #3 requires a bit more thinking, but handles many	1666	situations. Method #3 requires a bit more thinking, but handles many cases
1457	cases better, and isn't very complicated either. In most case, choosing	1667	better, and isn't very complicated either. In most case, choosing either
1458	either one is fine.	1668	one is fine, with #3 being better in typical situations.
1459		1669
1460	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1670	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1461	rather complicated, but extremely efficient, something that really pays	1671	rather complicated, but extremely efficient, something that really pays
1462	off after the first or so million of active timers, i.e. it's usually	1672	off after the first million or so of active timers, i.e. it's usually
1463	overkill :)	1673	overkill :)
1464		1674
1465	=head3 The special problem of time updates	1675	=head3 The special problem of time updates
1466		1676
1467	Establishing the current time is a costly operation (it usually takes at	1677	Establishing the current time is a costly operation (it usually takes at
…		…
1512	If the timer is started but non-repeating, stop it (as if it timed out).	1722	If the timer is started but non-repeating, stop it (as if it timed out).
1513		1723
1514	If the timer is repeating, either start it if necessary (with the	1724	If the timer is repeating, either start it if necessary (with the
1515	C<repeat> value), or reset the running timer to the C<repeat> value.	1725	C<repeat> value), or reset the running timer to the C<repeat> value.
1516		1726
1517	This sounds a bit complicated, see "Be smart about timeouts", above, for a	1727	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1518	usage example.	1728	usage example.
1519		1729
1520	=item ev_tstamp repeat [read-write]	1730	=item ev_tstamp repeat [read-write]
1521		1731
1522	The current C<repeat> value. Will be used each time the watcher times out	1732	The current C<repeat> value. Will be used each time the watcher times out
…		…
1561	=head2 C<ev_periodic> - to cron or not to cron?	1771	=head2 C<ev_periodic> - to cron or not to cron?
1562		1772
1563	Periodic watchers are also timers of a kind, but they are very versatile	1773	Periodic watchers are also timers of a kind, but they are very versatile
1564	(and unfortunately a bit complex).	1774	(and unfortunately a bit complex).
1565		1775
1566	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1776	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1567	but on wall clock time (absolute time). You can tell a periodic watcher	1777	relative time, the physical time that passes) but on wall clock time
1568	to trigger after some specific point in time. For example, if you tell a	1778	(absolute time, the thing you can read on your calender or clock). The
1569	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()	1779	difference is that wall clock time can run faster or slower than real
1570	+ 10.>, that is, an absolute time not a delay) and then reset your system	1780	time, and time jumps are not uncommon (e.g. when you adjust your
1571	clock to January of the previous year, then it will take more than year	1781	wrist-watch).
1572	to trigger the event (unlike an C<ev_timer>, which would still trigger
1573	roughly 10 seconds later as it uses a relative timeout).
1574		1782
		1783	You can tell a periodic watcher to trigger after some specific point
		1784	in time: for example, if you tell a periodic watcher to trigger "in 10
		1785	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1786	not a delay) and then reset your system clock to January of the previous
		1787	year, then it will take a year or more to trigger the event (unlike an
		1788	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1789	it, as it uses a relative timeout).
		1790
1575	C<ev_periodic>s can also be used to implement vastly more complex timers,	1791	C<ev_periodic> watchers can also be used to implement vastly more complex
1576	such as triggering an event on each "midnight, local time", or other	1792	timers, such as triggering an event on each "midnight, local time", or
1577	complicated rules.	1793	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1794	those cannot react to time jumps.
1578		1795
1579	As with timers, the callback is guaranteed to be invoked only when the	1796	As with timers, the callback is guaranteed to be invoked only when the
1580	time (C<at>) has passed, but if multiple periodic timers become ready	1797	point in time where it is supposed to trigger has passed. If multiple
1581	during the same loop iteration, then order of execution is undefined.	1798	timers become ready during the same loop iteration then the ones with
		1799	earlier time-out values are invoked before ones with later time-out values
		1800	(but this is no longer true when a callback calls C<ev_loop> recursively).
1582		1801
1583	=head3 Watcher-Specific Functions and Data Members	1802	=head3 Watcher-Specific Functions and Data Members
1584		1803
1585	=over 4	1804	=over 4
1586		1805
1587	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1806	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1588		1807
1589	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1808	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1590		1809
1591	Lots of arguments, lets sort it out... There are basically three modes of	1810	Lots of arguments, let's sort it out... There are basically three modes of
1592	operation, and we will explain them from simplest to most complex:	1811	operation, and we will explain them from simplest to most complex:
1593		1812
1594	=over 4	1813	=over 4
1595		1814
1596	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1815	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1597		1816
1598	In this configuration the watcher triggers an event after the wall clock	1817	In this configuration the watcher triggers an event after the wall clock
1599	time C<at> has passed. It will not repeat and will not adjust when a time	1818	time C<offset> has passed. It will not repeat and will not adjust when a
1600	jump occurs, that is, if it is to be run at January 1st 2011 then it will	1819	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1601	only run when the system clock reaches or surpasses this time.	1820	will be stopped and invoked when the system clock reaches or surpasses
		1821	this point in time.
1602		1822
1603	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1823	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1604		1824
1605	In this mode the watcher will always be scheduled to time out at the next	1825	In this mode the watcher will always be scheduled to time out at the next
1606	C<at + N * interval> time (for some integer N, which can also be negative)	1826	C<offset + N * interval> time (for some integer N, which can also be
1607	and then repeat, regardless of any time jumps.	1827	negative) and then repeat, regardless of any time jumps. The C<offset>
		1828	argument is merely an offset into the C<interval> periods.
1608		1829
1609	This can be used to create timers that do not drift with respect to the	1830	This can be used to create timers that do not drift with respect to the
1610	system clock, for example, here is a C<ev_periodic> that triggers each	1831	system clock, for example, here is an C<ev_periodic> that triggers each
1611	hour, on the hour:	1832	hour, on the hour (with respect to UTC):
1612		1833
1613	ev_periodic_set (&periodic, 0., 3600., 0);	1834	ev_periodic_set (&periodic, 0., 3600., 0);
1614		1835
1615	This doesn't mean there will always be 3600 seconds in between triggers,	1836	This doesn't mean there will always be 3600 seconds in between triggers,
1616	but only that the callback will be called when the system time shows a	1837	but only that the callback will be called when the system time shows a
1617	full hour (UTC), or more correctly, when the system time is evenly divisible	1838	full hour (UTC), or more correctly, when the system time is evenly divisible
1618	by 3600.	1839	by 3600.
1619		1840
1620	Another way to think about it (for the mathematically inclined) is that	1841	Another way to think about it (for the mathematically inclined) is that
1621	C<ev_periodic> will try to run the callback in this mode at the next possible	1842	C<ev_periodic> will try to run the callback in this mode at the next possible
1622	time where C<time = at (mod interval)>, regardless of any time jumps.	1843	time where C<time = offset (mod interval)>, regardless of any time jumps.
1623		1844
1624	For numerical stability it is preferable that the C<at> value is near	1845	For numerical stability it is preferable that the C<offset> value is near
1625	C<ev_now ()> (the current time), but there is no range requirement for	1846	C<ev_now ()> (the current time), but there is no range requirement for
1626	this value, and in fact is often specified as zero.	1847	this value, and in fact is often specified as zero.
1627		1848
1628	Note also that there is an upper limit to how often a timer can fire (CPU	1849	Note also that there is an upper limit to how often a timer can fire (CPU
1629	speed for example), so if C<interval> is very small then timing stability	1850	speed for example), so if C<interval> is very small then timing stability
1630	will of course deteriorate. Libev itself tries to be exact to be about one	1851	will of course deteriorate. Libev itself tries to be exact to be about one
1631	millisecond (if the OS supports it and the machine is fast enough).	1852	millisecond (if the OS supports it and the machine is fast enough).
1632		1853
1633	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1854	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1634		1855
1635	In this mode the values for C<interval> and C<at> are both being	1856	In this mode the values for C<interval> and C<offset> are both being
1636	ignored. Instead, each time the periodic watcher gets scheduled, the	1857	ignored. Instead, each time the periodic watcher gets scheduled, the
1637	reschedule callback will be called with the watcher as first, and the	1858	reschedule callback will be called with the watcher as first, and the
1638	current time as second argument.	1859	current time as second argument.
1639		1860
1640	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1861	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1641	ever, or make ANY event loop modifications whatsoever>.	1862	or make ANY other event loop modifications whatsoever, unless explicitly
		1863	allowed by documentation here>.
1642		1864
1643	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	1865	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1644	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the	1866	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1645	only event loop modification you are allowed to do).	1867	only event loop modification you are allowed to do).
1646		1868
…		…
1676	a different time than the last time it was called (e.g. in a crond like	1898	a different time than the last time it was called (e.g. in a crond like
1677	program when the crontabs have changed).	1899	program when the crontabs have changed).
1678		1900
1679	=item ev_tstamp ev_periodic_at (ev_periodic *)	1901	=item ev_tstamp ev_periodic_at (ev_periodic *)
1680		1902
1681	When active, returns the absolute time that the watcher is supposed to	1903	When active, returns the absolute time that the watcher is supposed
1682	trigger next.	1904	to trigger next. This is not the same as the C<offset> argument to
		1905	C<ev_periodic_set>, but indeed works even in interval and manual
		1906	rescheduling modes.
1683		1907
1684	=item ev_tstamp offset [read-write]	1908	=item ev_tstamp offset [read-write]
1685		1909
1686	When repeating, this contains the offset value, otherwise this is the	1910	When repeating, this contains the offset value, otherwise this is the
1687	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1911	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1912	although libev might modify this value for better numerical stability).
1688		1913
1689	Can be modified any time, but changes only take effect when the periodic	1914	Can be modified any time, but changes only take effect when the periodic
1690	timer fires or C<ev_periodic_again> is being called.	1915	timer fires or C<ev_periodic_again> is being called.
1691		1916
1692	=item ev_tstamp interval [read-write]	1917	=item ev_tstamp interval [read-write]
…		…
1801	some child status changes (most typically when a child of yours dies or	2026	some child status changes (most typically when a child of yours dies or
1802	exits). It is permissible to install a child watcher I<after> the child	2027	exits). It is permissible to install a child watcher I<after> the child
1803	has been forked (which implies it might have already exited), as long	2028	has been forked (which implies it might have already exited), as long
1804	as the event loop isn't entered (or is continued from a watcher), i.e.,	2029	as the event loop isn't entered (or is continued from a watcher), i.e.,
1805	forking and then immediately registering a watcher for the child is fine,	2030	forking and then immediately registering a watcher for the child is fine,
1806	but forking and registering a watcher a few event loop iterations later is	2031	but forking and registering a watcher a few event loop iterations later or
1807	not.	2032	in the next callback invocation is not.
1808		2033
1809	Only the default event loop is capable of handling signals, and therefore	2034	Only the default event loop is capable of handling signals, and therefore
1810	you can only register child watchers in the default event loop.	2035	you can only register child watchers in the default event loop.
1811		2036
1812	=head3 Process Interaction	2037	=head3 Process Interaction
…		…
1898		2123
1899		2124
1900	=head2 C<ev_stat> - did the file attributes just change?	2125	=head2 C<ev_stat> - did the file attributes just change?
1901		2126
1902	This watches a file system path for attribute changes. That is, it calls	2127	This watches a file system path for attribute changes. That is, it calls
1903	C<stat> regularly (or when the OS says it changed) and sees if it changed	2128	C<stat> on that path in regular intervals (or when the OS says it changed)
1904	compared to the last time, invoking the callback if it did.	2129	and sees if it changed compared to the last time, invoking the callback if
		2130	it did.
1905		2131
1906	The path does not need to exist: changing from "path exists" to "path does	2132	The path does not need to exist: changing from "path exists" to "path does
1907	not exist" is a status change like any other. The condition "path does	2133	not exist" is a status change like any other. The condition "path does not
1908	not exist" is signified by the C<st_nlink> field being zero (which is	2134	exist" (or more correctly "path cannot be stat'ed") is signified by the
1909	otherwise always forced to be at least one) and all the other fields of	2135	C<st_nlink> field being zero (which is otherwise always forced to be at
1910	the stat buffer having unspecified contents.	2136	least one) and all the other fields of the stat buffer having unspecified
		2137	contents.
1911		2138
1912	The path I<should> be absolute and I<must not> end in a slash. If it is	2139	The path I<must not> end in a slash or contain special components such as
		2140	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1913	relative and your working directory changes, the behaviour is undefined.	2141	your working directory changes, then the behaviour is undefined.
1914		2142
1915	Since there is no standard kernel interface to do this, the portable	2143	Since there is no portable change notification interface available, the
1916	implementation simply calls C<stat (2)> regularly on the path to see if	2144	portable implementation simply calls C<stat(2)> regularly on the path
1917	it changed somehow. You can specify a recommended polling interval for	2145	to see if it changed somehow. You can specify a recommended polling
1918	this case. If you specify a polling interval of C<0> (highly recommended!)	2146	interval for this case. If you specify a polling interval of C<0> (highly
1919	then a I<suitable, unspecified default> value will be used (which	2147	recommended!) then a I<suitable, unspecified default> value will be used
1920	you can expect to be around five seconds, although this might change	2148	(which you can expect to be around five seconds, although this might
1921	dynamically). Libev will also impose a minimum interval which is currently	2149	change dynamically). Libev will also impose a minimum interval which is
1922	around C<0.1>, but thats usually overkill.	2150	currently around C<0.1>, but that's usually overkill.
1923		2151
1924	This watcher type is not meant for massive numbers of stat watchers,	2152	This watcher type is not meant for massive numbers of stat watchers,
1925	as even with OS-supported change notifications, this can be	2153	as even with OS-supported change notifications, this can be
1926	resource-intensive.	2154	resource-intensive.
1927		2155
1928	At the time of this writing, the only OS-specific interface implemented	2156	At the time of this writing, the only OS-specific interface implemented
1929	is the Linux inotify interface (implementing kqueue support is left as	2157	is the Linux inotify interface (implementing kqueue support is left as an
1930	an exercise for the reader. Note, however, that the author sees no way	2158	exercise for the reader. Note, however, that the author sees no way of
1931	of implementing C<ev_stat> semantics with kqueue).	2159	implementing C<ev_stat> semantics with kqueue, except as a hint).
1932		2160
1933	=head3 ABI Issues (Largefile Support)	2161	=head3 ABI Issues (Largefile Support)
1934		2162
1935	Libev by default (unless the user overrides this) uses the default	2163	Libev by default (unless the user overrides this) uses the default
1936	compilation environment, which means that on systems with large file	2164	compilation environment, which means that on systems with large file
1937	support disabled by default, you get the 32 bit version of the stat	2165	support disabled by default, you get the 32 bit version of the stat
1938	structure. When using the library from programs that change the ABI to	2166	structure. When using the library from programs that change the ABI to
1939	use 64 bit file offsets the programs will fail. In that case you have to	2167	use 64 bit file offsets the programs will fail. In that case you have to
1940	compile libev with the same flags to get binary compatibility. This is	2168	compile libev with the same flags to get binary compatibility. This is
1941	obviously the case with any flags that change the ABI, but the problem is	2169	obviously the case with any flags that change the ABI, but the problem is
1942	most noticeably disabled with ev_stat and large file support.	2170	most noticeably displayed with ev_stat and large file support.
1943		2171
1944	The solution for this is to lobby your distribution maker to make large	2172	The solution for this is to lobby your distribution maker to make large
1945	file interfaces available by default (as e.g. FreeBSD does) and not	2173	file interfaces available by default (as e.g. FreeBSD does) and not
1946	optional. Libev cannot simply switch on large file support because it has	2174	optional. Libev cannot simply switch on large file support because it has
1947	to exchange stat structures with application programs compiled using the	2175	to exchange stat structures with application programs compiled using the
1948	default compilation environment.	2176	default compilation environment.
1949		2177
1950	=head3 Inotify and Kqueue	2178	=head3 Inotify and Kqueue
1951		2179
1952	When C<inotify (7)> support has been compiled into libev (generally	2180	When C<inotify (7)> support has been compiled into libev and present at
1953	only available with Linux 2.6.25 or above due to bugs in earlier	2181	runtime, it will be used to speed up change detection where possible. The
1954	implementations) and present at runtime, it will be used to speed up	2182	inotify descriptor will be created lazily when the first C<ev_stat>
1955	change detection where possible. The inotify descriptor will be created	2183	watcher is being started.
1956	lazily when the first C<ev_stat> watcher is being started.
1957		2184
1958	Inotify presence does not change the semantics of C<ev_stat> watchers	2185	Inotify presence does not change the semantics of C<ev_stat> watchers
1959	except that changes might be detected earlier, and in some cases, to avoid	2186	except that changes might be detected earlier, and in some cases, to avoid
1960	making regular C<stat> calls. Even in the presence of inotify support	2187	making regular C<stat> calls. Even in the presence of inotify support
1961	there are many cases where libev has to resort to regular C<stat> polling,	2188	there are many cases where libev has to resort to regular C<stat> polling,
1962	but as long as the path exists, libev usually gets away without polling.	2189	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2190	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2191	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2192	xfs are fully working) libev usually gets away without polling.
1963		2193
1964	There is no support for kqueue, as apparently it cannot be used to	2194	There is no support for kqueue, as apparently it cannot be used to
1965	implement this functionality, due to the requirement of having a file	2195	implement this functionality, due to the requirement of having a file
1966	descriptor open on the object at all times, and detecting renames, unlinks	2196	descriptor open on the object at all times, and detecting renames, unlinks
1967	etc. is difficult.	2197	etc. is difficult.
1968		2198
		2199	=head3 C<stat ()> is a synchronous operation
		2200
		2201	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2202	the process. The exception are C<ev_stat> watchers - those call C<stat
		2203	()>, which is a synchronous operation.
		2204
		2205	For local paths, this usually doesn't matter: unless the system is very
		2206	busy or the intervals between stat's are large, a stat call will be fast,
		2207	as the path data is usually in memory already (except when starting the
		2208	watcher).
		2209
		2210	For networked file systems, calling C<stat ()> can block an indefinite
		2211	time due to network issues, and even under good conditions, a stat call
		2212	often takes multiple milliseconds.
		2213
		2214	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2215	paths, although this is fully supported by libev.
		2216
1969	=head3 The special problem of stat time resolution	2217	=head3 The special problem of stat time resolution
1970		2218
1971	The C<stat ()> system call only supports full-second resolution portably, and	2219	The C<stat ()> system call only supports full-second resolution portably,
1972	even on systems where the resolution is higher, most file systems still	2220	and even on systems where the resolution is higher, most file systems
1973	only support whole seconds.	2221	still only support whole seconds.
1974		2222
1975	That means that, if the time is the only thing that changes, you can	2223	That means that, if the time is the only thing that changes, you can
1976	easily miss updates: on the first update, C<ev_stat> detects a change and	2224	easily miss updates: on the first update, C<ev_stat> detects a change and
1977	calls your callback, which does something. When there is another update	2225	calls your callback, which does something. When there is another update
1978	within the same second, C<ev_stat> will be unable to detect unless the	2226	within the same second, C<ev_stat> will be unable to detect unless the
…		…
2121		2369
2122	=head3 Watcher-Specific Functions and Data Members	2370	=head3 Watcher-Specific Functions and Data Members
2123		2371
2124	=over 4	2372	=over 4
2125		2373
2126	=item ev_idle_init (ev_signal *, callback)	2374	=item ev_idle_init (ev_idle *, callback)
2127		2375
2128	Initialises and configures the idle watcher - it has no parameters of any	2376	Initialises and configures the idle watcher - it has no parameters of any
2129	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2377	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2130	believe me.	2378	believe me.
2131		2379
…		…
2144	// no longer anything immediate to do.	2392	// no longer anything immediate to do.
2145	}	2393	}
2146		2394
2147	ev_idle *idle_watcher = malloc (sizeof (ev_idle));	2395	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2148	ev_idle_init (idle_watcher, idle_cb);	2396	ev_idle_init (idle_watcher, idle_cb);
2149	ev_idle_start (loop, idle_cb);	2397	ev_idle_start (loop, idle_watcher);
2150		2398
2151		2399
2152	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2400	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2153		2401
2154	Prepare and check watchers are usually (but not always) used in pairs:	2402	Prepare and check watchers are usually (but not always) used in pairs:
…		…
2247	struct pollfd fds [nfd];	2495	struct pollfd fds [nfd];
2248	// actual code will need to loop here and realloc etc.	2496	// actual code will need to loop here and realloc etc.
2249	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2497	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2250		2498
2251	/* the callback is illegal, but won't be called as we stop during check */	2499	/* the callback is illegal, but won't be called as we stop during check */
2252	ev_timer_init (&tw, 0, timeout * 1e-3);	2500	ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2253	ev_timer_start (loop, &tw);	2501	ev_timer_start (loop, &tw);
2254		2502
2255	// create one ev_io per pollfd	2503	// create one ev_io per pollfd
2256	for (int i = 0; i < nfd; ++i)	2504	for (int i = 0; i < nfd; ++i)
2257	{	2505	{
…		…
2370	some fds have to be watched and handled very quickly (with low latency),	2618	some fds have to be watched and handled very quickly (with low latency),
2371	and even priorities and idle watchers might have too much overhead. In	2619	and even priorities and idle watchers might have too much overhead. In
2372	this case you would put all the high priority stuff in one loop and all	2620	this case you would put all the high priority stuff in one loop and all
2373	the rest in a second one, and embed the second one in the first.	2621	the rest in a second one, and embed the second one in the first.
2374		2622
2375	As long as the watcher is active, the callback will be invoked every time	2623	As long as the watcher is active, the callback will be invoked every
2376	there might be events pending in the embedded loop. The callback must then	2624	time there might be events pending in the embedded loop. The callback
2377	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2625	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2378	their callbacks (you could also start an idle watcher to give the embedded	2626	sweep and invoke their callbacks (the callback doesn't need to invoke the
2379	loop strictly lower priority for example). You can also set the callback	2627	C<ev_embed_sweep> function directly, it could also start an idle watcher
2380	to C<0>, in which case the embed watcher will automatically execute the	2628	to give the embedded loop strictly lower priority for example).
2381	embedded loop sweep.
2382		2629
2383	As long as the watcher is started it will automatically handle events. The	2630	You can also set the callback to C<0>, in which case the embed watcher
2384	callback will be invoked whenever some events have been handled. You can	2631	will automatically execute the embedded loop sweep whenever necessary.
2385	set the callback to C<0> to avoid having to specify one if you are not
2386	interested in that.
2387		2632
2388	Also, there have not currently been made special provisions for forking:	2633	Fork detection will be handled transparently while the C<ev_embed> watcher
2389	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2634	is active, i.e., the embedded loop will automatically be forked when the
2390	but you will also have to stop and restart any C<ev_embed> watchers	2635	embedding loop forks. In other cases, the user is responsible for calling
2391	yourself - but you can use a fork watcher to handle this automatically,	2636	C<ev_loop_fork> on the embedded loop.
2392	and future versions of libev might do just that.
2393		2637
2394	Unfortunately, not all backends are embeddable: only the ones returned by	2638	Unfortunately, not all backends are embeddable: only the ones returned by
2395	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2639	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2396	portable one.	2640	portable one.
2397		2641
…		…
2491	event loop blocks next and before C<ev_check> watchers are being called,	2735	event loop blocks next and before C<ev_check> watchers are being called,
2492	and only in the child after the fork. If whoever good citizen calling	2736	and only in the child after the fork. If whoever good citizen calling
2493	C<ev_default_fork> cheats and calls it in the wrong process, the fork	2737	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2494	handlers will be invoked, too, of course.	2738	handlers will be invoked, too, of course.
2495		2739
		2740	=head3 The special problem of life after fork - how is it possible?
		2741
		2742	Most uses of C<fork()> consist of forking, then some simple calls to ste
		2743	up/change the process environment, followed by a call to C<exec()>. This
		2744	sequence should be handled by libev without any problems.
		2745
		2746	This changes when the application actually wants to do event handling
		2747	in the child, or both parent in child, in effect "continuing" after the
		2748	fork.
		2749
		2750	The default mode of operation (for libev, with application help to detect
		2751	forks) is to duplicate all the state in the child, as would be expected
		2752	when I<either> the parent I<or> the child process continues.
		2753
		2754	When both processes want to continue using libev, then this is usually the
		2755	wrong result. In that case, usually one process (typically the parent) is
		2756	supposed to continue with all watchers in place as before, while the other
		2757	process typically wants to start fresh, i.e. without any active watchers.
		2758
		2759	The cleanest and most efficient way to achieve that with libev is to
		2760	simply create a new event loop, which of course will be "empty", and
		2761	use that for new watchers. This has the advantage of not touching more
		2762	memory than necessary, and thus avoiding the copy-on-write, and the
		2763	disadvantage of having to use multiple event loops (which do not support
		2764	signal watchers).
		2765
		2766	When this is not possible, or you want to use the default loop for
		2767	other reasons, then in the process that wants to start "fresh", call
		2768	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
		2769	the default loop will "orphan" (not stop) all registered watchers, so you
		2770	have to be careful not to execute code that modifies those watchers. Note
		2771	also that in that case, you have to re-register any signal watchers.
		2772
2496	=head3 Watcher-Specific Functions and Data Members	2773	=head3 Watcher-Specific Functions and Data Members
2497		2774
2498	=over 4	2775	=over 4
2499		2776
2500	=item ev_fork_init (ev_signal *, callback)	2777	=item ev_fork_init (ev_signal *, callback)
…		…
2617	=over 4	2894	=over 4
2618		2895
2619	=item ev_async_init (ev_async *, callback)	2896	=item ev_async_init (ev_async *, callback)
2620		2897
2621	Initialises and configures the async watcher - it has no parameters of any	2898	Initialises and configures the async watcher - it has no parameters of any
2622	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	2899	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2623	trust me.	2900	trust me.
2624		2901
2625	=item ev_async_send (loop, ev_async *)	2902	=item ev_async_send (loop, ev_async *)
2626		2903
2627	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2904	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2628	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2905	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2629	C<ev_feed_event>, this call is safe to do from other threads, signal or	2906	C<ev_feed_event>, this call is safe to do from other threads, signal or
2630	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	2907	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2631	section below on what exactly this means).	2908	section below on what exactly this means).
2632		2909
		2910	Note that, as with other watchers in libev, multiple events might get
		2911	compressed into a single callback invocation (another way to look at this
		2912	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2913	reset when the event loop detects that).
		2914
2633	This call incurs the overhead of a system call only once per loop iteration,	2915	This call incurs the overhead of a system call only once per event loop
2634	so while the overhead might be noticeable, it doesn't apply to repeated	2916	iteration, so while the overhead might be noticeable, it doesn't apply to
2635	calls to C<ev_async_send>.	2917	repeated calls to C<ev_async_send> for the same event loop.
2636		2918
2637	=item bool = ev_async_pending (ev_async *)	2919	=item bool = ev_async_pending (ev_async *)
2638		2920
2639	Returns a non-zero value when C<ev_async_send> has been called on the	2921	Returns a non-zero value when C<ev_async_send> has been called on the
2640	watcher but the event has not yet been processed (or even noted) by the	2922	watcher but the event has not yet been processed (or even noted) by the
…		…
2643	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2925	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2644	the loop iterates next and checks for the watcher to have become active,	2926	the loop iterates next and checks for the watcher to have become active,
2645	it will reset the flag again. C<ev_async_pending> can be used to very	2927	it will reset the flag again. C<ev_async_pending> can be used to very
2646	quickly check whether invoking the loop might be a good idea.	2928	quickly check whether invoking the loop might be a good idea.
2647		2929
2648	Not that this does I<not> check whether the watcher itself is pending, only	2930	Not that this does I<not> check whether the watcher itself is pending,
2649	whether it has been requested to make this watcher pending.	2931	only whether it has been requested to make this watcher pending: there
		2932	is a time window between the event loop checking and resetting the async
		2933	notification, and the callback being invoked.
2650		2934
2651	=back	2935	=back
2652		2936
2653		2937
2654	=head1 OTHER FUNCTIONS	2938	=head1 OTHER FUNCTIONS
…		…
2833		3117
2834	myclass obj;	3118	myclass obj;
2835	ev::io iow;	3119	ev::io iow;
2836	iow.set <myclass, &myclass::io_cb> (&obj);	3120	iow.set <myclass, &myclass::io_cb> (&obj);
2837		3121
		3122	=item w->set (object *)
		3123
		3124	This is an B<experimental> feature that might go away in a future version.
		3125
		3126	This is a variation of a method callback - leaving out the method to call
		3127	will default the method to C<operator ()>, which makes it possible to use
		3128	functor objects without having to manually specify the C<operator ()> all
		3129	the time. Incidentally, you can then also leave out the template argument
		3130	list.
		3131
		3132	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3133	int revents)>.
		3134
		3135	See the method-C<set> above for more details.
		3136
		3137	Example: use a functor object as callback.
		3138
		3139	struct myfunctor
		3140	{
		3141	void operator() (ev::io &w, int revents)
		3142	{
		3143	...
		3144	}
		3145	}
		3146
		3147	myfunctor f;
		3148
		3149	ev::io w;
		3150	w.set (&f);
		3151
2838	=item w->set<function> (void *data = 0)	3152	=item w->set<function> (void *data = 0)
2839		3153
2840	Also sets a callback, but uses a static method or plain function as	3154	Also sets a callback, but uses a static method or plain function as
2841	callback. The optional C<data> argument will be stored in the watcher's	3155	callback. The optional C<data> argument will be stored in the watcher's
2842	C<data> member and is free for you to use.	3156	C<data> member and is free for you to use.
…		…
2928	L<http://software.schmorp.de/pkg/EV>.	3242	L<http://software.schmorp.de/pkg/EV>.
2929		3243
2930	=item Python	3244	=item Python
2931		3245
2932	Python bindings can be found at L<http://code.google.com/p/pyev/>. It	3246	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
2933	seems to be quite complete and well-documented. Note, however, that the	3247	seems to be quite complete and well-documented.
2934	patch they require for libev is outright dangerous as it breaks the ABI
2935	for everybody else, and therefore, should never be applied in an installed
2936	libev (if python requires an incompatible ABI then it needs to embed
2937	libev).
2938		3248
2939	=item Ruby	3249	=item Ruby
2940		3250
2941	Tony Arcieri has written a ruby extension that offers access to a subset	3251	Tony Arcieri has written a ruby extension that offers access to a subset
2942	of the libev API and adds file handle abstractions, asynchronous DNS and	3252	of the libev API and adds file handle abstractions, asynchronous DNS and
2943	more on top of it. It can be found via gem servers. Its homepage is at	3253	more on top of it. It can be found via gem servers. Its homepage is at
2944	L<http://rev.rubyforge.org/>.	3254	L<http://rev.rubyforge.org/>.
2945		3255
		3256	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3257	makes rev work even on mingw.
		3258
		3259	=item Haskell
		3260
		3261	A haskell binding to libev is available at
		3262	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3263
2946	=item D	3264	=item D
2947		3265
2948	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	3266	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2949	be found at L<http://proj.llucax.com.ar/wiki/evd>.	3267	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3268
		3269	=item Ocaml
		3270
		3271	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3272	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2950		3273
2951	=back	3274	=back
2952		3275
2953		3276
2954	=head1 MACRO MAGIC	3277	=head1 MACRO MAGIC
…		…
3055		3378
3056	#define EV_STANDALONE 1	3379	#define EV_STANDALONE 1
3057	#include "ev.h"	3380	#include "ev.h"
3058		3381
3059	Both header files and implementation files can be compiled with a C++	3382	Both header files and implementation files can be compiled with a C++
3060	compiler (at least, thats a stated goal, and breakage will be treated	3383	compiler (at least, that's a stated goal, and breakage will be treated
3061	as a bug).	3384	as a bug).
3062		3385
3063	You need the following files in your source tree, or in a directory	3386	You need the following files in your source tree, or in a directory
3064	in your include path (e.g. in libev/ when using -Ilibev):	3387	in your include path (e.g. in libev/ when using -Ilibev):
3065		3388
…		…
3121	keeps libev from including F<config.h>, and it also defines dummy	3444	keeps libev from including F<config.h>, and it also defines dummy
3122	implementations for some libevent functions (such as logging, which is not	3445	implementations for some libevent functions (such as logging, which is not
3123	supported). It will also not define any of the structs usually found in	3446	supported). It will also not define any of the structs usually found in
3124	F<event.h> that are not directly supported by the libev core alone.	3447	F<event.h> that are not directly supported by the libev core alone.
3125		3448
		3449	In stanbdalone mode, libev will still try to automatically deduce the
		3450	configuration, but has to be more conservative.
		3451
3126	=item EV_USE_MONOTONIC	3452	=item EV_USE_MONOTONIC
3127		3453
3128	If defined to be C<1>, libev will try to detect the availability of the	3454	If defined to be C<1>, libev will try to detect the availability of the
3129	monotonic clock option at both compile time and runtime. Otherwise no use	3455	monotonic clock option at both compile time and runtime. Otherwise no
3130	of the monotonic clock option will be attempted. If you enable this, you	3456	use of the monotonic clock option will be attempted. If you enable this,
3131	usually have to link against librt or something similar. Enabling it when	3457	you usually have to link against librt or something similar. Enabling it
3132	the functionality isn't available is safe, though, although you have	3458	when the functionality isn't available is safe, though, although you have
3133	to make sure you link against any libraries where the C<clock_gettime>	3459	to make sure you link against any libraries where the C<clock_gettime>
3134	function is hiding in (often F<-lrt>).	3460	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3135		3461
3136	=item EV_USE_REALTIME	3462	=item EV_USE_REALTIME
3137		3463
3138	If defined to be C<1>, libev will try to detect the availability of the	3464	If defined to be C<1>, libev will try to detect the availability of the
3139	real-time clock option at compile time (and assume its availability at	3465	real-time clock option at compile time (and assume its availability
3140	runtime if successful). Otherwise no use of the real-time clock option will	3466	at runtime if successful). Otherwise no use of the real-time clock
3141	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3467	option will be attempted. This effectively replaces C<gettimeofday>
3142	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3468	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3143	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3469	correctness. See the note about libraries in the description of
		3470	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3471	C<EV_USE_CLOCK_SYSCALL>.
		3472
		3473	=item EV_USE_CLOCK_SYSCALL
		3474
		3475	If defined to be C<1>, libev will try to use a direct syscall instead
		3476	of calling the system-provided C<clock_gettime> function. This option
		3477	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3478	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3479	programs needlessly. Using a direct syscall is slightly slower (in
		3480	theory), because no optimised vdso implementation can be used, but avoids
		3481	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3482	higher, as it simplifies linking (no need for C<-lrt>).
3144		3483
3145	=item EV_USE_NANOSLEEP	3484	=item EV_USE_NANOSLEEP
3146		3485
3147	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3486	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
3148	and will use it for delays. Otherwise it will use C<select ()>.	3487	and will use it for delays. Otherwise it will use C<select ()>.
…		…
3164		3503
3165	=item EV_SELECT_USE_FD_SET	3504	=item EV_SELECT_USE_FD_SET
3166		3505
3167	If defined to C<1>, then the select backend will use the system C<fd_set>	3506	If defined to C<1>, then the select backend will use the system C<fd_set>
3168	structure. This is useful if libev doesn't compile due to a missing	3507	structure. This is useful if libev doesn't compile due to a missing
3169	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on	3508	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
3170	exotic systems. This usually limits the range of file descriptors to some	3509	on exotic systems. This usually limits the range of file descriptors to
3171	low limit such as 1024 or might have other limitations (winsocket only	3510	some low limit such as 1024 or might have other limitations (winsocket
3172	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3511	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3173	influence the size of the C<fd_set> used.	3512	configures the maximum size of the C<fd_set>.
3174		3513
3175	=item EV_SELECT_IS_WINSOCKET	3514	=item EV_SELECT_IS_WINSOCKET
3176		3515
3177	When defined to C<1>, the select backend will assume that	3516	When defined to C<1>, the select backend will assume that
3178	select/socket/connect etc. don't understand file descriptors but	3517	select/socket/connect etc. don't understand file descriptors but
…		…
3537	loop, as long as you don't confuse yourself). The only exception is that	3876	loop, as long as you don't confuse yourself). The only exception is that
3538	you must not do this from C<ev_periodic> reschedule callbacks.	3877	you must not do this from C<ev_periodic> reschedule callbacks.
3539		3878
3540	Care has been taken to ensure that libev does not keep local state inside	3879	Care has been taken to ensure that libev does not keep local state inside
3541	C<ev_loop>, and other calls do not usually allow for coroutine switches as	3880	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3542	they do not clal any callbacks.	3881	they do not call any callbacks.
3543		3882
3544	=head2 COMPILER WARNINGS	3883	=head2 COMPILER WARNINGS
3545		3884
3546	Depending on your compiler and compiler settings, you might get no or a	3885	Depending on your compiler and compiler settings, you might get no or a
3547	lot of warnings when compiling libev code. Some people are apparently	3886	lot of warnings when compiling libev code. Some people are apparently
…		…
3581	==2274== definitely lost: 0 bytes in 0 blocks.	3920	==2274== definitely lost: 0 bytes in 0 blocks.
3582	==2274== possibly lost: 0 bytes in 0 blocks.	3921	==2274== possibly lost: 0 bytes in 0 blocks.
3583	==2274== still reachable: 256 bytes in 1 blocks.	3922	==2274== still reachable: 256 bytes in 1 blocks.
3584		3923
3585	Then there is no memory leak, just as memory accounted to global variables	3924	Then there is no memory leak, just as memory accounted to global variables
3586	is not a memleak - the memory is still being refernced, and didn't leak.	3925	is not a memleak - the memory is still being referenced, and didn't leak.
3587		3926
3588	Similarly, under some circumstances, valgrind might report kernel bugs	3927	Similarly, under some circumstances, valgrind might report kernel bugs
3589	as if it were a bug in libev (e.g. in realloc or in the poll backend,	3928	as if it were a bug in libev (e.g. in realloc or in the poll backend,
3590	although an acceptable workaround has been found here), or it might be	3929	although an acceptable workaround has been found here), or it might be
3591	confused.	3930	confused.
…		…
3620	way (note also that glib is the slowest event library known to man).	3959	way (note also that glib is the slowest event library known to man).
3621		3960
3622	There is no supported compilation method available on windows except	3961	There is no supported compilation method available on windows except
3623	embedding it into other applications.	3962	embedding it into other applications.
3624		3963
		3964	Sensible signal handling is officially unsupported by Microsoft - libev
		3965	tries its best, but under most conditions, signals will simply not work.
		3966
3625	Not a libev limitation but worth mentioning: windows apparently doesn't	3967	Not a libev limitation but worth mentioning: windows apparently doesn't
3626	accept large writes: instead of resulting in a partial write, windows will	3968	accept large writes: instead of resulting in a partial write, windows will
3627	either accept everything or return C<ENOBUFS> if the buffer is too large,	3969	either accept everything or return C<ENOBUFS> if the buffer is too large,
3628	so make sure you only write small amounts into your sockets (less than a	3970	so make sure you only write small amounts into your sockets (less than a
3629	megabyte seems safe, but this apparently depends on the amount of memory	3971	megabyte seems safe, but this apparently depends on the amount of memory
…		…
3633	the abysmal performance of winsockets, using a large number of sockets	3975	the abysmal performance of winsockets, using a large number of sockets
3634	is not recommended (and not reasonable). If your program needs to use	3976	is not recommended (and not reasonable). If your program needs to use
3635	more than a hundred or so sockets, then likely it needs to use a totally	3977	more than a hundred or so sockets, then likely it needs to use a totally
3636	different implementation for windows, as libev offers the POSIX readiness	3978	different implementation for windows, as libev offers the POSIX readiness
3637	notification model, which cannot be implemented efficiently on windows	3979	notification model, which cannot be implemented efficiently on windows
3638	(Microsoft monopoly games).	3980	(due to Microsoft monopoly games).
3639		3981
3640	A typical way to use libev under windows is to embed it (see the embedding	3982	A typical way to use libev under windows is to embed it (see the embedding
3641	section for details) and use the following F<evwrap.h> header file instead	3983	section for details) and use the following F<evwrap.h> header file instead
3642	of F<ev.h>:	3984	of F<ev.h>:
3643		3985
…		…
3679		4021
3680	Early versions of winsocket's select only supported waiting for a maximum	4022	Early versions of winsocket's select only supported waiting for a maximum
3681	of C<64> handles (probably owning to the fact that all windows kernels	4023	of C<64> handles (probably owning to the fact that all windows kernels
3682	can only wait for C<64> things at the same time internally; Microsoft	4024	can only wait for C<64> things at the same time internally; Microsoft
3683	recommends spawning a chain of threads and wait for 63 handles and the	4025	recommends spawning a chain of threads and wait for 63 handles and the
3684	previous thread in each. Great).	4026	previous thread in each. Sounds great!).
3685		4027
3686	Newer versions support more handles, but you need to define C<FD_SETSIZE>	4028	Newer versions support more handles, but you need to define C<FD_SETSIZE>
3687	to some high number (e.g. C<2048>) before compiling the winsocket select	4029	to some high number (e.g. C<2048>) before compiling the winsocket select
3688	call (which might be in libev or elsewhere, for example, perl does its own	4030	call (which might be in libev or elsewhere, for example, perl and many
3689	select emulation on windows).	4031	other interpreters do their own select emulation on windows).
3690		4032
3691	Another limit is the number of file descriptors in the Microsoft runtime	4033	Another limit is the number of file descriptors in the Microsoft runtime
3692	libraries, which by default is C<64> (there must be a hidden I<64> fetish	4034	libraries, which by default is C<64> (there must be a hidden I<64>
3693	or something like this inside Microsoft). You can increase this by calling	4035	fetish or something like this inside Microsoft). You can increase this
3694	C<_setmaxstdio>, which can increase this limit to C<2048> (another	4036	by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3695	arbitrary limit), but is broken in many versions of the Microsoft runtime	4037	(another arbitrary limit), but is broken in many versions of the Microsoft
3696	libraries.
3697
3698	This might get you to about C<512> or C<2048> sockets (depending on	4038	runtime libraries. This might get you to about C<512> or C<2048> sockets
3699	windows version and/or the phase of the moon). To get more, you need to	4039	(depending on windows version and/or the phase of the moon). To get more,
3700	wrap all I/O functions and provide your own fd management, but the cost of	4040	you need to wrap all I/O functions and provide your own fd management, but
3701	calling select (O(n²)) will likely make this unworkable.	4041	the cost of calling select (O(n²)) will likely make this unworkable.
3702		4042
3703	=back	4043	=back
3704		4044
3705	=head2 PORTABILITY REQUIREMENTS	4045	=head2 PORTABILITY REQUIREMENTS
3706		4046
…		…
3749	=item C<double> must hold a time value in seconds with enough accuracy	4089	=item C<double> must hold a time value in seconds with enough accuracy
3750		4090
3751	The type C<double> is used to represent timestamps. It is required to	4091	The type C<double> is used to represent timestamps. It is required to
3752	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4092	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
3753	enough for at least into the year 4000. This requirement is fulfilled by	4093	enough for at least into the year 4000. This requirement is fulfilled by
3754	implementations implementing IEEE 754 (basically all existing ones).	4094	implementations implementing IEEE 754, which is basically all existing
		4095	ones. With IEEE 754 doubles, you get microsecond accuracy until at least
		4096	2200.
3755		4097
3756	=back	4098	=back
3757		4099
3758	If you know of other additional requirements drop me a note.	4100	If you know of other additional requirements drop me a note.
3759		4101
…		…
3827	involves iterating over all running async watchers or all signal numbers.	4169	involves iterating over all running async watchers or all signal numbers.
3828		4170
3829	=back	4171	=back
3830		4172
3831		4173
		4174	=head1 GLOSSARY
		4175
		4176	=over 4
		4177
		4178	=item active
		4179
		4180	A watcher is active as long as it has been started (has been attached to
		4181	an event loop) but not yet stopped (disassociated from the event loop).
		4182
		4183	=item application
		4184
		4185	In this document, an application is whatever is using libev.
		4186
		4187	=item callback
		4188
		4189	The address of a function that is called when some event has been
		4190	detected. Callbacks are being passed the event loop, the watcher that
		4191	received the event, and the actual event bitset.
		4192
		4193	=item callback invocation
		4194
		4195	The act of calling the callback associated with a watcher.
		4196
		4197	=item event
		4198
		4199	A change of state of some external event, such as data now being available
		4200	for reading on a file descriptor, time having passed or simply not having
		4201	any other events happening anymore.
		4202
		4203	In libev, events are represented as single bits (such as C<EV_READ> or
		4204	C<EV_TIMEOUT>).
		4205
		4206	=item event library
		4207
		4208	A software package implementing an event model and loop.
		4209
		4210	=item event loop
		4211
		4212	An entity that handles and processes external events and converts them
		4213	into callback invocations.
		4214
		4215	=item event model
		4216
		4217	The model used to describe how an event loop handles and processes
		4218	watchers and events.
		4219
		4220	=item pending
		4221
		4222	A watcher is pending as soon as the corresponding event has been detected,
		4223	and stops being pending as soon as the watcher will be invoked or its
		4224	pending status is explicitly cleared by the application.
		4225
		4226	A watcher can be pending, but not active. Stopping a watcher also clears
		4227	its pending status.
		4228
		4229	=item real time
		4230
		4231	The physical time that is observed. It is apparently strictly monotonic :)
		4232
		4233	=item wall-clock time
		4234
		4235	The time and date as shown on clocks. Unlike real time, it can actually
		4236	be wrong and jump forwards and backwards, e.g. when the you adjust your
		4237	clock.
		4238
		4239	=item watcher
		4240
		4241	A data structure that describes interest in certain events. Watchers need
		4242	to be started (attached to an event loop) before they can receive events.
		4243
		4244	=item watcher invocation
		4245
		4246	The act of calling the callback associated with a watcher.
		4247
		4248	=back
		4249
3832	=head1 AUTHOR	4250	=head1 AUTHOR
3833		4251
3834	Marc Lehmann <libev@schmorp.de>.	4252	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3835		4253

Diff Legend

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