[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.240 by root, Sat Apr 25 14:12:48 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>).
…		…
605		644
606	This function is rarely useful, but when some event callback runs for a	645	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	646	very long time without entering the event loop, updating libev's idea of
608	the current time is a good idea.	647	the current time is a good idea.
609		648
610	See also "The special problem of time updates" in the C<ev_timer> section.	649	See also L<The special problem of time updates> in the C<ev_timer> section.
		650
		651	=item ev_suspend (loop)
		652
		653	=item ev_resume (loop)
		654
		655	These two functions suspend and resume a loop, for use when the loop is
		656	not used for a while and timeouts should not be processed.
		657
		658	A typical use case would be an interactive program such as a game: When
		659	the user presses C<^Z> to suspend the game and resumes it an hour later it
		660	would be best to handle timeouts as if no time had actually passed while
		661	the program was suspended. This can be achieved by calling C<ev_suspend>
		662	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		663	C<ev_resume> directly afterwards to resume timer processing.
		664
		665	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		666	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		667	will be rescheduled (that is, they will lose any events that would have
		668	occured while suspended).
		669
		670	After calling C<ev_suspend> you B<must not> call I<any> function on the
		671	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		672	without a previous call to C<ev_suspend>.
		673
		674	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		675	event loop time (see C<ev_now_update>).
611		676
612	=item ev_loop (loop, int flags)	677	=item ev_loop (loop, int flags)
613		678
614	Finally, this is it, the event handler. This function usually is called	679	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	680	after you initialised all your watchers and you want to start handling
…		…
631	the loop.	696	the loop.
632		697
633	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	698	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	699	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	700	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	701	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	702	user-registered callback will be called), and will return after one
638	iteration of the loop.	703	iteration of the loop.
639		704
640	This is useful if you are waiting for some external event in conjunction	705	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	706	with something not expressible using other libev watchers (i.e. "roll your
…		…
699		764
700	If you have a watcher you never unregister that should not keep C<ev_loop>	765	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	766	from returning, call ev_unref() after starting, and ev_ref() before
702	stopping it.	767	stopping it.
703		768
704	As an example, libev itself uses this for its internal signal pipe: It is	769	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	770	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	771	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	772	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>	773	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,	774	before stop> (but only if the watcher wasn't active before, or was active
710	respectively).	775	before, respectively. Note also that libev might stop watchers itself
		776	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		777	in the callback).
711		778
712	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	779	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
713	running when nothing else is active.	780	running when nothing else is active.
714		781
715	ev_signal exitsig;	782	ev_signal exitsig;
…		…
768	they fire on, say, one-second boundaries only.	835	they fire on, say, one-second boundaries only.
769		836
770	=item ev_loop_verify (loop)	837	=item ev_loop_verify (loop)
771		838
772	This function only does something when C<EV_VERIFY> support has been	839	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	840	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	841	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	842	is found to be inconsistent, it will print an error message to standard
776	error and call C<abort ()>.	843	error and call C<abort ()>.
777		844
778	This can be used to catch bugs inside libev itself: under normal	845	This can be used to catch bugs inside libev itself: under normal
…		…
781		848
782	=back	849	=back
783		850
784		851
785	=head1 ANATOMY OF A WATCHER	852	=head1 ANATOMY OF A WATCHER
		853
		854	In the following description, uppercase C<TYPE> in names stands for the
		855	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		856	watchers and C<ev_io_start> for I/O watchers.
786		857
787	A watcher is a structure that you create and register to record your	858	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	859	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:	860	become readable, you would create an C<ev_io> watcher for that:
790		861
…		…
793	ev_io_stop (w);	864	ev_io_stop (w);
794	ev_unloop (loop, EVUNLOOP_ALL);	865	ev_unloop (loop, EVUNLOOP_ALL);
795	}	866	}
796		867
797	struct ev_loop *loop = ev_default_loop (0);	868	struct ev_loop *loop = ev_default_loop (0);
		869
798	ev_io stdin_watcher;	870	ev_io stdin_watcher;
		871
799	ev_init (&stdin_watcher, my_cb);	872	ev_init (&stdin_watcher, my_cb);
800	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	873	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
801	ev_io_start (loop, &stdin_watcher);	874	ev_io_start (loop, &stdin_watcher);
		875
802	ev_loop (loop, 0);	876	ev_loop (loop, 0);
803		877
804	As you can see, you are responsible for allocating the memory for your	878	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,	879	watcher structures (and it is I<usually> a bad idea to do this on the
806	although this can sometimes be quite valid).	880	stack).
		881
		882	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		883	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
807		884
808	Each watcher structure must be initialised by a call to C<ev_init	885	Each watcher structure must be initialised by a call to C<ev_init
809	(watcher *, callback)>, which expects a callback to be provided. This	886	(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	887	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	888	watchers, each time the event loop detects that the file descriptor given
812	is readable and/or writable).	889	is readable and/or writable).
813		890
814	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	891	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	892	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	893	is also a macro to combine initialisation and setting in one call: C<<
817	(watcher *, callback, ...) >>.	894	ev_TYPE_init (watcher *, callback, ...) >>.
818		895
819	To make the watcher actually watch out for events, you have to start it	896	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	897	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	898	*) >>), and you can stop watching for events at any time by calling the
822	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	899	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
823		900
824	As long as your watcher is active (has been started but not stopped) you	901	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	902	must not touch the values stored in it. Most specifically you must never
826	reinitialise it or call its C<set> macro.	903	reinitialise it or call its C<ev_TYPE_set> macro.
827		904
828	Each and every callback receives the event loop pointer as first, the	905	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	906	registered watcher structure as second, and a bitset of received events as
830	third argument.	907	third argument.
831		908
…		…
889		966
890	=item C<EV_ASYNC>	967	=item C<EV_ASYNC>
891		968
892	The given async watcher has been asynchronously notified (see C<ev_async>).	969	The given async watcher has been asynchronously notified (see C<ev_async>).
893		970
		971	=item C<EV_CUSTOM>
		972
		973	Not ever sent (or otherwise used) by libev itself, but can be freely used
		974	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		975
