ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.111 by root, Tue Dec 25 18:01:20 2007 UTC vs.
Revision 1.157 by root, Tue May 20 23:49:41 2008 UTC

…		…
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
		11	// a single header file is required
11	#include <ev.h>	12	#include <ev.h>
12		13
		14	// every watcher type has its own typedef'd struct
		15	// with the name ev_<type>
13	ev_io stdin_watcher;	16	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	17	ev_timer timeout_watcher;
15		18
		19	// all watcher callbacks have a similar signature
16	/* called when data readable on stdin */	20	// this callback is called when data is readable on stdin
17	static void	21	static void
18	stdin_cb (EV_P_ struct ev_io *w, int revents)	22	stdin_cb (EV_P_ struct ev_io *w, int revents)
19	{	23	{
20	/* puts ("stdin ready"); */	24	puts ("stdin ready");
21	ev_io_stop (EV_A_ w); /* just a syntax example */	25	// for one-shot events, one must manually stop the watcher
22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */	26	// with its corresponding stop function.
		27	ev_io_stop (EV_A_ w);
		28
		29	// this causes all nested ev_loop's to stop iterating
		30	ev_unloop (EV_A_ EVUNLOOP_ALL);
23	}	31	}
24		32
		33	// another callback, this time for a time-out
25	static void	34	static void
26	timeout_cb (EV_P_ struct ev_timer *w, int revents)	35	timeout_cb (EV_P_ struct ev_timer *w, int revents)
27	{	36	{
28	/* puts ("timeout"); */	37	puts ("timeout");
29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */	38	// this causes the innermost ev_loop to stop iterating
		39	ev_unloop (EV_A_ EVUNLOOP_ONE);
30	}	40	}
31		41
32	int	42	int
33	main (void)	43	main (void)
34	{	44	{
		45	// use the default event loop unless you have special needs
35	struct ev_loop *loop = ev_default_loop (0);	46	struct ev_loop *loop = ev_default_loop (0);
36		47
37	/* initialise an io watcher, then start it */	48	// initialise an io watcher, then start it
		49	// this one will watch for stdin to become readable
38	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	50	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39	ev_io_start (loop, &stdin_watcher);	51	ev_io_start (loop, &stdin_watcher);
40		52
		53	// initialise a timer watcher, then start it
41	/* simple non-repeating 5.5 second timeout */	54	// simple non-repeating 5.5 second timeout
42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43	ev_timer_start (loop, &timeout_watcher);	56	ev_timer_start (loop, &timeout_watcher);
44		57
45	/* loop till timeout or data ready */	58	// now wait for events to arrive
46	ev_loop (loop, 0);	59	ev_loop (loop, 0);
47		60
		61	// unloop was called, so exit
48	return 0;	62	return 0;
49	}	63	}
50		64
51	=head1 DESCRIPTION	65	=head1 DESCRIPTION
52		66
53	The newest version of this document is also available as a html-formatted	67	The newest version of this document is also available as an html-formatted
54	web page you might find easier to navigate when reading it for the first	68	web page you might find easier to navigate when reading it for the first
55	time: L<http://cvs.schmorp.de/libev/ev.html>.	69	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
56		70
57	Libev is an event loop: you register interest in certain events (such as a	71	Libev is an event loop: you register interest in certain events (such as a
58	file descriptor being readable or a timeout occurring), and it will manage	72	file descriptor being readable or a timeout occurring), and it will manage
59	these event sources and provide your program with events.	73	these event sources and provide your program with events.
60		74
…		…
84	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent	98	L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85	for example).	99	for example).
86		100
87	=head2 CONVENTIONS	101	=head2 CONVENTIONS
88		102
89	Libev is very configurable. In this manual the default configuration will	103	Libev is very configurable. In this manual the default (and most common)
90	be described, which supports multiple event loops. For more info about	104	configuration will be described, which supports multiple event loops. For
91	various configuration options please have a look at B<EMBED> section in	105	more info about various configuration options please have a look at
92	this manual. If libev was configured without support for multiple event	106	B<EMBED> section in this manual. If libev was configured without support
93	loops, then all functions taking an initial argument of name C<loop>	107	for multiple event loops, then all functions taking an initial argument of
94	(which is always of type C<struct ev_loop *>) will not have this argument.	108	name C<loop> (which is always of type C<struct ev_loop *>) will not have
		109	this argument.
