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

Comparing libev/ev.pod (file contents):
Revision 1.36 by root, Sat Nov 24 07:14:26 2007 UTC vs.
Revision 1.54 by root, Tue Nov 27 20:26:51 2007 UTC

…		…
3	libev - a high performance full-featured event loop written in C	3	libev - a high performance full-featured event loop written in C
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	#include <ev.h>	7	#include <ev.h>
		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	}
8		50
9	=head1 DESCRIPTION	51	=head1 DESCRIPTION
10		52
11	Libev is an event loop: you register interest in certain events (such as a	53	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	54	file descriptor being readable or a timeout occuring), and it will manage
…		…
21	details of the event, and then hand it over to libev by I<starting> the	63	details of the event, and then hand it over to libev by I<starting> the
22	watcher.	64	watcher.
23		65
24	=head1 FEATURES	66	=head1 FEATURES
25		67
26	Libev supports select, poll, the linux-specific epoll and the bsd-specific	68	Libev supports C<select>, C<poll>, the linux-specific C<epoll>, the
27	kqueue mechanisms for file descriptor events, relative timers, absolute	69	bsd-specific C<kqueue> and the solaris-specific event port mechanisms
28	timers with customised rescheduling, signal events, process status change	70	for file descriptor events (C<ev_io>), relative timers (C<ev_timer>),
29	events (related to SIGCHLD), and event watchers dealing with the event	71	absolute timers with customised rescheduling (C<ev_periodic>), synchronous
30	loop mechanism itself (idle, prepare and check watchers). It also is quite	72	signals (C<ev_signal>), process status change events (C<ev_child>), and
		73	event watchers dealing with the event loop mechanism itself (C<ev_idle>,
		74	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		75	file watchers (C<ev_stat>) and even limited support for fork events
		76	(C<ev_fork>).
		77
		78	It also is quite fast (see this
31	fast (see this L<benchmark\|http://libev.schmorp.de/bench.html> comparing	79	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent
32	it to libevent for example).	80	for example).
33		81
34	=head1 CONVENTIONS	82	=head1 CONVENTIONS
35		83
36	Libev is very configurable. In this manual the default configuration	84	Libev is very configurable. In this manual the default configuration will
37	will be described, which supports multiple event loops. For more info	85	be described, which supports multiple event loops. For more info about
38	about various configuration options please have a look at the file	86	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	87	this manual. If libev was configured without support for multiple event
40	support for multiple event loops, then all functions taking an initial	88	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 *>)	89	(which is always of type C<struct ev_loop *>) will not have this argument.
42	will not have this argument.
43		90
44	=head1 TIME REPRESENTATION	91	=head1 TIME REPRESENTATION
45		92
46	Libev represents time as a single floating point number, representing the	93	Libev represents time as a single floating point number, representing the
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	94	(fractional) number of seconds since the (POSIX) epoch (somewhere near
48	the beginning of 1970, details are complicated, don't ask). This type is	95	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	96	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	97	to the C<double> type in C, and when you need to do any calculations on
51	it, you should treat it as such.	98	it, you should treat it as such.
52		99
53
54	=head1 GLOBAL FUNCTIONS	100	=head1 GLOBAL FUNCTIONS
55		101
56	These functions can be called anytime, even before initialising the	102	These functions can be called anytime, even before initialising the
57	library in any way.	103	library in any way.
58		104
…		…
77	Usually, it's a good idea to terminate if the major versions mismatch,	123	Usually, it's a good idea to terminate if the major versions mismatch,
78	as this indicates an incompatible change. Minor versions are usually	124	as this indicates an incompatible change. Minor versions are usually
79	compatible to older versions, so a larger minor version alone is usually	125	compatible to older versions, so a larger minor version alone is usually
80	not a problem.	126	not a problem.
81		127
82	Example: make sure we haven't accidentally been linked against the wrong	128	Example: Make sure we haven't accidentally been linked against the wrong
83	version:	129	version.
84		130
85	assert (("libev version mismatch",	131	assert (("libev version mismatch",
86	ev_version_major () == EV_VERSION_MAJOR	132	ev_version_major () == EV_VERSION_MAJOR
87	&& ev_version_minor () >= EV_VERSION_MINOR));	133	&& ev_version_minor () >= EV_VERSION_MINOR));
88		134
…		…
116	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	162	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
117	recommended ones.	163	recommended ones.
118		164
119	See the description of C<ev_embed> watchers for more info.	165	See the description of C<ev_embed> watchers for more info.
120		166
121	=item ev_set_allocator (void (cb)(void *ptr, long size))	167	=item ev_set_allocator (void (cb)(void *ptr, size_t size))
122		168
123	Sets the allocation function to use (the prototype is similar to the	169	Sets the allocation function to use (the prototype and semantics are
124	realloc C function, the semantics are identical). It is used to allocate	170	identical to the realloc C function). It is used to allocate and free
125	and free memory (no surprises here). If it returns zero when memory	171	memory (no surprises here). If it returns zero when memory needs to be
126	needs to be allocated, the library might abort or take some potentially	172	allocated, the library might abort or take some potentially destructive
127	destructive action. The default is your system realloc function.	173	action. The default is your system realloc function.
128		174
129	You could override this function in high-availability programs to, say,	175	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,	176	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.	177	or even to sleep a while and retry until some memory is available.
132		178
133	Example: replace the libev allocator with one that waits a bit and then	179	Example: Replace the libev allocator with one that waits a bit and then
134	retries: better than mine).	180	retries).
135		181
136	static void *	182	static void *
137	persistent_realloc (void *ptr, long size)	183	persistent_realloc (void *ptr, size_t size)
138	{	184	{
139	for (;;)	185	for (;;)
140	{	186	{
141	void *newptr = realloc (ptr, size);	187	void *newptr = realloc (ptr, size);
142		188
…		…
158	callback is set, then libev will expect it to remedy the sitution, no	204	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	205	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	206	requested operation, or, if the condition doesn't go away, do bad stuff
161	(such as abort).	207	(such as abort).
162		208
163	Example: do the same thing as libev does internally:	209	Example: This is basically the same thing that libev does internally, too.
164		210
165	static void	211	static void
166	fatal_error (const char *msg)	212	fatal_error (const char *msg)
167	{	213	{
168	perror (msg);	214	perror (msg);
…		…
314	Similar to C<ev_default_loop>, but always creates a new event loop that is	360	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	361	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	362	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).	363	undefined behaviour (or a failed assertion if assertions are enabled).
318		364
319	Example: try to create a event loop that uses epoll and nothing else.	365	Example: Try to create a event loop that uses epoll and nothing else.
320		366
321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	367	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
322	if (!epoller)	368	if (!epoller)
323	fatal ("no epoll found here, maybe it hides under your chair");	369	fatal ("no epoll found here, maybe it hides under your chair");
324		370
325	=item ev_default_destroy ()	371	=item ev_default_destroy ()
326		372
327	Destroys the default loop again (frees all memory and kernel state	373	Destroys the default loop again (frees all memory and kernel state
328	etc.). This stops all registered event watchers (by not touching them in	374	etc.). None of the active event watchers will be stopped in the normal
329	any way whatsoever, although you cannot rely on this :).	375	sense, so e.g. C<ev_is_active> might still return true. It is your
		376	responsibility to either stop all watchers cleanly yoursef I<before>
		377	calling this function, or cope with the fact afterwards (which is usually
		378	the easiest thing, youc na just ignore the watchers and/or C<free ()> them
		379	for example).
330		380
331	=item ev_loop_destroy (loop)	381	=item ev_loop_destroy (loop)
332		382
333	Like C<ev_default_destroy>, but destroys an event loop created by an	383	Like C<ev_default_destroy>, but destroys an event loop created by an
334	earlier call to C<ev_loop_new>.	384	earlier call to C<ev_loop_new>.
…		…
419	Signals and child watchers are implemented as I/O watchers, and will	469	Signals and child watchers are implemented as I/O watchers, and will
420	be handled here by queueing them when their watcher gets executed.	470	be handled here by queueing them when their watcher gets executed.
421	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	471	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
422	were used, return, otherwise continue with step *.	472	were used, return, otherwise continue with step *.
423		473
424	Example: queue some jobs and then loop until no events are outsanding	474	Example: Queue some jobs and then loop until no events are outsanding
425	anymore.	475	anymore.
426		476
427	... queue jobs here, make sure they register event watchers as long	477	... queue jobs here, make sure they register event watchers as long
428	... as they still have work to do (even an idle watcher will do..)	478	... as they still have work to do (even an idle watcher will do..)
429	ev_loop (my_loop, 0);	479	ev_loop (my_loop, 0);
…		…
449	visible to the libev user and should not keep C<ev_loop> from exiting if	499	visible to the libev user and should not keep C<ev_loop> from exiting if
450	no event watchers registered by it are active. It is also an excellent	500	no event watchers registered by it are active. It is also an excellent
451	way to do this for generic recurring timers or from within third-party	501	way to do this for generic recurring timers or from within third-party
452	libraries. Just remember to I<unref after start> and I<ref before stop>.	502	libraries. Just remember to I<unref after start> and I<ref before stop>.
453		503
454	Example: create a signal watcher, but keep it from keeping C<ev_loop>	504	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
455	running when nothing else is active.	505	running when nothing else is active.
456		506
457	struct dv_signal exitsig;	507	struct ev_signal exitsig;
458	ev_signal_init (&exitsig, sig_cb, SIGINT);	508	ev_signal_init (&exitsig, sig_cb, SIGINT);
459	ev_signal_start (myloop, &exitsig);	509	ev_signal_start (loop, &exitsig);
460	evf_unref (myloop);	510	evf_unref (loop);
461		511
462	Example: for some weird reason, unregister the above signal handler again.	512	Example: For some weird reason, unregister the above signal handler again.
463		513
464	ev_ref (myloop);	514	ev_ref (loop);
465	ev_signal_stop (myloop, &exitsig);	515	ev_signal_stop (loop, &exitsig);
466		516
467	=back	517	=back
		518
468		519
469	=head1 ANATOMY OF A WATCHER	520	=head1 ANATOMY OF A WATCHER
470		521
471	A watcher is a structure that you create and register to record your	522	A watcher is a structure that you create and register to record your
472	interest in some event. For instance, if you want to wait for STDIN to	523	interest in some event. For instance, if you want to wait for STDIN to
…		…
539	The signal specified in the C<ev_signal> watcher has been received by a thread.	590	The signal specified in the C<ev_signal> watcher has been received by a thread.
540		591
541	=item C<EV_CHILD>	592	=item C<EV_CHILD>
542		593
543	The pid specified in the C<ev_child> watcher has received a status change.	594	The pid specified in the C<ev_child> watcher has received a status change.
		595
		596	=item C<EV_STAT>
		597
		598	The path specified in the C<ev_stat> watcher changed its attributes somehow.
544		599
545	=item C<EV_IDLE>	600	=item C<EV_IDLE>
546		601
547	The C<ev_idle> watcher has determined that you have nothing better to do.	602	The C<ev_idle> watcher has determined that you have nothing better to do.
548		603
…		…
556	received events. Callbacks of both watcher types can start and stop as	611	received events. Callbacks of both watcher types can start and stop as
557	many watchers as they want, and all of them will be taken into account	612	many watchers as they want, and all of them will be taken into account
558	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	613	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
559	C<ev_loop> from blocking).	614	C<ev_loop> from blocking).
560		615
		616	=item C<EV_EMBED>
		617
		618	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		619
		620	=item C<EV_FORK>
		621
		622	The event loop has been resumed in the child process after fork (see
		623	C<ev_fork>).
		624
561	=item C<EV_ERROR>	625	=item C<EV_ERROR>
562		626
563	An unspecified error has occured, the watcher has been stopped. This might	627	An unspecified error has occured, the watcher has been stopped. This might
564	happen because the watcher could not be properly started because libev	628	happen because the watcher could not be properly started because libev
565	ran out of memory, a file descriptor was found to be closed or any other	629	ran out of memory, a file descriptor was found to be closed or any other
…		…
572	with the error from read() or write(). This will not work in multithreaded	636	with the error from read() or write(). This will not work in multithreaded
573	programs, though, so beware.	637	programs, though, so beware.
574		638
575	=back	639	=back
576		640
577	=head2 SUMMARY OF GENERIC WATCHER FUNCTIONS	641	=head2 GENERIC WATCHER FUNCTIONS
578		642
579	In the following description, C<TYPE> stands for the watcher type,	643	In the following description, C<TYPE> stands for the watcher type,
580	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.	644	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
581		645
582	=over 4	646	=over 4
…		…
591	which rolls both calls into one.	655	which rolls both calls into one.
592		656
593	You can reinitialise a watcher at any time as long as it has been stopped	657	You can reinitialise a watcher at any time as long as it has been stopped
594	(or never started) and there are no pending events outstanding.	658	(or never started) and there are no pending events outstanding.
595		659
596	The callbakc is always of type C<void ()(ev_loop loop, ev_TYPE *watcher,	660	The callback is always of type C<void ()(ev_loop loop, ev_TYPE *watcher,
597	int revents)>.	661	int revents)>.
598		662
599	=item C<ev_TYPE_set> (ev_TYPE *, [args])	663	=item C<ev_TYPE_set> (ev_TYPE *, [args])
600		664
601	This macro initialises the type-specific parts of a watcher. You need to	665	This macro initialises the type-specific parts of a watcher. You need to
…		…
684		748
685		749
686	=head1 WATCHER TYPES	750	=head1 WATCHER TYPES
687		751
688	This section describes each watcher in detail, but will not repeat	752	This section describes each watcher in detail, but will not repeat
689	information given in the last section.	753	information given in the last section. Any initialisation/set macros,
		754	functions and members specific to the watcher type are explained.
690		755
		756	Members are additionally marked with either I<[read-only]>, meaning that,
		757	while the watcher is active, you can look at the member and expect some
		758	sensible content, but you must not modify it (you can modify it while the
		759	watcher is stopped to your hearts content), or I<[read-write]>, which
		760	means you can expect it to have some sensible content while the watcher
		761	is active, but you can also modify it. Modifying it may not do something
		762	sensible or take immediate effect (or do anything at all), but libev will
		763	not crash or malfunction in any way.
691		764
		765
692	=head2 C<ev_io> - is this file descriptor readable or writable	766	=head2 C<ev_io> - is this file descriptor readable or writable?
693		767
694	I/O watchers check whether a file descriptor is readable or writable	768	I/O watchers check whether a file descriptor is readable or writable
695	in each iteration of the event loop (This behaviour is called	769	in each iteration of the event loop, or, more precisely, when reading
696	level-triggering because you keep receiving events as long as the	770	would not block the process and writing would at least be able to write
697	condition persists. Remember you can stop the watcher if you don't want to	771	some data. This behaviour is called level-triggering because you keep
698	act on the event and neither want to receive future events).	772	receiving events as long as the condition persists. Remember you can stop
		773	the watcher if you don't want to act on the event and neither want to
		774	receive future events.
699		775
700	In general you can register as many read and/or write event watchers per	776	In general you can register as many read and/or write event watchers per
701	fd as you want (as long as you don't confuse yourself). Setting all file	777	fd as you want (as long as you don't confuse yourself). Setting all file
702	descriptors to non-blocking mode is also usually a good idea (but not	778	descriptors to non-blocking mode is also usually a good idea (but not
703	required if you know what you are doing).	779	required if you know what you are doing).
704		780
705	You have to be careful with dup'ed file descriptors, though. Some backends	781	You have to be careful with dup'ed file descriptors, though. Some backends
706	(the linux epoll backend is a notable example) cannot handle dup'ed file	782	(the linux epoll backend is a notable example) cannot handle dup'ed file
707	descriptors correctly if you register interest in two or more fds pointing	783	descriptors correctly if you register interest in two or more fds pointing
708	to the same underlying file/socket etc. description (that is, they share	784	to the same underlying file/socket/etc. description (that is, they share
709	the same underlying "file open").	785	the same underlying "file open").
710		786
711	If you must do this, then force the use of a known-to-be-good backend	787	If you must do this, then force the use of a known-to-be-good backend
712	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	788	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
713	C<EVBACKEND_POLL>).	789	C<EVBACKEND_POLL>).
714		790
		791	Another thing you have to watch out for is that it is quite easy to
		792	receive "spurious" readyness notifications, that is your callback might
		793	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
		794	because there is no data. Not only are some backends known to create a
		795	lot of those (for example solaris ports), it is very easy to get into
		796	this situation even with a relatively standard program structure. Thus
		797	it is best to always use non-blocking I/O: An extra C<read>(2) returning
		798	C<EAGAIN> is far preferable to a program hanging until some data arrives.
		799
		800	If you cannot run the fd in non-blocking mode (for example you should not
		801	play around with an Xlib connection), then you have to seperately re-test
		802	wether a file descriptor is really ready with a known-to-be good interface
		803	such as poll (fortunately in our Xlib example, Xlib already does this on
		804	its own, so its quite safe to use).
		805
715	=over 4	806	=over 4
716		807
717	=item ev_io_init (ev_io *, callback, int fd, int events)	808	=item ev_io_init (ev_io *, callback, int fd, int events)
718		809
719	=item ev_io_set (ev_io *, int fd, int events)	810	=item ev_io_set (ev_io *, int fd, int events)
720		811
721	Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive	812	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
722	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ \|	813	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or
723	EV_WRITE> to receive the given events.	814	C<EV_READ \| EV_WRITE> to receive the given events.
724		815
725	Please note that most of the more scalable backend mechanisms (for example	816	=item int fd [read-only]
726	epoll and solaris ports) can result in spurious readyness notifications	817
727	for file descriptors, so you practically need to use non-blocking I/O (and	818	The file descriptor being watched.
728	treat callback invocation as hint only), or retest separately with a safe	819
729	interface before doing I/O (XLib can do this), or force the use of either	820	=item int events [read-only]
730	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>, which don't suffer from this	821
731	problem. Also note that it is quite easy to have your callback invoked	822	The events being watched.
732	when the readyness condition is no longer valid even when employing
733	typical ways of handling events, so its a good idea to use non-blocking
734	I/O unconditionally.
735		823
736	=back	824	=back
737		825
738	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	826	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
739	readable, but only once. Since it is likely line-buffered, you could	827	readable, but only once. Since it is likely line-buffered, you could
740	attempt to read a whole line in the callback:	828	attempt to read a whole line in the callback.
741		829
742	static void	830	static void
743	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)	831	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
744	{	832	{
745	ev_io_stop (loop, w);	833	ev_io_stop (loop, w);
…		…
752	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	840	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
753	ev_io_start (loop, &stdin_readable);	841	ev_io_start (loop, &stdin_readable);
754	ev_loop (loop, 0);	842	ev_loop (loop, 0);
755		843
756		844
757	=head2 C<ev_timer> - relative and optionally recurring timeouts	845	=head2 C<ev_timer> - relative and optionally repeating timeouts
758		846
759	Timer watchers are simple relative timers that generate an event after a	847	Timer watchers are simple relative timers that generate an event after a
760	given time, and optionally repeating in regular intervals after that.	848	given time, and optionally repeating in regular intervals after that.
761		849
762	The timers are based on real time, that is, if you register an event that	850	The timers are based on real time, that is, if you register an event that
…		…
803		891
804	If the timer is repeating, either start it if necessary (with the repeat	892	If the timer is repeating, either start it if necessary (with the repeat
805	value), or reset the running timer to the repeat value.	893	value), or reset the running timer to the repeat value.
806		894
807	This sounds a bit complicated, but here is a useful and typical	895	This sounds a bit complicated, but here is a useful and typical
808	example: Imagine you have a tcp connection and you want a so-called idle	896	example: Imagine you have a tcp connection and you want a so-called
809	timeout, that is, you want to be called when there have been, say, 60	897	idle timeout, that is, you want to be called when there have been,
810	seconds of inactivity on the socket. The easiest way to do this is to	898	say, 60 seconds of inactivity on the socket. The easiest way to do
811	configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each	899	this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling
812	time you successfully read or write some data. If you go into an idle	900	C<ev_timer_again> each time you successfully read or write some data. If
813	state where you do not expect data to travel on the socket, you can stop	901	you go into an idle state where you do not expect data to travel on the
814	the timer, and again will automatically restart it if need be.	902	socket, you can stop the timer, and again will automatically restart it if
		903	need be.
		904
		905	You can also ignore the C<after> value and C<ev_timer_start> altogether
		906	and only ever use the C<repeat> value:
		907
		908	ev_timer_init (timer, callback, 0., 5.);
		909	ev_timer_again (loop, timer);
		910	...
		911	timer->again = 17.;
		912	ev_timer_again (loop, timer);
		913	...
		914	timer->again = 10.;
		915	ev_timer_again (loop, timer);
		916
		917	This is more efficient then stopping/starting the timer eahc time you want
		918	to modify its timeout value.
		919
		920	=item ev_tstamp repeat [read-write]
		921
		922	The current C<repeat> value. Will be used each time the watcher times out
		923	or C<ev_timer_again> is called and determines the next timeout (if any),
		924	which is also when any modifications are taken into account.
815		925
816	=back	926	=back
817		927
818	Example: create a timer that fires after 60 seconds.	928	Example: Create a timer that fires after 60 seconds.
819		929
820	static void	930	static void
821	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)	931	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
822	{	932	{
823	.. one minute over, w is actually stopped right here	933	.. one minute over, w is actually stopped right here
…		…
825		935
826	struct ev_timer mytimer;	936	struct ev_timer mytimer;
827	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	937	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
828	ev_timer_start (loop, &mytimer);	938	ev_timer_start (loop, &mytimer);
829		939
830	Example: create a timeout timer that times out after 10 seconds of	940	Example: Create a timeout timer that times out after 10 seconds of
831	inactivity.	941	inactivity.
832		942
833	static void	943	static void
834	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)	944	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
835	{	945	{
…		…
844	// and in some piece of code that gets executed on any "activity":	954	// and in some piece of code that gets executed on any "activity":
845	// reset the timeout to start ticking again at 10 seconds	955	// reset the timeout to start ticking again at 10 seconds
846	ev_timer_again (&mytimer);	956	ev_timer_again (&mytimer);
847		957
848		958
849	=head2 C<ev_periodic> - to cron or not to cron	959	=head2 C<ev_periodic> - to cron or not to cron?
850		960
851	Periodic watchers are also timers of a kind, but they are very versatile	961	Periodic watchers are also timers of a kind, but they are very versatile
852	(and unfortunately a bit complex).	962	(and unfortunately a bit complex).
853		963
854	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	964	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
855	but on wallclock time (absolute time). You can tell a periodic watcher	965	but on wallclock time (absolute time). You can tell a periodic watcher
856	to trigger "at" some specific point in time. For example, if you tell a	966	to trigger "at" some specific point in time. For example, if you tell a
857	periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()	967	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
858	+ 10.>) and then reset your system clock to the last year, then it will	968	+ 10.>) and then reset your system clock to the last year, then it will
859	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	969	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
860	roughly 10 seconds later and of course not if you reset your system time	970	roughly 10 seconds later and of course not if you reset your system time
861	again).	971	again).
862		972
…		…
946	Simply stops and restarts the periodic watcher again. This is only useful	1056	Simply stops and restarts the periodic watcher again. This is only useful
947	when you changed some parameters or the reschedule callback would return	1057	when you changed some parameters or the reschedule callback would return
948	a different time than the last time it was called (e.g. in a crond like	1058	a different time than the last time it was called (e.g. in a crond like
949	program when the crontabs have changed).	1059	program when the crontabs have changed).
950		1060
		1061	=item ev_tstamp interval [read-write]
		1062
		1063	The current interval value. Can be modified any time, but changes only
		1064	take effect when the periodic timer fires or C<ev_periodic_again> is being
		1065	called.
		1066
		1067	=item ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]
		1068
		1069	The current reschedule callback, or C<0>, if this functionality is
		1070	switched off. Can be changed any time, but changes only take effect when
		1071	the periodic timer fires or C<ev_periodic_again> is being called.
		1072
