[ViewVC] Diff of: cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.198 by root, Thu Oct 23 06:30:48 2008 UTC vs.
Revision 1.233 by root, Thu Apr 16 07:32:51 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);
…		…
276		278
277	=back	279	=back
278		280
279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	281	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
280		282
281	An event loop is described by a C<ev_loop *>. The library knows two	283	An event loop is described by a C<struct ev_loop *> (the C<struct>
282	types of such loops, the I<default> loop, which supports signals and child	284	is I<not> optional in this case, as there is also an C<ev_loop>
283	events, and dynamically created loops which do not.	285	I<function>).
		286
		287	The library knows two types of such loops, the I<default> loop, which
		288	supports signals and child events, and dynamically created loops which do
		289	not.
284		290
285	=over 4	291	=over 4
286		292
287	=item struct ev_loop *ev_default_loop (unsigned int flags)	293	=item struct ev_loop *ev_default_loop (unsigned int flags)
288		294
…		…
294	If you don't know what event loop to use, use the one returned from this	300	If you don't know what event loop to use, use the one returned from this
295	function.	301	function.
296		302
297	Note that this function is I<not> thread-safe, so if you want to use it	303	Note that this function is I<not> thread-safe, so if you want to use it
298	from multiple threads, you have to lock (note also that this is unlikely,	304	from multiple threads, you have to lock (note also that this is unlikely,
299	as loops cannot bes hared easily between threads anyway).	305	as loops cannot be shared easily between threads anyway).
300		306
301	The default loop is the only loop that can handle C<ev_signal> and	307	The default loop is the only loop that can handle C<ev_signal> and
302	C<ev_child> watchers, and to do this, it always registers a handler	308	C<ev_child> watchers, and to do this, it always registers a handler
303	for C<SIGCHLD>. If this is a problem for your application you can either	309	for C<SIGCHLD>. If this is a problem for your application you can either
304	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	310	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
…		…
380	=item C<EVBACKEND_EPOLL> (value 4, Linux)	386	=item C<EVBACKEND_EPOLL> (value 4, Linux)
381		387
382	For few fds, this backend is a bit little slower than poll and select,	388	For few fds, this backend is a bit little slower than poll and select,
383	but it scales phenomenally better. While poll and select usually scale	389	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),	390	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	391	epoll scales either O(1) or O(active_fds).
386	of shortcomings, such as silently dropping events in some hard-to-detect	392
387	cases and requiring a system call per fd change, no fork support and bad	393	The epoll mechanism deserves honorable mention as the most misdesigned
388	support for dup.	394	of the more advanced event mechanisms: mere annoyances include silently
		395	dropping file descriptors, requiring a system call per change per file
		396	descriptor (and unnecessary guessing of parameters), problems with dup and
		397	so on. The biggest issue is fork races, however - if a program forks then
		398	I<both> parent and child process have to recreate the epoll set, which can
		399	take considerable time (one syscall per file descriptor) and is of course
		400	hard to detect.
		401
		402	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		403	of course I<doesn't>, and epoll just loves to report events for totally
		404	I<different> file descriptors (even already closed ones, so one cannot
		405	even remove them from the set) than registered in the set (especially
		406	on SMP systems). Libev tries to counter these spurious notifications by
		407	employing an additional generation counter and comparing that against the
		408	events to filter out spurious ones, recreating the set when required.
389		409
390	While stopping, setting and starting an I/O watcher in the same iteration	410	While stopping, setting and starting an I/O watcher in the same iteration
391	will result in some caching, there is still a system call per such incident	411	will result in some caching, there is still a system call per such
392	(because the fd could point to a different file description now), so its	412	incident (because the same I<file descriptor> could point to a different
393	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	413	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
394	very well if you register events for both fds.	414	file descriptors might not work very well if you register events for both
395		415	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		416
400	Best performance from this backend is achieved by not unregistering all	417	Best performance from this backend is achieved by not unregistering all
401	watchers for a file descriptor until it has been closed, if possible,	418	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	419	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	420	starting a watcher (without re-setting it) also usually doesn't cause
404	extra overhead.	421	extra overhead. A fork can both result in spurious notifications as well
		422	as in libev having to destroy and recreate the epoll object, which can
		423	take considerable time and thus should be avoided.
		424
		425	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		426	faster than epoll for maybe up to a hundred file descriptors, depending on
		427	the usage. So sad.
405		428
406	While nominally embeddable in other event loops, this feature is broken in	429	While nominally embeddable in other event loops, this feature is broken in
407	all kernel versions tested so far.	430	all kernel versions tested so far.
408		431
409	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	432	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
410	C<EVBACKEND_POLL>.	433	C<EVBACKEND_POLL>.
411		434
412	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	435	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
413		436
414	Kqueue deserves special mention, as at the time of this writing, it was	437	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	438	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	439	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	440	it's completely useless). Unlike epoll, however, whose brokenness
418	you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or	441	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.	442	without API changes to existing programs. For this reason it's not being
		443	"auto-detected" unless you explicitly specify it in the flags (i.e. using
		444	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		445	system like NetBSD.
420		446
421	You still can embed kqueue into a normal poll or select backend and use it	447	You still can embed kqueue into a normal poll or select backend and use it
422	only for sockets (after having made sure that sockets work with kqueue on	448	only for sockets (after having made sure that sockets work with kqueue on
423	the target platform). See C<ev_embed> watchers for more info.	449	the target platform). See C<ev_embed> watchers for more info.
424		450
425	It scales in the same way as the epoll backend, but the interface to the	451	It scales in the same way as the epoll backend, but the interface to the
426	kernel is more efficient (which says nothing about its actual speed, of	452	kernel is more efficient (which says nothing about its actual speed, of
427	course). While stopping, setting and starting an I/O watcher does never	453	course). While stopping, setting and starting an I/O watcher does never
428	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	454	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
429	two event changes per incident. Support for C<fork ()> is very bad and it	455	two event changes per incident. Support for C<fork ()> is very bad (but
430	drops fds silently in similarly hard-to-detect cases.	456	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		457	cases
431		458
432	This backend usually performs well under most conditions.	459	This backend usually performs well under most conditions.
433		460
434	While nominally embeddable in other event loops, this doesn't work	461	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	462	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	463	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	464	(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,	465	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
439	using it only for sockets.	466	also broken on OS X)) and, did I mention it, using it only for sockets.
440		467
441	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with	468	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	469	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
443	C<NOTE_EOF>.	470	C<NOTE_EOF>.
444		471
…		…
464	might perform better.	491	might perform better.
465		492
466	On the positive side, with the exception of the spurious readiness	493	On the positive side, with the exception of the spurious readiness
467	notifications, this backend actually performed fully to specification	494	notifications, this backend actually performed fully to specification
468	in all tests and is fully embeddable, which is a rare feat among the	495	in all tests and is fully embeddable, which is a rare feat among the
469	OS-specific backends.	496	OS-specific backends (I vastly prefer correctness over speed hacks).
470		497
471	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	498	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
472	C<EVBACKEND_POLL>.	499	C<EVBACKEND_POLL>.
473		500
474	=item C<EVBACKEND_ALL>	501	=item C<EVBACKEND_ALL>
…		…
527	responsibility to either stop all watchers cleanly yourself I<before>	554	responsibility to either stop all watchers cleanly yourself I<before>
528	calling this function, or cope with the fact afterwards (which is usually	555	calling this function, or cope with the fact afterwards (which is usually
529	the easiest thing, you can just ignore the watchers and/or C<free ()> them	556	the easiest thing, you can just ignore the watchers and/or C<free ()> them
530	for example).	557	for example).
531		558
532	Note that certain global state, such as signal state, will not be freed by	559	Note that certain global state, such as signal state (and installed signal
533	this function, and related watchers (such as signal and child watchers)	560	handlers), will not be freed by this function, and related watchers (such
534	would need to be stopped manually.	561	as signal and child watchers) would need to be stopped manually.
535		562
536	In general it is not advisable to call this function except in the	563	In general it is not advisable to call this function except in the
537	rare occasion where you really need to free e.g. the signal handling	564	rare occasion where you really need to free e.g. the signal handling
538	pipe fds. If you need dynamically allocated loops it is better to use	565	pipe fds. If you need dynamically allocated loops it is better to use
539	C<ev_loop_new> and C<ev_loop_destroy>).	566	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
607	very long time without entering the event loop, updating libev's idea of	634	very long time without entering the event loop, updating libev's idea of
608	the current time is a good idea.	635	the current time is a good idea.
609		636
610	See also "The special problem of time updates" in the C<ev_timer> section.	637	See also "The special problem of time updates" in the C<ev_timer> section.
611		638
		639	=item ev_suspend (loop)
		640
		641	=item ev_resume (loop)
		642
		643	These two functions suspend and resume a loop, for use when the loop is
		644	not used for a while and timeouts should not be processed.
		645
		646	A typical use case would be an interactive program such as a game: When
		647	the user presses C<^Z> to suspend the game and resumes it an hour later it
		648	would be best to handle timeouts as if no time had actually passed while
		649	the program was suspended. This can be achieved by calling C<ev_suspend>
		650	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		651	C<ev_resume> directly afterwards to resume timer processing.
		652
		653	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		654	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		655	will be rescheduled (that is, they will lose any events that would have
		656	occured while suspended).
		657
		658	After calling C<ev_suspend> you B<must not> call I<any> function on the
		659	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		660	without a previous call to C<ev_suspend>.
		661
		662	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		663	event loop time (see C<ev_now_update>).
		664
