ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.183 by root, Tue Sep 23 08:37:38 2008 UTC vs.
Revision 1.232 by root, Thu Apr 16 06:17:26 2009 UTC

…		…
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
11	// a single header file is required	11	// a single header file is required
12	#include <ev.h>	12	#include <ev.h>
13		13
		14	#include <stdio.h> // for puts
		15
14	// every watcher type has its own typedef'd struct	16	// every watcher type has its own typedef'd struct
15	// with the name ev_<type>	17	// with the name ev_TYPE
16	ev_io stdin_watcher;	18	ev_io stdin_watcher;
17	ev_timer timeout_watcher;	19	ev_timer timeout_watcher;
18		20
19	// all watcher callbacks have a similar signature	21	// all watcher callbacks have a similar signature
20	// this callback is called when data is readable on stdin	22	// this callback is called when data is readable on stdin
21	static void	23	static void
22	stdin_cb (EV_P_ struct ev_io *w, int revents)	24	stdin_cb (EV_P_ ev_io *w, int revents)
23	{	25	{
24	puts ("stdin ready");	26	puts ("stdin ready");
25	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
26	// with its corresponding stop function.	28	// with its corresponding stop function.
27	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
…		…
30	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_unloop (EV_A_ EVUNLOOP_ALL);
31	}	33	}
32		34
33	// another callback, this time for a time-out	35	// another callback, this time for a time-out
34	static void	36	static void
35	timeout_cb (EV_P_ struct ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
36	{	38	{
37	puts ("timeout");	39	puts ("timeout");
38	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_loop to stop iterating
39	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_unloop (EV_A_ EVUNLOOP_ONE);
40	}	42	}
…		…
103	Libev is very configurable. In this manual the default (and most common)	105	Libev is very configurable. In this manual the default (and most common)
104	configuration will be described, which supports multiple event loops. For	106	configuration will be described, which supports multiple event loops. For
105	more info about various configuration options please have a look at	107	more info about various configuration options please have a look at
106	B<EMBED> section in this manual. If libev was configured without support	108	B<EMBED> section in this manual. If libev was configured without support
107	for multiple event loops, then all functions taking an initial argument of	109	for multiple event loops, then all functions taking an initial argument of
108	name C<loop> (which is always of type C<struct ev_loop *>) will not have	110	name C<loop> (which is always of type C<ev_loop *>) will not have
109	this argument.	111	this argument.
110		112
111	=head2 TIME REPRESENTATION	113	=head2 TIME REPRESENTATION
112		114
113	Libev represents time as a single floating point number, representing the	115	Libev represents time as a single floating point number, representing the
…		…
214	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	216	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
215	recommended ones.	217	recommended ones.
216		218
217	See the description of C<ev_embed> watchers for more info.	219	See the description of C<ev_embed> watchers for more info.
218		220
219	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	221	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
220		222
221	Sets the allocation function to use (the prototype is similar - the	223	Sets the allocation function to use (the prototype is similar - the
222	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	224	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
223	used to allocate and free memory (no surprises here). If it returns zero	225	used to allocate and free memory (no surprises here). If it returns zero
224	when memory needs to be allocated (C<size != 0>), the library might abort	226	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
250	}	252	}
251		253
252	...	254	...
253	ev_set_allocator (persistent_realloc);	255	ev_set_allocator (persistent_realloc);
254		256
255	=item ev_set_syserr_cb (void (*cb)(const char *msg));	257	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]
256		258
257	Set the callback function to call on a retryable system call error (such	259	Set the callback function to call on a retryable system call error (such
258	as failed select, poll, epoll_wait). The message is a printable string	260	as failed select, poll, epoll_wait). The message is a printable string
259	indicating the system call or subsystem causing the problem. If this	261	indicating the system call or subsystem causing the problem. If this
260	callback is set, then libev will expect it to remedy the situation, no	262	callback is set, then libev will expect it to remedy the situation, no
…		…
276		278
277	=back	279	=back
278		280
279	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	281	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
280		282
281	An event loop is described by a C<struct ev_loop *>. The library knows two	283	An event loop is described by a C<struct ev_loop *> (the C<struct>
282	types of such loops, the I<default> loop, which supports signals and child	284	is I<not> optional in this case, as there is also an C<ev_loop>
283	events, and dynamically created loops which do not.	285	I<function>).
		286
		287	The library knows two types of such loops, the I<default> loop, which
		288	supports signals and child events, and dynamically created loops which do
		289	not.
284		290
285	=over 4	291	=over 4
286		292
287	=item struct ev_loop *ev_default_loop (unsigned int flags)	293	=item struct ev_loop *ev_default_loop (unsigned int flags)
288		294
…		…
294	If you don't know what event loop to use, use the one returned from this	300	If you don't know what event loop to use, use the one returned from this
295	function.	301	function.
296		302
297	Note that this function is I<not> thread-safe, so if you want to use it	303	Note that this function is I<not> thread-safe, so if you want to use it
298	from multiple threads, you have to lock (note also that this is unlikely,	304	from multiple threads, you have to lock (note also that this is unlikely,
299	as loops cannot bes hared easily between threads anyway).	305	as loops cannot be shared easily between threads anyway).
300		306
301	The default loop is the only loop that can handle C<ev_signal> and	307	The default loop is the only loop that can handle C<ev_signal> and
302	C<ev_child> watchers, and to do this, it always registers a handler	308	C<ev_child> watchers, and to do this, it always registers a handler
303	for C<SIGCHLD>. If this is a problem for your application you can either	309	for C<SIGCHLD>. If this is a problem for your application you can either
304	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	310	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
…		…
380	=item C<EVBACKEND_EPOLL> (value 4, Linux)	386	=item C<EVBACKEND_EPOLL> (value 4, Linux)
381		387
382	For few fds, this backend is a bit little slower than poll and select,	388	For few fds, this backend is a bit little slower than poll and select,
383	but it scales phenomenally better. While poll and select usually scale	389	but it scales phenomenally better. While poll and select usually scale
384	like O(total_fds) where n is the total number of fds (or the highest fd),	390	like O(total_fds) where n is the total number of fds (or the highest fd),
385	epoll scales either O(1) or O(active_fds). The epoll design has a number	391	epoll scales either O(1) or O(active_fds).
386	of shortcomings, such as silently dropping events in some hard-to-detect	392
387	cases and requiring a system call per fd change, no fork support and bad	393	The epoll mechanism deserves honorable mention as the most misdesigned
388	support for dup.	394	of the more advanced event mechanisms: mere annoyances include silently
		395	dropping file descriptors, requiring a system call per change per file
		396	descriptor (and unnecessary guessing of parameters), problems with dup and
		397	so on. The biggest issue is fork races, however - if a program forks then
		398	I<both> parent and child process have to recreate the epoll set, which can
		399	take considerable time (one syscall per file descriptor) and is of course
		400	hard to detect.
		401
		402	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
		403	of course I<doesn't>, and epoll just loves to report events for totally
		404	I<different> file descriptors (even already closed ones, so one cannot
		405	even remove them from the set) than registered in the set (especially
		406	on SMP systems). Libev tries to counter these spurious notifications by
		407	employing an additional generation counter and comparing that against the
		408	events to filter out spurious ones, recreating the set when required.
389		409
390	While stopping, setting and starting an I/O watcher in the same iteration	410	While stopping, setting and starting an I/O watcher in the same iteration
391	will result in some caching, there is still a system call per such incident	411	will result in some caching, there is still a system call per such
392	(because the fd could point to a different file description now), so its	412	incident (because the same I<file descriptor> could point to a different
393	best to avoid that. Also, C<dup ()>'ed file descriptors might not work	413	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
394	very well if you register events for both fds.	414	file descriptors might not work very well if you register events for both
395		415	file descriptors.
396	Please note that epoll sometimes generates spurious notifications, so you
397	need to use non-blocking I/O or other means to avoid blocking when no data
398	(or space) is available.
399		416
400	Best performance from this backend is achieved by not unregistering all	417	Best performance from this backend is achieved by not unregistering all
401	watchers for a file descriptor until it has been closed, if possible,	418	watchers for a file descriptor until it has been closed, if possible,
402	i.e. keep at least one watcher active per fd at all times. Stopping and	419	i.e. keep at least one watcher active per fd at all times. Stopping and
403	starting a watcher (without re-setting it) also usually doesn't cause	420	starting a watcher (without re-setting it) also usually doesn't cause
404	extra overhead.	421	extra overhead. A fork can both result in spurious notifications as well
		422	as in libev having to destroy and recreate the epoll object, which can
		423	take considerable time and thus should be avoided.
		424
		425	All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
		426	faster than epoll for maybe up to a hundred file descriptors, depending on
		427	the usage. So sad.
405		428
406	While nominally embeddable in other event loops, this feature is broken in	429	While nominally embeddable in other event loops, this feature is broken in
407	all kernel versions tested so far.	430	all kernel versions tested so far.
408		431
409	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	432	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
410	C<EVBACKEND_POLL>.	433	C<EVBACKEND_POLL>.
411		434
412	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	435	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
413		436
414	Kqueue deserves special mention, as at the time of this writing, it was	437	Kqueue deserves special mention, as at the time of this writing, it
415	broken on all BSDs except NetBSD (usually it doesn't work reliably with	438	was broken on all BSDs except NetBSD (usually it doesn't work reliably
416	anything but sockets and pipes, except on Darwin, where of course it's	439	with anything but sockets and pipes, except on Darwin, where of course
417	completely useless). For this reason it's not being "auto-detected" unless	440	it's completely useless). Unlike epoll, however, whose brokenness
418	you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or	441	is by design, these kqueue bugs can (and eventually will) be fixed
419	libev was compiled on a known-to-be-good (-enough) system like NetBSD.	442	without API changes to existing programs. For this reason it's not being
		443	"auto-detected" unless you explicitly specify it in the flags (i.e. using
		444	C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
		445	system like NetBSD.
420		446
421	You still can embed kqueue into a normal poll or select backend and use it	447	You still can embed kqueue into a normal poll or select backend and use it
422	only for sockets (after having made sure that sockets work with kqueue on	448	only for sockets (after having made sure that sockets work with kqueue on
423	the target platform). See C<ev_embed> watchers for more info.	449	the target platform). See C<ev_embed> watchers for more info.
424		450
425	It scales in the same way as the epoll backend, but the interface to the	451	It scales in the same way as the epoll backend, but the interface to the
426	kernel is more efficient (which says nothing about its actual speed, of	452	kernel is more efficient (which says nothing about its actual speed, of
427	course). While stopping, setting and starting an I/O watcher does never	453	course). While stopping, setting and starting an I/O watcher does never
428	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	454	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
429	two event changes per incident. Support for C<fork ()> is very bad and it	455	two event changes per incident. Support for C<fork ()> is very bad (but
430	drops fds silently in similarly hard-to-detect cases.	456	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
		457	cases
431		458
432	This backend usually performs well under most conditions.	459	This backend usually performs well under most conditions.
433		460
434	While nominally embeddable in other event loops, this doesn't work	461	While nominally embeddable in other event loops, this doesn't work
435	everywhere, so you might need to test for this. And since it is broken	462	everywhere, so you might need to test for this. And since it is broken
436	almost everywhere, you should only use it when you have a lot of sockets	463	almost everywhere, you should only use it when you have a lot of sockets
437	(for which it usually works), by embedding it into another event loop	464	(for which it usually works), by embedding it into another event loop
438	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and, did I mention it,	465	(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> (but C<poll> is of course
439	using it only for sockets.	466	also broken on OS X)) and, did I mention it, using it only for sockets.
440		467
441	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with	468	This backend maps C<EV_READ> into an C<EVFILT_READ> kevent with
442	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with	469	C<NOTE_EOF>, and C<EV_WRITE> into an C<EVFILT_WRITE> kevent with
443	C<NOTE_EOF>.	470	C<NOTE_EOF>.
444		471
…		…
464	might perform better.	491	might perform better.
465		492
466	On the positive side, with the exception of the spurious readiness	493	On the positive side, with the exception of the spurious readiness
467	notifications, this backend actually performed fully to specification	494	notifications, this backend actually performed fully to specification
468	in all tests and is fully embeddable, which is a rare feat among the	495	in all tests and is fully embeddable, which is a rare feat among the
469	OS-specific backends.	496	OS-specific backends (I vastly prefer correctness over speed hacks).
470		497
471	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	498	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
472	C<EVBACKEND_POLL>.	499	C<EVBACKEND_POLL>.
473		500
474	=item C<EVBACKEND_ALL>	501	=item C<EVBACKEND_ALL>
…		…
527	responsibility to either stop all watchers cleanly yourself I<before>	554	responsibility to either stop all watchers cleanly yourself I<before>
528	calling this function, or cope with the fact afterwards (which is usually	555	calling this function, or cope with the fact afterwards (which is usually
529	the easiest thing, you can just ignore the watchers and/or C<free ()> them	556	the easiest thing, you can just ignore the watchers and/or C<free ()> them
530	for example).	557	for example).
531		558
532	Note that certain global state, such as signal state, will not be freed by	559	Note that certain global state, such as signal state (and installed signal
533	this function, and related watchers (such as signal and child watchers)	560	handlers), will not be freed by this function, and related watchers (such
534	would need to be stopped manually.	561	as signal and child watchers) would need to be stopped manually.
535		562
536	In general it is not advisable to call this function except in the	563	In general it is not advisable to call this function except in the
537	rare occasion where you really need to free e.g. the signal handling	564	rare occasion where you really need to free e.g. the signal handling
538	pipe fds. If you need dynamically allocated loops it is better to use	565	pipe fds. If you need dynamically allocated loops it is better to use
539	C<ev_loop_new> and C<ev_loop_destroy>).	566	C<ev_loop_new> and C<ev_loop_destroy>).
…		…
607	very long time without entering the event loop, updating libev's idea of	634	very long time without entering the event loop, updating libev's idea of
608	the current time is a good idea.	635	the current time is a good idea.
609		636
610	See also "The special problem of time updates" in the C<ev_timer> section.	637	See also "The special problem of time updates" in the C<ev_timer> section.
611		638
		639	=item ev_suspend (loop)
		640
		641	=item ev_resume (loop)
		642
		643	These two functions suspend and resume a loop, for use when the loop is
		644	not used for a while and timeouts should not be processed.
		645
		646	A typical use case would be an interactive program such as a game: When
		647	the user presses C<^Z> to suspend the game and resumes it an hour later it
		648	would be best to handle timeouts as if no time had actually passed while
		649	the program was suspended. This can be achieved by calling C<ev_suspend>
		650	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		651	C<ev_resume> directly afterwards to resume timer processing.
		652
		653	Effectively, all C<ev_timer> watchers will be delayed by the time spend
		654	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
		655	will be rescheduled (that is, they will lose any events that would have
		656	occured while suspended).
		657
		658	After calling C<ev_suspend> you B<must not> call I<any> function on the
		659	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
		660	without a previous call to C<ev_suspend>.
		661
		662	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
		663	event loop time (see C<ev_now_update>).
		664
