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

Comparing libev/ev.pod (file contents):
Revision 1.46 by root, Mon Nov 26 10:20:43 2007 UTC vs.
Revision 1.62 by root, Thu Nov 29 17:28:13 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>), the Linux C<inotify> interface
29	events (related to SIGCHLD), and event watchers dealing with the event	71	(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
30	loop mechanism itself (idle, prepare and check watchers). It also is quite	72	with customised rescheduling (C<ev_periodic>), synchronous signals
		73	(C<ev_signal>), process status change events (C<ev_child>), and event
		74	watchers dealing with the event loop mechanism itself (C<ev_idle>,
		75	C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as
		76	file watchers (C<ev_stat>) and even limited support for fork events
		77	(C<ev_fork>).
		78
		79	It also is quite fast (see this
31	fast (see this L<benchmark\|http://libev.schmorp.de/bench.html> comparing	80	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent
32	it to libevent for example).	81	for example).
33		82
34	=head1 CONVENTIONS	83	=head1 CONVENTIONS
35		84
36	Libev is very configurable. In this manual the default configuration	85	Libev is very configurable. In this manual the default configuration will
37	will be described, which supports multiple event loops. For more info	86	be described, which supports multiple event loops. For more info about
38	about various configuration options please have a look at the file	87	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	88	this manual. If libev was configured without support for multiple event
40	support for multiple event loops, then all functions taking an initial	89	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 *>)	90	(which is always of type C<struct ev_loop *>) will not have this argument.
42	will not have this argument.
43		91
44	=head1 TIME REPRESENTATION	92	=head1 TIME REPRESENTATION
45		93
46	Libev represents time as a single floating point number, representing the	94	Libev represents time as a single floating point number, representing the
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	95	(fractional) number of seconds since the (POSIX) epoch (somewhere near
48	the beginning of 1970, details are complicated, don't ask). This type is	96	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	97	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	98	to the C<double> type in C, and when you need to do any calculations on
51	it, you should treat it as such.	99	it, you should treat it as such.
52		100
53
54	=head1 GLOBAL FUNCTIONS	101	=head1 GLOBAL FUNCTIONS
55		102
56	These functions can be called anytime, even before initialising the	103	These functions can be called anytime, even before initialising the
57	library in any way.	104	library in any way.
58		105
…		…
77	Usually, it's a good idea to terminate if the major versions mismatch,	124	Usually, it's a good idea to terminate if the major versions mismatch,
78	as this indicates an incompatible change. Minor versions are usually	125	as this indicates an incompatible change. Minor versions are usually
79	compatible to older versions, so a larger minor version alone is usually	126	compatible to older versions, so a larger minor version alone is usually
80	not a problem.	127	not a problem.
81		128
82	Example: make sure we haven't accidentally been linked against the wrong	129	Example: Make sure we haven't accidentally been linked against the wrong
83	version:	130	version.
84		131
85	assert (("libev version mismatch",	132	assert (("libev version mismatch",
86	ev_version_major () == EV_VERSION_MAJOR	133	ev_version_major () == EV_VERSION_MAJOR
87	&& ev_version_minor () >= EV_VERSION_MINOR));	134	&& ev_version_minor () >= EV_VERSION_MINOR));
88		135
…		…
118		165
119	See the description of C<ev_embed> watchers for more info.	166	See the description of C<ev_embed> watchers for more info.
120		167
121	=item ev_set_allocator (void (cb)(void *ptr, long size))	168	=item ev_set_allocator (void (cb)(void *ptr, long size))
122		169
123	Sets the allocation function to use (the prototype is similar to the	170	Sets the allocation function to use (the prototype is similar - the
124	realloc C function, the semantics are identical). It is used to allocate	171	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	172	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	173	memory needs to be allocated, the library might abort or take some
127	destructive action. The default is your system realloc function.	174	potentially destructive action. The default is your system realloc
		175	function.
128		176
129	You could override this function in high-availability programs to, say,	177	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,	178	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.	179	or even to sleep a while and retry until some memory is available.
132		180
133	Example: replace the libev allocator with one that waits a bit and then	181	Example: Replace the libev allocator with one that waits a bit and then
134	retries: better than mine).	182	retries).
135		183
136	static void *	184	static void *
137	persistent_realloc (void *ptr, long size)	185	persistent_realloc (void *ptr, size_t size)
138	{	186	{
139	for (;;)	187	for (;;)
140	{	188	{
141	void *newptr = realloc (ptr, size);	189	void *newptr = realloc (ptr, size);
142		190
…		…
158	callback is set, then libev will expect it to remedy the sitution, no	206	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	207	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	208	requested operation, or, if the condition doesn't go away, do bad stuff
161	(such as abort).	209	(such as abort).
162		210
163	Example: do the same thing as libev does internally:	211	Example: This is basically the same thing that libev does internally, too.
164		212
165	static void	213	static void
166	fatal_error (const char *msg)	214	fatal_error (const char *msg)
167	{	215	{
168	perror (msg);	216	perror (msg);
…		…
218	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	266	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
219	override the flags completely if it is found in the environment. This is	267	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	268	useful to try out specific backends to test their performance, or to work
221	around bugs.	269	around bugs.
222		270
		271	=item C<EVFLAG_FORKCHECK>
		272
		273	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		274	a fork, you can also make libev check for a fork in each iteration by
		275	enabling this flag.
		276
		277	This works by calling C<getpid ()> on every iteration of the loop,
		278	and thus this might slow down your event loop if you do a lot of loop
		279	iterations and little real work, but is usually not noticable (on my
		280	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		281	without a syscall and thus I<very> fast, but my Linux system also has
		282	C<pthread_atfork> which is even faster).
		283
		284	The big advantage of this flag is that you can forget about fork (and
		285	forget about forgetting to tell libev about forking) when you use this
		286	flag.
		287
		288	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		289	environment variable.
		290
223	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	291	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
224		292
225	This is your standard select(2) backend. Not I<completely> standard, as	293	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,	294	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	295	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	382	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	383	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	384	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).	385	undefined behaviour (or a failed assertion if assertions are enabled).
318		386
319	Example: try to create a event loop that uses epoll and nothing else.	387	Example: Try to create a event loop that uses epoll and nothing else.
320		388
321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	389	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
322	if (!epoller)	390	if (!epoller)
323	fatal ("no epoll found here, maybe it hides under your chair");	391	fatal ("no epoll found here, maybe it hides under your chair");
324		392
…		…
423	Signals and child watchers are implemented as I/O watchers, and will	491	Signals and child watchers are implemented as I/O watchers, and will
424	be handled here by queueing them when their watcher gets executed.	492	be handled here by queueing them when their watcher gets executed.
425	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	493	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
426	were used, return, otherwise continue with step *.	494	were used, return, otherwise continue with step *.
427		495
428	Example: queue some jobs and then loop until no events are outsanding	496	Example: Queue some jobs and then loop until no events are outsanding
429	anymore.	497	anymore.
430		498
431	... queue jobs here, make sure they register event watchers as long	499	... 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..)	500	... as they still have work to do (even an idle watcher will do..)
433	ev_loop (my_loop, 0);	501	ev_loop (my_loop, 0);
…		…
453	visible to the libev user and should not keep C<ev_loop> from exiting if	521	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	522	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	523	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>.	524	libraries. Just remember to I<unref after start> and I<ref before stop>.
457		525
458	Example: create a signal watcher, but keep it from keeping C<ev_loop>	526	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
459	running when nothing else is active.	527	running when nothing else is active.
460		528
461	struct dv_signal exitsig;	529	struct ev_signal exitsig;
462	ev_signal_init (&exitsig, sig_cb, SIGINT);	530	ev_signal_init (&exitsig, sig_cb, SIGINT);
463	ev_signal_start (myloop, &exitsig);	531	ev_signal_start (loop, &exitsig);
464	evf_unref (myloop);	532	evf_unref (loop);
465		533
466	Example: for some weird reason, unregister the above signal handler again.	534	Example: For some weird reason, unregister the above signal handler again.
467		535
468	ev_ref (myloop);	536	ev_ref (loop);
469	ev_signal_stop (myloop, &exitsig);	537	ev_signal_stop (loop, &exitsig);
470		538
471	=back	539	=back
472		540
473		541
474	=head1 ANATOMY OF A WATCHER	542	=head1 ANATOMY OF A WATCHER
…		…
544	The signal specified in the C<ev_signal> watcher has been received by a thread.	612	The signal specified in the C<ev_signal> watcher has been received by a thread.
545		613
546	=item C<EV_CHILD>	614	=item C<EV_CHILD>
547		615
548	The pid specified in the C<ev_child> watcher has received a status change.	616	The pid specified in the C<ev_child> watcher has received a status change.
		617
		618	=item C<EV_STAT>
		619
		620	The path specified in the C<ev_stat> watcher changed its attributes somehow.
549		621
550	=item C<EV_IDLE>	622	=item C<EV_IDLE>
551		623
552	The C<ev_idle> watcher has determined that you have nothing better to do.	624	The C<ev_idle> watcher has determined that you have nothing better to do.
553		625
…		…
561	received events. Callbacks of both watcher types can start and stop as	633	received events. Callbacks of both watcher types can start and stop as
562	many watchers as they want, and all of them will be taken into account	634	many watchers as they want, and all of them will be taken into account
563	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	635	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
564	C<ev_loop> from blocking).	636	C<ev_loop> from blocking).
565		637
		638	=item C<EV_EMBED>
		639
		640	The embedded event loop specified in the C<ev_embed> watcher needs attention.
		641
		642	=item C<EV_FORK>
		643
		644	The event loop has been resumed in the child process after fork (see
		645	C<ev_fork>).
		646
566	=item C<EV_ERROR>	647	=item C<EV_ERROR>
567		648
568	An unspecified error has occured, the watcher has been stopped. This might	649	An unspecified error has occured, the watcher has been stopped. This might
569	happen because the watcher could not be properly started because libev	650	happen because the watcher could not be properly started because libev
570	ran out of memory, a file descriptor was found to be closed or any other	651	ran out of memory, a file descriptor was found to be closed or any other
…		…
644	events but its callback has not yet been invoked). As long as a watcher	725	events but its callback has not yet been invoked). As long as a watcher
645	is pending (but not active) you must not call an init function on it (but	726	is pending (but not active) you must not call an init function on it (but
646	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	727	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to
647	libev (e.g. you cnanot C<free ()> it).	728	libev (e.g. you cnanot C<free ()> it).
648		729
649	=item callback = ev_cb (ev_TYPE *watcher)	730	=item callback ev_cb (ev_TYPE *watcher)
650		731
651	Returns the callback currently set on the watcher.	732	Returns the callback currently set on the watcher.
652		733
653	=item ev_cb_set (ev_TYPE *watcher, callback)	734	=item ev_cb_set (ev_TYPE *watcher, callback)
654		735
…		…
682	{	763	{
683	struct my_io w = (struct my_io )w_;	764	struct my_io w = (struct my_io )w_;
684	...	765	...
685	}	766	}
686		767
687	More interesting and less C-conformant ways of catsing your callback type	768	More interesting and less C-conformant ways of casting your callback type
688	have been omitted....	769	instead have been omitted.
		770
		771	Another common scenario is having some data structure with multiple
		772	watchers:
		773
		774	struct my_biggy
		775	{
		776	int some_data;
		777	ev_timer t1;
		778	ev_timer t2;
		779	}
		780
		781	In this case getting the pointer to C<my_biggy> is a bit more complicated,
		782	you need to use C<offsetof>:
		783
		784	#include <stddef.h>
		785
		786	static void
		787	t1_cb (EV_P_ struct ev_timer *w, int revents)
		788	{
		789	struct my_biggy big = (struct my_biggy *
		790	(((char *)w) - offsetof (struct my_biggy, t1));
		791	}
		792
		793	static void
		794	t2_cb (EV_P_ struct ev_timer *w, int revents)
		795	{
		796	struct my_biggy big = (struct my_biggy *
		797	(((char *)w) - offsetof (struct my_biggy, t2));
		798	}
689		799
690		800
691	=head1 WATCHER TYPES	801	=head1 WATCHER TYPES
692		802
693	This section describes each watcher in detail, but will not repeat	803	This section describes each watcher in detail, but will not repeat
694	information given in the last section.	804	information given in the last section. Any initialisation/set macros,
		805	functions and members specific to the watcher type are explained.
		806
		807	Members are additionally marked with either I<[read-only]>, meaning that,
		808	while the watcher is active, you can look at the member and expect some
		809	sensible content, but you must not modify it (you can modify it while the
		810	watcher is stopped to your hearts content), or I<[read-write]>, which
		811	means you can expect it to have some sensible content while the watcher
		812	is active, but you can also modify it. Modifying it may not do something
		813	sensible or take immediate effect (or do anything at all), but libev will
		814	not crash or malfunction in any way.
695		815
696		816
697	=head2 C<ev_io> - is this file descriptor readable or writable?	817	=head2 C<ev_io> - is this file descriptor readable or writable?
698		818
699	I/O watchers check whether a file descriptor is readable or writable	819	I/O watchers check whether a file descriptor is readable or writable
…		…
742		862
743	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to	863	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
744	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or	864	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or
745	C<EV_READ \| EV_WRITE> to receive the given events.	865	C<EV_READ \| EV_WRITE> to receive the given events.
746		866
		867	=item int fd [read-only]
		868
		869	The file descriptor being watched.
		870
		871	=item int events [read-only]
		872
		873	The events being watched.
		874
747	=back	875	=back
748		876
749	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well	877	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
750	readable, but only once. Since it is likely line-buffered, you could	878	readable, but only once. Since it is likely line-buffered, you could
751	attempt to read a whole line in the callback:	879	attempt to read a whole line in the callback.
752		880
753	static void	881	static void
754	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)	882	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
755	{	883	{
756	ev_io_stop (loop, w);	884	ev_io_stop (loop, w);
…		…
808	=item ev_timer_again (loop)	936	=item ev_timer_again (loop)
809		937
810	This will act as if the timer timed out and restart it again if it is	938	This will act as if the timer timed out and restart it again if it is
811	repeating. The exact semantics are:	939	repeating. The exact semantics are:
812		940
		941	If the timer is pending, its pending status is cleared.
		942
813	If the timer is started but nonrepeating, stop it.	943	If the timer is started but nonrepeating, stop it (as if it timed out).
814		944
815	If the timer is repeating, either start it if necessary (with the repeat	945	If the timer is repeating, either start it if necessary (with the
816	value), or reset the running timer to the repeat value.	946	C<repeat> value), or reset the running timer to the C<repeat> value.
817		947
818	This sounds a bit complicated, but here is a useful and typical	948	This sounds a bit complicated, but here is a useful and typical
819	example: Imagine you have a tcp connection and you want a so-called idle	949	example: Imagine you have a tcp connection and you want a so-called idle
820	timeout, that is, you want to be called when there have been, say, 60	950	timeout, that is, you want to be called when there have been, say, 60
821	seconds of inactivity on the socket. The easiest way to do this is to	951	seconds of inactivity on the socket. The easiest way to do this is to
822	configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each	952	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
823	time you successfully read or write some data. If you go into an idle	953	C<ev_timer_again> each time you successfully read or write some data. If
824	state where you do not expect data to travel on the socket, you can stop	954	you go into an idle state where you do not expect data to travel on the
825	the timer, and again will automatically restart it if need be.	955	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
		956	automatically restart it if need be.
		957
		958	That means you can ignore the C<after> value and C<ev_timer_start>
		959	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
		960
		961	ev_timer_init (timer, callback, 0., 5.);
		962	ev_timer_again (loop, timer);
		963	...
		964	timer->again = 17.;
		965	ev_timer_again (loop, timer);
		966	...
		967	timer->again = 10.;
		968	ev_timer_again (loop, timer);
		969
		970	This is more slightly efficient then stopping/starting the timer each time
		971	you want to modify its timeout value.
		972
		973	=item ev_tstamp repeat [read-write]
		974
		975	The current C<repeat> value. Will be used each time the watcher times out
		976	or C<ev_timer_again> is called and determines the next timeout (if any),
		977	which is also when any modifications are taken into account.
826		978
827	=back	979	=back
828		980
829	Example: create a timer that fires after 60 seconds.	981	Example: Create a timer that fires after 60 seconds.
830		982
831	static void	983	static void
832	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)	984	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
833	{	985	{
834	.. one minute over, w is actually stopped right here	986	.. one minute over, w is actually stopped right here
…		…
836		988
837	struct ev_timer mytimer;	989	struct ev_timer mytimer;
838	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	990	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
839	ev_timer_start (loop, &mytimer);	991	ev_timer_start (loop, &mytimer);
840		992
841	Example: create a timeout timer that times out after 10 seconds of	993	Example: Create a timeout timer that times out after 10 seconds of
842	inactivity.	994	inactivity.
843		995
844	static void	996	static void
845	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)	997	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
846	{	998	{
…		…
957	Simply stops and restarts the periodic watcher again. This is only useful	1109	Simply stops and restarts the periodic watcher again. This is only useful
958	when you changed some parameters or the reschedule callback would return	1110	when you changed some parameters or the reschedule callback would return
959	a different time than the last time it was called (e.g. in a crond like	1111	a different time than the last time it was called (e.g. in a crond like
960	program when the crontabs have changed).	1112	program when the crontabs have changed).
961		1113
		1114	=item ev_tstamp interval [read-write]
		1115
		1116	The current interval value. Can be modified any time, but changes only
		1117	take effect when the periodic timer fires or C<ev_periodic_again> is being
		1118	called.
		1119
		1120	=item ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]
		1121
		1122	The current reschedule callback, or C<0>, if this functionality is
		1123	switched off. Can be changed any time, but changes only take effect when
		1124	the periodic timer fires or C<ev_periodic_again> is being called.
		1125
962	=back	1126	=back
963		1127
964	Example: call a callback every hour, or, more precisely, whenever the	1128	Example: Call a callback every hour, or, more precisely, whenever the
965	system clock is divisible by 3600. The callback invocation times have	1129	system clock is divisible by 3600. The callback invocation times have
966	potentially a lot of jittering, but good long-term stability.	1130	potentially a lot of jittering, but good long-term stability.
967		1131
968	static void	1132	static void
969	clock_cb (struct ev_loop loop, struct ev_io w, int revents)	1133	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
…		…
973		1137
974	struct ev_periodic hourly_tick;	1138	struct ev_periodic hourly_tick;
975	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1139	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
976	ev_periodic_start (loop, &hourly_tick);	1140	ev_periodic_start (loop, &hourly_tick);
977		1141
978	Example: the same as above, but use a reschedule callback to do it:	1142	Example: The same as above, but use a reschedule callback to do it:
979		1143
980	#include <math.h>	1144	#include <math.h>
981		1145
982	static ev_tstamp	1146	static ev_tstamp
983	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1147	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
…		…
985	return fmod (now, 3600.) + 3600.;	1149	return fmod (now, 3600.) + 3600.;
986	}	1150	}
987		1151
988	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1152	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
989		1153
990	Example: call a callback every hour, starting now:	1154	Example: Call a callback every hour, starting now:
991		1155
992	struct ev_periodic hourly_tick;	1156	struct ev_periodic hourly_tick;
993	ev_periodic_init (&hourly_tick, clock_cb,	1157	ev_periodic_init (&hourly_tick, clock_cb,
994	fmod (ev_now (loop), 3600.), 3600., 0);	1158	fmod (ev_now (loop), 3600.), 3600., 0);
995	ev_periodic_start (loop, &hourly_tick);	1159	ev_periodic_start (loop, &hourly_tick);
…		…
1016	=item ev_signal_set (ev_signal *, int signum)	1180	=item ev_signal_set (ev_signal *, int signum)
1017		1181
1018	Configures the watcher to trigger on the given signal number (usually one	1182	Configures the watcher to trigger on the given signal number (usually one
1019	of the C<SIGxxx> constants).	1183	of the C<SIGxxx> constants).
1020		1184
		1185	=item int signum [read-only]
		1186
		1187	The signal the watcher watches out for.
		1188
1021	=back	1189	=back
1022		1190
1023		1191
1024	=head2 C<ev_child> - watch out for process status changes	1192	=head2 C<ev_child> - watch out for process status changes
1025		1193
…		…
1037	at the C<rstatus> member of the C<ev_child> watcher structure to see	1205	at the C<rstatus> member of the C<ev_child> watcher structure to see
1038	the status word (use the macros from C<sys/wait.h> and see your systems	1206	the status word (use the macros from C<sys/wait.h> and see your systems
1039	C<waitpid> documentation). The C<rpid> member contains the pid of the	1207	C<waitpid> documentation). The C<rpid> member contains the pid of the
1040	process causing the status change.	1208	process causing the status change.
1041		1209
		1210	=item int pid [read-only]
		1211
		1212	The process id this watcher watches out for, or C<0>, meaning any process id.
		1213
		1214	=item int rpid [read-write]
		1215
		1216	The process id that detected a status change.
		1217
		1218	=item int rstatus [read-write]
		1219
		1220	The process exit/trace status caused by C<rpid> (see your systems
		1221	C<waitpid> and C<sys/wait.h> documentation for details).
		1222
1042	=back	1223	=back
1043		1224
1044	Example: try to exit cleanly on SIGINT and SIGTERM.	1225	Example: Try to exit cleanly on SIGINT and SIGTERM.
1045		1226
1046	static void	1227	static void
1047	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1228	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
1048	{	1229	{
1049	ev_unloop (loop, EVUNLOOP_ALL);	1230	ev_unloop (loop, EVUNLOOP_ALL);
1050	}	1231	}
1051		1232
1052	struct ev_signal signal_watcher;	1233	struct ev_signal signal_watcher;
1053	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1234	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1054	ev_signal_start (loop, &sigint_cb);	1235	ev_signal_start (loop, &sigint_cb);
		1236
		1237
		1238	=head2 C<ev_stat> - did the file attributes just change?
		1239
		1240	This watches a filesystem path for attribute changes. That is, it calls
		1241	C<stat> regularly (or when the OS says it changed) and sees if it changed
		1242	compared to the last time, invoking the callback if it did.
		1243
		1244	The path does not need to exist: changing from "path exists" to "path does
		1245	not exist" is a status change like any other. The condition "path does
		1246	not exist" is signified by the C<st_nlink> field being zero (which is
		1247	otherwise always forced to be at least one) and all the other fields of
		1248	the stat buffer having unspecified contents.
		1249
		1250	The path I<should> be absolute and I<must not> end in a slash. If it is
		1251	relative and your working directory changes, the behaviour is undefined.
		1252
		1253	Since there is no standard to do this, the portable implementation simply
		1254	calls C<stat (2)> regularly on the path to see if it changed somehow. You
		1255	can specify a recommended polling interval for this case. If you specify
		1256	a polling interval of C<0> (highly recommended!) then a I<suitable,
		1257	unspecified default> value will be used (which you can expect to be around
		1258	five seconds, although this might change dynamically). Libev will also
		1259	impose a minimum interval which is currently around C<0.1>, but thats
		1260	usually overkill.
		1261
		1262	This watcher type is not meant for massive numbers of stat watchers,
		1263	as even with OS-supported change notifications, this can be
		1264	resource-intensive.
		1265
		1266	At the time of this writing, only the Linux inotify interface is
		1267	implemented (implementing kqueue support is left as an exercise for the
		1268	reader). Inotify will be used to give hints only and should not change the
		1269	semantics of C<ev_stat> watchers, which means that libev sometimes needs
		1270	to fall back to regular polling again even with inotify, but changes are
		1271	usually detected immediately, and if the file exists there will be no
		1272	polling.
		1273
		1274	=over 4
		1275
		1276	=item ev_stat_init (ev_stat , callback, const char path, ev_tstamp interval)
		1277
		1278	=item ev_stat_set (ev_stat , const char path, ev_tstamp interval)
		1279
		1280	Configures the watcher to wait for status changes of the given
		1281	C<path>. The C<interval> is a hint on how quickly a change is expected to
		1282	be detected and should normally be specified as C<0> to let libev choose
		1283	a suitable value. The memory pointed to by C<path> must point to the same
		1284	path for as long as the watcher is active.
		1285
		1286	The callback will be receive C<EV_STAT> when a change was detected,
		1287	relative to the attributes at the time the watcher was started (or the
		1288	last change was detected).
		1289
		1290	=item ev_stat_stat (ev_stat *)
		1291
		1292	Updates the stat buffer immediately with new values. If you change the
		1293	watched path in your callback, you could call this fucntion to avoid
		1294	detecting this change (while introducing a race condition). Can also be
		1295	useful simply to find out the new values.
		1296
		1297	=item ev_statdata attr [read-only]
		1298
		1299	The most-recently detected attributes of the file. Although the type is of
		1300	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
		1301	suitable for your system. If the C<st_nlink> member is C<0>, then there
		1302	was some error while C<stat>ing the file.
		1303
		1304	=item ev_statdata prev [read-only]
		1305
		1306	The previous attributes of the file. The callback gets invoked whenever
		1307	C<prev> != C<attr>.
		1308
		1309	=item ev_tstamp interval [read-only]
		1310
		1311	The specified interval.
		1312
		1313	=item const char *path [read-only]
		1314
		1315	The filesystem path that is being watched.
		1316
		1317	=back
		1318
		1319	Example: Watch C</etc/passwd> for attribute changes.
		1320
		1321	static void
		1322	passwd_cb (struct ev_loop loop, ev_stat w, int revents)
		1323	{
		1324	/* /etc/passwd changed in some way */
		1325	if (w->attr.st_nlink)
		1326	{
		1327	printf ("passwd current size %ld\n", (long)w->attr.st_size);
		1328	printf ("passwd current atime %ld\n", (long)w->attr.st_mtime);
		1329	printf ("passwd current mtime %ld\n", (long)w->attr.st_mtime);
		1330	}
		1331	else
		1332	/* you shalt not abuse printf for puts */
		1333	puts ("wow, /etc/passwd is not there, expect problems. "
		1334	"if this is windows, they already arrived\n");
		1335	}
		1336
		1337	...
		1338	ev_stat passwd;
		1339
		1340	ev_stat_init (&passwd, passwd_cb, "/etc/passwd");
		1341	ev_stat_start (loop, &passwd);
1055		1342
1056		1343
1057	=head2 C<ev_idle> - when you've got nothing better to do...	1344	=head2 C<ev_idle> - when you've got nothing better to do...
1058		1345
1059	Idle watchers trigger events when there are no other events are pending	1346	Idle watchers trigger events when there are no other events are pending
…		…
1080	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1367	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1081	believe me.	1368	believe me.
1082		1369
1083	=back	1370	=back
1084		1371
1085	Example: dynamically allocate an C<ev_idle>, start it, and in the	1372	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1086	callback, free it. Alos, use no error checking, as usual.	1373	callback, free it. Also, use no error checking, as usual.
1087		1374
1088	static void	1375	static void
1089	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)	1376	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
1090	{	1377	{
1091	free (w);	1378	free (w);
…		…
1292		1579
1293	Make a single, non-blocking sweep over the embedded loop. This works	1580	Make a single, non-blocking sweep over the embedded loop. This works
1294	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	1581	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1295	apropriate way for embedded loops.	1582	apropriate way for embedded loops.
1296		1583
		1584	=item struct ev_loop *loop [read-only]
		1585
		1586	The embedded event loop.
		1587
		1588	=back
		1589
		1590
		1591	=head2 C<ev_fork> - the audacity to resume the event loop after a fork
		1592
		1593	Fork watchers are called when a C<fork ()> was detected (usually because
		1594	whoever is a good citizen cared to tell libev about it by calling
		1595	C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the
		1596	event loop blocks next and before C<ev_check> watchers are being called,
		1597	and only in the child after the fork. If whoever good citizen calling
		1598	C<ev_default_fork> cheats and calls it in the wrong process, the fork
		1599	handlers will be invoked, too, of course.
		1600
		1601	=over 4
		1602
		1603	=item ev_fork_init (ev_signal *, callback)
		1604
		1605	Initialises and configures the fork watcher - it has no parameters of any
		1606	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
		1607	believe me.
		1608
1297	=back	1609	=back
1298		1610
1299		1611
1300	=head1 OTHER FUNCTIONS	1612	=head1 OTHER FUNCTIONS
1301		1613
…		…
1463		1775
1464	=item w->sweep () C<ev::embed> only	1776	=item w->sweep () C<ev::embed> only
1465		1777
1466	Invokes C<ev_embed_sweep>.	1778	Invokes C<ev_embed_sweep>.
1467		1779
		1780	=item w->update () C<ev::stat> only
		1781
		1782	Invokes C<ev_stat_stat>.
		1783
1468	=back	1784	=back
1469		1785
1470	=back	1786	=back
1471		1787
1472	Example: Define a class with an IO and idle watcher, start one of them in	1788	Example: Define a class with an IO and idle watcher, start one of them in
…		…
1484	: io (this, &myclass::io_cb),	1800	: io (this, &myclass::io_cb),
1485	idle (this, &myclass::idle_cb)	1801	idle (this, &myclass::idle_cb)
1486	{	1802	{
1487	io.start (fd, ev::READ);	1803	io.start (fd, ev::READ);
1488	}	1804	}
		1805
		1806
		1807	=head1 MACRO MAGIC
		1808
		1809	Libev can be compiled with a variety of options, the most fundemantal is
		1810	C<EV_MULTIPLICITY>. This option determines wether (most) functions and
		1811	callbacks have an initial C<struct ev_loop *> argument.
		1812
		1813	To make it easier to write programs that cope with either variant, the
		1814	following macros are defined:
		1815
		1816	=over 4
		1817
		1818	=item C<EV_A>, C<EV_A_>
		1819
		1820	This provides the loop I<argument> for functions, if one is required ("ev
		1821	loop argument"). The C<EV_A> form is used when this is the sole argument,
		1822	C<EV_A_> is used when other arguments are following. Example:
		1823
		1824	ev_unref (EV_A);
		1825	ev_timer_add (EV_A_ watcher);
		1826	ev_loop (EV_A_ 0);
		1827
		1828	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
		1829	which is often provided by the following macro.
		1830
		1831	=item C<EV_P>, C<EV_P_>
		1832
		1833	This provides the loop I<parameter> for functions, if one is required ("ev
		1834	loop parameter"). The C<EV_P> form is used when this is the sole parameter,
		1835	C<EV_P_> is used when other parameters are following. Example:
		1836
		1837	// this is how ev_unref is being declared
		1838	static void ev_unref (EV_P);
		1839
		1840	// this is how you can declare your typical callback
		1841	static void cb (EV_P_ ev_timer *w, int revents)
		1842
		1843	It declares a parameter C<loop> of type C<struct ev_loop *>, quite
		1844	suitable for use with C<EV_A>.
		1845
		1846	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
		1847
		1848	Similar to the other two macros, this gives you the value of the default
		1849	loop, if multiple loops are supported ("ev loop default").
		1850
		1851	=back
		1852
		1853	Example: Declare and initialise a check watcher, working regardless of
		1854	wether multiple loops are supported or not.
		1855
		1856	static void
		1857	check_cb (EV_P_ ev_timer *w, int revents)
		1858	{
		1859	ev_check_stop (EV_A_ w);
		1860	}
		1861
		1862	ev_check check;
		1863	ev_check_init (&check, check_cb);
		1864	ev_check_start (EV_DEFAULT_ &check);
		1865	ev_loop (EV_DEFAULT_ 0);
		1866
1489		1867
1490	=head1 EMBEDDING	1868	=head1 EMBEDDING
1491		1869
1492	Libev can (and often is) directly embedded into host	1870	Libev can (and often is) directly embedded into host
1493	applications. Examples of applications that embed it include the Deliantra	1871	applications. Examples of applications that embed it include the Deliantra
…		…
1668		2046
1669	=item EV_USE_DEVPOLL	2047	=item EV_USE_DEVPOLL
1670		2048
1671	reserved for future expansion, works like the USE symbols above.	2049	reserved for future expansion, works like the USE symbols above.
1672		2050
		2051	=item EV_USE_INOTIFY
		2052
		2053	If defined to be C<1>, libev will compile in support for the Linux inotify
		2054	interface to speed up C<ev_stat> watchers. Its actual availability will
		2055	be detected at runtime.
		2056
1673	=item EV_H	2057	=item EV_H
1674		2058
1675	The name of the F<ev.h> header file used to include it. The default if	2059	The name of the F<ev.h> header file used to include it. The default if
1676	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This	2060	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
1677	can be used to virtually rename the F<ev.h> header file in case of conflicts.	2061	can be used to virtually rename the F<ev.h> header file in case of conflicts.
…		…
1700	will have the C<struct ev_loop *> as first argument, and you can create	2084	will have the C<struct ev_loop *> as first argument, and you can create
1701	additional independent event loops. Otherwise there will be no support	2085	additional independent event loops. Otherwise there will be no support
1702	for multiple event loops and there is no first event loop pointer	2086	for multiple event loops and there is no first event loop pointer
1703	argument. Instead, all functions act on the single default loop.	2087	argument. Instead, all functions act on the single default loop.
1704		2088
1705	=item EV_PERIODICS	2089	=item EV_PERIODIC_ENABLE
1706		2090
1707	If undefined or defined to be C<1>, then periodic timers are supported,	2091	If undefined or defined to be C<1>, then periodic timers are supported. If
1708	otherwise not. This saves a few kb of code.	2092	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2093	code.
		2094
		2095	=item EV_EMBED_ENABLE
		2096
		2097	If undefined or defined to be C<1>, then embed watchers are supported. If
		2098	defined to be C<0>, then they are not.
		2099
		2100	=item EV_STAT_ENABLE
		2101
		2102	If undefined or defined to be C<1>, then stat watchers are supported. If
		2103	defined to be C<0>, then they are not.
		2104
		2105	=item EV_FORK_ENABLE
		2106
		2107	If undefined or defined to be C<1>, then fork watchers are supported. If
		2108	defined to be C<0>, then they are not.
		2109
		2110	=item EV_MINIMAL
		2111
		2112	If you need to shave off some kilobytes of code at the expense of some
		2113	speed, define this symbol to C<1>. Currently only used for gcc to override
		2114	some inlining decisions, saves roughly 30% codesize of amd64.
		2115
		2116	=item EV_PID_HASHSIZE
		2117
		2118	C<ev_child> watchers use a small hash table to distribute workload by
		2119	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
		2120	than enough. If you need to manage thousands of children you might want to
		2121	increase this value (I<must> be a power of two).
		2122
		2123	=item EV_INOTIFY_HASHSIZE
		2124
		2125	C<ev_staz> watchers use a small hash table to distribute workload by
		2126	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
		2127	usually more than enough. If you need to manage thousands of C<ev_stat>
		2128	watchers you might want to increase this value (I<must> be a power of
		2129	two).
1709		2130
1710	=item EV_COMMON	2131	=item EV_COMMON
1711		2132
1712	By default, all watchers have a C<void *data> member. By redefining	2133	By default, all watchers have a C<void *data> member. By redefining
1713	this macro to a something else you can include more and other types of	2134	this macro to a something else you can include more and other types of
…		…
1773		2194
1774	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2195	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
1775		2196
1776	=item Stopping check/prepare/idle watchers: O(1)	2197	=item Stopping check/prepare/idle watchers: O(1)
1777		2198
1778	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % 16))	2199	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
1779		2200
1780	=item Finding the next timer per loop iteration: O(1)	2201	=item Finding the next timer per loop iteration: O(1)
1781		2202
1782	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2203	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
1783		2204

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.46 by root, Mon Nov 26 10:20:43 2007 UTC vs. Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.46 by root, Mon Nov 26 10:20:43 2007 UTC vs.
Revision 1.62 by root, Thu Nov 29 17:28:13 2007 UTC