95		110
96	=head2 TIME REPRESENTATION	111	=head2 TIME REPRESENTATION
97		112
98	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	114	(fractional) number of seconds since the (POSIX) epoch (somewhere near
…		…
181	See the description of C<ev_embed> watchers for more info.	196	See the description of C<ev_embed> watchers for more info.
182		197
183	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	198	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
184		199
185	Sets the allocation function to use (the prototype is similar - the	200	Sets the allocation function to use (the prototype is similar - the
186	semantics is identical - to the realloc C function). It is used to	201	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
187	allocate and free memory (no surprises here). If it returns zero when	202	used to allocate and free memory (no surprises here). If it returns zero
188	memory needs to be allocated, the library might abort or take some	203	when memory needs to be allocated (C<size != 0>), the library might abort
189	potentially destructive action. The default is your system realloc	204	or take some potentially destructive action.
190	function.	205
		206	Since some systems (at least OpenBSD and Darwin) fail to implement
		207	correct C<realloc> semantics, libev will use a wrapper around the system
		208	C<realloc> and C<free> functions by default.
191		209
192	You could override this function in high-availability programs to, say,	210	You could override this function in high-availability programs to, say,
193	free some memory if it cannot allocate memory, to use a special allocator,	211	free some memory if it cannot allocate memory, to use a special allocator,
194	or even to sleep a while and retry until some memory is available.	212	or even to sleep a while and retry until some memory is available.
195		213
196	Example: Replace the libev allocator with one that waits a bit and then	214	Example: Replace the libev allocator with one that waits a bit and then
197	retries).	215	retries (example requires a standards-compliant C<realloc>).
198		216
199	static void *	217	static void *
200	persistent_realloc (void *ptr, size_t size)	218	persistent_realloc (void *ptr, size_t size)
201	{	219	{
202	for (;;)	220	for (;;)
…		…
241		259
242	An event loop is described by a C<struct ev_loop *>. The library knows two	260	An event loop is described by a C<struct ev_loop *>. The library knows two
243	types of such loops, the I<default> loop, which supports signals and child	261	types of such loops, the I<default> loop, which supports signals and child
244	events, and dynamically created loops which do not.	262	events, and dynamically created loops which do not.
245		263
246	If you use threads, a common model is to run the default event loop
247	in your main thread (or in a separate thread) and for each thread you
248	create, you also create another event loop. Libev itself does no locking
249	whatsoever, so if you mix calls to the same event loop in different
250	threads, make sure you lock (this is usually a bad idea, though, even if
251	done correctly, because it's hideous and inefficient).
252
253	=over 4	264	=over 4
254		265
255	=item struct ev_loop *ev_default_loop (unsigned int flags)	266	=item struct ev_loop *ev_default_loop (unsigned int flags)
256		267
257	This will initialise the default event loop if it hasn't been initialised	268	This will initialise the default event loop if it hasn't been initialised
…		…
259	false. If it already was initialised it simply returns it (and ignores the	270	false. If it already was initialised it simply returns it (and ignores the
260	flags. If that is troubling you, check C<ev_backend ()> afterwards).	271	flags. If that is troubling you, check C<ev_backend ()> afterwards).
261		272
262	If you don't know what event loop to use, use the one returned from this	273	If you don't know what event loop to use, use the one returned from this
263	function.	274	function.
		275
		276	Note that this function is I<not> thread-safe, so if you want to use it
		277	from multiple threads, you have to lock (note also that this is unlikely,
		278	as loops cannot bes hared easily between threads anyway).
		279
		280	The default loop is the only loop that can handle C<ev_signal> and
		281	C<ev_child> watchers, and to do this, it always registers a handler
		282	for C<SIGCHLD>. If this is a problem for your app you can either
		283	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
		284	can simply overwrite the C<SIGCHLD> signal handler I<after> calling
		285	C<ev_default_init>.
264		286
265	The flags argument can be used to specify special behaviour or specific	287	The flags argument can be used to specify special behaviour or specific
266	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	288	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
267		289
268	The following flags are supported:	290	The following flags are supported:
…		…
290	enabling this flag.	312	enabling this flag.
291		313
292	This works by calling C<getpid ()> on every iteration of the loop,	314	This works by calling C<getpid ()> on every iteration of the loop,
293	and thus this might slow down your event loop if you do a lot of loop	315	and thus this might slow down your event loop if you do a lot of loop
294	iterations and little real work, but is usually not noticeable (on my	316	iterations and little real work, but is usually not noticeable (on my
295	Linux system for example, C<getpid> is actually a simple 5-insn sequence	317	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
296	without a syscall and thus I<very> fast, but my Linux system also has	318	without a syscall and thus I<very> fast, but my GNU/Linux system also has
297	C<pthread_atfork> which is even faster).	319	C<pthread_atfork> which is even faster).
298		320
299	The big advantage of this flag is that you can forget about fork (and	321	The big advantage of this flag is that you can forget about fork (and
300	forget about forgetting to tell libev about forking) when you use this	322	forget about forgetting to tell libev about forking) when you use this
301	flag.	323	flag.
…		…
314	To get good performance out of this backend you need a high amount of	336	To get good performance out of this backend you need a high amount of
315	parallelity (most of the file descriptors should be busy). If you are	337	parallelity (most of the file descriptors should be busy). If you are
316	writing a server, you should C<accept ()> in a loop to accept as many	338	writing a server, you should C<accept ()> in a loop to accept as many
317	connections as possible during one iteration. You might also want to have	339	connections as possible during one iteration. You might also want to have
318	a look at C<ev_set_io_collect_interval ()> to increase the amount of	340	a look at C<ev_set_io_collect_interval ()> to increase the amount of
319	readyness notifications you get per iteration.	341	readiness notifications you get per iteration.
320		342
321	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)	343	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
322		344
323	And this is your standard poll(2) backend. It's more complicated	345	And this is your standard poll(2) backend. It's more complicated
324	than select, but handles sparse fds better and has no artificial	346	than select, but handles sparse fds better and has no artificial
…		…
332	For few fds, this backend is a bit little slower than poll and select,	354	For few fds, this backend is a bit little slower than poll and select,
333	but it scales phenomenally better. While poll and select usually scale	355	but it scales phenomenally better. While poll and select usually scale
334	like O(total_fds) where n is the total number of fds (or the highest fd),	356	like O(total_fds) where n is the total number of fds (or the highest fd),
335	epoll scales either O(1) or O(active_fds). The epoll design has a number	357	epoll scales either O(1) or O(active_fds). The epoll design has a number
336	of shortcomings, such as silently dropping events in some hard-to-detect	358	of shortcomings, such as silently dropping events in some hard-to-detect
337	cases and rewiring a syscall per fd change, no fork support and bad	359	cases and requiring a syscall per fd change, no fork support and bad
338	support for dup.	360	support for dup.
339		361
340	While stopping, setting and starting an I/O watcher in the same iteration	362	While stopping, setting and starting an I/O watcher in the same iteration
341	will result in some caching, there is still a syscall per such incident	363	will result in some caching, there is still a syscall per such incident
342	(because the fd could point to a different file description now), so its	364	(because the fd could point to a different file description now), so its
…		…
403	While this backend scales well, it requires one system call per active	425	While this backend scales well, it requires one system call per active
404	file descriptor per loop iteration. For small and medium numbers of file	426	file descriptor per loop iteration. For small and medium numbers of file
405	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	427	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
406	might perform better.	428	might perform better.
407		429
		430	On the positive side, ignoring the spurious readiness notifications, this
		431	backend actually performed to specification in all tests and is fully
		432	embeddable, which is a rare feat among the OS-specific backends.
		433
408	=item C<EVBACKEND_ALL>	434	=item C<EVBACKEND_ALL>
409		435
410	Try all backends (even potentially broken ones that wouldn't be tried	436	Try all backends (even potentially broken ones that wouldn't be tried
411	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	437	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
412	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	438	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
…		…
414	It is definitely not recommended to use this flag.	440	It is definitely not recommended to use this flag.
415		441
416	=back	442	=back
417		443
418	If one or more of these are ored into the flags value, then only these	444	If one or more of these are ored into the flags value, then only these
419	backends will be tried (in the reverse order as given here). If none are	445	backends will be tried (in the reverse order as listed here). If none are
420	specified, most compiled-in backend will be tried, usually in reverse	446	specified, all backends in C<ev_recommended_backends ()> will be tried.
421	order of their flag values :)
422		447
423	The most typical usage is like this:	448	The most typical usage is like this:
424		449
425	if (!ev_default_loop (0))	450	if (!ev_default_loop (0))
426	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");	451	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
…		…
440		465
441	Similar to C<ev_default_loop>, but always creates a new event loop that is	466	Similar to C<ev_default_loop>, but always creates a new event loop that is
442	always distinct from the default loop. Unlike the default loop, it cannot	467	always distinct from the default loop. Unlike the default loop, it cannot
443	handle signal and child watchers, and attempts to do so will be greeted by	468	handle signal and child watchers, and attempts to do so will be greeted by
444	undefined behaviour (or a failed assertion if assertions are enabled).	469	undefined behaviour (or a failed assertion if assertions are enabled).
		470
		471	Note that this function I<is> thread-safe, and the recommended way to use
		472	libev with threads is indeed to create one loop per thread, and using the
		473	default loop in the "main" or "initial" thread.
445		474
446	Example: Try to create a event loop that uses epoll and nothing else.	475	Example: Try to create a event loop that uses epoll and nothing else.
447		476
448	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	477	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
449	if (!epoller)	478	if (!epoller)
…		…
473	Like C<ev_default_destroy>, but destroys an event loop created by an	502	Like C<ev_default_destroy>, but destroys an event loop created by an
474	earlier call to C<ev_loop_new>.	503	earlier call to C<ev_loop_new>.
475		504
476	=item ev_default_fork ()	505	=item ev_default_fork ()
477		506
		507	This function sets a flag that causes subsequent C<ev_loop> iterations
478	This function reinitialises the kernel state for backends that have	508	to reinitialise the kernel state for backends that have one. Despite the
479	one. Despite the name, you can call it anytime, but it makes most sense	509	name, you can call it anytime, but it makes most sense after forking, in
480	after forking, in either the parent or child process (or both, but that	510	the child process (or both child and parent, but that again makes little
481	again makes little sense).	511	sense). You I<must> call it in the child before using any of the libev
		512	functions, and it will only take effect at the next C<ev_loop> iteration.
482		513
483	You I<must> call this function in the child process after forking if and	514	On the other hand, you only need to call this function in the child
484	only if you want to use the event library in both processes. If you just	515	process if and only if you want to use the event library in the child. If
485	fork+exec, you don't have to call it.	516	you just fork+exec, you don't have to call it at all.
486		517
487	The function itself is quite fast and it's usually not a problem to call	518	The function itself is quite fast and it's usually not a problem to call
488	it just in case after a fork. To make this easy, the function will fit in	519	it just in case after a fork. To make this easy, the function will fit in
489	quite nicely into a call to C<pthread_atfork>:	520	quite nicely into a call to C<pthread_atfork>:
490		521
491	pthread_atfork (0, 0, ev_default_fork);	522	pthread_atfork (0, 0, ev_default_fork);
492		523
493	At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
494	without calling this function, so if you force one of those backends you
495	do not need to care.
496
497	=item ev_loop_fork (loop)	524	=item ev_loop_fork (loop)
498		525
499	Like C<ev_default_fork>, but acts on an event loop created by	526	Like C<ev_default_fork>, but acts on an event loop created by
500	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	527	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
501	after fork, and how you do this is entirely your own problem.	528	after fork, and how you do this is entirely your own problem.
		529
		530	=item int ev_is_default_loop (loop)
		531
		532	Returns true when the given loop actually is the default loop, false otherwise.
502		533
503	=item unsigned int ev_loop_count (loop)	534	=item unsigned int ev_loop_count (loop)
504		535
505	Returns the count of loop iterations for the loop, which is identical to	536	Returns the count of loop iterations for the loop, which is identical to
506	the number of times libev did poll for new events. It starts at C<0> and	537	the number of times libev did poll for new events. It starts at C<0> and
…		…
551	usually a better approach for this kind of thing.	582	usually a better approach for this kind of thing.
552		583
553	Here are the gory details of what C<ev_loop> does:	584	Here are the gory details of what C<ev_loop> does:
554		585
555	- Before the first iteration, call any pending watchers.	586	- Before the first iteration, call any pending watchers.
556	* If there are no active watchers (reference count is zero), return.	587	* If EVFLAG_FORKCHECK was used, check for a fork.
557	- Queue all prepare watchers and then call all outstanding watchers.	588	- If a fork was detected, queue and call all fork watchers.
		589	- Queue and call all prepare watchers.
558	- If we have been forked, recreate the kernel state.	590	- If we have been forked, recreate the kernel state.
559	- Update the kernel state with all outstanding changes.	591	- Update the kernel state with all outstanding changes.
560	- Update the "event loop time".	592	- Update the "event loop time".
561	- Calculate for how long to block.	593	- Calculate for how long to sleep or block, if at all
		594	(active idle watchers, EVLOOP_NONBLOCK or not having
		595	any active watchers at all will result in not sleeping).
		596	- Sleep if the I/O and timer collect interval say so.
562	- Block the process, waiting for any events.	597	- Block the process, waiting for any events.
563	- Queue all outstanding I/O (fd) events.	598	- Queue all outstanding I/O (fd) events.
564	- Update the "event loop time" and do time jump handling.	599	- Update the "event loop time" and do time jump handling.
565	- Queue all outstanding timers.	600	- Queue all outstanding timers.
566	- Queue all outstanding periodics.	601	- Queue all outstanding periodics.
567	- If no events are pending now, queue all idle watchers.	602	- If no events are pending now, queue all idle watchers.
568	- Queue all check watchers.	603	- Queue all check watchers.
569	- Call all queued watchers in reverse order (i.e. check watchers first).	604	- Call all queued watchers in reverse order (i.e. check watchers first).
570	Signals and child watchers are implemented as I/O watchers, and will	605	Signals and child watchers are implemented as I/O watchers, and will
571	be handled here by queueing them when their watcher gets executed.	606	be handled here by queueing them when their watcher gets executed.
572	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	607	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
573	were used, return, otherwise continue with step *.	608	were used, or there are no active watchers, return, otherwise
		609	continue with step *.
574		610
575	Example: Queue some jobs and then loop until no events are outsanding	611	Example: Queue some jobs and then loop until no events are outstanding
576	anymore.	612	anymore.
577		613
578	... queue jobs here, make sure they register event watchers as long	614	... queue jobs here, make sure they register event watchers as long
579	... as they still have work to do (even an idle watcher will do..)	615	... as they still have work to do (even an idle watcher will do..)
580	ev_loop (my_loop, 0);	616	ev_loop (my_loop, 0);
…		…
584		620
585	Can be used to make a call to C<ev_loop> return early (but only after it	621	Can be used to make a call to C<ev_loop> return early (but only after it
586	has processed all outstanding events). The C<how> argument must be either	622	has processed all outstanding events). The C<how> argument must be either
587	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	623	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
588	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	624	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
		625
		626	This "unloop state" will be cleared when entering C<ev_loop> again.
589		627
590	=item ev_ref (loop)	628	=item ev_ref (loop)
591		629
592	=item ev_unref (loop)	630	=item ev_unref (loop)
593		631
…		…
598	returning, ev_unref() after starting, and ev_ref() before stopping it. For	636	returning, ev_unref() after starting, and ev_ref() before stopping it. For
599	example, libev itself uses this for its internal signal pipe: It is not	637	example, libev itself uses this for its internal signal pipe: It is not
600	visible to the libev user and should not keep C<ev_loop> from exiting if	638	visible to the libev user and should not keep C<ev_loop> from exiting if
601	no event watchers registered by it are active. It is also an excellent	639	no event watchers registered by it are active. It is also an excellent
602	way to do this for generic recurring timers or from within third-party	640	way to do this for generic recurring timers or from within third-party
603	libraries. Just remember to I<unref after start> and I<ref before stop>.	641	libraries. Just remember to I<unref after start> and I<ref before stop>
		642	(but only if the watcher wasn't active before, or was active before,
		643	respectively).
604		644
605	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	645	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
606	running when nothing else is active.	646	running when nothing else is active.
607		647
608	struct ev_signal exitsig;	648	struct ev_signal exitsig;
…		…
756		796
757	=item C<EV_FORK>	797	=item C<EV_FORK>
758		798
759	The event loop has been resumed in the child process after fork (see	799	The event loop has been resumed in the child process after fork (see
760	C<ev_fork>).	800	C<ev_fork>).
		801
		802	=item C<EV_ASYNC>
		803
		804	The given async watcher has been asynchronously notified (see C<ev_async>).
761		805
762	=item C<EV_ERROR>	806	=item C<EV_ERROR>
763		807
764	An unspecified error has occured, the watcher has been stopped. This might	808	An unspecified error has occured, the watcher has been stopped. This might
765	happen because the watcher could not be properly started because libev	809	happen because the watcher could not be properly started because libev
…		…
988	If you must do this, then force the use of a known-to-be-good backend	1032	If you must do this, then force the use of a known-to-be-good backend
989	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	1033	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
990	C<EVBACKEND_POLL>).	1034	C<EVBACKEND_POLL>).
991		1035
992	Another thing you have to watch out for is that it is quite easy to	1036	Another thing you have to watch out for is that it is quite easy to
993	receive "spurious" readyness notifications, that is your callback might	1037	receive "spurious" readiness notifications, that is your callback might
994	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1038	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
995	because there is no data. Not only are some backends known to create a	1039	because there is no data. Not only are some backends known to create a
996	lot of those (for example solaris ports), it is very easy to get into	1040	lot of those (for example solaris ports), it is very easy to get into
997	this situation even with a relatively standard program structure. Thus	1041	this situation even with a relatively standard program structure. Thus
998	it is best to always use non-blocking I/O: An extra C<read>(2) returning	1042	it is best to always use non-blocking I/O: An extra C<read>(2) returning
…		…
1045	To support fork in your programs, you either have to call	1089	To support fork in your programs, you either have to call
1046	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1090	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1047	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1091	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1048	C<EVBACKEND_POLL>.	1092	C<EVBACKEND_POLL>.
1049		1093
		1094	=head3 The special problem of SIGPIPE
		1095
		1096	While not really specific to libev, it is easy to forget about SIGPIPE:
		1097	when reading from a pipe whose other end has been closed, your program
		1098	gets send a SIGPIPE, which, by default, aborts your program. For most
		1099	programs this is sensible behaviour, for daemons, this is usually
		1100	undesirable.
		1101
		1102	So when you encounter spurious, unexplained daemon exits, make sure you
		1103	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1104	somewhere, as that would have given you a big clue).
		1105
