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

Comparing libev/ev.pod (file contents):
Revision 1.49 by root, Tue Nov 27 08:20:42 2007 UTC vs.
Revision 1.77 by root, Sat Dec 8 22:11:14 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
…		…
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.
366		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.
		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.
371		453
…		…
404	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	486	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
405	usually a better approach for this kind of thing.	487	usually a better approach for this kind of thing.
406		488
407	Here are the gory details of what C<ev_loop> does:	489	Here are the gory details of what C<ev_loop> does:
408		490
		491	- Before the first iteration, call any pending watchers.
409	* If there are no active watchers (reference count is zero), return.	492	* If there are no active watchers (reference count is zero), return.
410	- Queue prepare watchers and then call all outstanding watchers.	493	- Queue all prepare watchers and then call all outstanding watchers.
411	- If we have been forked, recreate the kernel state.	494	- If we have been forked, recreate the kernel state.
412	- Update the kernel state with all outstanding changes.	495	- Update the kernel state with all outstanding changes.
413	- Update the "event loop time".	496	- Update the "event loop time".
414	- Calculate for how long to block.	497	- Calculate for how long to block.
415	- Block the process, waiting for any events.	498	- Block the process, waiting for any events.
…		…
423	Signals and child watchers are implemented as I/O watchers, and will	506	Signals and child watchers are implemented as I/O watchers, and will
424	be handled here by queueing them when their watcher gets executed.	507	be handled here by queueing them when their watcher gets executed.
425	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	508	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
426	were used, return, otherwise continue with step *.	509	were used, return, otherwise continue with step *.
427		510
428	Example: queue some jobs and then loop until no events are outsanding	511	Example: Queue some jobs and then loop until no events are outsanding
429	anymore.	512	anymore.
430		513
431	... queue jobs here, make sure they register event watchers as long	514	... 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..)	515	... as they still have work to do (even an idle watcher will do..)
433	ev_loop (my_loop, 0);	516	ev_loop (my_loop, 0);
…		…
453	visible to the libev user and should not keep C<ev_loop> from exiting if	536	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	537	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	538	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>.	539	libraries. Just remember to I<unref after start> and I<ref before stop>.
457		540
458	Example: create a signal watcher, but keep it from keeping C<ev_loop>	541	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
459	running when nothing else is active.	542	running when nothing else is active.
460		543
461	struct dv_signal exitsig;	544	struct ev_signal exitsig;
462	ev_signal_init (&exitsig, sig_cb, SIGINT);	545	ev_signal_init (&exitsig, sig_cb, SIGINT);
463	ev_signal_start (myloop, &exitsig);	546	ev_signal_start (loop, &exitsig);
464	evf_unref (myloop);	547	evf_unref (loop);
465		548
466	Example: for some weird reason, unregister the above signal handler again.	549	Example: For some weird reason, unregister the above signal handler again.
467		550
468	ev_ref (myloop);	551	ev_ref (loop);
469	ev_signal_stop (myloop, &exitsig);	552	ev_signal_stop (loop, &exitsig);
470		553
471	=back	554	=back
472		555
473		556
474	=head1 ANATOMY OF A WATCHER	557	=head1 ANATOMY OF A WATCHER
…		…
565	received events. Callbacks of both watcher types can start and stop as	648	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	649	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	650	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
568	C<ev_loop> from blocking).	651	C<ev_loop> from blocking).
569		652
		653	=item C<EV_EMBED>
		654
		655	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		656
		657	=item C<EV_FORK>
		658
		659	The event loop has been resumed in the child process after fork (see
		660	C<ev_fork>).
		661
570	=item C<EV_ERROR>	662	=item C<EV_ERROR>
571		663
572	An unspecified error has occured, the watcher has been stopped. This might	664	An unspecified error has occured, the watcher has been stopped. This might
573	happen because the watcher could not be properly started because libev	665	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	666	ran out of memory, a file descriptor was found to be closed or any other
…		…
645	=item bool ev_is_pending (ev_TYPE *watcher)	737	=item bool ev_is_pending (ev_TYPE *watcher)
646		738
647	Returns a true value iff the watcher is pending, (i.e. it has outstanding	739	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	740	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	741	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	742	C<ev_TYPE_set> is safe), you must not change its priority, and you must
651	libev (e.g. you cnanot C<free ()> it).	743	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		744	it).
652		745
653	=item callback = ev_cb (ev_TYPE *watcher)	746	=item callback ev_cb (ev_TYPE *watcher)
654		747
655	Returns the callback currently set on the watcher.	748	Returns the callback currently set on the watcher.
656		749
657	=item ev_cb_set (ev_TYPE *watcher, callback)	750	=item ev_cb_set (ev_TYPE *watcher, callback)
658		751
659	Change the callback. You can change the callback at virtually any time	752	Change the callback. You can change the callback at virtually any time
660	(modulo threads).	753	(modulo threads).
		754
		755	=item ev_set_priority (ev_TYPE *watcher, priority)
		756
		757	=item int ev_priority (ev_TYPE *watcher)
		758
		759	Set and query the priority of the watcher. The priority is a small
		760	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		761	(default: C<-2>). Pending watchers with higher priority will be invoked
		762	before watchers with lower priority, but priority will not keep watchers
		763	from being executed (except for C<ev_idle> watchers).
		764
		765	This means that priorities are I<only> used for ordering callback
		766	invocation after new events have been received. This is useful, for
		767	example, to reduce latency after idling, or more often, to bind two
		768	watchers on the same event and make sure one is called first.
		769
		770	If you need to suppress invocation when higher priority events are pending
		771	you need to look at C<ev_idle> watchers, which provide this functionality.
		772
		773	You I<must not> change the priority of a watcher as long as it is active or
		774	pending.
		775
		776	The default priority used by watchers when no priority has been set is
		777	always C<0>, which is supposed to not be too high and not be too low :).
		778
		779	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		780	fine, as long as you do not mind that the priority value you query might
		781	or might not have been adjusted to be within valid range.
		782
		783	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		784
		785	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		786	C<loop> nor C<revents> need to be valid as long as the watcher callback
		787	can deal with that fact.
		788
		789	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		790
		791	If the watcher is pending, this function returns clears its pending status
		792	and returns its C<revents> bitset (as if its callback was invoked). If the
		793	watcher isn't pending it does nothing and returns C<0>.