894	=item C<EV_ERROR>	976	=item C<EV_ERROR>
895		977
896	An unspecified error has occurred, the watcher has been stopped. This might	978	An unspecified error has occurred, the watcher has been stopped. This might
897	happen because the watcher could not be properly started because libev	979	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	980	ran out of memory, a file descriptor was found to be closed or any other
…		…
912		994
913	=back	995	=back
914		996
915	=head2 GENERIC WATCHER FUNCTIONS	997	=head2 GENERIC WATCHER FUNCTIONS
916		998
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	999	=over 4
921		1000
922	=item C<ev_init> (ev_TYPE *watcher, callback)	1001	=item C<ev_init> (ev_TYPE *watcher, callback)
923		1002
924	This macro initialises the generic portion of a watcher. The contents	1003	This macro initialises the generic portion of a watcher. The contents
…		…
1016	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1095	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1017	(default: C<-2>). Pending watchers with higher priority will be invoked	1096	(default: C<-2>). Pending watchers with higher priority will be invoked
1018	before watchers with lower priority, but priority will not keep watchers	1097	before watchers with lower priority, but priority will not keep watchers
1019	from being executed (except for C<ev_idle> watchers).	1098	from being executed (except for C<ev_idle> watchers).
1020		1099
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	1100	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.	1101	you need to look at C<ev_idle> watchers, which provide this functionality.
1028		1102
1029	You I<must not> change the priority of a watcher as long as it is active or	1103	You I<must not> change the priority of a watcher as long as it is active or
1030	pending.	1104	pending.
1031		1105
		1106	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1107	fine, as long as you do not mind that the priority value you query might
		1108	or might not have been clamped to the valid range.
		1109
1032	The default priority used by watchers when no priority has been set is	1110	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 :).	1111	always C<0>, which is supposed to not be too high and not be too low :).
1034		1112
1035	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1113	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	1114	priorities.
1037	or might not have been adjusted to be within valid range.
1038		1115
1039	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1116	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1040		1117
1041	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1118	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	1119	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)	1194	t2_cb (EV_P_ ev_timer *w, int revents)
1118	{	1195	{
1119	struct my_biggy big = (struct my_biggy *	1196	struct my_biggy big = (struct my_biggy *
1120	(((char *)w) - offsetof (struct my_biggy, t2));	1197	(((char *)w) - offsetof (struct my_biggy, t2));
1121	}	1198	}
		1199
		1200	=head2 WATCHER PRIORITY MODELS
		1201
		1202	Many event loops support I<watcher priorities>, which are usually small
		1203	integers that influence the ordering of event callback invocation
		1204	between watchers in some way, all else being equal.
		1205
		1206	In libev, Watcher priorities can be set using C<ev_set_priority>. See its
		1207	description for the more technical details such as the actual priority
		1208	range.
		1209
		1210	There are two common ways how these these priorities are being interpreted
		1211	by event loops:
		1212
		1213	In the more common lock-out model, higher priorities "lock out" invocation
		1214	of lower priority watchers, which means as long as higher priority
		1215	watchers receive events, lower priority watchers are not being invoked.
		1216
		1217	The less common only-for-ordering model uses priorities solely to order
		1218	callback invocation within a single event loop iteration: Higher priority
		1219	watchers are invoked before lower priority ones, but they all get invoked
		1220	before polling for new events.
		1221
		1222	Libev uses the second (only-for-ordering) model for all its watchers
		1223	except for idle watchers (which use the lock-out model).
		1224
		1225	The rationale behind this is that implementing the lock-out model for
		1226	watchers is not well supported by most kernel interfaces, and most event
		1227	libraries will just poll for the same events again and again as long as
		1228	their callbacks have not been executed, which is very inefficient in the
		1229	common case of one high-priority watcher locking out a mass of lower
		1230	priority ones.
		1231
		1232	Static (ordering) priorities are most useful when you have two or more
		1233	watchers handling the same resource: a typical usage example is having an
		1234	C<ev_io> watcher to receive data, and an associated C<ev_timer> to handle
		1235	timeouts. Under load, data might be received while the program handles
		1236	other jobs, but since timers normally get invoked first, the timeout
		1237	handler will be executed before checking for data. In that case, giving
		1238	the timer a lower priority than the I/O watcher ensures that I/O will be
		1239	handled first even under adverse conditions (which is usually, but not
		1240	always, what you want).
		1241
		1242	Since idle watchers use the "lock-out" model, meaning that idle watchers
		1243	will only be executed when no same or higher priority watchers have
		1244	received events, they can be used to implement the "lock-out" model when
		1245	required.
		1246
		1247	For example, to emulate how many other event libraries handle priorities,
		1248	you can associate an C<ev_idle> watcher to each such watcher, and in
		1249	the normal watcher callback, you just start the idle watcher. The real
		1250	processing is done in the idle watcher callback. This causes libev to
		1251	continously poll and process kernel event data for the watcher, but when
		1252	the lock-out case is known to be rare (which in turn is rare :), this is
		1253	workable.
		1254
		1255	Usually, however, the lock-out model implemented that way will perform
		1256	miserably under the type of load it was designed to handle. In that case,
		1257	it might be preferable to stop the real watcher before starting the
		1258	idle watcher, so the kernel will not have to process the event in case
		1259	the actual processing will be delayed for considerable time.
		1260
		1261	Here is an example of an I/O watcher that should run at a strictly lower
		1262	priority than the default, and which should only process data when no
		1263	other events are pending:
		1264
		1265	ev_idle idle; // actual processing watcher
		1266	ev_io io; // actual event watcher
		1267
		1268	static void
		1269	io_cb (EV_P_ ev_io *w, int revents)
		1270	{
		1271	// stop the I/O watcher, we received the event, but
		1272	// are not yet ready to handle it.
		1273	ev_io_stop (EV_A_ w);
		1274
		1275	// start the idle watcher to ahndle the actual event.
		1276	// it will not be executed as long as other watchers
		1277	// with the default priority are receiving events.
		1278	ev_idle_start (EV_A_ &idle);
		1279	}
		1280
		1281	static void
		1282	idle-cb (EV_P_ ev_idle *w, int revents)
		1283	{
		1284	// actual processing
		1285	read (STDIN_FILENO, ...);
		1286
		1287	// have to start the I/O watcher again, as
		1288	// we have handled the event
		1289	ev_io_start (EV_P_ &io);
		1290	}
		1291
		1292	// initialisation
		1293	ev_idle_init (&idle, idle_cb);
		1294	ev_io_init (&io, io_cb, STDIN_FILENO, EV_READ);
		1295	ev_io_start (EV_DEFAULT_ &io);
		1296
		1297	In the "real" world, it might also be beneficial to start a timer, so that
		1298	low-priority connections can not be locked out forever under load. This
		1299	enables your program to keep a lower latency for important connections
		1300	during short periods of high load, while not completely locking out less
		1301	important ones.
1122		1302
1123		1303
1124	=head1 WATCHER TYPES	1304	=head1 WATCHER TYPES
1125		1305
1126	This section describes each watcher in detail, but will not repeat	1306	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	1332	descriptors to non-blocking mode is also usually a good idea (but not
1153	required if you know what you are doing).	1333	required if you know what you are doing).
1154		1334
1155	If you cannot use non-blocking mode, then force the use of a	1335	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	1336	known-to-be-good backend (at the time of this writing, this includes only
1157	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>).	1337	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
		1338	descriptors for which non-blocking operation makes no sense (such as
		1339	files) - libev doesn't guarentee any specific behaviour in that case.
1158		1340
1159	Another thing you have to watch out for is that it is quite easy to	1341	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	1342	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	1343	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	1344	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	1465	year, it will still time out after (roughly) one hour. "Roughly" because
1284	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1466	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1285	monotonic clock option helps a lot here).	1467	monotonic clock option helps a lot here).
1286		1468
1287	The callback is guaranteed to be invoked only I<after> its timeout has	1469	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	1470	passed (not I<at>, so on systems with very low-resolution clocks this
1289	then order of execution is undefined.	1471	might introduce a small delay). If multiple timers become ready during the
		1472	same loop iteration then the ones with earlier time-out values are invoked
		1473	before ones with later time-out values (but this is no longer true when a
		1474	callback calls C<ev_loop> recursively).