951	=back	1073	=back
952		1074
953	Example: call a callback every hour, or, more precisely, whenever the	1075	Example: Call a callback every hour, or, more precisely, whenever the
954	system clock is divisible by 3600. The callback invocation times have	1076	system clock is divisible by 3600. The callback invocation times have
955	potentially a lot of jittering, but good long-term stability.	1077	potentially a lot of jittering, but good long-term stability.
956		1078
957	static void	1079	static void
958	clock_cb (struct ev_loop loop, struct ev_io w, int revents)	1080	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
…		…
962		1084
963	struct ev_periodic hourly_tick;	1085	struct ev_periodic hourly_tick;
964	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1086	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
965	ev_periodic_start (loop, &hourly_tick);	1087	ev_periodic_start (loop, &hourly_tick);
966		1088
967	Example: the same as above, but use a reschedule callback to do it:	1089	Example: The same as above, but use a reschedule callback to do it:
968		1090
969	#include <math.h>	1091	#include <math.h>
970		1092
971	static ev_tstamp	1093	static ev_tstamp
972	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1094	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
974	return fmod (now, 3600.) + 3600.;	1096	return fmod (now, 3600.) + 3600.;
975	}	1097	}
976		1098
977	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1099	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
978		1100
979	Example: call a callback every hour, starting now:	1101	Example: Call a callback every hour, starting now:
980		1102
981	struct ev_periodic hourly_tick;	1103	struct ev_periodic hourly_tick;
982	ev_periodic_init (&hourly_tick, clock_cb,	1104	ev_periodic_init (&hourly_tick, clock_cb,
983	fmod (ev_now (loop), 3600.), 3600., 0);	1105	fmod (ev_now (loop), 3600.), 3600., 0);
984	ev_periodic_start (loop, &hourly_tick);	1106	ev_periodic_start (loop, &hourly_tick);
985		1107
986		1108
987	=head2 C<ev_signal> - signal me when a signal gets signalled	1109	=head2 C<ev_signal> - signal me when a signal gets signalled!
988		1110
989	Signal watchers will trigger an event when the process receives a specific	1111	Signal watchers will trigger an event when the process receives a specific
990	signal one or more times. Even though signals are very asynchronous, libev	1112	signal one or more times. Even though signals are very asynchronous, libev
991	will try it's best to deliver signals synchronously, i.e. as part of the	1113	will try it's best to deliver signals synchronously, i.e. as part of the
992	normal event processing, like any other event.	1114	normal event processing, like any other event.
…		…
1005	=item ev_signal_set (ev_signal *, int signum)	1127	=item ev_signal_set (ev_signal *, int signum)
1006		1128
1007	Configures the watcher to trigger on the given signal number (usually one	1129	Configures the watcher to trigger on the given signal number (usually one
1008	of the C<SIGxxx> constants).	1130	of the C<SIGxxx> constants).
1009		1131
		1132	=item int signum [read-only]
		1133
		1134	The signal the watcher watches out for.
		1135