612	=item ev_loop (loop, int flags)	665	=item ev_loop (loop, int flags)
613		666
614	Finally, this is it, the event handler. This function usually is called	667	Finally, this is it, the event handler. This function usually is called
615	after you initialised all your watchers and you want to start handling	668	after you initialised all your watchers and you want to start handling
616	events.	669	events.
…		…
631	the loop.	684	the loop.
632		685
633	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	686	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
634	necessary) and will handle those and any already outstanding ones. It	687	necessary) and will handle those and any already outstanding ones. It
635	will block your process until at least one new event arrives (which could	688	will block your process until at least one new event arrives (which could
636	be an event internal to libev itself, so there is no guarentee that a	689	be an event internal to libev itself, so there is no guarantee that a
637	user-registered callback will be called), and will return after one	690	user-registered callback will be called), and will return after one
638	iteration of the loop.	691	iteration of the loop.
639		692
640	This is useful if you are waiting for some external event in conjunction	693	This is useful if you are waiting for some external event in conjunction
641	with something not expressible using other libev watchers (i.e. "roll your	694	with something not expressible using other libev watchers (i.e. "roll your
…		…
685	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	738	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
686	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	739	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
687		740
688	This "unloop state" will be cleared when entering C<ev_loop> again.	741	This "unloop state" will be cleared when entering C<ev_loop> again.
689		742
		743	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.
		744
690	=item ev_ref (loop)	745	=item ev_ref (loop)
691		746
692	=item ev_unref (loop)	747	=item ev_unref (loop)
693		748
694	Ref/unref can be used to add or remove a reference count on the event	749	Ref/unref can be used to add or remove a reference count on the event
…		…
697		752
698	If you have a watcher you never unregister that should not keep C<ev_loop>	753	If you have a watcher you never unregister that should not keep C<ev_loop>
699	from returning, call ev_unref() after starting, and ev_ref() before	754	from returning, call ev_unref() after starting, and ev_ref() before
700	stopping it.	755	stopping it.
701		756
702	As an example, libev itself uses this for its internal signal pipe: It is	757	As an example, libev itself uses this for its internal signal pipe: It
703	not visible to the libev user and should not keep C<ev_loop> from exiting	758	is not visible to the libev user and should not keep C<ev_loop> from
704	if no event watchers registered by it are active. It is also an excellent	759	exiting if no event watchers registered by it are active. It is also an
705	way to do this for generic recurring timers or from within third-party	760	excellent way to do this for generic recurring timers or from within
706	libraries. Just remember to I<unref after start> and I<ref before stop>	761	third-party libraries. Just remember to I<unref after start> and I<ref
707	(but only if the watcher wasn't active before, or was active before,	762	before stop> (but only if the watcher wasn't active before, or was active
708	respectively).	763	before, respectively. Note also that libev might stop watchers itself
		764	(e.g. non-repeating timers) in which case you have to C<ev_ref>
		765	in the callback).
709		766
710	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	767	Example: Create a signal watcher, but keep it from keeping C<ev_loop>
711	running when nothing else is active.	768	running when nothing else is active.
712		769
713	struct ev_signal exitsig;	770	ev_signal exitsig;
714	ev_signal_init (&exitsig, sig_cb, SIGINT);	771	ev_signal_init (&exitsig, sig_cb, SIGINT);
715	ev_signal_start (loop, &exitsig);	772	ev_signal_start (loop, &exitsig);
716	evf_unref (loop);	773	evf_unref (loop);
717		774
718	Example: For some weird reason, unregister the above signal handler again.	775	Example: For some weird reason, unregister the above signal handler again.
…		…
766	they fire on, say, one-second boundaries only.	823	they fire on, say, one-second boundaries only.
767		824
768	=item ev_loop_verify (loop)	825	=item ev_loop_verify (loop)
769		826
770	This function only does something when C<EV_VERIFY> support has been	827	This function only does something when C<EV_VERIFY> support has been
771	compiled in. which is the default for non-minimal builds. It tries to go	828	compiled in, which is the default for non-minimal builds. It tries to go
772	through all internal structures and checks them for validity. If anything	829	through all internal structures and checks them for validity. If anything
773	is found to be inconsistent, it will print an error message to standard	830	is found to be inconsistent, it will print an error message to standard
774	error and call C<abort ()>.	831	error and call C<abort ()>.
775		832
776	This can be used to catch bugs inside libev itself: under normal	833	This can be used to catch bugs inside libev itself: under normal
…		…
780	=back	837	=back
781		838
782		839
783	=head1 ANATOMY OF A WATCHER	840	=head1 ANATOMY OF A WATCHER
784		841
		842	In the following description, uppercase C<TYPE> in names stands for the
		843	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
		844	watchers and C<ev_io_start> for I/O watchers.
		845
785	A watcher is a structure that you create and register to record your	846	A watcher is a structure that you create and register to record your
786	interest in some event. For instance, if you want to wait for STDIN to	847	interest in some event. For instance, if you want to wait for STDIN to
787	become readable, you would create an C<ev_io> watcher for that:	848	become readable, you would create an C<ev_io> watcher for that:
788		849
789	static void my_cb (struct ev_loop *loop, struct ev_io *w, int revents)	850	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
790	{	851	{
791	ev_io_stop (w);	852	ev_io_stop (w);
792	ev_unloop (loop, EVUNLOOP_ALL);	853	ev_unloop (loop, EVUNLOOP_ALL);
793	}	854	}
794		855
795	struct ev_loop *loop = ev_default_loop (0);	856	struct ev_loop *loop = ev_default_loop (0);
		857
796	struct ev_io stdin_watcher;	858	ev_io stdin_watcher;
		859
797	ev_init (&stdin_watcher, my_cb);	860	ev_init (&stdin_watcher, my_cb);
798	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	861	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
799	ev_io_start (loop, &stdin_watcher);	862	ev_io_start (loop, &stdin_watcher);
		863
800	ev_loop (loop, 0);	864	ev_loop (loop, 0);
801		865
802	As you can see, you are responsible for allocating the memory for your	866	As you can see, you are responsible for allocating the memory for your
803	watcher structures (and it is usually a bad idea to do this on the stack,	867	watcher structures (and it is I<usually> a bad idea to do this on the
804	although this can sometimes be quite valid).	868	stack).
		869
		870	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
		871	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
805		872
806	Each watcher structure must be initialised by a call to C<ev_init	873	Each watcher structure must be initialised by a call to C<ev_init
807	(watcher *, callback)>, which expects a callback to be provided. This	874	(watcher *, callback)>, which expects a callback to be provided. This
808	callback gets invoked each time the event occurs (or, in the case of I/O	875	callback gets invoked each time the event occurs (or, in the case of I/O
809	watchers, each time the event loop detects that the file descriptor given	876	watchers, each time the event loop detects that the file descriptor given
810	is readable and/or writable).	877	is readable and/or writable).
811		878
812	Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro	879	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
813	with arguments specific to this watcher type. There is also a macro	880	macro to configure it, with arguments specific to the watcher type. There
814	to combine initialisation and setting in one call: C<< ev_<type>_init	881	is also a macro to combine initialisation and setting in one call: C<<
815	(watcher *, callback, ...) >>.	882	ev_TYPE_init (watcher *, callback, ...) >>.
816		883
817	To make the watcher actually watch out for events, you have to start it	884	To make the watcher actually watch out for events, you have to start it
818	with a watcher-specific start function (C<< ev_<type>_start (loop, watcher	885	with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
819	*) >>), and you can stop watching for events at any time by calling the	886	*) >>), and you can stop watching for events at any time by calling the
820	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	887	corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
821		888
822	As long as your watcher is active (has been started but not stopped) you	889	As long as your watcher is active (has been started but not stopped) you
823	must not touch the values stored in it. Most specifically you must never	890	must not touch the values stored in it. Most specifically you must never
824	reinitialise it or call its C<set> macro.	891	reinitialise it or call its C<ev_TYPE_set> macro.
825		892
826	Each and every callback receives the event loop pointer as first, the	893	Each and every callback receives the event loop pointer as first, the
827	registered watcher structure as second, and a bitset of received events as	894	registered watcher structure as second, and a bitset of received events as
828	third argument.	895	third argument.
829		896
…		…
887		954
888	=item C<EV_ASYNC>	955	=item C<EV_ASYNC>
889		956
890	The given async watcher has been asynchronously notified (see C<ev_async>).	957	The given async watcher has been asynchronously notified (see C<ev_async>).
891		958
		959	=item C<EV_CUSTOM>
		960
		961	Not ever sent (or otherwise used) by libev itself, but can be freely used
		962	by libev users to signal watchers (e.g. via C<ev_feed_event>).
		963
892	=item C<EV_ERROR>	964	=item C<EV_ERROR>
893		965
894	An unspecified error has occurred, the watcher has been stopped. This might	966	An unspecified error has occurred, the watcher has been stopped. This might
895	happen because the watcher could not be properly started because libev	967	happen because the watcher could not be properly started because libev
896	ran out of memory, a file descriptor was found to be closed or any other	968	ran out of memory, a file descriptor was found to be closed or any other
		969	problem. Libev considers these application bugs.
		970
897	problem. You best act on it by reporting the problem and somehow coping	971	You best act on it by reporting the problem and somehow coping with the
898	with the watcher being stopped.	972	watcher being stopped. Note that well-written programs should not receive
		973	an error ever, so when your watcher receives it, this usually indicates a
		974	bug in your program.
899		975
900	Libev will usually signal a few "dummy" events together with an error, for	976	Libev will usually signal a few "dummy" events together with an error, for
901	example it might indicate that a fd is readable or writable, and if your	977	example it might indicate that a fd is readable or writable, and if your
902	callbacks is well-written it can just attempt the operation and cope with	978	callbacks is well-written it can just attempt the operation and cope with
903	the error from read() or write(). This will not work in multi-threaded	979	the error from read() or write(). This will not work in multi-threaded
…		…
906		982
907	=back	983	=back
908		984
909	=head2 GENERIC WATCHER FUNCTIONS	985	=head2 GENERIC WATCHER FUNCTIONS
910		986
911	In the following description, C<TYPE> stands for the watcher type,
912	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
913
914	=over 4	987	=over 4
915		988
916	=item C<ev_init> (ev_TYPE *watcher, callback)	989	=item C<ev_init> (ev_TYPE *watcher, callback)
917		990
918	This macro initialises the generic portion of a watcher. The contents	991	This macro initialises the generic portion of a watcher. The contents
…		…
923	which rolls both calls into one.	996	which rolls both calls into one.
924		997
925	You can reinitialise a watcher at any time as long as it has been stopped	998	You can reinitialise a watcher at any time as long as it has been stopped
926	(or never started) and there are no pending events outstanding.	999	(or never started) and there are no pending events outstanding.
927		1000
928	The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher,	1001	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
929	int revents)>.	1002	int revents)>.
930		1003
931	Example: Initialise an C<ev_io> watcher in two steps.	1004	Example: Initialise an C<ev_io> watcher in two steps.
932		1005
933	ev_io w;	1006	ev_io w;
…		…
967		1040
968	ev_io_start (EV_DEFAULT_UC, &w);	1041	ev_io_start (EV_DEFAULT_UC, &w);
969		1042
970	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1043	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)
971		1044
972	Stops the given watcher again (if active) and clears the pending	1045	Stops the given watcher if active, and clears the pending status (whether
		1046	the watcher was active or not).
		1047
973	status. It is possible that stopped watchers are pending (for example,	1048	It is possible that stopped watchers are pending - for example,
974	non-repeating timers are being stopped when they become pending), but	1049	non-repeating timers are being stopped when they become pending - but
975	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If	1050	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
976	you want to free or reuse the memory used by the watcher it is therefore a	1051	pending. If you want to free or reuse the memory used by the watcher it is
977	good idea to always call its C<ev_TYPE_stop> function.	1052	therefore a good idea to always call its C<ev_TYPE_stop> function.
978		1053
979	=item bool ev_is_active (ev_TYPE *watcher)	1054	=item bool ev_is_active (ev_TYPE *watcher)
980		1055
981	Returns a true value iff the watcher is active (i.e. it has been started	1056	Returns a true value iff the watcher is active (i.e. it has been started
982	and not yet been stopped). As long as a watcher is active you must not modify	1057	and not yet been stopped). As long as a watcher is active you must not modify
…		…
1008	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1083	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1009	(default: C<-2>). Pending watchers with higher priority will be invoked	1084	(default: C<-2>). Pending watchers with higher priority will be invoked
1010	before watchers with lower priority, but priority will not keep watchers	1085	before watchers with lower priority, but priority will not keep watchers
1011	from being executed (except for C<ev_idle> watchers).	1086	from being executed (except for C<ev_idle> watchers).
1012		1087
		1088	See L<
		1089