1050		1106
1051	=head3 Watcher-Specific Functions	1107	=head3 Watcher-Specific Functions
1052		1108
1053	=over 4	1109	=over 4
1054		1110
…		…
1095		1151
1096	Timer watchers are simple relative timers that generate an event after a	1152	Timer watchers are simple relative timers that generate an event after a
1097	given time, and optionally repeating in regular intervals after that.	1153	given time, and optionally repeating in regular intervals after that.
1098		1154
1099	The timers are based on real time, that is, if you register an event that	1155	The timers are based on real time, that is, if you register an event that
1100	times out after an hour and you reset your system clock to last years	1156	times out after an hour and you reset your system clock to january last
1101	time, it will still time out after (roughly) and hour. "Roughly" because	1157	year, it will still time out after (roughly) and hour. "Roughly" because
1102	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1158	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1103	monotonic clock option helps a lot here).	1159	monotonic clock option helps a lot here).
1104		1160
1105	The relative timeouts are calculated relative to the C<ev_now ()>	1161	The relative timeouts are calculated relative to the C<ev_now ()>
1106	time. This is usually the right thing as this timestamp refers to the time	1162	time. This is usually the right thing as this timestamp refers to the time
…		…
1108	you suspect event processing to be delayed and you I<need> to base the timeout	1164	you suspect event processing to be delayed and you I<need> to base the timeout
1109	on the current time, use something like this to adjust for this:	1165	on the current time, use something like this to adjust for this:
1110		1166
1111	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	1167	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1112		1168
1113	The callback is guarenteed to be invoked only when its timeout has passed,	1169	The callback is guarenteed to be invoked only after its timeout has passed,
1114	but if multiple timers become ready during the same loop iteration then	1170	but if multiple timers become ready during the same loop iteration then
1115	order of execution is undefined.	1171	order of execution is undefined.
1116		1172
1117	=head3 Watcher-Specific Functions and Data Members	1173	=head3 Watcher-Specific Functions and Data Members
1118		1174
…		…
1120		1176
1121	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	1177	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1122		1178
1123	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)	1179	=item ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)
1124		1180
1125	Configure the timer to trigger after C<after> seconds. If C<repeat> is	1181	Configure the timer to trigger after C<after> seconds. If C<repeat>
1126	C<0.>, then it will automatically be stopped. If it is positive, then the	1182	is C<0.>, then it will automatically be stopped once the timeout is
1127	timer will automatically be configured to trigger again C<repeat> seconds	1183	reached. If it is positive, then the timer will automatically be
1128	later, again, and again, until stopped manually.	1184	configured to trigger again C<repeat> seconds later, again, and again,
		1185	until stopped manually.
1129		1186
1130	The timer itself will do a best-effort at avoiding drift, that is, if you	1187	The timer itself will do a best-effort at avoiding drift, that is, if
1131	configure a timer to trigger every 10 seconds, then it will trigger at	1188	you configure a timer to trigger every 10 seconds, then it will normally
1132	exactly 10 second intervals. If, however, your program cannot keep up with	1189	trigger at exactly 10 second intervals. If, however, your program cannot
1133	the timer (because it takes longer than those 10 seconds to do stuff) the	1190	keep up with the timer (because it takes longer than those 10 seconds to
1134	timer will not fire more than once per event loop iteration.	1191	do stuff) the timer will not fire more than once per event loop iteration.
1135		1192
1136	=item ev_timer_again (loop)	1193	=item ev_timer_again (loop, ev_timer *)
1137		1194
1138	This will act as if the timer timed out and restart it again if it is	1195	This will act as if the timer timed out and restart it again if it is
1139	repeating. The exact semantics are:	1196	repeating. The exact semantics are:
1140		1197
1141	If the timer is pending, its pending status is cleared.	1198	If the timer is pending, its pending status is cleared.
…		…
1216	Periodic watchers are also timers of a kind, but they are very versatile	1273	Periodic watchers are also timers of a kind, but they are very versatile
1217	(and unfortunately a bit complex).	1274	(and unfortunately a bit complex).
1218		1275
1219	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1276	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
1220	but on wallclock time (absolute time). You can tell a periodic watcher	1277	but on wallclock time (absolute time). You can tell a periodic watcher
1221	to trigger "at" some specific point in time. For example, if you tell a	1278	to trigger after some specific point in time. For example, if you tell a
1222	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1279	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
1223	+ 10.>) and then reset your system clock to the last year, then it will	1280	+ 10.>, that is, an absolute time not a delay) and then reset your system
		1281	clock to january of the previous year, then it will take more than year
1224	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1282	to trigger the event (unlike an C<ev_timer>, which would still trigger
1225	roughly 10 seconds later).	1283	roughly 10 seconds later as it uses a relative timeout).
1226		1284
1227	They can also be used to implement vastly more complex timers, such as	1285	C<ev_periodic>s can also be used to implement vastly more complex timers,
1228	triggering an event on each midnight, local time or other, complicated,	1286	such as triggering an event on each "midnight, local time", or other
1229	rules.	1287	complicated, rules.
1230		1288
1231	As with timers, the callback is guarenteed to be invoked only when the	1289	As with timers, the callback is guarenteed to be invoked only when the
1232	time (C<at>) has been passed, but if multiple periodic timers become ready	1290	time (C<at>) has passed, but if multiple periodic timers become ready
1233	during the same loop iteration then order of execution is undefined.	1291	during the same loop iteration then order of execution is undefined.
1234		1292
1235	=head3 Watcher-Specific Functions and Data Members	1293	=head3 Watcher-Specific Functions and Data Members
1236		1294
1237	=over 4	1295	=over 4
…		…
1245		1303
1246	=over 4	1304	=over 4
1247		1305
1248	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1306	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1249		1307
1250	In this configuration the watcher triggers an event at the wallclock time	1308	In this configuration the watcher triggers an event after the wallclock
1251	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1309	time C<at> has passed and doesn't repeat. It will not adjust when a time
1252	that is, if it is to be run at January 1st 2011 then it will run when the	1310	jump occurs, that is, if it is to be run at January 1st 2011 then it will
1253	system time reaches or surpasses this time.	1311	run when the system time reaches or surpasses this time.
1254		1312
1255	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1313	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1256		1314
1257	In this mode the watcher will always be scheduled to time out at the next	1315	In this mode the watcher will always be scheduled to time out at the next
1258	C<at + N * interval> time (for some integer N, which can also be negative)	1316	C<at + N * interval> time (for some integer N, which can also be negative)
1259	and then repeat, regardless of any time jumps.	1317	and then repeat, regardless of any time jumps.
1260		1318
1261	This can be used to create timers that do not drift with respect to system	1319	This can be used to create timers that do not drift with respect to system
1262	time:	1320	time, for example, here is a C<ev_periodic> that triggers each hour, on
		1321	the hour:
1263		1322
1264	ev_periodic_set (&periodic, 0., 3600., 0);	1323	ev_periodic_set (&periodic, 0., 3600., 0);
1265		1324
1266	This doesn't mean there will always be 3600 seconds in between triggers,	1325	This doesn't mean there will always be 3600 seconds in between triggers,
1267	but only that the the callback will be called when the system time shows a	1326	but only that the the callback will be called when the system time shows a
…		…
1272	C<ev_periodic> will try to run the callback in this mode at the next possible	1331	C<ev_periodic> will try to run the callback in this mode at the next possible
1273	time where C<time = at (mod interval)>, regardless of any time jumps.	1332	time where C<time = at (mod interval)>, regardless of any time jumps.
1274		1333
1275	For numerical stability it is preferable that the C<at> value is near	1334	For numerical stability it is preferable that the C<at> value is near
1276	C<ev_now ()> (the current time), but there is no range requirement for	1335	C<ev_now ()> (the current time), but there is no range requirement for
1277	this value.	1336	this value, and in fact is often specified as zero.
1278		1337
1279	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1338	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1280		1339
1281	In this mode the values for C<interval> and C<at> are both being	1340	In this mode the values for C<interval> and C<at> are both being
1282	ignored. Instead, each time the periodic watcher gets scheduled, the	1341	ignored. Instead, each time the periodic watcher gets scheduled, the
1283	reschedule callback will be called with the watcher as first, and the	1342	reschedule callback will be called with the watcher as first, and the
1284	current time as second argument.	1343	current time as second argument.
1285		1344
1286	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1345	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1287	ever, or make any event loop modifications>. If you need to stop it,	1346	ever, or make ANY event loop modifications whatsoever>.
1288	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1289	starting an C<ev_prepare> watcher, which is legal).
1290		1347
		1348	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
		1349	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
		1350	only event loop modification you are allowed to do).
		1351
1291	Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w,	1352	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic
1292	ev_tstamp now)>, e.g.:	1353	*w, ev_tstamp now)>, e.g.:
1293		1354
1294	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1355	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
1295	{	1356	{
1296	return now + 60.;	1357	return now + 60.;
1297	}	1358	}
…		…
1299	It must return the next time to trigger, based on the passed time value	1360	It must return the next time to trigger, based on the passed time value
1300	(that is, the lowest time value larger than to the second argument). It	1361	(that is, the lowest time value larger than to the second argument). It
1301	will usually be called just before the callback will be triggered, but	1362	will usually be called just before the callback will be triggered, but
1302	might be called at other times, too.	1363	might be called at other times, too.
1303		1364
1304	NOTE: I<< This callback must always return a time that is later than the	1365	NOTE: I<< This callback must always return a time that is higher than or
1305	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.	1366	equal to the passed C<now> value >>.
1306		1367
1307	This can be used to create very complex timers, such as a timer that	1368	This can be used to create very complex timers, such as a timer that
1308	triggers on each midnight, local time. To do this, you would calculate the	1369	triggers on "next midnight, local time". To do this, you would calculate the
1309	next midnight after C<now> and return the timestamp value for this. How	1370	next midnight after C<now> and return the timestamp value for this. How
1310	you do this is, again, up to you (but it is not trivial, which is the main	1371	you do this is, again, up to you (but it is not trivial, which is the main
1311	reason I omitted it as an example).	1372	reason I omitted it as an example).
1312		1373
1313	=back	1374	=back
…		…
1317	Simply stops and restarts the periodic watcher again. This is only useful	1378	Simply stops and restarts the periodic watcher again. This is only useful
1318	when you changed some parameters or the reschedule callback would return	1379	when you changed some parameters or the reschedule callback would return
1319	a different time than the last time it was called (e.g. in a crond like	1380	a different time than the last time it was called (e.g. in a crond like
1320	program when the crontabs have changed).	1381	program when the crontabs have changed).
1321		1382
		1383	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1384
		1385	When active, returns the absolute time that the watcher is supposed to
		1386	trigger next.
		1387
1322	=item ev_tstamp offset [read-write]	1388	=item ev_tstamp offset [read-write]
1323		1389
1324	When repeating, this contains the offset value, otherwise this is the	1390	When repeating, this contains the offset value, otherwise this is the
1325	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1391	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1326		1392
…		…
1336	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1402	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]
1337		1403
1338	The current reschedule callback, or C<0>, if this functionality is	1404	The current reschedule callback, or C<0>, if this functionality is
1339	switched off. Can be changed any time, but changes only take effect when	1405	switched off. Can be changed any time, but changes only take effect when
1340	the periodic timer fires or C<ev_periodic_again> is being called.	1406	the periodic timer fires or C<ev_periodic_again> is being called.
1341
1342	=item ev_tstamp at [read-only]
1343
1344	When active, contains the absolute time that the watcher is supposed to
1345	trigger next.
1346		1407
1347	=back	1408	=back
1348		1409
1349	=head3 Examples	1410	=head3 Examples
1350		1411
…		…
1394	with the kernel (thus it coexists with your own signal handlers as long	1455	with the kernel (thus it coexists with your own signal handlers as long
1395	as you don't register any with libev). Similarly, when the last signal	1456	as you don't register any with libev). Similarly, when the last signal
1396	watcher for a signal is stopped libev will reset the signal handler to	1457	watcher for a signal is stopped libev will reset the signal handler to
1397	SIG_DFL (regardless of what it was set to before).	1458	SIG_DFL (regardless of what it was set to before).
1398		1459
		1460	If possible and supported, libev will install its handlers with
		1461	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
		1462	interrupted. If you have a problem with syscalls getting interrupted by
		1463	signals you can block all signals in an C<ev_check> watcher and unblock
		1464	them in an C<ev_prepare> watcher.
		1465
1399	=head3 Watcher-Specific Functions and Data Members	1466	=head3 Watcher-Specific Functions and Data Members
1400		1467
1401	=over 4	1468	=over 4
1402		1469
1403	=item ev_signal_init (ev_signal *, callback, int signum)	1470	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
1411		1478
1412	The signal the watcher watches out for.	1479	The signal the watcher watches out for.
1413		1480
1414	=back	1481	=back
1415		1482
		1483	=head3 Examples
		1484
		1485	Example: Try to exit cleanly on SIGINT and SIGTERM.
		1486
		1487	static void
		1488	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
		1489	{
		1490	ev_unloop (loop, EVUNLOOP_ALL);
		1491	}
		1492
		1493	struct ev_signal signal_watcher;
		1494	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1495	ev_signal_start (loop, &sigint_cb);
		1496
1416		1497
1417	=head2 C<ev_child> - watch out for process status changes	1498	=head2 C<ev_child> - watch out for process status changes
1418		1499
1419	Child watchers trigger when your process receives a SIGCHLD in response to	1500	Child watchers trigger when your process receives a SIGCHLD in response to
1420	some child status changes (most typically when a child of yours dies).	1501	some child status changes (most typically when a child of yours dies). It
		1502	is permissible to install a child watcher I<after> the child has been
		1503	forked (which implies it might have already exited), as long as the event
		1504	loop isn't entered (or is continued from a watcher).
		1505
		1506	Only the default event loop is capable of handling signals, and therefore
		1507	you can only rgeister child watchers in the default event loop.
		1508
		1509	=head3 Process Interaction
		1510
		1511	Libev grabs C<SIGCHLD> as soon as the default event loop is
		1512	initialised. This is necessary to guarantee proper behaviour even if
		1513	the first child watcher is started after the child exits. The occurance
		1514	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		1515	synchronously as part of the event loop processing. Libev always reaps all
		1516	children, even ones not watched.
		1517
		1518	=head3 Overriding the Built-In Processing
		1519
		1520	Libev offers no special support for overriding the built-in child
		1521	processing, but if your application collides with libev's default child
		1522	handler, you can override it easily by installing your own handler for
		1523	C<SIGCHLD> after initialising the default loop, and making sure the
		1524	default loop never gets destroyed. You are encouraged, however, to use an
		1525	event-based approach to child reaping and thus use libev's support for
		1526	that, so other libev users can use C<ev_child> watchers freely.
1421		1527
1422	=head3 Watcher-Specific Functions and Data Members	1528	=head3 Watcher-Specific Functions and Data Members
1423		1529
1424	=over 4	1530	=over 4
1425		1531
1426	=item ev_child_init (ev_child *, callback, int pid)	1532	=item ev_child_init (ev_child *, callback, int pid, int trace)
1427		1533
1428	=item ev_child_set (ev_child *, int pid)	1534	=item ev_child_set (ev_child *, int pid, int trace)
1429		1535
1430	Configures the watcher to wait for status changes of process C<pid> (or	1536	Configures the watcher to wait for status changes of process C<pid> (or
1431	I<any> process if C<pid> is specified as C<0>). The callback can look	1537	I<any> process if C<pid> is specified as C<0>). The callback can look
1432	at the C<rstatus> member of the C<ev_child> watcher structure to see	1538	at the C<rstatus> member of the C<ev_child> watcher structure to see
1433	the status word (use the macros from C<sys/wait.h> and see your systems	1539	the status word (use the macros from C<sys/wait.h> and see your systems
1434	C<waitpid> documentation). The C<rpid> member contains the pid of the	1540	C<waitpid> documentation). The C<rpid> member contains the pid of the
1435	process causing the status change.	1541	process causing the status change. C<trace> must be either C<0> (only
		1542	activate the watcher when the process terminates) or C<1> (additionally
		1543	activate the watcher when the process is stopped or continued).
1436		1544
1437	=item int pid [read-only]	1545	=item int pid [read-only]
1438		1546
1439	The process id this watcher watches out for, or C<0>, meaning any process id.	1547	The process id this watcher watches out for, or C<0>, meaning any process id.
1440		1548
…		…
1449		1557
1450	=back	1558	=back
1451		1559
1452	=head3 Examples	1560	=head3 Examples
1453		1561
1454	Example: Try to exit cleanly on SIGINT and SIGTERM.	1562	Example: C<fork()> a new process and install a child handler to wait for
		1563	its completion.
		1564
		1565	ev_child cw;
1455		1566
1456	static void	1567	static void
1457	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1568	child_cb (EV_P_ struct ev_child *w, int revents)
1458	{	1569	{
1459	ev_unloop (loop, EVUNLOOP_ALL);	1570	ev_child_stop (EV_A_ w);
		1571	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1460	}	1572	}
1461		1573
1462	struct ev_signal signal_watcher;	1574	pid_t pid = fork ();
1463	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1575
1464	ev_signal_start (loop, &sigint_cb);	1576	if (pid < 0)
		1577	// error
		1578	else if (pid == 0)
		1579	{
		1580	// the forked child executes here
		1581	exit (1);
		1582	}
		1583	else
		1584	{
		1585	ev_child_init (&cw, child_cb, pid, 0);
		1586	ev_child_start (EV_DEFAULT_ &cw);
		1587	}
1465		1588
1466		1589
1467	=head2 C<ev_stat> - did the file attributes just change?	1590	=head2 C<ev_stat> - did the file attributes just change?
1468		1591
1469	This watches a filesystem path for attribute changes. That is, it calls	1592	This watches a filesystem path for attribute changes. That is, it calls
…		…
1492	as even with OS-supported change notifications, this can be	1615	as even with OS-supported change notifications, this can be
1493	resource-intensive.	1616	resource-intensive.
1494		1617
1495	At the time of this writing, only the Linux inotify interface is	1618	At the time of this writing, only the Linux inotify interface is
1496	implemented (implementing kqueue support is left as an exercise for the	1619	implemented (implementing kqueue support is left as an exercise for the
		1620	reader, note, however, that the author sees no way of implementing ev_stat
1497	reader). Inotify will be used to give hints only and should not change the	1621	semantics with kqueue). Inotify will be used to give hints only and should
1498	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1622	not change the semantics of C<ev_stat> watchers, which means that libev
1499	to fall back to regular polling again even with inotify, but changes are	1623	sometimes needs to fall back to regular polling again even with inotify,
1500	usually detected immediately, and if the file exists there will be no	1624	but changes are usually detected immediately, and if the file exists there
1501	polling.	1625	will be no polling.
		1626
		1627	=head3 ABI Issues (Largefile Support)
		1628
		1629	Libev by default (unless the user overrides this) uses the default
		1630	compilation environment, which means that on systems with optionally
		1631	disabled large file support, you get the 32 bit version of the stat
		1632	structure. When using the library from programs that change the ABI to
		1633	use 64 bit file offsets the programs will fail. In that case you have to
		1634	compile libev with the same flags to get binary compatibility. This is
		1635	obviously the case with any flags that change the ABI, but the problem is
		1636	most noticably with ev_stat and largefile support.
1502		1637
1503	=head3 Inotify	1638	=head3 Inotify
1504		1639
1505	When C<inotify (7)> support has been compiled into libev (generally only	1640	When C<inotify (7)> support has been compiled into libev (generally only
1506	available on Linux) and present at runtime, it will be used to speed up	1641	available on Linux) and present at runtime, it will be used to speed up
1507	change detection where possible. The inotify descriptor will be created lazily	1642	change detection where possible. The inotify descriptor will be created lazily
1508	when the first C<ev_stat> watcher is being started.	1643	when the first C<ev_stat> watcher is being started.
1509		1644
1510	Inotify presense does not change the semantics of C<ev_stat> watchers	1645	Inotify presence does not change the semantics of C<ev_stat> watchers
1511	except that changes might be detected earlier, and in some cases, to avoid	1646	except that changes might be detected earlier, and in some cases, to avoid
1512	making regular C<stat> calls. Even in the presense of inotify support	1647	making regular C<stat> calls. Even in the presence of inotify support
1513	there are many cases where libev has to resort to regular C<stat> polling.	1648	there are many cases where libev has to resort to regular C<stat> polling.
1514		1649
1515	(There is no support for kqueue, as apparently it cannot be used to	1650	(There is no support for kqueue, as apparently it cannot be used to
1516	implement this functionality, due to the requirement of having a file	1651	implement this functionality, due to the requirement of having a file
1517	descriptor open on the object at all times).	1652	descriptor open on the object at all times).
…		…
1520		1655
1521	The C<stat ()> syscall only supports full-second resolution portably, and	1656	The C<stat ()> syscall only supports full-second resolution portably, and
1522	even on systems where the resolution is higher, many filesystems still	1657	even on systems where the resolution is higher, many filesystems still
1523	only support whole seconds.	1658	only support whole seconds.
1524		1659
1525	That means that, if the time is the only thing that changes, you might	1660	That means that, if the time is the only thing that changes, you can
1526	miss updates: on the first update, C<ev_stat> detects a change and calls	1661	easily miss updates: on the first update, C<ev_stat> detects a change and
1527	your callback, which does something. When there is another update within	1662	calls your callback, which does something. When there is another update
1528	the same second, C<ev_stat> will be unable to detect it.	1663	within the same second, C<ev_stat> will be unable to detect it as the stat
		1664	data does not change.
1529		1665
1530	The solution to this is to delay acting on a change for a second (or till	1666	The solution to this is to delay acting on a change for slightly more
1531	the next second boundary), using a roughly one-second delay C<ev_timer>	1667	than a second (or till slightly after the next full second boundary), using
1532	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	1668	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1533	is added to work around small timing inconsistencies of some operating	1669	ev_timer_again (loop, w)>).
1534	systems.	1670
		1671	The C<.02> offset is added to work around small timing inconsistencies
		1672	of some operating systems (where the second counter of the current time
		1673	might be be delayed. One such system is the Linux kernel, where a call to
		1674	C<gettimeofday> might return a timestamp with a full second later than
		1675	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		1676	update file times then there will be a small window where the kernel uses
		1677	the previous second to update file times but libev might already execute
		1678	the timer callback).