1290		1475
1291	=head3 Be smart about timeouts	1476	=head3 Be smart about timeouts
1292		1477
1293	Many real-world problems invole some kind of time-out, usually for error	1478	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,	1479	recovery. A typical example is an HTTP request - if the other side hangs,
1295	you want to raise some error after a while.	1480	you want to raise some error after a while.
1296		1481
1297	Here are some ways on how to handle this problem, from simple and	1482	What follows are some ways to handle this problem, from obvious and
1298	inefficient to very efficient.	1483	inefficient to smart and efficient.
1299		1484
1300	In the following examples a 60 second activity timeout is assumed - a	1485	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")	1486	gets reset to 60 seconds each time there is activity (e.g. each time some
1302	was received.	1487	data or other life sign was received).
1303		1488
1304	=over 4	1489	=over 4
1305		1490
1306	=item 1. Use a timer and stop, reinitialise, start it on activity.	1491	=item 1. Use a timer and stop, reinitialise and start it on activity.
1307		1492
1308	This is the most obvious, but not the most simple way: In the beginning,	1493	This is the most obvious, but not the most simple way: In the beginning,
1309	start the watcher:	1494	start the watcher:
1310		1495
1311	ev_timer_init (timer, callback, 60., 0.);	1496	ev_timer_init (timer, callback, 60., 0.);
1312	ev_timer_start (loop, timer);	1497	ev_timer_start (loop, timer);
1313		1498
1314	Then, each time there is some activity, C<ev_timer_stop> the timer,	1499	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
1315	initialise it again, and start it:	1500	and start it again:
1316		1501
1317	ev_timer_stop (loop, timer);	1502	ev_timer_stop (loop, timer);
1318	ev_timer_set (timer, 60., 0.);	1503	ev_timer_set (timer, 60., 0.);
1319	ev_timer_start (loop, timer);	1504	ev_timer_start (loop, timer);
1320		1505
1321	This is relatively simple to implement, but means that each time there	1506	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	1507	some activity, libev will first have to remove the timer from its internal
1323	internal data strcuture and then add it again.	1508	data structure and then add it again. Libev tries to be fast, but it's
		1509	still not a constant-time operation.
1324		1510
1325	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.	1511	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
1326		1512
1327	This is the easiest way, and involves using C<ev_timer_again> instead of	1513	This is the easiest way, and involves using C<ev_timer_again> instead of
1328	C<ev_timer_start>.	1514	C<ev_timer_start>.
1329		1515
1330	For this, configure an C<ev_timer> with a C<repeat> value of C<60> and	1516	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	1517	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	1518	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	1519	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.	1520	the timer, and C<ev_timer_again> will automatically restart it if need be.
1335		1521
1336	That means you can ignore the C<after> value and C<ev_timer_start>	1522	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>.	1523	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1524	member and C<ev_timer_again>.
1338		1525
1339	At start:	1526	At start:
1340		1527
1341	ev_timer_init (timer, callback, 0., 60.);	1528	ev_timer_init (timer, callback);
		1529	timer->repeat = 60.;
1342	ev_timer_again (loop, timer);	1530	ev_timer_again (loop, timer);
1343		1531
1344	Each time you receive some data:	1532	Each time there is some activity:
1345		1533
1346	ev_timer_again (loop, timer);	1534	ev_timer_again (loop, timer);
1347		1535
1348	It is even possible to change the time-out on the fly:	1536	It is even possible to change the time-out on the fly, regardless of
		1537	whether the watcher is active or not:
1349		1538
1350	timer->repeat = 30.;	1539	timer->repeat = 30.;
1351	ev_timer_again (loop, timer);	1540	ev_timer_again (loop, timer);
1352		1541
1353	This is slightly more efficient then stopping/starting the timer each time	1542	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	1543	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.	1544	remove and re-insert the timer from/into its internal data structure.
		1545
		1546	It is, however, even simpler than the "obvious" way to do it.