612	=item ev_loop (loop, int flags)	665	=item ev_loop (loop, int flags)
613		666
614	Finally, this is it, the event handler. This function usually is called	667	Finally, this is it, the event handler. This function usually is called
615	after you initialised all your watchers and you want to start handling	668	after you initialised all your watchers and you want to start handling
616	events.	669	events.
…		…
631	the loop.	684	the loop.
632		685
633	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	686	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
634	necessary) and will handle those and any already outstanding ones. It	687	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	688	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	689	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	690	user-registered callback will be called), and will return after one
638	iteration of the loop.	691	iteration of the loop.
639		692
640	This is useful if you are waiting for some external event in conjunction	693	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	694	with something not expressible using other libev watchers (i.e. "roll your
…		…
699		752
700	If you have a watcher you never unregister that should not keep C<ev_loop>	753	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	754	from returning, call ev_unref() after starting, and ev_ref() before
702	stopping it.	755	stopping it.
703		756
704	As an example, libev itself uses this for its internal signal pipe: It is	757	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	758	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	759	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	760	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>	761	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,	762	before stop> (but only if the watcher wasn't active before, or was active
710	respectively).	763	before, respectively. Note also that libev might stop watchers itself
		764	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		765	in the callback).
711		766
712	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	767	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
713	running when nothing else is active.	768	running when nothing else is active.
714		769
715	ev_signal exitsig;	770	ev_signal exitsig;
…		…
768	they fire on, say, one-second boundaries only.	823	they fire on, say, one-second boundaries only.
769		824
770	=item ev_loop_verify (loop)	825	=item ev_loop_verify (loop)
771		826
772	This function only does something when C<EV_VERIFY> support has been	827	This function only does something when C<EV_VERIFY> support has been
773	compiled in. which is the default for non-minimal builds. It tries to go	828	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	829	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	830	is found to be inconsistent, it will print an error message to standard
776	error and call C<abort ()>.	831	error and call C<abort ()>.
777		832
778	This can be used to catch bugs inside libev itself: under normal	833	This can be used to catch bugs inside libev itself: under normal
…		…
781		836
782	=back	837	=back
783		838
784		839
785	=head1 ANATOMY OF A WATCHER	840	=head1 ANATOMY OF A WATCHER
		841
		842	In the following description, uppercase C<TYPE> in names stands for the
		843	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		844	watchers and C<ev_io_start> for I/O watchers.
786		845
787	A watcher is a structure that you create and register to record your	846	A watcher is a structure that you create and register to record your
788	interest in some event. For instance, if you want to wait for STDIN to	847	interest in some event. For instance, if you want to wait for STDIN to
789	become readable, you would create an C<ev_io> watcher for that:	848	become readable, you would create an C<ev_io> watcher for that:
790		849
…		…
793	ev_io_stop (w);	852	ev_io_stop (w);
794	ev_unloop (loop, EVUNLOOP_ALL);	853	ev_unloop (loop, EVUNLOOP_ALL);
795	}	854	}
796		855
797	struct ev_loop *loop = ev_default_loop (0);	856	struct ev_loop *loop = ev_default_loop (0);
		857
798	ev_io stdin_watcher;	858	ev_io stdin_watcher;
		859
799	ev_init (&stdin_watcher, my_cb);	860	ev_init (&stdin_watcher, my_cb);
800	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	861	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
801	ev_io_start (loop, &stdin_watcher);	862	ev_io_start (loop, &stdin_watcher);
		863
802	ev_loop (loop, 0);	864	ev_loop (loop, 0);
803		865
804	As you can see, you are responsible for allocating the memory for your	866	As you can see, you are responsible for allocating the memory for your
805	watcher structures (and it is usually a bad idea to do this on the stack,	867	watcher structures (and it is I<usually> a bad idea to do this on the
806	although this can sometimes be quite valid).	868	stack).
		869
		870	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		871	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
807		872
808	Each watcher structure must be initialised by a call to C<ev_init	873	Each watcher structure must be initialised by a call to C<ev_init
809	(watcher *, callback)>, which expects a callback to be provided. This	874	(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	875	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	876	watchers, each time the event loop detects that the file descriptor given
812	is readable and/or writable).	877	is readable and/or writable).
813		878
814	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	879	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
815	with arguments specific to this watcher type. There is also a macro	880	macro to configure it, with arguments specific to the watcher type. There
816	to combine initialisation and setting in one call: C<< ev_<type>_init	881	is also a macro to combine initialisation and setting in one call: C<<
817	(watcher *, callback, ...) >>.	882	ev_TYPE_init (watcher *, callback, ...) >>.
818		883
819	To make the watcher actually watch out for events, you have to start it	884	To make the watcher actually watch out for events, you have to start it
820	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	885	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
821	*) >>), and you can stop watching for events at any time by calling the	886	*) >>), and you can stop watching for events at any time by calling the
822	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	887	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
823		888
824	As long as your watcher is active (has been started but not stopped) you	889	As long as your watcher is active (has been started but not stopped) you
825	must not touch the values stored in it. Most specifically you must never	890	must not touch the values stored in it. Most specifically you must never
826	reinitialise it or call its C<set> macro.	891	reinitialise it or call its C<ev_TYPE_set> macro.
827		892
828	Each and every callback receives the event loop pointer as first, the	893	Each and every callback receives the event loop pointer as first, the
829	registered watcher structure as second, and a bitset of received events as	894	registered watcher structure as second, and a bitset of received events as
830	third argument.	895	third argument.
831		896
…		…
889		954
890	=item C<EV_ASYNC>	955	=item C<EV_ASYNC>
891		956
892	The given async watcher has been asynchronously notified (see C<ev_async>).	957	The given async watcher has been asynchronously notified (see C<ev_async>).
893		958
		959	=item C<EV_CUSTOM>
		960
		961	Not ever sent (or otherwise used) by libev itself, but can be freely used
		962	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		963
894	=item C<EV_ERROR>	964	=item C<EV_ERROR>
895		965
896	An unspecified error has occurred, the watcher has been stopped. This might	966	An unspecified error has occurred, the watcher has been stopped. This might
897	happen because the watcher could not be properly started because libev	967	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	968	ran out of memory, a file descriptor was found to be closed or any other
…		…
912		982
913	=back	983	=back
914		984
915	=head2 GENERIC WATCHER FUNCTIONS	985	=head2 GENERIC WATCHER FUNCTIONS
916		986
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	987	=over 4
921		988
922	=item C<ev_init> (ev_TYPE *watcher, callback)	989	=item C<ev_init> (ev_TYPE *watcher, callback)
923		990
924	This macro initialises the generic portion of a watcher. The contents	991	This macro initialises the generic portion of a watcher. The contents
…		…
1016	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1083	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1017	(default: C<-2>). Pending watchers with higher priority will be invoked	1084	(default: C<-2>). Pending watchers with higher priority will be invoked
1018	before watchers with lower priority, but priority will not keep watchers	1085	before watchers with lower priority, but priority will not keep watchers
1019	from being executed (except for C<ev_idle> watchers).	1086	from being executed (except for C<ev_idle> watchers).
1020		1087
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	1088	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.	1089	you need to look at C<ev_idle> watchers, which provide this functionality.
1028		1090
1029	You I<must not> change the priority of a watcher as long as it is active or	1091	You I<must not> change the priority of a watcher as long as it is active or
1030	pending.	1092	pending.
1031		1093
		1094	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1095	fine, as long as you do not mind that the priority value you query might
		1096	or might not have been clamped to the valid range.
		1097