1535		1679
1536	=head3 Watcher-Specific Functions and Data Members	1680	=head3 Watcher-Specific Functions and Data Members
1537		1681
1538	=over 4	1682	=over 4
1539		1683
…		…
1545	C<path>. The C<interval> is a hint on how quickly a change is expected to	1689	C<path>. The C<interval> is a hint on how quickly a change is expected to
1546	be detected and should normally be specified as C<0> to let libev choose	1690	be detected and should normally be specified as C<0> to let libev choose
1547	a suitable value. The memory pointed to by C<path> must point to the same	1691	a suitable value. The memory pointed to by C<path> must point to the same
1548	path for as long as the watcher is active.	1692	path for as long as the watcher is active.
1549		1693
1550	The callback will be receive C<EV_STAT> when a change was detected,	1694	The callback will receive C<EV_STAT> when a change was detected, relative
1551	relative to the attributes at the time the watcher was started (or the	1695	to the attributes at the time the watcher was started (or the last change
1552	last change was detected).	1696	was detected).
1553		1697
1554	=item ev_stat_stat (ev_stat *)	1698	=item ev_stat_stat (loop, ev_stat *)
1555		1699
1556	Updates the stat buffer immediately with new values. If you change the	1700	Updates the stat buffer immediately with new values. If you change the
1557	watched path in your callback, you could call this fucntion to avoid	1701	watched path in your callback, you could call this function to avoid
1558	detecting this change (while introducing a race condition). Can also be	1702	detecting this change (while introducing a race condition if you are not
1559	useful simply to find out the new values.	1703	the only one changing the path). Can also be useful simply to find out the
		1704	new values.
1560		1705
1561	=item ev_statdata attr [read-only]	1706	=item ev_statdata attr [read-only]
1562		1707
1563	The most-recently detected attributes of the file. Although the type is of	1708	The most-recently detected attributes of the file. Although the type is
1564	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	1709	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1565	suitable for your system. If the C<st_nlink> member is C<0>, then there	1710	suitable for your system, but you can only rely on the POSIX-standardised
		1711	members to be present. If the C<st_nlink> member is C<0>, then there was
1566	was some error while C<stat>ing the file.	1712	some error while C<stat>ing the file.
1567		1713
1568	=item ev_statdata prev [read-only]	1714	=item ev_statdata prev [read-only]
1569		1715
1570	The previous attributes of the file. The callback gets invoked whenever	1716	The previous attributes of the file. The callback gets invoked whenever
1571	C<prev> != C<attr>.	1717	C<prev> != C<attr>, or, more precisely, one or more of these members
		1718	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		1719	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1572		1720