1010	=back	1136	=back
1011		1137
1012		1138
1013	=head2 C<ev_child> - wait for pid status changes	1139	=head2 C<ev_child> - watch out for process status changes
1014		1140
1015	Child watchers trigger when your process receives a SIGCHLD in response to	1141	Child watchers trigger when your process receives a SIGCHLD in response to
1016	some child status changes (most typically when a child of yours dies).	1142	some child status changes (most typically when a child of yours dies).
1017		1143
1018	=over 4	1144	=over 4
…		…
1026	at the C<rstatus> member of the C<ev_child> watcher structure to see	1152	at the C<rstatus> member of the C<ev_child> watcher structure to see
1027	the status word (use the macros from C<sys/wait.h> and see your systems	1153	the status word (use the macros from C<sys/wait.h> and see your systems
1028	C<waitpid> documentation). The C<rpid> member contains the pid of the	1154	C<waitpid> documentation). The C<rpid> member contains the pid of the
1029	process causing the status change.	1155	process causing the status change.
1030		1156
		1157	=item int pid [read-only]
		1158
		1159	The process id this watcher watches out for, or C<0>, meaning any process id.
		1160
		1161	=item int rpid [read-write]
		1162
		1163	The process id that detected a status change.
		1164
		1165	=item int rstatus [read-write]
		1166
		1167	The process exit/trace status caused by C<rpid> (see your systems
		1168	C<waitpid> and C<sys/wait.h> documentation for details).
		1169