1356		1547
1357	=item 3. Let the timer time out, but then re-arm it as required.	1548	=item 3. Let the timer time out, but then re-arm it as required.
1358		1549
1359	This method is more tricky, but usually most efficient: Most timeouts are	1550	This method is more tricky, but usually most efficient: Most timeouts are
1360	relatively long compared to the loop iteration time - in our example,	1551	relatively long compared to the intervals between other activity - in
1361	within 60 seconds, there are usually many I/O events with associated	1552	our example, within 60 seconds, there are usually many I/O events with
1362	activity resets.	1553	associated activity resets.
1363		1554
1364	In this case, it would be more efficient to leave the C<ev_timer> alone,	1555	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	1556	but remember the time of last activity, and check for a real timeout only
1366	within the callback:	1557	within the callback:
1367		1558
1368	ev_tstamp last_activity; // time of last activity	1559	ev_tstamp last_activity; // time of last activity
1369		1560
1370	static void	1561	static void
1371	callback (EV_P_ ev_timer *w, int revents)	1562	callback (EV_P_ ev_timer *w, int revents)
1372	{	1563	{
1373	ev_tstamp now = ev_now (EV_A);	1564	ev_tstamp now = ev_now (EV_A);
1374	ev_tstamp timeout = last_activity + 60.;	1565	ev_tstamp timeout = last_activity + 60.;
1375		1566
1376	// if last_activity is older than now - timeout, we did time out	1567	// if last_activity + 60. is older than now, we did time out
1377	if (timeout < now)	1568	if (timeout < now)
1378	{	1569	{
1379	// timeout occured, take action	1570	// timeout occured, take action
1380	}	1571	}
1381	else	1572	else
1382	{	1573	{
1383	// callback was invoked, but there was some activity, re-arm	1574	// callback was invoked, but there was some activity, re-arm
1384	// to fire in last_activity + 60.	1575	// the watcher to fire in last_activity + 60, which is
		1576	// guaranteed to be in the future, so "again" is positive:
1385	w->again = timeout - now;	1577	w->repeat = timeout - now;
1386	ev_timer_again (EV_A_ w);	1578	ev_timer_again (EV_A_ w);
1387	}	1579	}
1388	}	1580	}
1389		1581
1390	To summarise the callback: first calculate the real time-out (defined as	1582	To summarise the callback: first calculate the real timeout (defined
1391	"60 seconds after the last activity"), then check if that time has been	1583	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	1584	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	1585	the callback was invoked too early (C<timeout> is in the future), so
1394	fire at that future time.	1586	re-schedule the timer to fire at that future time, to see if maybe we have
		1587	a timeout then.
1395		1588
1396	Note how C<ev_timer_again> is used, taking advantage of the	1589	Note how C<ev_timer_again> is used, taking advantage of the
1397	C<ev_timer_again> optimisation when the timer is already running.	1590	C<ev_timer_again> optimisation when the timer is already running.
1398		1591
1399	This scheme causes more callback invocations (about one every 60 seconds),	1592	This scheme causes more callback invocations (about one every 60 seconds
1400	but virtually no calls to libev to change the timeout.	1593	minus half the average time between activity), but virtually no calls to
		1594	libev to change the timeout.
1401		1595
1402	To start the timer, simply intiialise the watcher and C<last_activity>,	1596	To start the timer, simply initialise the watcher and set C<last_activity>
1403	then call the callback:	1597	to the current time (meaning we just have some activity :), then call the
		1598	callback, which will "do the right thing" and start the timer:
1404		1599
1405	ev_timer_init (timer, callback);	1600	ev_timer_init (timer, callback);
1406	last_activity = ev_now (loop);	1601	last_activity = ev_now (loop);
1407	callback (loop, timer, EV_TIMEOUT);	1602	callback (loop, timer, EV_TIMEOUT);
1408		1603
1409	And when there is some activity, simply remember the time in	1604	And when there is some activity, simply store the current time in
1410	C<last_activity>:	1605	C<last_activity>, no libev calls at all:
1411		1606
1412	last_actiivty = ev_now (loop);	1607	last_actiivty = ev_now (loop);
1413		1608
1414	This technique is slightly more complex, but in most cases where the	1609	This technique is slightly more complex, but in most cases where the
1415	time-out is unlikely to be triggered, much more efficient.	1610	time-out is unlikely to be triggered, much more efficient.
1416		1611
		1612	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1613	callback :) - just change the timeout and invoke the callback, which will
		1614	fix things for you.
		1615
		1616	=item 4. Wee, just use a double-linked list for your timeouts.
		1617
		1618	If there is not one request, but many thousands (millions...), all
		1619	employing some kind of timeout with the same timeout value, then one can
		1620	do even better:
		1621
		1622	When starting the timeout, calculate the timeout value and put the timeout
		1623	at the I<end> of the list.
		1624
		1625	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1626	the list is expected to fire (for example, using the technique #3).
		1627
		1628	When there is some activity, remove the timer from the list, recalculate
		1629	the timeout, append it to the end of the list again, and make sure to
		1630	update the C<ev_timer> if it was taken from the beginning of the list.
		1631
		1632	This way, one can manage an unlimited number of timeouts in O(1) time for
		1633	starting, stopping and updating the timers, at the expense of a major
		1634	complication, and having to use a constant timeout. The constant timeout
		1635	ensures that the list stays sorted.
		1636
1417	=back	1637	=back
		1638
		1639	So which method the best?
		1640
		1641	Method #2 is a simple no-brain-required solution that is adequate in most
		1642	situations. Method #3 requires a bit more thinking, but handles many cases
		1643	better, and isn't very complicated either. In most case, choosing either
		1644	one is fine, with #3 being better in typical situations.
		1645
		1646	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1647	rather complicated, but extremely efficient, something that really pays
		1648	off after the first million or so of active timers, i.e. it's usually
		1649	overkill :)
1418		1650
1419	=head3 The special problem of time updates	1651	=head3 The special problem of time updates
1420		1652
1421	Establishing the current time is a costly operation (it usually takes at	1653	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	1654	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).	1698	If the timer is started but non-repeating, stop it (as if it timed out).
1467		1699
1468	If the timer is repeating, either start it if necessary (with the	1700	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.	1701	C<repeat> value), or reset the running timer to the C<repeat> value.
1470		1702
1471	This sounds a bit complicated, see "Be smart about timeouts", above, for a	1703	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1472	usage example.	1704	usage example.
1473		1705
1474	=item ev_tstamp repeat [read-write]	1706	=item ev_tstamp repeat [read-write]
1475		1707
1476	The current C<repeat> value. Will be used each time the watcher times out	1708	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?	1747	=head2 C<ev_periodic> - to cron or not to cron?
1516		1748
1517	Periodic watchers are also timers of a kind, but they are very versatile	1749	Periodic watchers are also timers of a kind, but they are very versatile
1518	(and unfortunately a bit complex).	1750	(and unfortunately a bit complex).
1519		1751
1520	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1752	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	1753	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	1754	(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 ()	1755	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	1756	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	1757	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		1758
		1759	You can tell a periodic watcher to trigger after some specific point
		1760	in time: for example, if you tell a periodic watcher to trigger "in 10
		1761	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1762	not a delay) and then reset your system clock to January of the previous
		1763	year, then it will take a year or more to trigger the event (unlike an
		1764	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1765	it, as it uses a relative timeout).
		1766