1573	=item ev_tstamp interval [read-only]	1721	=item ev_tstamp interval [read-only]
1574		1722
1575	The specified interval.	1723	The specified interval.
1576		1724
…		…
1630	}	1778	}
1631		1779
1632	...	1780	...
1633	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	1781	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1634	ev_stat_start (loop, &passwd);	1782	ev_stat_start (loop, &passwd);
1635	ev_timer_init (&timer, timer_cb, 0., 1.01);	1783	ev_timer_init (&timer, timer_cb, 0., 1.02);
1636		1784
1637		1785
1638	=head2 C<ev_idle> - when you've got nothing better to do...	1786	=head2 C<ev_idle> - when you've got nothing better to do...
1639		1787
1640	Idle watchers trigger events when no other events of the same or higher	1788	Idle watchers trigger events when no other events of the same or higher
…		…
1676	static void	1824	static void
1677	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	1825	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1678	{	1826	{
1679	free (w);	1827	free (w);
1680	// now do something you wanted to do when the program has	1828	// now do something you wanted to do when the program has
1681	// no longer asnything immediate to do.	1829	// no longer anything immediate to do.
1682	}	1830	}
1683		1831
1684	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	1832	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1685	ev_idle_init (idle_watcher, idle_cb);	1833	ev_idle_init (idle_watcher, idle_cb);
1686	ev_idle_start (loop, idle_cb);	1834	ev_idle_start (loop, idle_cb);
…		…
1728		1876
1729	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	1877	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1730	priority, to ensure that they are being run before any other watchers	1878	priority, to ensure that they are being run before any other watchers
1731	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	1879	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1732	too) should not activate ("feed") events into libev. While libev fully	1880	too) should not activate ("feed") events into libev. While libev fully
1733	supports this, they will be called before other C<ev_check> watchers	1881	supports this, they might get executed before other C<ev_check> watchers
1734	did their job. As C<ev_check> watchers are often used to embed other	1882	did their job. As C<ev_check> watchers are often used to embed other
1735	(non-libev) event loops those other event loops might be in an unusable	1883	(non-libev) event loops those other event loops might be in an unusable
1736	state until their C<ev_check> watcher ran (always remind yourself to	1884	state until their C<ev_check> watcher ran (always remind yourself to
1737	coexist peacefully with others).	1885	coexist peacefully with others).
1738		1886
…		…
1753	=head3 Examples	1901	=head3 Examples
1754		1902
1755	There are a number of principal ways to embed other event loops or modules	1903	There are a number of principal ways to embed other event loops or modules
1756	into libev. Here are some ideas on how to include libadns into libev	1904	into libev. Here are some ideas on how to include libadns into libev
1757	(there is a Perl module named C<EV::ADNS> that does this, which you could	1905	(there is a Perl module named C<EV::ADNS> that does this, which you could
1758	use for an actually working example. Another Perl module named C<EV::Glib>	1906	use as a working example. Another Perl module named C<EV::Glib> embeds a
1759	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	1907	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1760	into the Glib event loop).	1908	Glib event loop).
1761		1909
1762	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	1910	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1763	and in a check watcher, destroy them and call into libadns. What follows	1911	and in a check watcher, destroy them and call into libadns. What follows
1764	is pseudo-code only of course. This requires you to either use a low	1912	is pseudo-code only of course. This requires you to either use a low
1765	priority for the check watcher or use C<ev_clear_pending> explicitly, as	1913	priority for the check watcher or use C<ev_clear_pending> explicitly, as
…		…
2027	believe me.	2175	believe me.
2028		2176
2029	=back	2177	=back
2030		2178
2031		2179
		2180	=head2 C<ev_async> - how to wake up another event loop
		2181
		2182	In general, you cannot use an C<ev_loop> from multiple threads or other
		2183	asynchronous sources such as signal handlers (as opposed to multiple event
		2184	loops - those are of course safe to use in different threads).
		2185
		2186	Sometimes, however, you need to wake up another event loop you do not
		2187	control, for example because it belongs to another thread. This is what
		2188	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2189	can signal it by calling C<ev_async_send>, which is thread- and signal
		2190	safe.
		2191
		2192	This functionality is very similar to C<ev_signal> watchers, as signals,
		2193	too, are asynchronous in nature, and signals, too, will be compressed
		2194	(i.e. the number of callback invocations may be less than the number of
		2195	C<ev_async_sent> calls).
		2196
		2197	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2198	just the default loop.
		2199
		2200	=head3 Queueing
		2201
		2202	C<ev_async> does not support queueing of data in any way. The reason
		2203	is that the author does not know of a simple (or any) algorithm for a
		2204	multiple-writer-single-reader queue that works in all cases and doesn't
		2205	need elaborate support such as pthreads.
		2206
		2207	That means that if you want to queue data, you have to provide your own
		2208	queue. But at least I can tell you would implement locking around your
		2209	queue:
		2210
		2211	=over 4
		2212
		2213	=item queueing from a signal handler context
		2214
		2215	To implement race-free queueing, you simply add to the queue in the signal
		2216	handler but you block the signal handler in the watcher callback. Here is an example that does that for
		2217	some fictitiuous SIGUSR1 handler:
		2218
		2219	static ev_async mysig;
		2220
		2221	static void
		2222	sigusr1_handler (void)
		2223	{
		2224	sometype data;
		2225
		2226	// no locking etc.
		2227	queue_put (data);
		2228	ev_async_send (EV_DEFAULT_ &mysig);
		2229	}
		2230
		2231	static void
		2232	mysig_cb (EV_P_ ev_async *w, int revents)
		2233	{
		2234	sometype data;
		2235	sigset_t block, prev;
		2236
		2237	sigemptyset (&block);
		2238	sigaddset (&block, SIGUSR1);
		2239	sigprocmask (SIG_BLOCK, &block, &prev);
		2240
		2241	while (queue_get (&data))
		2242	process (data);
		2243
		2244	if (sigismember (&prev, SIGUSR1)
		2245	sigprocmask (SIG_UNBLOCK, &block, 0);
		2246	}
		2247
		2248	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2249	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2250	either...).
		2251
		2252	=item queueing from a thread context
		2253
		2254	The strategy for threads is different, as you cannot (easily) block
		2255	threads but you can easily preempt them, so to queue safely you need to
		2256	employ a traditional mutex lock, such as in this pthread example:
		2257
		2258	static ev_async mysig;
		2259	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2260
		2261	static void
		2262	otherthread (void)
		2263	{
		2264	// only need to lock the actual queueing operation
		2265	pthread_mutex_lock (&mymutex);
		2266	queue_put (data);
		2267	pthread_mutex_unlock (&mymutex);
		2268
		2269	ev_async_send (EV_DEFAULT_ &mysig);
		2270	}
		2271
		2272	static void
		2273	mysig_cb (EV_P_ ev_async *w, int revents)
		2274	{
		2275	pthread_mutex_lock (&mymutex);
		2276
		2277	while (queue_get (&data))
		2278	process (data);
		2279
		2280	pthread_mutex_unlock (&mymutex);
		2281	}
		2282
		2283	=back
		2284
		2285
		2286	=head3 Watcher-Specific Functions and Data Members
		2287
		2288	=over 4
		2289
		2290	=item ev_async_init (ev_async *, callback)
		2291
		2292	Initialises and configures the async watcher - it has no parameters of any
		2293	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
		2294	believe me.
		2295
		2296	=item ev_async_send (loop, ev_async *)
		2297
		2298	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		2299	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		2300	C<ev_feed_event>, this call is safe to do in other threads, signal or
		2301	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
		2302	section below on what exactly this means).
		2303
		2304	This call incurs the overhead of a syscall only once per loop iteration,
		2305	so while the overhead might be noticable, it doesn't apply to repeated
		2306	calls to C<ev_async_send>.
		2307
		2308	=item bool = ev_async_pending (ev_async *)
		2309
		2310	Returns a non-zero value when C<ev_async_send> has been called on the
		2311	watcher but the event has not yet been processed (or even noted) by the
		2312	event loop.
		2313
		2314	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2315	the loop iterates next and checks for the watcher to have become active,
		2316	it will reset the flag again. C<ev_async_pending> can be used to very
		2317	quickly check wether invoking the loop might be a good idea.
		2318
		2319	Not that this does I<not> check wether the watcher itself is pending, only
		2320	wether it has been requested to make this watcher pending.
		2321
		2322	=back
		2323
		2324
2032	=head1 OTHER FUNCTIONS	2325	=head1 OTHER FUNCTIONS
2033		2326
2034	There are some other functions of possible interest. Described. Here. Now.	2327	There are some other functions of possible interest. Described. Here. Now.
2035		2328
2036	=over 4	2329	=over 4
…		…
2104		2397
2105	=item * Priorities are not currently supported. Initialising priorities	2398	=item * Priorities are not currently supported. Initialising priorities
2106	will fail and all watchers will have the same priority, even though there	2399	will fail and all watchers will have the same priority, even though there
2107	is an ev_pri field.	2400	is an ev_pri field.
2108		2401
		2402	=item * In libevent, the last base created gets the signals, in libev, the
		2403	first base created (== the default loop) gets the signals.
		2404
2109	=item * Other members are not supported.	2405	=item * Other members are not supported.
2110		2406
2111	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2407	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2112	to use the libev header file and library.	2408	to use the libev header file and library.
2113		2409
…		…
2263	Example: Define a class with an IO and idle watcher, start one of them in	2559	Example: Define a class with an IO and idle watcher, start one of them in
2264	the constructor.	2560	the constructor.
2265		2561
2266	class myclass	2562	class myclass
2267	{	2563	{
2268	ev_io io; void io_cb (ev::io &w, int revents);	2564	ev::io io; void io_cb (ev::io &w, int revents);
2269	ev_idle idle void idle_cb (ev::idle &w, int revents);	2565	ev:idle idle void idle_cb (ev::idle &w, int revents);
2270		2566
2271	myclass ();	2567	myclass (int fd)
2272	}
2273
2274	myclass::myclass (int fd)
2275	{	2568	{
2276	io .set <myclass, &myclass::io_cb > (this);	2569	io .set <myclass, &myclass::io_cb > (this);
2277	idle.set <myclass, &myclass::idle_cb> (this);	2570	idle.set <myclass, &myclass::idle_cb> (this);
2278		2571
2279	io.start (fd, ev::READ);	2572	io.start (fd, ev::READ);
		2573	}
2280	}	2574	};
		2575
		2576
		2577	=head1 OTHER LANGUAGE BINDINGS
		2578
		2579	Libev does not offer other language bindings itself, but bindings for a
		2580	numbe rof languages exist in the form of third-party packages. If you know
		2581	any interesting language binding in addition to the ones listed here, drop
		2582	me a note.
		2583
		2584	=over 4
		2585
		2586	=item Perl
		2587
		2588	The EV module implements the full libev API and is actually used to test
		2589	libev. EV is developed together with libev. Apart from the EV core module,
		2590	there are additional modules that implement libev-compatible interfaces
		2591	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
		2592	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
		2593
		2594	It can be found and installed via CPAN, its homepage is found at
		2595	L<http://software.schmorp.de/pkg/EV>.
		2596
		2597	=item Ruby
		2598
		2599	Tony Arcieri has written a ruby extension that offers access to a subset
		2600	of the libev API and adds filehandle abstractions, asynchronous DNS and
		2601	more on top of it. It can be found via gem servers. Its homepage is at
		2602	L<http://rev.rubyforge.org/>.
		2603
		2604	=item D
		2605
		2606	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		2607	be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
		2608
		2609	=back
2281		2610
2282		2611
2283	=head1 MACRO MAGIC	2612	=head1 MACRO MAGIC
2284		2613
2285	Libev can be compiled with a variety of options, the most fundamantal	2614	Libev can be compiled with a variety of options, the most fundamantal
…		…
2321		2650
2322	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	2651	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2323		2652
2324	Similar to the other two macros, this gives you the value of the default	2653	Similar to the other two macros, this gives you the value of the default
2325	loop, if multiple loops are supported ("ev loop default").	2654	loop, if multiple loops are supported ("ev loop default").
		2655
		2656	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		2657
		2658	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		2659	default loop has been initialised (C<UC> == unchecked). Their behaviour
		2660	is undefined when the default loop has not been initialised by a previous
		2661	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		2662
		2663	It is often prudent to use C<EV_DEFAULT> when initialising the first
		2664	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2326		2665