1032	The default priority used by watchers when no priority has been set is	1098	The default priority used by watchers when no priority has been set is
1033	always C<0>, which is supposed to not be too high and not be too low :).	1099	always C<0>, which is supposed to not be too high and not be too low :).
1034		1100
1035	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1101	See L<WATCHER PRIORITIES>, below, for a more thorough treatment of
1036	fine, as long as you do not mind that the priority value you query might	1102	priorities.
1037	or might not have been adjusted to be within valid range.
1038		1103
1039	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1104	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1040		1105
1041	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1106	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1042	C<loop> nor C<revents> need to be valid as long as the watcher callback	1107	C<loop> nor C<revents> need to be valid as long as the watcher callback
…		…
1117	t2_cb (EV_P_ ev_timer *w, int revents)	1182	t2_cb (EV_P_ ev_timer *w, int revents)
1118	{	1183	{
1119	struct my_biggy big = (struct my_biggy *	1184	struct my_biggy big = (struct my_biggy *
1120	(((char *)w) - offsetof (struct my_biggy, t2));	1185	(((char *)w) - offsetof (struct my_biggy, t2));
1121	}	1186	}
		1187
		1188	=head2 WATCHER PRIORITY MODELS
		1189
		1190	Many event loops support I<watcher priorities>, which are usually small
		1191	integers that influence the ordering of event callback invocation
		1192	between watchers in some way, all else being equal.
		1193
		1194	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1195	description for the more technical details such as the actual priority
		1196	range.
		1197
		1198	There are two common ways how these these priorities are being interpreted
		1199	by event loops:
		1200
		1201	In the more common lock-out model, higher priorities "lock out" invocation
		1202	of lower priority watchers, which means as long as higher priority
		1203	watchers receive events, lower priority watchers are not being invoked.
		1204
		1205	The less common only-for-ordering model uses priorities solely to order
		1206	callback invocation within a single event loop iteration: Higher priority
		1207	watchers are invoked before lower priority ones, but they all get invoked
		1208	before polling for new events.
		1209
		1210	Libev uses the second (only-for-ordering) model for all its watchers
		1211	except for idle watchers (which use the lock-out model).
		1212
		1213	The rationale behind this is that implementing the lock-out model for
		1214	watchers is not well supported by most kernel interfaces, and most event
		1215	libraries will just poll for the same events again and again as long as
		1216	their callbacks have not been executed, which is very inefficient in the
		1217	common case of one high-priority watcher locking out a mass of lower
		1218	priority ones.
		1219
		1220	Static (ordering) priorities are most useful when you have two or more
		1221	watchers handling the same resource: a typical usage example is having an
		1222	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1223	timeouts. Under load, data might be received while the program handles
		1224	other jobs, but since timers normally get invoked first, the timeout
		1225	handler will be executed before checking for data. In that case, giving
		1226	the timer a lower priority than the I/O watcher ensures that I/O will be
		1227	handled first even under adverse conditions (which is usually, but not
		1228	always, what you want).
		1229
		1230	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1231	will only be executed when no same or higher priority watchers have
		1232	received events, they can be used to implement the "lock-out" model when
		1233	required.
		1234
		1235	For example, to emulate how many other event libraries handle priorities,
		1236	you can associate an C<ev_idle> watcher to each such watcher, and in
		1237	the normal watcher callback, you just start the idle watcher. The real
		1238	processing is done in the idle watcher callback. This causes libev to
		1239	continously poll and process kernel event data for the watcher, but when
		1240	the lock-out case is known to be rare (which in turn is rare :), this is
		1241	workable.
		1242
		1243	Usually, however, the lock-out model implemented that way will perform
		1244	miserably under the type of load it was designed to handle. In that case,
		1245	it might be preferable to stop the real watcher before starting the
		1246	idle watcher, so the kernel will not have to process the event in case
		1247	the actual processing will be delayed for considerable time.
		1248
		1249	Here is an example of an I/O watcher that should run at a strictly lower
		1250	priority than the default, and which should only process data when no
		1251	other events are pending:
		1252
		1253	ev_idle idle; // actual processing watcher
		1254	ev_io io; // actual event watcher
		1255
		1256	static void
		1257	io_cb (EV_P_ ev_io *w, int revents)
		1258	{
		1259	// stop the I/O watcher, we received the event, but
		1260	// are not yet ready to handle it.
		1261	ev_io_stop (EV_A_ w);
		1262
		1263	// start the idle watcher to ahndle the actual event.
		1264	// it will not be executed as long as other watchers
		1265	// with the default priority are receiving events.
		1266	ev_idle_start (EV_A_ &idle);
		1267	}
		1268
		1269	static void
		1270	idle-cb (EV_P_ ev_idle *w, int revents)
		1271	{
		1272	// actual processing
		1273	read (STDIN_FILENO, ...);
		1274
		1275	// have to start the I/O watcher again, as
		1276	// we have handled the event
		1277	ev_io_start (EV_P_ &io);
		1278	}
		1279
		1280	// initialisation
		1281	ev_idle_init (&idle, idle_cb);
		1282	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1283	ev_io_start (EV_DEFAULT_ &io);
		1284
		1285	In the "real" world, it might also be beneficial to start a timer, so that
		1286	low-priority connections can not be locked out forever under load. This
		1287	enables your program to keep a lower latency for important connections
		1288	during short periods of high load, while not completely locking out less
		1289	important ones.
1122		1290
1123		1291
1124	=head1 WATCHER TYPES	1292	=head1 WATCHER TYPES
1125		1293
1126	This section describes each watcher in detail, but will not repeat	1294	This section describes each watcher in detail, but will not repeat
…		…
1283	year, it will still time out after (roughly) one hour. "Roughly" because	1451	year, it will still time out after (roughly) one hour. "Roughly" because
1284	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1452	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1285	monotonic clock option helps a lot here).	1453	monotonic clock option helps a lot here).
1286		1454
1287	The callback is guaranteed to be invoked only I<after> its timeout has	1455	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	1456	passed. If multiple timers become ready during the same loop iteration
1289	then order of execution is undefined.	1457	then the ones with earlier time-out values are invoked before ones with
		1458	later time-out values (but this is no longer true when a callback calls
		1459	C<ev_loop> recursively).
1290		1460
1291	=head3 Be smart about timeouts	1461	=head3 Be smart about timeouts
1292		1462
1293	Many real-world problems invole some kind of time-out, usually for error	1463	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,	1464	recovery. A typical example is an HTTP request - if the other side hangs,
1295	you want to raise some error after a while.	1465	you want to raise some error after a while.
1296		1466
1297	Here are some ways on how to handle this problem, from simple and	1467	What follows are some ways to handle this problem, from obvious and
1298	inefficient to very efficient.	1468	inefficient to smart and efficient.
1299		1469
1300	In the following examples a 60 second activity timeout is assumed - a	1470	In the following, a 60 second activity timeout is assumed - a timeout that
1301	timeout that gets reset to 60 seconds each time some data ("a lifesign")	1471	gets reset to 60 seconds each time there is activity (e.g. each time some
1302	was received.	1472	data or other life sign was received).
1303		1473
1304	=over 4	1474	=over 4
1305		1475
1306	=item 1. Use a timer and stop, reinitialise, start it on activity.	1476	=item 1. Use a timer and stop, reinitialise and start it on activity.
1307		1477
1308	This is the most obvious, but not the most simple way: In the beginning,	1478	This is the most obvious, but not the most simple way: In the beginning,
1309	start the watcher:	1479	start the watcher:
1310		1480
1311	ev_timer_init (timer, callback, 60., 0.);	1481	ev_timer_init (timer, callback, 60., 0.);
1312	ev_timer_start (loop, timer);	1482	ev_timer_start (loop, timer);
1313		1483
1314	Then, each time there is some activity, C<ev_timer_stop> the timer,	1484	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
1315	initialise it again, and start it:	1485	and start it again:
1316		1486
1317	ev_timer_stop (loop, timer);	1487	ev_timer_stop (loop, timer);
1318	ev_timer_set (timer, 60., 0.);	1488	ev_timer_set (timer, 60., 0.);
1319	ev_timer_start (loop, timer);	1489	ev_timer_start (loop, timer);
1320		1490
1321	This is relatively simple to implement, but means that each time there	1491	This is relatively simple to implement, but means that each time there is
1322	is some activity, libev will first have to remove the timer from it's	1492	some activity, libev will first have to remove the timer from its internal
1323	internal data strcuture and then add it again.	1493	data structure and then add it again. Libev tries to be fast, but it's
		1494	still not a constant-time operation.