1013	This means that priorities are I<only> used for ordering callback	1090	This means that priorities are I<only> used for ordering callback
1014	invocation after new events have been received. This is useful, for	1091	invocation after new events have been received. This is useful, for
1015	example, to reduce latency after idling, or more often, to bind two	1092	example, to reduce latency after idling, or more often, to bind two
1016	watchers on the same event and make sure one is called first.	1093	watchers on the same event and make sure one is called first.
1017		1094
…		…
1024	The default priority used by watchers when no priority has been set is	1101	The default priority used by watchers when no priority has been set is
1025	always C<0>, which is supposed to not be too high and not be too low :).	1102	always C<0>, which is supposed to not be too high and not be too low :).
1026		1103
1027	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is	1104	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1028	fine, as long as you do not mind that the priority value you query might	1105	fine, as long as you do not mind that the priority value you query might
1029	or might not have been adjusted to be within valid range.	1106	or might not have been clamped to the valid range.
1030		1107
1031	=item ev_invoke (loop, ev_TYPE *watcher, int revents)	1108	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1032		1109
1033	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither	1110	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1034	C<loop> nor C<revents> need to be valid as long as the watcher callback	1111	C<loop> nor C<revents> need to be valid as long as the watcher callback
…		…
1056	member, you can also "subclass" the watcher type and provide your own	1133	member, you can also "subclass" the watcher type and provide your own
1057	data:	1134	data:
1058		1135
1059	struct my_io	1136	struct my_io
1060	{	1137	{
1061	struct ev_io io;	1138	ev_io io;
1062	int otherfd;	1139	int otherfd;
1063	void *somedata;	1140	void *somedata;
1064	struct whatever *mostinteresting;	1141	struct whatever *mostinteresting;
1065	};	1142	};
1066		1143
…		…
1069	ev_io_init (&w.io, my_cb, fd, EV_READ);	1146	ev_io_init (&w.io, my_cb, fd, EV_READ);
1070		1147
1071	And since your callback will be called with a pointer to the watcher, you	1148	And since your callback will be called with a pointer to the watcher, you
1072	can cast it back to your own type:	1149	can cast it back to your own type:
1073		1150
1074	static void my_cb (struct ev_loop *loop, struct ev_io *w_, int revents)	1151	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1075	{	1152	{
1076	struct my_io *w = (struct my_io *)w_;	1153	struct my_io *w = (struct my_io *)w_;
1077	...	1154	...
1078	}	1155	}
1079		1156
…		…
1097	programmers):	1174	programmers):
1098		1175
1099	#include <stddef.h>	1176	#include <stddef.h>
1100		1177
1101	static void	1178	static void
1102	t1_cb (EV_P_ struct ev_timer *w, int revents)	1179	t1_cb (EV_P_ ev_timer *w, int revents)
1103	{	1180	{
1104	struct my_biggy big = (struct my_biggy *	1181	struct my_biggy big = (struct my_biggy *
1105	(((char *)w) - offsetof (struct my_biggy, t1));	1182	(((char *)w) - offsetof (struct my_biggy, t1));
1106	}	1183	}
1107		1184
1108	static void	1185	static void
1109	t2_cb (EV_P_ struct ev_timer *w, int revents)	1186	t2_cb (EV_P_ ev_timer *w, int revents)
1110	{	1187	{
1111	struct my_biggy big = (struct my_biggy *	1188	struct my_biggy big = (struct my_biggy *
1112	(((char *)w) - offsetof (struct my_biggy, t2));	1189	(((char *)w) - offsetof (struct my_biggy, t2));
1113	}	1190	}
1114		1191
…		…
1249	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well	1326	Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1250	readable, but only once. Since it is likely line-buffered, you could	1327	readable, but only once. Since it is likely line-buffered, you could
1251	attempt to read a whole line in the callback.	1328	attempt to read a whole line in the callback.
1252		1329
1253	static void	1330	static void
1254	stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1331	stdin_readable_cb (struct ev_loop *loop, ev_io *w, int revents)
1255	{	1332	{
1256	ev_io_stop (loop, w);	1333	ev_io_stop (loop, w);
1257	.. read from stdin here (or from w->fd) and handle any I/O errors	1334	.. read from stdin here (or from w->fd) and handle any I/O errors
1258	}	1335	}
1259		1336
1260	...	1337	...
1261	struct ev_loop *loop = ev_default_init (0);	1338	struct ev_loop *loop = ev_default_init (0);
1262	struct ev_io stdin_readable;	1339	ev_io stdin_readable;
1263	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1340	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1264	ev_io_start (loop, &stdin_readable);	1341	ev_io_start (loop, &stdin_readable);
1265	ev_loop (loop, 0);	1342	ev_loop (loop, 0);
1266		1343
1267		1344
…		…
1275	year, it will still time out after (roughly) one hour. "Roughly" because	1352	year, it will still time out after (roughly) one hour. "Roughly" because
1276	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1353	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1277	monotonic clock option helps a lot here).	1354	monotonic clock option helps a lot here).
1278		1355
1279	The callback is guaranteed to be invoked only I<after> its timeout has	1356	The callback is guaranteed to be invoked only I<after> its timeout has
1280	passed, but if multiple timers become ready during the same loop iteration	1357	passed. If multiple timers become ready during the same loop iteration
1281	then order of execution is undefined.	1358	then the ones with earlier time-out values are invoked before ones with
		1359	later time-out values (but this is no longer true when a callback calls
		1360	C<ev_loop> recursively).
		1361
		1362	=head3 Be smart about timeouts
		1363
		1364	Many real-world problems involve some kind of timeout, usually for error
		1365	recovery. A typical example is an HTTP request - if the other side hangs,
		1366	you want to raise some error after a while.
		1367
		1368	What follows are some ways to handle this problem, from obvious and
		1369	inefficient to smart and efficient.
		1370
		1371	In the following, a 60 second activity timeout is assumed - a timeout that
		1372	gets reset to 60 seconds each time there is activity (e.g. each time some
		1373	data or other life sign was received).
		1374
		1375	=over 4
		1376
		1377	=item 1. Use a timer and stop, reinitialise and start it on activity.
		1378
		1379	This is the most obvious, but not the most simple way: In the beginning,
		1380	start the watcher:
		1381
		1382	ev_timer_init (timer, callback, 60., 0.);
		1383	ev_timer_start (loop, timer);
		1384
		1385	Then, each time there is some activity, C<ev_timer_stop> it, initialise it
		1386	and start it again:
		1387
		1388	ev_timer_stop (loop, timer);
		1389	ev_timer_set (timer, 60., 0.);
		1390	ev_timer_start (loop, timer);
		1391
		1392	This is relatively simple to implement, but means that each time there is
		1393	some activity, libev will first have to remove the timer from its internal
		1394	data structure and then add it again. Libev tries to be fast, but it's
		1395	still not a constant-time operation.
		1396
		1397	=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
		1398
		1399	This is the easiest way, and involves using C<ev_timer_again> instead of
		1400	C<ev_timer_start>.
		1401
		1402	To implement this, configure an C<ev_timer> with a C<repeat> value
		1403	of C<60> and then call C<ev_timer_again> at start and each time you
		1404	successfully read or write some data. If you go into an idle state where
		1405	you do not expect data to travel on the socket, you can C<ev_timer_stop>
		1406	the timer, and C<ev_timer_again> will automatically restart it if need be.
		1407
		1408	That means you can ignore both the C<ev_timer_start> function and the
		1409	C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
		1410	member and C<ev_timer_again>.
		1411
		1412	At start:
		1413
		1414	ev_timer_init (timer, callback);
		1415	timer->repeat = 60.;
		1416	ev_timer_again (loop, timer);
		1417
		1418	Each time there is some activity:
		1419
		1420	ev_timer_again (loop, timer);
		1421
		1422	It is even possible to change the time-out on the fly, regardless of
		1423	whether the watcher is active or not:
		1424
		1425	timer->repeat = 30.;
		1426	ev_timer_again (loop, timer);
		1427
		1428	This is slightly more efficient then stopping/starting the timer each time
		1429	you want to modify its timeout value, as libev does not have to completely
		1430	remove and re-insert the timer from/into its internal data structure.
		1431
		1432	It is, however, even simpler than the "obvious" way to do it.
		1433
		1434	=item 3. Let the timer time out, but then re-arm it as required.
		1435
		1436	This method is more tricky, but usually most efficient: Most timeouts are
		1437	relatively long compared to the intervals between other activity - in
		1438	our example, within 60 seconds, there are usually many I/O events with
		1439	associated activity resets.
		1440
		1441	In this case, it would be more efficient to leave the C<ev_timer> alone,
		1442	but remember the time of last activity, and check for a real timeout only
		1443	within the callback:
		1444
		1445	ev_tstamp last_activity; // time of last activity
		1446
		1447	static void
		1448	callback (EV_P_ ev_timer *w, int revents)
		1449	{
		1450	ev_tstamp now = ev_now (EV_A);
		1451	ev_tstamp timeout = last_activity + 60.;
		1452
		1453	// if last_activity + 60. is older than now, we did time out
		1454	if (timeout < now)
		1455	{
		1456	// timeout occured, take action
		1457	}
		1458	else
		1459	{
		1460	// callback was invoked, but there was some activity, re-arm
		1461	// the watcher to fire in last_activity + 60, which is
		1462	// guaranteed to be in the future, so "again" is positive:
		1463	w->repeat = timeout - now;
		1464	ev_timer_again (EV_A_ w);
		1465	}
		1466	}
		1467
		1468	To summarise the callback: first calculate the real timeout (defined
		1469	as "60 seconds after the last activity"), then check if that time has
		1470	been reached, which means something I<did>, in fact, time out. Otherwise
		1471	the callback was invoked too early (C<timeout> is in the future), so
		1472	re-schedule the timer to fire at that future time, to see if maybe we have
		1473	a timeout then.
		1474
		1475	Note how C<ev_timer_again> is used, taking advantage of the
		1476	C<ev_timer_again> optimisation when the timer is already running.
		1477
		1478	This scheme causes more callback invocations (about one every 60 seconds
		1479	minus half the average time between activity), but virtually no calls to
		1480	libev to change the timeout.
		1481
		1482	To start the timer, simply initialise the watcher and set C<last_activity>
		1483	to the current time (meaning we just have some activity :), then call the
		1484	callback, which will "do the right thing" and start the timer:
		1485
		1486	ev_timer_init (timer, callback);
		1487	last_activity = ev_now (loop);
		1488	callback (loop, timer, EV_TIMEOUT);
		1489
		1490	And when there is some activity, simply store the current time in
		1491	C<last_activity>, no libev calls at all:
		1492
		1493	last_actiivty = ev_now (loop);
		1494
		1495	This technique is slightly more complex, but in most cases where the
		1496	time-out is unlikely to be triggered, much more efficient.
		1497
		1498	Changing the timeout is trivial as well (if it isn't hard-coded in the
		1499	callback :) - just change the timeout and invoke the callback, which will
		1500	fix things for you.
		1501
		1502	=item 4. Wee, just use a double-linked list for your timeouts.
		1503
		1504	If there is not one request, but many thousands (millions...), all
		1505	employing some kind of timeout with the same timeout value, then one can
		1506	do even better:
		1507
		1508	When starting the timeout, calculate the timeout value and put the timeout
		1509	at the I<end> of the list.
		1510
		1511	Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
		1512	the list is expected to fire (for example, using the technique #3).
		1513
		1514	When there is some activity, remove the timer from the list, recalculate
		1515	the timeout, append it to the end of the list again, and make sure to
		1516	update the C<ev_timer> if it was taken from the beginning of the list.
		1517
		1518	This way, one can manage an unlimited number of timeouts in O(1) time for
		1519	starting, stopping and updating the timers, at the expense of a major
		1520	complication, and having to use a constant timeout. The constant timeout
		1521	ensures that the list stays sorted.
		1522
		1523	=back
		1524
		1525	So which method the best?
		1526
		1527	Method #2 is a simple no-brain-required solution that is adequate in most
		1528	situations. Method #3 requires a bit more thinking, but handles many cases
		1529	better, and isn't very complicated either. In most case, choosing either
		1530	one is fine, with #3 being better in typical situations.
		1531
		1532	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
		1533	rather complicated, but extremely efficient, something that really pays
		1534	off after the first million or so of active timers, i.e. it's usually
		1535	overkill :)
1282		1536
1283	=head3 The special problem of time updates	1537	=head3 The special problem of time updates
1284		1538
1285	Establishing the current time is a costly operation (it usually takes at	1539	Establishing the current time is a costly operation (it usually takes at
1286	least two system calls): EV therefore updates its idea of the current	1540	least two system calls): EV therefore updates its idea of the current
…		…
1330	If the timer is started but non-repeating, stop it (as if it timed out).	1584	If the timer is started but non-repeating, stop it (as if it timed out).
1331		1585
1332	If the timer is repeating, either start it if necessary (with the	1586	If the timer is repeating, either start it if necessary (with the
1333	C<repeat> value), or reset the running timer to the C<repeat> value.	1587	C<repeat> value), or reset the running timer to the C<repeat> value.
1334		1588
1335	This sounds a bit complicated, but here is a useful and typical	1589	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1336	example: Imagine you have a TCP connection and you want a so-called idle	1590	usage example.
1337	timeout, that is, you want to be called when there have been, say, 60
1338	seconds of inactivity on the socket. The easiest way to do this is to
1339	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
1340	C<ev_timer_again> each time you successfully read or write some data. If
1341	you go into an idle state where you do not expect data to travel on the
1342	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
1343	automatically restart it if need be.
1344
1345	That means you can ignore the C<after> value and C<ev_timer_start>
1346	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
1347
1348	ev_timer_init (timer, callback, 0., 5.);
1349	ev_timer_again (loop, timer);
1350	...
1351	timer->again = 17.;
1352	ev_timer_again (loop, timer);
1353	...
1354	timer->again = 10.;
1355	ev_timer_again (loop, timer);
1356
1357	This is more slightly efficient then stopping/starting the timer each time
1358	you want to modify its timeout value.
1359
1360	Note, however, that it is often even more efficient to remember the
1361	time of the last activity and let the timer time-out naturally. In the
1362	callback, you then check whether the time-out is real, or, if there was
1363	some activity, you reschedule the watcher to time-out in "last_activity +
1364	timeout - ev_now ()" seconds.
1365		1591
1366	=item ev_tstamp repeat [read-write]	1592	=item ev_tstamp repeat [read-write]
1367		1593
1368	The current C<repeat> value. Will be used each time the watcher times out	1594	The current C<repeat> value. Will be used each time the watcher times out
1369	or C<ev_timer_again> is called, and determines the next timeout (if any),	1595	or C<ev_timer_again> is called, and determines the next timeout (if any),
…		…
1374	=head3 Examples	1600	=head3 Examples
1375		1601
1376	Example: Create a timer that fires after 60 seconds.	1602	Example: Create a timer that fires after 60 seconds.
1377		1603
1378	static void	1604	static void
1379	one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1605	one_minute_cb (struct ev_loop *loop, ev_timer *w, int revents)
1380	{	1606	{
1381	.. one minute over, w is actually stopped right here	1607	.. one minute over, w is actually stopped right here
1382	}	1608	}
1383		1609
1384	struct ev_timer mytimer;	1610	ev_timer mytimer;
1385	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);	1611	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
1386	ev_timer_start (loop, &mytimer);	1612	ev_timer_start (loop, &mytimer);
1387		1613
1388	Example: Create a timeout timer that times out after 10 seconds of	1614	Example: Create a timeout timer that times out after 10 seconds of
1389	inactivity.	1615	inactivity.
1390		1616
1391	static void	1617	static void
1392	timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)	1618	timeout_cb (struct ev_loop *loop, ev_timer *w, int revents)
1393	{	1619	{
1394	.. ten seconds without any activity	1620	.. ten seconds without any activity
1395	}	1621	}
1396		1622
1397	struct ev_timer mytimer;	1623	ev_timer mytimer;
1398	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1624	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1399	ev_timer_again (&mytimer); /* start timer */	1625	ev_timer_again (&mytimer); /* start timer */
1400	ev_loop (loop, 0);	1626	ev_loop (loop, 0);
1401		1627
1402	// and in some piece of code that gets executed on any "activity":	1628	// and in some piece of code that gets executed on any "activity":
…		…
1407	=head2 C<ev_periodic> - to cron or not to cron?	1633	=head2 C<ev_periodic> - to cron or not to cron?
1408		1634
1409	Periodic watchers are also timers of a kind, but they are very versatile	1635	Periodic watchers are also timers of a kind, but they are very versatile
1410	(and unfortunately a bit complex).	1636	(and unfortunately a bit complex).
1411		1637
1412	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	1638	Unlike C<ev_timer>, periodic watchers are not based on real time (or
1413	but on wall clock time (absolute time). You can tell a periodic watcher	1639	relative time, the physical time that passes) but on wall clock time
1414	to trigger after some specific point in time. For example, if you tell a	1640	(absolute time, the thing you can read on your calender or clock). The
1415	periodic watcher to trigger in 10 seconds (by specifying e.g. C<ev_now ()	1641	difference is that wall clock time can run faster or slower than real
1416	+ 10.>, that is, an absolute time not a delay) and then reset your system	1642	time, and time jumps are not uncommon (e.g. when you adjust your
1417	clock to January of the previous year, then it will take more than year	1643	wrist-watch).
1418	to trigger the event (unlike an C<ev_timer>, which would still trigger
1419	roughly 10 seconds later as it uses a relative timeout).
1420		1644
		1645	You can tell a periodic watcher to trigger after some specific point
		1646	in time: for example, if you tell a periodic watcher to trigger "in 10
		1647	seconds" (by specifying e.g. C<ev_now () + 10.>, that is, an absolute time
		1648	not a delay) and then reset your system clock to January of the previous
		1649	year, then it will take a year or more to trigger the event (unlike an
		1650	C<ev_timer>, which would still trigger roughly 10 seconds after starting
		1651	it, as it uses a relative timeout).
		1652