2327	=back	2666	=back
2328		2667
2329	Example: Declare and initialise a check watcher, utilising the above	2668	Example: Declare and initialise a check watcher, utilising the above
2330	macros so it will work regardless of whether multiple loops are supported	2669	macros so it will work regardless of whether multiple loops are supported
…		…
2426		2765
2427	libev.m4	2766	libev.m4
2428		2767
2429	=head2 PREPROCESSOR SYMBOLS/MACROS	2768	=head2 PREPROCESSOR SYMBOLS/MACROS
2430		2769
2431	Libev can be configured via a variety of preprocessor symbols you have to define	2770	Libev can be configured via a variety of preprocessor symbols you have to
2432	before including any of its files. The default is not to build for multiplicity	2771	define before including any of its files. The default in the absense of
2433	and only include the select backend.	2772	autoconf is noted for every option.
2434		2773
2435	=over 4	2774	=over 4
2436		2775
2437	=item EV_STANDALONE	2776	=item EV_STANDALONE
2438		2777
…		…
2464	=item EV_USE_NANOSLEEP	2803	=item EV_USE_NANOSLEEP
2465		2804
2466	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	2805	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2467	and will use it for delays. Otherwise it will use C<select ()>.	2806	and will use it for delays. Otherwise it will use C<select ()>.
2468		2807
		2808	=item EV_USE_EVENTFD
		2809
		2810	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		2811	available and will probe for kernel support at runtime. This will improve
		2812	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		2813	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		2814	2.7 or newer, otherwise disabled.
		2815
2469	=item EV_USE_SELECT	2816	=item EV_USE_SELECT
2470		2817
2471	If undefined or defined to be C<1>, libev will compile in support for the	2818	If undefined or defined to be C<1>, libev will compile in support for the
2472	C<select>(2) backend. No attempt at autodetection will be done: if no	2819	C<select>(2) backend. No attempt at autodetection will be done: if no
2473	other method takes over, select will be it. Otherwise the select backend	2820	other method takes over, select will be it. Otherwise the select backend
…		…
2491	be used is the winsock select). This means that it will call	2838	be used is the winsock select). This means that it will call
2492	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,	2839	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2493	it is assumed that all these functions actually work on fds, even	2840	it is assumed that all these functions actually work on fds, even
2494	on win32. Should not be defined on non-win32 platforms.	2841	on win32. Should not be defined on non-win32 platforms.
2495		2842
		2843	=item EV_FD_TO_WIN32_HANDLE
		2844
		2845	If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
		2846	file descriptors to socket handles. When not defining this symbol (the
		2847	default), then libev will call C<_get_osfhandle>, which is usually
		2848	correct. In some cases, programs use their own file descriptor management,
		2849	in which case they can provide this function to map fds to socket handles.
		2850
2496	=item EV_USE_POLL	2851	=item EV_USE_POLL
2497		2852
2498	If defined to be C<1>, libev will compile in support for the C<poll>(2)	2853	If defined to be C<1>, libev will compile in support for the C<poll>(2)
2499	backend. Otherwise it will be enabled on non-win32 platforms. It	2854	backend. Otherwise it will be enabled on non-win32 platforms. It
2500	takes precedence over select.	2855	takes precedence over select.
2501		2856
2502	=item EV_USE_EPOLL	2857	=item EV_USE_EPOLL
2503		2858
2504	If defined to be C<1>, libev will compile in support for the Linux	2859	If defined to be C<1>, libev will compile in support for the Linux
2505	C<epoll>(7) backend. Its availability will be detected at runtime,	2860	C<epoll>(7) backend. Its availability will be detected at runtime,
2506	otherwise another method will be used as fallback. This is the	2861	otherwise another method will be used as fallback. This is the preferred
2507	preferred backend for GNU/Linux systems.	2862	backend for GNU/Linux systems. If undefined, it will be enabled if the
		2863	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2508		2864
2509	=item EV_USE_KQUEUE	2865	=item EV_USE_KQUEUE
2510		2866
2511	If defined to be C<1>, libev will compile in support for the BSD style	2867	If defined to be C<1>, libev will compile in support for the BSD style
2512	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	2868	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2531		2887
2532	=item EV_USE_INOTIFY	2888	=item EV_USE_INOTIFY
2533		2889
2534	If defined to be C<1>, libev will compile in support for the Linux inotify	2890	If defined to be C<1>, libev will compile in support for the Linux inotify
2535	interface to speed up C<ev_stat> watchers. Its actual availability will	2891	interface to speed up C<ev_stat> watchers. Its actual availability will
2536	be detected at runtime.	2892	be detected at runtime. If undefined, it will be enabled if the headers
		2893	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		2894
		2895	=item EV_ATOMIC_T
		2896
		2897	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		2898	access is atomic with respect to other threads or signal contexts. No such
		2899	type is easily found in the C language, so you can provide your own type
		2900	that you know is safe for your purposes. It is used both for signal handler "locking"
		2901	as well as for signal and thread safety in C<ev_async> watchers.
		2902
		2903	In the absense of this define, libev will use C<sig_atomic_t volatile>
		2904	(from F<signal.h>), which is usually good enough on most platforms.
2537		2905
2538	=item EV_H	2906	=item EV_H
2539		2907
2540	The name of the F<ev.h> header file used to include it. The default if	2908	The name of the F<ev.h> header file used to include it. The default if
2541	undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to	2909	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2542	virtually rename the F<ev.h> header file in case of conflicts.	2910	used to virtually rename the F<ev.h> header file in case of conflicts.
2543		2911
2544	=item EV_CONFIG_H	2912	=item EV_CONFIG_H
2545		2913
2546	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	2914	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2547	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	2915	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2548	C<EV_H>, above.	2916	C<EV_H>, above.
2549		2917
2550	=item EV_EVENT_H	2918	=item EV_EVENT_H
2551		2919
2552	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	2920	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2553	of how the F<event.h> header can be found, the dfeault is C<"event.h">.	2921	of how the F<event.h> header can be found, the default is C<"event.h">.
2554		2922
2555	=item EV_PROTOTYPES	2923	=item EV_PROTOTYPES
2556		2924
2557	If defined to be C<0>, then F<ev.h> will not define any function	2925	If defined to be C<0>, then F<ev.h> will not define any function
2558	prototypes, but still define all the structs and other symbols. This is	2926	prototypes, but still define all the structs and other symbols. This is
…		…
2609	=item EV_FORK_ENABLE	2977	=item EV_FORK_ENABLE
2610		2978
2611	If undefined or defined to be C<1>, then fork watchers are supported. If	2979	If undefined or defined to be C<1>, then fork watchers are supported. If
2612	defined to be C<0>, then they are not.	2980	defined to be C<0>, then they are not.
2613		2981
		2982	=item EV_ASYNC_ENABLE
		2983
		2984	If undefined or defined to be C<1>, then async watchers are supported. If
		2985	defined to be C<0>, then they are not.
		2986
2614	=item EV_MINIMAL	2987	=item EV_MINIMAL
2615		2988
2616	If you need to shave off some kilobytes of code at the expense of some	2989	If you need to shave off some kilobytes of code at the expense of some
2617	speed, define this symbol to C<1>. Currently only used for gcc to override	2990	speed, define this symbol to C<1>. Currently this is used to override some
2618	some inlining decisions, saves roughly 30% codesize of amd64.	2991	inlining decisions, saves roughly 30% codesize of amd64. It also selects a
		2992	much smaller 2-heap for timer management over the default 4-heap.
2619		2993
2620	=item EV_PID_HASHSIZE	2994	=item EV_PID_HASHSIZE
2621		2995
2622	C<ev_child> watchers use a small hash table to distribute workload by	2996	C<ev_child> watchers use a small hash table to distribute workload by
2623	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	2997	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2629	C<ev_stat> watchers use a small hash table to distribute workload by	3003	C<ev_stat> watchers use a small hash table to distribute workload by
2630	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	3004	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2631	usually more than enough. If you need to manage thousands of C<ev_stat>	3005	usually more than enough. If you need to manage thousands of C<ev_stat>
2632	watchers you might want to increase this value (I<must> be a power of	3006	watchers you might want to increase this value (I<must> be a power of
2633	two).	3007	two).
		3008
		3009	=item EV_USE_4HEAP
		3010
		3011	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3012	timer and periodics heap, libev uses a 4-heap when this symbol is defined
		3013	to C<1>. The 4-heap uses more complicated (longer) code but has
		3014	noticably faster performance with many (thousands) of watchers.
		3015
		3016	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3017	(disabled).
		3018
		3019	=item EV_HEAP_CACHE_AT
		3020
		3021	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3022	timer and periodics heap, libev can cache the timestamp (I<at>) within
		3023	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3024	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3025	but avoids random read accesses on heap changes. This improves performance
		3026	noticably with with many (hundreds) of watchers.
		3027
		3028	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3029	(disabled).
2634		3030
2635	=item EV_COMMON	3031	=item EV_COMMON
2636		3032
2637	By default, all watchers have a C<void *data> member. By redefining	3033	By default, all watchers have a C<void *data> member. By redefining
2638	this macro to a something else you can include more and other types of	3034	this macro to a something else you can include more and other types of
…		…
2712		3108
2713	#include "ev_cpp.h"	3109	#include "ev_cpp.h"
2714	#include "ev.c"	3110	#include "ev.c"
2715		3111
2716		3112
		3113	=head1 THREADS AND COROUTINES
		3114
		3115	=head2 THREADS
		3116
		3117	Libev itself is completely threadsafe, but it uses no locking. This
		3118	means that you can use as many loops as you want in parallel, as long as
		3119	only one thread ever calls into one libev function with the same loop
		3120	parameter.
		3121
		3122	Or put differently: calls with different loop parameters can be done in
		3123	parallel from multiple threads, calls with the same loop parameter must be
		3124	done serially (but can be done from different threads, as long as only one
		3125	thread ever is inside a call at any point in time, e.g. by using a mutex
		3126	per loop).
		3127
		3128	If you want to know which design is best for your problem, then I cannot
		3129	help you but by giving some generic advice:
		3130
		3131	=over 4
		3132
		3133	=item * most applications have a main thread: use the default libev loop
		3134	in that thread, or create a seperate thread running only the default loop.
		3135
		3136	This helps integrating other libraries or software modules that use libev
		3137	themselves and don't care/know about threading.
		3138
		3139	=item * one loop per thread is usually a good model.
		3140
		3141	Doing this is almost never wrong, sometimes a better-performance model
		3142	exists, but it is always a good start.
		3143
		3144	=item * other models exist, such as the leader/follower pattern, where one
		3145	loop is handed through multiple threads in a kind of round-robbin fashion.
		3146
		3147	Chosing a model is hard - look around, learn, know that usually you cna do
		3148	better than you currently do :-)
		3149
		3150	=item * often you need to talk to some other thread which blocks in the
		3151	event loop - C<ev_async> watchers can be used to wake them up from other
		3152	threads safely (or from signal contexts...).
		3153
		3154	=back
		3155
		3156	=head2 COROUTINES
		3157
		3158	Libev is much more accomodating to coroutines ("cooperative threads"):
		3159	libev fully supports nesting calls to it's functions from different
		3160	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3161	different coroutines and switch freely between both coroutines running the
		3162	loop, as long as you don't confuse yourself). The only exception is that
		3163	you must not do this from C<ev_periodic> reschedule callbacks.
		3164
		3165	Care has been invested into making sure that libev does not keep local
		3166	state inside C<ev_loop>, and other calls do not usually allow coroutine
		3167	switches.
		3168
		3169