1324		1495
1325	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.	1496	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
1326		1497
1327	This is the easiest way, and involves using C<ev_timer_again> instead of	1498	This is the easiest way, and involves using C<ev_timer_again> instead of
1328	C<ev_timer_start>.	1499	C<ev_timer_start>.
1329		1500
1330	For this, configure an C<ev_timer> with a C<repeat> value of C<60> and	1501	To implement this, configure an C<ev_timer> with a C<repeat> value
1331	then call C<ev_timer_again> at start and each time you successfully read	1502	of C<60> and then call C<ev_timer_again> at start and each time you
1332	or write some data. If you go into an idle state where you do not expect	1503	successfully read or write some data. If you go into an idle state where
1333	data to travel on the socket, you can C<ev_timer_stop> the timer, and	1504	you do not expect data to travel on the socket, you can C<ev_timer_stop>
1334	C<ev_timer_again> will automatically restart it if need be.	1505	the timer, and C<ev_timer_again> will automatically restart it if need be.
1335		1506
1336	That means you can ignore the C<after> value and C<ev_timer_start>	1507	That means you can ignore both the C<ev_timer_start> function and the
1337	altogether and only ever use the C<repeat> value and C<ev_timer_again>.	1508	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1509	member and C<ev_timer_again>.
1338		1510
1339	At start:	1511	At start:
1340		1512
1341	ev_timer_init (timer, callback, 0., 60.);	1513	ev_timer_init (timer, callback);
		1514	timer->repeat = 60.;
1342	ev_timer_again (loop, timer);	1515	ev_timer_again (loop, timer);
1343		1516
1344	Each time you receive some data:	1517	Each time there is some activity:
1345		1518
1346	ev_timer_again (loop, timer);	1519	ev_timer_again (loop, timer);
1347		1520
1348	It is even possible to change the time-out on the fly:	1521	It is even possible to change the time-out on the fly, regardless of
		1522	whether the watcher is active or not:
1349		1523
1350	timer->repeat = 30.;	1524	timer->repeat = 30.;
1351	ev_timer_again (loop, timer);	1525	ev_timer_again (loop, timer);
1352		1526
1353	This is slightly more efficient then stopping/starting the timer each time	1527	This is slightly more efficient then stopping/starting the timer each time
1354	you want to modify its timeout value, as libev does not have to completely	1528	you want to modify its timeout value, as libev does not have to completely
1355	remove and re-insert the timer from/into it's internal data structure.	1529	remove and re-insert the timer from/into its internal data structure.
		1530
		1531	It is, however, even simpler than the "obvious" way to do it.
1356		1532
1357	=item 3. Let the timer time out, but then re-arm it as required.	1533	=item 3. Let the timer time out, but then re-arm it as required.
1358		1534
1359	This method is more tricky, but usually most efficient: Most timeouts are	1535	This method is more tricky, but usually most efficient: Most timeouts are
1360	relatively long compared to the loop iteration time - in our example,	1536	relatively long compared to the intervals between other activity - in
1361	within 60 seconds, there are usually many I/O events with associated	1537	our example, within 60 seconds, there are usually many I/O events with
1362	activity resets.	1538	associated activity resets.
1363		1539
1364	In this case, it would be more efficient to leave the C<ev_timer> alone,	1540	In this case, it would be more efficient to leave the C<ev_timer> alone,
1365	but remember the time of last activity, and check for a real timeout only	1541	but remember the time of last activity, and check for a real timeout only
1366	within the callback:	1542	within the callback:
1367		1543
1368	ev_tstamp last_activity; // time of last activity	1544	ev_tstamp last_activity; // time of last activity
1369		1545
1370	static void	1546	static void
1371	callback (EV_P_ ev_timer *w, int revents)	1547	callback (EV_P_ ev_timer *w, int revents)
1372	{	1548	{
1373	ev_tstamp now = ev_now (EV_A);	1549	ev_tstamp now = ev_now (EV_A);
1374	ev_tstamp timeout = last_activity + 60.;	1550	ev_tstamp timeout = last_activity + 60.;
1375		1551
1376	// if last_activity is older than now - timeout, we did time out	1552	// if last_activity + 60. is older than now, we did time out
1377	if (timeout < now)	1553	if (timeout < now)
1378	{	1554	{
1379	// timeout occured, take action	1555	// timeout occured, take action
1380	}	1556	}
1381	else	1557	else
1382	{	1558	{
1383	// callback was invoked, but there was some activity, re-arm	1559	// callback was invoked, but there was some activity, re-arm
1384	// to fire in last_activity + 60.	1560	// the watcher to fire in last_activity + 60, which is
		1561	// guaranteed to be in the future, so "again" is positive:
1385	w->again = timeout - now;	1562	w->repeat = timeout - now;
1386	ev_timer_again (EV_A_ w);	1563	ev_timer_again (EV_A_ w);
1387	}	1564	}
1388	}	1565	}
1389		1566
1390	To summarise the callback: first calculate the real time-out (defined as	1567	To summarise the callback: first calculate the real timeout (defined
1391	"60 seconds after the last activity"), then check if that time has been	1568	as "60 seconds after the last activity"), then check if that time has
1392	reached, which means there was a real timeout. Otherwise the callback was	1569	been reached, which means something I<did>, in fact, time out. Otherwise
1393	invoked too early (timeout is in the future), so re-schedule the timer to	1570	the callback was invoked too early (C<timeout> is in the future), so
1394	fire at that future time.	1571	re-schedule the timer to fire at that future time, to see if maybe we have
		1572	a timeout then.
1395		1573
1396	Note how C<ev_timer_again> is used, taking advantage of the	1574	Note how C<ev_timer_again> is used, taking advantage of the
1397	C<ev_timer_again> optimisation when the timer is already running.	1575	C<ev_timer_again> optimisation when the timer is already running.
1398		1576
1399	This scheme causes more callback invocations (about one every 60 seconds),	1577	This scheme causes more callback invocations (about one every 60 seconds
1400	but virtually no calls to libev to change the timeout.	1578	minus half the average time between activity), but virtually no calls to
		1579	libev to change the timeout.
1401		1580
1402	To start the timer, simply intiialise the watcher and C<last_activity>,	1581	To start the timer, simply initialise the watcher and set C<last_activity>
1403	then call the callback:	1582	to the current time (meaning we just have some activity :), then call the
		1583	callback, which will "do the right thing" and start the timer:
1404		1584
1405	ev_timer_init (timer, callback);	1585	ev_timer_init (timer, callback);
1406	last_activity = ev_now (loop);	1586	last_activity = ev_now (loop);
1407	callback (loop, timer, EV_TIMEOUT);	1587	callback (loop, timer, EV_TIMEOUT);
1408		1588
1409	And when there is some activity, simply remember the time in	1589	And when there is some activity, simply store the current time in
1410	C<last_activity>:	1590	C<last_activity>, no libev calls at all:
1411		1591
1412	last_actiivty = ev_now (loop);	1592	last_actiivty = ev_now (loop);
1413		1593
1414	This technique is slightly more complex, but in most cases where the	1594	This technique is slightly more complex, but in most cases where the
1415	time-out is unlikely to be triggered, much more efficient.	1595	time-out is unlikely to be triggered, much more efficient.
1416		1596
		1597	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1598	callback :) - just change the timeout and invoke the callback, which will
		1599	fix things for you.
		1600
		1601	=item 4. Wee, just use a double-linked list for your timeouts.
		1602
		1603	If there is not one request, but many thousands (millions...), all
		1604	employing some kind of timeout with the same timeout value, then one can
		1605	do even better:
		1606
		1607	When starting the timeout, calculate the timeout value and put the timeout
		1608	at the I<end> of the list.
		1609
		1610	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1611	the list is expected to fire (for example, using the technique #3).
		1612
		1613	When there is some activity, remove the timer from the list, recalculate
		1614	the timeout, append it to the end of the list again, and make sure to
		1615	update the C<ev_timer> if it was taken from the beginning of the list.
		1616
		1617	This way, one can manage an unlimited number of timeouts in O(1) time for
		1618	starting, stopping and updating the timers, at the expense of a major
		1619	complication, and having to use a constant timeout. The constant timeout
		1620	ensures that the list stays sorted.
		1621
1417	=back	1622	=back
		1623
		1624	So which method the best?
		1625
		1626	Method #2 is a simple no-brain-required solution that is adequate in most
		1627	situations. Method #3 requires a bit more thinking, but handles many cases
		1628	better, and isn't very complicated either. In most case, choosing either
		1629	one is fine, with #3 being better in typical situations.
		1630
		1631	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1632	rather complicated, but extremely efficient, something that really pays
		1633	off after the first million or so of active timers, i.e. it's usually
		1634	overkill :)
