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

Comparing libev/ev.pod (file contents):
Revision 1.48 by root, Tue Nov 27 08:11:52 2007 UTC vs.
Revision 1.76 by root, Sat Dec 8 15:30:30 2007 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
		9	=head1 EXAMPLE PROGRAM
		10
		11	#include <ev.h>
		12
		13	ev_io stdin_watcher;
		14	ev_timer timeout_watcher;
		15
		16	/* called when data readable on stdin */
		17	static void
		18	stdin_cb (EV_P_ struct ev_io *w, int revents)
		19	{
		20	/* puts ("stdin ready"); */
		21	ev_io_stop (EV_A_ w); /* just a syntax example */
		22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */
		23	}
		24
		25	static void
		26	timeout_cb (EV_P_ struct ev_timer *w, int revents)
		27	{
		28	/* puts ("timeout"); */
		29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */
		30	}
		31
		32	int
		33	main (void)
		34	{
		35	struct ev_loop *loop = ev_default_loop (0);
		36
		37	/* initialise an io watcher, then start it */
		38	ev_io_init (&stdin_watcher, stdin_cb, /STDIN_FILENO/ 0, EV_READ);
		39	ev_io_start (loop, &stdin_watcher);
		40
		41	/* simple non-repeating 5.5 second timeout */
		42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		43	ev_timer_start (loop, &timeout_watcher);
		44
		45	/* loop till timeout or data ready */
		46	ev_loop (loop, 0);
		47
		48	return 0;
		49	}
		50
9	=head1 DESCRIPTION	51	=head1 DESCRIPTION
		52
		53	The newest version of this document is also available as a html-formatted
		54	web page you might find easier to navigate when reading it for the first
		55	time: L<http://cvs.schmorp.de/libev/ev.html>.