1421	C<ev_periodic>s can also be used to implement vastly more complex timers,	1653	C<ev_periodic> watchers can also be used to implement vastly more complex
1422	such as triggering an event on each "midnight, local time", or other	1654	timers, such as triggering an event on each "midnight, local time", or
1423	complicated rules.	1655	other complicated rules. This cannot be done with C<ev_timer> watchers, as
		1656	those cannot react to time jumps.
1424		1657
1425	As with timers, the callback is guaranteed to be invoked only when the	1658	As with timers, the callback is guaranteed to be invoked only when the
1426	time (C<at>) has passed, but if multiple periodic timers become ready	1659	point in time where it is supposed to trigger has passed. If multiple
1427	during the same loop iteration, then order of execution is undefined.	1660	timers become ready during the same loop iteration then the ones with
		1661	earlier time-out values are invoked before ones with later time-out values
		1662	(but this is no longer true when a callback calls C<ev_loop> recursively).
1428		1663
1429	=head3 Watcher-Specific Functions and Data Members	1664	=head3 Watcher-Specific Functions and Data Members
1430		1665
1431	=over 4	1666	=over 4
1432		1667
1433	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	1668	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1434		1669
1435	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	1670	=item ev_periodic_set (ev_periodic *, ev_tstamp offset, ev_tstamp interval, reschedule_cb)
1436		1671
1437	Lots of arguments, lets sort it out... There are basically three modes of	1672	Lots of arguments, let's sort it out... There are basically three modes of
1438	operation, and we will explain them from simplest to most complex:	1673	operation, and we will explain them from simplest to most complex:
1439		1674
1440	=over 4	1675	=over 4
1441		1676
1442	=item * absolute timer (at = time, interval = reschedule_cb = 0)	1677	=item * absolute timer (offset = absolute time, interval = 0, reschedule_cb = 0)
1443		1678
1444	In this configuration the watcher triggers an event after the wall clock	1679	In this configuration the watcher triggers an event after the wall clock
1445	time C<at> has passed. It will not repeat and will not adjust when a time	1680	time C<offset> has passed. It will not repeat and will not adjust when a
1446	jump occurs, that is, if it is to be run at January 1st 2011 then it will	1681	time jump occurs, that is, if it is to be run at January 1st 2011 then it
1447	only run when the system clock reaches or surpasses this time.	1682	will be stopped and invoked when the system clock reaches or surpasses
		1683	this point in time.
1448		1684
1449	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1685	=item * repeating interval timer (offset = offset within interval, interval > 0, reschedule_cb = 0)
1450		1686
1451	In this mode the watcher will always be scheduled to time out at the next	1687	In this mode the watcher will always be scheduled to time out at the next
1452	C<at + N * interval> time (for some integer N, which can also be negative)	1688	C<offset + N * interval> time (for some integer N, which can also be
1453	and then repeat, regardless of any time jumps.	1689	negative) and then repeat, regardless of any time jumps. The C<offset>
		1690	argument is merely an offset into the C<interval> periods.
1454		1691
1455	This can be used to create timers that do not drift with respect to the	1692	This can be used to create timers that do not drift with respect to the
1456	system clock, for example, here is a C<ev_periodic> that triggers each	1693	system clock, for example, here is an C<ev_periodic> that triggers each
1457	hour, on the hour:	1694	hour, on the hour (with respect to UTC):
1458		1695
1459	ev_periodic_set (&periodic, 0., 3600., 0);	1696	ev_periodic_set (&periodic, 0., 3600., 0);
1460		1697
1461	This doesn't mean there will always be 3600 seconds in between triggers,	1698	This doesn't mean there will always be 3600 seconds in between triggers,
1462	but only that the callback will be called when the system time shows a	1699	but only that the callback will be called when the system time shows a
1463	full hour (UTC), or more correctly, when the system time is evenly divisible	1700	full hour (UTC), or more correctly, when the system time is evenly divisible
1464	by 3600.	1701	by 3600.
1465		1702
1466	Another way to think about it (for the mathematically inclined) is that	1703	Another way to think about it (for the mathematically inclined) is that
1467	C<ev_periodic> will try to run the callback in this mode at the next possible	1704	C<ev_periodic> will try to run the callback in this mode at the next possible
1468	time where C<time = at (mod interval)>, regardless of any time jumps.	1705	time where C<time = offset (mod interval)>, regardless of any time jumps.
1469		1706
1470	For numerical stability it is preferable that the C<at> value is near	1707	For numerical stability it is preferable that the C<offset> value is near
1471	C<ev_now ()> (the current time), but there is no range requirement for	1708	C<ev_now ()> (the current time), but there is no range requirement for
1472	this value, and in fact is often specified as zero.	1709	this value, and in fact is often specified as zero.
1473		1710
1474	Note also that there is an upper limit to how often a timer can fire (CPU	1711	Note also that there is an upper limit to how often a timer can fire (CPU
1475	speed for example), so if C<interval> is very small then timing stability	1712	speed for example), so if C<interval> is very small then timing stability
1476	will of course deteriorate. Libev itself tries to be exact to be about one	1713	will of course deteriorate. Libev itself tries to be exact to be about one
1477	millisecond (if the OS supports it and the machine is fast enough).	1714	millisecond (if the OS supports it and the machine is fast enough).
1478		1715
1479	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)	1716	=item * manual reschedule mode (offset ignored, interval ignored, reschedule_cb = callback)
1480		1717
1481	In this mode the values for C<interval> and C<at> are both being	1718	In this mode the values for C<interval> and C<offset> are both being
1482	ignored. Instead, each time the periodic watcher gets scheduled, the	1719	ignored. Instead, each time the periodic watcher gets scheduled, the
1483	reschedule callback will be called with the watcher as first, and the	1720	reschedule callback will be called with the watcher as first, and the
1484	current time as second argument.	1721	current time as second argument.
1485		1722
1486	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1723	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, ever,
1487	ever, or make ANY event loop modifications whatsoever>.	1724	or make ANY other event loop modifications whatsoever, unless explicitly
		1725	allowed by documentation here>.
1488		1726
1489	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop	1727	If you need to stop it, return C<now + 1e30> (or so, fudge fudge) and stop
1490	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the	1728	it afterwards (e.g. by starting an C<ev_prepare> watcher, which is the
1491	only event loop modification you are allowed to do).	1729	only event loop modification you are allowed to do).
1492		1730
1493	The callback prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic	1731	The callback prototype is C<ev_tstamp (*reschedule_cb)(ev_periodic
1494	*w, ev_tstamp now)>, e.g.:	1732	*w, ev_tstamp now)>, e.g.:
1495		1733
		1734	static ev_tstamp
1496	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1735	my_rescheduler (ev_periodic *w, ev_tstamp now)
1497	{	1736	{
1498	return now + 60.;	1737	return now + 60.;
1499	}	1738	}
1500		1739
1501	It must return the next time to trigger, based on the passed time value	1740	It must return the next time to trigger, based on the passed time value
…		…
1521	a different time than the last time it was called (e.g. in a crond like	1760	a different time than the last time it was called (e.g. in a crond like
1522	program when the crontabs have changed).	1761	program when the crontabs have changed).
1523		1762
1524	=item ev_tstamp ev_periodic_at (ev_periodic *)	1763	=item ev_tstamp ev_periodic_at (ev_periodic *)
1525		1764
1526	When active, returns the absolute time that the watcher is supposed to	1765	When active, returns the absolute time that the watcher is supposed
1527	trigger next.	1766	to trigger next. This is not the same as the C<offset> argument to
		1767	C<ev_periodic_set>, but indeed works even in interval and manual
		1768	rescheduling modes.
1528		1769
1529	=item ev_tstamp offset [read-write]	1770	=item ev_tstamp offset [read-write]
1530		1771
1531	When repeating, this contains the offset value, otherwise this is the	1772	When repeating, this contains the offset value, otherwise this is the
1532	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1773	absolute point in time (the C<offset> value passed to C<ev_periodic_set>,
		1774	although libev might modify this value for better numerical stability).
1533		1775
1534	Can be modified any time, but changes only take effect when the periodic	1776	Can be modified any time, but changes only take effect when the periodic
1535	timer fires or C<ev_periodic_again> is being called.	1777	timer fires or C<ev_periodic_again> is being called.
1536		1778
1537	=item ev_tstamp interval [read-write]	1779	=item ev_tstamp interval [read-write]
1538		1780
1539	The current interval value. Can be modified any time, but changes only	1781	The current interval value. Can be modified any time, but changes only
1540	take effect when the periodic timer fires or C<ev_periodic_again> is being	1782	take effect when the periodic timer fires or C<ev_periodic_again> is being
1541	called.	1783	called.
1542		1784
1543	=item ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) [read-write]	1785	=item ev_tstamp (*reschedule_cb)(ev_periodic *w, ev_tstamp now) [read-write]
1544		1786
1545	The current reschedule callback, or C<0>, if this functionality is	1787	The current reschedule callback, or C<0>, if this functionality is
1546	switched off. Can be changed any time, but changes only take effect when	1788	switched off. Can be changed any time, but changes only take effect when
1547	the periodic timer fires or C<ev_periodic_again> is being called.	1789	the periodic timer fires or C<ev_periodic_again> is being called.
1548		1790
…		…
1553	Example: Call a callback every hour, or, more precisely, whenever the	1795	Example: Call a callback every hour, or, more precisely, whenever the
1554	system time is divisible by 3600. The callback invocation times have	1796	system time is divisible by 3600. The callback invocation times have
1555	potentially a lot of jitter, but good long-term stability.	1797	potentially a lot of jitter, but good long-term stability.
1556		1798
1557	static void	1799	static void
1558	clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)	1800	clock_cb (struct ev_loop *loop, ev_io *w, int revents)
1559	{	1801	{
1560	... its now a full hour (UTC, or TAI or whatever your clock follows)	1802	... its now a full hour (UTC, or TAI or whatever your clock follows)
1561	}	1803	}
1562		1804
1563	struct ev_periodic hourly_tick;	1805	ev_periodic hourly_tick;
1564	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);	1806	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
1565	ev_periodic_start (loop, &hourly_tick);	1807	ev_periodic_start (loop, &hourly_tick);
1566		1808
1567	Example: The same as above, but use a reschedule callback to do it:	1809	Example: The same as above, but use a reschedule callback to do it:
1568		1810
1569	#include <math.h>	1811	#include <math.h>
1570		1812
1571	static ev_tstamp	1813	static ev_tstamp
1572	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)	1814	my_scheduler_cb (ev_periodic *w, ev_tstamp now)
1573	{	1815	{
1574	return now + (3600. - fmod (now, 3600.));	1816	return now + (3600. - fmod (now, 3600.));
1575	}	1817	}
1576		1818
1577	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);	1819	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
1578		1820
1579	Example: Call a callback every hour, starting now:	1821	Example: Call a callback every hour, starting now:
1580		1822
1581	struct ev_periodic hourly_tick;	1823	ev_periodic hourly_tick;
1582	ev_periodic_init (&hourly_tick, clock_cb,	1824	ev_periodic_init (&hourly_tick, clock_cb,
1583	fmod (ev_now (loop), 3600.), 3600., 0);	1825	fmod (ev_now (loop), 3600.), 3600., 0);
1584	ev_periodic_start (loop, &hourly_tick);	1826	ev_periodic_start (loop, &hourly_tick);
1585		1827
1586		1828
…		…
1625		1867
1626	=back	1868	=back
1627		1869
1628	=head3 Examples	1870	=head3 Examples
1629		1871
1630	Example: Try to exit cleanly on SIGINT and SIGTERM.	1872	Example: Try to exit cleanly on SIGINT.
1631		1873
1632	static void	1874	static void
1633	sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)	1875	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
1634	{	1876	{
1635	ev_unloop (loop, EVUNLOOP_ALL);	1877	ev_unloop (loop, EVUNLOOP_ALL);
1636	}	1878	}
1637		1879
1638	struct ev_signal signal_watcher;	1880	ev_signal signal_watcher;
1639	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1881	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1640	ev_signal_start (loop, &sigint_cb);	1882	ev_signal_start (loop, &signal_watcher);
1641		1883
1642		1884
1643	=head2 C<ev_child> - watch out for process status changes	1885	=head2 C<ev_child> - watch out for process status changes
1644		1886
1645	Child watchers trigger when your process receives a SIGCHLD in response to	1887	Child watchers trigger when your process receives a SIGCHLD in response to
…		…
1718	its completion.	1960	its completion.
1719		1961
1720	ev_child cw;	1962	ev_child cw;
1721		1963
1722	static void	1964	static void
1723	child_cb (EV_P_ struct ev_child *w, int revents)	1965	child_cb (EV_P_ ev_child *w, int revents)
1724	{	1966	{
1725	ev_child_stop (EV_A_ w);	1967	ev_child_stop (EV_A_ w);
1726	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);	1968	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1727	}	1969	}
1728		1970
…		…
1743		1985
1744		1986
1745	=head2 C<ev_stat> - did the file attributes just change?	1987	=head2 C<ev_stat> - did the file attributes just change?
1746		1988
1747	This watches a file system path for attribute changes. That is, it calls	1989	This watches a file system path for attribute changes. That is, it calls
1748	C<stat> regularly (or when the OS says it changed) and sees if it changed	1990	C<stat> on that path in regular intervals (or when the OS says it changed)
1749	compared to the last time, invoking the callback if it did.	1991	and sees if it changed compared to the last time, invoking the callback if
		1992	it did.
1750		1993
1751	The path does not need to exist: changing from "path exists" to "path does	1994	The path does not need to exist: changing from "path exists" to "path does
1752	not exist" is a status change like any other. The condition "path does	1995	not exist" is a status change like any other. The condition "path does not
1753	not exist" is signified by the C<st_nlink> field being zero (which is	1996	exist" (or more correctly "path cannot be stat'ed") is signified by the
1754	otherwise always forced to be at least one) and all the other fields of	1997	C<st_nlink> field being zero (which is otherwise always forced to be at
1755	the stat buffer having unspecified contents.	1998	least one) and all the other fields of the stat buffer having unspecified
		1999	contents.