1418		1635
1419	=head3 The special problem of time updates	1636	=head3 The special problem of time updates
1420		1637
1421	Establishing the current time is a costly operation (it usually takes at	1638	Establishing the current time is a costly operation (it usually takes at
1422	least two system calls): EV therefore updates its idea of the current	1639	least two system calls): EV therefore updates its idea of the current
…		…
1466	If the timer is started but non-repeating, stop it (as if it timed out).	1683	If the timer is started but non-repeating, stop it (as if it timed out).
1467		1684
1468	If the timer is repeating, either start it if necessary (with the	1685	If the timer is repeating, either start it if necessary (with the
1469	C<repeat> value), or reset the running timer to the C<repeat> value.	1686	C<repeat> value), or reset the running timer to the C<repeat> value.
1470		1687
1471	This sounds a bit complicated, see "Be smart about timeouts", above, for a	1688	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1472	usage example.	1689	usage example.
1473		1690
1474	=item ev_tstamp repeat [read-write]	1691	=item ev_tstamp repeat [read-write]
1475		1692
1476	The current C<repeat> value. Will be used each time the watcher times out	1693	The current C<repeat> value. Will be used each time the watcher times out
…		…
1515	=head2 C<ev_periodic> - to cron or not to cron?	1732	=head2 C<ev_periodic> - to cron or not to cron?
1516		1733
1517	Periodic watchers are also timers of a kind, but they are very versatile	1734	Periodic watchers are also timers of a kind, but they are very versatile
1518	(and unfortunately a bit complex).	1735	(and unfortunately a bit complex).
1519		1736
1520	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1737	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1521	but on wall clock time (absolute time). You can tell a periodic watcher	1738	relative time, the physical time that passes) but on wall clock time
1522	to trigger after some specific point in time. For example, if you tell a	1739	(absolute time, the thing you can read on your calender or clock). The
1523	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()	1740	difference is that wall clock time can run faster or slower than real
1524	+ 10.>, that is, an absolute time not a delay) and then reset your system	1741	time, and time jumps are not uncommon (e.g. when you adjust your
1525	clock to January of the previous year, then it will take more than year	1742	wrist-watch).
1526	to trigger the event (unlike an C<ev_timer>, which would still trigger
1527	roughly 10 seconds later as it uses a relative timeout).
1528		1743
		1744	You can tell a periodic watcher to trigger after some specific point
		1745	in time: for example, if you tell a periodic watcher to trigger "in 10
		1746	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1747	not a delay) and then reset your system clock to January of the previous
		1748	year, then it will take a year or more to trigger the event (unlike an
		1749	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1750	it, as it uses a relative timeout).
		1751
1529	C<ev_periodic>s can also be used to implement vastly more complex timers,	1752	C<ev_periodic> watchers can also be used to implement vastly more complex
1530	such as triggering an event on each "midnight, local time", or other	1753	timers, such as triggering an event on each "midnight, local time", or
1531	complicated rules.	1754	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1755	those cannot react to time jumps.
1532		1756
1533	As with timers, the callback is guaranteed to be invoked only when the	1757	As with timers, the callback is guaranteed to be invoked only when the
1534	time (C<at>) has passed, but if multiple periodic timers become ready	1758	point in time where it is supposed to trigger has passed. If multiple
1535	during the same loop iteration, then order of execution is undefined.	1759	timers become ready during the same loop iteration then the ones with
		1760	earlier time-out values are invoked before ones with later time-out values
		1761	(but this is no longer true when a callback calls C<ev_loop> recursively).
1536		1762
1537	=head3 Watcher-Specific Functions and Data Members	1763	=head3 Watcher-Specific Functions and Data Members
1538		1764
1539	=over 4	1765	=over 4
1540		1766
1541	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1767	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1542		1768
1543	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1769	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1544		1770
1545	Lots of arguments, lets sort it out... There are basically three modes of	1771	Lots of arguments, let's sort it out... There are basically three modes of
1546	operation, and we will explain them from simplest to most complex:	1772	operation, and we will explain them from simplest to most complex:
1547		1773
1548	=over 4	1774	=over 4
1549		1775
1550	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1776	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1551		1777
1552	In this configuration the watcher triggers an event after the wall clock	1778	In this configuration the watcher triggers an event after the wall clock
1553	time C<at> has passed. It will not repeat and will not adjust when a time	1779	time C<offset> has passed. It will not repeat and will not adjust when a
1554	jump occurs, that is, if it is to be run at January 1st 2011 then it will	1780	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1555	only run when the system clock reaches or surpasses this time.	1781	will be stopped and invoked when the system clock reaches or surpasses
		1782	this point in time.
1556		1783
1557	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1784	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1558		1785
1559	In this mode the watcher will always be scheduled to time out at the next	1786	In this mode the watcher will always be scheduled to time out at the next
1560	C<at + N * interval> time (for some integer N, which can also be negative)	1787	C<offset + N * interval> time (for some integer N, which can also be
1561	and then repeat, regardless of any time jumps.	1788	negative) and then repeat, regardless of any time jumps. The C<offset>
		1789	argument is merely an offset into the C<interval> periods.
1562		1790
1563	This can be used to create timers that do not drift with respect to the	1791	This can be used to create timers that do not drift with respect to the
1564	system clock, for example, here is a C<ev_periodic> that triggers each	1792	system clock, for example, here is an C<ev_periodic> that triggers each
1565	hour, on the hour:	1793	hour, on the hour (with respect to UTC):
1566		1794
1567	ev_periodic_set (&periodic, 0., 3600., 0);	1795	ev_periodic_set (&periodic, 0., 3600., 0);
1568		1796
1569	This doesn't mean there will always be 3600 seconds in between triggers,	1797	This doesn't mean there will always be 3600 seconds in between triggers,
1570	but only that the callback will be called when the system time shows a	1798	but only that the callback will be called when the system time shows a
1571	full hour (UTC), or more correctly, when the system time is evenly divisible	1799	full hour (UTC), or more correctly, when the system time is evenly divisible
1572	by 3600.	1800	by 3600.
1573		1801
1574	Another way to think about it (for the mathematically inclined) is that	1802	Another way to think about it (for the mathematically inclined) is that
1575	C<ev_periodic> will try to run the callback in this mode at the next possible	1803	C<ev_periodic> will try to run the callback in this mode at the next possible
1576	time where C<time = at (mod interval)>, regardless of any time jumps.	1804	time where C<time = offset (mod interval)>, regardless of any time jumps.
1577		1805
1578	For numerical stability it is preferable that the C<at> value is near	1806	For numerical stability it is preferable that the C<offset> value is near
1579	C<ev_now ()> (the current time), but there is no range requirement for	1807	C<ev_now ()> (the current time), but there is no range requirement for
1580	this value, and in fact is often specified as zero.	1808	this value, and in fact is often specified as zero.
1581		1809
1582	Note also that there is an upper limit to how often a timer can fire (CPU	1810	Note also that there is an upper limit to how often a timer can fire (CPU
1583	speed for example), so if C<interval> is very small then timing stability	1811	speed for example), so if C<interval> is very small then timing stability
1584	will of course deteriorate. Libev itself tries to be exact to be about one	1812	will of course deteriorate. Libev itself tries to be exact to be about one
1585	millisecond (if the OS supports it and the machine is fast enough).	1813	millisecond (if the OS supports it and the machine is fast enough).
1586		1814
1587	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1815	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1588		1816
1589	In this mode the values for C<interval> and C<at> are both being	1817	In this mode the values for C<interval> and C<offset> are both being
1590	ignored. Instead, each time the periodic watcher gets scheduled, the	1818	ignored. Instead, each time the periodic watcher gets scheduled, the
1591	reschedule callback will be called with the watcher as first, and the	1819	reschedule callback will be called with the watcher as first, and the
1592	current time as second argument.	1820	current time as second argument.
1593		1821
1594	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1822	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1595	ever, or make ANY event loop modifications whatsoever>.	1823	or make ANY other event loop modifications whatsoever, unless explicitly
		1824	allowed by documentation here>.
1596		1825
1597	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	1826	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1598	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the	1827	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1599	only event loop modification you are allowed to do).	1828	only event loop modification you are allowed to do).
1600		1829
…		…
1630	a different time than the last time it was called (e.g. in a crond like	1859	a different time than the last time it was called (e.g. in a crond like
1631	program when the crontabs have changed).	1860	program when the crontabs have changed).
1632		1861
1633	=item ev_tstamp ev_periodic_at (ev_periodic *)	1862	=item ev_tstamp ev_periodic_at (ev_periodic *)
1634		1863
1635	When active, returns the absolute time that the watcher is supposed to	1864	When active, returns the absolute time that the watcher is supposed
1636	trigger next.	1865	to trigger next. This is not the same as the C<offset> argument to
		1866	C<ev_periodic_set>, but indeed works even in interval and manual
		1867	rescheduling modes.