661		794
662	=back	795	=back
663		796
664		797
665	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	798	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
686	{	819	{
687	struct my_io w = (struct my_io )w_;	820	struct my_io w = (struct my_io )w_;
688	...	821	...
689	}	822	}
690		823
691	More interesting and less C-conformant ways of catsing your callback type	824	More interesting and less C-conformant ways of casting your callback type
692	have been omitted....	825	instead have been omitted.
		826
		827	Another common scenario is having some data structure with multiple
		828	watchers:
		829
		830	struct my_biggy
		831	{
		832	int some_data;
		833	ev_timer t1;
		834	ev_timer t2;
		835	}
		836
		837	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		838	you need to use C<offsetof>:
		839
		840	#include <stddef.h>
		841
		842	static void
		843	t1_cb (EV_P_ struct ev_timer *w, int revents)
		844	{
		845	struct my_biggy big = (struct my_biggy *
		846	(((char *)w) - offsetof (struct my_biggy, t1));
		847	}
		848
		849	static void
		850	t2_cb (EV_P_ struct ev_timer *w, int revents)
		851	{
		852	struct my_biggy big = (struct my_biggy *
		853	(((char *)w) - offsetof (struct my_biggy, t2));
		854	}
693		855
694		856
695	=head1 WATCHER TYPES	857	=head1 WATCHER TYPES
696		858
697	This section describes each watcher in detail, but will not repeat	859	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	904	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.	905	C<EAGAIN> is far preferable to a program hanging until some data arrives.
744		906
745	If you cannot run the fd in non-blocking mode (for example you should not	907	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	908	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	909	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	910	such as poll (fortunately in our Xlib example, Xlib already does this on
749	its own, so its quite safe to use).	911	its own, so its quite safe to use).
750		912
751	=over 4	913	=over 4
752		914
…		…
766		928
767	The events being watched.	929	The events being watched.
768		930
769	=back	931	=back
770		932
771	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	933	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	934	readable, but only once. Since it is likely line-buffered, you could
773	attempt to read a whole line in the callback:	935	attempt to read a whole line in the callback.
774		936
775	static void	937	static void
776	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)	938	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
777	{	939	{
778	ev_io_stop (loop, w);	940	ev_io_stop (loop, w);
…		…
830	=item ev_timer_again (loop)	992	=item ev_timer_again (loop)
831		993
832	This will act as if the timer timed out and restart it again if it is	994	This will act as if the timer timed out and restart it again if it is
833	repeating. The exact semantics are:	995	repeating. The exact semantics are:
834		996
		997	If the timer is pending, its pending status is cleared.
		998
835	If the timer is started but nonrepeating, stop it.	999	If the timer is started but nonrepeating, stop it (as if it timed out).
836		1000
837	If the timer is repeating, either start it if necessary (with the repeat	1001	If the timer is repeating, either start it if necessary (with the
838	value), or reset the running timer to the repeat value.	1002	C<repeat> value), or reset the running timer to the C<repeat> value.
839		1003
840	This sounds a bit complicated, but here is a useful and typical	1004	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	1005	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,	1006	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	1007	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	1008	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	1009	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	1010	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	1011	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
848	need be.	1012	automatically restart it if need be.
849		1013
850	You can also ignore the C<after> value and C<ev_timer_start> altogether	1014	That means you can ignore the C<after> value and C<ev_timer_start>
851	and only ever use the C<repeat> value:	1015	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
852		1016
853	ev_timer_init (timer, callback, 0., 5.);	1017	ev_timer_init (timer, callback, 0., 5.);
854	ev_timer_again (loop, timer);	1018	ev_timer_again (loop, timer);
855	...	1019	...
856	timer->again = 17.;	1020	timer->again = 17.;
857	ev_timer_again (loop, timer);	1021	ev_timer_again (loop, timer);
858	...	1022	...
859	timer->again = 10.;	1023	timer->again = 10.;
860	ev_timer_again (loop, timer);	1024	ev_timer_again (loop, timer);
861		1025
862	This is more efficient then stopping/starting the timer eahc time you want	1026	This is more slightly efficient then stopping/starting the timer each time
863	to modify its timeout value.	1027	you want to modify its timeout value.
864		1028
865	=item ev_tstamp repeat [read-write]	1029	=item ev_tstamp repeat [read-write]
866		1030
867	The current C<repeat> value. Will be used each time the watcher times out	1031	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),	1032	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.	1033	which is also when any modifications are taken into account.
870		1034
871	=back	1035	=back
872		1036
873	Example: create a timer that fires after 60 seconds.	1037	Example: Create a timer that fires after 60 seconds.
874		1038
875	static void	1039	static void
876	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)	1040	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
877	{	1041	{
878	.. one minute over, w is actually stopped right here	1042	.. one minute over, w is actually stopped right here
…		…
880		1044
881	struct ev_timer mytimer;	1045	struct ev_timer mytimer;
882	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1046	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
883	ev_timer_start (loop, &mytimer);	1047	ev_timer_start (loop, &mytimer);
884		1048
885	Example: create a timeout timer that times out after 10 seconds of	1049	Example: Create a timeout timer that times out after 10 seconds of
886	inactivity.	1050	inactivity.
887		1051
888	static void	1052	static void
889	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)	1053	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
890	{	1054	{
…		…
1015	switched off. Can be changed any time, but changes only take effect when	1179	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.	1180	the periodic timer fires or C<ev_periodic_again> is being called.
1017		1181
1018	=back	1182	=back
1019		1183
1020	Example: call a callback every hour, or, more precisely, whenever the	1184	Example: Call a callback every hour, or, more precisely, whenever the
1021	system clock is divisible by 3600. The callback invocation times have	1185	system clock is divisible by 3600. The callback invocation times have
1022	potentially a lot of jittering, but good long-term stability.	1186	potentially a lot of jittering, but good long-term stability.
1023		1187
1024	static void	1188	static void
1025	clock_cb (struct ev_loop loop, struct ev_io w, int revents)	1189	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
…		…
1029		1193
1030	struct ev_periodic hourly_tick;	1194	struct ev_periodic hourly_tick;
1031	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1195	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1032	ev_periodic_start (loop, &hourly_tick);	1196	ev_periodic_start (loop, &hourly_tick);
1033		1197
1034	Example: the same as above, but use a reschedule callback to do it:	1198	Example: The same as above, but use a reschedule callback to do it:
1035		1199
1036	#include <math.h>	1200	#include <math.h>
1037		1201
1038	static ev_tstamp	1202	static ev_tstamp
1039	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1203	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
1041	return fmod (now, 3600.) + 3600.;	1205	return fmod (now, 3600.) + 3600.;
1042	}	1206	}
1043		1207
1044	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1208	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1045		1209
1046	Example: call a callback every hour, starting now:	1210	Example: Call a callback every hour, starting now:
1047		1211
1048	struct ev_periodic hourly_tick;	1212	struct ev_periodic hourly_tick;
1049	ev_periodic_init (&hourly_tick, clock_cb,	1213	ev_periodic_init (&hourly_tick, clock_cb,
1050	fmod (ev_now (loop), 3600.), 3600., 0);	1214	fmod (ev_now (loop), 3600.), 3600., 0);
1051	ev_periodic_start (loop, &hourly_tick);	1215	ev_periodic_start (loop, &hourly_tick);
…		…
1112	The process exit/trace status caused by C<rpid> (see your systems	1276	The process exit/trace status caused by C<rpid> (see your systems
1113	C<waitpid> and C<sys/wait.h> documentation for details).	1277	C<waitpid> and C<sys/wait.h> documentation for details).
1114		1278
1115	=back	1279	=back
1116		1280
1117	Example: try to exit cleanly on SIGINT and SIGTERM.	1281	Example: Try to exit cleanly on SIGINT and SIGTERM.
1118		1282
1119	static void	1283	static void
1120	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1284	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
1121	{	1285	{
1122	ev_unloop (loop, EVUNLOOP_ALL);	1286	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1137	not exist" is a status change like any other. The condition "path does	1301	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	1302	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	1303	otherwise always forced to be at least one) and all the other fields of
1140	the stat buffer having unspecified contents.	1304	the stat buffer having unspecified contents.
1141		1305
		1306	The path I<should> be absolute and I<must not> end in a slash. If it is
		1307	relative and your working directory changes, the behaviour is undefined.
		1308
1142	Since there is no standard to do this, the portable implementation simply	1309	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	1310	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	1311	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,	1312	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	1313	unspecified default> value will be used (which you can expect to be around
1147	five seconds, although this might change dynamically). Libev will also	1314	five seconds, although this might change dynamically). Libev will also
1148	impose a minimum interval which is currently around C<0.1>, but thats	1315	impose a minimum interval which is currently around C<0.1>, but thats
…		…
1150		1317
1151	This watcher type is not meant for massive numbers of stat watchers,	1318	This watcher type is not meant for massive numbers of stat watchers,
1152	as even with OS-supported change notifications, this can be	1319	as even with OS-supported change notifications, this can be
1153	resource-intensive.	1320	resource-intensive.
1154		1321
1155	At the time of this writing, no specific OS backends are implemented, but	1322	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.	1323	implemented (implementing kqueue support is left as an exercise for the
		1324	reader). Inotify will be used to give hints only and should not change the
		1325	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1326	to fall back to regular polling again even with inotify, but changes are
		1327	usually detected immediately, and if the file exists there will be no
		1328	polling.
1157		1329
1158	=over 4	1330	=over 4
1159		1331
1160	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)	1332	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)
1161		1333
…		…
1225	ev_stat_start (loop, &passwd);	1397	ev_stat_start (loop, &passwd);
1226		1398
1227		1399
1228	=head2 C<ev_idle> - when you've got nothing better to do...	1400	=head2 C<ev_idle> - when you've got nothing better to do...
1229		1401
1230	Idle watchers trigger events when there are no other events are pending	1402	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	1403	priority are pending (prepare, check and other idle watchers do not
1232	as your process is busy handling sockets or timeouts (or even signals,	1404	count).
1233	imagine) it will not be triggered. But when your process is idle all idle	1405
1234	watchers are being called again and again, once per event loop iteration -	1406	That is, as long as your process is busy handling sockets or timeouts
		1407	(or even signals, imagine) of the same or higher priority it will not be
		1408	triggered. But when your process is idle (or only lower-priority watchers
		1409	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	1410	iteration - until stopped, that is, or your process receives more events
1236	busy.	1411	and becomes busy again with higher priority stuff.
1237		1412
1238	The most noteworthy effect is that as long as any idle watchers are	1413	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.	1414	active, the process will not block when waiting for new events.
1240		1415
1241	Apart from keeping your process non-blocking (which is a useful	1416	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,	1426	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1252	believe me.	1427	believe me.
1253		1428
1254	=back	1429	=back
1255		1430
1256	Example: dynamically allocate an C<ev_idle>, start it, and in the	1431	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1257	callback, free it. Alos, use no error checking, as usual.	1432	callback, free it. Also, use no error checking, as usual.
1258		1433
1259	static void	1434	static void
1260	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)	1435	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
1261	{	1436	{
1262	free (w);	1437	free (w);
…		…
1307	with priority higher than or equal to the event loop and one coroutine	1482	with priority higher than or equal to the event loop and one coroutine
1308	of lower priority, but only once, using idle watchers to keep the event	1483	of lower priority, but only once, using idle watchers to keep the event
1309	loop from blocking if lower-priority coroutines are active, thus mapping	1484	loop from blocking if lower-priority coroutines are active, thus mapping
1310	low-priority coroutines to idle/background tasks).	1485	low-priority coroutines to idle/background tasks).
1311		1486
		1487	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1488	priority, to ensure that they are being run before any other watchers
		1489	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1490	too) should not activate ("feed") events into libev. While libev fully
		1491	supports this, they will be called before other C<ev_check> watchers did
		1492	their job. As C<ev_check> watchers are often used to embed other event
		1493	loops those other event loops might be in an unusable state until their
		1494	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
		1495	others).
		1496