1756		2000
1757	The path I<should> be absolute and I<must not> end in a slash. If it is	2001	The path I<must not> end in a slash or contain special components such as
		2002	C<.> or C<..>. The path I<should> be absolute: If it is relative and
1758	relative and your working directory changes, the behaviour is undefined.	2003	your working directory changes, then the behaviour is undefined.
1759		2004
1760	Since there is no standard kernel interface to do this, the portable	2005	Since there is no portable change notification interface available, the
1761	implementation simply calls C<stat (2)> regularly on the path to see if	2006	portable implementation simply calls C<stat(2)> regularly on the path
1762	it changed somehow. You can specify a recommended polling interval for	2007	to see if it changed somehow. You can specify a recommended polling
1763	this case. If you specify a polling interval of C<0> (highly recommended!)	2008	interval for this case. If you specify a polling interval of C<0> (highly
1764	then a I<suitable, unspecified default> value will be used (which	2009	recommended!) then a I<suitable, unspecified default> value will be used
1765	you can expect to be around five seconds, although this might change	2010	(which you can expect to be around five seconds, although this might
1766	dynamically). Libev will also impose a minimum interval which is currently	2011	change dynamically). Libev will also impose a minimum interval which is
1767	around C<0.1>, but thats usually overkill.	2012	currently around C<0.1>, but that's usually overkill.
1768		2013
1769	This watcher type is not meant for massive numbers of stat watchers,	2014	This watcher type is not meant for massive numbers of stat watchers,
1770	as even with OS-supported change notifications, this can be	2015	as even with OS-supported change notifications, this can be
1771	resource-intensive.	2016	resource-intensive.
1772		2017
1773	At the time of this writing, the only OS-specific interface implemented	2018	At the time of this writing, the only OS-specific interface implemented
1774	is the Linux inotify interface (implementing kqueue support is left as	2019	is the Linux inotify interface (implementing kqueue support is left as an
1775	an exercise for the reader. Note, however, that the author sees no way	2020	exercise for the reader. Note, however, that the author sees no way of
1776	of implementing C<ev_stat> semantics with kqueue).	2021	implementing C<ev_stat> semantics with kqueue, except as a hint).
1777		2022
1778	=head3 ABI Issues (Largefile Support)	2023	=head3 ABI Issues (Largefile Support)
1779		2024
1780	Libev by default (unless the user overrides this) uses the default	2025	Libev by default (unless the user overrides this) uses the default
1781	compilation environment, which means that on systems with large file	2026	compilation environment, which means that on systems with large file
1782	support disabled by default, you get the 32 bit version of the stat	2027	support disabled by default, you get the 32 bit version of the stat
1783	structure. When using the library from programs that change the ABI to	2028	structure. When using the library from programs that change the ABI to
1784	use 64 bit file offsets the programs will fail. In that case you have to	2029	use 64 bit file offsets the programs will fail. In that case you have to
1785	compile libev with the same flags to get binary compatibility. This is	2030	compile libev with the same flags to get binary compatibility. This is
1786	obviously the case with any flags that change the ABI, but the problem is	2031	obviously the case with any flags that change the ABI, but the problem is
1787	most noticeably disabled with ev_stat and large file support.	2032	most noticeably displayed with ev_stat and large file support.
1788		2033
1789	The solution for this is to lobby your distribution maker to make large	2034	The solution for this is to lobby your distribution maker to make large
1790	file interfaces available by default (as e.g. FreeBSD does) and not	2035	file interfaces available by default (as e.g. FreeBSD does) and not
1791	optional. Libev cannot simply switch on large file support because it has	2036	optional. Libev cannot simply switch on large file support because it has
1792	to exchange stat structures with application programs compiled using the	2037	to exchange stat structures with application programs compiled using the
1793	default compilation environment.	2038	default compilation environment.
1794		2039
1795	=head3 Inotify and Kqueue	2040	=head3 Inotify and Kqueue
1796		2041
1797	When C<inotify (7)> support has been compiled into libev (generally only	2042	When C<inotify (7)> support has been compiled into libev and present at
1798	available with Linux) and present at runtime, it will be used to speed up	2043	runtime, it will be used to speed up change detection where possible. The
1799	change detection where possible. The inotify descriptor will be created lazily	2044	inotify descriptor will be created lazily when the first C<ev_stat>
1800	when the first C<ev_stat> watcher is being started.	2045	watcher is being started.
1801		2046
1802	Inotify presence does not change the semantics of C<ev_stat> watchers	2047	Inotify presence does not change the semantics of C<ev_stat> watchers
1803	except that changes might be detected earlier, and in some cases, to avoid	2048	except that changes might be detected earlier, and in some cases, to avoid
1804	making regular C<stat> calls. Even in the presence of inotify support	2049	making regular C<stat> calls. Even in the presence of inotify support
1805	there are many cases where libev has to resort to regular C<stat> polling,	2050	there are many cases where libev has to resort to regular C<stat> polling,
1806	but as long as the path exists, libev usually gets away without polling.	2051	but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
		2052	many bugs), the path exists (i.e. stat succeeds), and the path resides on
		2053	a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
		2054	xfs are fully working) libev usually gets away without polling.
1807		2055
1808	There is no support for kqueue, as apparently it cannot be used to	2056	There is no support for kqueue, as apparently it cannot be used to
1809	implement this functionality, due to the requirement of having a file	2057	implement this functionality, due to the requirement of having a file
1810	descriptor open on the object at all times, and detecting renames, unlinks	2058	descriptor open on the object at all times, and detecting renames, unlinks
1811	etc. is difficult.	2059	etc. is difficult.
1812		2060
		2061	=head3 C<stat ()> is a synchronous operation
		2062
		2063	Libev doesn't normally do any kind of I/O itself, and so is not blocking
		2064	the process. The exception are C<ev_stat> watchers - those call C<stat
		2065	()>, which is a synchronous operation.
		2066
		2067	For local paths, this usually doesn't matter: unless the system is very
		2068	busy or the intervals between stat's are large, a stat call will be fast,
		2069	as the path data is usually in memory already (except when starting the
		2070	watcher).
		2071
		2072	For networked file systems, calling C<stat ()> can block an indefinite
		2073	time due to network issues, and even under good conditions, a stat call
		2074	often takes multiple milliseconds.
		2075
		2076	Therefore, it is best to avoid using C<ev_stat> watchers on networked
		2077	paths, although this is fully supported by libev.
		2078
1813	=head3 The special problem of stat time resolution	2079	=head3 The special problem of stat time resolution
1814		2080
1815	The C<stat ()> system call only supports full-second resolution portably, and	2081	The C<stat ()> system call only supports full-second resolution portably,
1816	even on systems where the resolution is higher, most file systems still	2082	and even on systems where the resolution is higher, most file systems
1817	only support whole seconds.	2083	still only support whole seconds.
1818		2084
1819	That means that, if the time is the only thing that changes, you can	2085	That means that, if the time is the only thing that changes, you can
1820	easily miss updates: on the first update, C<ev_stat> detects a change and	2086	easily miss updates: on the first update, C<ev_stat> detects a change and
1821	calls your callback, which does something. When there is another update	2087	calls your callback, which does something. When there is another update
1822	within the same second, C<ev_stat> will be unable to detect unless the	2088	within the same second, C<ev_stat> will be unable to detect unless the
…		…
1965		2231
1966	=head3 Watcher-Specific Functions and Data Members	2232	=head3 Watcher-Specific Functions and Data Members
1967		2233
1968	=over 4	2234	=over 4
1969		2235
1970	=item ev_idle_init (ev_signal *, callback)	2236	=item ev_idle_init (ev_idle *, callback)
1971		2237
1972	Initialises and configures the idle watcher - it has no parameters of any	2238	Initialises and configures the idle watcher - it has no parameters of any
1973	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	2239	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1974	believe me.	2240	believe me.
1975		2241
…		…
1979		2245
1980	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the	2246	Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1981	callback, free it. Also, use no error checking, as usual.	2247	callback, free it. Also, use no error checking, as usual.
1982		2248
1983	static void	2249	static void
1984	idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)	2250	idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
1985	{	2251	{
1986	free (w);	2252	free (w);
1987	// now do something you wanted to do when the program has	2253	// now do something you wanted to do when the program has
1988	// no longer anything immediate to do.	2254	// no longer anything immediate to do.
1989	}	2255	}
1990		2256
1991	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));	2257	ev_idle *idle_watcher = malloc (sizeof (ev_idle));
1992	ev_idle_init (idle_watcher, idle_cb);	2258	ev_idle_init (idle_watcher, idle_cb);
1993	ev_idle_start (loop, idle_cb);	2259	ev_idle_start (loop, idle_cb);
1994		2260
1995		2261
1996	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!	2262	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
…		…
2077		2343
2078	static ev_io iow [nfd];	2344	static ev_io iow [nfd];
2079	static ev_timer tw;	2345	static ev_timer tw;
2080		2346
2081	static void	2347	static void
2082	io_cb (ev_loop *loop, ev_io *w, int revents)	2348	io_cb (struct ev_loop *loop, ev_io *w, int revents)
2083	{	2349	{
2084	}	2350	}
2085		2351
2086	// create io watchers for each fd and a timer before blocking	2352	// create io watchers for each fd and a timer before blocking
2087	static void	2353	static void
2088	adns_prepare_cb (ev_loop *loop, ev_prepare *w, int revents)	2354	adns_prepare_cb (struct ev_loop *loop, ev_prepare *w, int revents)
2089	{	2355	{
2090	int timeout = 3600000;	2356	int timeout = 3600000;
2091	struct pollfd fds [nfd];	2357	struct pollfd fds [nfd];
2092	// actual code will need to loop here and realloc etc.	2358	// actual code will need to loop here and realloc etc.
2093	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	2359	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
…		…
2108	}	2374	}
2109	}	2375	}
2110		2376
2111	// stop all watchers after blocking	2377	// stop all watchers after blocking
2112	static void	2378	static void
2113	adns_check_cb (ev_loop *loop, ev_check *w, int revents)	2379	adns_check_cb (struct ev_loop *loop, ev_check *w, int revents)
2114	{	2380	{
2115	ev_timer_stop (loop, &tw);	2381	ev_timer_stop (loop, &tw);
2116		2382
2117	for (int i = 0; i < nfd; ++i)	2383	for (int i = 0; i < nfd; ++i)
2118	{	2384	{
…		…
2214	some fds have to be watched and handled very quickly (with low latency),	2480	some fds have to be watched and handled very quickly (with low latency),
2215	and even priorities and idle watchers might have too much overhead. In	2481	and even priorities and idle watchers might have too much overhead. In
2216	this case you would put all the high priority stuff in one loop and all	2482	this case you would put all the high priority stuff in one loop and all
2217	the rest in a second one, and embed the second one in the first.	2483	the rest in a second one, and embed the second one in the first.
2218		2484
2219	As long as the watcher is active, the callback will be invoked every time	2485	As long as the watcher is active, the callback will be invoked every
2220	there might be events pending in the embedded loop. The callback must then	2486	time there might be events pending in the embedded loop. The callback
2221	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke	2487	must then call C<ev_embed_sweep (mainloop, watcher)> to make a single
2222	their callbacks (you could also start an idle watcher to give the embedded	2488	sweep and invoke their callbacks (the callback doesn't need to invoke the
2223	loop strictly lower priority for example). You can also set the callback	2489	C<ev_embed_sweep> function directly, it could also start an idle watcher
2224	to C<0>, in which case the embed watcher will automatically execute the	2490	to give the embedded loop strictly lower priority for example).
2225	embedded loop sweep.
2226		2491
2227	As long as the watcher is started it will automatically handle events. The	2492	You can also set the callback to C<0>, in which case the embed watcher
2228	callback will be invoked whenever some events have been handled. You can	2493	will automatically execute the embedded loop sweep whenever necessary.
2229	set the callback to C<0> to avoid having to specify one if you are not
2230	interested in that.
2231		2494
2232	Also, there have not currently been made special provisions for forking:	2495	Fork detection will be handled transparently while the C<ev_embed> watcher
2233	when you fork, you not only have to call C<ev_loop_fork> on both loops,	2496	is active, i.e., the embedded loop will automatically be forked when the
2234	but you will also have to stop and restart any C<ev_embed> watchers	2497	embedding loop forks. In other cases, the user is responsible for calling
2235	yourself - but you can use a fork watcher to handle this automatically,	2498	C<ev_loop_fork> on the embedded loop.
2236	and future versions of libev might do just that.
2237		2499
2238	Unfortunately, not all backends are embeddable, only the ones returned by	2500	Unfortunately, not all backends are embeddable: only the ones returned by
2239	C<ev_embeddable_backends> are, which, unfortunately, does not include any	2501	C<ev_embeddable_backends> are, which, unfortunately, does not include any
2240	portable one.	2502	portable one.
2241		2503
2242	So when you want to use this feature you will always have to be prepared	2504	So when you want to use this feature you will always have to be prepared
2243	that you cannot get an embeddable loop. The recommended way to get around	2505	that you cannot get an embeddable loop. The recommended way to get around
2244	this is to have a separate variables for your embeddable loop, try to	2506	this is to have a separate variables for your embeddable loop, try to
2245	create it, and if that fails, use the normal loop for everything.	2507	create it, and if that fails, use the normal loop for everything.
		2508
		2509	=head3 C<ev_embed> and fork
		2510
		2511	While the C<ev_embed> watcher is running, forks in the embedding loop will
		2512	automatically be applied to the embedded loop as well, so no special
		2513	fork handling is required in that case. When the watcher is not running,
		2514	however, it is still the task of the libev user to call C<ev_loop_fork ()>
		2515	as applicable.
2246		2516
2247	=head3 Watcher-Specific Functions and Data Members	2517	=head3 Watcher-Specific Functions and Data Members
2248		2518
2249	=over 4	2519	=over 4
2250		2520
…		…
2278	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be	2548	C<loop_lo> (which is C<loop_hi> in the case no embeddable loop can be
2279	used).	2549	used).
2280		2550
2281	struct ev_loop *loop_hi = ev_default_init (0);	2551	struct ev_loop *loop_hi = ev_default_init (0);
2282	struct ev_loop *loop_lo = 0;	2552	struct ev_loop *loop_lo = 0;
2283	struct ev_embed embed;	2553	ev_embed embed;
2284		2554
2285	// see if there is a chance of getting one that works	2555	// see if there is a chance of getting one that works
2286	// (remember that a flags value of 0 means autodetection)	2556	// (remember that a flags value of 0 means autodetection)
2287	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()	2557	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
2288	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())	2558	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
…		…
2302	kqueue implementation). Store the kqueue/socket-only event loop in	2572	kqueue implementation). Store the kqueue/socket-only event loop in
2303	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).	2573	C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
2304		2574
2305	struct ev_loop *loop = ev_default_init (0);	2575	struct ev_loop *loop = ev_default_init (0);
2306	struct ev_loop *loop_socket = 0;	2576	struct ev_loop *loop_socket = 0;
2307	struct ev_embed embed;	2577	ev_embed embed;
2308		2578
2309	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)	2579	if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2310	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))	2580	if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2311	{	2581	{
2312	ev_embed_init (&embed, 0, loop_socket);	2582	ev_embed_init (&embed, 0, loop_socket);
…		…
2368	is that the author does not know of a simple (or any) algorithm for a	2638	is that the author does not know of a simple (or any) algorithm for a
2369	multiple-writer-single-reader queue that works in all cases and doesn't	2639	multiple-writer-single-reader queue that works in all cases and doesn't
2370	need elaborate support such as pthreads.	2640	need elaborate support such as pthreads.
2371		2641
2372	That means that if you want to queue data, you have to provide your own	2642	That means that if you want to queue data, you have to provide your own
2373	queue. But at least I can tell you would implement locking around your	2643	queue. But at least I can tell you how to implement locking around your
2374	queue:	2644	queue:
2375		2645
2376	=over 4	2646	=over 4
2377		2647
2378	=item queueing from a signal handler context	2648	=item queueing from a signal handler context
2379		2649
2380	To implement race-free queueing, you simply add to the queue in the signal	2650	To implement race-free queueing, you simply add to the queue in the signal
2381	handler but you block the signal handler in the watcher callback. Here is an example that does that for	2651	handler but you block the signal handler in the watcher callback. Here is
2382	some fictitious SIGUSR1 handler:	2652	an example that does that for some fictitious SIGUSR1 handler:
2383		2653
2384	static ev_async mysig;	2654	static ev_async mysig;
2385		2655
2386	static void	2656	static void
2387	sigusr1_handler (void)	2657	sigusr1_handler (void)
…		…
2453	=over 4	2723	=over 4
2454		2724
2455	=item ev_async_init (ev_async *, callback)	2725	=item ev_async_init (ev_async *, callback)
2456		2726
2457	Initialises and configures the async watcher - it has no parameters of any	2727	Initialises and configures the async watcher - it has no parameters of any
2458	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,	2728	kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2459	believe me.	2729	trust me.
2460		2730
2461	=item ev_async_send (loop, ev_async *)	2731	=item ev_async_send (loop, ev_async *)
2462		2732
2463	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	2733	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2464	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	2734	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2465	C<ev_feed_event>, this call is safe to do in other threads, signal or	2735	C<ev_feed_event>, this call is safe to do from other threads, signal or
2466	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	2736	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding
2467	section below on what exactly this means).	2737	section below on what exactly this means).
2468		2738
		2739	Note that, as with other watchers in libev, multiple events might get
		2740	compressed into a single callback invocation (another way to look at this
		2741	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
		2742	reset when the event loop detects that).
		2743