1637		1868
1638	=item ev_tstamp offset [read-write]	1869	=item ev_tstamp offset [read-write]
1639		1870
1640	When repeating, this contains the offset value, otherwise this is the	1871	When repeating, this contains the offset value, otherwise this is the
1641	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1872	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1873	although libev might modify this value for better numerical stability).
1642		1874
1643	Can be modified any time, but changes only take effect when the periodic	1875	Can be modified any time, but changes only take effect when the periodic
1644	timer fires or C<ev_periodic_again> is being called.	1876	timer fires or C<ev_periodic_again> is being called.
1645		1877
1646	=item ev_tstamp interval [read-write]	1878	=item ev_tstamp interval [read-write]
…		…
1852		2084
1853		2085
1854	=head2 C<ev_stat> - did the file attributes just change?	2086	=head2 C<ev_stat> - did the file attributes just change?
1855		2087
1856	This watches a file system path for attribute changes. That is, it calls	2088	This watches a file system path for attribute changes. That is, it calls
1857	C<stat> regularly (or when the OS says it changed) and sees if it changed	2089	C<stat> on that path in regular intervals (or when the OS says it changed)
1858	compared to the last time, invoking the callback if it did.	2090	and sees if it changed compared to the last time, invoking the callback if
		2091	it did.
1859		2092
1860	The path does not need to exist: changing from "path exists" to "path does	2093	The path does not need to exist: changing from "path exists" to "path does
1861	not exist" is a status change like any other. The condition "path does	2094	not exist" is a status change like any other. The condition "path does not
1862	not exist" is signified by the C<st_nlink> field being zero (which is	2095	exist" (or more correctly "path cannot be stat'ed") is signified by the
1863	otherwise always forced to be at least one) and all the other fields of	2096	C<st_nlink> field being zero (which is otherwise always forced to be at
1864	the stat buffer having unspecified contents.	2097	least one) and all the other fields of the stat buffer having unspecified
		2098	contents.
1865		2099
1866	The path I<should> be absolute and I<must not> end in a slash. If it is	2100	The path I<must not> end in a slash or contain special components such as
		2101	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1867	relative and your working directory changes, the behaviour is undefined.	2102	your working directory changes, then the behaviour is undefined.
1868		2103
1869	Since there is no standard kernel interface to do this, the portable	2104	Since there is no portable change notification interface available, the
1870	implementation simply calls C<stat (2)> regularly on the path to see if	2105	portable implementation simply calls C<stat(2)> regularly on the path
1871	it changed somehow. You can specify a recommended polling interval for	2106	to see if it changed somehow. You can specify a recommended polling
1872	this case. If you specify a polling interval of C<0> (highly recommended!)	2107	interval for this case. If you specify a polling interval of C<0> (highly
1873	then a I<suitable, unspecified default> value will be used (which	2108	recommended!) then a I<suitable, unspecified default> value will be used
1874	you can expect to be around five seconds, although this might change	2109	(which you can expect to be around five seconds, although this might
1875	dynamically). Libev will also impose a minimum interval which is currently	2110	change dynamically). Libev will also impose a minimum interval which is
1876	around C<0.1>, but thats usually overkill.	2111	currently around C<0.1>, but that's usually overkill.
1877		2112
1878	This watcher type is not meant for massive numbers of stat watchers,	2113	This watcher type is not meant for massive numbers of stat watchers,
1879	as even with OS-supported change notifications, this can be	2114	as even with OS-supported change notifications, this can be
1880	resource-intensive.	2115	resource-intensive.
1881		2116
1882	At the time of this writing, the only OS-specific interface implemented	2117	At the time of this writing, the only OS-specific interface implemented
1883	is the Linux inotify interface (implementing kqueue support is left as	2118	is the Linux inotify interface (implementing kqueue support is left as an
1884	an exercise for the reader. Note, however, that the author sees no way	2119	exercise for the reader. Note, however, that the author sees no way of
1885	of implementing C<ev_stat> semantics with kqueue).	2120	implementing C<ev_stat> semantics with kqueue, except as a hint).
1886		2121
1887	=head3 ABI Issues (Largefile Support)	2122	=head3 ABI Issues (Largefile Support)
1888		2123
1889	Libev by default (unless the user overrides this) uses the default	2124	Libev by default (unless the user overrides this) uses the default
1890	compilation environment, which means that on systems with large file	2125	compilation environment, which means that on systems with large file
1891	support disabled by default, you get the 32 bit version of the stat	2126	support disabled by default, you get the 32 bit version of the stat
1892	structure. When using the library from programs that change the ABI to	2127	structure. When using the library from programs that change the ABI to
1893	use 64 bit file offsets the programs will fail. In that case you have to	2128	use 64 bit file offsets the programs will fail. In that case you have to
1894	compile libev with the same flags to get binary compatibility. This is	2129	compile libev with the same flags to get binary compatibility. This is
1895	obviously the case with any flags that change the ABI, but the problem is	2130	obviously the case with any flags that change the ABI, but the problem is
1896	most noticeably disabled with ev_stat and large file support.	2131	most noticeably displayed with ev_stat and large file support.
1897		2132
1898	The solution for this is to lobby your distribution maker to make large	2133	The solution for this is to lobby your distribution maker to make large
1899	file interfaces available by default (as e.g. FreeBSD does) and not	2134	file interfaces available by default (as e.g. FreeBSD does) and not
1900	optional. Libev cannot simply switch on large file support because it has	2135	optional. Libev cannot simply switch on large file support because it has
1901	to exchange stat structures with application programs compiled using the	2136	to exchange stat structures with application programs compiled using the
1902	default compilation environment.	2137	default compilation environment.
1903		2138
1904	=head3 Inotify and Kqueue	2139	=head3 Inotify and Kqueue
1905		2140
1906	When C<inotify (7)> support has been compiled into libev (generally	2141	When C<inotify (7)> support has been compiled into libev and present at
1907	only available with Linux 2.6.25 or above due to bugs in earlier	2142	runtime, it will be used to speed up change detection where possible. The
1908	implementations) and present at runtime, it will be used to speed up	2143	inotify descriptor will be created lazily when the first C<ev_stat>
1909	change detection where possible. The inotify descriptor will be created	2144	watcher is being started.
1910	lazily when the first C<ev_stat> watcher is being started.
1911		2145
1912	Inotify presence does not change the semantics of C<ev_stat> watchers	2146	Inotify presence does not change the semantics of C<ev_stat> watchers
1913	except that changes might be detected earlier, and in some cases, to avoid	2147	except that changes might be detected earlier, and in some cases, to avoid
1914	making regular C<stat> calls. Even in the presence of inotify support	2148	making regular C<stat> calls. Even in the presence of inotify support
1915	there are many cases where libev has to resort to regular C<stat> polling,	2149	there are many cases where libev has to resort to regular C<stat> polling,
1916	but as long as the path exists, libev usually gets away without polling.	2150	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2151	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2152	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2153	xfs are fully working) libev usually gets away without polling.
1917		2154
1918	There is no support for kqueue, as apparently it cannot be used to	2155	There is no support for kqueue, as apparently it cannot be used to
1919	implement this functionality, due to the requirement of having a file	2156	implement this functionality, due to the requirement of having a file
1920	descriptor open on the object at all times, and detecting renames, unlinks	2157	descriptor open on the object at all times, and detecting renames, unlinks
1921	etc. is difficult.	2158	etc. is difficult.
1922		2159
		2160	=head3 C<stat ()> is a synchronous operation
		2161
		2162	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2163	the process. The exception are C<ev_stat> watchers - those call C<stat
		2164	()>, which is a synchronous operation.
		2165
		2166	For local paths, this usually doesn't matter: unless the system is very
		2167	busy or the intervals between stat's are large, a stat call will be fast,
		2168	as the path data is usually in memory already (except when starting the
		2169	watcher).
		2170
		2171	For networked file systems, calling C<stat ()> can block an indefinite
		2172	time due to network issues, and even under good conditions, a stat call
		2173	often takes multiple milliseconds.
		2174
		2175	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2176	paths, although this is fully supported by libev.
		2177