2717	=head1 COMPLEXITIES	3170	=head1 COMPLEXITIES
2718		3171
2719	In this section the complexities of (many of) the algorithms used inside	3172	In this section the complexities of (many of) the algorithms used inside
2720	libev will be explained. For complexity discussions about backends see the	3173	libev will be explained. For complexity discussions about backends see the
2721	documentation for C<ev_default_init>.	3174	documentation for C<ev_default_init>.
…		…
2737	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3190	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2738		3191
2739	That means that changing a timer costs less than removing/adding them	3192	That means that changing a timer costs less than removing/adding them
2740	as only the relative motion in the event queue has to be paid for.	3193	as only the relative motion in the event queue has to be paid for.
2741		3194
2742	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	3195	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2743		3196
2744	These just add the watcher into an array or at the head of a list.	3197	These just add the watcher into an array or at the head of a list.
2745		3198
2746	=item Stopping check/prepare/idle watchers: O(1)	3199	=item Stopping check/prepare/idle/fork/async watchers: O(1)
2747		3200
2748	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3201	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2749		3202
2750	These watchers are stored in lists then need to be walked to find the	3203	These watchers are stored in lists then need to be walked to find the
2751	correct watcher to remove. The lists are usually short (you don't usually	3204	correct watcher to remove. The lists are usually short (you don't usually
2752	have many watchers waiting for the same fd or signal).	3205	have many watchers waiting for the same fd or signal).
2753		3206
2754	=item Finding the next timer in each loop iteration: O(1)	3207	=item Finding the next timer in each loop iteration: O(1)
2755		3208
2756	By virtue of using a binary heap, the next timer is always found at the	3209	By virtue of using a binary or 4-heap, the next timer is always found at a
2757	beginning of the storage array.	3210	fixed position in the storage array.
2758		3211
2759	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3212	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2760		3213
2761	A change means an I/O watcher gets started or stopped, which requires	3214	A change means an I/O watcher gets started or stopped, which requires
2762	libev to recalculate its status (and possibly tell the kernel, depending	3215	libev to recalculate its status (and possibly tell the kernel, depending
…		…
2767	=item Priority handling: O(number_of_priorities)	3220	=item Priority handling: O(number_of_priorities)
2768		3221
2769	Priorities are implemented by allocating some space for each	3222	Priorities are implemented by allocating some space for each
2770	priority. When doing priority-based operations, libev usually has to	3223	priority. When doing priority-based operations, libev usually has to
2771	linearly search all the priorities, but starting/stopping and activating	3224	linearly search all the priorities, but starting/stopping and activating
2772	watchers becomes O(1) w.r.t. prioritiy handling.	3225	watchers becomes O(1) w.r.t. priority handling.
		3226
		3227	=item Sending an ev_async: O(1)
		3228
		3229	=item Processing ev_async_send: O(number_of_async_watchers)
		3230
		3231	=item Processing signals: O(max_signal_number)
		3232
		3233	Sending involves a syscall I<iff> there were no other C<ev_async_send>
		3234	calls in the current loop iteration. Checking for async and signal events
		3235	involves iterating over all running async watchers or all signal numbers.
2773		3236
2774	=back	3237	=back
2775		3238
2776		3239
		3240	=head1 Win32 platform limitations and workarounds
		3241
		3242	Win32 doesn't support any of the standards (e.g. POSIX) that libev
		3243	requires, and its I/O model is fundamentally incompatible with the POSIX
		3244	model. Libev still offers limited functionality on this platform in
		3245	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
		3246	descriptors. This only applies when using Win32 natively, not when using
		3247	e.g. cygwin.
		3248
		3249	Lifting these limitations would basically require the full
		3250	re-implementation of the I/O system. If you are into these kinds of
		3251	things, then note that glib does exactly that for you in a very portable
		3252	way (note also that glib is the slowest event library known to man).
		3253
		3254	There is no supported compilation method available on windows except
		3255	embedding it into other applications.
		3256
		3257	Due to the many, low, and arbitrary limits on the win32 platform and
		3258	the abysmal performance of winsockets, using a large number of sockets
		3259	is not recommended (and not reasonable). If your program needs to use
		3260	more than a hundred or so sockets, then likely it needs to use a totally
		3261	different implementation for windows, as libev offers the POSIX readiness
		3262	notification model, which cannot be implemented efficiently on windows
		3263	(microsoft monopoly games).
		3264
		3265	=over 4
		3266
		3267	=item The winsocket select function
		3268
		3269	The winsocket C<select> function doesn't follow POSIX in that it requires
		3270	socket I<handles> and not socket I<file descriptors>. This makes select
		3271	very inefficient, and also requires a mapping from file descriptors
		3272	to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
		3273	C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
		3274	symbols for more info.
		3275
		3276	The configuration for a "naked" win32 using the microsoft runtime
		3277	libraries and raw winsocket select is:
		3278
		3279	#define EV_USE_SELECT 1
		3280	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
		3281
		3282	Note that winsockets handling of fd sets is O(n), so you can easily get a
		3283	complexity in the O(n²) range when using win32.
		3284
		3285	=item Limited number of file descriptors
		3286
		3287	Windows has numerous arbitrary (and low) limits on things.
		3288
		3289	Early versions of winsocket's select only supported waiting for a maximum
		3290	of C<64> handles (probably owning to the fact that all windows kernels
		3291	can only wait for C<64> things at the same time internally; microsoft
		3292	recommends spawning a chain of threads and wait for 63 handles and the
		3293	previous thread in each. Great).
		3294
		3295	Newer versions support more handles, but you need to define C<FD_SETSIZE>
		3296	to some high number (e.g. C<2048>) before compiling the winsocket select
		3297	call (which might be in libev or elsewhere, for example, perl does its own
		3298	select emulation on windows).
		3299
		3300	Another limit is the number of file descriptors in the microsoft runtime
		3301	libraries, which by default is C<64> (there must be a hidden I<64> fetish
		3302	or something like this inside microsoft). You can increase this by calling
		3303	C<_setmaxstdio>, which can increase this limit to C<2048> (another
		3304	arbitrary limit), but is broken in many versions of the microsoft runtime
		3305	libraries.
		3306
		3307	This might get you to about C<512> or C<2048> sockets (depending on
		3308	windows version and/or the phase of the moon). To get more, you need to
		3309	wrap all I/O functions and provide your own fd management, but the cost of
		3310	calling select (O(n²)) will likely make this unworkable.
		3311
		3312	=back
		3313
		3314
		3315	=head1 PORTABILITY REQUIREMENTS
		3316
		3317	In addition to a working ISO-C implementation, libev relies on a few
		3318	additional extensions:
		3319
		3320	=over 4
		3321
		3322	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3323
		3324	The type C<sig_atomic_t volatile> (or whatever is defined as
		3325	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
		3326	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3327	believed to be sufficiently portable.
		3328
		3329	=item C<sigprocmask> must work in a threaded environment
		3330
		3331	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3332	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3333	pthread implementations will either allow C<sigprocmask> in the "main
		3334	thread" or will block signals process-wide, both behaviours would
		3335	be compatible with libev. Interaction between C<sigprocmask> and
		3336	C<pthread_sigmask> could complicate things, however.
		3337
		3338	The most portable way to handle signals is to block signals in all threads
		3339	except the initial one, and run the default loop in the initial thread as
		3340	well.
		3341
		3342	=item C<long> must be large enough for common memory allocation sizes
		3343
		3344	To improve portability and simplify using libev, libev uses C<long>
		3345	internally instead of C<size_t> when allocating its data structures. On
		3346	non-POSIX systems (Microsoft...) this might be unexpectedly low, but
		3347	is still at least 31 bits everywhere, which is enough for hundreds of
		3348	millions of watchers.
		3349
		3350	=item C<double> must hold a time value in seconds with enough accuracy
		3351
		3352	The type C<double> is used to represent timestamps. It is required to
		3353	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		3354	enough for at least into the year 4000. This requirement is fulfilled by
		3355	implementations implementing IEEE 754 (basically all existing ones).
		3356
		3357	=back
		3358
		3359	If you know of other additional requirements drop me a note.
		3360
		3361
		3362	=head1 VALGRIND
		3363
		3364	Valgrind has a special section here because it is a popular tool that is
		3365	highly useful, but valgrind reports are very hard to interpret.
		3366
		3367	If you think you found a bug (memory leak, uninitialised data access etc.)
		3368	in libev, then check twice: If valgrind reports something like:
		3369
		3370	==2274== definitely lost: 0 bytes in 0 blocks.
		3371	==2274== possibly lost: 0 bytes in 0 blocks.
		3372	==2274== still reachable: 256 bytes in 1 blocks.
		3373
		3374	then there is no memory leak. Similarly, under some circumstances,
		3375	valgrind might report kernel bugs as if it were a bug in libev, or it
		3376	might be confused (it is a very good tool, but only a tool).
		3377
		3378	If you are unsure about something, feel free to contact the mailing list
		3379	with the full valgrind report and an explanation on why you think this is
		3380	a bug in libev. However, don't be annoyed when you get a brisk "this is
		3381	no bug" answer and take the chance of learning how to interpret valgrind
		3382	properly.
		3383
		3384	If you need, for some reason, empty reports from valgrind for your project
		3385	I suggest using suppression lists.
		3386
		3387
2777	=head1 AUTHOR	3388	=head1 AUTHOR
2778		3389
2779	Marc Lehmann <libev@schmorp.de>.	3390	Marc Lehmann <libev@schmorp.de>.
2780		3391

Diff Legend

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