2469	This call incurs the overhead of a system call only once per loop iteration,	2744	This call incurs the overhead of a system call only once per event loop
2470	so while the overhead might be noticeable, it doesn't apply to repeated	2745	iteration, so while the overhead might be noticeable, it doesn't apply to
2471	calls to C<ev_async_send>.	2746	repeated calls to C<ev_async_send> for the same event loop.
2472		2747
2473	=item bool = ev_async_pending (ev_async *)	2748	=item bool = ev_async_pending (ev_async *)
2474		2749
2475	Returns a non-zero value when C<ev_async_send> has been called on the	2750	Returns a non-zero value when C<ev_async_send> has been called on the
2476	watcher but the event has not yet been processed (or even noted) by the	2751	watcher but the event has not yet been processed (or even noted) by the
…		…
2479	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When	2754	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2480	the loop iterates next and checks for the watcher to have become active,	2755	the loop iterates next and checks for the watcher to have become active,
2481	it will reset the flag again. C<ev_async_pending> can be used to very	2756	it will reset the flag again. C<ev_async_pending> can be used to very
2482	quickly check whether invoking the loop might be a good idea.	2757	quickly check whether invoking the loop might be a good idea.
2483		2758
2484	Not that this does I<not> check whether the watcher itself is pending, only	2759	Not that this does I<not> check whether the watcher itself is pending,
2485	whether it has been requested to make this watcher pending.	2760	only whether it has been requested to make this watcher pending: there
		2761	is a time window between the event loop checking and resetting the async
		2762	notification, and the callback being invoked.