1923	=head3 The special problem of stat time resolution	2178	=head3 The special problem of stat time resolution
1924		2179
1925	The C<stat ()> system call only supports full-second resolution portably, and	2180	The C<stat ()> system call only supports full-second resolution portably,
1926	even on systems where the resolution is higher, most file systems still	2181	and even on systems where the resolution is higher, most file systems
1927	only support whole seconds.	2182	still only support whole seconds.
1928		2183
1929	That means that, if the time is the only thing that changes, you can	2184	That means that, if the time is the only thing that changes, you can
1930	easily miss updates: on the first update, C<ev_stat> detects a change and	2185	easily miss updates: on the first update, C<ev_stat> detects a change and
1931	calls your callback, which does something. When there is another update	2186	calls your callback, which does something. When there is another update
1932	within the same second, C<ev_stat> will be unable to detect unless the	2187	within the same second, C<ev_stat> will be unable to detect unless the
…		…
2075		2330
2076	=head3 Watcher-Specific Functions and Data Members	2331	=head3 Watcher-Specific Functions and Data Members
2077		2332
2078	=over 4	2333	=over 4
2079		2334
2080	=item ev_idle_init (ev_signal *, callback)	2335	=item ev_idle_init (ev_idle *, callback)
2081		2336
2082	Initialises and configures the idle watcher - it has no parameters of any	2337	Initialises and configures the idle watcher - it has no parameters of any
2083	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2338	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2084	believe me.	2339	believe me.
2085		2340
…		…
2324	some fds have to be watched and handled very quickly (with low latency),	2579	some fds have to be watched and handled very quickly (with low latency),
2325	and even priorities and idle watchers might have too much overhead. In	2580	and even priorities and idle watchers might have too much overhead. In
2326	this case you would put all the high priority stuff in one loop and all	2581	this case you would put all the high priority stuff in one loop and all
2327	the rest in a second one, and embed the second one in the first.	2582	the rest in a second one, and embed the second one in the first.
2328		2583
2329	As long as the watcher is active, the callback will be invoked every time	2584	As long as the watcher is active, the callback will be invoked every
2330	there might be events pending in the embedded loop. The callback must then	2585	time there might be events pending in the embedded loop. The callback
2331	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2586	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2332	their callbacks (you could also start an idle watcher to give the embedded	2587	sweep and invoke their callbacks (the callback doesn't need to invoke the
2333	loop strictly lower priority for example). You can also set the callback	2588	C<ev_embed_sweep> function directly, it could also start an idle watcher
2334	to C<0>, in which case the embed watcher will automatically execute the	2589	to give the embedded loop strictly lower priority for example).
2335	embedded loop sweep.
2336		2590
2337	As long as the watcher is started it will automatically handle events. The	2591	You can also set the callback to C<0>, in which case the embed watcher
2338	callback will be invoked whenever some events have been handled. You can	2592	will automatically execute the embedded loop sweep whenever necessary.
2339	set the callback to C<0> to avoid having to specify one if you are not
2340	interested in that.
2341		2593
2342	Also, there have not currently been made special provisions for forking:	2594	Fork detection will be handled transparently while the C<ev_embed> watcher
2343	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2595	is active, i.e., the embedded loop will automatically be forked when the
2344	but you will also have to stop and restart any C<ev_embed> watchers	2596	embedding loop forks. In other cases, the user is responsible for calling
2345	yourself - but you can use a fork watcher to handle this automatically,	2597	C<ev_loop_fork> on the embedded loop.
2346	and future versions of libev might do just that.
2347		2598
2348	Unfortunately, not all backends are embeddable: only the ones returned by	2599	Unfortunately, not all backends are embeddable: only the ones returned by
2349	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2600	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2350	portable one.	2601	portable one.
2351		2602
…		…
2571	=over 4	2822	=over 4
2572		2823
2573	=item ev_async_init (ev_async *, callback)	2824	=item ev_async_init (ev_async *, callback)
2574		2825
2575	Initialises and configures the async watcher - it has no parameters of any	2826	Initialises and configures the async watcher - it has no parameters of any
2576	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	2827	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2577	trust me.	2828	trust me.
2578		2829
2579	=item ev_async_send (loop, ev_async *)	2830	=item ev_async_send (loop, ev_async *)
2580		2831
2581	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2832	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2582	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2833	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2583	C<ev_feed_event>, this call is safe to do from other threads, signal or	2834	C<ev_feed_event>, this call is safe to do from other threads, signal or
2584	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	2835	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2585	section below on what exactly this means).	2836	section below on what exactly this means).
2586		2837
		2838	Note that, as with other watchers in libev, multiple events might get
		2839	compressed into a single callback invocation (another way to look at this
		2840	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2841	reset when the event loop detects that).
		2842
2587	This call incurs the overhead of a system call only once per loop iteration,	2843	This call incurs the overhead of a system call only once per event loop
2588	so while the overhead might be noticeable, it doesn't apply to repeated	2844	iteration, so while the overhead might be noticeable, it doesn't apply to
2589	calls to C<ev_async_send>.	2845	repeated calls to C<ev_async_send> for the same event loop.
2590		2846
2591	=item bool = ev_async_pending (ev_async *)	2847	=item bool = ev_async_pending (ev_async *)
2592		2848
2593	Returns a non-zero value when C<ev_async_send> has been called on the	2849	Returns a non-zero value when C<ev_async_send> has been called on the
2594	watcher but the event has not yet been processed (or even noted) by the	2850	watcher but the event has not yet been processed (or even noted) by the
…		…
2597	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2853	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2598	the loop iterates next and checks for the watcher to have become active,	2854	the loop iterates next and checks for the watcher to have become active,
2599	it will reset the flag again. C<ev_async_pending> can be used to very	2855	it will reset the flag again. C<ev_async_pending> can be used to very
2600	quickly check whether invoking the loop might be a good idea.	2856	quickly check whether invoking the loop might be a good idea.
2601		2857
2602	Not that this does I<not> check whether the watcher itself is pending, only	2858	Not that this does I<not> check whether the watcher itself is pending,
2603	whether it has been requested to make this watcher pending.	2859	only whether it has been requested to make this watcher pending: there
		2860	is a time window between the event loop checking and resetting the async
		2861	notification, and the callback being invoked.
2604		2862
2605	=back	2863	=back
2606		2864
2607		2865
2608	=head1 OTHER FUNCTIONS	2866	=head1 OTHER FUNCTIONS
…		…
2787		3045
2788	myclass obj;	3046	myclass obj;
2789	ev::io iow;	3047	ev::io iow;
2790	iow.set <myclass, &myclass::io_cb> (&obj);	3048	iow.set <myclass, &myclass::io_cb> (&obj);
2791		3049
		3050	=item w->set (object *)
		3051
		3052	This is an B<experimental> feature that might go away in a future version.
		3053
		3054	This is a variation of a method callback - leaving out the method to call
		3055	will default the method to C<operator ()>, which makes it possible to use
		3056	functor objects without having to manually specify the C<operator ()> all
		3057	the time. Incidentally, you can then also leave out the template argument
		3058	list.
		3059
		3060	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3061	int revents)>.
		3062
		3063	See the method-C<set> above for more details.
		3064
		3065	Example: use a functor object as callback.
		3066
		3067	struct myfunctor
		3068	{
		3069	void operator() (ev::io &w, int revents)
		3070	{
		3071	...
		3072	}
		3073	}
		3074
		3075	myfunctor f;
		3076
		3077	ev::io w;
		3078	w.set (&f);
		3079
2792	=item w->set<function> (void *data = 0)	3080	=item w->set<function> (void *data = 0)
2793		3081
2794	Also sets a callback, but uses a static method or plain function as	3082	Also sets a callback, but uses a static method or plain function as
2795	callback. The optional C<data> argument will be stored in the watcher's	3083	callback. The optional C<data> argument will be stored in the watcher's
2796	C<data> member and is free for you to use.	3084	C<data> member and is free for you to use.
…		…
2882	L<http://software.schmorp.de/pkg/EV>.	3170	L<http://software.schmorp.de/pkg/EV>.
2883		3171
2884	=item Python	3172	=item Python
2885		3173
2886	Python bindings can be found at L<http://code.google.com/p/pyev/>. It	3174	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
2887	seems to be quite complete and well-documented. Note, however, that the	3175	seems to be quite complete and well-documented.
2888	patch they require for libev is outright dangerous as it breaks the ABI
2889	for everybody else, and therefore, should never be applied in an installed
2890	libev (if python requires an incompatible ABI then it needs to embed
2891	libev).
2892		3176
2893	=item Ruby	3177	=item Ruby
2894		3178
2895	Tony Arcieri has written a ruby extension that offers access to a subset	3179	Tony Arcieri has written a ruby extension that offers access to a subset
2896	of the libev API and adds file handle abstractions, asynchronous DNS and	3180	of the libev API and adds file handle abstractions, asynchronous DNS and
2897	more on top of it. It can be found via gem servers. Its homepage is at	3181	more on top of it. It can be found via gem servers. Its homepage is at
2898	L<http://rev.rubyforge.org/>.	3182	L<http://rev.rubyforge.org/>.
2899		3183
		3184	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3185	makes rev work even on mingw.
		3186
		3187	=item Haskell
		3188
		3189	A haskell binding to libev is available at
		3190	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3191