1031	=back	1170	=back
1032		1171
1033	Example: try to exit cleanly on SIGINT and SIGTERM.	1172	Example: Try to exit cleanly on SIGINT and SIGTERM.
1034		1173
1035	static void	1174	static void
1036	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1175	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
1037	{	1176	{
1038	ev_unloop (loop, EVUNLOOP_ALL);	1177	ev_unloop (loop, EVUNLOOP_ALL);
…		…
1041	struct ev_signal signal_watcher;	1180	struct ev_signal signal_watcher;
1042	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1181	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1043	ev_signal_start (loop, &sigint_cb);	1182	ev_signal_start (loop, &sigint_cb);
1044		1183
1045		1184
		1185	=head2 C<ev_stat> - did the file attributes just change?
		1186
		1187	This watches a filesystem path for attribute changes. That is, it calls
		1188	C<stat> regularly (or when the OS says it changed) and sees if it changed
		1189	compared to the last time, invoking the callback if it did.
		1190
		1191	The path does not need to exist: changing from "path exists" to "path does
		1192	not exist" is a status change like any other. The condition "path does
		1193	not exist" is signified by the C<st_nlink> field being zero (which is
		1194	otherwise always forced to be at least one) and all the other fields of
		1195	the stat buffer having unspecified contents.
		1196
		1197	Since there is no standard to do this, the portable implementation simply
		1198	calls C<stat (2)> regulalry on the path to see if it changed somehow. You
		1199	can specify a recommended polling interval for this case. If you specify
		1200	a polling interval of C<0> (highly recommended!) then a I<suitable,
		1201	unspecified default> value will be used (which you can expect to be around
		1202	five seconds, although this might change dynamically). Libev will also
		1203	impose a minimum interval which is currently around C<0.1>, but thats
		1204	usually overkill.
		1205
		1206	This watcher type is not meant for massive numbers of stat watchers,
		1207	as even with OS-supported change notifications, this can be
		1208	resource-intensive.
		1209
		1210	At the time of this writing, no specific OS backends are implemented, but
		1211	if demand increases, at least a kqueue and inotify backend will be added.
		1212
		1213	=over 4
		1214
		1215	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)
		1216
		1217	=item ev_stat_set (ev_stat , const char path, ev_tstamp interval)
		1218
		1219	Configures the watcher to wait for status changes of the given
		1220	C<path>. The C<interval> is a hint on how quickly a change is expected to
		1221	be detected and should normally be specified as C<0> to let libev choose
		1222	a suitable value. The memory pointed to by C<path> must point to the same
		1223	path for as long as the watcher is active.
		1224
		1225	The callback will be receive C<EV_STAT> when a change was detected,
		1226	relative to the attributes at the time the watcher was started (or the
		1227	last change was detected).
		1228
		1229	=item ev_stat_stat (ev_stat *)
		1230
		1231	Updates the stat buffer immediately with new values. If you change the
		1232	watched path in your callback, you could call this fucntion to avoid
		1233	detecting this change (while introducing a race condition). Can also be
		1234	useful simply to find out the new values.
		1235
		1236	=item ev_statdata attr [read-only]
		1237
		1238	The most-recently detected attributes of the file. Although the type is of
		1239	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
		1240	suitable for your system. If the C<st_nlink> member is C<0>, then there
		1241	was some error while C<stat>ing the file.
		1242
		1243	=item ev_statdata prev [read-only]
		1244
		1245	The previous attributes of the file. The callback gets invoked whenever
		1246	C<prev> != C<attr>.
		1247
		1248	=item ev_tstamp interval [read-only]
		1249
		1250	The specified interval.
		1251
		1252	=item const char *path [read-only]
		1253
		1254	The filesystem path that is being watched.
		1255
		1256	=back
		1257
		1258	Example: Watch C</etc/passwd> for attribute changes.
		1259
		1260	static void
		1261	passwd_cb (struct ev_loop loop, ev_stat w, int revents)
		1262	{
		1263	/* /etc/passwd changed in some way */
		1264	if (w->attr.st_nlink)
		1265	{
		1266	printf ("passwd current size %ld\n", (long)w->attr.st_size);
		1267	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
		1268	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
		1269	}
		1270	else
		1271	/* you shalt not abuse printf for puts */
		1272	puts ("wow, /etc/passwd is not there, expect problems. "
		1273	"if this is windows, they already arrived\n");
		1274	}
		1275
		1276	...
		1277	ev_stat passwd;
		1278
		1279	ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
		1280	ev_stat_start (loop, &passwd);
		1281
		1282