1529	C<ev_periodic>s can also be used to implement vastly more complex timers,	1767	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	1768	timers, such as triggering an event on each "midnight, local time", or
1531	complicated rules.	1769	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1770	those cannot react to time jumps.
1532		1771
1533	As with timers, the callback is guaranteed to be invoked only when the	1772	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	1773	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.	1774	timers become ready during the same loop iteration then the ones with
		1775	earlier time-out values are invoked before ones with later time-out values
		1776	(but this is no longer true when a callback calls C<ev_loop> recursively).
1536		1777
1537	=head3 Watcher-Specific Functions and Data Members	1778	=head3 Watcher-Specific Functions and Data Members
1538		1779
1539	=over 4	1780	=over 4
1540		1781
1541	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1782	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1542		1783
1543	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1784	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1544		1785
1545	Lots of arguments, lets sort it out... There are basically three modes of	1786	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:	1787	operation, and we will explain them from simplest to most complex:
1547		1788
1548	=over 4	1789	=over 4
1549		1790
1550	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1791	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1551		1792
1552	In this configuration the watcher triggers an event after the wall clock	1793	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	1794	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	1795	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.	1796	will be stopped and invoked when the system clock reaches or surpasses
		1797	this point in time.
1556		1798
1557	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1799	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1558		1800
1559	In this mode the watcher will always be scheduled to time out at the next	1801	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)	1802	C<offset + N * interval> time (for some integer N, which can also be
1561	and then repeat, regardless of any time jumps.	1803	negative) and then repeat, regardless of any time jumps. The C<offset>
		1804	argument is merely an offset into the C<interval> periods.
1562		1805
1563	This can be used to create timers that do not drift with respect to the	1806	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	1807	system clock, for example, here is an C<ev_periodic> that triggers each
1565	hour, on the hour:	1808	hour, on the hour (with respect to UTC):
1566		1809
1567	ev_periodic_set (&periodic, 0., 3600., 0);	1810	ev_periodic_set (&periodic, 0., 3600., 0);
1568		1811
1569	This doesn't mean there will always be 3600 seconds in between triggers,	1812	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	1813	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	1814	full hour (UTC), or more correctly, when the system time is evenly divisible
1572	by 3600.	1815	by 3600.
1573		1816
1574	Another way to think about it (for the mathematically inclined) is that	1817	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	1818	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.	1819	time where C<time = offset (mod interval)>, regardless of any time jumps.
1577		1820
1578	For numerical stability it is preferable that the C<at> value is near	1821	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	1822	C<ev_now ()> (the current time), but there is no range requirement for
1580	this value, and in fact is often specified as zero.	1823	this value, and in fact is often specified as zero.
1581		1824
1582	Note also that there is an upper limit to how often a timer can fire (CPU	1825	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	1826	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	1827	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).	1828	millisecond (if the OS supports it and the machine is fast enough).
1586		1829
1587	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1830	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1588		1831
1589	In this mode the values for C<interval> and C<at> are both being	1832	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	1833	ignored. Instead, each time the periodic watcher gets scheduled, the
1591	reschedule callback will be called with the watcher as first, and the	1834	reschedule callback will be called with the watcher as first, and the
1592	current time as second argument.	1835	current time as second argument.
1593		1836
1594	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1837	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1595	ever, or make ANY event loop modifications whatsoever>.	1838	or make ANY other event loop modifications whatsoever, unless explicitly
		1839	allowed by documentation here>.
1596		1840
1597	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	1841	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	1842	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1599	only event loop modification you are allowed to do).	1843	only event loop modification you are allowed to do).
1600		1844
…		…
1630	a different time than the last time it was called (e.g. in a crond like	1874	a different time than the last time it was called (e.g. in a crond like
1631	program when the crontabs have changed).	1875	program when the crontabs have changed).
1632		1876
1633	=item ev_tstamp ev_periodic_at (ev_periodic *)	1877	=item ev_tstamp ev_periodic_at (ev_periodic *)
1634		1878
1635	When active, returns the absolute time that the watcher is supposed to	1879	When active, returns the absolute time that the watcher is supposed
1636	trigger next.	1880	to trigger next. This is not the same as the C<offset> argument to
		1881	C<ev_periodic_set>, but indeed works even in interval and manual
		1882	rescheduling modes.
1637		1883
1638	=item ev_tstamp offset [read-write]	1884	=item ev_tstamp offset [read-write]
1639		1885
1640	When repeating, this contains the offset value, otherwise this is the	1886	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>).	1887	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1888	although libev might modify this value for better numerical stability).
1642		1889
1643	Can be modified any time, but changes only take effect when the periodic	1890	Can be modified any time, but changes only take effect when the periodic
1644	timer fires or C<ev_periodic_again> is being called.	1891	timer fires or C<ev_periodic_again> is being called.
1645		1892
1646	=item ev_tstamp interval [read-write]	1893	=item ev_tstamp interval [read-write]
…		…
1852		2099
1853		2100
1854	=head2 C<ev_stat> - did the file attributes just change?	2101	=head2 C<ev_stat> - did the file attributes just change?
1855		2102
1856	This watches a file system path for attribute changes. That is, it calls	2103	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	2104	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.	2105	and sees if it changed compared to the last time, invoking the callback if
		2106	it did.
1859		2107
1860	The path does not need to exist: changing from "path exists" to "path does	2108	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	2109	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	2110	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	2111	C<st_nlink> field being zero (which is otherwise always forced to be at
1864	the stat buffer having unspecified contents.	2112	least one) and all the other fields of the stat buffer having unspecified
		2113	contents.
1865		2114
1866	The path I<should> be absolute and I<must not> end in a slash. If it is	2115	The path I<must not> end in a slash or contain special components such as
		2116	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.	2117	your working directory changes, then the behaviour is undefined.