2486		2763
2487	=back	2764	=back
2488		2765
2489		2766
2490	=head1 OTHER FUNCTIONS	2767	=head1 OTHER FUNCTIONS
…		…
2494	=over 4	2771	=over 4
2495		2772
2496	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	2773	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
2497		2774
2498	This function combines a simple timer and an I/O watcher, calls your	2775	This function combines a simple timer and an I/O watcher, calls your
2499	callback on whichever event happens first and automatically stop both	2776	callback on whichever event happens first and automatically stops both
2500	watchers. This is useful if you want to wait for a single event on an fd	2777	watchers. This is useful if you want to wait for a single event on an fd
2501	or timeout without having to allocate/configure/start/stop/free one or	2778	or timeout without having to allocate/configure/start/stop/free one or
2502	more watchers yourself.	2779	more watchers yourself.
2503		2780
2504	If C<fd> is less than 0, then no I/O watcher will be started and events	2781	If C<fd> is less than 0, then no I/O watcher will be started and the
2505	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	2782	C<events> argument is being ignored. Otherwise, an C<ev_io> watcher for
2506	C<events> set will be created and started.	2783	the given C<fd> and C<events> set will be created and started.
2507		2784
2508	If C<timeout> is less than 0, then no timeout watcher will be	2785	If C<timeout> is less than 0, then no timeout watcher will be
2509	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	2786	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2510	repeat = 0) will be started. While C<0> is a valid timeout, it is of	2787	repeat = 0) will be started. C<0> is a valid timeout.
2511	dubious value.
2512		2788
2513	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	2789	The callback has the type C<void (*cb)(int revents, void *arg)> and gets
2514	passed an C<revents> set like normal event callbacks (a combination of	2790	passed an C<revents> set like normal event callbacks (a combination of
2515	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	2791	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
2516	value passed to C<ev_once>:	2792	value passed to C<ev_once>. Note that it is possible to receive I<both>
		2793	a timeout and an io event at the same time - you probably should give io
		2794	events precedence.
		2795
		2796	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2517		2797
2518	static void stdin_ready (int revents, void *arg)	2798	static void stdin_ready (int revents, void *arg)
2519	{	2799	{
		2800	if (revents & EV_READ)
		2801	/* stdin might have data for us, joy! */;
2520	if (revents & EV_TIMEOUT)	2802	else if (revents & EV_TIMEOUT)
2521	/* doh, nothing entered */;	2803	/* doh, nothing entered */;
2522	else if (revents & EV_READ)
2523	/* stdin might have data for us, joy! */;
2524	}	2804	}
2525		2805
2526	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	2806	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2527		2807
2528	=item ev_feed_event (ev_loop *, watcher *, int revents)	2808	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2529		2809
2530	Feeds the given event set into the event loop, as if the specified event	2810	Feeds the given event set into the event loop, as if the specified event
2531	had happened for the specified watcher (which must be a pointer to an	2811	had happened for the specified watcher (which must be a pointer to an
2532	initialised but not necessarily started event watcher).	2812	initialised but not necessarily started event watcher).
2533		2813
2534	=item ev_feed_fd_event (ev_loop *, int fd, int revents)	2814	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)
2535		2815
2536	Feed an event on the given fd, as if a file descriptor backend detected	2816	Feed an event on the given fd, as if a file descriptor backend detected
2537	the given events it.	2817	the given events it.
2538		2818
2539	=item ev_feed_signal_event (ev_loop *loop, int signum)	2819	=item ev_feed_signal_event (struct ev_loop *loop, int signum)
2540		2820
2541	Feed an event as if the given signal occurred (C<loop> must be the default	2821	Feed an event as if the given signal occurred (C<loop> must be the default
2542	loop!).	2822	loop!).
2543		2823
2544	=back	2824	=back
…		…
2666		2946
2667	myclass obj;	2947	myclass obj;
2668	ev::io iow;	2948	ev::io iow;
2669	iow.set <myclass, &myclass::io_cb> (&obj);	2949	iow.set <myclass, &myclass::io_cb> (&obj);
2670		2950
		2951	=item w->set (object *)
		2952
		2953	This is an B<experimental> feature that might go away in a future version.
		2954
		2955	This is a variation of a method callback - leaving out the method to call
		2956	will default the method to C<operator ()>, which makes it possible to use
		2957	functor objects without having to manually specify the C<operator ()> all
		2958	the time. Incidentally, you can then also leave out the template argument
		2959	list.
		2960
		2961	The C<operator ()> method prototype must be C<void operator ()(watcher &w,
		2962	int revents)>.
		2963
		2964	See the method-C<set> above for more details.
		2965
		2966	Example: use a functor object as callback.
		2967
		2968	struct myfunctor
		2969	{
		2970	void operator() (ev::io &w, int revents)
		2971	{
		2972	...
		2973	}
		2974	}
		2975
		2976	myfunctor f;
		2977
		2978	ev::io w;
		2979	w.set (&f);
		2980
2671	=item w->set<function> (void *data = 0)	2981	=item w->set<function> (void *data = 0)
2672		2982
2673	Also sets a callback, but uses a static method or plain function as	2983	Also sets a callback, but uses a static method or plain function as
2674	callback. The optional C<data> argument will be stored in the watcher's	2984	callback. The optional C<data> argument will be stored in the watcher's
2675	C<data> member and is free for you to use.	2985	C<data> member and is free for you to use.
2676		2986
2677	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.	2987	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
2678		2988
2679	See the method-C<set> above for more details.	2989	See the method-C<set> above for more details.
2680		2990
2681	Example:	2991	Example: Use a plain function as callback.
2682		2992
2683	static void io_cb (ev::io &w, int revents) { }	2993	static void io_cb (ev::io &w, int revents) { }
2684	iow.set <io_cb> ();	2994	iow.set <io_cb> ();
2685		2995
2686	=item w->set (struct ev_loop *)	2996	=item w->set (struct ev_loop *)
…		…
2724	Example: Define a class with an IO and idle watcher, start one of them in	3034	Example: Define a class with an IO and idle watcher, start one of them in
2725	the constructor.	3035	the constructor.
2726		3036
2727	class myclass	3037	class myclass
2728	{	3038	{
2729	ev::io io; void io_cb (ev::io &w, int revents);	3039	ev::io io ; void io_cb (ev::io &w, int revents);
2730	ev:idle idle void idle_cb (ev::idle &w, int revents);	3040	ev::idle idle; void idle_cb (ev::idle &w, int revents);
2731		3041
2732	myclass (int fd)	3042	myclass (int fd)
2733	{	3043	{
2734	io .set <myclass, &myclass::io_cb > (this);	3044	io .set <myclass, &myclass::io_cb > (this);
2735	idle.set <myclass, &myclass::idle_cb> (this);	3045	idle.set <myclass, &myclass::idle_cb> (this);
…		…
2751	=item Perl	3061	=item Perl
2752		3062
2753	The EV module implements the full libev API and is actually used to test	3063	The EV module implements the full libev API and is actually used to test
2754	libev. EV is developed together with libev. Apart from the EV core module,	3064	libev. EV is developed together with libev. Apart from the EV core module,
2755	there are additional modules that implement libev-compatible interfaces	3065	there are additional modules that implement libev-compatible interfaces
2756	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the	3066	to C<libadns> (C<EV::ADNS>, but C<AnyEvent::DNS> is preferred nowadays),
2757	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).	3067	C<Net::SNMP> (C<Net::SNMP::EV>) and the C<libglib> event core (C<Glib::EV>
		3068	and C<EV::Glib>).
2758		3069
2759	It can be found and installed via CPAN, its homepage is at	3070	It can be found and installed via CPAN, its homepage is at
2760	L<http://software.schmorp.de/pkg/EV>.	3071	L<http://software.schmorp.de/pkg/EV>.
2761		3072
2762	=item Python	3073	=item Python
2763		3074
2764	Python bindings can be found at L<http://code.google.com/p/pyev/>. It	3075	Python bindings can be found at L<http://code.google.com/p/pyev/>. It
2765	seems to be quite complete and well-documented. Note, however, that the	3076	seems to be quite complete and well-documented.
2766	patch they require for libev is outright dangerous as it breaks the ABI
2767	for everybody else, and therefore, should never be applied in an installed
2768	libev (if python requires an incompatible ABI then it needs to embed
2769	libev).
2770		3077
2771	=item Ruby	3078	=item Ruby
2772		3079
2773	Tony Arcieri has written a ruby extension that offers access to a subset	3080	Tony Arcieri has written a ruby extension that offers access to a subset
2774	of the libev API and adds file handle abstractions, asynchronous DNS and	3081	of the libev API and adds file handle abstractions, asynchronous DNS and
2775	more on top of it. It can be found via gem servers. Its homepage is at	3082	more on top of it. It can be found via gem servers. Its homepage is at
2776	L<http://rev.rubyforge.org/>.	3083	L<http://rev.rubyforge.org/>.
2777		3084
		3085	Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
		3086	makes rev work even on mingw.
		3087
		3088	=item Haskell
		3089
		3090	A haskell binding to libev is available at
		3091	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
		3092
2778	=item D	3093	=item D
2779		3094
2780	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	3095	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2781	be found at L<http://proj.llucax.com.ar/wiki/evd>.	3096	be found at L<http://proj.llucax.com.ar/wiki/evd>.
		3097
		3098	=item Ocaml
		3099
		3100	Erkki Seppala has written Ocaml bindings for libev, to be found at
		3101	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2782		3102
2783	=back	3103	=back
2784		3104
2785		3105
2786	=head1 MACRO MAGIC	3106	=head1 MACRO MAGIC
…		…
2887		3207
2888	#define EV_STANDALONE 1	3208	#define EV_STANDALONE 1
2889	#include "ev.h"	3209	#include "ev.h"
2890		3210
2891	Both header files and implementation files can be compiled with a C++	3211	Both header files and implementation files can be compiled with a C++
2892	compiler (at least, thats a stated goal, and breakage will be treated	3212	compiler (at least, that's a stated goal, and breakage will be treated
2893	as a bug).	3213	as a bug).
2894		3214
2895	You need the following files in your source tree, or in a directory	3215	You need the following files in your source tree, or in a directory
2896	in your include path (e.g. in libev/ when using -Ilibev):	3216	in your include path (e.g. in libev/ when using -Ilibev):
2897		3217
…		…
2941		3261
2942	=head2 PREPROCESSOR SYMBOLS/MACROS	3262	=head2 PREPROCESSOR SYMBOLS/MACROS
2943		3263
2944	Libev can be configured via a variety of preprocessor symbols you have to	3264	Libev can be configured via a variety of preprocessor symbols you have to
2945	define before including any of its files. The default in the absence of	3265	define before including any of its files. The default in the absence of
2946	autoconf is noted for every option.	3266	autoconf is documented for every option.
2947		3267
2948	=over 4	3268	=over 4
2949		3269
2950	=item EV_STANDALONE	3270	=item EV_STANDALONE
2951		3271
…		…
2953	keeps libev from including F<config.h>, and it also defines dummy	3273	keeps libev from including F<config.h>, and it also defines dummy
2954	implementations for some libevent functions (such as logging, which is not	3274	implementations for some libevent functions (such as logging, which is not
2955	supported). It will also not define any of the structs usually found in	3275	supported). It will also not define any of the structs usually found in
2956	F<event.h> that are not directly supported by the libev core alone.	3276	F<event.h> that are not directly supported by the libev core alone.
2957		3277
		3278	In stanbdalone mode, libev will still try to automatically deduce the
		3279	configuration, but has to be more conservative.
		3280
2958	=item EV_USE_MONOTONIC	3281	=item EV_USE_MONOTONIC
2959		3282
2960	If defined to be C<1>, libev will try to detect the availability of the	3283	If defined to be C<1>, libev will try to detect the availability of the
2961	monotonic clock option at both compile time and runtime. Otherwise no use	3284	monotonic clock option at both compile time and runtime. Otherwise no
2962	of the monotonic clock option will be attempted. If you enable this, you	3285	use of the monotonic clock option will be attempted. If you enable this,
2963	usually have to link against librt or something similar. Enabling it when	3286	you usually have to link against librt or something similar. Enabling it
2964	the functionality isn't available is safe, though, although you have	3287	when the functionality isn't available is safe, though, although you have
2965	to make sure you link against any libraries where the C<clock_gettime>	3288	to make sure you link against any libraries where the C<clock_gettime>
2966	function is hiding in (often F<-lrt>).	3289	function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
2967		3290
2968	=item EV_USE_REALTIME	3291	=item EV_USE_REALTIME
2969		3292
2970	If defined to be C<1>, libev will try to detect the availability of the	3293	If defined to be C<1>, libev will try to detect the availability of the
2971	real-time clock option at compile time (and assume its availability at	3294	real-time clock option at compile time (and assume its availability
2972	runtime if successful). Otherwise no use of the real-time clock option will	3295	at runtime if successful). Otherwise no use of the real-time clock
2973	be attempted. This effectively replaces C<gettimeofday> by C<clock_get	3296	option will be attempted. This effectively replaces C<gettimeofday>
2974	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the	3297	by C<clock_get (CLOCK_REALTIME, ...)> and will not normally affect
2975	note about libraries in the description of C<EV_USE_MONOTONIC>, though.	3298	correctness. See the note about libraries in the description of
		3299	C<EV_USE_MONOTONIC>, though. Defaults to the opposite value of
		3300	C<EV_USE_CLOCK_SYSCALL>.
		3301
		3302	=item EV_USE_CLOCK_SYSCALL
		3303
		3304	If defined to be C<1>, libev will try to use a direct syscall instead
		3305	of calling the system-provided C<clock_gettime> function. This option
		3306	exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
		3307	unconditionally pulls in C<libpthread>, slowing down single-threaded
		3308	programs needlessly. Using a direct syscall is slightly slower (in
		3309	theory), because no optimised vdso implementation can be used, but avoids
		3310	the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
		3311	higher, as it simplifies linking (no need for C<-lrt>).
2976		3312
2977	=item EV_USE_NANOSLEEP	3313	=item EV_USE_NANOSLEEP
2978		3314
2979	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	3315	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2980	and will use it for delays. Otherwise it will use C<select ()>.	3316	and will use it for delays. Otherwise it will use C<select ()>.
…		…
2996		3332
2997	=item EV_SELECT_USE_FD_SET	3333	=item EV_SELECT_USE_FD_SET
2998		3334
2999	If defined to C<1>, then the select backend will use the system C<fd_set>	3335	If defined to C<1>, then the select backend will use the system C<fd_set>
3000	structure. This is useful if libev doesn't compile due to a missing	3336	structure. This is useful if libev doesn't compile due to a missing
3001	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on	3337	C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
3002	exotic systems. This usually limits the range of file descriptors to some	3338	on exotic systems. This usually limits the range of file descriptors to
3003	low limit such as 1024 or might have other limitations (winsocket only	3339	some low limit such as 1024 or might have other limitations (winsocket
3004	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might	3340	only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3005	influence the size of the C<fd_set> used.	3341	configures the maximum size of the C<fd_set>.
3006		3342
3007	=item EV_SELECT_IS_WINSOCKET	3343	=item EV_SELECT_IS_WINSOCKET
3008		3344
3009	When defined to C<1>, the select backend will assume that	3345	When defined to C<1>, the select backend will assume that
3010	select/socket/connect etc. don't understand file descriptors but	3346	select/socket/connect etc. don't understand file descriptors but
…		…
3121	When doing priority-based operations, libev usually has to linearly search	3457	When doing priority-based operations, libev usually has to linearly search
3122	all the priorities, so having many of them (hundreds) uses a lot of space	3458	all the priorities, so having many of them (hundreds) uses a lot of space
3123	and time, so using the defaults of five priorities (-2 .. +2) is usually	3459	and time, so using the defaults of five priorities (-2 .. +2) is usually
3124	fine.	3460	fine.
3125		3461
3126	If your embedding application does not need any priorities, defining these both to	3462	If your embedding application does not need any priorities, defining these
3127	C<0> will save some memory and CPU.	3463	both to C<0> will save some memory and CPU.
3128		3464
3129	=item EV_PERIODIC_ENABLE	3465	=item EV_PERIODIC_ENABLE
3130		3466
3131	If undefined or defined to be C<1>, then periodic timers are supported. If	3467	If undefined or defined to be C<1>, then periodic timers are supported. If
3132	defined to be C<0>, then they are not. Disabling them saves a few kB of	3468	defined to be C<0>, then they are not. Disabling them saves a few kB of
…		…
3139	code.	3475	code.
3140		3476
3141	=item EV_EMBED_ENABLE	3477	=item EV_EMBED_ENABLE
3142		3478
3143	If undefined or defined to be C<1>, then embed watchers are supported. If	3479	If undefined or defined to be C<1>, then embed watchers are supported. If
3144	defined to be C<0>, then they are not.	3480	defined to be C<0>, then they are not. Embed watchers rely on most other
		3481	watcher types, which therefore must not be disabled.
3145		3482
3146	=item EV_STAT_ENABLE	3483	=item EV_STAT_ENABLE
3147		3484
3148	If undefined or defined to be C<1>, then stat watchers are supported. If	3485	If undefined or defined to be C<1>, then stat watchers are supported. If
3149	defined to be C<0>, then they are not.	3486	defined to be C<0>, then they are not.
…		…
3181	two).	3518	two).
3182		3519
3183	=item EV_USE_4HEAP	3520	=item EV_USE_4HEAP
3184		3521
3185	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3522	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3186	timer and periodics heap, libev uses a 4-heap when this symbol is defined	3523	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3187	to C<1>. The 4-heap uses more complicated (longer) code but has	3524	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3188	noticeably faster performance with many (thousands) of watchers.	3525	faster performance with many (thousands) of watchers.
3189		3526
3190	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3527	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3191	(disabled).	3528	(disabled).
3192		3529
3193	=item EV_HEAP_CACHE_AT	3530	=item EV_HEAP_CACHE_AT
3194		3531
3195	Heaps are not very cache-efficient. To improve the cache-efficiency of the	3532	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3196	timer and periodics heap, libev can cache the timestamp (I<at>) within	3533	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3197	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	3534	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3198	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	3535	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3199	but avoids random read accesses on heap changes. This improves performance	3536	but avoids random read accesses on heap changes. This improves performance
3200	noticeably with with many (hundreds) of watchers.	3537	noticeably with many (hundreds) of watchers.
3201		3538
3202	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	3539	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
3203	(disabled).	3540	(disabled).
3204		3541
3205	=item EV_VERIFY	3542	=item EV_VERIFY
…		…
3211	called once per loop, which can slow down libev. If set to C<3>, then the	3548	called once per loop, which can slow down libev. If set to C<3>, then the
3212	verification code will be called very frequently, which will slow down	3549	verification code will be called very frequently, which will slow down
3213	libev considerably.	3550	libev considerably.
3214		3551
3215	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	3552	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be
3216	C<0.>	3553	C<0>.
3217		3554
3218	=item EV_COMMON	3555	=item EV_COMMON
3219		3556
3220	By default, all watchers have a C<void *data> member. By redefining	3557	By default, all watchers have a C<void *data> member. By redefining
3221	this macro to a something else you can include more and other types of	3558	this macro to a something else you can include more and other types of
…		…
3238	and the way callbacks are invoked and set. Must expand to a struct member	3575	and the way callbacks are invoked and set. Must expand to a struct member
3239	definition and a statement, respectively. See the F<ev.h> header file for	3576	definition and a statement, respectively. See the F<ev.h> header file for
3240	their default definitions. One possible use for overriding these is to	3577	their default definitions. One possible use for overriding these is to
3241	avoid the C<struct ev_loop *> as first argument in all cases, or to use	3578	avoid the C<struct ev_loop *> as first argument in all cases, or to use
3242	method calls instead of plain function calls in C++.	3579	method calls instead of plain function calls in C++.
		3580
		3581	=back
3243		3582
3244	=head2 EXPORTED API SYMBOLS	3583	=head2 EXPORTED API SYMBOLS
3245		3584
3246	If you need to re-export the API (e.g. via a DLL) and you need a list of	3585	If you need to re-export the API (e.g. via a DLL) and you need a list of
3247	exported symbols, you can use the provided F<Symbol.*> files which list	3586	exported symbols, you can use the provided F<Symbol.*> files which list
…		…
3294	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	3633	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3295		3634
3296	#include "ev_cpp.h"	3635	#include "ev_cpp.h"
3297	#include "ev.c"	3636	#include "ev.c"
3298		3637
		3638	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES
3299		3639
3300	=head1 THREADS AND COROUTINES	3640	=head2 THREADS AND COROUTINES
3301		3641
3302	=head2 THREADS	3642	=head3 THREADS
3303		3643
3304	Libev itself is thread-safe (unless the opposite is specifically	3644	All libev functions are reentrant and thread-safe unless explicitly
3305	documented for a function), but it uses no locking itself. This means that	3645	documented otherwise, but libev implements no locking itself. This means
3306	you can use as many loops as you want in parallel, as long as only one	3646	that you can use as many loops as you want in parallel, as long as there
3307	thread ever calls into one libev function with the same loop parameter:	3647	are no concurrent calls into any libev function with the same loop
		3648	parameter (C<ev_default_*> calls have an implicit default loop parameter,
3308	libev guarentees that different event loops share no data structures that	3649	of course): libev guarantees that different event loops share no data
3309	need locking.	3650	structures that need any locking.
3310		3651
3311	Or to put it differently: calls with different loop parameters can be done	3652	Or to put it differently: calls with different loop parameters can be done
3312	concurrently from multiple threads, calls with the same loop parameter	3653	concurrently from multiple threads, calls with the same loop parameter
3313	must be done serially (but can be done from different threads, as long as	3654	must be done serially (but can be done from different threads, as long as
3314	only one thread ever is inside a call at any point in time, e.g. by using	3655	only one thread ever is inside a call at any point in time, e.g. by using
3315	a mutex per loop).	3656	a mutex per loop).
3316		3657
3317	Specifically to support threads (and signal handlers), libev implements	3658	Specifically to support threads (and signal handlers), libev implements
3318	so-called C<ev_async> watchers, which allow some limited form of	3659	so-called C<ev_async> watchers, which allow some limited form of
3319	concurrency on the same event loop.	3660	concurrency on the same event loop, namely waking it up "from the
		3661	outside".
3320		3662
3321	If you want to know which design (one loop, locking, or multiple loops	3663	If you want to know which design (one loop, locking, or multiple loops
3322	without or something else still) is best for your problem, then I cannot	3664	without or something else still) is best for your problem, then I cannot
3323	help you. I can give some generic advice however:	3665	help you, but here is some generic advice:
3324		3666
3325	=over 4	3667	=over 4
3326		3668
3327	=item * most applications have a main thread: use the default libev loop	3669	=item * most applications have a main thread: use the default libev loop
3328	in that thread, or create a separate thread running only the default loop.	3670	in that thread, or create a separate thread running only the default loop.
…		…
3352	default loop and triggering an C<ev_async> watcher from the default loop	3694	default loop and triggering an C<ev_async> watcher from the default loop
3353	watcher callback into the event loop interested in the signal.	3695	watcher callback into the event loop interested in the signal.
3354		3696
3355	=back	3697	=back
3356		3698
3357	=head2 COROUTINES	3699	=head3 COROUTINES
3358		3700
3359	Libev is much more accommodating to coroutines ("cooperative threads"):	3701	Libev is very accommodating to coroutines ("cooperative threads"):
3360	libev fully supports nesting calls to it's functions from different	3702	libev fully supports nesting calls to its functions from different
3361	coroutines (e.g. you can call C<ev_loop> on the same loop from two	3703	coroutines (e.g. you can call C<ev_loop> on the same loop from two
3362	different coroutines and switch freely between both coroutines running the	3704	different coroutines, and switch freely between both coroutines running the
3363	loop, as long as you don't confuse yourself). The only exception is that	3705	loop, as long as you don't confuse yourself). The only exception is that
3364	you must not do this from C<ev_periodic> reschedule callbacks.	3706	you must not do this from C<ev_periodic> reschedule callbacks.
3365		3707
3366	Care has been taken to ensure that libev does not keep local state inside	3708	Care has been taken to ensure that libev does not keep local state inside
3367	C<ev_loop>, and other calls do not usually allow coroutine switches.	3709	C<ev_loop>, and other calls do not usually allow for coroutine switches as
		3710	they do not call any callbacks.
3368		3711
		3712	=head2 COMPILER WARNINGS
3369		3713
3370	=head1 COMPLEXITIES	3714	Depending on your compiler and compiler settings, you might get no or a
		3715	lot of warnings when compiling libev code. Some people are apparently
		3716	scared by this.
3371		3717
3372	In this section the complexities of (many of) the algorithms used inside	3718	However, these are unavoidable for many reasons. For one, each compiler
3373	libev will be explained. For complexity discussions about backends see the	3719	has different warnings, and each user has different tastes regarding
3374	documentation for C<ev_default_init>.	3720	warning options. "Warn-free" code therefore cannot be a goal except when
		3721	targeting a specific compiler and compiler-version.
3375		3722
3376	All of the following are about amortised time: If an array needs to be	3723	Another reason is that some compiler warnings require elaborate
3377	extended, libev needs to realloc and move the whole array, but this	3724	workarounds, or other changes to the code that make it less clear and less
3378	happens asymptotically never with higher number of elements, so O(1) might	3725	maintainable.
3379	mean it might do a lengthy realloc operation in rare cases, but on average
3380	it is much faster and asymptotically approaches constant time.
3381		3726
3382	=over 4	3727	And of course, some compiler warnings are just plain stupid, or simply
		3728	wrong (because they don't actually warn about the condition their message
		3729	seems to warn about). For example, certain older gcc versions had some
		3730	warnings that resulted an extreme number of false positives. These have
		3731	been fixed, but some people still insist on making code warn-free with
		3732	such buggy versions.
3383		3733
3384	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	3734	While libev is written to generate as few warnings as possible,
		3735	"warn-free" code is not a goal, and it is recommended not to build libev
		3736	with any compiler warnings enabled unless you are prepared to cope with
		3737	them (e.g. by ignoring them). Remember that warnings are just that:
		3738	warnings, not errors, or proof of bugs.
3385		3739
3386	This means that, when you have a watcher that triggers in one hour and
3387	there are 100 watchers that would trigger before that then inserting will
3388	have to skip roughly seven (C<ld 100>) of these watchers.
3389		3740
3390	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3741	=head2 VALGRIND
3391		3742
3392	That means that changing a timer costs less than removing/adding them	3743	Valgrind has a special section here because it is a popular tool that is
3393	as only the relative motion in the event queue has to be paid for.	3744	highly useful. Unfortunately, valgrind reports are very hard to interpret.
3394		3745
3395	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)	3746	If you think you found a bug (memory leak, uninitialised data access etc.)
		3747	in libev, then check twice: If valgrind reports something like:
3396		3748
3397	These just add the watcher into an array or at the head of a list.	3749	==2274== definitely lost: 0 bytes in 0 blocks.
		3750	==2274== possibly lost: 0 bytes in 0 blocks.
		3751	==2274== still reachable: 256 bytes in 1 blocks.
3398		3752
3399	=item Stopping check/prepare/idle/fork/async watchers: O(1)	3753	Then there is no memory leak, just as memory accounted to global variables
		3754	is not a memleak - the memory is still being referenced, and didn't leak.
3400		3755
3401	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3756	Similarly, under some circumstances, valgrind might report kernel bugs
		3757	as if it were a bug in libev (e.g. in realloc or in the poll backend,
		3758	although an acceptable workaround has been found here), or it might be
		3759	confused.
3402		3760
3403	These watchers are stored in lists then need to be walked to find the	3761	Keep in mind that valgrind is a very good tool, but only a tool. Don't
3404	correct watcher to remove. The lists are usually short (you don't usually	3762	make it into some kind of religion.
3405	have many watchers waiting for the same fd or signal).
3406		3763
3407	=item Finding the next timer in each loop iteration: O(1)	3764	If you are unsure about something, feel free to contact the mailing list
		3765	with the full valgrind report and an explanation on why you think this
		3766	is a bug in libev (best check the archives, too :). However, don't be
		3767	annoyed when you get a brisk "this is no bug" answer and take the chance
		3768	of learning how to interpret valgrind properly.
3408		3769
3409	By virtue of using a binary or 4-heap, the next timer is always found at a	3770	If you need, for some reason, empty reports from valgrind for your project
3410	fixed position in the storage array.	3771	I suggest using suppression lists.
3411		3772
3412	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
3413		3773
3414	A change means an I/O watcher gets started or stopped, which requires	3774	=head1 PORTABILITY NOTES
3415	libev to recalculate its status (and possibly tell the kernel, depending
3416	on backend and whether C<ev_io_set> was used).
3417		3775
3418	=item Activating one watcher (putting it into the pending state): O(1)
3419
3420	=item Priority handling: O(number_of_priorities)
3421
3422	Priorities are implemented by allocating some space for each
3423	priority. When doing priority-based operations, libev usually has to
3424	linearly search all the priorities, but starting/stopping and activating
3425	watchers becomes O(1) w.r.t. priority handling.
3426
3427	=item Sending an ev_async: O(1)
3428
3429	=item Processing ev_async_send: O(number_of_async_watchers)
3430
3431	=item Processing signals: O(max_signal_number)
3432
3433	Sending involves a system call I<iff> there were no other C<ev_async_send>
3434	calls in the current loop iteration. Checking for async and signal events
3435	involves iterating over all running async watchers or all signal numbers.
3436
3437	=back
3438
3439
3440	=head1 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	3776	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
3441		3777
3442	Win32 doesn't support any of the standards (e.g. POSIX) that libev	3778	Win32 doesn't support any of the standards (e.g. POSIX) that libev
3443	requires, and its I/O model is fundamentally incompatible with the POSIX	3779	requires, and its I/O model is fundamentally incompatible with the POSIX
3444	model. Libev still offers limited functionality on this platform in	3780	model. Libev still offers limited functionality on this platform in
3445	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3781	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
…		…
3456		3792
3457	Not a libev limitation but worth mentioning: windows apparently doesn't	3793	Not a libev limitation but worth mentioning: windows apparently doesn't
3458	accept large writes: instead of resulting in a partial write, windows will	3794	accept large writes: instead of resulting in a partial write, windows will
3459	either accept everything or return C<ENOBUFS> if the buffer is too large,	3795	either accept everything or return C<ENOBUFS> if the buffer is too large,
3460	so make sure you only write small amounts into your sockets (less than a	3796	so make sure you only write small amounts into your sockets (less than a
3461	megabyte seems safe, but thsi apparently depends on the amount of memory	3797	megabyte seems safe, but this apparently depends on the amount of memory
3462	available).	3798	available).
3463		3799
3464	Due to the many, low, and arbitrary limits on the win32 platform and	3800	Due to the many, low, and arbitrary limits on the win32 platform and
3465	the abysmal performance of winsockets, using a large number of sockets	3801	the abysmal performance of winsockets, using a large number of sockets
3466	is not recommended (and not reasonable). If your program needs to use	3802	is not recommended (and not reasonable). If your program needs to use
…		…
3477	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */	3813	#define EV_SELECT_IS_WINSOCKET 1 /* configure libev for windows select */
3478		3814
3479	#include "ev.h"	3815	#include "ev.h"
3480		3816
3481	And compile the following F<evwrap.c> file into your project (make sure	3817	And compile the following F<evwrap.c> file into your project (make sure
3482	you do I<not> compile the F<ev.c> or any other embedded soruce files!):	3818	you do I<not> compile the F<ev.c> or any other embedded source files!):
3483		3819
3484	#include "evwrap.h"	3820	#include "evwrap.h"
3485	#include "ev.c"	3821	#include "ev.c"
3486		3822
3487	=over 4	3823	=over 4
…		…
3532	wrap all I/O functions and provide your own fd management, but the cost of	3868	wrap all I/O functions and provide your own fd management, but the cost of
3533	calling select (O(n²)) will likely make this unworkable.	3869	calling select (O(n²)) will likely make this unworkable.
3534		3870
3535	=back	3871	=back
3536		3872
3537
3538	=head1 PORTABILITY REQUIREMENTS	3873	=head2 PORTABILITY REQUIREMENTS
3539		3874
3540	In addition to a working ISO-C implementation, libev relies on a few	3875	In addition to a working ISO-C implementation and of course the
3541	additional extensions:	3876	backend-specific APIs, libev relies on a few additional extensions:
3542		3877
3543	=over 4	3878	=over 4
3544		3879
3545	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible	3880	=item C<void (*)(ev_watcher_type *, int revents)> must have compatible
3546	calling conventions regardless of C<ev_watcher_type *>.	3881	calling conventions regardless of C<ev_watcher_type *>.
…		…
3552	calls them using an C<ev_watcher *> internally.	3887	calls them using an C<ev_watcher *> internally.
3553		3888
3554	=item C<sig_atomic_t volatile> must be thread-atomic as well	3889	=item C<sig_atomic_t volatile> must be thread-atomic as well
3555		3890
3556	The type C<sig_atomic_t volatile> (or whatever is defined as	3891	The type C<sig_atomic_t volatile> (or whatever is defined as
3557	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different	3892	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
3558	threads. This is not part of the specification for C<sig_atomic_t>, but is	3893	threads. This is not part of the specification for C<sig_atomic_t>, but is
3559	believed to be sufficiently portable.	3894	believed to be sufficiently portable.
3560		3895
3561	=item C<sigprocmask> must work in a threaded environment	3896	=item C<sigprocmask> must work in a threaded environment
3562		3897
…		…
3571	except the initial one, and run the default loop in the initial thread as	3906	except the initial one, and run the default loop in the initial thread as
3572	well.	3907	well.
3573		3908
3574	=item C<long> must be large enough for common memory allocation sizes	3909	=item C<long> must be large enough for common memory allocation sizes
3575		3910
3576	To improve portability and simplify using libev, libev uses C<long>	3911	To improve portability and simplify its API, libev uses C<long> internally
3577	internally instead of C<size_t> when allocating its data structures. On	3912	instead of C<size_t> when allocating its data structures. On non-POSIX
3578	non-POSIX systems (Microsoft...) this might be unexpectedly low, but	3913	systems (Microsoft...) this might be unexpectedly low, but is still at
3579	is still at least 31 bits everywhere, which is enough for hundreds of	3914	least 31 bits everywhere, which is enough for hundreds of millions of
3580	millions of watchers.	3915	watchers.
3581		3916
3582	=item C<double> must hold a time value in seconds with enough accuracy	3917	=item C<double> must hold a time value in seconds with enough accuracy
3583		3918
3584	The type C<double> is used to represent timestamps. It is required to	3919	The type C<double> is used to represent timestamps. It is required to
3585	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	3920	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
…		…
3589	=back	3924	=back
3590		3925
3591	If you know of other additional requirements drop me a note.	3926	If you know of other additional requirements drop me a note.
3592		3927
3593		3928
3594	=head1 COMPILER WARNINGS	3929	=head1 ALGORITHMIC COMPLEXITIES
3595		3930
3596	Depending on your compiler and compiler settings, you might get no or a	3931	In this section the complexities of (many of) the algorithms used inside
3597	lot of warnings when compiling libev code. Some people are apparently	3932	libev will be documented. For complexity discussions about backends see
3598	scared by this.	3933	the documentation for C<ev_default_init>.
3599		3934
3600	However, these are unavoidable for many reasons. For one, each compiler	3935	All of the following are about amortised time: If an array needs to be
3601	has different warnings, and each user has different tastes regarding	3936	extended, libev needs to realloc and move the whole array, but this
3602	warning options. "Warn-free" code therefore cannot be a goal except when	3937	happens asymptotically rarer with higher number of elements, so O(1) might
3603	targeting a specific compiler and compiler-version.	3938	mean that libev does a lengthy realloc operation in rare cases, but on
		3939	average it is much faster and asymptotically approaches constant time.
3604		3940
3605	Another reason is that some compiler warnings require elaborate	3941	=over 4
3606	workarounds, or other changes to the code that make it less clear and less
3607	maintainable.
3608		3942
3609	And of course, some compiler warnings are just plain stupid, or simply	3943	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
3610	wrong (because they don't actually warn about the condition their message
3611	seems to warn about).
3612		3944
3613	While libev is written to generate as few warnings as possible,	3945	This means that, when you have a watcher that triggers in one hour and
3614	"warn-free" code is not a goal, and it is recommended not to build libev	3946	there are 100 watchers that would trigger before that, then inserting will
3615	with any compiler warnings enabled unless you are prepared to cope with	3947	have to skip roughly seven (C<ld 100>) of these watchers.
3616	them (e.g. by ignoring them). Remember that warnings are just that:
3617	warnings, not errors, or proof of bugs.
3618		3948
		3949	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
3619		3950
3620	=head1 VALGRIND	3951	That means that changing a timer costs less than removing/adding them,
		3952	as only the relative motion in the event queue has to be paid for.
3621		3953
3622	Valgrind has a special section here because it is a popular tool that is	3954	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
3623	highly useful, but valgrind reports are very hard to interpret.
3624		3955
3625	If you think you found a bug (memory leak, uninitialised data access etc.)	3956	These just add the watcher into an array or at the head of a list.
3626	in libev, then check twice: If valgrind reports something like:
3627		3957
3628	==2274== definitely lost: 0 bytes in 0 blocks.	3958	=item Stopping check/prepare/idle/fork/async watchers: O(1)
3629	==2274== possibly lost: 0 bytes in 0 blocks.
3630	==2274== still reachable: 256 bytes in 1 blocks.
3631		3959
3632	Then there is no memory leak. Similarly, under some circumstances,	3960	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
3633	valgrind might report kernel bugs as if it were a bug in libev, or it
3634	might be confused (it is a very good tool, but only a tool).
3635		3961
3636	If you are unsure about something, feel free to contact the mailing list	3962	These watchers are stored in lists, so they need to be walked to find the
3637	with the full valgrind report and an explanation on why you think this is	3963	correct watcher to remove. The lists are usually short (you don't usually
3638	a bug in libev. However, don't be annoyed when you get a brisk "this is	3964	have many watchers waiting for the same fd or signal: one is typical, two
3639	no bug" answer and take the chance of learning how to interpret valgrind	3965	is rare).
3640	properly.
3641		3966
3642	If you need, for some reason, empty reports from valgrind for your project	3967	=item Finding the next timer in each loop iteration: O(1)
3643	I suggest using suppression lists.	3968
		3969	By virtue of using a binary or 4-heap, the next timer is always found at a
		3970	fixed position in the storage array.
		3971
		3972	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
		3973
		3974	A change means an I/O watcher gets started or stopped, which requires
		3975	libev to recalculate its status (and possibly tell the kernel, depending
		3976	on backend and whether C<ev_io_set> was used).
		3977
		3978	=item Activating one watcher (putting it into the pending state): O(1)
		3979
		3980	=item Priority handling: O(number_of_priorities)
		3981
		3982	Priorities are implemented by allocating some space for each
		3983	priority. When doing priority-based operations, libev usually has to
		3984	linearly search all the priorities, but starting/stopping and activating
		3985	watchers becomes O(1) with respect to priority handling.
		3986
		3987	=item Sending an ev_async: O(1)
		3988
		3989	=item Processing ev_async_send: O(number_of_async_watchers)
		3990
		3991	=item Processing signals: O(max_signal_number)
		3992
		3993	Sending involves a system call I<iff> there were no other C<ev_async_send>
		3994	calls in the current loop iteration. Checking for async and signal events
		3995	involves iterating over all running async watchers or all signal numbers.
		3996
		3997	=back
3644		3998
3645		3999
3646	=head1 AUTHOR	4000	=head1 AUTHOR
3647		4001
3648	Marc Lehmann <libev@schmorp.de>.	4002	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3649		4003

Diff Legend

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