1046	=head2 C<ev_idle> - when you've got nothing better to do	1283	=head2 C<ev_idle> - when you've got nothing better to do...
1047		1284
1048	Idle watchers trigger events when there are no other events are pending	1285	Idle watchers trigger events when there are no other events are pending
1049	(prepare, check and other idle watchers do not count). That is, as long	1286	(prepare, check and other idle watchers do not count). That is, as long
1050	as your process is busy handling sockets or timeouts (or even signals,	1287	as your process is busy handling sockets or timeouts (or even signals,
1051	imagine) it will not be triggered. But when your process is idle all idle	1288	imagine) it will not be triggered. But when your process is idle all idle
…		…
1069	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1306	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1070	believe me.	1307	believe me.
1071		1308
1072	=back	1309	=back
1073		1310
1074	Example: dynamically allocate an C<ev_idle>, start it, and in the	1311	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1075	callback, free it. Alos, use no error checking, as usual.	1312	callback, free it. Also, use no error checking, as usual.
1076		1313
1077	static void	1314	static void
1078	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)	1315	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
1079	{	1316	{
1080	free (w);	1317	free (w);
…		…
1085	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1322	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1086	ev_idle_init (idle_watcher, idle_cb);	1323	ev_idle_init (idle_watcher, idle_cb);
1087	ev_idle_start (loop, idle_cb);	1324	ev_idle_start (loop, idle_cb);
1088		1325
1089		1326
1090	=head2 C<ev_prepare> and C<ev_check> - customise your event loop	1327	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
1091		1328
1092	Prepare and check watchers are usually (but not always) used in tandem:	1329	Prepare and check watchers are usually (but not always) used in tandem:
1093	prepare watchers get invoked before the process blocks and check watchers	1330	prepare watchers get invoked before the process blocks and check watchers
1094	afterwards.	1331	afterwards.
1095		1332
		1333	You I<must not> call C<ev_loop> or similar functions that enter
		1334	the current event loop from either C<ev_prepare> or C<ev_check>
		1335	watchers. Other loops than the current one are fine, however. The
		1336	rationale behind this is that you do not need to check for recursion in
		1337	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
		1338	C<ev_check> so if you have one watcher of each kind they will always be
		1339	called in pairs bracketing the blocking call.
		1340
1096	Their main purpose is to integrate other event mechanisms into libev and	1341	Their main purpose is to integrate other event mechanisms into libev and
1097	their use is somewhat advanced. This could be used, for example, to track	1342	their use is somewhat advanced. This could be used, for example, to track
1098	variable changes, implement your own watchers, integrate net-snmp or a	1343	variable changes, implement your own watchers, integrate net-snmp or a
1099	coroutine library and lots more.	1344	coroutine library and lots more. They are also occasionally useful if
		1345	you cache some data and want to flush it before blocking (for example,
		1346	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
		1347	watcher).
1100		1348
1101	This is done by examining in each prepare call which file descriptors need	1349	This is done by examining in each prepare call which file descriptors need
1102	to be watched by the other library, registering C<ev_io> watchers for	1350	to be watched by the other library, registering C<ev_io> watchers for
1103	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1351	them and starting an C<ev_timer> watcher for any timeouts (many libraries
1104	provide just this functionality). Then, in the check watcher you check for	1352	provide just this functionality). Then, in the check watcher you check for
…		…
1126	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1374	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1127	macros, but using them is utterly, utterly and completely pointless.	1375	macros, but using them is utterly, utterly and completely pointless.
1128		1376
1129	=back	1377	=back
1130		1378
1131	Example: TODO.	1379	Example: To include a library such as adns, you would add IO watchers
		1380	and a timeout watcher in a prepare handler, as required by libadns, and
		1381	in a check watcher, destroy them and call into libadns. What follows is
		1382	pseudo-code only of course:
1132		1383
		1384	static ev_io iow [nfd];
		1385	static ev_timer tw;
1133		1386
		1387	static void
		1388	io_cb (ev_loop loop, ev_io w, int revents)
		1389	{
		1390	// set the relevant poll flags
		1391	// could also call adns_processreadable etc. here
		1392	struct pollfd fd = (struct pollfd )w->data;
		1393	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1394	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1395	}
		1396
		1397	// create io watchers for each fd and a timer before blocking
		1398	static void
		1399	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
		1400	{
		1401	int timeout = 3600000;truct pollfd fds [nfd];
		1402	// actual code will need to loop here and realloc etc.
		1403	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
		1404
		1405	/* the callback is illegal, but won't be called as we stop during check */
		1406	ev_timer_init (&tw, 0, timeout * 1e-3);
		1407	ev_timer_start (loop, &tw);
		1408
		1409	// create on ev_io per pollfd
		1410	for (int i = 0; i < nfd; ++i)
		1411	{
		1412	ev_io_init (iow + i, io_cb, fds [i].fd,
		1413	((fds [i].events & POLLIN ? EV_READ : 0)
		1414	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
		1415
		1416	fds [i].revents = 0;
		1417	iow [i].data = fds + i;
		1418	ev_io_start (loop, iow + i);
		1419	}
		1420	}
		1421
		1422	// stop all watchers after blocking
		1423	static void
		1424	adns_check_cb (ev_loop loop, ev_check w, int revents)
		1425	{
		1426	ev_timer_stop (loop, &tw);
		1427
		1428	for (int i = 0; i < nfd; ++i)
		1429	ev_io_stop (loop, iow + i);
		1430
		1431	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1432	}
		1433
		1434
1134	=head2 C<ev_embed> - when one backend isn't enough	1435	=head2 C<ev_embed> - when one backend isn't enough...
1135		1436
1136	This is a rather advanced watcher type that lets you embed one event loop	1437	This is a rather advanced watcher type that lets you embed one event loop
1137	into another (currently only C<ev_io> events are supported in the embedded	1438	into another (currently only C<ev_io> events are supported in the embedded
1138	loop, other types of watchers might be handled in a delayed or incorrect	1439	loop, other types of watchers might be handled in a delayed or incorrect
1139	fashion and must not be used).	1440	fashion and must not be used).
…		…
1217		1518
1218	Make a single, non-blocking sweep over the embedded loop. This works	1519	Make a single, non-blocking sweep over the embedded loop. This works
1219	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	1520	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1220	apropriate way for embedded loops.	1521	apropriate way for embedded loops.
1221		1522
		1523	=item struct ev_loop *loop [read-only]
		1524
		1525	The embedded event loop.
		1526
		1527	=back
		1528
		1529
		1530	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		1531
		1532	Fork watchers are called when a C<fork ()> was detected (usually because
		1533	whoever is a good citizen cared to tell libev about it by calling
		1534	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		1535	event loop blocks next and before C<ev_check> watchers are being called,
		1536	and only in the child after the fork. If whoever good citizen calling
		1537	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		1538	handlers will be invoked, too, of course.
		1539
		1540	=over 4
		1541
		1542	=item ev_fork_init (ev_signal *, callback)
		1543
		1544	Initialises and configures the fork watcher - it has no parameters of any
		1545	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
		1546	believe me.
		1547
1222	=back	1548	=back
1223		1549
1224		1550
1225	=head1 OTHER FUNCTIONS	1551	=head1 OTHER FUNCTIONS
1226		1552
…		…
1306		1632
1307	=back	1633	=back
1308		1634
1309	=head1 C++ SUPPORT	1635	=head1 C++ SUPPORT
1310		1636
1311	TBD.	1637	Libev comes with some simplistic wrapper classes for C++ that mainly allow
		1638	you to use some convinience methods to start/stop watchers and also change
		1639	the callback model to a model using method callbacks on objects.
		1640
		1641	To use it,
		1642
		1643	#include <ev++.h>
		1644
		1645	(it is not installed by default). This automatically includes F<ev.h>
		1646	and puts all of its definitions (many of them macros) into the global
		1647	namespace. All C++ specific things are put into the C<ev> namespace.
		1648
		1649	It should support all the same embedding options as F<ev.h>, most notably
		1650	C<EV_MULTIPLICITY>.
		1651
		1652	Here is a list of things available in the C<ev> namespace:
		1653
		1654	=over 4
		1655
		1656	=item C<ev::READ>, C<ev::WRITE> etc.
		1657
		1658	These are just enum values with the same values as the C<EV_READ> etc.
		1659	macros from F<ev.h>.
		1660
		1661	=item C<ev::tstamp>, C<ev::now>
		1662
		1663	Aliases to the same types/functions as with the C<ev_> prefix.
		1664
		1665	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
		1666
		1667	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
		1668	the same name in the C<ev> namespace, with the exception of C<ev_signal>
		1669	which is called C<ev::sig> to avoid clashes with the C<signal> macro
		1670	defines by many implementations.
		1671
		1672	All of those classes have these methods:
		1673
		1674	=over 4
		1675
		1676	=item ev::TYPE::TYPE (object , object::method )
		1677
		1678	=item ev::TYPE::TYPE (object , object::method , struct ev_loop *)
		1679
		1680	=item ev::TYPE::~TYPE
		1681
		1682	The constructor takes a pointer to an object and a method pointer to
		1683	the event handler callback to call in this class. The constructor calls
		1684	C<ev_init> for you, which means you have to call the C<set> method
		1685	before starting it. If you do not specify a loop then the constructor
		1686	automatically associates the default loop with this watcher.
		1687
		1688	The destructor automatically stops the watcher if it is active.
		1689
		1690	=item w->set (struct ev_loop *)
		1691
		1692	Associates a different C<struct ev_loop> with this watcher. You can only
		1693	do this when the watcher is inactive (and not pending either).
		1694
		1695	=item w->set ([args])
		1696
		1697	Basically the same as C<ev_TYPE_set>, with the same args. Must be
		1698	called at least once. Unlike the C counterpart, an active watcher gets
		1699	automatically stopped and restarted.
		1700
		1701	=item w->start ()
		1702
		1703	Starts the watcher. Note that there is no C<loop> argument as the
		1704	constructor already takes the loop.
		1705
		1706	=item w->stop ()
		1707
		1708	Stops the watcher if it is active. Again, no C<loop> argument.
		1709
		1710	=item w->again () C<ev::timer>, C<ev::periodic> only
		1711
		1712	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
		1713	C<ev_TYPE_again> function.
		1714
		1715	=item w->sweep () C<ev::embed> only
		1716
		1717	Invokes C<ev_embed_sweep>.
		1718
		1719	=item w->update () C<ev::stat> only
		1720
		1721	Invokes C<ev_stat_stat>.
		1722
		1723	=back
		1724
		1725	=back
		1726
		1727	Example: Define a class with an IO and idle watcher, start one of them in
		1728	the constructor.
		1729
		1730	class myclass
		1731	{
		1732	ev_io io; void io_cb (ev::io &w, int revents);
		1733	ev_idle idle void idle_cb (ev::idle &w, int revents);
		1734
		1735	myclass ();
		1736	}
		1737
		1738	myclass::myclass (int fd)
		1739	: io (this, &myclass::io_cb),
		1740	idle (this, &myclass::idle_cb)
		1741	{
		1742	io.start (fd, ev::READ);
		1743	}
		1744
		1745
		1746	=head1 MACRO MAGIC
		1747
		1748	Libev can be compiled with a variety of options, the most fundemantal is
		1749	C<EV_MULTIPLICITY>. This option determines wether (most) functions and
		1750	callbacks have an initial C<struct ev_loop *> argument.
		1751
		1752	To make it easier to write programs that cope with either variant, the
		1753	following macros are defined:
		1754
		1755	=over 4
		1756
		1757	=item C<EV_A>, C<EV_A_>
		1758
		1759	This provides the loop I<argument> for functions, if one is required ("ev
		1760	loop argument"). The C<EV_A> form is used when this is the sole argument,
		1761	C<EV_A_> is used when other arguments are following. Example:
		1762
		1763	ev_unref (EV_A);
		1764	ev_timer_add (EV_A_ watcher);
		1765	ev_loop (EV_A_ 0);
		1766
		1767	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		1768	which is often provided by the following macro.
		1769
		1770	=item C<EV_P>, C<EV_P_>
		1771
		1772	This provides the loop I<parameter> for functions, if one is required ("ev
		1773	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		1774	C<EV_P_> is used when other parameters are following. Example:
		1775
		1776	// this is how ev_unref is being declared
		1777	static void ev_unref (EV_P);
		1778
		1779	// this is how you can declare your typical callback
		1780	static void cb (EV_P_ ev_timer *w, int revents)
		1781
		1782	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		1783	suitable for use with C<EV_A>.
		1784
		1785	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		1786
		1787	Similar to the other two macros, this gives you the value of the default
		1788	loop, if multiple loops are supported ("ev loop default").
		1789
		1790	=back
		1791
		1792	Example: Declare and initialise a check watcher, working regardless of
		1793	wether multiple loops are supported or not.
		1794
		1795	static void
		1796	check_cb (EV_P_ ev_timer *w, int revents)
		1797	{
		1798	ev_check_stop (EV_A_ w);
		1799	}
		1800
		1801	ev_check check;
		1802	ev_check_init (&check, check_cb);
		1803	ev_check_start (EV_DEFAULT_ &check);
		1804	ev_loop (EV_DEFAULT_ 0);
		1805
		1806
		1807	=head1 EMBEDDING
		1808
		1809	Libev can (and often is) directly embedded into host
		1810	applications. Examples of applications that embed it include the Deliantra
		1811	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
		1812	and rxvt-unicode.
		1813
		1814	The goal is to enable you to just copy the neecssary files into your
		1815	source directory without having to change even a single line in them, so
		1816	you can easily upgrade by simply copying (or having a checked-out copy of
		1817	libev somewhere in your source tree).
		1818
		1819	=head2 FILESETS
		1820
		1821	Depending on what features you need you need to include one or more sets of files
		1822	in your app.
		1823
		1824	=head3 CORE EVENT LOOP
		1825
		1826	To include only the libev core (all the C<ev_*> functions), with manual
		1827	configuration (no autoconf):
		1828
		1829	#define EV_STANDALONE 1
		1830	#include "ev.c"
		1831
		1832	This will automatically include F<ev.h>, too, and should be done in a
		1833	single C source file only to provide the function implementations. To use
		1834	it, do the same for F<ev.h> in all files wishing to use this API (best
		1835	done by writing a wrapper around F<ev.h> that you can include instead and
		1836	where you can put other configuration options):
		1837
		1838	#define EV_STANDALONE 1
		1839	#include "ev.h"
		1840
		1841	Both header files and implementation files can be compiled with a C++
		1842	compiler (at least, thats a stated goal, and breakage will be treated
		1843	as a bug).
		1844
		1845	You need the following files in your source tree, or in a directory
		1846	in your include path (e.g. in libev/ when using -Ilibev):
		1847
		1848	ev.h
		1849	ev.c
		1850	ev_vars.h
		1851	ev_wrap.h
		1852
		1853	ev_win32.c required on win32 platforms only
		1854
		1855	ev_select.c only when select backend is enabled (which is by default)
		1856	ev_poll.c only when poll backend is enabled (disabled by default)
		1857	ev_epoll.c only when the epoll backend is enabled (disabled by default)
		1858	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
		1859	ev_port.c only when the solaris port backend is enabled (disabled by default)
		1860
		1861	F<ev.c> includes the backend files directly when enabled, so you only need
		1862	to compile this single file.
		1863
		1864	=head3 LIBEVENT COMPATIBILITY API
		1865
		1866	To include the libevent compatibility API, also include:
		1867
		1868	#include "event.c"
		1869
		1870	in the file including F<ev.c>, and:
		1871
		1872	#include "event.h"
		1873
		1874	in the files that want to use the libevent API. This also includes F<ev.h>.
		1875
		1876	You need the following additional files for this:
		1877
		1878	event.h
		1879	event.c
		1880
		1881	=head3 AUTOCONF SUPPORT
		1882
		1883	Instead of using C<EV_STANDALONE=1> and providing your config in
		1884	whatever way you want, you can also C<m4_include([libev.m4])> in your
		1885	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
		1886	include F<config.h> and configure itself accordingly.
		1887
		1888	For this of course you need the m4 file:
		1889
		1890	libev.m4
		1891
		1892	=head2 PREPROCESSOR SYMBOLS/MACROS
		1893
		1894	Libev can be configured via a variety of preprocessor symbols you have to define
		1895	before including any of its files. The default is not to build for multiplicity
		1896	and only include the select backend.
		1897
		1898	=over 4
		1899
		1900	=item EV_STANDALONE
		1901
		1902	Must always be C<1> if you do not use autoconf configuration, which
		1903	keeps libev from including F<config.h>, and it also defines dummy
		1904	implementations for some libevent functions (such as logging, which is not
		1905	supported). It will also not define any of the structs usually found in
		1906	F<event.h> that are not directly supported by the libev core alone.
		1907
		1908	=item EV_USE_MONOTONIC
		1909
		1910	If defined to be C<1>, libev will try to detect the availability of the
		1911	monotonic clock option at both compiletime and runtime. Otherwise no use
		1912	of the monotonic clock option will be attempted. If you enable this, you
		1913	usually have to link against librt or something similar. Enabling it when
		1914	the functionality isn't available is safe, though, althoguh you have
		1915	to make sure you link against any libraries where the C<clock_gettime>
		1916	function is hiding in (often F<-lrt>).
		1917
		1918	=item EV_USE_REALTIME
		1919
		1920	If defined to be C<1>, libev will try to detect the availability of the
		1921	realtime clock option at compiletime (and assume its availability at
		1922	runtime if successful). Otherwise no use of the realtime clock option will
		1923	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
		1924	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries
		1925	in the description of C<EV_USE_MONOTONIC>, though.
		1926
		1927	=item EV_USE_SELECT
		1928
		1929	If undefined or defined to be C<1>, libev will compile in support for the
		1930	C<select>(2) backend. No attempt at autodetection will be done: if no
		1931	other method takes over, select will be it. Otherwise the select backend
		1932	will not be compiled in.
		1933
		1934	=item EV_SELECT_USE_FD_SET
		1935
		1936	If defined to C<1>, then the select backend will use the system C<fd_set>
		1937	structure. This is useful if libev doesn't compile due to a missing
		1938	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on
		1939	exotic systems. This usually limits the range of file descriptors to some
		1940	low limit such as 1024 or might have other limitations (winsocket only
		1941	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
		1942	influence the size of the C<fd_set> used.
		1943
		1944	=item EV_SELECT_IS_WINSOCKET
		1945
		1946	When defined to C<1>, the select backend will assume that
		1947	select/socket/connect etc. don't understand file descriptors but
		1948	wants osf handles on win32 (this is the case when the select to
		1949	be used is the winsock select). This means that it will call
		1950	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
		1951	it is assumed that all these functions actually work on fds, even
		1952	on win32. Should not be defined on non-win32 platforms.
		1953
		1954	=item EV_USE_POLL
		1955
		1956	If defined to be C<1>, libev will compile in support for the C<poll>(2)
		1957	backend. Otherwise it will be enabled on non-win32 platforms. It
		1958	takes precedence over select.
		1959
		1960	=item EV_USE_EPOLL
		1961
		1962	If defined to be C<1>, libev will compile in support for the Linux
		1963	C<epoll>(7) backend. Its availability will be detected at runtime,
		1964	otherwise another method will be used as fallback. This is the
		1965	preferred backend for GNU/Linux systems.
		1966
		1967	=item EV_USE_KQUEUE
		1968
		1969	If defined to be C<1>, libev will compile in support for the BSD style
		1970	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
		1971	otherwise another method will be used as fallback. This is the preferred
		1972	backend for BSD and BSD-like systems, although on most BSDs kqueue only
		1973	supports some types of fds correctly (the only platform we found that
		1974	supports ptys for example was NetBSD), so kqueue might be compiled in, but
		1975	not be used unless explicitly requested. The best way to use it is to find
		1976	out whether kqueue supports your type of fd properly and use an embedded
		1977	kqueue loop.
		1978
		1979	=item EV_USE_PORT
		1980
		1981	If defined to be C<1>, libev will compile in support for the Solaris
		1982	10 port style backend. Its availability will be detected at runtime,
		1983	otherwise another method will be used as fallback. This is the preferred
		1984	backend for Solaris 10 systems.
		1985
		1986	=item EV_USE_DEVPOLL
		1987
		1988	reserved for future expansion, works like the USE symbols above.
		1989
		1990	=item EV_H
		1991
		1992	The name of the F<ev.h> header file used to include it. The default if
		1993	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
		1994	can be used to virtually rename the F<ev.h> header file in case of conflicts.
		1995
		1996	=item EV_CONFIG_H
		1997
		1998	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
		1999	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
		2000	C<EV_H>, above.
		2001
		2002	=item EV_EVENT_H
		2003
		2004	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
		2005	of how the F<event.h> header can be found.
		2006
		2007	=item EV_PROTOTYPES
		2008
		2009	If defined to be C<0>, then F<ev.h> will not define any function
		2010	prototypes, but still define all the structs and other symbols. This is
		2011	occasionally useful if you want to provide your own wrapper functions
		2012	around libev functions.
		2013
		2014	=item EV_MULTIPLICITY
		2015
		2016	If undefined or defined to C<1>, then all event-loop-specific functions
		2017	will have the C<struct ev_loop *> as first argument, and you can create
		2018	additional independent event loops. Otherwise there will be no support
		2019	for multiple event loops and there is no first event loop pointer
		2020	argument. Instead, all functions act on the single default loop.
		2021
		2022	=item EV_PERIODIC_ENABLE
		2023
		2024	If undefined or defined to be C<1>, then periodic timers are supported. If
		2025	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2026	code.
		2027
		2028	=item EV_EMBED_ENABLE
		2029
		2030	If undefined or defined to be C<1>, then embed watchers are supported. If
		2031	defined to be C<0>, then they are not.
		2032
		2033	=item EV_STAT_ENABLE
		2034
		2035	If undefined or defined to be C<1>, then stat watchers are supported. If
		2036	defined to be C<0>, then they are not.
		2037
		2038	=item EV_FORK_ENABLE
		2039
		2040	If undefined or defined to be C<1>, then fork watchers are supported. If
		2041	defined to be C<0>, then they are not.
		2042
		2043	=item EV_MINIMAL
		2044
		2045	If you need to shave off some kilobytes of code at the expense of some
		2046	speed, define this symbol to C<1>. Currently only used for gcc to override
		2047	some inlining decisions, saves roughly 30% codesize of amd64.
		2048
		2049	=item EV_PID_HASHSIZE
		2050
		2051	C<ev_child> watchers use a small hash table to distribute workload by
		2052	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		2053	than enough. If you need to manage thousands of children you might want to
		2054	increase this value.
		2055
		2056	=item EV_COMMON
		2057
		2058	By default, all watchers have a C<void *data> member. By redefining
		2059	this macro to a something else you can include more and other types of
		2060	members. You have to define it each time you include one of the files,
		2061	though, and it must be identical each time.
		2062
		2063	For example, the perl EV module uses something like this:
		2064
		2065	#define EV_COMMON \
		2066	SV self; / contains this struct */ \
		2067	SV cb_sv, fh /* note no trailing ";" */
		2068
		2069	=item EV_CB_DECLARE (type)
		2070
		2071	=item EV_CB_INVOKE (watcher, revents)
		2072
		2073	=item ev_set_cb (ev, cb)
		2074
		2075	Can be used to change the callback member declaration in each watcher,
		2076	and the way callbacks are invoked and set. Must expand to a struct member
		2077	definition and a statement, respectively. See the F<ev.v> header file for
		2078	their default definitions. One possible use for overriding these is to
		2079	avoid the C<struct ev_loop *> as first argument in all cases, or to use
		2080	method calls instead of plain function calls in C++.
		2081
		2082	=head2 EXAMPLES
		2083
		2084	For a real-world example of a program the includes libev
		2085	verbatim, you can have a look at the EV perl module
		2086	(L<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
		2087	the F<libev/> subdirectory and includes them in the F<EV/EVAPI.h> (public
		2088	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
		2089	will be compiled. It is pretty complex because it provides its own header
		2090	file.
		2091
		2092	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
		2093	that everybody includes and which overrides some autoconf choices:
		2094
		2095	#define EV_USE_POLL 0
		2096	#define EV_MULTIPLICITY 0
		2097	#define EV_PERIODICS 0
		2098	#define EV_CONFIG_H <config.h>
		2099
		2100	#include "ev++.h"
		2101
		2102	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
		2103
		2104	#include "ev_cpp.h"
		2105	#include "ev.c"
		2106
		2107
		2108	=head1 COMPLEXITIES
		2109
		2110	In this section the complexities of (many of) the algorithms used inside
		2111	libev will be explained. For complexity discussions about backends see the
		2112	documentation for C<ev_default_init>.
		2113
		2114	=over 4
		2115
		2116	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
		2117
		2118	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
		2119
		2120	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
		2121
		2122	=item Stopping check/prepare/idle watchers: O(1)
		2123
		2124	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))
		2125
		2126	=item Finding the next timer per loop iteration: O(1)
		2127
		2128	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		2129
		2130	=item Activating one watcher: O(1)
		2131
		2132	=back
		2133
1312		2134
1313	=head1 AUTHOR	2135	=head1 AUTHOR
1314		2136
1315	Marc Lehmann <libev@schmorp.de>.	2137	Marc Lehmann <libev@schmorp.de>.
1316		2138

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.36 by root, Sat Nov 24 07:14:26 2007 UTC vs. Revision 1.54 by root, Tue Nov 27 20:26:51 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.36 by root, Sat Nov 24 07:14:26 2007 UTC vs.
Revision 1.54 by root, Tue Nov 27 20:26:51 2007 UTC