1868		2118
1869	Since there is no standard kernel interface to do this, the portable	2119	Since there is no portable change notification interface available, the
1870	implementation simply calls C<stat (2)> regularly on the path to see if	2120	portable implementation simply calls C<stat(2)> regularly on the path
1871	it changed somehow. You can specify a recommended polling interval for	2121	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!)	2122	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	2123	recommended!) then a I<suitable, unspecified default> value will be used
1874	you can expect to be around five seconds, although this might change	2124	(which you can expect to be around five seconds, although this might
1875	dynamically). Libev will also impose a minimum interval which is currently	2125	change dynamically). Libev will also impose a minimum interval which is
1876	around C<0.1>, but thats usually overkill.	2126	currently around C<0.1>, but that's usually overkill.
1877		2127
1878	This watcher type is not meant for massive numbers of stat watchers,	2128	This watcher type is not meant for massive numbers of stat watchers,
1879	as even with OS-supported change notifications, this can be	2129	as even with OS-supported change notifications, this can be
1880	resource-intensive.	2130	resource-intensive.
1881		2131
1882	At the time of this writing, the only OS-specific interface implemented	2132	At the time of this writing, the only OS-specific interface implemented
1883	is the Linux inotify interface (implementing kqueue support is left as	2133	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	2134	exercise for the reader. Note, however, that the author sees no way of
1885	of implementing C<ev_stat> semantics with kqueue).	2135	implementing C<ev_stat> semantics with kqueue, except as a hint).
1886		2136
1887	=head3 ABI Issues (Largefile Support)	2137	=head3 ABI Issues (Largefile Support)
1888		2138
1889	Libev by default (unless the user overrides this) uses the default	2139	Libev by default (unless the user overrides this) uses the default
1890	compilation environment, which means that on systems with large file	2140	compilation environment, which means that on systems with large file
1891	support disabled by default, you get the 32 bit version of the stat	2141	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	2142	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	2143	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	2144	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	2145	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.	2146	most noticeably displayed with ev_stat and large file support.
1897		2147
1898	The solution for this is to lobby your distribution maker to make large	2148	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	2149	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	2150	optional. Libev cannot simply switch on large file support because it has
1901	to exchange stat structures with application programs compiled using the	2151	to exchange stat structures with application programs compiled using the
1902	default compilation environment.	2152	default compilation environment.
1903		2153
1904	=head3 Inotify and Kqueue	2154	=head3 Inotify and Kqueue
1905		2155
1906	When C<inotify (7)> support has been compiled into libev (generally	2156	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	2157	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	2158	inotify descriptor will be created lazily when the first C<ev_stat>
1909	change detection where possible. The inotify descriptor will be created	2159	watcher is being started.
1910	lazily when the first C<ev_stat> watcher is being started.
1911		2160
1912	Inotify presence does not change the semantics of C<ev_stat> watchers	2161	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	2162	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	2163	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,	2164	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.	2165	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2166	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2167	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2168	xfs are fully working) libev usually gets away without polling.
1917		2169
1918	There is no support for kqueue, as apparently it cannot be used to	2170	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	2171	implement this functionality, due to the requirement of having a file
1920	descriptor open on the object at all times, and detecting renames, unlinks	2172	descriptor open on the object at all times, and detecting renames, unlinks
1921	etc. is difficult.	2173	etc. is difficult.
1922		2174
		2175	=head3 C<stat ()> is a synchronous operation
		2176
		2177	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2178	the process. The exception are C<ev_stat> watchers - those call C<stat
		2179	()>, which is a synchronous operation.
		2180
		2181	For local paths, this usually doesn't matter: unless the system is very
		2182	busy or the intervals between stat's are large, a stat call will be fast,
		2183	as the path data is usually in memory already (except when starting the
		2184	watcher).
		2185
		2186	For networked file systems, calling C<stat ()> can block an indefinite
		2187	time due to network issues, and even under good conditions, a stat call
		2188	often takes multiple milliseconds.
		2189
		2190	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2191	paths, although this is fully supported by libev.
		2192
1923	=head3 The special problem of stat time resolution	2193	=head3 The special problem of stat time resolution
1924		2194
1925	The C<stat ()> system call only supports full-second resolution portably, and	2195	The C<stat ()> system call only supports full-second resolution portably,
1926	even on systems where the resolution is higher, most file systems still	2196	and even on systems where the resolution is higher, most file systems
1927	only support whole seconds.	2197	still only support whole seconds.
1928		2198
1929	That means that, if the time is the only thing that changes, you can	2199	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	2200	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	2201	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	2202	within the same second, C<ev_stat> will be unable to detect unless the
…		…
2075		2345
2076	=head3 Watcher-Specific Functions and Data Members	2346	=head3 Watcher-Specific Functions and Data Members
2077		2347
2078	=over 4	2348	=over 4
2079		2349
2080	=item ev_idle_init (ev_signal *, callback)	2350	=item ev_idle_init (ev_idle *, callback)
2081		2351
2082	Initialises and configures the idle watcher - it has no parameters of any	2352	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,	2353	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
2084	believe me.	2354	believe me.
2085		2355
…		…
2324	some fds have to be watched and handled very quickly (with low latency),	2594	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	2595	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	2596	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.	2597	the rest in a second one, and embed the second one in the first.
2328		2598
2329	As long as the watcher is active, the callback will be invoked every time	2599	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	2600	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	2601	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	2602	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	2603	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	2604	to give the embedded loop strictly lower priority for example).
2335	embedded loop sweep.
2336		2605
2337	As long as the watcher is started it will automatically handle events. The	2606	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	2607	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		2608
2342	Also, there have not currently been made special provisions for forking:	2609	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,	2610	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	2611	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,	2612	C<ev_loop_fork> on the embedded loop.
2346	and future versions of libev might do just that.
2347		2613
2348	Unfortunately, not all backends are embeddable: only the ones returned by	2614	Unfortunately, not all backends are embeddable: only the ones returned by
2349	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2615	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2350	portable one.	2616	portable one.
2351		2617
…		…
2445	event loop blocks next and before C<ev_check> watchers are being called,	2711	event loop blocks next and before C<ev_check> watchers are being called,
2446	and only in the child after the fork. If whoever good citizen calling	2712	and only in the child after the fork. If whoever good citizen calling
2447	C<ev_default_fork> cheats and calls it in the wrong process, the fork	2713	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2448	handlers will be invoked, too, of course.	2714	handlers will be invoked, too, of course.
2449		2715
		2716	=head3 The special problem of life after fork - how is it possible?
		2717
		2718	Most uses of C<fork()> consist of forking, then some simple calls to ste
		2719	up/change the process environment, followed by a call to C<exec()>. This
		2720	sequence should be handled by libev without any problems.
		2721
		2722	This changes when the application actually wants to do event handling
		2723	in the child, or both parent in child, in effect "continuing" after the
		2724	fork.
		2725
		2726	The default mode of operation (for libev, with application help to detect
		2727	forks) is to duplicate all the state in the child, as would be expected
		2728	when I<either> the parent I<or> the child process continues.
		2729
		2730	When both processes want to continue using libev, then this is usually the
		2731	wrong result. In that case, usually one process (typically the parent) is
		2732	supposed to continue with all watchers in place as before, while the other
		2733	process typically wants to start fresh, i.e. without any active watchers.
		2734
		2735	The cleanest and most efficient way to achieve that with libev is to
		2736	simply create a new event loop, which of course will be "empty", and
		2737	use that for new watchers. This has the advantage of not touching more
		2738	memory than necessary, and thus avoiding the copy-on-write, and the
		2739	disadvantage of having to use multiple event loops (which do not support
		2740	signal watchers).
		2741
		2742	When this is not possible, or you want to use the default loop for
		2743	other reasons, then in the process that wants to start "fresh", call
		2744	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
		2745	the default loop will "orphan" (not stop) all registered watchers, so you
		2746	have to be careful not to execute code that modifies those watchers. Note
		2747	also that in that case, you have to re-register any signal watchers.
		2748