1312	=over 4	1497	=over 4
1313		1498
1314	=item ev_prepare_init (ev_prepare *, callback)	1499	=item ev_prepare_init (ev_prepare *, callback)
1315		1500
1316	=item ev_check_init (ev_check *, callback)	1501	=item ev_check_init (ev_check *, callback)
…		…
1319	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1504	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.	1505	macros, but using them is utterly, utterly and completely pointless.
1321		1506
1322	=back	1507	=back
1323		1508
1324	Example: To include a library such as adns, you would add IO watchers	1509	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	1510	into libev. Here are some ideas on how to include libadns into libev
		1511	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1512	use for an actually working example. Another Perl module named C<EV::Glib>
		1513	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1514	into the Glib event loop).
		1515
		1516	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	1517	and in a check watcher, destroy them and call into libadns. What follows
1327	pseudo-code only of course:	1518	is pseudo-code only of course. This requires you to either use a low
		1519	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1520	the callbacks for the IO/timeout watchers might not have been called yet.
1328		1521
1329	static ev_io iow [nfd];	1522	static ev_io iow [nfd];
1330	static ev_timer tw;	1523	static ev_timer tw;
1331		1524
1332	static void	1525	static void
1333	io_cb (ev_loop loop, ev_io w, int revents)	1526	io_cb (ev_loop loop, ev_io w, int revents)
1334	{	1527	{
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	}	1528	}
1341		1529
1342	// create io watchers for each fd and a timer before blocking	1530	// create io watchers for each fd and a timer before blocking
1343	static void	1531	static void
1344	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)	1532	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
1345	{	1533	{
1346	int timeout = 3600000;truct pollfd fds [nfd];	1534	int timeout = 3600000;
		1535	struct pollfd fds [nfd];
1347	// actual code will need to loop here and realloc etc.	1536	// actual code will need to loop here and realloc etc.
1348	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1537	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1349		1538
1350	/* the callback is illegal, but won't be called as we stop during check */	1539	/* the callback is illegal, but won't be called as we stop during check */
1351	ev_timer_init (&tw, 0, timeout * 1e-3);	1540	ev_timer_init (&tw, 0, timeout * 1e-3);
1352	ev_timer_start (loop, &tw);	1541	ev_timer_start (loop, &tw);
1353		1542
1354	// create on ev_io per pollfd	1543	// create one ev_io per pollfd
1355	for (int i = 0; i < nfd; ++i)	1544	for (int i = 0; i < nfd; ++i)
1356	{	1545	{
1357	ev_io_init (iow + i, io_cb, fds [i].fd,	1546	ev_io_init (iow + i, io_cb, fds [i].fd,
1358	((fds [i].events & POLLIN ? EV_READ : 0)	1547	((fds [i].events & POLLIN ? EV_READ : 0)
1359	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1548	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1360		1549
1361	fds [i].revents = 0;	1550	fds [i].revents = 0;
1362	iow [i].data = fds + i;
1363	ev_io_start (loop, iow + i);	1551	ev_io_start (loop, iow + i);
1364	}	1552	}
1365	}	1553	}
1366		1554
1367	// stop all watchers after blocking	1555	// stop all watchers after blocking
…		…
1369	adns_check_cb (ev_loop loop, ev_check w, int revents)	1557	adns_check_cb (ev_loop loop, ev_check w, int revents)
1370	{	1558	{
1371	ev_timer_stop (loop, &tw);	1559	ev_timer_stop (loop, &tw);
1372		1560
1373	for (int i = 0; i < nfd; ++i)	1561	for (int i = 0; i < nfd; ++i)
		1562	{
		1563	// set the relevant poll flags
		1564	// could also call adns_processreadable etc. here
		1565	struct pollfd *fd = fds + i;
		1566	int revents = ev_clear_pending (iow + i);
		1567	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1568	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1569
		1570	// now stop the watcher
1374	ev_io_stop (loop, iow + i);	1571	ev_io_stop (loop, iow + i);
		1572	}
1375		1573
1376	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1574	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1575	}
		1576
		1577	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1578	in the prepare watcher and would dispose of the check watcher.
		1579
		1580	Method 3: If the module to be embedded supports explicit event
		1581	notification (adns does), you can also make use of the actual watcher
		1582	callbacks, and only destroy/create the watchers in the prepare watcher.
		1583
		1584	static void
		1585	timer_cb (EV_P_ ev_timer *w, int revents)
		1586	{
		1587	adns_state ads = (adns_state)w->data;
		1588	update_now (EV_A);
		1589
		1590	adns_processtimeouts (ads, &tv_now);
		1591	}
		1592
		1593	static void
		1594	io_cb (EV_P_ ev_io *w, int revents)
		1595	{
		1596	adns_state ads = (adns_state)w->data;
		1597	update_now (EV_A);
		1598
		1599	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1600	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1601	}
		1602
		1603	// do not ever call adns_afterpoll
		1604
		1605	Method 4: Do not use a prepare or check watcher because the module you
		1606	want to embed is too inflexible to support it. Instead, youc na override
		1607	their poll function. The drawback with this solution is that the main
		1608	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1609	this.
		1610
		1611	static gint
		1612	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1613	{
		1614	int got_events = 0;
		1615
		1616	for (n = 0; n < nfds; ++n)
		1617	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1618
		1619	if (timeout >= 0)
		1620	// create/start timer
		1621
		1622	// poll
		1623	ev_loop (EV_A_ 0);
		1624
		1625	// stop timer again
		1626	if (timeout >= 0)
		1627	ev_timer_stop (EV_A_ &to);
		1628
		1629	// stop io watchers again - their callbacks should have set
		1630	for (n = 0; n < nfds; ++n)
		1631	ev_io_stop (EV_A_ iow [n]);
		1632
		1633	return got_events;
1377	}	1634	}
1378		1635
1379		1636
1380	=head2 C<ev_embed> - when one backend isn't enough...	1637	=head2 C<ev_embed> - when one backend isn't enough...
1381		1638
…		…
1470	The embedded event loop.	1727	The embedded event loop.
1471		1728
1472	=back	1729	=back
1473		1730
1474		1731
		1732	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		1733
		1734	Fork watchers are called when a C<fork ()> was detected (usually because
		1735	whoever is a good citizen cared to tell libev about it by calling
		1736	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		1737	event loop blocks next and before C<ev_check> watchers are being called,
		1738	and only in the child after the fork. If whoever good citizen calling
		1739	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		1740	handlers will be invoked, too, of course.
		1741
		1742	=over 4
		1743
		1744	=item ev_fork_init (ev_signal *, callback)
		1745
		1746	Initialises and configures the fork watcher - it has no parameters of any
		1747	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
		1748	believe me.
		1749
		1750	=back
		1751
		1752
1475	=head1 OTHER FUNCTIONS	1753	=head1 OTHER FUNCTIONS
1476		1754
1477	There are some other functions of possible interest. Described. Here. Now.	1755	There are some other functions of possible interest. Described. Here. Now.
1478		1756
1479	=over 4	1757	=over 4
…		…
1564		1842
1565	To use it,	1843	To use it,
1566		1844
1567	#include <ev++.h>	1845	#include <ev++.h>
1568		1846
1569	(it is not installed by default). This automatically includes F<ev.h>	1847	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	1848	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.	1849	put into the C<ev> namespace. It should support all the same embedding
		1850	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1572		1851
1573	It should support all the same embedding options as F<ev.h>, most notably	1852	Care has been taken to keep the overhead low. The only data member the C++
1574	C<EV_MULTIPLICITY>.	1853	classes add (compared to plain C-style watchers) is the event loop pointer
		1854	that the watcher is associated with (or no additional members at all if
		1855	you disable C<EV_MULTIPLICITY> when embedding libev).
		1856
		1857	Currently, functions, and static and non-static member functions can be
		1858	used as callbacks. Other types should be easy to add as long as they only
		1859	need one additional pointer for context. If you need support for other
		1860	types of functors please contact the author (preferably after implementing
		1861	it).
1575		1862
1576	Here is a list of things available in the C<ev> namespace:	1863	Here is a list of things available in the C<ev> namespace:
1577		1864
1578	=over 4	1865	=over 4
1579		1866
…		…
1595		1882
1596	All of those classes have these methods:	1883	All of those classes have these methods:
1597		1884
1598	=over 4	1885	=over 4
1599		1886
1600	=item ev::TYPE::TYPE (object , object::method )	1887	=item ev::TYPE::TYPE ()
1601		1888
1602	=item ev::TYPE::TYPE (object , object::method , struct ev_loop *)	1889	=item ev::TYPE::TYPE (struct ev_loop *)
1603		1890
1604	=item ev::TYPE::~TYPE	1891	=item ev::TYPE::~TYPE
1605		1892
1606	The constructor takes a pointer to an object and a method pointer to	1893	The constructor (optionally) takes an event loop to associate the watcher
1607	the event handler callback to call in this class. The constructor calls	1894	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	1895
1609	before starting it. If you do not specify a loop then the constructor	1896	The constructor calls C<ev_init> for you, which means you have to call the
1610	automatically associates the default loop with this watcher.	1897	C<set> method before starting it.
		1898
		1899	It will not set a callback, however: You have to call the templated C<set>
		1900	method to set a callback before you can start the watcher.
		1901
		1902	(The reason why you have to use a method is a limitation in C++ which does
		1903	not allow explicit template arguments for constructors).
1611		1904
1612	The destructor automatically stops the watcher if it is active.	1905	The destructor automatically stops the watcher if it is active.
		1906
		1907	=item w->set<class, &class::method> (object *)
		1908
		1909	This method sets the callback method to call. The method has to have a
		1910	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		1911	first argument and the C<revents> as second. The object must be given as
		1912	parameter and is stored in the C<data> member of the watcher.
		1913
		1914	This method synthesizes efficient thunking code to call your method from
		1915	the C callback that libev requires. If your compiler can inline your
		1916	callback (i.e. it is visible to it at the place of the C<set> call and
		1917	your compiler is good :), then the method will be fully inlined into the
		1918	thunking function, making it as fast as a direct C callback.
		1919
		1920	Example: simple class declaration and watcher initialisation
		1921
		1922	struct myclass
		1923	{
		1924	void io_cb (ev::io &w, int revents) { }
		1925	}
		1926
		1927	myclass obj;
		1928	ev::io iow;
		1929	iow.set <myclass, &myclass::io_cb> (&obj);
		1930
		1931	=item w->set<function> (void *data = 0)
		1932
		1933	Also sets a callback, but uses a static method or plain function as
		1934	callback. The optional C<data> argument will be stored in the watcher's
		1935	C<data> member and is free for you to use.
		1936
		1937	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		1938
		1939	See the method-C<set> above for more details.
		1940
		1941	Example:
		1942
		1943	static void io_cb (ev::io &w, int revents) { }
		1944	iow.set <io_cb> ();
1613		1945
1614	=item w->set (struct ev_loop *)	1946	=item w->set (struct ev_loop *)
1615		1947
1616	Associates a different C<struct ev_loop> with this watcher. You can only	1948	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).	1949	do this when the watcher is inactive (and not pending either).
1618		1950
1619	=item w->set ([args])	1951	=item w->set ([args])
1620		1952
1621	Basically the same as C<ev_TYPE_set>, with the same args. Must be	1953	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	1954	called at least once. Unlike the C counterpart, an active watcher gets
1623	automatically stopped and restarted.	1955	automatically stopped and restarted when reconfiguring it with this
		1956	method.
1624		1957
1625	=item w->start ()	1958	=item w->start ()
1626		1959
1627	Starts the watcher. Note that there is no C<loop> argument as the	1960	Starts the watcher. Note that there is no C<loop> argument, as the
1628	constructor already takes the loop.	1961	constructor already stores the event loop.
1629		1962
1630	=item w->stop ()	1963	=item w->stop ()
1631		1964
1632	Stops the watcher if it is active. Again, no C<loop> argument.	1965	Stops the watcher if it is active. Again, no C<loop> argument.
1633		1966
…		…
1658		1991
1659	myclass ();	1992	myclass ();
1660	}	1993	}
1661		1994
1662	myclass::myclass (int fd)	1995	myclass::myclass (int fd)
1663	: io (this, &myclass::io_cb),
1664	idle (this, &myclass::idle_cb)
1665	{	1996	{
		1997	io .set <myclass, &myclass::io_cb > (this);
		1998	idle.set <myclass, &myclass::idle_cb> (this);
		1999
1666	io.start (fd, ev::READ);	2000	io.start (fd, ev::READ);
1667	}	2001	}
		2002
		2003
		2004	=head1 MACRO MAGIC
		2005
		2006	Libev can be compiled with a variety of options, the most fundemantal is
		2007	C<EV_MULTIPLICITY>. This option determines whether (most) functions and
		2008	callbacks have an initial C<struct ev_loop *> argument.
		2009
		2010	To make it easier to write programs that cope with either variant, the
		2011	following macros are defined:
		2012
		2013	=over 4
		2014
		2015	=item C<EV_A>, C<EV_A_>
		2016
		2017	This provides the loop I<argument> for functions, if one is required ("ev
		2018	loop argument"). The C<EV_A> form is used when this is the sole argument,
		2019	C<EV_A_> is used when other arguments are following. Example:
		2020
		2021	ev_unref (EV_A);
		2022	ev_timer_add (EV_A_ watcher);
		2023	ev_loop (EV_A_ 0);
		2024
		2025	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		2026	which is often provided by the following macro.
		2027
		2028	=item C<EV_P>, C<EV_P_>
		2029
		2030	This provides the loop I<parameter> for functions, if one is required ("ev
		2031	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		2032	C<EV_P_> is used when other parameters are following. Example:
		2033
		2034	// this is how ev_unref is being declared
		2035	static void ev_unref (EV_P);
		2036
		2037	// this is how you can declare your typical callback
		2038	static void cb (EV_P_ ev_timer *w, int revents)
		2039
		2040	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		2041	suitable for use with C<EV_A>.
		2042
		2043	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		2044
		2045	Similar to the other two macros, this gives you the value of the default
		2046	loop, if multiple loops are supported ("ev loop default").
		2047
		2048	=back
		2049
		2050	Example: Declare and initialise a check watcher, utilising the above
		2051	macros so it will work regardless of whether multiple loops are supported
		2052	or not.
		2053
		2054	static void
		2055	check_cb (EV_P_ ev_timer *w, int revents)
		2056	{
		2057	ev_check_stop (EV_A_ w);
		2058	}
		2059
		2060	ev_check check;
		2061	ev_check_init (&check, check_cb);
		2062	ev_check_start (EV_DEFAULT_ &check);
		2063	ev_loop (EV_DEFAULT_ 0);
1668		2064
1669	=head1 EMBEDDING	2065	=head1 EMBEDDING
1670		2066
1671	Libev can (and often is) directly embedded into host	2067	Libev can (and often is) directly embedded into host
1672	applications. Examples of applications that embed it include the Deliantra	2068	applications. Examples of applications that embed it include the Deliantra
…		…
1712	ev_vars.h	2108	ev_vars.h
1713	ev_wrap.h	2109	ev_wrap.h
1714		2110
1715	ev_win32.c required on win32 platforms only	2111	ev_win32.c required on win32 platforms only
1716		2112
1717	ev_select.c only when select backend is enabled (which is by default)	2113	ev_select.c only when select backend is enabled (which is enabled by default)
1718	ev_poll.c only when poll backend is enabled (disabled by default)	2114	ev_poll.c only when poll backend is enabled (disabled by default)
1719	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2115	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1720	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2116	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1721	ev_port.c only when the solaris port backend is enabled (disabled by default)	2117	ev_port.c only when the solaris port backend is enabled (disabled by default)
1722		2118
…		…
1847		2243
1848	=item EV_USE_DEVPOLL	2244	=item EV_USE_DEVPOLL
1849		2245
1850	reserved for future expansion, works like the USE symbols above.	2246	reserved for future expansion, works like the USE symbols above.
1851		2247
		2248	=item EV_USE_INOTIFY
		2249
		2250	If defined to be C<1>, libev will compile in support for the Linux inotify
		2251	interface to speed up C<ev_stat> watchers. Its actual availability will
		2252	be detected at runtime.
		2253
1852	=item EV_H	2254	=item EV_H
1853		2255
1854	The name of the F<ev.h> header file used to include it. The default if	2256	The name of the F<ev.h> header file used to include it. The default if
1855	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2257	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
1856	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2258	can be used to virtually rename the F<ev.h> header file in case of conflicts.
…		…
1879	will have the C<struct ev_loop *> as first argument, and you can create	2281	will have the C<struct ev_loop *> as first argument, and you can create
1880	additional independent event loops. Otherwise there will be no support	2282	additional independent event loops. Otherwise there will be no support
1881	for multiple event loops and there is no first event loop pointer	2283	for multiple event loops and there is no first event loop pointer
1882	argument. Instead, all functions act on the single default loop.	2284	argument. Instead, all functions act on the single default loop.
1883		2285
		2286	=item EV_MINPRI
		2287
		2288	=item EV_MAXPRI
		2289
		2290	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2291	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2292	provide for more priorities by overriding those symbols (usually defined
		2293	to be C<-2> and C<2>, respectively).
		2294
		2295	When doing priority-based operations, libev usually has to linearly search
		2296	all the priorities, so having many of them (hundreds) uses a lot of space
		2297	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2298	fine.
		2299
		2300	If your embedding app does not need any priorities, defining these both to
		2301	C<0> will save some memory and cpu.
		2302
1884	=item EV_PERIODIC_ENABLE	2303	=item EV_PERIODIC_ENABLE
1885		2304
1886	If undefined or defined to be C<1>, then periodic timers are supported. If	2305	If undefined or defined to be C<1>, then periodic timers are supported. If
1887	defined to be C<0>, then they are not. Disabling them saves a few kB of	2306	defined to be C<0>, then they are not. Disabling them saves a few kB of
1888	code.	2307	code.
1889		2308
		2309	=item EV_IDLE_ENABLE
		2310
		2311	If undefined or defined to be C<1>, then idle watchers are supported. If
		2312	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2313	code.
		2314
1890	=item EV_EMBED_ENABLE	2315	=item EV_EMBED_ENABLE
1891		2316
1892	If undefined or defined to be C<1>, then embed watchers are supported. If	2317	If undefined or defined to be C<1>, then embed watchers are supported. If
1893	defined to be C<0>, then they are not.	2318	defined to be C<0>, then they are not.
1894		2319
1895	=item EV_STAT_ENABLE	2320	=item EV_STAT_ENABLE
1896		2321
1897	If undefined or defined to be C<1>, then stat watchers are supported. If	2322	If undefined or defined to be C<1>, then stat watchers are supported. If
		2323	defined to be C<0>, then they are not.
		2324
		2325	=item EV_FORK_ENABLE
		2326
		2327	If undefined or defined to be C<1>, then fork watchers are supported. If
1898	defined to be C<0>, then they are not.	2328	defined to be C<0>, then they are not.
1899		2329
1900	=item EV_MINIMAL	2330	=item EV_MINIMAL
1901		2331
1902	If you need to shave off some kilobytes of code at the expense of some	2332	If you need to shave off some kilobytes of code at the expense of some
1903	speed, define this symbol to C<1>. Currently only used for gcc to override	2333	speed, define this symbol to C<1>. Currently only used for gcc to override
1904	some inlining decisions, saves roughly 30% codesize of amd64.	2334	some inlining decisions, saves roughly 30% codesize of amd64.
		2335
		2336	=item EV_PID_HASHSIZE
		2337
		2338	C<ev_child> watchers use a small hash table to distribute workload by
		2339	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		2340	than enough. If you need to manage thousands of children you might want to
		2341	increase this value (I<must> be a power of two).
		2342
		2343	=item EV_INOTIFY_HASHSIZE
		2344
		2345	C<ev_staz> watchers use a small hash table to distribute workload by
		2346	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2347	usually more than enough. If you need to manage thousands of C<ev_stat>
		2348	watchers you might want to increase this value (I<must> be a power of
		2349	two).
1905		2350
1906	=item EV_COMMON	2351	=item EV_COMMON
1907		2352
1908	By default, all watchers have a C<void *data> member. By redefining	2353	By default, all watchers have a C<void *data> member. By redefining
1909	this macro to a something else you can include more and other types of	2354	this macro to a something else you can include more and other types of
…		…
1938	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2383	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
1939	will be compiled. It is pretty complex because it provides its own header	2384	will be compiled. It is pretty complex because it provides its own header
1940	file.	2385	file.
1941		2386
1942	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2387	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
1943	that everybody includes and which overrides some autoconf choices:	2388	that everybody includes and which overrides some configure choices:
1944		2389
		2390	#define EV_MINIMAL 1
1945	#define EV_USE_POLL 0	2391	#define EV_USE_POLL 0
1946	#define EV_MULTIPLICITY 0	2392	#define EV_MULTIPLICITY 0
1947	#define EV_PERIODICS 0	2393	#define EV_PERIODIC_ENABLE 0
		2394	#define EV_STAT_ENABLE 0
		2395	#define EV_FORK_ENABLE 0
1948	#define EV_CONFIG_H <config.h>	2396	#define EV_CONFIG_H <config.h>
		2397	#define EV_MINPRI 0
		2398	#define EV_MAXPRI 0
1949		2399
1950	#include "ev++.h"	2400	#include "ev++.h"
1951		2401
1952	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2402	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
1953		2403
…		…
1959		2409
1960	In this section the complexities of (many of) the algorithms used inside	2410	In this section the complexities of (many of) the algorithms used inside
1961	libev will be explained. For complexity discussions about backends see the	2411	libev will be explained. For complexity discussions about backends see the
1962	documentation for C<ev_default_init>.	2412	documentation for C<ev_default_init>.
1963		2413
		2414	All of the following are about amortised time: If an array needs to be
		2415	extended, libev needs to realloc and move the whole array, but this
		2416	happens asymptotically never with higher number of elements, so O(1) might
		2417	mean it might do a lengthy realloc operation in rare cases, but on average
		2418	it is much faster and asymptotically approaches constant time.
		2419
1964	=over 4	2420	=over 4
1965		2421
1966	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2422	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
1967		2423
		2424	This means that, when you have a watcher that triggers in one hour and
		2425	there are 100 watchers that would trigger before that then inserting will
		2426	have to skip those 100 watchers.
		2427
1968	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2428	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
1969		2429
		2430	That means that for changing a timer costs less than removing/adding them
		2431	as only the relative motion in the event queue has to be paid for.
		2432
1970	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2433	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
1971		2434
		2435	These just add the watcher into an array or at the head of a list.
1972	=item Stopping check/prepare/idle watchers: O(1)	2436	=item Stopping check/prepare/idle watchers: O(1)
1973		2437
1974	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	2438	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
		2439
		2440	These watchers are stored in lists then need to be walked to find the
		2441	correct watcher to remove. The lists are usually short (you don't usually
		2442	have many watchers waiting for the same fd or signal).
1975		2443
1976	=item Finding the next timer per loop iteration: O(1)	2444	=item Finding the next timer per loop iteration: O(1)
1977		2445
1978	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2446	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
1979		2447
		2448	A change means an I/O watcher gets started or stopped, which requires
		2449	libev to recalculate its status (and possibly tell the kernel).
		2450
1980	=item Activating one watcher: O(1)	2451	=item Activating one watcher: O(1)
1981		2452
		2453	=item Priority handling: O(number_of_priorities)
		2454
		2455	Priorities are implemented by allocating some space for each
		2456	priority. When doing priority-based operations, libev usually has to
		2457	linearly search all the priorities.
		2458
1982	=back	2459	=back
1983		2460
1984		2461
1985	=head1 AUTHOR	2462	=head1 AUTHOR
1986		2463

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.49 by root, Tue Nov 27 08:20:42 2007 UTC vs. Revision 1.77 by root, Sat Dec 8 22:11:14 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.49 by root, Tue Nov 27 08:20:42 2007 UTC vs.
Revision 1.77 by root, Sat Dec 8 22:11:14 2007 UTC