2900	=item D	3192	=item D
2901		3193
2902	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	3194	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2903	be found at L<http://proj.llucax.com.ar/wiki/evd>.	3195	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3196
		3197	=item Ocaml
		3198
		3199	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3200	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2904		3201
2905	=back	3202	=back
2906		3203
2907		3204
2908	=head1 MACRO MAGIC	3205	=head1 MACRO MAGIC
…		…
3009		3306
3010	#define EV_STANDALONE 1	3307	#define EV_STANDALONE 1
3011	#include "ev.h"	3308	#include "ev.h"
3012		3309
3013	Both header files and implementation files can be compiled with a C++	3310	Both header files and implementation files can be compiled with a C++
3014	compiler (at least, thats a stated goal, and breakage will be treated	3311	compiler (at least, that's a stated goal, and breakage will be treated
3015	as a bug).	3312	as a bug).
3016		3313
3017	You need the following files in your source tree, or in a directory	3314	You need the following files in your source tree, or in a directory
3018	in your include path (e.g. in libev/ when using -Ilibev):	3315	in your include path (e.g. in libev/ when using -Ilibev):
3019		3316
…		…
3075	keeps libev from including F<config.h>, and it also defines dummy	3372	keeps libev from including F<config.h>, and it also defines dummy
3076	implementations for some libevent functions (such as logging, which is not	3373	implementations for some libevent functions (such as logging, which is not
3077	supported). It will also not define any of the structs usually found in	3374	supported). It will also not define any of the structs usually found in
3078	F<event.h> that are not directly supported by the libev core alone.	3375	F<event.h> that are not directly supported by the libev core alone.
3079		3376
		3377	In stanbdalone mode, libev will still try to automatically deduce the
		3378	configuration, but has to be more conservative.
		3379
3080	=item EV_USE_MONOTONIC	3380	=item EV_USE_MONOTONIC
3081		3381
3082	If defined to be C<1>, libev will try to detect the availability of the	3382	If defined to be C<1>, libev will try to detect the availability of the
3083	monotonic clock option at both compile time and runtime. Otherwise no use	3383	monotonic clock option at both compile time and runtime. Otherwise no
3084	of the monotonic clock option will be attempted. If you enable this, you	3384	use of the monotonic clock option will be attempted. If you enable this,
3085	usually have to link against librt or something similar. Enabling it when	3385	you usually have to link against librt or something similar. Enabling it
3086	the functionality isn't available is safe, though, although you have	3386	when the functionality isn't available is safe, though, although you have
3087	to make sure you link against any libraries where the C<clock_gettime>	3387	to make sure you link against any libraries where the C<clock_gettime>
3088	function is hiding in (often F<-lrt>).	3388	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3089		3389
3090	=item EV_USE_REALTIME	3390	=item EV_USE_REALTIME
3091		3391
3092	If defined to be C<1>, libev will try to detect the availability of the	3392	If defined to be C<1>, libev will try to detect the availability of the
3093	real-time clock option at compile time (and assume its availability at	3393	real-time clock option at compile time (and assume its availability
3094	runtime if successful). Otherwise no use of the real-time clock option will	3394	at runtime if successful). Otherwise no use of the real-time clock
3095	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3395	option will be attempted. This effectively replaces C<gettimeofday>
3096	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3396	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3097	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3397	correctness. See the note about libraries in the description of
		3398	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3399	C<EV_USE_CLOCK_SYSCALL>.
		3400
		3401	=item EV_USE_CLOCK_SYSCALL
		3402
		3403	If defined to be C<1>, libev will try to use a direct syscall instead
		3404	of calling the system-provided C<clock_gettime> function. This option
		3405	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3406	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3407	programs needlessly. Using a direct syscall is slightly slower (in
		3408	theory), because no optimised vdso implementation can be used, but avoids
		3409	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3410	higher, as it simplifies linking (no need for C<-lrt>).
3098		3411
3099	=item EV_USE_NANOSLEEP	3412	=item EV_USE_NANOSLEEP
3100		3413
3101	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3414	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
3102	and will use it for delays. Otherwise it will use C<select ()>.	3415	and will use it for delays. Otherwise it will use C<select ()>.
…		…
3118		3431
3119	=item EV_SELECT_USE_FD_SET	3432	=item EV_SELECT_USE_FD_SET
3120		3433
3121	If defined to C<1>, then the select backend will use the system C<fd_set>	3434	If defined to C<1>, then the select backend will use the system C<fd_set>
3122	structure. This is useful if libev doesn't compile due to a missing	3435	structure. This is useful if libev doesn't compile due to a missing
3123	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on	3436	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
3124	exotic systems. This usually limits the range of file descriptors to some	3437	on exotic systems. This usually limits the range of file descriptors to
3125	low limit such as 1024 or might have other limitations (winsocket only	3438	some low limit such as 1024 or might have other limitations (winsocket
3126	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3439	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3127	influence the size of the C<fd_set> used.	3440	configures the maximum size of the C<fd_set>.
3128		3441
3129	=item EV_SELECT_IS_WINSOCKET	3442	=item EV_SELECT_IS_WINSOCKET
3130		3443
3131	When defined to C<1>, the select backend will assume that	3444	When defined to C<1>, the select backend will assume that
3132	select/socket/connect etc. don't understand file descriptors but	3445	select/socket/connect etc. don't understand file descriptors but
…		…
3491	loop, as long as you don't confuse yourself). The only exception is that	3804	loop, as long as you don't confuse yourself). The only exception is that
3492	you must not do this from C<ev_periodic> reschedule callbacks.	3805	you must not do this from C<ev_periodic> reschedule callbacks.
3493		3806
3494	Care has been taken to ensure that libev does not keep local state inside	3807	Care has been taken to ensure that libev does not keep local state inside
3495	C<ev_loop>, and other calls do not usually allow for coroutine switches as	3808	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3496	they do not clal any callbacks.	3809	they do not call any callbacks.
3497		3810
3498	=head2 COMPILER WARNINGS	3811	=head2 COMPILER WARNINGS
3499		3812
3500	Depending on your compiler and compiler settings, you might get no or a	3813	Depending on your compiler and compiler settings, you might get no or a
3501	lot of warnings when compiling libev code. Some people are apparently	3814	lot of warnings when compiling libev code. Some people are apparently
…		…
3535	==2274== definitely lost: 0 bytes in 0 blocks.	3848	==2274== definitely lost: 0 bytes in 0 blocks.
3536	==2274== possibly lost: 0 bytes in 0 blocks.	3849	==2274== possibly lost: 0 bytes in 0 blocks.
3537	==2274== still reachable: 256 bytes in 1 blocks.	3850	==2274== still reachable: 256 bytes in 1 blocks.
3538		3851
3539	Then there is no memory leak, just as memory accounted to global variables	3852	Then there is no memory leak, just as memory accounted to global variables
3540	is not a memleak - the memory is still being refernced, and didn't leak.	3853	is not a memleak - the memory is still being referenced, and didn't leak.
3541		3854
3542	Similarly, under some circumstances, valgrind might report kernel bugs	3855	Similarly, under some circumstances, valgrind might report kernel bugs
3543	as if it were a bug in libev (e.g. in realloc or in the poll backend,	3856	as if it were a bug in libev (e.g. in realloc or in the poll backend,
3544	although an acceptable workaround has been found here), or it might be	3857	although an acceptable workaround has been found here), or it might be
3545	confused.	3858	confused.
…		…
3783	=back	4096	=back
3784		4097
3785		4098
3786	=head1 AUTHOR	4099	=head1 AUTHOR
3787		4100
3788	Marc Lehmann <libev@schmorp.de>.	4101	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3789		4102

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.198 by root, Thu Oct 23 06:30:48 2008 UTC vs. Revision 1.233 by root, Thu Apr 16 07:32:51 2009 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.198 by root, Thu Oct 23 06:30:48 2008 UTC vs.
Revision 1.233 by root, Thu Apr 16 07:32:51 2009 UTC