2450	=head3 Watcher-Specific Functions and Data Members	2749	=head3 Watcher-Specific Functions and Data Members
2451		2750
2452	=over 4	2751	=over 4
2453		2752
2454	=item ev_fork_init (ev_signal *, callback)	2753	=item ev_fork_init (ev_signal *, callback)
…		…
2571	=over 4	2870	=over 4
2572		2871
2573	=item ev_async_init (ev_async *, callback)	2872	=item ev_async_init (ev_async *, callback)
2574		2873
2575	Initialises and configures the async watcher - it has no parameters of any	2874	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,	2875	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2577	trust me.	2876	trust me.
2578		2877
2579	=item ev_async_send (loop, ev_async *)	2878	=item ev_async_send (loop, ev_async *)
2580		2879
2581	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2880	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	2881	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	2882	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	2883	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2585	section below on what exactly this means).	2884	section below on what exactly this means).
2586		2885
		2886	Note that, as with other watchers in libev, multiple events might get
		2887	compressed into a single callback invocation (another way to look at this
		2888	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2889	reset when the event loop detects that).
		2890
2587	This call incurs the overhead of a system call only once per loop iteration,	2891	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	2892	iteration, so while the overhead might be noticeable, it doesn't apply to
2589	calls to C<ev_async_send>.	2893	repeated calls to C<ev_async_send> for the same event loop.
2590		2894
2591	=item bool = ev_async_pending (ev_async *)	2895	=item bool = ev_async_pending (ev_async *)
2592		2896
2593	Returns a non-zero value when C<ev_async_send> has been called on the	2897	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	2898	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	2901	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,	2902	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	2903	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.	2904	quickly check whether invoking the loop might be a good idea.
2601		2905
2602	Not that this does I<not> check whether the watcher itself is pending, only	2906	Not that this does I<not> check whether the watcher itself is pending,
2603	whether it has been requested to make this watcher pending.	2907	only whether it has been requested to make this watcher pending: there
		2908	is a time window between the event loop checking and resetting the async
		2909	notification, and the callback being invoked.
2604		2910
2605	=back	2911	=back
2606		2912
2607		2913
2608	=head1 OTHER FUNCTIONS	2914	=head1 OTHER FUNCTIONS
…		…
2787		3093
2788	myclass obj;	3094	myclass obj;
2789	ev::io iow;	3095	ev::io iow;
2790	iow.set <myclass, &myclass::io_cb> (&obj);	3096	iow.set <myclass, &myclass::io_cb> (&obj);
2791		3097
		3098	=item w->set (object *)
		3099
		3100	This is an B<experimental> feature that might go away in a future version.
		3101
		3102	This is a variation of a method callback - leaving out the method to call
		3103	will default the method to C<operator ()>, which makes it possible to use
		3104	functor objects without having to manually specify the C<operator ()> all
		3105	the time. Incidentally, you can then also leave out the template argument
		3106	list.
		3107
		3108	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		3109	int revents)>.
		3110
		3111	See the method-C<set> above for more details.
		3112
		3113	Example: use a functor object as callback.
		3114
		3115	struct myfunctor
		3116	{
		3117	void operator() (ev::io &w, int revents)
		3118	{
		3119	...
		3120	}
		3121	}
		3122
		3123	myfunctor f;
		3124
		3125	ev::io w;
		3126	w.set (&f);
		3127
2792	=item w->set<function> (void *data = 0)	3128	=item w->set<function> (void *data = 0)
2793		3129
2794	Also sets a callback, but uses a static method or plain function as	3130	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	3131	callback. The optional C<data> argument will be stored in the watcher's
2796	C<data> member and is free for you to use.	3132	C<data> member and is free for you to use.
…		…
2882	L<http://software.schmorp.de/pkg/EV>.	3218	L<http://software.schmorp.de/pkg/EV>.
2883		3219
2884	=item Python	3220	=item Python
2885		3221
2886	Python bindings can be found at L<http://code.google.com/p/pyev/>. It	3222	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	3223	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		3224
2893	=item Ruby	3225	=item Ruby
2894		3226
2895	Tony Arcieri has written a ruby extension that offers access to a subset	3227	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	3228	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	3229	more on top of it. It can be found via gem servers. Its homepage is at
2898	L<http://rev.rubyforge.org/>.	3230	L<http://rev.rubyforge.org/>.
2899		3231
		3232	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3233	makes rev work even on mingw.
		3234
		3235	=item Haskell
		3236
		3237	A haskell binding to libev is available at
		3238	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3239
2900	=item D	3240	=item D
2901		3241
2902	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	3242	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>.	3243	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3244
		3245	=item Ocaml
		3246
		3247	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3248	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2904		3249