10		56
11	Libev is an event loop: you register interest in certain events (such as a	57	Libev is an event loop: you register interest in certain events (such as a
12	file descriptor being readable or a timeout occuring), and it will manage	58	file descriptor being readable or a timeout occuring), and it will manage
13	these event sources and provide your program with events.	59	these event sources and provide your program with events.
14		60
…		…
21	details of the event, and then hand it over to libev by I<starting> the	67	details of the event, and then hand it over to libev by I<starting> the
22	watcher.	68	watcher.
23		69
24	=head1 FEATURES	70	=head1 FEATURES
25		71
26	Libev supports select, poll, the linux-specific epoll and the bsd-specific	72	Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
27	kqueue mechanisms for file descriptor events, relative timers, absolute	73	BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
28	timers with customised rescheduling, signal events, process status change	74	for file descriptor events (C<ev_io>), the Linux C<inotify> interface
29	events (related to SIGCHLD), and event watchers dealing with the event	75	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30	loop mechanism itself (idle, prepare and check watchers). It also is quite	76	with customised rescheduling (C<ev_periodic>), synchronous signals
		77	(C<ev_signal>), process status change events (C<ev_child>), and event
		78	watchers dealing with the event loop mechanism itself (C<ev_idle>,
		79	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		80	file watchers (C<ev_stat>) and even limited support for fork events
		81	(C<ev_fork>).
		82
		83	It also is quite fast (see this
31	fast (see this L<benchmark\|http://libev.schmorp.de/bench.html> comparing	84	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent
32	it to libevent for example).	85	for example).
33		86
34	=head1 CONVENTIONS	87	=head1 CONVENTIONS
35		88
36	Libev is very configurable. In this manual the default configuration	89	Libev is very configurable. In this manual the default configuration will
37	will be described, which supports multiple event loops. For more info	90	be described, which supports multiple event loops. For more info about
38	about various configuration options please have a look at the file	91	various configuration options please have a look at B<EMBED> section in
39	F<README.embed> in the libev distribution. If libev was configured without	92	this manual. If libev was configured without support for multiple event
40	support for multiple event loops, then all functions taking an initial	93	loops, then all functions taking an initial argument of name C<loop>
41	argument of name C<loop> (which is always of type C<struct ev_loop *>)	94	(which is always of type C<struct ev_loop *>) will not have this argument.
42	will not have this argument.
43		95
44	=head1 TIME REPRESENTATION	96	=head1 TIME REPRESENTATION
45		97
46	Libev represents time as a single floating point number, representing the	98	Libev represents time as a single floating point number, representing the
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	99	(fractional) number of seconds since the (POSIX) epoch (somewhere near
48	the beginning of 1970, details are complicated, don't ask). This type is	100	the beginning of 1970, details are complicated, don't ask). This type is
49	called C<ev_tstamp>, which is what you should use too. It usually aliases	101	called C<ev_tstamp>, which is what you should use too. It usually aliases
50	to the C<double> type in C, and when you need to do any calculations on	102	to the C<double> type in C, and when you need to do any calculations on
51	it, you should treat it as such.	103	it, you should treat it as such.
52		104
53
54	=head1 GLOBAL FUNCTIONS	105	=head1 GLOBAL FUNCTIONS
55		106
56	These functions can be called anytime, even before initialising the	107	These functions can be called anytime, even before initialising the
57	library in any way.	108	library in any way.
58		109
…		…
77	Usually, it's a good idea to terminate if the major versions mismatch,	128	Usually, it's a good idea to terminate if the major versions mismatch,
78	as this indicates an incompatible change. Minor versions are usually	129	as this indicates an incompatible change. Minor versions are usually
79	compatible to older versions, so a larger minor version alone is usually	130	compatible to older versions, so a larger minor version alone is usually
80	not a problem.	131	not a problem.
81		132
82	Example: make sure we haven't accidentally been linked against the wrong	133	Example: Make sure we haven't accidentally been linked against the wrong
83	version:	134	version.
84		135
85	assert (("libev version mismatch",	136	assert (("libev version mismatch",
86	ev_version_major () == EV_VERSION_MAJOR	137	ev_version_major () == EV_VERSION_MAJOR
87	&& ev_version_minor () >= EV_VERSION_MINOR));	138	&& ev_version_minor () >= EV_VERSION_MINOR));
88		139
…		…
118		169
119	See the description of C<ev_embed> watchers for more info.	170	See the description of C<ev_embed> watchers for more info.
120		171
121	=item ev_set_allocator (void (cb)(void *ptr, long size))	172	=item ev_set_allocator (void (cb)(void *ptr, long size))
122		173
123	Sets the allocation function to use (the prototype is similar to the	174	Sets the allocation function to use (the prototype is similar - the
124	realloc C function, the semantics are identical). It is used to allocate	175	semantics is identical - to the realloc C function). It is used to
125	and free memory (no surprises here). If it returns zero when memory	176	allocate and free memory (no surprises here). If it returns zero when
126	needs to be allocated, the library might abort or take some potentially	177	memory needs to be allocated, the library might abort or take some
127	destructive action. The default is your system realloc function.	178	potentially destructive action. The default is your system realloc
		179	function.
128		180
129	You could override this function in high-availability programs to, say,	181	You could override this function in high-availability programs to, say,
130	free some memory if it cannot allocate memory, to use a special allocator,	182	free some memory if it cannot allocate memory, to use a special allocator,
131	or even to sleep a while and retry until some memory is available.	183	or even to sleep a while and retry until some memory is available.
132		184
133	Example: replace the libev allocator with one that waits a bit and then	185	Example: Replace the libev allocator with one that waits a bit and then
134	retries: better than mine).	186	retries).
135		187
136	static void *	188	static void *
137	persistent_realloc (void *ptr, long size)	189	persistent_realloc (void *ptr, size_t size)
138	{	190	{
139	for (;;)	191	for (;;)
140	{	192	{
141	void *newptr = realloc (ptr, size);	193	void *newptr = realloc (ptr, size);
142		194
…		…
158	callback is set, then libev will expect it to remedy the sitution, no	210	callback is set, then libev will expect it to remedy the sitution, no
159	matter what, when it returns. That is, libev will generally retry the	211	matter what, when it returns. That is, libev will generally retry the
160	requested operation, or, if the condition doesn't go away, do bad stuff	212	requested operation, or, if the condition doesn't go away, do bad stuff
161	(such as abort).	213	(such as abort).
162		214
163	Example: do the same thing as libev does internally:	215	Example: This is basically the same thing that libev does internally, too.
164		216
165	static void	217	static void
166	fatal_error (const char *msg)	218	fatal_error (const char *msg)
167	{	219	{
168	perror (msg);	220	perror (msg);
…		…
218	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	270	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
219	override the flags completely if it is found in the environment. This is	271	override the flags completely if it is found in the environment. This is
220	useful to try out specific backends to test their performance, or to work	272	useful to try out specific backends to test their performance, or to work
221	around bugs.	273	around bugs.
222		274
		275	=item C<EVFLAG_FORKCHECK>
		276
		277	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		278	a fork, you can also make libev check for a fork in each iteration by
		279	enabling this flag.
		280
		281	This works by calling C<getpid ()> on every iteration of the loop,
		282	and thus this might slow down your event loop if you do a lot of loop
		283	iterations and little real work, but is usually not noticeable (on my
		284	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		285	without a syscall and thus I<very> fast, but my Linux system also has
		286	C<pthread_atfork> which is even faster).
		287
		288	The big advantage of this flag is that you can forget about fork (and
		289	forget about forgetting to tell libev about forking) when you use this
		290	flag.
		291
		292	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		293	environment variable.
		294
223	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	295	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
224		296
225	This is your standard select(2) backend. Not I<completely> standard, as	297	This is your standard select(2) backend. Not I<completely> standard, as
226	libev tries to roll its own fd_set with no limits on the number of fds,	298	libev tries to roll its own fd_set with no limits on the number of fds,
227	but if that fails, expect a fairly low limit on the number of fds when	299	but if that fails, expect a fairly low limit on the number of fds when
…		…
314	Similar to C<ev_default_loop>, but always creates a new event loop that is	386	Similar to C<ev_default_loop>, but always creates a new event loop that is
315	always distinct from the default loop. Unlike the default loop, it cannot	387	always distinct from the default loop. Unlike the default loop, it cannot
316	handle signal and child watchers, and attempts to do so will be greeted by	388	handle signal and child watchers, and attempts to do so will be greeted by
317	undefined behaviour (or a failed assertion if assertions are enabled).	389	undefined behaviour (or a failed assertion if assertions are enabled).
318		390
319	Example: try to create a event loop that uses epoll and nothing else.	391	Example: Try to create a event loop that uses epoll and nothing else.
320		392
321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	393	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
322	if (!epoller)	394	if (!epoller)
323	fatal ("no epoll found here, maybe it hides under your chair");	395	fatal ("no epoll found here, maybe it hides under your chair");
324		396
…		…
361	=item ev_loop_fork (loop)	433	=item ev_loop_fork (loop)
362		434
363	Like C<ev_default_fork>, but acts on an event loop created by	435	Like C<ev_default_fork>, but acts on an event loop created by
364	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	436	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
365	after fork, and how you do this is entirely your own problem.	437	after fork, and how you do this is entirely your own problem.
		438
		439	=item unsigned int ev_loop_count (loop)
		440
		441	Returns the count of loop iterations for the loop, which is identical to
		442	the number of times libev did poll for new events. It starts at C<0> and
		443	happily wraps around with enough iterations.
		444
		445	This value can sometimes be useful as a generation counter of sorts (it
		446	"ticks" the number of loop iterations), as it roughly corresponds with
		447	C<ev_prepare> and C<ev_check> calls.
366		448
367	=item unsigned int ev_backend (loop)	449	=item unsigned int ev_backend (loop)
368		450
369	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	451	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
370	use.	452	use.
…		…
423	Signals and child watchers are implemented as I/O watchers, and will	505	Signals and child watchers are implemented as I/O watchers, and will
424	be handled here by queueing them when their watcher gets executed.	506	be handled here by queueing them when their watcher gets executed.
425	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	507	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
426	were used, return, otherwise continue with step *.	508	were used, return, otherwise continue with step *.
427		509
428	Example: queue some jobs and then loop until no events are outsanding	510	Example: Queue some jobs and then loop until no events are outsanding
429	anymore.	511	anymore.
430		512
431	... queue jobs here, make sure they register event watchers as long	513	... queue jobs here, make sure they register event watchers as long
432	... as they still have work to do (even an idle watcher will do..)	514	... as they still have work to do (even an idle watcher will do..)
433	ev_loop (my_loop, 0);	515	ev_loop (my_loop, 0);
…		…
453	visible to the libev user and should not keep C<ev_loop> from exiting if	535	visible to the libev user and should not keep C<ev_loop> from exiting if
454	no event watchers registered by it are active. It is also an excellent	536	no event watchers registered by it are active. It is also an excellent
455	way to do this for generic recurring timers or from within third-party	537	way to do this for generic recurring timers or from within third-party
456	libraries. Just remember to I<unref after start> and I<ref before stop>.	538	libraries. Just remember to I<unref after start> and I<ref before stop>.
457		539
458	Example: create a signal watcher, but keep it from keeping C<ev_loop>	540	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
459	running when nothing else is active.	541	running when nothing else is active.
460		542
461	struct dv_signal exitsig;	543	struct ev_signal exitsig;
462	ev_signal_init (&exitsig, sig_cb, SIGINT);	544	ev_signal_init (&exitsig, sig_cb, SIGINT);
463	ev_signal_start (myloop, &exitsig);	545	ev_signal_start (loop, &exitsig);
464	evf_unref (myloop);	546	evf_unref (loop);
465		547
466	Example: for some weird reason, unregister the above signal handler again.	548	Example: For some weird reason, unregister the above signal handler again.
467		549
468	ev_ref (myloop);	550	ev_ref (loop);
469	ev_signal_stop (myloop, &exitsig);	551	ev_signal_stop (loop, &exitsig);
470		552
471	=back	553	=back
472		554
473		555
474	=head1 ANATOMY OF A WATCHER	556	=head1 ANATOMY OF A WATCHER
…		…
565	received events. Callbacks of both watcher types can start and stop as	647	received events. Callbacks of both watcher types can start and stop as
566	many watchers as they want, and all of them will be taken into account	648	many watchers as they want, and all of them will be taken into account
567	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	649	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
568	C<ev_loop> from blocking).	650	C<ev_loop> from blocking).
569		651
		652	=item C<EV_EMBED>
		653
		654	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		655
		656	=item C<EV_FORK>
		657
		658	The event loop has been resumed in the child process after fork (see
		659	C<ev_fork>).
		660
570	=item C<EV_ERROR>	661	=item C<EV_ERROR>
571		662
572	An unspecified error has occured, the watcher has been stopped. This might	663	An unspecified error has occured, the watcher has been stopped. This might
573	happen because the watcher could not be properly started because libev	664	happen because the watcher could not be properly started because libev
574	ran out of memory, a file descriptor was found to be closed or any other	665	ran out of memory, a file descriptor was found to be closed or any other
…		…
645	=item bool ev_is_pending (ev_TYPE *watcher)	736	=item bool ev_is_pending (ev_TYPE *watcher)
646		737
647	Returns a true value iff the watcher is pending, (i.e. it has outstanding	738	Returns a true value iff the watcher is pending, (i.e. it has outstanding
648	events but its callback has not yet been invoked). As long as a watcher	739	events but its callback has not yet been invoked). As long as a watcher
649	is pending (but not active) you must not call an init function on it (but	740	is pending (but not active) you must not call an init function on it (but
650	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	741	C<ev_TYPE_set> is safe), you must not change its priority, and you must
651	libev (e.g. you cnanot C<free ()> it).	742	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		743	it).
652		744
653	=item callback = ev_cb (ev_TYPE *watcher)	745	=item callback ev_cb (ev_TYPE *watcher)
654		746
655	Returns the callback currently set on the watcher.	747	Returns the callback currently set on the watcher.
656		748
657	=item ev_cb_set (ev_TYPE *watcher, callback)	749	=item ev_cb_set (ev_TYPE *watcher, callback)
658		750
659	Change the callback. You can change the callback at virtually any time	751	Change the callback. You can change the callback at virtually any time
660	(modulo threads).	752	(modulo threads).
		753
		754	=item ev_set_priority (ev_TYPE *watcher, priority)
		755
		756	=item int ev_priority (ev_TYPE *watcher)
		757
		758	Set and query the priority of the watcher. The priority is a small
		759	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		760	(default: C<-2>). Pending watchers with higher priority will be invoked
		761	before watchers with lower priority, but priority will not keep watchers
		762	from being executed (except for C<ev_idle> watchers).
		763
		764	This means that priorities are I<only> used for ordering callback
		765	invocation after new events have been received. This is useful, for
		766	example, to reduce latency after idling, or more often, to bind two
		767	watchers on the same event and make sure one is called first.
		768
		769	If you need to suppress invocation when higher priority events are pending
		770	you need to look at C<ev_idle> watchers, which provide this functionality.
		771
		772	You I<must not> change the priority of a watcher as long as it is active or
		773	pending.
		774
		775	The default priority used by watchers when no priority has been set is
		776	always C<0>, which is supposed to not be too high and not be too low :).
		777
		778	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		779	fine, as long as you do not mind that the priority value you query might
		780	or might not have been adjusted to be within valid range.
		781
		782	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		783
		784	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		785	C<loop> nor C<revents> need to be valid as long as the watcher callback
		786	can deal with that fact.
		787
		788	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		789
		790	If the watcher is pending, this function returns clears its pending status
		791	and returns its C<revents> bitset (as if its callback was invoked). If the
		792	watcher isn't pending it does nothing and returns C<0>.
661		793
662	=back	794	=back
663		795
664		796
665	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	797	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
686	{	818	{
687	struct my_io w = (struct my_io )w_;	819	struct my_io w = (struct my_io )w_;
688	...	820	...
689	}	821	}
690		822
691	More interesting and less C-conformant ways of catsing your callback type	823	More interesting and less C-conformant ways of casting your callback type
692	have been omitted....	824	instead have been omitted.
		825
		826	Another common scenario is having some data structure with multiple
		827	watchers:
		828
		829	struct my_biggy
		830	{
		831	int some_data;
		832	ev_timer t1;
		833	ev_timer t2;
		834	}
		835
		836	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		837	you need to use C<offsetof>:
		838
		839	#include <stddef.h>
		840
		841	static void
		842	t1_cb (EV_P_ struct ev_timer *w, int revents)
		843	{
		844	struct my_biggy big = (struct my_biggy *
		845	(((char *)w) - offsetof (struct my_biggy, t1));
		846	}
		847
		848	static void
		849	t2_cb (EV_P_ struct ev_timer *w, int revents)
		850	{
		851	struct my_biggy big = (struct my_biggy *
		852	(((char *)w) - offsetof (struct my_biggy, t2));
		853	}
693		854
694		855
695	=head1 WATCHER TYPES	856	=head1 WATCHER TYPES
696		857
697	This section describes each watcher in detail, but will not repeat	858	This section describes each watcher in detail, but will not repeat
…		…
742	it is best to always use non-blocking I/O: An extra C<read>(2) returning	903	it is best to always use non-blocking I/O: An extra C<read>(2) returning
743	C<EAGAIN> is far preferable to a program hanging until some data arrives.	904	C<EAGAIN> is far preferable to a program hanging until some data arrives.
744		905
745	If you cannot run the fd in non-blocking mode (for example you should not	906	If you cannot run the fd in non-blocking mode (for example you should not
746	play around with an Xlib connection), then you have to seperately re-test	907	play around with an Xlib connection), then you have to seperately re-test
747	wether a file descriptor is really ready with a known-to-be good interface	908	whether a file descriptor is really ready with a known-to-be good interface
748	such as poll (fortunately in our Xlib example, Xlib already does this on	909	such as poll (fortunately in our Xlib example, Xlib already does this on
749	its own, so its quite safe to use).	910	its own, so its quite safe to use).
750		911
751	=over 4	912	=over 4
752		913
…		…
766		927
767	The events being watched.	928	The events being watched.
768		929
769	=back	930	=back
770		931
771	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	932	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
772	readable, but only once. Since it is likely line-buffered, you could	933	readable, but only once. Since it is likely line-buffered, you could
773	attempt to read a whole line in the callback:	934	attempt to read a whole line in the callback.
774		935
775	static void	936	static void
776	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)	937	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
777	{	938	{
778	ev_io_stop (loop, w);	939	ev_io_stop (loop, w);
…		…
830	=item ev_timer_again (loop)	991	=item ev_timer_again (loop)
831		992
832	This will act as if the timer timed out and restart it again if it is	993	This will act as if the timer timed out and restart it again if it is
833	repeating. The exact semantics are:	994	repeating. The exact semantics are:
834		995
		996	If the timer is pending, its pending status is cleared.
		997
835	If the timer is started but nonrepeating, stop it.	998	If the timer is started but nonrepeating, stop it (as if it timed out).
836		999
837	If the timer is repeating, either start it if necessary (with the repeat	1000	If the timer is repeating, either start it if necessary (with the
838	value), or reset the running timer to the repeat value.	1001	C<repeat> value), or reset the running timer to the C<repeat> value.
839		1002
840	This sounds a bit complicated, but here is a useful and typical	1003	This sounds a bit complicated, but here is a useful and typical
841	example: Imagine you have a tcp connection and you want a so-called	1004	example: Imagine you have a tcp connection and you want a so-called idle
842	idle timeout, that is, you want to be called when there have been,	1005	timeout, that is, you want to be called when there have been, say, 60
843	say, 60 seconds of inactivity on the socket. The easiest way to do	1006	seconds of inactivity on the socket. The easiest way to do this is to
844	this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling	1007	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
845	C<ev_timer_again> each time you successfully read or write some data. If	1008	C<ev_timer_again> each time you successfully read or write some data. If
846	you go into an idle state where you do not expect data to travel on the	1009	you go into an idle state where you do not expect data to travel on the
847	socket, you can stop the timer, and again will automatically restart it if	1010	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
848	need be.	1011	automatically restart it if need be.
849		1012
850	You can also ignore the C<after> value and C<ev_timer_start> altogether	1013	That means you can ignore the C<after> value and C<ev_timer_start>
851	and only ever use the C<repeat> value:	1014	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
852		1015
853	ev_timer_init (timer, callback, 0., 5.);	1016	ev_timer_init (timer, callback, 0., 5.);
854	ev_timer_again (loop, timer);	1017	ev_timer_again (loop, timer);
855	...	1018	...
856	timer->again = 17.;	1019	timer->again = 17.;
857	ev_timer_again (loop, timer);	1020	ev_timer_again (loop, timer);
858	...	1021	...
859	timer->again = 10.;	1022	timer->again = 10.;
860	ev_timer_again (loop, timer);	1023	ev_timer_again (loop, timer);
861		1024
862	This is more efficient then stopping/starting the timer eahc time you want	1025	This is more slightly efficient then stopping/starting the timer each time
863	to modify its timeout value.	1026	you want to modify its timeout value.
864		1027
865	=item ev_tstamp repeat [read-write]	1028	=item ev_tstamp repeat [read-write]
866		1029
867	The current C<repeat> value. Will be used each time the watcher times out	1030	The current C<repeat> value. Will be used each time the watcher times out
868	or C<ev_timer_again> is called and determines the next timeout (if any),	1031	or C<ev_timer_again> is called and determines the next timeout (if any),
869	which is also when any modifications are taken into account.	1032	which is also when any modifications are taken into account.
870		1033
871	=back	1034	=back
872		1035
873	Example: create a timer that fires after 60 seconds.	1036	Example: Create a timer that fires after 60 seconds.
874		1037
875	static void	1038	static void
876	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)	1039	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
877	{	1040	{
878	.. one minute over, w is actually stopped right here	1041	.. one minute over, w is actually stopped right here
…		…
880		1043
881	struct ev_timer mytimer;	1044	struct ev_timer mytimer;
882	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1045	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
883	ev_timer_start (loop, &mytimer);	1046	ev_timer_start (loop, &mytimer);
884		1047
885	Example: create a timeout timer that times out after 10 seconds of	1048	Example: Create a timeout timer that times out after 10 seconds of
886	inactivity.	1049	inactivity.
887		1050
888	static void	1051	static void
889	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)	1052	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
890	{	1053	{
…		…
1015	switched off. Can be changed any time, but changes only take effect when	1178	switched off. Can be changed any time, but changes only take effect when
1016	the periodic timer fires or C<ev_periodic_again> is being called.	1179	the periodic timer fires or C<ev_periodic_again> is being called.
1017		1180
1018	=back	1181	=back
1019		1182
1020	Example: call a callback every hour, or, more precisely, whenever the	1183	Example: Call a callback every hour, or, more precisely, whenever the
1021	system clock is divisible by 3600. The callback invocation times have	1184	system clock is divisible by 3600. The callback invocation times have
1022	potentially a lot of jittering, but good long-term stability.	1185	potentially a lot of jittering, but good long-term stability.
1023		1186
1024	static void	1187	static void
1025	clock_cb (struct ev_loop loop, struct ev_io w, int revents)	1188	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
…		…
1029		1192
1030	struct ev_periodic hourly_tick;	1193	struct ev_periodic hourly_tick;
1031	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1194	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1032	ev_periodic_start (loop, &hourly_tick);	1195	ev_periodic_start (loop, &hourly_tick);
1033		1196
1034	Example: the same as above, but use a reschedule callback to do it:	1197	Example: The same as above, but use a reschedule callback to do it:
1035		1198
1036	#include <math.h>	1199	#include <math.h>
1037		1200
1038	static ev_tstamp	1201	static ev_tstamp
1039	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1202	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
1041	return fmod (now, 3600.) + 3600.;	1204	return fmod (now, 3600.) + 3600.;
1042	}	1205	}
1043		1206
1044	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1207	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1045		1208
1046	Example: call a callback every hour, starting now:	1209	Example: Call a callback every hour, starting now:
1047		1210
1048	struct ev_periodic hourly_tick;	1211	struct ev_periodic hourly_tick;
1049	ev_periodic_init (&hourly_tick, clock_cb,	1212	ev_periodic_init (&hourly_tick, clock_cb,
1050	fmod (ev_now (loop), 3600.), 3600., 0);	1213	fmod (ev_now (loop), 3600.), 3600., 0);
1051	ev_periodic_start (loop, &hourly_tick);	1214	ev_periodic_start (loop, &hourly_tick);
…		…
1112	The process exit/trace status caused by C<rpid> (see your systems	1275	The process exit/trace status caused by C<rpid> (see your systems
1113	C<waitpid> and C<sys/wait.h> documentation for details).	1276	C<waitpid> and C<sys/wait.h> documentation for details).
1114		1277
1115	=back	1278	=back
1116		1279
1117	Example: try to exit cleanly on SIGINT and SIGTERM.	1280	Example: Try to exit cleanly on SIGINT and SIGTERM.
1118		1281
1119	static void	1282	static void
1120	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1283	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
1121	{	1284	{
1122	ev_unloop (loop, EVUNLOOP_ALL);	1285	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1137	not exist" is a status change like any other. The condition "path does	1300	not exist" is a status change like any other. The condition "path does
1138	not exist" is signified by the C<st_nlink> field being zero (which is	1301	not exist" is signified by the C<st_nlink> field being zero (which is
1139	otherwise always forced to be at least one) and all the other fields of	1302	otherwise always forced to be at least one) and all the other fields of
1140	the stat buffer having unspecified contents.	1303	the stat buffer having unspecified contents.
1141		1304
		1305	The path I<should> be absolute and I<must not> end in a slash. If it is
		1306	relative and your working directory changes, the behaviour is undefined.
		1307
1142	Since there is no standard to do this, the portable implementation simply	1308	Since there is no standard to do this, the portable implementation simply
1143	calls C<stat (2)> regulalry on the path to see if it changed somehow. You	1309	calls C<stat (2)> regularly on the path to see if it changed somehow. You
1144	can specify a recommended polling interval for this case. If you specify	1310	can specify a recommended polling interval for this case. If you specify
1145	a polling interval of C<0> (highly recommended!) then a I<suitable,	1311	a polling interval of C<0> (highly recommended!) then a I<suitable,
1146	unspecified default> value will be used (which you can expect to be around	1312	unspecified default> value will be used (which you can expect to be around
1147	five seconds, although this might change dynamically). Libev will also	1313	five seconds, although this might change dynamically). Libev will also
1148	impose a minimum interval which is currently around C<0.1>, but thats	1314	impose a minimum interval which is currently around C<0.1>, but thats
…		…
1150		1316
1151	This watcher type is not meant for massive numbers of stat watchers,	1317	This watcher type is not meant for massive numbers of stat watchers,
1152	as even with OS-supported change notifications, this can be	1318	as even with OS-supported change notifications, this can be
1153	resource-intensive.	1319	resource-intensive.
1154		1320
1155	At the time of this writing, no specific OS backends are implemented, but	1321	At the time of this writing, only the Linux inotify interface is
1156	if demand increases, at least a kqueue and inotify backend will be added.	1322	implemented (implementing kqueue support is left as an exercise for the
		1323	reader). Inotify will be used to give hints only and should not change the
		1324	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1325	to fall back to regular polling again even with inotify, but changes are
		1326	usually detected immediately, and if the file exists there will be no
		1327	polling.
1157		1328
1158	=over 4	1329	=over 4
1159		1330
1160	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)	1331	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)
1161		1332
…		…
1225	ev_stat_start (loop, &passwd);	1396	ev_stat_start (loop, &passwd);
1226		1397
1227		1398
1228	=head2 C<ev_idle> - when you've got nothing better to do...	1399	=head2 C<ev_idle> - when you've got nothing better to do...
1229		1400
1230	Idle watchers trigger events when there are no other events are pending	1401	Idle watchers trigger events when no other events of the same or higher
1231	(prepare, check and other idle watchers do not count). That is, as long	1402	priority are pending (prepare, check and other idle watchers do not
1232	as your process is busy handling sockets or timeouts (or even signals,	1403	count).
1233	imagine) it will not be triggered. But when your process is idle all idle	1404
1234	watchers are being called again and again, once per event loop iteration -	1405	That is, as long as your process is busy handling sockets or timeouts
		1406	(or even signals, imagine) of the same or higher priority it will not be
		1407	triggered. But when your process is idle (or only lower-priority watchers
		1408	are pending), the idle watchers are being called once per event loop
1235	until stopped, that is, or your process receives more events and becomes	1409	iteration - until stopped, that is, or your process receives more events
1236	busy.	1410	and becomes busy again with higher priority stuff.
1237		1411
1238	The most noteworthy effect is that as long as any idle watchers are	1412	The most noteworthy effect is that as long as any idle watchers are
1239	active, the process will not block when waiting for new events.	1413	active, the process will not block when waiting for new events.
1240		1414
1241	Apart from keeping your process non-blocking (which is a useful	1415	Apart from keeping your process non-blocking (which is a useful
…		…
1251	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1425	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1252	believe me.	1426	believe me.
1253		1427
1254	=back	1428	=back
1255		1429
1256	Example: dynamically allocate an C<ev_idle>, start it, and in the	1430	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1257	callback, free it. Alos, use no error checking, as usual.	1431	callback, free it. Also, use no error checking, as usual.
1258		1432
1259	static void	1433	static void
1260	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)	1434	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
1261	{	1435	{
1262	free (w);	1436	free (w);
…		…
1319	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1493	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1320	macros, but using them is utterly, utterly and completely pointless.	1494	macros, but using them is utterly, utterly and completely pointless.
1321		1495
1322	=back	1496	=back
1323		1497
1324	Example: To include a library such as adns, you would add IO watchers	1498	There are a number of principal ways to embed other event loops or modules
1325	and a timeout watcher in a prepare handler, as required by libadns, and	1499	into libev. Here are some ideas on how to include libadns into libev
		1500	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1501	use for an actually working example. Another Perl module named C<EV::Glib>
		1502	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1503	into the Glib event loop).
		1504
		1505	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1326	in a check watcher, destroy them and call into libadns. What follows is	1506	and in a check watcher, destroy them and call into libadns. What follows
1327	pseudo-code only of course:	1507	is pseudo-code only of course. This requires you to either use a low
		1508	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1509	the callbacks for the IO/timeout watchers might not have been called yet.
1328		1510
1329	static ev_io iow [nfd];	1511	static ev_io iow [nfd];
1330	static ev_timer tw;	1512	static ev_timer tw;
1331		1513
1332	static void	1514	static void
1333	io_cb (ev_loop loop, ev_io w, int revents)	1515	io_cb (ev_loop loop, ev_io w, int revents)
1334	{	1516	{
1335	// set the relevant poll flags
1336	// could also call adns_processreadable etc. here
1337	struct pollfd fd = (struct pollfd )w->data;
1338	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
1339	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
1340	}	1517	}
1341		1518
1342	// create io watchers for each fd and a timer before blocking	1519	// create io watchers for each fd and a timer before blocking
1343	static void	1520	static void
1344	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)	1521	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
1345	{	1522	{
1346	int timeout = 3600000;truct pollfd fds [nfd];	1523	int timeout = 3600000;
		1524	struct pollfd fds [nfd];
1347	// actual code will need to loop here and realloc etc.	1525	// actual code will need to loop here and realloc etc.
1348	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1526	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1349		1527
1350	/* the callback is illegal, but won't be called as we stop during check */	1528	/* the callback is illegal, but won't be called as we stop during check */
1351	ev_timer_init (&tw, 0, timeout * 1e-3);	1529	ev_timer_init (&tw, 0, timeout * 1e-3);
1352	ev_timer_start (loop, &tw);	1530	ev_timer_start (loop, &tw);
1353		1531
1354	// create on ev_io per pollfd	1532	// create one ev_io per pollfd
1355	for (int i = 0; i < nfd; ++i)	1533	for (int i = 0; i < nfd; ++i)
1356	{	1534	{
1357	ev_io_init (iow + i, io_cb, fds [i].fd,	1535	ev_io_init (iow + i, io_cb, fds [i].fd,
1358	((fds [i].events & POLLIN ? EV_READ : 0)	1536	((fds [i].events & POLLIN ? EV_READ : 0)
1359	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1537	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1360		1538
1361	fds [i].revents = 0;	1539	fds [i].revents = 0;
1362	iow [i].data = fds + i;
1363	ev_io_start (loop, iow + i);	1540	ev_io_start (loop, iow + i);
1364	}	1541	}
1365	}	1542	}
1366		1543
1367	// stop all watchers after blocking	1544	// stop all watchers after blocking
…		…
1369	adns_check_cb (ev_loop loop, ev_check w, int revents)	1546	adns_check_cb (ev_loop loop, ev_check w, int revents)
1370	{	1547	{
1371	ev_timer_stop (loop, &tw);	1548	ev_timer_stop (loop, &tw);
1372		1549
1373	for (int i = 0; i < nfd; ++i)	1550	for (int i = 0; i < nfd; ++i)
		1551	{
		1552	// set the relevant poll flags
		1553	// could also call adns_processreadable etc. here
		1554	struct pollfd *fd = fds + i;
		1555	int revents = ev_clear_pending (iow + i);
		1556	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1557	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1558
		1559	// now stop the watcher
1374	ev_io_stop (loop, iow + i);	1560	ev_io_stop (loop, iow + i);
		1561	}
1375		1562
1376	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1563	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1564	}
		1565
		1566	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1567	in the prepare watcher and would dispose of the check watcher.
		1568
		1569	Method 3: If the module to be embedded supports explicit event
		1570	notification (adns does), you can also make use of the actual watcher
		1571	callbacks, and only destroy/create the watchers in the prepare watcher.
		1572
		1573	static void
		1574	timer_cb (EV_P_ ev_timer *w, int revents)
		1575	{
		1576	adns_state ads = (adns_state)w->data;
		1577	update_now (EV_A);
		1578
		1579	adns_processtimeouts (ads, &tv_now);
		1580	}
		1581
		1582	static void
		1583	io_cb (EV_P_ ev_io *w, int revents)
		1584	{
		1585	adns_state ads = (adns_state)w->data;
		1586	update_now (EV_A);
		1587
		1588	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1589	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1590	}
		1591
		1592	// do not ever call adns_afterpoll
		1593
		1594	Method 4: Do not use a prepare or check watcher because the module you
		1595	want to embed is too inflexible to support it. Instead, youc na override
		1596	their poll function. The drawback with this solution is that the main
		1597	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1598	this.
		1599
		1600	static gint
		1601	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1602	{
		1603	int got_events = 0;
		1604
		1605	for (n = 0; n < nfds; ++n)
		1606	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1607
		1608	if (timeout >= 0)
		1609	// create/start timer
		1610
		1611	// poll
		1612	ev_loop (EV_A_ 0);
		1613
		1614	// stop timer again
		1615	if (timeout >= 0)
		1616	ev_timer_stop (EV_A_ &to);
		1617
		1618	// stop io watchers again - their callbacks should have set
		1619	for (n = 0; n < nfds; ++n)
		1620	ev_io_stop (EV_A_ iow [n]);
		1621
		1622	return got_events;
1377	}	1623	}
1378		1624
1379		1625
1380	=head2 C<ev_embed> - when one backend isn't enough...	1626	=head2 C<ev_embed> - when one backend isn't enough...
1381		1627
…		…
1470	The embedded event loop.	1716	The embedded event loop.
1471		1717
1472	=back	1718	=back
1473		1719
1474		1720
		1721	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		1722
		1723	Fork watchers are called when a C<fork ()> was detected (usually because
		1724	whoever is a good citizen cared to tell libev about it by calling
		1725	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		1726	event loop blocks next and before C<ev_check> watchers are being called,
		1727	and only in the child after the fork. If whoever good citizen calling
		1728	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		1729	handlers will be invoked, too, of course.
		1730
		1731	=over 4
		1732
		1733	=item ev_fork_init (ev_signal *, callback)
		1734
		1735	Initialises and configures the fork watcher - it has no parameters of any
		1736	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
		1737	believe me.
		1738
		1739	=back
		1740
		1741
1475	=head1 OTHER FUNCTIONS	1742	=head1 OTHER FUNCTIONS
1476		1743
1477	There are some other functions of possible interest. Described. Here. Now.	1744	There are some other functions of possible interest. Described. Here. Now.
1478		1745
1479	=over 4	1746	=over 4
…		…
1564		1831
1565	To use it,	1832	To use it,
1566		1833
1567	#include <ev++.h>	1834	#include <ev++.h>
1568		1835
1569	(it is not installed by default). This automatically includes F<ev.h>	1836	This automatically includes F<ev.h> and puts all of its definitions (many
1570	and puts all of its definitions (many of them macros) into the global	1837	of them macros) into the global namespace. All C++ specific things are
1571	namespace. All C++ specific things are put into the C<ev> namespace.	1838	put into the C<ev> namespace. It should support all the same embedding
		1839	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1572		1840
1573	It should support all the same embedding options as F<ev.h>, most notably	1841	Care has been taken to keep the overhead low. The only data member the C++
1574	C<EV_MULTIPLICITY>.	1842	classes add (compared to plain C-style watchers) is the event loop pointer
		1843	that the watcher is associated with (or no additional members at all if
		1844	you disable C<EV_MULTIPLICITY> when embedding libev).
		1845
		1846	Currently, functions, and static and non-static member functions can be
		1847	used as callbacks. Other types should be easy to add as long as they only
		1848	need one additional pointer for context. If you need support for other
		1849	types of functors please contact the author (preferably after implementing
		1850	it).
1575		1851
1576	Here is a list of things available in the C<ev> namespace:	1852	Here is a list of things available in the C<ev> namespace:
1577		1853
1578	=over 4	1854	=over 4
1579		1855
…		…
1595		1871
1596	All of those classes have these methods:	1872	All of those classes have these methods:
1597		1873
1598	=over 4	1874	=over 4
1599		1875
1600	=item ev::TYPE::TYPE (object , object::method )	1876	=item ev::TYPE::TYPE ()
1601		1877
1602	=item ev::TYPE::TYPE (object , object::method , struct ev_loop *)	1878	=item ev::TYPE::TYPE (struct ev_loop *)
1603		1879
1604	=item ev::TYPE::~TYPE	1880	=item ev::TYPE::~TYPE
1605		1881
1606	The constructor takes a pointer to an object and a method pointer to	1882	The constructor (optionally) takes an event loop to associate the watcher
1607	the event handler callback to call in this class. The constructor calls	1883	with. If it is omitted, it will use C<EV_DEFAULT>.
1608	C<ev_init> for you, which means you have to call the C<set> method	1884
1609	before starting it. If you do not specify a loop then the constructor	1885	The constructor calls C<ev_init> for you, which means you have to call the
1610	automatically associates the default loop with this watcher.	1886	C<set> method before starting it.
		1887
		1888	It will not set a callback, however: You have to call the templated C<set>
		1889	method to set a callback before you can start the watcher.
		1890
		1891	(The reason why you have to use a method is a limitation in C++ which does
		1892	not allow explicit template arguments for constructors).
1611		1893
1612	The destructor automatically stops the watcher if it is active.	1894	The destructor automatically stops the watcher if it is active.
		1895
		1896	=item w->set<class, &class::method> (object *)
		1897
		1898	This method sets the callback method to call. The method has to have a
		1899	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		1900	first argument and the C<revents> as second. The object must be given as
		1901	parameter and is stored in the C<data> member of the watcher.
		1902
		1903	This method synthesizes efficient thunking code to call your method from
		1904	the C callback that libev requires. If your compiler can inline your
		1905	callback (i.e. it is visible to it at the place of the C<set> call and
		1906	your compiler is good :), then the method will be fully inlined into the
		1907	thunking function, making it as fast as a direct C callback.
		1908
		1909	Example: simple class declaration and watcher initialisation
		1910
		1911	struct myclass
		1912	{
		1913	void io_cb (ev::io &w, int revents) { }
		1914	}
		1915
		1916	myclass obj;
		1917	ev::io iow;
		1918	iow.set <myclass, &myclass::io_cb> (&obj);
		1919
		1920	=item w->set<function> (void *data = 0)
		1921
		1922	Also sets a callback, but uses a static method or plain function as
		1923	callback. The optional C<data> argument will be stored in the watcher's
		1924	C<data> member and is free for you to use.
		1925
		1926	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		1927
		1928	See the method-C<set> above for more details.
		1929
		1930	Example:
		1931
		1932	static void io_cb (ev::io &w, int revents) { }
		1933	iow.set <io_cb> ();
1613		1934
1614	=item w->set (struct ev_loop *)	1935	=item w->set (struct ev_loop *)
1615		1936
1616	Associates a different C<struct ev_loop> with this watcher. You can only	1937	Associates a different C<struct ev_loop> with this watcher. You can only
1617	do this when the watcher is inactive (and not pending either).	1938	do this when the watcher is inactive (and not pending either).
1618		1939
1619	=item w->set ([args])	1940	=item w->set ([args])
1620		1941
1621	Basically the same as C<ev_TYPE_set>, with the same args. Must be	1942	Basically the same as C<ev_TYPE_set>, with the same args. Must be
1622	called at least once. Unlike the C counterpart, an active watcher gets	1943	called at least once. Unlike the C counterpart, an active watcher gets
1623	automatically stopped and restarted.	1944	automatically stopped and restarted when reconfiguring it with this
		1945	method.
1624		1946
1625	=item w->start ()	1947	=item w->start ()
1626		1948
1627	Starts the watcher. Note that there is no C<loop> argument as the	1949	Starts the watcher. Note that there is no C<loop> argument, as the
1628	constructor already takes the loop.	1950	constructor already stores the event loop.
1629		1951
1630	=item w->stop ()	1952	=item w->stop ()
1631		1953
1632	Stops the watcher if it is active. Again, no C<loop> argument.	1954	Stops the watcher if it is active. Again, no C<loop> argument.
1633		1955
…		…
1638		1960
1639	=item w->sweep () C<ev::embed> only	1961	=item w->sweep () C<ev::embed> only
1640		1962
1641	Invokes C<ev_embed_sweep>.	1963	Invokes C<ev_embed_sweep>.
1642		1964
		1965	=item w->update () C<ev::stat> only
		1966
		1967	Invokes C<ev_stat_stat>.
		1968
1643	=back	1969	=back
1644		1970
1645	=back	1971	=back
1646		1972
1647	Example: Define a class with an IO and idle watcher, start one of them in	1973	Example: Define a class with an IO and idle watcher, start one of them in
…		…
1654		1980
1655	myclass ();	1981	myclass ();
1656	}	1982	}
1657		1983
1658	myclass::myclass (int fd)	1984	myclass::myclass (int fd)
1659	: io (this, &myclass::io_cb),
1660	idle (this, &myclass::idle_cb)
1661	{	1985	{
		1986	io .set <myclass, &myclass::io_cb > (this);
		1987	idle.set <myclass, &myclass::idle_cb> (this);
		1988
1662	io.start (fd, ev::READ);	1989	io.start (fd, ev::READ);
1663	}	1990	}
		1991
		1992
		1993	=head1 MACRO MAGIC
		1994
		1995	Libev can be compiled with a variety of options, the most fundemantal is
		1996	C<EV_MULTIPLICITY>. This option determines whether (most) functions and
		1997	callbacks have an initial C<struct ev_loop *> argument.
		1998
		1999	To make it easier to write programs that cope with either variant, the
		2000	following macros are defined:
		2001
		2002	=over 4
		2003
		2004	=item C<EV_A>, C<EV_A_>
		2005
		2006	This provides the loop I<argument> for functions, if one is required ("ev
		2007	loop argument"). The C<EV_A> form is used when this is the sole argument,
		2008	C<EV_A_> is used when other arguments are following. Example:
		2009
		2010	ev_unref (EV_A);
		2011	ev_timer_add (EV_A_ watcher);
		2012	ev_loop (EV_A_ 0);
		2013
		2014	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		2015	which is often provided by the following macro.
		2016
		2017	=item C<EV_P>, C<EV_P_>
		2018
		2019	This provides the loop I<parameter> for functions, if one is required ("ev
		2020	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		2021	C<EV_P_> is used when other parameters are following. Example:
		2022
		2023	// this is how ev_unref is being declared
		2024	static void ev_unref (EV_P);
		2025
		2026	// this is how you can declare your typical callback
		2027	static void cb (EV_P_ ev_timer *w, int revents)
		2028
		2029	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		2030	suitable for use with C<EV_A>.
		2031
		2032	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		2033
		2034	Similar to the other two macros, this gives you the value of the default
		2035	loop, if multiple loops are supported ("ev loop default").
		2036
		2037	=back
		2038
		2039	Example: Declare and initialise a check watcher, utilising the above
		2040	macros so it will work regardless of whether multiple loops are supported
		2041	or not.
		2042
		2043	static void
		2044	check_cb (EV_P_ ev_timer *w, int revents)
		2045	{
		2046	ev_check_stop (EV_A_ w);
		2047	}
		2048
		2049	ev_check check;
		2050	ev_check_init (&check, check_cb);
		2051	ev_check_start (EV_DEFAULT_ &check);
		2052	ev_loop (EV_DEFAULT_ 0);
1664		2053
1665	=head1 EMBEDDING	2054	=head1 EMBEDDING
1666		2055
1667	Libev can (and often is) directly embedded into host	2056	Libev can (and often is) directly embedded into host
1668	applications. Examples of applications that embed it include the Deliantra	2057	applications. Examples of applications that embed it include the Deliantra
…		…
1708	ev_vars.h	2097	ev_vars.h
1709	ev_wrap.h	2098	ev_wrap.h
1710		2099
1711	ev_win32.c required on win32 platforms only	2100	ev_win32.c required on win32 platforms only
1712		2101
1713	ev_select.c only when select backend is enabled (which is by default)	2102	ev_select.c only when select backend is enabled (which is enabled by default)
1714	ev_poll.c only when poll backend is enabled (disabled by default)	2103	ev_poll.c only when poll backend is enabled (disabled by default)
1715	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2104	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1716	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2105	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1717	ev_port.c only when the solaris port backend is enabled (disabled by default)	2106	ev_port.c only when the solaris port backend is enabled (disabled by default)
1718		2107
…		…
1843		2232
1844	=item EV_USE_DEVPOLL	2233	=item EV_USE_DEVPOLL
1845		2234
1846	reserved for future expansion, works like the USE symbols above.	2235	reserved for future expansion, works like the USE symbols above.
1847		2236
		2237	=item EV_USE_INOTIFY
		2238
		2239	If defined to be C<1>, libev will compile in support for the Linux inotify
		2240	interface to speed up C<ev_stat> watchers. Its actual availability will
		2241	be detected at runtime.
		2242
1848	=item EV_H	2243	=item EV_H
1849		2244
1850	The name of the F<ev.h> header file used to include it. The default if	2245	The name of the F<ev.h> header file used to include it. The default if
1851	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2246	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
1852	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2247	can be used to virtually rename the F<ev.h> header file in case of conflicts.
…		…
1875	will have the C<struct ev_loop *> as first argument, and you can create	2270	will have the C<struct ev_loop *> as first argument, and you can create
1876	additional independent event loops. Otherwise there will be no support	2271	additional independent event loops. Otherwise there will be no support
1877	for multiple event loops and there is no first event loop pointer	2272	for multiple event loops and there is no first event loop pointer
1878	argument. Instead, all functions act on the single default loop.	2273	argument. Instead, all functions act on the single default loop.
1879		2274
		2275	=item EV_MINPRI
		2276
		2277	=item EV_MAXPRI
		2278
		2279	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2280	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2281	provide for more priorities by overriding those symbols (usually defined
		2282	to be C<-2> and C<2>, respectively).
		2283
		2284	When doing priority-based operations, libev usually has to linearly search
		2285	all the priorities, so having many of them (hundreds) uses a lot of space
		2286	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2287	fine.
		2288
		2289	If your embedding app does not need any priorities, defining these both to
		2290	C<0> will save some memory and cpu.
		2291
1880	=item EV_PERIODIC_ENABLE	2292	=item EV_PERIODIC_ENABLE
1881		2293
1882	If undefined or defined to be C<1>, then periodic timers are supported. If	2294	If undefined or defined to be C<1>, then periodic timers are supported. If
1883	defined to be C<0>, then they are not. Disabling them saves a few kB of	2295	defined to be C<0>, then they are not. Disabling them saves a few kB of
1884	code.	2296	code.
1885		2297
		2298	=item EV_IDLE_ENABLE
		2299
		2300	If undefined or defined to be C<1>, then idle watchers are supported. If
		2301	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2302	code.
		2303
1886	=item EV_EMBED_ENABLE	2304	=item EV_EMBED_ENABLE
1887		2305
1888	If undefined or defined to be C<1>, then embed watchers are supported. If	2306	If undefined or defined to be C<1>, then embed watchers are supported. If
1889	defined to be C<0>, then they are not.	2307	defined to be C<0>, then they are not.
1890		2308
1891	=item EV_STAT_ENABLE	2309	=item EV_STAT_ENABLE
1892		2310
1893	If undefined or defined to be C<1>, then stat watchers are supported. If	2311	If undefined or defined to be C<1>, then stat watchers are supported. If
		2312	defined to be C<0>, then they are not.
		2313
		2314	=item EV_FORK_ENABLE
		2315
		2316	If undefined or defined to be C<1>, then fork watchers are supported. If
1894	defined to be C<0>, then they are not.	2317	defined to be C<0>, then they are not.
1895		2318
1896	=item EV_MINIMAL	2319	=item EV_MINIMAL
1897		2320
1898	If you need to shave off some kilobytes of code at the expense of some	2321	If you need to shave off some kilobytes of code at the expense of some
1899	speed, define this symbol to C<1>. Currently only used for gcc to override	2322	speed, define this symbol to C<1>. Currently only used for gcc to override
1900	some inlining decisions, saves roughly 30% codesize of amd64.	2323	some inlining decisions, saves roughly 30% codesize of amd64.
		2324
		2325	=item EV_PID_HASHSIZE
		2326
		2327	C<ev_child> watchers use a small hash table to distribute workload by
		2328	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		2329	than enough. If you need to manage thousands of children you might want to
		2330	increase this value (I<must> be a power of two).
		2331
		2332	=item EV_INOTIFY_HASHSIZE
		2333
		2334	C<ev_staz> watchers use a small hash table to distribute workload by
		2335	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2336	usually more than enough. If you need to manage thousands of C<ev_stat>
		2337	watchers you might want to increase this value (I<must> be a power of
		2338	two).
1901		2339
1902	=item EV_COMMON	2340	=item EV_COMMON
1903		2341
1904	By default, all watchers have a C<void *data> member. By redefining	2342	By default, all watchers have a C<void *data> member. By redefining
1905	this macro to a something else you can include more and other types of	2343	this macro to a something else you can include more and other types of
…		…
1934	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2372	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
1935	will be compiled. It is pretty complex because it provides its own header	2373	will be compiled. It is pretty complex because it provides its own header
1936	file.	2374	file.
1937		2375
1938	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2376	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
1939	that everybody includes and which overrides some autoconf choices:	2377	that everybody includes and which overrides some configure choices:
1940		2378
		2379	#define EV_MINIMAL 1
1941	#define EV_USE_POLL 0	2380	#define EV_USE_POLL 0
1942	#define EV_MULTIPLICITY 0	2381	#define EV_MULTIPLICITY 0
1943	#define EV_PERIODICS 0	2382	#define EV_PERIODIC_ENABLE 0
		2383	#define EV_STAT_ENABLE 0
		2384	#define EV_FORK_ENABLE 0
1944	#define EV_CONFIG_H <config.h>	2385	#define EV_CONFIG_H <config.h>
		2386	#define EV_MINPRI 0
		2387	#define EV_MAXPRI 0
1945		2388
1946	#include "ev++.h"	2389	#include "ev++.h"
1947		2390
1948	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2391	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
1949		2392
…		…
1955		2398
1956	In this section the complexities of (many of) the algorithms used inside	2399	In this section the complexities of (many of) the algorithms used inside
1957	libev will be explained. For complexity discussions about backends see the	2400	libev will be explained. For complexity discussions about backends see the
1958	documentation for C<ev_default_init>.	2401	documentation for C<ev_default_init>.
1959		2402
		2403	All of the following are about amortised time: If an array needs to be
		2404	extended, libev needs to realloc and move the whole array, but this
		2405	happens asymptotically never with higher number of elements, so O(1) might
		2406	mean it might do a lengthy realloc operation in rare cases, but on average
		2407	it is much faster and asymptotically approaches constant time.
		2408
1960	=over 4	2409	=over 4
1961		2410
1962	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2411	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
1963		2412
		2413	This means that, when you have a watcher that triggers in one hour and
		2414	there are 100 watchers that would trigger before that then inserting will
		2415	have to skip those 100 watchers.
		2416
1964	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2417	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
1965		2418
		2419	That means that for changing a timer costs less than removing/adding them
		2420	as only the relative motion in the event queue has to be paid for.
		2421
1966	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2422	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
1967		2423
		2424	These just add the watcher into an array or at the head of a list.
1968	=item Stopping check/prepare/idle watchers: O(1)	2425	=item Stopping check/prepare/idle watchers: O(1)
1969		2426
1970	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	2427	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		2428
		2429	These watchers are stored in lists then need to be walked to find the
		2430	correct watcher to remove. The lists are usually short (you don't usually
		2431	have many watchers waiting for the same fd or signal).
1971		2432
1972	=item Finding the next timer per loop iteration: O(1)	2433	=item Finding the next timer per loop iteration: O(1)
1973		2434
1974	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2435	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
1975		2436
		2437	A change means an I/O watcher gets started or stopped, which requires
		2438	libev to recalculate its status (and possibly tell the kernel).
		2439
1976	=item Activating one watcher: O(1)	2440	=item Activating one watcher: O(1)
1977		2441
		2442	=item Priority handling: O(number_of_priorities)
		2443
		2444	Priorities are implemented by allocating some space for each
		2445	priority. When doing priority-based operations, libev usually has to
		2446	linearly search all the priorities.
		2447
1978	=back	2448	=back
1979		2449
1980		2450
1981	=head1 AUTHOR	2451	=head1 AUTHOR
1982		2452

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.48 by root, Tue Nov 27 08:11:52 2007 UTC vs. Revision 1.76 by root, Sat Dec 8 15:30:30 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.48 by root, Tue Nov 27 08:11:52 2007 UTC vs.
Revision 1.76 by root, Sat Dec 8 15:30:30 2007 UTC