2905	=back	3250	=back
2906		3251
2907		3252
2908	=head1 MACRO MAGIC	3253	=head1 MACRO MAGIC
…		…
3009		3354
3010	#define EV_STANDALONE 1	3355	#define EV_STANDALONE 1
3011	#include "ev.h"	3356	#include "ev.h"
3012		3357
3013	Both header files and implementation files can be compiled with a C++	3358	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	3359	compiler (at least, that's a stated goal, and breakage will be treated
3015	as a bug).	3360	as a bug).
3016		3361
3017	You need the following files in your source tree, or in a directory	3362	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):	3363	in your include path (e.g. in libev/ when using -Ilibev):
3019		3364
…		…
3075	keeps libev from including F<config.h>, and it also defines dummy	3420	keeps libev from including F<config.h>, and it also defines dummy
3076	implementations for some libevent functions (such as logging, which is not	3421	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	3422	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.	3423	F<event.h> that are not directly supported by the libev core alone.
3079		3424
		3425	In stanbdalone mode, libev will still try to automatically deduce the
		3426	configuration, but has to be more conservative.
		3427
3080	=item EV_USE_MONOTONIC	3428	=item EV_USE_MONOTONIC
3081		3429
3082	If defined to be C<1>, libev will try to detect the availability of the	3430	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	3431	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	3432	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	3433	you usually have to link against librt or something similar. Enabling it
3086	the functionality isn't available is safe, though, although you have	3434	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>	3435	to make sure you link against any libraries where the C<clock_gettime>
3088	function is hiding in (often F<-lrt>).	3436	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3089		3437
3090	=item EV_USE_REALTIME	3438	=item EV_USE_REALTIME
3091		3439
3092	If defined to be C<1>, libev will try to detect the availability of the	3440	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	3441	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	3442	at runtime if successful). Otherwise no use of the real-time clock
3095	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3443	option will be attempted. This effectively replaces C<gettimeofday>
3096	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3444	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
3097	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3445	correctness. See the note about libraries in the description of
		3446	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3447	C<EV_USE_CLOCK_SYSCALL>.
		3448
		3449	=item EV_USE_CLOCK_SYSCALL
		3450
		3451	If defined to be C<1>, libev will try to use a direct syscall instead
		3452	of calling the system-provided C<clock_gettime> function. This option
		3453	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3454	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3455	programs needlessly. Using a direct syscall is slightly slower (in
		3456	theory), because no optimised vdso implementation can be used, but avoids
		3457	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3458	higher, as it simplifies linking (no need for C<-lrt>).
3098		3459
3099	=item EV_USE_NANOSLEEP	3460	=item EV_USE_NANOSLEEP
3100		3461
3101	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3462	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 ()>.	3463	and will use it for delays. Otherwise it will use C<select ()>.
…		…
3118		3479
3119	=item EV_SELECT_USE_FD_SET	3480	=item EV_SELECT_USE_FD_SET
3120		3481
3121	If defined to C<1>, then the select backend will use the system C<fd_set>	3482	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	3483	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	3484	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	3485	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	3486	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	3487	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3127	influence the size of the C<fd_set> used.	3488	configures the maximum size of the C<fd_set>.
3128		3489
3129	=item EV_SELECT_IS_WINSOCKET	3490	=item EV_SELECT_IS_WINSOCKET
3130		3491
3131	When defined to C<1>, the select backend will assume that	3492	When defined to C<1>, the select backend will assume that
3132	select/socket/connect etc. don't understand file descriptors but	3493	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	3852	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.	3853	you must not do this from C<ev_periodic> reschedule callbacks.
3493		3854
3494	Care has been taken to ensure that libev does not keep local state inside	3855	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	3856	C<ev_loop>, and other calls do not usually allow for coroutine switches as
3496	they do not clal any callbacks.	3857	they do not call any callbacks.
3497		3858
3498	=head2 COMPILER WARNINGS	3859	=head2 COMPILER WARNINGS
3499		3860
3500	Depending on your compiler and compiler settings, you might get no or a	3861	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	3862	lot of warnings when compiling libev code. Some people are apparently
…		…
3535	==2274== definitely lost: 0 bytes in 0 blocks.	3896	==2274== definitely lost: 0 bytes in 0 blocks.
3536	==2274== possibly lost: 0 bytes in 0 blocks.	3897	==2274== possibly lost: 0 bytes in 0 blocks.
3537	==2274== still reachable: 256 bytes in 1 blocks.	3898	==2274== still reachable: 256 bytes in 1 blocks.
3538		3899
3539	Then there is no memory leak, just as memory accounted to global variables	3900	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.	3901	is not a memleak - the memory is still being referenced, and didn't leak.
3541		3902
3542	Similarly, under some circumstances, valgrind might report kernel bugs	3903	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,	3904	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	3905	although an acceptable workaround has been found here), or it might be
3545	confused.	3906	confused.
…		…
3781	involves iterating over all running async watchers or all signal numbers.	4142	involves iterating over all running async watchers or all signal numbers.
3782		4143
3783	=back	4144	=back
3784		4145
3785		4146
		4147	=head1 GLOSSARY
		4148
		4149	=over 4
		4150
		4151	=item active
		4152
		4153	A watcher is active as long as it has been started (has been attached to
		4154	an event loop) but not yet stopped (disassociated from the event loop).
		4155
		4156	=item application
		4157
		4158	In this document, an application is whatever is using libev.
		4159
		4160	=item callback
		4161
		4162	The address of a function that is called when some event has been
		4163	detected. Callbacks are being passed the event loop, the watcher that
		4164	received the event, and the actual event bitset.
		4165
		4166	=item callback invocation
		4167
		4168	The act of calling the callback associated with a watcher.
		4169
		4170	=item event
		4171
		4172	A change of state of some external event, such as data now being available
		4173	for reading on a file descriptor, time having passed or simply not having
		4174	any other events happening anymore.
		4175
		4176	In libev, events are represented as single bits (such as C<EV_READ> or
		4177	C<EV_TIMEOUT>).
		4178
		4179	=item event library
		4180
		4181	A software package implementing an event model and loop.
		4182
		4183	=item event loop
		4184
		4185	An entity that handles and processes external events and converts them
		4186	into callback invocations.
		4187
		4188	=item event model
		4189
		4190	The model used to describe how an event loop handles and processes
		4191	watchers and events.
		4192
		4193	=item pending
		4194
		4195	A watcher is pending as soon as the corresponding event has been detected,
		4196	and stops being pending as soon as the watcher will be invoked or its
		4197	pending status is explicitly cleared by the application.
		4198
		4199	A watcher can be pending, but not active. Stopping a watcher also clears
		4200	its pending status.
		4201
		4202	=item real time
		4203
		4204	The physical time that is observed. It is apparently strictly monotonic :)
		4205
		4206	=item wall-clock time
		4207
		4208	The time and date as shown on clocks. Unlike real time, it can actually
		4209	be wrong and jump forwards and backwards, e.g. when the you adjust your
		4210	clock.
		4211
		4212	=item watcher
		4213
		4214	A data structure that describes interest in certain events. Watchers need
		4215	to be started (attached to an event loop) before they can receive events.
		4216
		4217	=item watcher invocation
		4218
		4219	The act of calling the callback associated with a watcher.
		4220
		4221	=back
		4222
3786	=head1 AUTHOR	4223	=head1 AUTHOR
3787		4224
3788	Marc Lehmann <libev@schmorp.de>.	4225	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3789		4226

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.240 by root, Sat Apr 25 14:12:48 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.240 by root, Sat Apr 25 14:12:48 2009 UTC